FS/FS/cust_main.pm

   1 package FS::cust_main;
   2 use base qw( FS::cust_main::Packages
   3              FS::cust_main::Status
   4              FS::cust_main::NationalID
   5              FS::cust_main::Billing
   6              FS::cust_main::Billing_Realtime
   7              FS::cust_main::Billing_Batch
   8              FS::cust_main::Billing_Discount
   9              FS::cust_main::Billing_ThirdParty
  10              FS::cust_main::Location
  11              FS::cust_main::Credit_Limit
  12              FS::cust_main::Merge
  13              FS::cust_main::API
  14              FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
  15              FS::geocode_Mixin FS::Quotable_Mixin FS::Sales_Mixin
  16              FS::o2m_Common
  17              FS::Record
  18            );
  19
  20 require 5.006;
  21 use strict;
  22 use Carp;
  23 use Try::Tiny;
  24 use Scalar::Util qw( blessed );
  25 use List::Util qw(min);
  26 use Tie::IxHash;
  27 use File::Temp; #qw( tempfile );
  28 use Data::Dumper;
  29 use Time::Local qw(timelocal);
  30 use Date::Format;
  31 #use Date::Manip;
  32 use Email::Address;
  33 use Business::CreditCard 0.28;
  34 use FS::UID qw( dbh driver_name );
  35 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
  36 use FS::Cursor;
  37 use FS::Misc qw( generate_ps do_print money_pretty card_types );
  38 use FS::Msgcat qw(gettext);
  39 use FS::CurrentUser;
  40 use FS::TicketSystem;
  41 use FS::payby;
  42 use FS::cust_pkg;
  43 use FS::cust_svc;
  44 use FS::cust_bill;
  45 use FS::cust_bill_void;
  46 use FS::legacy_cust_bill;
  47 use FS::cust_pay;
  48 use FS::cust_pay_pending;
  49 use FS::cust_pay_void;
  50 use FS::cust_pay_batch;
  51 use FS::cust_credit;
  52 use FS::cust_refund;
  53 use FS::part_referral;
  54 use FS::cust_main_county;
  55 use FS::cust_location;
  56 use FS::cust_class;
  57 use FS::tax_status;
  58 use FS::cust_main_exemption;
  59 use FS::cust_tax_adjustment;
  60 use FS::cust_tax_location;
  61 use FS::agent_currency;
  62 use FS::cust_main_invoice;
  63 use FS::cust_tag;
  64 use FS::prepay_credit;
  65 use FS::queue;
  66 use FS::part_pkg;
  67 use FS::part_export;
  68 #use FS::cust_event;
  69 use FS::type_pkgs;
  70 use FS::payment_gateway;
  71 use FS::agent_payment_gateway;
  72 use FS::banned_pay;
  73 use FS::cust_main_note;
  74 use FS::cust_attachment;
  75 use FS::cust_contact;
  76 use FS::Locales;
  77 use FS::upgrade_journal;
  78 use FS::sales;
  79 use FS::cust_payby;
  80 use FS::contact;
  81 use FS::reason;
  82 use FS::Misc::Savepoint;
  83 use FS::DBI;
  84
  85 # 1 is mostly method/subroutine entry and options
  86 # 2 traces progress of some operations
  87 # 3 is even more information including possibly sensitive data
  88 our $DEBUG = 0;
  89 our $me = '[FS::cust_main]';
  90
  91 our $import = 0;
  92 our $ignore_expired_card = 0;
  93 our $ignore_banned_card = 0;
  94 our $ignore_invalid_card = 0;
  95
  96 our $skip_fuzzyfiles = 0;
  97
  98 our $ucfirst_nowarn = 0;
  99
 100 #this info is in cust_payby as of 4.x
 101 #this and the fields themselves can be removed in 5.x
 102 our @encrypted_fields = ('payinfo', 'paycvv');
 103 sub nohistory_fields { ('payinfo', 'paycvv'); }
 104
 105 our $conf;
 106 our $default_agent_custid;
 107 our $custnum_display_length;
 108 #ask FS::UID to run this stuff for us later
 109 #$FS::UID::callback{'FS::cust_main'} = sub {
 110 install_callback FS::UID sub {
 111   $conf = new FS::Conf;
 112   $ignore_invalid_card    = $conf->exists('allow_invalid_cards');
 113   $default_agent_custid   = $conf->exists('cust_main-default_agent_custid');
 114   $custnum_display_length = $conf->config('cust_main-custnum-display_length');
 115 };
 116
 117 sub _cache {
 118   my $self = shift;
 119   my ( $hashref, $cache ) = @_;
 120   if ( exists $hashref->{'pkgnum'} ) {
 121     #@{ $self->{'_pkgnum'} } = ();
 122     my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
 123     $self->{'_pkgnum'} = $subcache;
 124     #push @{ $self->{'_pkgnum'} },
 125     FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
 126   }
 127 }
 128
 129 =head1 NAME
 130
 131 FS::cust_main - Object methods for cust_main records
 132
 133 =head1 SYNOPSIS
 134
 135   use FS::cust_main;
 136
 137   $record = new FS::cust_main \%hash;
 138   $record = new FS::cust_main { 'column' => 'value' };
 139
 140   $error = $record->insert;
 141
 142   $error = $new_record->replace($old_record);
 143
 144   $error = $record->delete;
 145
 146   $error = $record->check;
 147
 148   @cust_pkg = $record->all_pkgs;
 149
 150   @cust_pkg = $record->ncancelled_pkgs;
 151
 152   @cust_pkg = $record->suspended_pkgs;
 153
 154   $error = $record->bill;
 155   $error = $record->bill %options;
 156   $error = $record->bill 'time' => $time;
 157
 158   $error = $record->collect;
 159   $error = $record->collect %options;
 160   $error = $record->collect 'invoice_time'   => $time,
 161                           ;
 162
 163 =head1 DESCRIPTION
 164
 165 An FS::cust_main object represents a customer.  FS::cust_main inherits from
 166 FS::Record.  The following fields are currently supported:
 167
 168 =over 4
 169
 170 =item custnum
 171
 172 Primary key (assigned automatically for new customers)
 173
 174 =item agentnum
 175
 176 Agent (see L<FS::agent>)
 177
 178 =item refnum
 179
 180 Advertising source (see L<FS::part_referral>)
 181
 182 =item first
 183
 184 First name
 185
 186 =item last
 187
 188 Last name
 189
 190 =item ss
 191
 192 Cocial security number (optional)
 193
 194 =item company
 195
 196 (optional)
 197
 198 =item daytime
 199
 200 phone (optional)
 201
 202 =item night
 203
 204 phone (optional)
 205
 206 =item fax
 207
 208 phone (optional)
 209
 210 =item mobile
 211
 212 phone (optional)
 213
 214 =item payby
 215
 216 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
 217
 218 =item payinfo
 219
 220 Payment Information (See L<FS::payinfo_Mixin> for data format)
 221
 222 =item paymask
 223
 224 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
 225
 226 =item paycvv
 227
 228 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
 229
 230 =item paydate
 231
 232 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
 233
 234 =item paystart_month
 235
 236 Start date month (maestro/solo cards only)
 237
 238 =item paystart_year
 239
 240 Start date year (maestro/solo cards only)
 241
 242 =item payissue
 243
 244 Issue number (maestro/solo cards only)
 245
 246 =item payname
 247
 248 Name on card or billing name
 249
 250 =item payip
 251
 252 IP address from which payment information was received
 253
 254 =item tax
 255
 256 Tax exempt, empty or `Y'
 257
 258 =item usernum
 259
 260 Order taker (see L<FS::access_user>)
 261
 262 =item comments
 263
 264 Comments (optional)
 265
 266 =item referral_custnum
 267
 268 Referring customer number
 269
 270 =item spool_cdr
 271
 272 Enable individual CDR spooling, empty or `Y'
 273
 274 =item dundate
 275
 276 A suggestion to events (see L<FS::part_bill_event>) to delay until this unix timestamp
 277
 278 =item squelch_cdr
 279
 280 Discourage individual CDR printing, empty or `Y'
 281
 282 =item edit_subject
 283
 284 Allow self-service editing of ticket subjects, empty or 'Y'
 285
 286 =item calling_list_exempt
 287
 288 Do not call, empty or 'Y'
 289
 290 =item invoice_ship_address
 291
 292 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
 293
 294 =back
 295
 296 =head1 METHODS
 297
 298 =over 4
 299
 300 =item new HASHREF
 301
 302 Creates a new customer.  To add the customer to the database, see L<"insert">.
 303
 304 Note that this stores the hash reference, not a distinct copy of the hash it
 305 points to.  You can ask the object for a copy with the I<hash> method.
 306
 307 =cut
 308
 309 sub table { 'cust_main'; }
 310
 311 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
 312
 313 Adds this customer to the database.  If there is an error, returns the error,
 314 otherwise returns false.
 315
 316 Usually the customer's location will not yet exist in the database, and
 317 the C<bill_location> and C<ship_location> pseudo-fields must be set to
 318 uninserted L<FS::cust_location> objects.  These will be inserted and linked
 319 (in both directions) to the new customer record.  If they're references
 320 to the same object, they will become the same location.
 321
 322 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
 323 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
 324 are inserted atomicly, or the transaction is rolled back.  Passing an empty
 325 hash reference is equivalent to not supplying this parameter.  There should be
 326 a better explanation of this, but until then, here's an example:
 327
 328   use Tie::RefHash;
 329   tie %hash, 'Tie::RefHash'; #this part is important
 330   %hash = (
 331     $cust_pkg => [ $svc_acct ],
 332     ...
 333   );
 334   $cust_main->insert( \%hash );
 335
 336 INVOICING_LIST_ARYREF: No longer supported.
 337
 338 Currently available options are: I<depend_jobnum>, I<noexport>,
 339 I<tax_exemption>, I<prospectnum>, I<contact> and I<contact_params>.
 340
 341 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
 342 on the supplied jobnum (they will not run until the specific job completes).
 343 This can be used to defer provisioning until some action completes (such
 344 as running the customer's credit card successfully).
 345
 346 The I<noexport> option is deprecated.  If I<noexport> is set true, no
 347 provisioning jobs (exports) are scheduled.  (You can schedule them later with
 348 the B<reexport> method.)
 349
 350 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
 351 of tax names and exemption numbers.  FS::cust_main_exemption records will be
 352 created and inserted.
 353
 354 If I<prospectnum> is set, moves contacts and locations from that prospect.
 355
 356 If I<contact> is set to an arrayref of FS::contact objects, those will be
 357 inserted.
 358
 359 If I<contact_params> is set to a hashref of CGI parameters (and I<contact> is
 360 unset), inserts those new contacts with this new customer.  Handles CGI
 361 paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
 362
 363 If I<cust_payby_params> is set to a hashref o fCGI parameters, inserts those
 364 new stored payment records with this new customer.  Handles CGI parameters
 365 for an "m2" multiple entry field as passed by edit/cust_main.cgi
 366
 367 =cut
 368
 369 sub insert {
 370   my $self = shift;
 371   my $cust_pkgs = @_ ? shift : {};
 372   my $invoicing_list;
 373   if ( $_[0] and ref($_[0]) eq 'ARRAY' ) {
 374     warn "cust_main::insert using deprecated invoicing list argument";
 375     $invoicing_list = shift;
 376   }
 377   my %options = @_;
 378   warn "$me insert called with options ".
 379        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
 380     if $DEBUG;
 381
 382   return "You are not permitted to change customer invoicing terms."
 383     if $self->invoice_terms #i.e. not the default
 384     && ! $FS::CurrentUser::CurrentUser->access_right('Edit customer invoice terms');
 385
 386   local $SIG{HUP} = 'IGNORE';
 387   local $SIG{INT} = 'IGNORE';
 388   local $SIG{QUIT} = 'IGNORE';
 389   local $SIG{TERM} = 'IGNORE';
 390   local $SIG{TSTP} = 'IGNORE';
 391   local $SIG{PIPE} = 'IGNORE';
 392
 393   my $oldAutoCommit = $FS::UID::AutoCommit;
 394   local $FS::UID::AutoCommit = 0;
 395   my $dbh = dbh;
 396
 397   my $prepay_identifier = '';
 398   my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
 399   my $payby = '';
 400   if ( $self->payby eq 'PREPAY' ) {
 401
 402     $self->payby(''); #'BILL');
 403     $prepay_identifier = $self->payinfo;
 404     $self->payinfo('');
 405
 406     warn "  looking up prepaid card $prepay_identifier\n"
 407       if $DEBUG > 1;
 408
 409     my $error = $self->get_prepay( $prepay_identifier,
 410                                    'amount_ref'     => \$amount,
 411                                    'seconds_ref'    => \$seconds,
 412                                    'upbytes_ref'    => \$upbytes,
 413                                    'downbytes_ref'  => \$downbytes,
 414                                    'totalbytes_ref' => \$totalbytes,
 415                                  );
 416     if ( $error ) {
 417       $dbh->rollback if $oldAutoCommit;
 418       #return "error applying prepaid card (transaction rolled back): $error";
 419       return $error;
 420     }
 421
 422     $payby = 'PREP' if $amount;
 423
 424   } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
 425
 426     $payby = $1;
 427     $self->payby(''); #'BILL');
 428     $amount = $self->paid;
 429
 430   }
 431
 432   # insert locations
 433   foreach my $l (qw(bill_location ship_location)) {
 434
 435     my $loc = delete $self->hashref->{$l} or next;
 436
 437     if ( !$loc->locationnum ) {
 438       # warn the location that we're going to insert it with no custnum
 439       $loc->set(custnum_pending => 1);
 440       warn "  inserting $l\n"
 441         if $DEBUG > 1;
 442       my $error = $loc->insert;
 443       if ( $error ) {
 444         $dbh->rollback if $oldAutoCommit;
 445         my $label = $l eq 'ship_location' ? 'service' : 'billing';
 446         return "$error (in $label location)";
 447       }
 448
 449     } elsif ( $loc->prospectnum ) {
 450
 451       $loc->prospectnum('');
 452       $loc->set(custnum_pending => 1);
 453       my $error = $loc->replace;
 454       if ( $error ) {
 455         $dbh->rollback if $oldAutoCommit;
 456         my $label = $l eq 'ship_location' ? 'service' : 'billing';
 457         return "$error (moving $label location)";
 458       }
 459
 460     } elsif ( ($loc->custnum || 0) > 0 ) {
 461       # then it somehow belongs to another customer--shouldn't happen
 462       $dbh->rollback if $oldAutoCommit;
 463       return "$l belongs to customer ".$loc->custnum;
 464     }
 465     # else it already belongs to this customer
 466     # (happens when ship_location is identical to bill_location)
 467
 468     $self->set($l.'num', $loc->locationnum);
 469
 470     if ( $self->get($l.'num') eq '' ) {
 471       $dbh->rollback if $oldAutoCommit;
 472       return "$l not set";
 473     }
 474   }
 475
 476   warn "  inserting $self\n"
 477     if $DEBUG > 1;
 478
 479   $self->signupdate(time) unless $self->signupdate;
 480
 481   $self->auto_agent_custid()
 482     if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
 483
 484   my $error =  $self->check_payinfo_cardtype
 485             || $self->SUPER::insert;
 486   if ( $error ) {
 487     $dbh->rollback if $oldAutoCommit;
 488     #return "inserting cust_main record (transaction rolled back): $error";
 489     return $error;
 490   }
 491
 492   # now set cust_location.custnum
 493   foreach my $l (qw(bill_location ship_location)) {
 494     warn "  setting $l.custnum\n"
 495       if $DEBUG > 1;
 496     my $loc = $self->$l or next;
 497     unless ( $loc->custnum ) {
 498       $loc->set(custnum => $self->custnum);
 499       $error ||= $loc->replace;
 500     }
 501
 502     if ( $error ) {
 503       $dbh->rollback if $oldAutoCommit;
 504       return "error setting $l custnum: $error";
 505     }
 506   }
 507
 508   warn "  setting customer tags\n"
 509     if $DEBUG > 1;
 510
 511   foreach my $tagnum ( @{ $self->tagnum || [] } ) {
 512     my $cust_tag = new FS::cust_tag { 'tagnum'  => $tagnum,
 513                                       'custnum' => $self->custnum };
 514     my $error = $cust_tag->insert;
 515     if ( $error ) {
 516       $dbh->rollback if $oldAutoCommit;
 517       return $error;
 518     }
 519   }
 520
 521   my $prospectnum = delete $options{'prospectnum'};
 522   if ( $prospectnum ) {
 523
 524     warn "  moving contacts and locations from prospect $prospectnum\n"
 525       if $DEBUG > 1;
 526
 527     my $prospect_main =
 528       qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
 529     unless ( $prospect_main ) {
 530       $dbh->rollback if $oldAutoCommit;
 531       return "Unknown prospectnum $prospectnum";
 532     }
 533     $prospect_main->custnum($self->custnum);
 534     $prospect_main->disabled('Y');
 535     my $error = $prospect_main->replace;
 536     if ( $error ) {
 537       $dbh->rollback if $oldAutoCommit;
 538       return $error;
 539     }
 540
 541     foreach my $prospect_contact ( $prospect_main->prospect_contact ) {
 542       my $cust_contact = new FS::cust_contact {
 543         'custnum' => $self->custnum,
 544         'invoice_dest' => 'Y', # invoice_dest currently not set for prospect contacts
 545         map { $_ => $prospect_contact->$_() } qw( contactnum classnum comment )
 546       };
 547       my $error =  $cust_contact->insert
 548                 || $prospect_contact->delete;
 549       if ( $error ) {
 550         $dbh->rollback if $oldAutoCommit;
 551         return $error;
 552       }
 553     }
 554
 555     my @cust_location = $prospect_main->cust_location;
 556     my @qual = $prospect_main->qual;
 557
 558     foreach my $r ( @cust_location, @qual ) {
 559       $r->prospectnum('');
 560       $r->custnum($self->custnum);
 561       my $error = $r->replace;
 562       if ( $error ) {
 563         $dbh->rollback if $oldAutoCommit;
 564         return $error;
 565       }
 566     }
 567     # since we set invoice_dest on all migrated prospect contacts (for now),
 568     # don't process invoicing_list.
 569     delete $options{'invoicing_list'};
 570     $invoicing_list = undef;
 571   }
 572
 573   warn "  setting contacts\n"
 574     if $DEBUG > 1;
 575
 576   $invoicing_list ||= $options{'invoicing_list'};
 577   if ( $invoicing_list ) {
 578
 579     $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
 580
 581     my $email = '';
 582     foreach my $dest (@$invoicing_list ) {
 583       if ($dest eq 'POST') {
 584         $self->set('postal_invoice', 'Y');
 585       } else {
 586
 587         my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
 588         if ( $contact_email ) {
 589           my $cust_contact = FS::cust_contact->new({
 590               contactnum    => $contact_email->contactnum,
 591               custnum       => $self->custnum,
 592           });
 593           $cust_contact->set('invoice_dest', 'Y');
 594           my $error = $cust_contact->insert;
 595           if ( $error ) {
 596             $dbh->rollback if $oldAutoCommit;
 597             return "$error (linking to email address $dest)";
 598           }
 599
 600         } else {
 601           # this email address is not yet linked to any contact
 602           $email .= ',' if length($email);
 603           $email .= $dest;
 604         }
 605       }
 606     }
 607
 608     if ( $email ) {
 609
 610       my $contact = FS::contact->new({
 611         'custnum'       => $self->get('custnum'),
 612         'last'          => $self->get('last'),
 613         'first'         => $self->get('first'),
 614         'emailaddress'  => $email,
 615         'invoice_dest'  => 'Y', # yes, you can set this via the contact
 616       });
 617       my $error = $contact->insert;
 618       if ( $error ) {
 619         $dbh->rollback if $oldAutoCommit;
 620         return $error;
 621       }
 622
 623     }
 624
 625   }
 626
 627   if ( my $contact = delete $options{'contact'} ) {
 628
 629     foreach my $c ( @$contact ) {
 630       $c->custnum($self->custnum);
 631       my $error = $c->insert;
 632       if ( $error ) {
 633         $dbh->rollback if $oldAutoCommit;
 634         return $error;
 635       }
 636
 637     }
 638
 639   } elsif ( my $contact_params = delete $options{'contact_params'} ) {
 640
 641     my $error = $self->process_o2m( 'table'  => 'contact',
 642                                     'fields' => FS::contact->cgi_contact_fields,
 643                                     'params' => $contact_params,
 644                                   );
 645     if ( $error ) {
 646       $dbh->rollback if $oldAutoCommit;
 647       return $error;
 648     }
 649   }
 650
 651   warn "  setting cust_payby\n"
 652     if $DEBUG > 1;
 653
 654   if ( $options{cust_payby} ) {
 655
 656     foreach my $cust_payby ( @{ $options{cust_payby} } ) {
 657       $cust_payby->custnum($self->custnum);
 658       my $error = $cust_payby->insert;
 659       if ( $error ) {
 660         $dbh->rollback if $oldAutoCommit;
 661         return $error;
 662       }
 663     }
 664
 665   } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
 666
 667     my $error = $self->process_o2m(
 668       'table'         => 'cust_payby',
 669       'fields'        => FS::cust_payby->cgi_cust_payby_fields,
 670       'params'        => $cust_payby_params,
 671       'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
 672     );
 673     if ( $error ) {
 674       $dbh->rollback if $oldAutoCommit;
 675       return $error;
 676     }
 677
 678   }
 679
 680   warn "  setting cust_main_exemption\n"
 681     if $DEBUG > 1;
 682
 683   my $tax_exemption = delete $options{'tax_exemption'};
 684   if ( $tax_exemption ) {
 685
 686     $tax_exemption = { map { $_ => '' } @$tax_exemption }
 687       if ref($tax_exemption) eq 'ARRAY';
 688
 689     foreach my $taxname ( keys %$tax_exemption ) {
 690       my $cust_main_exemption = new FS::cust_main_exemption {
 691         'custnum'       => $self->custnum,
 692         'taxname'       => $taxname,
 693         'exempt_number' => $tax_exemption->{$taxname},
 694       };
 695       my $error = $cust_main_exemption->insert;
 696       if ( $error ) {
 697         $dbh->rollback if $oldAutoCommit;
 698         return "inserting cust_main_exemption (transaction rolled back): $error";
 699       }
 700     }
 701   }
 702
 703   warn "  ordering packages\n"
 704     if $DEBUG > 1;
 705
 706   $error = $self->order_pkgs( $cust_pkgs,
 707                               %options,
 708                               'seconds_ref'    => \$seconds,
 709                               'upbytes_ref'    => \$upbytes,
 710                               'downbytes_ref'  => \$downbytes,
 711                               'totalbytes_ref' => \$totalbytes,
 712                             );
 713   if ( $error ) {
 714     $dbh->rollback if $oldAutoCommit;
 715     return $error;
 716   }
 717
 718   if ( $seconds ) {
 719     $dbh->rollback if $oldAutoCommit;
 720     return "No svc_acct record to apply pre-paid time";
 721   }
 722   if ( $upbytes || $downbytes || $totalbytes ) {
 723     $dbh->rollback if $oldAutoCommit;
 724     return "No svc_acct record to apply pre-paid data";
 725   }
 726
 727   if ( $amount ) {
 728     warn "  inserting initial $payby payment of $amount\n"
 729       if $DEBUG > 1;
 730     $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
 731     if ( $error ) {
 732       $dbh->rollback if $oldAutoCommit;
 733       return "inserting payment (transaction rolled back): $error";
 734     }
 735   }
 736
 737   unless ( $import || $skip_fuzzyfiles ) {
 738     warn "  queueing fuzzyfiles update\n"
 739       if $DEBUG > 1;
 740     $error = $self->queue_fuzzyfiles_update;
 741     if ( $error ) {
 742       $dbh->rollback if $oldAutoCommit;
 743       return "updating fuzzy search cache: $error";
 744     }
 745   }
 746
 747   # cust_main exports!
 748   warn "  exporting\n" if $DEBUG > 1;
 749
 750   my $export_args = $options{'export_args'} || [];
 751
 752   my @part_export =
 753     map qsearch( 'part_export', {exportnum=>$_} ),
 754       $conf->config('cust_main-exports'); #, $agentnum
 755
 756   foreach my $part_export ( @part_export ) {
 757     my $error = $part_export->export_insert($self, @$export_args);
 758     if ( $error ) {
 759       $dbh->rollback if $oldAutoCommit;
 760       return "exporting to ". $part_export->exporttype.
 761              " (transaction rolled back): $error";
 762     }
 763   }
 764
 765   #foreach my $depend_jobnum ( @$depend_jobnums ) {
 766   #    warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
 767   #      if $DEBUG;
 768   #    foreach my $jobnum ( @jobnums ) {
 769   #      my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
 770   #      warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
 771   #        if $DEBUG;
 772   #      my $error = $queue->depend_insert($depend_jobnum);
 773   #      if ( $error ) {
 774   #        $dbh->rollback if $oldAutoCommit;
 775   #        return "error queuing job dependancy: $error";
 776   #      }
 777   #    }
 778   #  }
 779   #
 780   #}
 781   #
 782   #if ( exists $options{'jobnums'} ) {
 783   #  push @{ $options{'jobnums'} }, @jobnums;
 784   #}
 785
 786   warn "  insert complete; committing transaction\n"
 787     if $DEBUG > 1;
 788
 789   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 790   '';
 791
 792 }
 793
 794 use File::CounterFile;
 795 sub auto_agent_custid {
 796   my $self = shift;
 797
 798   my $format = $conf->config('cust_main-auto_agent_custid');
 799   my $agent_custid;
 800   if ( $format eq '1YMMXXXXXXXX' ) {
 801
 802     my $counter = new File::CounterFile 'cust_main.agent_custid';
 803     $counter->lock;
 804
 805     my $ym = 100000000000 + time2str('%y%m00000000', time);
 806     if ( $ym > $counter->value ) {
 807       $counter->{'value'} = $agent_custid = $ym;
 808       $counter->{'updated'} = 1;
 809     } else {
 810       $agent_custid = $counter->inc;
 811     }
 812
 813     $counter->unlock;
 814
 815   } else {
 816     die "Unknown cust_main-auto_agent_custid format: $format";
 817   }
 818
 819   $self->agent_custid($agent_custid);
 820
 821 }
 822
 823 =item PACKAGE METHODS
 824
 825 Documentation on customer package methods has been moved to
 826 L<FS::cust_main::Packages>.
 827
 828 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
 829
 830 Recharges this (existing) customer with the specified prepaid card (see
 831 L<FS::prepay_credit>), specified either by I<identifier> or as an
 832 FS::prepay_credit object.  If there is an error, returns the error, otherwise
 833 returns false.
 834
 835 Optionally, five scalar references can be passed as well.  They will have their
 836 values filled in with the amount, number of seconds, and number of upload,
 837 download, and total bytes applied by this prepaid card.
 838
 839 =cut
 840
 841 #the ref bullshit here should be refactored like get_prepay.  MyAccount.pm is
 842 #the only place that uses these args
 843 sub recharge_prepay {
 844   my( $self, $prepay_credit, $amountref, $secondsref,
 845       $upbytesref, $downbytesref, $totalbytesref ) = @_;
 846
 847   local $SIG{HUP} = 'IGNORE';
 848   local $SIG{INT} = 'IGNORE';
 849   local $SIG{QUIT} = 'IGNORE';
 850   local $SIG{TERM} = 'IGNORE';
 851   local $SIG{TSTP} = 'IGNORE';
 852   local $SIG{PIPE} = 'IGNORE';
 853
 854   my $oldAutoCommit = $FS::UID::AutoCommit;
 855   local $FS::UID::AutoCommit = 0;
 856   my $dbh = dbh;
 857
 858   my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
 859
 860   my $error = $self->get_prepay( $prepay_credit,
 861                                  'amount_ref'     => \$amount,
 862                                  'seconds_ref'    => \$seconds,
 863                                  'upbytes_ref'    => \$upbytes,
 864                                  'downbytes_ref'  => \$downbytes,
 865                                  'totalbytes_ref' => \$totalbytes,
 866                                )
 867            || $self->increment_seconds($seconds)
 868            || $self->increment_upbytes($upbytes)
 869            || $self->increment_downbytes($downbytes)
 870            || $self->increment_totalbytes($totalbytes)
 871            || $self->insert_cust_pay_prepay( $amount,
 872                                              ref($prepay_credit)
 873                                                ? $prepay_credit->identifier
 874                                                : $prepay_credit
 875                                            );
 876
 877   if ( $error ) {
 878     $dbh->rollback if $oldAutoCommit;
 879     return $error;
 880   }
 881
 882   if ( defined($amountref)  ) { $$amountref  = $amount;  }
 883   if ( defined($secondsref) ) { $$secondsref = $seconds; }
 884   if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
 885   if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
 886   if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
 887
 888   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 889   '';
 890
 891 }
 892
 893 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
 894
 895 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
 896 specified either by I<identifier> or as an FS::prepay_credit object.
 897
 898 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
 899 incremented by the values of the prepaid card.
 900
 901 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
 902 check or set this customer's I<agentnum>.
 903
 904 If there is an error, returns the error, otherwise returns false.
 905
 906 =cut
 907
 908
 909 sub get_prepay {
 910   my( $self, $prepay_credit, %opt ) = @_;
 911
 912   local $SIG{HUP} = 'IGNORE';
 913   local $SIG{INT} = 'IGNORE';
 914   local $SIG{QUIT} = 'IGNORE';
 915   local $SIG{TERM} = 'IGNORE';
 916   local $SIG{TSTP} = 'IGNORE';
 917   local $SIG{PIPE} = 'IGNORE';
 918
 919   my $oldAutoCommit = $FS::UID::AutoCommit;
 920   local $FS::UID::AutoCommit = 0;
 921   my $dbh = dbh;
 922
 923   unless ( ref($prepay_credit) ) {
 924
 925     my $identifier = $prepay_credit;
 926
 927     $prepay_credit = qsearchs(
 928       'prepay_credit',
 929       { 'identifier' => $identifier },
 930       '',
 931       'FOR UPDATE'
 932     );
 933
 934     unless ( $prepay_credit ) {
 935       $dbh->rollback if $oldAutoCommit;
 936       return "Invalid prepaid card: ". $identifier;
 937     }
 938
 939   }
 940
 941   if ( $prepay_credit->agentnum ) {
 942     if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
 943       $dbh->rollback if $oldAutoCommit;
 944       return "prepaid card not valid for agent ". $self->agentnum;
 945     }
 946     $self->agentnum($prepay_credit->agentnum);
 947   }
 948
 949   my $error = $prepay_credit->delete;
 950   if ( $error ) {
 951     $dbh->rollback if $oldAutoCommit;
 952     return "removing prepay_credit (transaction rolled back): $error";
 953   }
 954
 955   ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
 956     for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
 957
 958   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 959   '';
 960
 961 }
 962
 963 =item increment_upbytes SECONDS
 964
 965 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 966 the specified number of upbytes.  If there is an error, returns the error,
 967 otherwise returns false.
 968
 969 =cut
 970
 971 sub increment_upbytes {
 972   _increment_column( shift, 'upbytes', @_);
 973 }
 974
 975 =item increment_downbytes SECONDS
 976
 977 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 978 the specified number of downbytes.  If there is an error, returns the error,
 979 otherwise returns false.
 980
 981 =cut
 982
 983 sub increment_downbytes {
 984   _increment_column( shift, 'downbytes', @_);
 985 }
 986
 987 =item increment_totalbytes SECONDS
 988
 989 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 990 the specified number of totalbytes.  If there is an error, returns the error,
 991 otherwise returns false.
 992
 993 =cut
 994
 995 sub increment_totalbytes {
 996   _increment_column( shift, 'totalbytes', @_);
 997 }
 998
 999 =item increment_seconds SECONDS
1000
1001 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1002 the specified number of seconds.  If there is an error, returns the error,
1003 otherwise returns false.
1004
1005 =cut
1006
1007 sub increment_seconds {
1008   _increment_column( shift, 'seconds', @_);
1009 }
1010
1011 =item _increment_column AMOUNT
1012
1013 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1014 the specified number of seconds or bytes.  If there is an error, returns
1015 the error, otherwise returns false.
1016
1017 =cut
1018
1019 sub _increment_column {
1020   my( $self, $column, $amount ) = @_;
1021   warn "$me increment_column called: $column, $amount\n"
1022     if $DEBUG;
1023
1024   return '' unless $amount;
1025
1026   my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1027                       $self->ncancelled_pkgs;
1028
1029   if ( ! @cust_pkg ) {
1030     return 'No packages with primary or single services found'.
1031            ' to apply pre-paid time';
1032   } elsif ( scalar(@cust_pkg) > 1 ) {
1033     #maybe have a way to specify the package/account?
1034     return 'Multiple packages found to apply pre-paid time';
1035   }
1036
1037   my $cust_pkg = $cust_pkg[0];
1038   warn "  found package pkgnum ". $cust_pkg->pkgnum. "\n"
1039     if $DEBUG > 1;
1040
1041   my @cust_svc =
1042     $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1043
1044   if ( ! @cust_svc ) {
1045     return 'No account found to apply pre-paid time';
1046   } elsif ( scalar(@cust_svc) > 1 ) {
1047     return 'Multiple accounts found to apply pre-paid time';
1048   }
1049
1050   my $svc_acct = $cust_svc[0]->svc_x;
1051   warn "  found service svcnum ". $svc_acct->pkgnum.
1052        ' ('. $svc_acct->email. ")\n"
1053     if $DEBUG > 1;
1054
1055   $column = "increment_$column";
1056   $svc_acct->$column($amount);
1057
1058 }
1059
1060 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1061
1062 Inserts a prepayment in the specified amount for this customer.  An optional
1063 second argument can specify the prepayment identifier for tracking purposes.
1064 If there is an error, returns the error, otherwise returns false.
1065
1066 =cut
1067
1068 sub insert_cust_pay_prepay {
1069   shift->insert_cust_pay('PREP', @_);
1070 }
1071
1072 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1073
1074 Inserts a cash payment in the specified amount for this customer.  An optional
1075 second argument can specify the payment identifier for tracking purposes.
1076 If there is an error, returns the error, otherwise returns false.
1077
1078 =cut
1079
1080 sub insert_cust_pay_cash {
1081   shift->insert_cust_pay('CASH', @_);
1082 }
1083
1084 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1085
1086 Inserts a Western Union payment in the specified amount for this customer.  An
1087 optional second argument can specify the prepayment identifier for tracking
1088 purposes.  If there is an error, returns the error, otherwise returns false.
1089
1090 =cut
1091
1092 sub insert_cust_pay_west {
1093   shift->insert_cust_pay('WEST', @_);
1094 }
1095
1096 sub insert_cust_pay {
1097   my( $self, $payby, $amount ) = splice(@_, 0, 3);
1098   my $payinfo = scalar(@_) ? shift : '';
1099
1100   my $cust_pay = new FS::cust_pay {
1101     'custnum' => $self->custnum,
1102     'paid'    => sprintf('%.2f', $amount),
1103     #'_date'   => #date the prepaid card was purchased???
1104     'payby'   => $payby,
1105     'payinfo' => $payinfo,
1106   };
1107   $cust_pay->insert;
1108
1109 }
1110
1111 =item delete [ OPTION => VALUE ... ]
1112
1113 This deletes the customer.  If there is an error, returns the error, otherwise
1114 returns false.
1115
1116 This will completely remove all traces of the customer record.  This is not
1117 what you want when a customer cancels service; for that, cancel all of the
1118 customer's packages (see L</cancel>).
1119
1120 If the customer has any uncancelled packages, you need to pass a new (valid)
1121 customer number for those packages to be transferred to, as the "new_customer"
1122 option.  Cancelled packages will be deleted.  Did I mention that this is NOT
1123 what you want when a customer cancels service and that you really should be
1124 looking at L<FS::cust_pkg/cancel>?
1125
1126 You can't delete a customer with invoices (see L<FS::cust_bill>),
1127 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1128 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1129 set the "delete_financials" option to a true value.
1130
1131 =cut
1132
1133 sub delete {
1134   my( $self, %opt ) = @_;
1135
1136   local $SIG{HUP} = 'IGNORE';
1137   local $SIG{INT} = 'IGNORE';
1138   local $SIG{QUIT} = 'IGNORE';
1139   local $SIG{TERM} = 'IGNORE';
1140   local $SIG{TSTP} = 'IGNORE';
1141   local $SIG{PIPE} = 'IGNORE';
1142
1143   my $oldAutoCommit = $FS::UID::AutoCommit;
1144   local $FS::UID::AutoCommit = 0;
1145   my $dbh = dbh;
1146
1147   if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1148      $dbh->rollback if $oldAutoCommit;
1149      return "Can't delete a master agent customer";
1150   }
1151
1152   #use FS::access_user
1153   if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1154      $dbh->rollback if $oldAutoCommit;
1155      return "Can't delete a master employee customer";
1156   }
1157
1158   tie my %financial_tables, 'Tie::IxHash',
1159     'cust_bill'      => 'invoices',
1160     'cust_statement' => 'statements',
1161     'cust_credit'    => 'credits',
1162     'cust_pay'       => 'payments',
1163     'cust_refund'    => 'refunds',
1164   ;
1165
1166   foreach my $table ( keys %financial_tables ) {
1167
1168     my @records = $self->$table();
1169
1170     if ( @records && ! $opt{'delete_financials'} ) {
1171       $dbh->rollback if $oldAutoCommit;
1172       return "Can't delete a customer with ". $financial_tables{$table};
1173     }
1174
1175     foreach my $record ( @records ) {
1176       my $error = $record->delete;
1177       if ( $error ) {
1178         $dbh->rollback if $oldAutoCommit;
1179         return "Error deleting ". $financial_tables{$table}. ": $error\n";
1180       }
1181     }
1182
1183   }
1184
1185   my @cust_pkg = $self->ncancelled_pkgs;
1186   if ( @cust_pkg ) {
1187     my $new_custnum = $opt{'new_custnum'};
1188     unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1189       $dbh->rollback if $oldAutoCommit;
1190       return "Invalid new customer number: $new_custnum";
1191     }
1192     foreach my $cust_pkg ( @cust_pkg ) {
1193       my %hash = $cust_pkg->hash;
1194       $hash{'custnum'} = $new_custnum;
1195       my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1196       my $error = $new_cust_pkg->replace($cust_pkg,
1197                                          options => { $cust_pkg->options },
1198                                         );
1199       if ( $error ) {
1200         $dbh->rollback if $oldAutoCommit;
1201         return $error;
1202       }
1203     }
1204   }
1205   my @cancelled_cust_pkg = $self->all_pkgs;
1206   foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1207     my $error = $cust_pkg->delete;
1208     if ( $error ) {
1209       $dbh->rollback if $oldAutoCommit;
1210       return $error;
1211     }
1212   }
1213
1214   #cust_tax_adjustment in financials?
1215   #cust_pay_pending?  ouch
1216   foreach my $table (qw(
1217     cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1218     cust_payby cust_location cust_main_note cust_tax_adjustment
1219     cust_pay_void cust_pay_batch queue cust_tax_exempt
1220   )) {
1221     foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1222       my $error = $record->delete;
1223       if ( $error ) {
1224         $dbh->rollback if $oldAutoCommit;
1225         return $error;
1226       }
1227     }
1228   }
1229
1230   my $sth = $dbh->prepare(
1231     'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1232   ) or do {
1233     my $errstr = $dbh->errstr;
1234     $dbh->rollback if $oldAutoCommit;
1235     return $errstr;
1236   };
1237   $sth->execute($self->custnum) or do {
1238     my $errstr = $sth->errstr;
1239     $dbh->rollback if $oldAutoCommit;
1240     return $errstr;
1241   };
1242
1243   #tickets
1244
1245   my $ticket_dbh = '';
1246   if ($conf->config('ticket_system') eq 'RT_Internal') {
1247     $ticket_dbh = $dbh;
1248   } elsif ($conf->config('ticket_system') eq 'RT_External') {
1249     my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1250     $ticket_dbh = FS::DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1251       #or die "RT_External DBI->connect error: $DBI::errstr\n";
1252   }
1253
1254   if ( $ticket_dbh ) {
1255
1256     my $ticket_sth = $ticket_dbh->prepare(
1257       'DELETE FROM Links WHERE Target = ?'
1258     ) or do {
1259       my $errstr = $ticket_dbh->errstr;
1260       $dbh->rollback if $oldAutoCommit;
1261       return $errstr;
1262     };
1263     $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1264       or do {
1265         my $errstr = $ticket_sth->errstr;
1266         $dbh->rollback if $oldAutoCommit;
1267         return $errstr;
1268       };
1269
1270     #check and see if the customer is the only link on the ticket, and
1271     #if so, set the ticket to deleted status in RT?
1272     #maybe someday, for now this will at least fix tickets not displaying
1273
1274   }
1275
1276   #delete the customer record
1277
1278   my $error = $self->SUPER::delete;
1279   if ( $error ) {
1280     $dbh->rollback if $oldAutoCommit;
1281     return $error;
1282   }
1283
1284   # cust_main exports!
1285
1286   #my $export_args = $options{'export_args'} || [];
1287
1288   my @part_export =
1289     map qsearch( 'part_export', {exportnum=>$_} ),
1290       $conf->config('cust_main-exports'); #, $agentnum
1291
1292   foreach my $part_export ( @part_export ) {
1293     my $error = $part_export->export_delete( $self ); #, @$export_args);
1294     if ( $error ) {
1295       $dbh->rollback if $oldAutoCommit;
1296       return "exporting to ". $part_export->exporttype.
1297              " (transaction rolled back): $error";
1298     }
1299   }
1300
1301   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1302   '';
1303
1304 }
1305
1306 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1307
1308 Replaces the OLD_RECORD with this one in the database.  If there is an error,
1309 returns the error, otherwise returns false.
1310
1311 To change the customer's address, set the pseudo-fields C<bill_location> and
1312 C<ship_location>.  The address will still only change if at least one of the
1313 address fields differs from the existing values.
1314
1315 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1316 set as the contact email address for a default contact with the same name as
1317 the customer.
1318
1319 Currently available options are: I<tax_exemption>, I<cust_payby_params>,
1320 I<contact_params>, I<invoicing_list>.
1321
1322 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1323 of tax names and exemption numbers.  FS::cust_main_exemption records will be
1324 deleted and inserted as appropriate.
1325
1326 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1327 groups (describing the customer's payment methods and contacts, respectively)
1328 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1329 and L<FS::contact> for the fields these can contain.
1330
1331 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1332 should be used instead if possible.
1333
1334 =cut
1335
1336 sub replace {
1337   my $self = shift;
1338
1339   my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1340               ? shift
1341               : $self->replace_old;
1342
1343   my @param = @_;
1344
1345   warn "$me replace called\n"
1346     if $DEBUG;
1347
1348   my $curuser = $FS::CurrentUser::CurrentUser;
1349   return "You are not permitted to create complimentary accounts."
1350     if $self->complimentary eq 'Y'
1351     && $self->complimentary ne $old->complimentary
1352     && ! $curuser->access_right('Complimentary customer');
1353
1354   local($ignore_expired_card) = 1
1355     if $old->payby  =~ /^(CARD|DCRD)$/
1356     && $self->payby =~ /^(CARD|DCRD)$/
1357     && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1358
1359   local($ignore_banned_card) = 1
1360     if (    $old->payby  =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1361          || $old->payby  =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1362     && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1363
1364   if (    $self->payby =~ /^(CARD|DCRD)$/
1365        && $old->payinfo ne $self->payinfo
1366        && $old->paymask ne $self->paymask )
1367   {
1368     my $error = $self->check_payinfo_cardtype;
1369     return $error if $error;
1370   }
1371
1372   return "Invoicing locale is required"
1373     if $old->locale
1374     && ! $self->locale
1375     && $conf->exists('cust_main-require_locale');
1376
1377   return "You are not permitted to change customer invoicing terms."
1378     if $old->invoice_terms ne $self->invoice_terms
1379     && ! $curuser->access_right('Edit customer invoice terms');
1380
1381   local $SIG{HUP} = 'IGNORE';
1382   local $SIG{INT} = 'IGNORE';
1383   local $SIG{QUIT} = 'IGNORE';
1384   local $SIG{TERM} = 'IGNORE';
1385   local $SIG{TSTP} = 'IGNORE';
1386   local $SIG{PIPE} = 'IGNORE';
1387
1388   my $oldAutoCommit = $FS::UID::AutoCommit;
1389   local $FS::UID::AutoCommit = 0;
1390   my $dbh = dbh;
1391
1392   for my $l (qw(bill_location ship_location)) {
1393     #my $old_loc = $old->$l;
1394     my $new_loc = $self->$l or next;
1395
1396     # find the existing location if there is one
1397     $new_loc->set('custnum' => $self->custnum);
1398     my $error = $new_loc->find_or_insert;
1399     if ( $error ) {
1400       $dbh->rollback if $oldAutoCommit;
1401       return $error;
1402     }
1403     $self->set($l.'num', $new_loc->locationnum);
1404   } #for $l
1405
1406   my $invoicing_list;
1407   if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1408     warn "cust_main::replace: using deprecated invoicing list argument";
1409     $invoicing_list = shift @param;
1410   }
1411
1412   my %options = @param;
1413
1414   $invoicing_list ||= $options{invoicing_list};
1415
1416   my @contacts = map { $_->contact } $self->cust_contact;
1417   # find a contact that matches the customer's name
1418   my ($implicit_contact) = grep { $_->first eq $old->get('first')
1419                               and $_->last  eq $old->get('last') }
1420                             @contacts;
1421   $implicit_contact ||= FS::contact->new({
1422       'custnum'       => $self->custnum,
1423       'locationnum'   => $self->get('bill_locationnum'),
1424   });
1425
1426   # for any of these that are already contact emails, link to the existing
1427   # contact
1428   if ( $invoicing_list ) {
1429     my $email = '';
1430
1431     # kind of like process_m2m on these, except:
1432     # - the other side is two tables in a join
1433     # - and we might have to create new contact_emails
1434     # - and possibly a new contact
1435     #
1436     # Find existing invoice emails that aren't on the implicit contact.
1437     # Any of these that are not on the new invoicing list will be removed.
1438     my %old_email_cust_contact;
1439     foreach my $cust_contact ($self->cust_contact) {
1440       next if !$cust_contact->invoice_dest;
1441       next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1442
1443       foreach my $contact_email ($cust_contact->contact->contact_email) {
1444         $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1445       }
1446     }
1447
1448     foreach my $dest (@$invoicing_list) {
1449
1450       if ($dest eq 'POST') {
1451
1452         $self->set('postal_invoice', 'Y');
1453
1454       } elsif ( exists($old_email_cust_contact{$dest}) ) {
1455
1456         delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1457
1458       } else {
1459
1460         # See if it belongs to some other contact; if so, link it.
1461         my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1462         if ( $contact_email
1463              and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1464           my $cust_contact = qsearchs('cust_contact', {
1465               contactnum  => $contact_email->contactnum,
1466               custnum     => $self->custnum,
1467           }) || FS::cust_contact->new({
1468               contactnum    => $contact_email->contactnum,
1469               custnum       => $self->custnum,
1470           });
1471           $cust_contact->set('invoice_dest', 'Y');
1472           my $error = $cust_contact->custcontactnum ?
1473                         $cust_contact->replace : $cust_contact->insert;
1474           if ( $error ) {
1475             $dbh->rollback if $oldAutoCommit;
1476             return "$error (linking to email address $dest)";
1477           }
1478
1479         } else {
1480           # This email address is not yet linked to any contact, so it will
1481           # be added to the implicit contact.
1482           $email .= ',' if length($email);
1483           $email .= $dest;
1484         }
1485       }
1486     }
1487
1488     foreach my $remove_dest (keys %old_email_cust_contact) {
1489       my $cust_contact = $old_email_cust_contact{$remove_dest};
1490       # These were not in the list of requested destinations, so take them off.
1491       $cust_contact->set('invoice_dest', '');
1492       my $error = $cust_contact->replace;
1493       if ( $error ) {
1494         $dbh->rollback if $oldAutoCommit;
1495         return "$error (unlinking email address $remove_dest)";
1496       }
1497     }
1498
1499     # make sure it keeps up with the changed customer name, if any
1500     $implicit_contact->set('last', $self->get('last'));
1501     $implicit_contact->set('first', $self->get('first'));
1502     $implicit_contact->set('emailaddress', $email);
1503     $implicit_contact->set('invoice_dest', 'Y');
1504     $implicit_contact->set('custnum', $self->custnum);
1505     my $i_cust_contact =
1506       qsearchs('cust_contact', {
1507                                  contactnum  => $implicit_contact->contactnum,
1508                                  custnum     => $self->custnum,
1509                                }
1510       );
1511     if ( $i_cust_contact ) {
1512       $implicit_contact->set($_, $i_cust_contact->$_)
1513         foreach qw( classnum selfservice_access comment );
1514     }
1515
1516     my $error;
1517     if ( $implicit_contact->contactnum ) {
1518       $error = $implicit_contact->replace;
1519     } elsif ( length($email) ) { # don't create a new contact if not needed
1520       $error = $implicit_contact->insert;
1521     }
1522
1523     if ( $error ) {
1524       $dbh->rollback if $oldAutoCommit;
1525       return "$error (adding email address $email)";
1526     }
1527
1528   }
1529
1530   # replace the customer record
1531   my $error = $self->SUPER::replace($old);
1532
1533   if ( $error ) {
1534     $dbh->rollback if $oldAutoCommit;
1535     return $error;
1536   }
1537
1538   # now move packages to the new service location
1539   $self->set('ship_location', ''); #flush cache
1540   if ( $old->ship_locationnum and # should only be null during upgrade...
1541        $old->ship_locationnum != $self->ship_locationnum ) {
1542     $error = $old->ship_location->move_to($self->ship_location);
1543     if ( $error ) {
1544       $dbh->rollback if $oldAutoCommit;
1545       return $error;
1546     }
1547   }
1548   # don't move packages based on the billing location, but
1549   # disable it if it's no longer in use
1550   if ( $old->bill_locationnum and
1551        $old->bill_locationnum != $self->bill_locationnum ) {
1552     $error = $old->bill_location->disable_if_unused;
1553     if ( $error ) {
1554       $dbh->rollback if $oldAutoCommit;
1555       return $error;
1556     }
1557   }
1558
1559   if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1560
1561     #this could be more efficient than deleting and re-inserting, if it matters
1562     foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1563       my $error = $cust_tag->delete;
1564       if ( $error ) {
1565         $dbh->rollback if $oldAutoCommit;
1566         return $error;
1567       }
1568     }
1569     foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1570       my $cust_tag = new FS::cust_tag { 'tagnum'  => $tagnum,
1571                                         'custnum' => $self->custnum };
1572       my $error = $cust_tag->insert;
1573       if ( $error ) {
1574         $dbh->rollback if $oldAutoCommit;
1575         return $error;
1576       }
1577     }
1578
1579   }
1580
1581   my $tax_exemption = delete $options{'tax_exemption'};
1582   if ( $tax_exemption ) {
1583
1584     $tax_exemption = { map { $_ => '' } @$tax_exemption }
1585       if ref($tax_exemption) eq 'ARRAY';
1586
1587     my %cust_main_exemption =
1588       map { $_->taxname => $_ }
1589           qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1590
1591     foreach my $taxname ( keys %$tax_exemption ) {
1592
1593       if ( $cust_main_exemption{$taxname} &&
1594            $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1595          )
1596       {
1597         delete $cust_main_exemption{$taxname};
1598         next;
1599       }
1600
1601       my $cust_main_exemption = new FS::cust_main_exemption {
1602         'custnum'       => $self->custnum,
1603         'taxname'       => $taxname,
1604         'exempt_number' => $tax_exemption->{$taxname},
1605       };
1606       my $error = $cust_main_exemption->insert;
1607       if ( $error ) {
1608         $dbh->rollback if $oldAutoCommit;
1609         return "inserting cust_main_exemption (transaction rolled back): $error";
1610       }
1611     }
1612
1613     foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1614       my $error = $cust_main_exemption->delete;
1615       if ( $error ) {
1616         $dbh->rollback if $oldAutoCommit;
1617         return "deleting cust_main_exemption (transaction rolled back): $error";
1618       }
1619     }
1620
1621   }
1622
1623   if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1624
1625     my $error = $self->process_o2m(
1626       'table'         => 'cust_payby',
1627       'fields'        => FS::cust_payby->cgi_cust_payby_fields,
1628       'params'        => $cust_payby_params,
1629       'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1630     );
1631     if ( $error ) {
1632       $dbh->rollback if $oldAutoCommit;
1633       return $error;
1634     }
1635
1636   }
1637
1638   if ( my $contact_params = delete $options{'contact_params'} ) {
1639
1640     # this can potentially replace contacts that were created by the
1641     # invoicing list argument, but the UI shouldn't allow both of them
1642     # to be specified
1643
1644     my $error = $self->process_o2m(
1645       'table'         => 'contact',
1646       'fields'        => FS::contact->cgi_contact_fields,
1647       'params'        => $contact_params,
1648     );
1649     if ( $error ) {
1650       $dbh->rollback if $oldAutoCommit;
1651       return $error;
1652     }
1653
1654   }
1655
1656   unless ( $import || $skip_fuzzyfiles ) {
1657     $error = $self->queue_fuzzyfiles_update;
1658     if ( $error ) {
1659       $dbh->rollback if $oldAutoCommit;
1660       return "updating fuzzy search cache: $error";
1661     }
1662   }
1663
1664   # tax district update in cust_location
1665
1666   # cust_main exports!
1667
1668   my $export_args = $options{'export_args'} || [];
1669
1670   my @part_export =
1671     map qsearch( 'part_export', {exportnum=>$_} ),
1672       $conf->config('cust_main-exports'); #, $agentnum
1673
1674   foreach my $part_export ( @part_export ) {
1675     my $error = $part_export->export_replace( $self, $old, @$export_args);
1676     if ( $error ) {
1677       $dbh->rollback if $oldAutoCommit;
1678       return "exporting to ". $part_export->exporttype.
1679              " (transaction rolled back): $error";
1680     }
1681   }
1682
1683   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1684   '';
1685
1686 }
1687
1688 =item queue_fuzzyfiles_update
1689
1690 Used by insert & replace to update the fuzzy search cache
1691
1692 =cut
1693
1694 use FS::cust_main::Search;
1695 sub queue_fuzzyfiles_update {
1696   my $self = shift;
1697
1698   local $SIG{HUP} = 'IGNORE';
1699   local $SIG{INT} = 'IGNORE';
1700   local $SIG{QUIT} = 'IGNORE';
1701   local $SIG{TERM} = 'IGNORE';
1702   local $SIG{TSTP} = 'IGNORE';
1703   local $SIG{PIPE} = 'IGNORE';
1704
1705   my $oldAutoCommit = $FS::UID::AutoCommit;
1706   local $FS::UID::AutoCommit = 0;
1707   my $dbh = dbh;
1708
1709   foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1710     my $queue = new FS::queue {
1711       'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1712     };
1713     my @args = "cust_main.$field", $self->get($field);
1714     my $error = $queue->insert( @args );
1715     if ( $error ) {
1716       $dbh->rollback if $oldAutoCommit;
1717       return "queueing job (transaction rolled back): $error";
1718     }
1719   }
1720
1721   my @locations = ();
1722   push @locations, $self->bill_location if $self->bill_locationnum;
1723   push @locations, $self->ship_location if @locations && $self->has_ship_address;
1724   foreach my $location (@locations) {
1725     my $queue = new FS::queue {
1726       'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1727     };
1728     my @args = 'cust_location.address1', $location->address1;
1729     my $error = $queue->insert( @args );
1730     if ( $error ) {
1731       $dbh->rollback if $oldAutoCommit;
1732       return "queueing job (transaction rolled back): $error";
1733     }
1734   }
1735
1736   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1737   '';
1738
1739 }
1740
1741 =item check
1742
1743 Checks all fields to make sure this is a valid customer record.  If there is
1744 an error, returns the error, otherwise returns false.  Called by the insert
1745 and replace methods.
1746
1747 =cut
1748
1749 sub check {
1750   my $self = shift;
1751
1752   warn "$me check BEFORE: \n". $self->_dump
1753     if $DEBUG > 2;
1754
1755   my $error =
1756     $self->ut_numbern('custnum')
1757     || $self->ut_number('agentnum')
1758     || $self->ut_textn('agent_custid')
1759     || $self->ut_number('refnum')
1760     || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1761     || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1762     || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1763     || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1764     || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1765     || $self->ut_textn('custbatch')
1766     || $self->ut_name('last')
1767     || $self->ut_name('first')
1768     || $self->ut_snumbern('signupdate')
1769     || $self->ut_snumbern('birthdate')
1770     || $self->ut_namen('spouse_last')
1771     || $self->ut_namen('spouse_first')
1772     || $self->ut_snumbern('spouse_birthdate')
1773     || $self->ut_snumbern('anniversary_date')
1774     || $self->ut_textn('company')
1775     || $self->ut_textn('ship_company')
1776     || $self->ut_anything('comments')
1777     || $self->ut_numbern('referral_custnum')
1778     || $self->ut_textn('stateid')
1779     || $self->ut_textn('stateid_state')
1780     || $self->ut_textn('invoice_terms')
1781     || $self->ut_floatn('cdr_termination_percentage')
1782     || $self->ut_floatn('credit_limit')
1783     || $self->ut_numbern('billday')
1784     || $self->ut_numbern('prorate_day')
1785     || $self->ut_flag('force_prorate_day')
1786     || $self->ut_flag('edit_subject')
1787     || $self->ut_flag('calling_list_exempt')
1788     || $self->ut_flag('invoice_noemail')
1789     || $self->ut_flag('message_noemail')
1790     || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1791     || $self->ut_currencyn('currency')
1792     || $self->ut_textn('po_number')
1793     || $self->ut_enum('complimentary', [ '', 'Y' ])
1794     || $self->ut_flag('invoice_ship_address')
1795     || $self->ut_flag('invoice_dest')
1796   ;
1797
1798   foreach (qw(company ship_company)) {
1799     my $company = $self->get($_);
1800     $company =~ s/^\s+//;
1801     $company =~ s/\s+$//;
1802     $company =~ s/\s+/ /g;
1803     $self->set($_, $company);
1804   }
1805
1806   #barf.  need message catalogs.  i18n.  etc.
1807   $error .= "Please select an advertising source."
1808     if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1809   return $error if $error;
1810
1811   my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1812     or return "Unknown agent";
1813
1814   if ( $self->currency ) {
1815     my $agent_currency = qsearchs( 'agent_currency', {
1816       'agentnum' => $agent->agentnum,
1817       'currency' => $self->currency,
1818     })
1819       or return "Agent ". $agent->agent.
1820                 " not permitted to offer ".  $self->currency. " invoicing";
1821   }
1822
1823   return "Unknown refnum"
1824     unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1825
1826   return "Unknown referring custnum: ". $self->referral_custnum
1827     unless ! $self->referral_custnum
1828            || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1829
1830   if ( $self->ss eq '' ) {
1831     $self->ss('');
1832   } else {
1833     my $ss = $self->ss;
1834     $ss =~ s/\D//g;
1835     $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1836       or return "Illegal social security number: ". $self->ss;
1837     $self->ss("$1-$2-$3");
1838   }
1839
1840   #turn off invoice_ship_address if ship & bill are the same
1841   if ($self->bill_locationnum eq $self->ship_locationnum) {
1842     $self->invoice_ship_address('');
1843   }
1844
1845   # cust_main_county verification now handled by cust_location check
1846
1847   $error =
1848        $self->ut_phonen('daytime', $self->country)
1849     || $self->ut_phonen('night',   $self->country)
1850     || $self->ut_phonen('fax',     $self->country)
1851     || $self->ut_phonen('mobile',  $self->country)
1852   ;
1853   return $error if $error;
1854
1855   if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1856        && ! $import
1857        && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1858      ) {
1859
1860     my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1861                           ? 'Day Phone'
1862                           : FS::Msgcat::_gettext('daytime');
1863     my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1864                         ? 'Night Phone'
1865                         : FS::Msgcat::_gettext('night');
1866
1867     my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1868                         ? 'Mobile Phone'
1869                         : FS::Msgcat::_gettext('mobile');
1870
1871     return "$daytime_label, $night_label or $mobile_label is required"
1872
1873   }
1874
1875   ### start of stuff moved to cust_payby
1876   # then mostly kept here to support upgrades (can remove in 5.x)
1877   #  but modified to allow everything to be empty
1878
1879   if ( $self->payby ) {
1880     FS::payby->can_payby($self->table, $self->payby)
1881       or return "Illegal payby: ". $self->payby;
1882   } else {
1883     $self->payby('');
1884   }
1885
1886   $error =    $self->ut_numbern('paystart_month')
1887            || $self->ut_numbern('paystart_year')
1888            || $self->ut_numbern('payissue')
1889            || $self->ut_textn('paytype')
1890   ;
1891   return $error if $error;
1892
1893   if ( $self->payip eq '' ) {
1894     $self->payip('');
1895   } else {
1896     $error = $self->ut_ip('payip');
1897     return $error if $error;
1898   }
1899
1900   # If it is encrypted and the private key is not availaible then we can't
1901   # check the credit card.
1902   my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1903
1904   # Need some kind of global flag to accept invalid cards, for testing
1905   # on scrubbed data.
1906   if ( !$import && !$ignore_invalid_card && $check_payinfo &&
1907     $self->payby =~ /^(CARD|DCRD)$/ ) {
1908
1909     my $payinfo = $self->payinfo;
1910     $payinfo =~ s/\D//g;
1911     $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1912       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1913     $payinfo = $1;
1914     $self->payinfo($payinfo);
1915     validate($payinfo)
1916       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1917
1918     return gettext('unknown_card_type')
1919       if $self->payinfo !~ /^99\d{14}$/ #token
1920       && cardtype($self->payinfo) eq "Unknown";
1921
1922     unless ( $ignore_banned_card ) {
1923       my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1924       if ( $ban ) {
1925         if ( $ban->bantype eq 'warn' ) {
1926           #or others depending on value of $ban->reason ?
1927           return '_duplicate_card'.
1928                  ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1929                  ' until '.         time2str('%a %h %o at %r', $ban->_end_date).
1930                  ' (ban# '. $ban->bannum. ')'
1931             unless $self->override_ban_warn;
1932         } else {
1933           return 'Banned credit card: banned on '.
1934                  time2str('%a %h %o at %r', $ban->_date).
1935                  ' by '. $ban->otaker.
1936                  ' (ban# '. $ban->bannum. ')';
1937         }
1938       }
1939     }
1940
1941     if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1942       if ( cardtype($self->payinfo) eq 'American Express card' ) {
1943         $self->paycvv =~ /^(\d{4})$/
1944           or return "CVV2 (CID) for American Express cards is four digits.";
1945         $self->paycvv($1);
1946       } else {
1947         $self->paycvv =~ /^(\d{3})$/
1948           or return "CVV2 (CVC2/CID) is three digits.";
1949         $self->paycvv($1);
1950       }
1951     } else {
1952       $self->paycvv('');
1953     }
1954
1955     my $cardtype = cardtype($payinfo);
1956     if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1957
1958       return "Start date or issue number is required for $cardtype cards"
1959         unless $self->paystart_month && $self->paystart_year or $self->payissue;
1960
1961       return "Start month must be between 1 and 12"
1962         if $self->paystart_month
1963            and $self->paystart_month < 1 || $self->paystart_month > 12;
1964
1965       return "Start year must be 1990 or later"
1966         if $self->paystart_year
1967            and $self->paystart_year < 1990;
1968
1969       return "Issue number must be beween 1 and 99"
1970         if $self->payissue
1971           and $self->payissue < 1 || $self->payissue > 99;
1972
1973     } else {
1974       $self->paystart_month('');
1975       $self->paystart_year('');
1976       $self->payissue('');
1977     }
1978
1979   } elsif ( !$ignore_invalid_card && $check_payinfo &&
1980     $self->payby =~ /^(CHEK|DCHK)$/ ) {
1981
1982     my $payinfo = $self->payinfo;
1983     $payinfo =~ s/[^\d\@\.]//g;
1984     if ( $conf->config('echeck-country') eq 'CA' ) {
1985       $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1986         or return 'invalid echeck account@branch.bank';
1987       $payinfo = "$1\@$2.$3";
1988     } elsif ( $conf->config('echeck-country') eq 'US' ) {
1989       $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1990       $payinfo = "$1\@$2";
1991     } else {
1992       $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1993       $payinfo = "$1\@$2";
1994     }
1995     $self->payinfo($payinfo);
1996     $self->paycvv('');
1997
1998     unless ( $ignore_banned_card ) {
1999       my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
2000       if ( $ban ) {
2001         if ( $ban->bantype eq 'warn' ) {
2002           #or others depending on value of $ban->reason ?
2003           return '_duplicate_ach' unless $self->override_ban_warn;
2004         } else {
2005           return 'Banned ACH account: banned on '.
2006                  time2str('%a %h %o at %r', $ban->_date).
2007                  ' by '. $ban->otaker.
2008                  ' (ban# '. $ban->bannum. ')';
2009         }
2010       }
2011     }
2012
2013   } elsif ( $self->payby eq 'LECB' ) {
2014
2015     my $payinfo = $self->payinfo;
2016     $payinfo =~ s/\D//g;
2017     $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2018     $payinfo = $1;
2019     $self->payinfo($payinfo);
2020     $self->paycvv('');
2021
2022   } elsif ( $self->payby eq 'BILL' ) {
2023
2024     $error = $self->ut_textn('payinfo');
2025     return "Illegal P.O. number: ". $self->payinfo if $error;
2026     $self->paycvv('');
2027
2028   } elsif ( $self->payby eq 'COMP' ) {
2029
2030     my $curuser = $FS::CurrentUser::CurrentUser;
2031     if (    ! $self->custnum
2032          && ! $curuser->access_right('Complimentary customer')
2033        )
2034     {
2035       return "You are not permitted to create complimentary accounts."
2036     }
2037
2038     $error = $self->ut_textn('payinfo');
2039     return "Illegal comp account issuer: ". $self->payinfo if $error;
2040     $self->paycvv('');
2041
2042   } elsif ( $self->payby eq 'PREPAY' ) {
2043
2044     my $payinfo = $self->payinfo;
2045     $payinfo =~ s/\W//g; #anything else would just confuse things
2046     $self->payinfo($payinfo);
2047     $error = $self->ut_alpha('payinfo');
2048     return "Illegal prepayment identifier: ". $self->payinfo if $error;
2049     return "Unknown prepayment identifier"
2050       unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2051     $self->paycvv('');
2052
2053   }
2054
2055   return "You are not permitted to create complimentary accounts."
2056     if ! $self->custnum
2057     && $self->complimentary eq 'Y'
2058     && ! $FS::CurrentUser::CurrentUser->access_right('Complimentary customer');
2059
2060   if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2061     return "Expiration date required"
2062       # shouldn't payinfo_check do this?
2063       unless ! $self->payby
2064             || $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2065     $self->paydate('');
2066   } else {
2067     my( $m, $y );
2068     if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2069       ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2070     } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2071       ( $m, $y ) = ( $2, "19$1" );
2072     } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2073       ( $m, $y ) = ( $3, "20$2" );
2074     } else {
2075       return "Illegal expiration date: ". $self->paydate;
2076     }
2077     $m = sprintf('%02d',$m);
2078     $self->paydate("$y-$m-01");
2079     my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2080     return gettext('expired_card')
2081       if !$import
2082       && !$ignore_expired_card
2083       && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2084   }
2085
2086   if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2087        ( ! $conf->exists('require_cardname')
2088          || $self->payby !~ /^(CARD|DCRD)$/  )
2089   ) {
2090     $self->payname( $self->first. " ". $self->getfield('last') );
2091   } else {
2092
2093     if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2094       $self->payname =~ /^([\w \,\.\-\']*)$/
2095         or return gettext('illegal_name'). " payname: ". $self->payname;
2096       $self->payname($1);
2097     } else {
2098       $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2099         or return gettext('illegal_name'). " payname: ". $self->payname;
2100       $self->payname($1);
2101     }
2102
2103   }
2104
2105   ### end of stuff moved to cust_payby
2106
2107   return "Please select an invoicing locale"
2108     if ! $self->locale
2109     && ! $self->custnum
2110     && $conf->exists('cust_main-require_locale');
2111
2112   return "Please select a customer class"
2113     if ! $self->classnum
2114     && $conf->exists('cust_main-require_classnum');
2115
2116   foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2117     $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2118     $self->$flag($1);
2119   }
2120
2121   $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2122
2123   warn "$me check AFTER: \n". $self->_dump
2124     if $DEBUG > 2;
2125
2126   $self->SUPER::check;
2127 }
2128
2129 sub check_payinfo_cardtype {
2130   my $self = shift;
2131
2132   return '' unless $self->payby =~ /^(CARD|DCRD)$/;
2133
2134   my $payinfo = $self->payinfo;
2135   $payinfo =~ s/\D//g;
2136
2137   return '' if $self->tokenized($payinfo); #token
2138
2139   my %bop_card_types = map { $_=>1 } values %{ card_types() };
2140   my $cardtype = cardtype($payinfo);
2141
2142   return "$cardtype not accepted" unless $bop_card_types{$cardtype};
2143
2144   '';
2145
2146 }
2147
2148 =item replace_check
2149
2150 Additional checks for replace only.
2151
2152 =cut
2153
2154 sub replace_check {
2155   my ($new,$old) = @_;
2156   #preserve old value if global config is set
2157   if ($old && $conf->exists('invoice-ship_address')) {
2158     $new->invoice_ship_address($old->invoice_ship_address);
2159   }
2160   return '';
2161 }
2162
2163 =item addr_fields
2164
2165 Returns a list of fields which have ship_ duplicates.
2166
2167 =cut
2168
2169 sub addr_fields {
2170   qw( last first company
2171       locationname
2172       address1 address2 city county state zip country
2173       latitude longitude
2174       daytime night fax mobile
2175     );
2176 }
2177
2178 =item has_ship_address
2179
2180 Returns true if this customer record has a separate shipping address.
2181
2182 =cut
2183
2184 sub has_ship_address {
2185   my $self = shift;
2186   $self->bill_locationnum != $self->ship_locationnum;
2187 }
2188
2189 =item location_hash
2190
2191 Returns a list of key/value pairs, with the following keys: address1,
2192 adddress2, city, county, state, zip, country, district, and geocode.  The
2193 shipping address is used if present.
2194
2195 =cut
2196
2197 sub location_hash {
2198   my $self = shift;
2199   $self->ship_location->location_hash;
2200 }
2201
2202 =item cust_location
2203
2204 Returns all locations (see L<FS::cust_location>) for this customer.
2205
2206 =cut
2207
2208 sub cust_location {
2209   my $self = shift;
2210   qsearch({
2211     'table'   => 'cust_location',
2212     'hashref' => { 'custnum'     => $self->custnum,
2213                    'prospectnum' => '',
2214                  },
2215     'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
2216   });
2217 }
2218
2219 =item cust_contact
2220
2221 Returns all contact associations (see L<FS::cust_contact>) for this customer.
2222
2223 =cut
2224
2225 sub cust_contact {
2226   my $self = shift;
2227   qsearch('cust_contact', { 'custnum' => $self->custnum } );
2228 }
2229
2230 =item cust_payby PAYBY
2231
2232 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2233
2234 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
2235 Does not validate PAYBY.
2236
2237 =cut
2238
2239 sub cust_payby {
2240   my $self = shift;
2241   my @payby = @_;
2242   my $search = {
2243     'table'    => 'cust_payby',
2244     'hashref'  => { 'custnum' => $self->custnum },
2245     'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
2246   };
2247   $search->{'extra_sql'} = ' AND payby IN ( '.
2248                                join(',', map dbh->quote($_), @payby).
2249                              ' ) '
2250     if @payby;
2251
2252   qsearch($search);
2253 }
2254
2255 =item has_cust_payby_auto
2256
2257 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2258
2259 =cut
2260
2261 sub has_cust_payby_auto {
2262   my $self = shift;
2263   scalar( qsearch({
2264     'table'     => 'cust_payby',
2265     'hashref'   => { 'custnum' => $self->custnum, },
2266     'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2267     'order_by'  => 'LIMIT 1',
2268   }) );
2269
2270 }
2271
2272 =item unsuspend
2273
2274 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2275 and L<FS::cust_pkg>) for this customer, except those on hold.
2276
2277 Returns a list: an empty list on success or a list of errors.
2278
2279 =cut
2280
2281 sub unsuspend {
2282   my $self = shift;
2283   grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs(@_);
2284 }
2285
2286 =item release_hold
2287
2288 Unsuspends all suspended packages in the on-hold state (those without setup
2289 dates) for this customer.
2290
2291 =cut
2292
2293 sub release_hold {
2294   my $self = shift;
2295   grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2296 }
2297
2298 =item suspend
2299
2300 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2301
2302 Returns a list: an empty list on success or a list of errors.
2303
2304 =cut
2305
2306 sub suspend {
2307   my $self = shift;
2308   grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2309 }
2310
2311 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2312
2313 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2314 PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref instead
2315 of a list of pkgparts; the hashref has the following keys:
2316
2317 =over 4
2318
2319 =item pkgparts - listref of pkgparts
2320
2321 =item (other options are passed to the suspend method)
2322
2323 =back
2324
2325
2326 Returns a list: an empty list on success or a list of errors.
2327
2328 =cut
2329
2330 sub suspend_if_pkgpart {
2331   my $self = shift;
2332   my (@pkgparts, %opt);
2333   if (ref($_[0]) eq 'HASH'){
2334     @pkgparts = @{$_[0]{pkgparts}};
2335     %opt      = %{$_[0]};
2336   }else{
2337     @pkgparts = @_;
2338   }
2339   grep { $_->suspend(%opt) }
2340     grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2341       $self->unsuspended_pkgs;
2342 }
2343
2344 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2345
2346 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2347 given PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref
2348 instead of a list of pkgparts; the hashref has the following keys:
2349
2350 =over 4
2351
2352 =item pkgparts - listref of pkgparts
2353
2354 =item (other options are passed to the suspend method)
2355
2356 =back
2357
2358 Returns a list: an empty list on success or a list of errors.
2359
2360 =cut
2361
2362 sub suspend_unless_pkgpart {
2363   my $self = shift;
2364   my (@pkgparts, %opt);
2365   if (ref($_[0]) eq 'HASH'){
2366     @pkgparts = @{$_[0]{pkgparts}};
2367     %opt      = %{$_[0]};
2368   }else{
2369     @pkgparts = @_;
2370   }
2371   grep { $_->suspend(%opt) }
2372     grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2373       $self->unsuspended_pkgs;
2374 }
2375
2376 =item cancel [ OPTION => VALUE ... ]
2377
2378 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2379 The cancellation time will be now.
2380
2381 =back
2382
2383 Always returns a list: an empty list on success or a list of errors.
2384
2385 =cut
2386
2387 sub cancel {
2388   my $self = shift;
2389   my %opt = @_;
2390   warn "$me cancel called on customer ". $self->custnum. " with options ".
2391        join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2392     if $DEBUG;
2393   my @pkgs = $self->ncancelled_pkgs;
2394
2395   $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2396 }
2397
2398 =item cancel_pkgs OPTIONS
2399
2400 Cancels a specified list of packages. OPTIONS can include:
2401
2402 =over 4
2403
2404 =item cust_pkg - an arrayref of the packages. Required.
2405
2406 =item time - the cancellation time, used to calculate final bills and
2407 unused-time credits if any. Will be passed through to the bill() and
2408 FS::cust_pkg::cancel() methods.
2409
2410 =item quiet - can be set true to supress email cancellation notices.
2411
2412 =item reason - can be set to a cancellation reason (see L<FS::reason>), either a
2413 reasonnum of an existing reason, or passing a hashref will create a new reason.
2414 The hashref should have the following keys:
2415 typenum - Reason type (see L<FS::reason_type>)
2416 reason - Text of the new reason.
2417
2418 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2419 for the individual packages, parallel to the C<cust_pkg> argument. The
2420 reason and reason_otaker arguments will be taken from those objects.
2421
2422 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2423
2424 =item nobill - can be set true to skip billing if it might otherwise be done.
2425
2426 =cut
2427
2428 sub cancel_pkgs {
2429   my( $self, %opt ) = @_;
2430
2431   # we're going to cancel services, which is not reversible
2432   #   unless exports are suppressed
2433   die "cancel_pkgs cannot be run inside a transaction"
2434     if !$FS::UID::AutoCommit && !$FS::svc_Common::noexport_hack;
2435
2436   my $oldAutoCommit = $FS::UID::AutoCommit;
2437   local $FS::UID::AutoCommit = 0;
2438
2439   savepoint_create('cancel_pkgs');
2440
2441   return ( 'access denied' )
2442     unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2443
2444   if ( $opt{'ban'} ) {
2445
2446     foreach my $cust_payby ( $self->cust_payby ) {
2447
2448       #well, if they didn't get decrypted on search, then we don't have to
2449       # try again... queue a job for the server that does have decryption
2450       # capability if we're in a paranoid multi-server implementation?
2451       return ( "Can't (yet) ban encrypted credit cards" )
2452         if $cust_payby->is_encrypted($cust_payby->payinfo);
2453
2454       my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2455       my $error = $ban->insert;
2456       if ($error) {
2457         savepoint_rollback_and_release('cancel_pkgs');
2458         dbh->rollback if $oldAutoCommit;
2459         return ( $error );
2460       }
2461
2462     }
2463
2464   }
2465
2466   my @pkgs = @{ delete $opt{'cust_pkg'} };
2467   my $cancel_time = $opt{'time'} || time;
2468
2469   # bill all packages first, so we don't lose usage, service counts for
2470   # bulk billing, etc.
2471   if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2472     $opt{nobill} = 1;
2473     my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2474                              'cancel'   => 1,
2475                              'time'     => $cancel_time );
2476     if ($error) {
2477       warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2478       savepoint_rollback_and_release('cancel_pkgs');
2479       dbh->rollback if $oldAutoCommit;
2480       return ( "Error billing during cancellation: $error" );
2481     }
2482   }
2483   savepoint_release('cancel_pkgs');
2484   dbh->commit if $oldAutoCommit;
2485
2486   my @errors;
2487   # now cancel all services, the same way we would for individual packages.
2488   # if any of them fail, cancel the rest anyway.
2489   my @cust_svc = map { $_->cust_svc } @pkgs;
2490   my @sorted_cust_svc =
2491     map  { $_->[0] }
2492     sort { $a->[1] <=> $b->[1] }
2493     map  { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2494   ;
2495   warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2496     $self->custnum."\n"
2497     if $DEBUG;
2498   my $i = 0;
2499   foreach my $cust_svc (@sorted_cust_svc) {
2500     my $savepoint = 'cancel_pkgs_'.$i++;
2501     savepoint_create( $savepoint );
2502     my $part_svc = $cust_svc->part_svc;
2503     next if ( defined($part_svc) and $part_svc->preserve );
2504     # immediate cancel, no date option
2505     # transactionize individually
2506     my $error = try { $cust_svc->cancel } catch { $_ };
2507     if ( $error ) {
2508       savepoint_rollback_and_release( $savepoint );
2509       dbh->rollback if $oldAutoCommit;
2510       push @errors, $error;
2511     } else {
2512       savepoint_release( $savepoint );
2513       dbh->commit if $oldAutoCommit;
2514     }
2515   }
2516   if (@errors) {
2517     return @errors;
2518   }
2519
2520   warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2521     $self->custnum. "\n"
2522     if $DEBUG;
2523
2524   my @cprs;
2525   if ($opt{'cust_pkg_reason'}) {
2526     @cprs = @{ delete $opt{'cust_pkg_reason'} };
2527   }
2528   my $null_reason;
2529   $i = 0;
2530   foreach (@pkgs) {
2531     my %lopt = %opt;
2532     my $savepoint = 'cancel_pkgs_'.$i++;
2533     savepoint_create( $savepoint );
2534     if (@cprs) {
2535       my $cpr = shift @cprs;
2536       if ( $cpr ) {
2537         $lopt{'reason'}        = $cpr->reasonnum;
2538         $lopt{'reason_otaker'} = $cpr->otaker;
2539       } else {
2540         warn "no reason found when canceling package ".$_->pkgnum."\n";
2541         # we're not actually required to pass a reason to cust_pkg::cancel,
2542         # but if we're getting to this point, something has gone awry.
2543         $null_reason ||= FS::reason->new_or_existing(
2544           reason  => 'unknown reason',
2545           type    => 'Cancel Reason',
2546           class   => 'C',
2547         );
2548         $lopt{'reason'} = $null_reason->reasonnum;
2549         $lopt{'reason_otaker'} = $FS::CurrentUser::CurrentUser->username;
2550       }
2551     }
2552     my $error = $_->cancel(%lopt);
2553     if ( $error ) {
2554       savepoint_rollback_and_release( $savepoint );
2555       dbh->rollback if $oldAutoCommit;
2556       push @errors, 'pkgnum '.$_->pkgnum.': '.$error;
2557     } else {
2558       savepoint_release( $savepoint );
2559       dbh->commit if $oldAutoCommit;
2560     }
2561   }
2562
2563   return @errors;
2564 }
2565
2566 sub _banned_pay_hashref {
2567   my $self = shift;
2568
2569   my %payby2ban = (
2570     'CARD' => 'CARD',
2571     'DCRD' => 'CARD',
2572     'CHEK' => 'CHEK',
2573     'DCHK' => 'CHEK'
2574   );
2575
2576   {
2577     'payby'   => $payby2ban{$self->payby},
2578     'payinfo' => $self->payinfo,
2579     #don't ever *search* on reason! #'reason'  =>
2580   };
2581 }
2582
2583 =item notes
2584
2585 Returns all notes (see L<FS::cust_main_note>) for this customer.
2586
2587 =cut
2588
2589 sub notes {
2590   my($self,$orderby_classnum) = (shift,shift);
2591   my $orderby = "sticky DESC, _date DESC";
2592   $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2593   qsearch( 'cust_main_note',
2594            { 'custnum' => $self->custnum },
2595            '',
2596            "ORDER BY $orderby",
2597          );
2598 }
2599
2600 =item agent
2601
2602 Returns the agent (see L<FS::agent>) for this customer.
2603
2604 =item agent_name
2605
2606 Returns the agent name (see L<FS::agent>) for this customer.
2607
2608 =cut
2609
2610 sub agent_name {
2611   my $self = shift;
2612   $self->agent->agent;
2613 }
2614
2615 =item cust_tag
2616
2617 Returns any tags associated with this customer, as FS::cust_tag objects,
2618 or an empty list if there are no tags.
2619
2620 =item part_tag
2621
2622 Returns any tags associated with this customer, as FS::part_tag objects,
2623 or an empty list if there are no tags.
2624
2625 =cut
2626
2627 sub part_tag {
2628   my $self = shift;
2629   map $_->part_tag, $self->cust_tag;
2630 }
2631
2632
2633 =item cust_class
2634
2635 Returns the customer class, as an FS::cust_class object, or the empty string
2636 if there is no customer class.
2637
2638 =item categoryname
2639
2640 Returns the customer category name, or the empty string if there is no customer
2641 category.
2642
2643 =cut
2644
2645 sub categoryname {
2646   my $self = shift;
2647   my $cust_class = $self->cust_class;
2648   $cust_class
2649     ? $cust_class->categoryname
2650     : '';
2651 }
2652
2653 =item classname
2654
2655 Returns the customer class name, or the empty string if there is no customer
2656 class.
2657
2658 =cut
2659
2660 sub classname {
2661   my $self = shift;
2662   my $cust_class = $self->cust_class;
2663   $cust_class
2664     ? $cust_class->classname
2665     : '';
2666 }
2667
2668 =item tax_status
2669
2670 Returns the external tax status, as an FS::tax_status object, or the empty
2671 string if there is no tax status.
2672
2673 =cut
2674
2675 sub tax_status {
2676   my $self = shift;
2677   if ( $self->taxstatusnum ) {
2678     qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2679   } else {
2680     return '';
2681   }
2682 }
2683
2684 =item taxstatus
2685
2686 Returns the tax status code if there is one.
2687
2688 =cut
2689
2690 sub taxstatus {
2691   my $self = shift;
2692   my $tax_status = $self->tax_status;
2693   $tax_status
2694     ? $tax_status->taxstatus
2695     : '';
2696 }
2697
2698 =item BILLING METHODS
2699
2700 Documentation on billing methods has been moved to
2701 L<FS::cust_main::Billing>.
2702
2703 =item REALTIME BILLING METHODS
2704
2705 Documentation on realtime billing methods has been moved to
2706 L<FS::cust_main::Billing_Realtime>.
2707
2708 =item remove_cvv
2709
2710 Removes the I<paycvv> field from the database directly.
2711
2712 If there is an error, returns the error, otherwise returns false.
2713
2714 DEPRECATED.  Use L</remove_cvv_from_cust_payby> instead.
2715
2716 =cut
2717
2718 sub remove_cvv {
2719   my $self = shift;
2720   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2721     or return dbh->errstr;
2722   $sth->execute($self->custnum)
2723     or return $sth->errstr;
2724   $self->paycvv('');
2725   '';
2726 }
2727
2728 =item total_owed
2729
2730 Returns the total owed for this customer on all invoices
2731 (see L<FS::cust_bill/owed>).
2732
2733 =cut
2734
2735 sub total_owed {
2736   my $self = shift;
2737   $self->total_owed_date(2145859200); #12/31/2037
2738 }
2739
2740 =item total_owed_date TIME
2741
2742 Returns the total owed for this customer on all invoices with date earlier than
2743 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2744 see L<Time::Local> and L<Date::Parse> for conversion functions.
2745
2746 =cut
2747
2748 sub total_owed_date {
2749   my $self = shift;
2750   my $time = shift;
2751
2752   my $custnum = $self->custnum;
2753
2754   my $owed_sql = FS::cust_bill->owed_sql;
2755
2756   my $sql = "
2757     SELECT SUM($owed_sql) FROM cust_bill
2758       WHERE custnum = $custnum
2759         AND _date <= $time
2760   ";
2761
2762   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2763
2764 }
2765
2766 =item total_owed_pkgnum PKGNUM
2767
2768 Returns the total owed on all invoices for this customer's specific package
2769 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2770
2771 =cut
2772
2773 sub total_owed_pkgnum {
2774   my( $self, $pkgnum ) = @_;
2775   $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2776 }
2777
2778 =item total_owed_date_pkgnum TIME PKGNUM
2779
2780 Returns the total owed for this customer's specific package when using
2781 experimental package balances on all invoices with date earlier than
2782 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2783 see L<Time::Local> and L<Date::Parse> for conversion functions.
2784
2785 =cut
2786
2787 sub total_owed_date_pkgnum {
2788   my( $self, $time, $pkgnum ) = @_;
2789
2790   my $total_bill = 0;
2791   foreach my $cust_bill (
2792     grep { $_->_date <= $time }
2793       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2794   ) {
2795     $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2796   }
2797   sprintf( "%.2f", $total_bill );
2798
2799 }
2800
2801 =item total_paid
2802
2803 Returns the total amount of all payments.
2804
2805 =cut
2806
2807 sub total_paid {
2808   my $self = shift;
2809   my $total = 0;
2810   $total += $_->paid foreach $self->cust_pay;
2811   sprintf( "%.2f", $total );
2812 }
2813
2814 =item total_unapplied_credits
2815
2816 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2817 customer.  See L<FS::cust_credit/credited>.
2818
2819 =item total_credited
2820
2821 Old name for total_unapplied_credits.  Don't use.
2822
2823 =cut
2824
2825 sub total_credited {
2826   #carp "total_credited deprecated, use total_unapplied_credits";
2827   shift->total_unapplied_credits(@_);
2828 }
2829
2830 sub total_unapplied_credits {
2831   my $self = shift;
2832
2833   my $custnum = $self->custnum;
2834
2835   my $unapplied_sql = FS::cust_credit->unapplied_sql;
2836
2837   my $sql = "
2838     SELECT SUM($unapplied_sql) FROM cust_credit
2839       WHERE custnum = $custnum
2840   ";
2841
2842   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2843
2844 }
2845
2846 =item total_unapplied_credits_pkgnum PKGNUM
2847
2848 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2849 customer.  See L<FS::cust_credit/credited>.
2850
2851 =cut
2852
2853 sub total_unapplied_credits_pkgnum {
2854   my( $self, $pkgnum ) = @_;
2855   my $total_credit = 0;
2856   $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2857   sprintf( "%.2f", $total_credit );
2858 }
2859
2860
2861 =item total_unapplied_payments
2862
2863 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2864 See L<FS::cust_pay/unapplied>.
2865
2866 =cut
2867
2868 sub total_unapplied_payments {
2869   my $self = shift;
2870
2871   my $custnum = $self->custnum;
2872
2873   my $unapplied_sql = FS::cust_pay->unapplied_sql;
2874
2875   my $sql = "
2876     SELECT SUM($unapplied_sql) FROM cust_pay
2877       WHERE custnum = $custnum
2878   ";
2879
2880   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2881
2882 }
2883
2884 =item total_unapplied_payments_pkgnum PKGNUM
2885
2886 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2887 specific package when using experimental package balances.  See
2888 L<FS::cust_pay/unapplied>.
2889
2890 =cut
2891
2892 sub total_unapplied_payments_pkgnum {
2893   my( $self, $pkgnum ) = @_;
2894   my $total_unapplied = 0;
2895   $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2896   sprintf( "%.2f", $total_unapplied );
2897 }
2898
2899
2900 =item total_unapplied_refunds
2901
2902 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2903 customer.  See L<FS::cust_refund/unapplied>.
2904
2905 =cut
2906
2907 sub total_unapplied_refunds {
2908   my $self = shift;
2909   my $custnum = $self->custnum;
2910
2911   my $unapplied_sql = FS::cust_refund->unapplied_sql;
2912
2913   my $sql = "
2914     SELECT SUM($unapplied_sql) FROM cust_refund
2915       WHERE custnum = $custnum
2916   ";
2917
2918   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2919
2920 }
2921
2922 =item balance
2923
2924 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2925 total_unapplied_credits minus total_unapplied_payments).
2926
2927 =cut
2928
2929 sub balance {
2930   my $self = shift;
2931   $self->balance_date_range;
2932 }
2933
2934 =item balance_date TIME
2935
2936 Returns the balance for this customer, only considering invoices with date
2937 earlier than TIME (total_owed_date minus total_credited minus
2938 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
2939 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
2940 functions.
2941
2942 =cut
2943
2944 sub balance_date {
2945   my $self = shift;
2946   $self->balance_date_range(shift);
2947 }
2948
2949 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2950
2951 Returns the balance for this customer, optionally considering invoices with
2952 date earlier than START_TIME, and not later than END_TIME
2953 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2954
2955 Times are specified as SQL fragments or numeric
2956 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
2957 L<Date::Parse> for conversion functions.  The empty string can be passed
2958 to disable that time constraint completely.
2959
2960 Accepts the same options as L</balance_date_sql>:
2961
2962 =over 4
2963
2964 =item unapplied_date
2965
2966 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)
2967
2968 =item cutoff
2969
2970 An absolute cutoff time.  Payments, credits, and refunds I<applied> after this
2971 time will be ignored.  Note that START_TIME and END_TIME only limit the date
2972 range for invoices and I<unapplied> payments, credits, and refunds.
2973
2974 =back
2975
2976 =cut
2977
2978 sub balance_date_range {
2979   my $self = shift;
2980   my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2981             ') FROM cust_main WHERE custnum='. $self->custnum;
2982   sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2983 }
2984
2985 =item balance_pkgnum PKGNUM
2986
2987 Returns the balance for this customer's specific package when using
2988 experimental package balances (total_owed plus total_unrefunded, minus
2989 total_unapplied_credits minus total_unapplied_payments)
2990
2991 =cut
2992
2993 sub balance_pkgnum {
2994   my( $self, $pkgnum ) = @_;
2995
2996   sprintf( "%.2f",
2997       $self->total_owed_pkgnum($pkgnum)
2998 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2999 #    + $self->total_unapplied_refunds_pkgnum($pkgnum)
3000     - $self->total_unapplied_credits_pkgnum($pkgnum)
3001     - $self->total_unapplied_payments_pkgnum($pkgnum)
3002   );
3003 }
3004
3005 =item payment_info
3006
3007 Returns a hash of useful information for making a payment.
3008
3009 =over 4
3010
3011 =item balance
3012
3013 Current balance.
3014
3015 =item payby
3016
3017 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
3018 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
3019 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
3020
3021 =back
3022
3023 For credit card transactions:
3024
3025 =over 4
3026
3027 =item card_type 1
3028
3029 =item payname
3030
3031 Exact name on card
3032
3033 =back
3034
3035 For electronic check transactions:
3036
3037 =over 4
3038
3039 =item stateid_state
3040
3041 =back
3042
3043 =cut
3044
3045 sub payment_info {
3046   my $self = shift;
3047
3048   my %return = ();
3049
3050   $return{balance} = $self->balance;
3051
3052   $return{payname} = $self->payname
3053                      || ( $self->first. ' '. $self->get('last') );
3054
3055   $return{$_} = $self->bill_location->$_
3056     for qw(address1 address2 city state zip);
3057
3058   $return{payby} = $self->payby;
3059   $return{stateid_state} = $self->stateid_state;
3060
3061   if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
3062     $return{card_type} = cardtype($self->payinfo);
3063     $return{payinfo} = $self->paymask;
3064
3065     @return{'month', 'year'} = $self->paydate_monthyear;
3066
3067   }
3068
3069   if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
3070     my ($payinfo1, $payinfo2) = split '@', $self->paymask;
3071     $return{payinfo1} = $payinfo1;
3072     $return{payinfo2} = $payinfo2;
3073     $return{paytype}  = $self->paytype;
3074     $return{paystate} = $self->paystate;
3075
3076   }
3077
3078   #doubleclick protection
3079   my $_date = time;
3080   $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3081
3082   %return;
3083
3084 }
3085
3086 =item paydate_epoch
3087
3088 Returns the next payment expiration date for this customer. If they have no
3089 payment methods that will expire, returns 0.
3090
3091 =cut
3092
3093 sub paydate_epoch {
3094   my $self = shift;
3095   # filter out the ones that individually return 0, but then return 0 if
3096   # there are no results
3097   my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
3098   min( @epochs ) || 0;
3099 }
3100
3101 =item paydate_epoch_sql
3102
3103 Returns an SQL expression to get the next payment expiration date for a
3104 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
3105 dates, so that it's safe to test for "will it expire before date X" for any
3106 date up to then.
3107
3108 =cut
3109
3110 sub paydate_epoch_sql {
3111   my $class = shift;
3112   my $paydate = FS::cust_payby->paydate_epoch_sql;
3113   "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
3114 }
3115
3116 sub tax_exemption {
3117   my( $self, $taxname ) = @_;
3118
3119   qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3120                                      'taxname' => $taxname,
3121                                    },
3122           );
3123 }
3124
3125 =item cust_main_exemption
3126
3127 =item invoicing_list
3128
3129 Returns a list of email addresses (with svcnum entries expanded), and the word
3130 'POST' if the customer receives postal invoices.
3131
3132 =cut
3133
3134 sub invoicing_list {
3135   my( $self, $arrayref ) = @_;
3136
3137   if ( $arrayref ) {
3138     warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
3139   }
3140
3141   my @emails = $self->invoicing_list_emailonly;
3142   push @emails, 'POST' if $self->get('postal_invoice');
3143
3144   @emails;
3145 }
3146
3147 =item check_invoicing_list ARRAYREF
3148
3149 Checks these arguements as valid input for the invoicing_list method.  If there
3150 is an error, returns the error, otherwise returns false.
3151
3152 =cut
3153
3154 sub check_invoicing_list {
3155   my( $self, $arrayref ) = @_;
3156
3157   foreach my $address ( @$arrayref ) {
3158
3159     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3160       return 'Can\'t add FAX invoice destination with a blank FAX number.';
3161     }
3162
3163     my $cust_main_invoice = new FS::cust_main_invoice ( {
3164       'custnum' => $self->custnum,
3165       'dest'    => $address,
3166     } );
3167     my $error = $self->custnum
3168                 ? $cust_main_invoice->check
3169                 : $cust_main_invoice->checkdest
3170     ;
3171     return $error if $error;
3172
3173   }
3174
3175   return "Email address required"
3176     if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3177     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3178
3179   '';
3180 }
3181
3182 =item all_emails
3183
3184 Returns the email addresses of all accounts provisioned for this customer.
3185
3186 =cut
3187
3188 sub all_emails {
3189   my $self = shift;
3190   my %list;
3191   foreach my $cust_pkg ( $self->all_pkgs ) {
3192     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3193     my @svc_acct =
3194       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3195         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3196           @cust_svc;
3197     $list{$_}=1 foreach map { $_->email } @svc_acct;
3198   }
3199   keys %list;
3200 }
3201
3202 =item invoicing_list_addpost
3203
3204 Adds postal invoicing to this customer.  If this customer is already configured
3205 to receive postal invoices, does nothing.
3206
3207 =cut
3208
3209 sub invoicing_list_addpost {
3210   my $self = shift;
3211   if ( $self->get('postal_invoice') eq '' ) {
3212     $self->set('postal_invoice', 'Y');
3213     my $error = $self->replace;
3214     warn $error if $error; # should fail harder, but this is traditional
3215   }
3216 }
3217
3218 =item invoicing_list_emailonly
3219
3220 Returns the list of email invoice recipients (invoicing_list without non-email
3221 destinations such as POST and FAX).
3222
3223 =cut
3224
3225 sub invoicing_list_emailonly {
3226   my $self = shift;
3227   warn "$me invoicing_list_emailonly called"
3228     if $DEBUG;
3229   return () if !$self->custnum; # not yet inserted
3230   return map { $_->emailaddress }
3231     qsearch({
3232         table     => 'cust_contact',
3233         select    => 'emailaddress',
3234         addl_from => ' JOIN contact USING (contactnum) '.
3235                      ' JOIN contact_email USING (contactnum)',
3236         hashref   => { 'custnum' => $self->custnum, },
3237         extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
3238     });
3239 }
3240
3241 =item invoicing_list_emailonly_scalar
3242
3243 Returns the list of email invoice recipients (invoicing_list without non-email
3244 destinations such as POST and FAX) as a comma-separated scalar.
3245
3246 =cut
3247
3248 sub invoicing_list_emailonly_scalar {
3249   my $self = shift;
3250   warn "$me invoicing_list_emailonly_scalar called"
3251     if $DEBUG;
3252   join(', ', $self->invoicing_list_emailonly);
3253 }
3254
3255 =item contact_list [ CLASSNUM, DEST_FLAG... ]
3256
3257 Returns a list of contacts (L<FS::contact> objects) for the customer.
3258
3259 If no arguments are given, returns all contacts for the customer.
3260
3261 Arguments may contain classnums.  When classnums are specified, only
3262 contacts with a matching cust_contact.classnum are returned.  When a
3263 classnum of 0 is given, contacts with a null classnum are also included.
3264
3265 Arguments may also contain the dest flag names 'invoice' or 'message'.
3266 If given, contacts who's invoice_dest and/or message_dest flags are
3267 not set to 'Y' will be excluded.
3268
3269 =cut
3270
3271 sub contact_list {
3272   my $self = shift;
3273   my $search = {
3274     table       => 'contact',
3275     select      => join(', ',(
3276                     'contact.*',
3277                     'cust_contact.invoice_dest',
3278                     'cust_contact.message_dest',
3279     )),
3280     addl_from   => ' JOIN cust_contact USING (contactnum)',
3281     extra_sql   => ' WHERE cust_contact.custnum = '.$self->custnum,
3282   };
3283
3284   # Bugfix notes:
3285   #   Calling methods were relying on this method to use invoice_dest to
3286   #   block e-mail messages.  Depending on parameters, this may or may not
3287   #   have actually happened.
3288   #
3289   #   The bug could cause this SQL to be used to filter e-mail addresses:
3290   #
3291   #   AND (
3292   #     cust_contact.classnums IN (1,2,3)
3293   #     OR cust_contact.invoice_dest = 'Y'
3294   #   )
3295   #
3296   #   improperly including everybody with the opt-in flag AND everybody
3297   #   in the contact classes
3298   #
3299   # Possibility to introduce new bugs:
3300   #   If callers of this method called it incorrectly, and didn't notice
3301   #   because it seemed to send the e-mails they wanted.
3302
3303   # WHERE ...
3304   # AND (
3305   #   (
3306   #     cust_contact.classnum IN (1,2,3)
3307   #     OR
3308   #     cust_contact.classnum IS NULL
3309   #   )
3310   #   AND (
3311   #     cust_contact.invoice_dest = 'Y'
3312   #     OR
3313   #     cust_contact.message_dest = 'Y'
3314   #   )
3315   # )
3316
3317   my @and_dest;
3318   my @or_classnum;
3319   my @classnums;
3320   for (@_) {
3321     if ($_ eq 'invoice' || $_ eq 'message') {
3322       push @and_dest, " cust_contact.${_}_dest = 'Y' ";
3323     } elsif ($_ eq '0') {
3324       push @or_classnum, ' cust_contact.classnum IS NULL ';
3325     } elsif ( /^\d+$/ ) {
3326       push @classnums, $_;
3327     } else {
3328       croak "bad classnum argument '$_'";
3329     }
3330   }
3331
3332   push @or_classnum, 'cust_contact.classnum IN ('.join(',',@classnums).')'
3333     if @classnums;
3334
3335   if (@or_classnum || @and_dest) { # catch, no arguments given
3336     $search->{extra_sql} .= ' AND ( ';
3337
3338       if (@or_classnum) {
3339         $search->{extra_sql} .= ' ( ';
3340         $search->{extra_sql} .= join ' OR ', map {" $_ "} @or_classnum;
3341         $search->{extra_sql} .= ' ) ';
3342         $search->{extra_sql} .= ' AND ( ' if @and_dest;
3343       }
3344
3345       if (@and_dest) {
3346         $search->{extra_sql} .= join ' OR ', map {" $_ "} @and_dest;
3347         $search->{extra_sql} .= ' ) ' if @or_classnum;
3348       }
3349
3350     $search->{extra_sql} .= ' ) ';
3351
3352     warn "\$extra_sql: $search->{extra_sql} \n" if $DEBUG;
3353   }
3354
3355   qsearch($search);
3356 }
3357
3358 =item contact_list_email [ CLASSNUM, ... ]
3359
3360 Same as L</contact_list>, but returns email destinations instead of contact
3361 objects.
3362
3363 =cut
3364
3365 sub contact_list_email {
3366   my $self = shift;
3367   my @contacts = $self->contact_list(@_);
3368   my @emails;
3369   foreach my $contact (@contacts) {
3370     foreach my $contact_email ($contact->contact_email) {
3371       push @emails,  Email::Address->new( $contact->firstlast,
3372                                           $contact_email->emailaddress
3373                      )->format;
3374     }
3375   }
3376   @emails;
3377 }
3378
3379 =item referral_custnum_cust_main
3380
3381 Returns the customer who referred this customer (or the empty string, if
3382 this customer was not referred).
3383
3384 Note the difference with referral_cust_main method: This method,
3385 referral_custnum_cust_main returns the single customer (if any) who referred
3386 this customer, while referral_cust_main returns an array of customers referred
3387 BY this customer.
3388
3389 =cut
3390
3391 sub referral_custnum_cust_main {
3392   my $self = shift;
3393   return '' unless $self->referral_custnum;
3394   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3395 }
3396
3397 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3398
3399 Returns an array of customers referred by this customer (referral_custnum set
3400 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
3401 customers referred by customers referred by this customer and so on, inclusive.
3402 The default behavior is DEPTH 1 (no recursion).
3403
3404 Note the difference with referral_custnum_cust_main method: This method,
3405 referral_cust_main, returns an array of customers referred BY this customer,
3406 while referral_custnum_cust_main returns the single customer (if any) who
3407 referred this customer.
3408
3409 =cut
3410
3411 sub referral_cust_main {
3412   my $self = shift;
3413   my $depth = @_ ? shift : 1;
3414   my $exclude = @_ ? shift : {};
3415
3416   my @cust_main =
3417     map { $exclude->{$_->custnum}++; $_; }
3418       grep { ! $exclude->{ $_->custnum } }
3419         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3420
3421   if ( $depth > 1 ) {
3422     push @cust_main,
3423       map { $_->referral_cust_main($depth-1, $exclude) }
3424         @cust_main;
3425   }
3426
3427   @cust_main;
3428 }
3429
3430 =item referral_cust_main_ncancelled
3431
3432 Same as referral_cust_main, except only returns customers with uncancelled
3433 packages.
3434
3435 =cut
3436
3437 sub referral_cust_main_ncancelled {
3438   my $self = shift;
3439   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3440 }
3441
3442 =item referral_cust_pkg [ DEPTH ]
3443
3444 Like referral_cust_main, except returns a flat list of all unsuspended (and
3445 uncancelled) packages for each customer.  The number of items in this list may
3446 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3447
3448 =cut
3449
3450 sub referral_cust_pkg {
3451   my $self = shift;
3452   my $depth = @_ ? shift : 1;
3453
3454   map { $_->unsuspended_pkgs }
3455     grep { $_->unsuspended_pkgs }
3456       $self->referral_cust_main($depth);
3457 }
3458
3459 =item referring_cust_main
3460
3461 Returns the single cust_main record for the customer who referred this customer
3462 (referral_custnum), or false.
3463
3464 =cut
3465
3466 sub referring_cust_main {
3467   my $self = shift;
3468   return '' unless $self->referral_custnum;
3469   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3470 }
3471
3472 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3473
3474 Applies a credit to this customer.  If there is an error, returns the error,
3475 otherwise returns false.
3476
3477 REASON can be a text string, an FS::reason object, or a scalar reference to
3478 a reasonnum.  If a text string, it will be automatically inserted as a new
3479 reason, and a 'reason_type' option must be passed to indicate the
3480 FS::reason_type for the new reason.
3481
3482 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3483 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3484 I<commission_pkgnum>.
3485
3486 Any other options are passed to FS::cust_credit::insert.
3487
3488 =cut
3489
3490 sub credit {
3491   my( $self, $amount, $reason, %options ) = @_;
3492
3493   my $cust_credit = new FS::cust_credit {
3494     'custnum' => $self->custnum,
3495     'amount'  => $amount,
3496   };
3497
3498   if ( ref($reason) ) {
3499
3500     if ( ref($reason) eq 'SCALAR' ) {
3501       $cust_credit->reasonnum( $$reason );
3502     } else {
3503       $cust_credit->reasonnum( $reason->reasonnum );
3504     }
3505
3506   } else {
3507     $cust_credit->set('reason', $reason)
3508   }
3509
3510   $cust_credit->$_( delete $options{$_} )
3511     foreach grep exists($options{$_}),
3512               qw( addlinfo eventnum ),
3513               map "commission_$_", qw( agentnum salesnum pkgnum );
3514
3515   $cust_credit->insert(%options);
3516
3517 }
3518
3519 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3520
3521 Creates a one-time charge for this customer.  If there is an error, returns
3522 the error, otherwise returns false.
3523
3524 New-style, with a hashref of options:
3525
3526   my $error = $cust_main->charge(
3527                                   {
3528                                     'amount'     => 54.32,
3529                                     'quantity'   => 1,
3530                                     'start_date' => str2time('7/4/2009'),
3531                                     'pkg'        => 'Description',
3532                                     'comment'    => 'Comment',
3533                                     'additional' => [], #extra invoice detail
3534                                     'classnum'   => 1,  #pkg_class
3535
3536                                     'setuptax'   => '', # or 'Y' for tax exempt
3537
3538                                     'locationnum'=> 1234, # optional
3539
3540                                     #internal taxation
3541                                     'taxclass'   => 'Tax class',
3542
3543                                     #vendor taxation
3544                                     'taxproduct' => 2,  #part_pkg_taxproduct
3545                                     'override'   => {}, #XXX describe
3546
3547                                     #will be filled in with the new object
3548                                     'cust_pkg_ref' => \$cust_pkg,
3549
3550                                     #generate an invoice immediately
3551                                     'bill_now' => 0,
3552                                     'invoice_terms' => '', #with these terms
3553                                   }
3554                                 );
3555
3556 Old-style:
3557
3558   my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3559
3560 =cut
3561
3562 #super false laziness w/quotation::charge
3563 sub charge {
3564   my $self = shift;
3565   my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3566   my ( $pkg, $comment, $additional );
3567   my ( $setuptax, $taxclass );   #internal taxes
3568   my ( $taxproduct, $override ); #vendor (CCH) taxes
3569   my $no_auto = '';
3570   my $separate_bill = '';
3571   my $cust_pkg_ref = '';
3572   my ( $bill_now, $invoice_terms ) = ( 0, '' );
3573   my $locationnum;
3574   my ( $discountnum, $discountnum_amount, $discountnum_percent ) = ( '','','' );
3575   if ( ref( $_[0] ) ) {
3576     $amount     = $_[0]->{amount};
3577     $setup_cost = $_[0]->{setup_cost};
3578     $quantity   = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3579     $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3580     $no_auto    = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3581     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3582     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
3583                                            : '$'. sprintf("%.2f",$amount);
3584     $setuptax   = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3585     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3586     $classnum   = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3587     $additional = $_[0]->{additional} || [];
3588     $taxproduct = $_[0]->{taxproductnum};
3589     $override   = { '' => $_[0]->{tax_override} };
3590     $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3591     $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3592     $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3593     $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3594     $separate_bill = $_[0]->{separate_bill} || '';
3595     $discountnum = $_[0]->{setup_discountnum};
3596     $discountnum_amount = $_[0]->{setup_discountnum_amount};
3597     $discountnum_percent = $_[0]->{setup_discountnum_percent};
3598   } else { # yuck
3599     $amount     = shift;
3600     $setup_cost = '';
3601     $quantity   = 1;
3602     $start_date = '';
3603     $pkg        = @_ ? shift : 'One-time charge';
3604     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
3605     $setuptax   = '';
3606     $taxclass   = @_ ? shift : '';
3607     $additional = [];
3608   }
3609
3610   local $SIG{HUP} = 'IGNORE';
3611   local $SIG{INT} = 'IGNORE';
3612   local $SIG{QUIT} = 'IGNORE';
3613   local $SIG{TERM} = 'IGNORE';
3614   local $SIG{TSTP} = 'IGNORE';
3615   local $SIG{PIPE} = 'IGNORE';
3616
3617   my $oldAutoCommit = $FS::UID::AutoCommit;
3618   local $FS::UID::AutoCommit = 0;
3619   my $dbh = dbh;
3620
3621   my $part_pkg = new FS::part_pkg ( {
3622     'pkg'           => $pkg,
3623     'comment'       => $comment,
3624     'plan'          => 'flat',
3625     'freq'          => 0,
3626     'disabled'      => 'Y',
3627     'classnum'      => ( $classnum ? $classnum : '' ),
3628     'setuptax'      => $setuptax,
3629     'taxclass'      => $taxclass,
3630     'taxproductnum' => $taxproduct,
3631     'setup_cost'    => $setup_cost,
3632   } );
3633
3634   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3635                         ( 0 .. @$additional - 1 )
3636                   ),
3637                   'additional_count' => scalar(@$additional),
3638                   'setup_fee' => $amount,
3639                 );
3640
3641   my $error = $part_pkg->insert( options       => \%options,
3642                                  tax_overrides => $override,
3643                                );
3644   if ( $error ) {
3645     $dbh->rollback if $oldAutoCommit;
3646     return $error;
3647   }
3648
3649   my $pkgpart = $part_pkg->pkgpart;
3650   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3651   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3652     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3653     $error = $type_pkgs->insert;
3654     if ( $error ) {
3655       $dbh->rollback if $oldAutoCommit;
3656       return $error;
3657     }
3658   }
3659
3660   my $cust_pkg = new FS::cust_pkg ( {
3661     'custnum'                   => $self->custnum,
3662     'pkgpart'                   => $pkgpart,
3663     'quantity'                  => $quantity,
3664     'start_date'                => $start_date,
3665     'no_auto'                   => $no_auto,
3666     'separate_bill'             => $separate_bill,
3667     'locationnum'               => $locationnum,
3668     'setup_discountnum'         => $discountnum,
3669     'setup_discountnum_amount'  => $discountnum_amount,
3670     'setup_discountnum_percent' => $discountnum_percent,
3671   } );
3672
3673   $error = $cust_pkg->insert;
3674   if ( $error ) {
3675     $dbh->rollback if $oldAutoCommit;
3676     return $error;
3677   } elsif ( $cust_pkg_ref ) {
3678     ${$cust_pkg_ref} = $cust_pkg;
3679   }
3680
3681   if ( $bill_now ) {
3682     my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3683                              'pkg_list'      => [ $cust_pkg ],
3684                            );
3685     if ( $error ) {
3686       $dbh->rollback if $oldAutoCommit;
3687       return $error;
3688     }
3689   }
3690
3691   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3692   return '';
3693
3694 }
3695
3696 #=item charge_postal_fee
3697 #
3698 #Applies a one time charge this customer.  If there is an error,
3699 #returns the error, returns the cust_pkg charge object or false
3700 #if there was no charge.
3701 #
3702 #=cut
3703 #
3704 # This should be a customer event.  For that to work requires that bill
3705 # also be a customer event.
3706
3707 sub charge_postal_fee {
3708   my $self = shift;
3709
3710   my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3711   return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3712
3713   my $cust_pkg = new FS::cust_pkg ( {
3714     'custnum'  => $self->custnum,
3715     'pkgpart'  => $pkgpart,
3716     'quantity' => 1,
3717   } );
3718
3719   my $error = $cust_pkg->insert;
3720   $error ? $error : $cust_pkg;
3721 }
3722
3723 =item num_cust_attachment_deleted
3724
3725 Returns the number of deleted attachments for this customer (see
3726 L<FS::num_cust_attachment>).
3727
3728 =cut
3729
3730 sub num_cust_attachments_deleted {
3731   my $self = shift;
3732   $self->scalar_sql(
3733     " SELECT COUNT(*) FROM cust_attachment ".
3734       " WHERE custnum = ? AND disabled IS NOT NULL AND disabled > 0",
3735     $self->custnum
3736   );
3737 }
3738
3739 =item max_invnum
3740
3741 Returns the most recent invnum (invoice number) for this customer.
3742
3743 =cut
3744
3745 sub max_invnum {
3746   my $self = shift;
3747   $self->scalar_sql(
3748     " SELECT MAX(invnum) FROM cust_bill WHERE custnum = ?",
3749     $self->custnum
3750   );
3751 }
3752
3753 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3754
3755 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3756
3757 Optionally, a list or hashref of additional arguments to the qsearch call can
3758 be passed.
3759
3760 =cut
3761
3762 sub cust_bill {
3763   my $self = shift;
3764   my $opt = ref($_[0]) ? shift : { @_ };
3765
3766   #return $self->num_cust_bill unless wantarray || keys %$opt;
3767
3768   $opt->{'table'} = 'cust_bill';
3769   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3770   $opt->{'hashref'}{'custnum'} = $self->custnum;
3771   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3772
3773   map { $_ } #behavior of sort undefined in scalar context
3774     sort { $a->_date <=> $b->_date }
3775       qsearch($opt);
3776 }
3777
3778 =item open_cust_bill
3779
3780 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3781 customer.
3782
3783 =cut
3784
3785 sub open_cust_bill {
3786   my $self = shift;
3787
3788   $self->cust_bill(
3789     'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3790     #@_
3791   );
3792
3793 }
3794
3795 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3796
3797 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3798
3799 =cut
3800
3801 sub legacy_cust_bill {
3802   my $self = shift;
3803
3804   #return $self->num_legacy_cust_bill unless wantarray;
3805
3806   map { $_ } #behavior of sort undefined in scalar context
3807     sort { $a->_date <=> $b->_date }
3808       qsearch({ 'table'    => 'legacy_cust_bill',
3809                 'hashref'  => { 'custnum' => $self->custnum, },
3810                 'order_by' => 'ORDER BY _date ASC',
3811              });
3812 }
3813
3814 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3815
3816 Returns all the statements (see L<FS::cust_statement>) for this customer.
3817
3818 Optionally, a list or hashref of additional arguments to the qsearch call can
3819 be passed.
3820
3821 =cut
3822
3823 =item cust_bill_void
3824
3825 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3826
3827 =cut
3828
3829 sub cust_bill_void {
3830   my $self = shift;
3831
3832   map { $_ } #return $self->num_cust_bill_void unless wantarray;
3833   sort { $a->_date <=> $b->_date }
3834     qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3835 }
3836
3837 sub cust_statement {
3838   my $self = shift;
3839   my $opt = ref($_[0]) ? shift : { @_ };
3840
3841   #return $self->num_cust_statement unless wantarray || keys %$opt;
3842
3843   $opt->{'table'} = 'cust_statement';
3844   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3845   $opt->{'hashref'}{'custnum'} = $self->custnum;
3846   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3847
3848   map { $_ } #behavior of sort undefined in scalar context
3849     sort { $a->_date <=> $b->_date }
3850       qsearch($opt);
3851 }
3852
3853 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3854
3855 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3856
3857 Optionally, a list or hashref of additional arguments to the qsearch call can
3858 be passed following the SVCDB.
3859
3860 =cut
3861
3862 sub svc_x {
3863   my $self = shift;
3864   my $svcdb = shift;
3865   if ( ! $svcdb =~ /^svc_\w+$/ ) {
3866     warn "$me svc_x requires a svcdb";
3867     return;
3868   }
3869   my $opt = ref($_[0]) ? shift : { @_ };
3870
3871   $opt->{'table'} = $svcdb;
3872   $opt->{'addl_from'} =
3873     'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3874     ($opt->{'addl_from'} || '');
3875
3876   my $custnum = $self->custnum;
3877   $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3878   my $where = "cust_pkg.custnum = $custnum";
3879
3880   my $extra_sql = $opt->{'extra_sql'} || '';
3881   if ( keys %{ $opt->{'hashref'} } ) {
3882     $extra_sql = " AND $where $extra_sql";
3883   }
3884   else {
3885     if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3886       $extra_sql = "WHERE $where AND $1";
3887     }
3888     else {
3889       $extra_sql = "WHERE $where $extra_sql";
3890     }
3891   }
3892   $opt->{'extra_sql'} = $extra_sql;
3893
3894   qsearch($opt);
3895 }
3896
3897 # required for use as an eventtable;
3898 sub svc_acct {
3899   my $self = shift;
3900   $self->svc_x('svc_acct', @_);
3901 }
3902
3903 =item cust_credit
3904
3905 Returns all the credits (see L<FS::cust_credit>) for this customer.
3906
3907 =cut
3908
3909 sub cust_credit {
3910   my $self = shift;
3911
3912   #return $self->num_cust_credit unless wantarray;
3913
3914   map { $_ } #behavior of sort undefined in scalar context
3915     sort { $a->_date <=> $b->_date }
3916       qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3917 }
3918
3919 =item cust_credit_pkgnum
3920
3921 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3922 package when using experimental package balances.
3923
3924 =cut
3925
3926 sub cust_credit_pkgnum {
3927   my( $self, $pkgnum ) = @_;
3928   map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3929   sort { $a->_date <=> $b->_date }
3930     qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3931                               'pkgnum'  => $pkgnum,
3932                             }
3933     );
3934 }
3935
3936 =item cust_credit_void
3937
3938 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3939
3940 =cut
3941
3942 sub cust_credit_void {
3943   my $self = shift;
3944   map { $_ }
3945   sort { $a->_date <=> $b->_date }
3946     qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3947 }
3948
3949 =item cust_pay
3950
3951 Returns all the payments (see L<FS::cust_pay>) for this customer.
3952
3953 =cut
3954
3955 sub cust_pay {
3956   my $self = shift;
3957   my $opt = ref($_[0]) ? shift : { @_ };
3958
3959   return $self->num_cust_pay unless wantarray || keys %$opt;
3960
3961   $opt->{'table'} = 'cust_pay';
3962   $opt->{'hashref'}{'custnum'} = $self->custnum;
3963
3964   map { $_ } #behavior of sort undefined in scalar context
3965     sort { $a->_date <=> $b->_date }
3966       qsearch($opt);
3967
3968 }
3969
3970 =item num_cust_pay
3971
3972 Returns the number of payments (see L<FS::cust_pay>) for this customer.  Also
3973 called automatically when the cust_pay method is used in a scalar context.
3974
3975 =cut
3976
3977 sub num_cust_pay {
3978   my $self = shift;
3979   my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3980   my $sth = dbh->prepare($sql) or die dbh->errstr;
3981   $sth->execute($self->custnum) or die $sth->errstr;
3982   $sth->fetchrow_arrayref->[0];
3983 }
3984
3985 =item unapplied_cust_pay
3986
3987 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3988
3989 =cut
3990
3991 sub unapplied_cust_pay {
3992   my $self = shift;
3993
3994   $self->cust_pay(
3995     'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3996     #@_
3997   );
3998
3999 }
4000
4001 =item cust_pay_pkgnum
4002
4003 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
4004 package when using experimental package balances.
4005
4006 =cut
4007
4008 sub cust_pay_pkgnum {
4009   my( $self, $pkgnum ) = @_;
4010   map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
4011   sort { $a->_date <=> $b->_date }
4012     qsearch( 'cust_pay', { 'custnum' => $self->custnum,
4013                            'pkgnum'  => $pkgnum,
4014                          }
4015     );
4016 }
4017
4018 =item cust_pay_void
4019
4020 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4021
4022 =cut
4023
4024 sub cust_pay_void {
4025   my $self = shift;
4026   map { $_ } #return $self->num_cust_pay_void unless wantarray;
4027   sort { $a->_date <=> $b->_date }
4028     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4029 }
4030
4031 =item cust_pay_pending
4032
4033 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
4034 (without status "done").
4035
4036 =cut
4037
4038 sub cust_pay_pending {
4039   my $self = shift;
4040   return $self->num_cust_pay_pending unless wantarray;
4041   sort { $a->_date <=> $b->_date }
4042     qsearch( 'cust_pay_pending', {
4043                                    'custnum' => $self->custnum,
4044                                    'status'  => { op=>'!=', value=>'done' },
4045                                  },
4046            );
4047 }
4048
4049 =item cust_pay_pending_attempt
4050
4051 Returns all payment attempts / declined payments for this customer, as pending
4052 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
4053 a corresponding payment (see L<FS::cust_pay>).
4054
4055 =cut
4056
4057 sub cust_pay_pending_attempt {
4058   my $self = shift;
4059   return $self->num_cust_pay_pending_attempt unless wantarray;
4060   sort { $a->_date <=> $b->_date }
4061     qsearch( 'cust_pay_pending', {
4062                                    'custnum' => $self->custnum,
4063                                    'status'  => 'done',
4064                                    'paynum'  => '',
4065                                  },
4066            );
4067 }
4068
4069 =item num_cust_pay_pending
4070
4071 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
4072 customer (without status "done").  Also called automatically when the
4073 cust_pay_pending method is used in a scalar context.
4074
4075 =cut
4076
4077 sub num_cust_pay_pending {
4078   my $self = shift;
4079   $self->scalar_sql(
4080     " SELECT COUNT(*) FROM cust_pay_pending ".
4081       " WHERE custnum = ? AND status != 'done' ",
4082     $self->custnum
4083   );
4084 }
4085
4086 =item num_cust_pay_pending_attempt
4087
4088 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
4089 customer, with status "done" but without a corresp.  Also called automatically when the
4090 cust_pay_pending method is used in a scalar context.
4091
4092 =cut
4093
4094 sub num_cust_pay_pending_attempt {
4095   my $self = shift;
4096   $self->scalar_sql(
4097     " SELECT COUNT(*) FROM cust_pay_pending ".
4098       " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
4099     $self->custnum
4100   );
4101 }
4102
4103 =item cust_refund
4104
4105 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4106
4107 =cut
4108
4109 sub cust_refund {
4110   my $self = shift;
4111   map { $_ } #return $self->num_cust_refund unless wantarray;
4112   sort { $a->_date <=> $b->_date }
4113     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4114 }
4115
4116 =item display_custnum
4117
4118 Returns the displayed customer number for this customer: agent_custid if
4119 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
4120
4121 =cut
4122
4123 sub display_custnum {
4124   my $self = shift;
4125
4126   return $self->agent_custid
4127     if $default_agent_custid && $self->agent_custid;
4128
4129   my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
4130
4131   if ( $prefix ) {
4132     return $prefix .
4133            sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
4134   } elsif ( $custnum_display_length ) {
4135     return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
4136   } else {
4137     return $self->custnum;
4138   }
4139 }
4140
4141 =item name
4142
4143 Returns a name string for this customer, either "Company (Last, First)" or
4144 "Last, First".
4145
4146 =cut
4147
4148 sub name {
4149   my $self = shift;
4150   my $name = $self->contact;
4151   $name = $self->company. " ($name)" if $self->company;
4152   $name;
4153 }
4154
4155 =item batch_payment_payname
4156
4157 Returns a name string for this customer, either "cust_batch_payment->payname" or "First Last" or "Company,
4158 based on if a company name exists and is the account being used a business account.
4159
4160 =cut
4161
4162 sub batch_payment_payname {
4163   my $self = shift;
4164   my $cust_pay_batch = shift;
4165   my $name;
4166
4167   if ($cust_pay_batch->{Hash}->{payby} eq "CARD") { $name = $cust_pay_batch->payname; }
4168   else { $name = $self->first .' '. $self->last; }
4169
4170   $name = $self->company
4171     if (($cust_pay_batch->{Hash}->{paytype} eq "Business checking" || $cust_pay_batch->{Hash}->{paytype} eq "Business savings") && $self->company);
4172
4173   $name;
4174 }
4175
4176 =item service_contact
4177
4178 Returns the L<FS::contact> object for this customer that has the 'Service'
4179 contact class, or undef if there is no such contact.  Deprecated; don't use
4180 this in new code.
4181
4182 =cut
4183
4184 sub service_contact {
4185   my $self = shift;
4186   if ( !exists($self->{service_contact}) ) {
4187     my $classnum = $self->scalar_sql(
4188       'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4189     ) || 0; #if it's zero, qsearchs will return nothing
4190     my $cust_contact = qsearchs('cust_contact', {
4191         'classnum' => $classnum,
4192         'custnum'  => $self->custnum,
4193     });
4194     $self->{service_contact} = $cust_contact->contact if $cust_contact;
4195   }
4196   $self->{service_contact};
4197 }
4198
4199 =item ship_name
4200
4201 Returns a name string for this (service/shipping) contact, either
4202 "Company (Last, First)" or "Last, First".
4203
4204 =cut
4205
4206 sub ship_name {
4207   my $self = shift;
4208
4209   my $name = $self->ship_contact;
4210   $name = $self->company. " ($name)" if $self->company;
4211   $name;
4212 }
4213
4214 =item name_short
4215
4216 Returns a name string for this customer, either "Company" or "First Last".
4217
4218 =cut
4219
4220 sub name_short {
4221   my $self = shift;
4222   $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4223 }
4224
4225 =item ship_name_short
4226
4227 Returns a name string for this (service/shipping) contact, either "Company"
4228 or "First Last".
4229
4230 =cut
4231
4232 sub ship_name_short {
4233   my $self = shift;
4234   $self->service_contact
4235     ? $self->ship_contact_firstlast
4236     : $self->name_short
4237 }
4238
4239 =item contact
4240
4241 Returns this customer's full (billing) contact name only, "Last, First"
4242
4243 =cut
4244
4245 sub contact {
4246   my $self = shift;
4247   $self->get('last'). ', '. $self->first;
4248 }
4249
4250 =item ship_contact
4251
4252 Returns this customer's full (shipping) contact name only, "Last, First"
4253
4254 =cut
4255
4256 sub ship_contact {
4257   my $self = shift;
4258   my $contact = $self->service_contact || $self;
4259   $contact->get('last') . ', ' . $contact->get('first');
4260 }
4261
4262 =item contact_firstlast
4263
4264 Returns this customers full (billing) contact name only, "First Last".
4265
4266 =cut
4267
4268 sub contact_firstlast {
4269   my $self = shift;
4270   $self->first. ' '. $self->get('last');
4271 }
4272
4273 =item ship_contact_firstlast
4274
4275 Returns this customer's full (shipping) contact name only, "First Last".
4276
4277 =cut
4278
4279 sub ship_contact_firstlast {
4280   my $self = shift;
4281   my $contact = $self->service_contact || $self;
4282   $contact->get('first') . ' '. $contact->get('last');
4283 }
4284
4285 sub bill_country_full {
4286   my $self = shift;
4287   $self->bill_location->country_full;
4288 }
4289
4290 sub ship_country_full {
4291   my $self = shift;
4292   $self->ship_location->country_full;
4293 }
4294
4295 =item county_state_county [ PREFIX ]
4296
4297 Returns a string consisting of just the county, state and country.
4298
4299 =cut
4300
4301 sub county_state_country {
4302   my $self = shift;
4303   my $locationnum;
4304   if ( @_ && $_[0] && $self->has_ship_address ) {
4305     $locationnum = $self->ship_locationnum;
4306   } else {
4307     $locationnum = $self->bill_locationnum;
4308   }
4309   my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4310   $cust_location->county_state_country;
4311 }
4312
4313 =item geocode DATA_VENDOR
4314
4315 Returns a value for the customer location as encoded by DATA_VENDOR.
4316 Currently this only makes sense for "CCH" as DATA_VENDOR.
4317
4318 =cut
4319
4320 =item cust_status
4321
4322 =item status
4323
4324 Returns a status string for this customer, currently:
4325
4326 =over 4
4327
4328 =item prospect
4329
4330 No packages have ever been ordered.  Displayed as "No packages".
4331
4332 =item ordered
4333
4334 Recurring packages all are new (not yet billed).
4335
4336 =item active
4337
4338 One or more recurring packages is active.
4339
4340 =item inactive
4341
4342 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
4343
4344 =item suspended
4345
4346 All non-cancelled recurring packages are suspended.
4347
4348 =item cancelled
4349
4350 All recurring packages are cancelled.
4351
4352 =back
4353
4354 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4355 cust_main-status_module configuration option.
4356
4357 =cut
4358
4359 sub status { shift->cust_status(@_); }
4360
4361 sub cust_status {
4362   my $self = shift;
4363   return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4364   for my $status ( FS::cust_main->statuses() ) {
4365     my $method = $status.'_sql';
4366     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4367     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4368     $sth->execute( ($self->custnum) x $numnum )
4369       or die "Error executing 'SELECT $sql': ". $sth->errstr;
4370     if ( $sth->fetchrow_arrayref->[0] ) {
4371       $self->hashref->{cust_status} = $status;
4372       return $status;
4373     }
4374   }
4375 }
4376
4377 =item is_status_delay_cancel
4378
4379 Returns true if customer status is 'suspended'
4380 and all suspended cust_pkg return true for
4381 cust_pkg->is_status_delay_cancel.
4382
4383 This is not a real status, this only meant for hacking display
4384 values, because otherwise treating the customer as suspended is
4385 really the whole point of the delay_cancel option.
4386
4387 =cut
4388
4389 sub is_status_delay_cancel {
4390   my ($self) = @_;
4391   return 0 unless $self->status eq 'suspended';
4392   foreach my $cust_pkg ($self->ncancelled_pkgs) {
4393     return 0 unless $cust_pkg->is_status_delay_cancel;
4394   }
4395   return 1;
4396 }
4397
4398 =item ucfirst_cust_status
4399
4400 =item ucfirst_status
4401
4402 Deprecated, use the cust_status_label method instead.
4403
4404 Returns the status with the first character capitalized.
4405
4406 =cut
4407
4408 sub ucfirst_status {
4409   carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4410   local($ucfirst_nowarn) = 1;
4411   shift->ucfirst_cust_status(@_);
4412 }
4413
4414 sub ucfirst_cust_status {
4415   carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4416   my $self = shift;
4417   ucfirst($self->cust_status);
4418 }
4419
4420 =item cust_status_label
4421
4422 =item status_label
4423
4424 Returns the display label for this status.
4425
4426 =cut
4427
4428 sub status_label { shift->cust_status_label(@_); }
4429
4430 sub cust_status_label {
4431   my $self = shift;
4432   __PACKAGE__->statuslabels->{$self->cust_status};
4433 }
4434
4435 =item statuscolor
4436
4437 Returns a hex triplet color string for this customer's status.
4438
4439 =cut
4440
4441 sub statuscolor { shift->cust_statuscolor(@_); }
4442
4443 sub cust_statuscolor {
4444   my $self = shift;
4445   __PACKAGE__->statuscolors->{$self->cust_status};
4446 }
4447
4448 =item tickets [ STATUS ]
4449
4450 Returns an array of hashes representing the customer's RT tickets.
4451
4452 An optional status (or arrayref or hashref of statuses) may be specified.
4453
4454 =cut
4455
4456 sub tickets {
4457   my $self = shift;
4458   my $status = ( @_ && $_[0] ) ? shift : '';
4459
4460   my $num = $conf->config('cust_main-max_tickets') || 10;
4461   my @tickets = ();
4462
4463   if ( $conf->config('ticket_system') ) {
4464     unless ( $conf->config('ticket_system-custom_priority_field') ) {
4465
4466       @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4467                                                         $num,
4468                                                         undef,
4469                                                         $status,
4470                                                       )
4471                   };
4472
4473     } else {
4474
4475       foreach my $priority (
4476         $conf->config('ticket_system-custom_priority_field-values'), ''
4477       ) {
4478         last if scalar(@tickets) >= $num;
4479         push @tickets,
4480           @{ FS::TicketSystem->customer_tickets( $self->custnum,
4481                                                  $num - scalar(@tickets),
4482                                                  $priority,
4483                                                  $status,
4484                                                )
4485            };
4486       }
4487     }
4488   }
4489   (@tickets);
4490 }
4491
4492 =item appointments [ STATUS ]
4493
4494 Returns an array of hashes representing the customer's RT tickets which
4495 are appointments.
4496
4497 =cut
4498
4499 sub appointments {
4500   my $self = shift;
4501   my $status = ( @_ && $_[0] ) ? shift : '';
4502
4503   return () unless $conf->config('ticket_system');
4504
4505   my $queueid = $conf->config('ticket_system-appointment-queueid');
4506
4507   @{ FS::TicketSystem->customer_tickets( $self->custnum,
4508                                          99,
4509                                          undef,
4510                                          $status,
4511                                          $queueid,
4512                                        )
4513   };
4514 }
4515
4516 # Return services representing svc_accts in customer support packages
4517 sub support_services {
4518   my $self = shift;
4519   my %packages = map { $_ => 1 } $conf->config('support_packages');
4520
4521   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4522     grep { $_->part_svc->svcdb eq 'svc_acct' }
4523     map { $_->cust_svc }
4524     grep { exists $packages{ $_->pkgpart } }
4525     $self->ncancelled_pkgs;
4526
4527 }
4528
4529 # Return a list of latitude/longitude for one of the services (if any)
4530 sub service_coordinates {
4531   my $self = shift;
4532
4533   my @svc_X =
4534     grep { $_->latitude && $_->longitude }
4535     map { $_->svc_x }
4536     map { $_->cust_svc }
4537     $self->ncancelled_pkgs;
4538
4539   scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4540 }
4541
4542 =item masked FIELD
4543
4544 Returns a masked version of the named field
4545
4546 =cut
4547
4548 sub masked {
4549 my ($self,$field) = @_;
4550
4551 # Show last four
4552
4553 'x'x(length($self->getfield($field))-4).
4554   substr($self->getfield($field), (length($self->getfield($field))-4));
4555
4556 }
4557
4558 =item payment_history
4559
4560 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4561 cust_credit and cust_refund objects.  Each hashref has the following fields:
4562
4563 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4564
4565 I<date> - value of _date field, unix timestamp
4566
4567 I<date_pretty> - user-friendly date
4568
4569 I<description> - user-friendly description of item
4570
4571 I<amount> - impact of item on user's balance
4572 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4573 Not to be confused with the native 'amount' field in cust_credit, see below.
4574
4575 I<amount_pretty> - includes money char
4576
4577 I<balance> - customer balance, chronologically as of this item
4578
4579 I<balance_pretty> - includes money char
4580
4581 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4582
4583 I<paid> - amount paid for cust_pay records, undef for other types
4584
4585 I<credit> - amount credited for cust_credit records, undef for other types.
4586 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4587
4588 I<refund> - amount refunded for cust_refund records, undef for other types
4589
4590 The four table-specific keys always have positive values, whether they reflect charges or payments.
4591
4592 The following options may be passed to this method:
4593
4594 I<line_items> - if true, returns charges ('Line item') rather than invoices
4595
4596 I<start_date> - unix timestamp, only include records on or after.
4597 If specified, an item of type 'Previous' will also be included.
4598 It does not have table-specific fields.
4599
4600 I<end_date> - unix timestamp, only include records before
4601
4602 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4603
4604 I<conf> - optional already-loaded FS::Conf object.
4605
4606 =cut
4607
4608 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4609 # and also for sending customer statements, which should both be kept customer-friendly.
4610 # If you add anything that shouldn't be passed on through the API or exposed
4611 # to customers, add a new option to include it, don't include it by default
4612 sub payment_history {
4613   my $self = shift;
4614   my $opt = ref($_[0]) ? $_[0] : { @_ };
4615
4616   my $conf = $$opt{'conf'} || new FS::Conf;
4617   my $money_char = $conf->config("money_char") || '$',
4618
4619   #first load entire history,
4620   #need previous to calculate previous balance
4621   #loading after end_date shouldn't hurt too much?
4622   my @history = ();
4623   if ( $$opt{'line_items'} ) {
4624
4625     foreach my $cust_bill ( $self->cust_bill ) {
4626
4627       push @history, {
4628         'type'        => 'Line item',
4629         'description' => $_->desc( $self->locale ).
4630                            ( $_->sdate && $_->edate
4631                                ? ' '. time2str('%d-%b-%Y', $_->sdate).
4632                                  ' To '. time2str('%d-%b-%Y', $_->edate)
4633                                : ''
4634                            ),
4635         'amount'      => sprintf('%.2f', $_->setup + $_->recur ),
4636         'charged'     => sprintf('%.2f', $_->setup + $_->recur ),
4637         'date'        => $cust_bill->_date,
4638         'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4639       }
4640         foreach $cust_bill->cust_bill_pkg;
4641
4642     }
4643
4644   } else {
4645
4646     push @history, {
4647                      'type'        => 'Invoice',
4648                      'description' => 'Invoice #'. $_->display_invnum,
4649                      'amount'      => sprintf('%.2f', $_->charged ),
4650                      'charged'     => sprintf('%.2f', $_->charged ),
4651                      'date'        => $_->_date,
4652                      'date_pretty' => $self->time2str_local('short', $_->_date ),
4653                    }
4654       foreach $self->cust_bill;
4655
4656   }
4657
4658   push @history, {
4659                    'type'        => 'Payment',
4660                    'description' => 'Payment', #XXX type
4661                    'amount'      => sprintf('%.2f', 0 - $_->paid ),
4662                    'paid'        => sprintf('%.2f', $_->paid ),
4663                    'date'        => $_->_date,
4664                    'date_pretty' => $self->time2str_local('short', $_->_date ),
4665                  }
4666     foreach $self->cust_pay;
4667
4668   push @history, {
4669                    'type'        => 'Credit',
4670                    'description' => 'Credit', #more info?
4671                    'amount'      => sprintf('%.2f', 0 -$_->amount ),
4672                    'credit'      => sprintf('%.2f', $_->amount ),
4673                    'date'        => $_->_date,
4674                    'date_pretty' => $self->time2str_local('short', $_->_date ),
4675                  }
4676     foreach $self->cust_credit;
4677
4678   push @history, {
4679                    'type'        => 'Refund',
4680                    'description' => 'Refund', #more info?  type, like payment?
4681                    'amount'      => $_->refund,
4682                    'refund'      => $_->refund,
4683                    'date'        => $_->_date,
4684                    'date_pretty' => $self->time2str_local('short', $_->_date ),
4685                  }
4686     foreach $self->cust_refund;
4687
4688   #put it all in chronological order
4689   @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4690
4691   #calculate balance, filter items outside date range
4692   my $previous = 0;
4693   my $balance = 0;
4694   my @out = ();
4695   foreach my $item (@history) {
4696     last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4697     $balance += $$item{'amount'};
4698     if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4699       $previous += $$item{'amount'};
4700       next;
4701     }
4702     $$item{'balance'} = sprintf("%.2f",$balance);
4703     foreach my $key ( qw(amount balance) ) {
4704       $$item{$key.'_pretty'} = money_pretty($$item{$key});
4705     }
4706     push(@out,$item);
4707   }
4708
4709   # start with previous balance, if there was one
4710   if ($previous) {
4711     my $item = {
4712       'type'        => 'Previous',
4713       'description' => 'Previous balance',
4714       'amount'      => sprintf("%.2f",$previous),
4715       'balance'     => sprintf("%.2f",$previous),
4716       'date'        => $$opt{'start_date'},
4717       'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4718     };
4719     #false laziness with above
4720     foreach my $key ( qw(amount balance) ) {
4721       $$item{$key.'_pretty'} = $$item{$key};
4722       $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4723     }
4724     unshift(@out,$item);
4725   }
4726
4727   @out = reverse @history if $$opt{'reverse_sort'};
4728
4729   return @out;
4730 }
4731
4732 =item save_cust_payby
4733
4734 Saves a new cust_payby for this customer, replacing an existing entry only
4735 in select circumstances.  Does not validate input.
4736
4737 If auto is specified, marks this as the customer's primary method, or the
4738 specified weight.  Existing payment methods have their weight incremented as
4739 appropriate.
4740
4741 If bill_location is specified with auto, also sets location in cust_main.
4742
4743 Will not insert complete duplicates of existing records, or records in which the
4744 only difference from an existing record is to turn off automatic payment (will
4745 return without error.)  Will replace existing records in which the only difference
4746 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4747 Fields marked as preserved are optional, and existing values will not be overwritten with
4748 blanks when replacing.
4749
4750 Accepts the following named parameters:
4751
4752 =over 4
4753
4754 =item payment_payby
4755
4756 either CARD or CHEK
4757
4758 =item auto
4759
4760 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4761
4762 =item weight
4763
4764 optional, set higher than 1 for secondary, etc.
4765
4766 =item payinfo
4767
4768 required
4769
4770 =item paymask
4771
4772 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4773
4774 =item payname
4775
4776 required
4777
4778 =item payip
4779
4780 optional, will be preserved when replacing
4781
4782 =item paydate
4783
4784 CARD only, required
4785
4786 =item bill_location
4787
4788 CARD only, required, FS::cust_location object
4789
4790 =item paystart_month
4791
4792 CARD only, optional, will be preserved when replacing
4793
4794 =item paystart_year
4795
4796 CARD only, optional, will be preserved when replacing
4797
4798 =item payissue
4799
4800 CARD only, optional, will be preserved when replacing
4801
4802 =item paycvv
4803
4804 CARD only, only used if conf cvv-save is set appropriately
4805
4806 =item paytype
4807
4808 CHEK only
4809
4810 =item paystate
4811
4812 CHEK only
4813
4814 =item saved_cust_payby
4815
4816 scalar reference, for returning saved object
4817
4818 =back
4819
4820 =cut
4821
4822 #The code for this option is in place, but it's not currently used
4823 #
4824 # =item replace
4825 #
4826 # existing cust_payby object to be replaced (must match custnum)
4827
4828 # stateid/stateid_state/ss are not currently supported in cust_payby,
4829 # might not even work properly in 4.x, but will need to work here if ever added
4830
4831 sub save_cust_payby {
4832   my $self = shift;
4833   my %opt = @_;
4834
4835   my $old = $opt{'replace'};
4836   my $new = new FS::cust_payby { $old ? $old->hash : () };
4837   return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4838   $new->set( 'custnum' => $self->custnum );
4839
4840   my $payby = $opt{'payment_payby'};
4841   return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4842
4843   # don't allow turning off auto when replacing
4844   $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4845
4846   my @check_existing; # payby relevant to this payment_payby
4847
4848   # set payby based on auto
4849   if ( $payby eq 'CARD' ) {
4850     $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4851     @check_existing = qw( CARD DCRD );
4852   } elsif ( $payby eq 'CHEK' ) {
4853     $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4854     @check_existing = qw( CHEK DCHK );
4855   }
4856
4857   $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4858
4859   # basic fields
4860   $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4861   $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4862   $new->set( 'payname' => $opt{'payname'} );
4863   $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4864
4865   my $conf = new FS::Conf;
4866
4867   # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4868   if ( $payby eq 'CARD' &&
4869        ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4870          || $conf->exists('business-onlinepayment-verification')
4871        )
4872   ) {
4873     $new->set( 'paycvv' => $opt{'paycvv'} );
4874   } else {
4875     $new->set( 'paycvv' => '');
4876   }
4877
4878   local $SIG{HUP} = 'IGNORE';
4879   local $SIG{INT} = 'IGNORE';
4880   local $SIG{QUIT} = 'IGNORE';
4881   local $SIG{TERM} = 'IGNORE';
4882   local $SIG{TSTP} = 'IGNORE';
4883   local $SIG{PIPE} = 'IGNORE';
4884
4885   my $oldAutoCommit = $FS::UID::AutoCommit;
4886   local $FS::UID::AutoCommit = 0;
4887   my $dbh = dbh;
4888
4889   # set fields specific to payment_payby
4890   if ( $payby eq 'CARD' ) {
4891     if ($opt{'bill_location'}) {
4892       $opt{'bill_location'}->set('custnum' => $self->custnum);
4893       my $error = $opt{'bill_location'}->find_or_insert;
4894       if ( $error ) {
4895         $dbh->rollback if $oldAutoCommit;
4896         return $error;
4897       }
4898       $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4899     }
4900     foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4901       $new->set( $field => $opt{$field} );
4902     }
4903   } else {
4904     foreach my $field ( qw(paytype paystate) ) {
4905       $new->set( $field => $opt{$field} );
4906     }
4907   }
4908
4909   # other cust_payby to compare this to
4910   my @existing = $self->cust_payby(@check_existing);
4911
4912   # fields that can overwrite blanks with values, but not values with blanks
4913   my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4914
4915   my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4916   unless ($old) {
4917     # generally, we don't want to overwrite existing cust_payby with this,
4918     # but we can replace if we're only marking it auto or adding a preserved field
4919     # and we can avoid saving a total duplicate or merely turning off auto
4920 PAYBYLOOP:
4921     foreach my $cust_payby (@existing) {
4922       # check fields that absolutely should not change
4923       foreach my $field ($new->fields) {
4924         next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4925         next if grep(/^$field$/, @preserve );
4926         next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4927         # check if paymask exists,  if so stop and don't save, no need for a duplicate.
4928         return '' if $new->get('paymask') eq $cust_payby->get('paymask');
4929       }
4930       # now check fields that can replace if one value is blank
4931       my $replace = 0;
4932       foreach my $field (@preserve) {
4933         if (
4934           ( $new->get($field) and !$cust_payby->get($field) ) or
4935           ( $cust_payby->get($field) and !$new->get($field) )
4936         ) {
4937           # prevention of overwriting values with blanks happens farther below
4938           $replace = 1;
4939         } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4940           next PAYBYLOOP;
4941         }
4942       }
4943       unless ( $replace ) {
4944         # nearly identical, now check weight
4945         if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4946           # ignore identical cust_payby, and ignore attempts to turn off auto
4947           # no need to save or re-weight cust_payby (but still need to update/commit $self)
4948           $skip_cust_payby = 1;
4949           last PAYBYLOOP;
4950         }
4951         # otherwise, only change is to mark this as primary
4952       }
4953       # if we got this far, we're definitely replacing
4954       $old = $cust_payby;
4955       last PAYBYLOOP;
4956     } #PAYBYLOOP
4957   }
4958
4959   if ($old) {
4960     $new->set( 'custpaybynum' => $old->custpaybynum );
4961     # don't turn off automatic payment (but allow it to be turned on)
4962     if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4963       $opt{'auto'} = 1;
4964       $new->set( 'payby' => $old->payby );
4965       $new->set( 'weight' => 1 );
4966     }
4967     # make sure we're not overwriting values with blanks
4968     foreach my $field (@preserve) {
4969       if ( $old->get($field) and !$new->get($field) ) {
4970         $new->set( $field => $old->get($field) );
4971       }
4972     }
4973   }
4974
4975   # only overwrite cust_main bill_location if auto
4976   if ($opt{'auto'} && $opt{'bill_location'}) {
4977     $self->set('bill_location' => $opt{'bill_location'});
4978     my $error = $self->replace;
4979     if ( $error ) {
4980       $dbh->rollback if $oldAutoCommit;
4981       return $error;
4982     }
4983   }
4984
4985   # done with everything except reweighting and saving cust_payby
4986   # still need to commit changes to cust_main and cust_location
4987   if ($skip_cust_payby) {
4988     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4989     return '';
4990   }
4991
4992   # re-weight existing primary cust_pay for this payby
4993   if ($opt{'auto'}) {
4994     foreach my $cust_payby (@existing) {
4995       # relies on cust_payby return order
4996       last unless $cust_payby->payby !~ /^D/;
4997       last if $cust_payby->weight > 1;
4998       next if $new->custpaybynum eq $cust_payby->custpaybynum;
4999       next if $cust_payby->weight < ($opt{'weight'} || 1);
5000       $cust_payby->weight( $cust_payby->weight + 1 );
5001       my $error = $cust_payby->replace;
5002       if ( $error ) {
5003         $dbh->rollback if $oldAutoCommit;
5004         return "Error reweighting cust_payby: $error";
5005       }
5006     }
5007   }
5008
5009   # finally, save cust_payby
5010   my $error = $old ? $new->replace($old) : $new->insert;
5011   if ( $error ) {
5012     $dbh->rollback if $oldAutoCommit;
5013     return $error;
5014   }
5015
5016   ${$opt{'saved_cust_payby'}} = $new
5017     if $opt{'saved_cust_payby'};
5018
5019   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5020   '';
5021
5022 }
5023
5024 =item remove_cvv_from_cust_payby PAYINFO
5025
5026 Removes paycvv from associated cust_payby with matching PAYINFO.
5027
5028 =cut
5029
5030 sub remove_cvv_from_cust_payby {
5031   my ($self,$payinfo) = @_;
5032
5033   my $oldAutoCommit = $FS::UID::AutoCommit;
5034   local $FS::UID::AutoCommit = 0;
5035   my $dbh = dbh;
5036
5037   foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
5038     next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
5039     $cust_payby->paycvv('');
5040     my $error = $cust_payby->replace;
5041     if ($error) {
5042       $dbh->rollback if $oldAutoCommit;
5043       return $error;
5044     }
5045   }
5046
5047   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5048   '';
5049 }
5050
5051 =back
5052
5053 =head1 CLASS METHODS
5054
5055 =over 4
5056
5057 =item statuses
5058
5059 Class method that returns the list of possible status strings for customers
5060 (see L<the status method|/status>).  For example:
5061
5062   @statuses = FS::cust_main->statuses();
5063
5064 =cut
5065
5066 sub statuses {
5067   my $self = shift;
5068   keys %{ $self->statuscolors };
5069 }
5070
5071 =item cust_status_sql
5072
5073 Returns an SQL fragment to determine the status of a cust_main record, as a
5074 string.
5075
5076 =cut
5077
5078 sub cust_status_sql {
5079   my $sql = 'CASE';
5080   for my $status ( FS::cust_main->statuses() ) {
5081     my $method = $status.'_sql';
5082     $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
5083   }
5084   $sql .= ' END';
5085   return $sql;
5086 }
5087
5088
5089 =item prospect_sql
5090
5091 Returns an SQL expression identifying prospective cust_main records (customers
5092 with no packages ever ordered)
5093
5094 =cut
5095
5096 use vars qw($select_count_pkgs);
5097 $select_count_pkgs =
5098   "SELECT COUNT(*) FROM cust_pkg
5099     WHERE cust_pkg.custnum = cust_main.custnum";
5100
5101 sub select_count_pkgs_sql {
5102   $select_count_pkgs;
5103 }
5104
5105 sub prospect_sql {
5106   " 0 = ( $select_count_pkgs ) ";
5107 }
5108
5109 =item ordered_sql
5110
5111 Returns an SQL expression identifying ordered cust_main records (customers with
5112 no active packages, but recurring packages not yet setup or one time charges
5113 not yet billed).
5114
5115 =cut
5116
5117 sub ordered_sql {
5118   FS::cust_main->none_active_sql.
5119   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
5120 }
5121
5122 =item active_sql
5123
5124 Returns an SQL expression identifying active cust_main records (customers with
5125 active recurring packages).
5126
5127 =cut
5128
5129 sub active_sql {
5130   " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
5131 }
5132
5133 =item none_active_sql
5134
5135 Returns an SQL expression identifying cust_main records with no active
5136 recurring packages.  This includes customers of status prospect, ordered,
5137 inactive, and suspended.
5138
5139 =cut
5140
5141 sub none_active_sql {
5142   " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
5143 }
5144
5145 =item inactive_sql
5146
5147 Returns an SQL expression identifying inactive cust_main records (customers with
5148 no active recurring packages, but otherwise unsuspended/uncancelled).
5149
5150 =cut
5151
5152 sub inactive_sql {
5153   FS::cust_main->none_active_sql.
5154   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
5155 }
5156
5157 =item susp_sql
5158 =item suspended_sql
5159
5160 Returns an SQL expression identifying suspended cust_main records.
5161
5162 =cut
5163
5164
5165 sub suspended_sql { susp_sql(@_); }
5166 sub susp_sql {
5167   FS::cust_main->none_active_sql.
5168   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
5169 }
5170
5171 =item cancel_sql
5172 =item cancelled_sql
5173
5174 Returns an SQL expression identifying cancelled cust_main records.
5175
5176 =cut
5177
5178 sub cancel_sql { shift->cancelled_sql(@_); }
5179
5180 =item uncancel_sql
5181 =item uncancelled_sql
5182
5183 Returns an SQL expression identifying un-cancelled cust_main records.
5184
5185 =cut
5186
5187 sub uncancelled_sql { uncancel_sql(@_); }
5188 sub uncancel_sql {
5189   my $self = shift;
5190   "( NOT (".$self->cancelled_sql.") )"; #sensitive to cust_main-status_module
5191 }
5192
5193 =item balance_sql
5194
5195 Returns an SQL fragment to retreive the balance.
5196
5197 =cut
5198
5199 sub balance_sql { "
5200     ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5201         WHERE cust_bill.custnum   = cust_main.custnum     )
5202   - ( SELECT COALESCE( SUM(paid),    0 ) FROM cust_pay
5203         WHERE cust_pay.custnum    = cust_main.custnum     )
5204   - ( SELECT COALESCE( SUM(amount),  0 ) FROM cust_credit
5205         WHERE cust_credit.custnum = cust_main.custnum     )
5206   + ( SELECT COALESCE( SUM(refund),  0 ) FROM cust_refund
5207         WHERE cust_refund.custnum = cust_main.custnum     )
5208 "; }
5209
5210 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
5211
5212 Returns an SQL fragment to retreive the balance for this customer, optionally
5213 considering invoices with date earlier than START_TIME, and not
5214 later than END_TIME (total_owed_date minus total_unapplied_credits minus
5215 total_unapplied_payments).
5216
5217 Times are specified as SQL fragments or numeric
5218 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
5219 L<Date::Parse> for conversion functions.  The empty string can be passed
5220 to disable that time constraint completely.
5221
5222 Available options are:
5223
5224 =over 4
5225
5226 =item unapplied_date
5227
5228 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)
5229
5230 =item total
5231
5232 (unused.  obsolete?)
5233 set to true to remove all customer comparison clauses, for totals
5234
5235 =item where
5236
5237 (unused.  obsolete?)
5238 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5239
5240 =item join
5241
5242 (unused.  obsolete?)
5243 JOIN clause (typically used with the total option)
5244
5245 =item cutoff
5246
5247 An absolute cutoff time.  Payments, credits, and refunds I<applied> after this
5248 time will be ignored.  Note that START_TIME and END_TIME only limit the date
5249 range for invoices and I<unapplied> payments, credits, and refunds.
5250
5251 =back
5252
5253 =cut
5254
5255 sub balance_date_sql {
5256   my( $class, $start, $end, %opt ) = @_;
5257
5258   my $cutoff = $opt{'cutoff'};
5259
5260   my $owed         = FS::cust_bill->owed_sql($cutoff);
5261   my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
5262   my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
5263   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
5264
5265   my $j = $opt{'join'} || '';
5266
5267   my $owed_wh   = $class->_money_table_where( 'cust_bill',   $start,$end,%opt );
5268   my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5269   my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5270   my $pay_wh    = $class->_money_table_where( 'cust_pay',    $start,$end,%opt );
5271
5272   "   ( SELECT COALESCE(SUM($owed),         0) FROM cust_bill   $j $owed_wh   )
5273     + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5274     - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5275     - ( SELECT COALESCE(SUM($unapp_pay),    0) FROM cust_pay    $j $pay_wh    )
5276   ";
5277
5278 }
5279
5280 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
5281
5282 Returns an SQL fragment to retreive the total unapplied payments for this
5283 customer, only considering payments with date earlier than START_TIME, and
5284 optionally not later than END_TIME.
5285
5286 Times are specified as SQL fragments or numeric
5287 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
5288 L<Date::Parse> for conversion functions.  The empty string can be passed
5289 to disable that time constraint completely.
5290
5291 Available options are:
5292
5293 =cut
5294
5295 sub unapplied_payments_date_sql {
5296   my( $class, $start, $end, %opt ) = @_;
5297
5298   my $cutoff = $opt{'cutoff'};
5299
5300   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
5301
5302   my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
5303                                                           'unapplied_date'=>1 );
5304
5305   " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
5306 }
5307
5308 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5309
5310 Helper method for balance_date_sql; name (and usage) subject to change
5311 (suggestions welcome).
5312
5313 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5314 cust_refund, cust_credit or cust_pay).
5315
5316 If TABLE is "cust_bill" or the unapplied_date option is true, only
5317 considers records with date earlier than START_TIME, and optionally not
5318 later than END_TIME .
5319
5320 =cut
5321
5322 sub _money_table_where {
5323   my( $class, $table, $start, $end, %opt ) = @_;
5324
5325   my @where = ();
5326   push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5327   if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5328     push @where, "$table._date <= $start" if defined($start) && length($start);
5329     push @where, "$table._date >  $end"   if defined($end)   && length($end);
5330   }
5331   push @where, @{$opt{'where'}} if $opt{'where'};
5332   my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5333
5334   $where;
5335
5336 }
5337
5338 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
5339 use FS::cust_main::Search;
5340 sub search {
5341   my $class = shift;
5342   FS::cust_main::Search->search(@_);
5343 }
5344
5345 =back
5346
5347 =head1 SUBROUTINES
5348
5349 =over 4
5350
5351 #=item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5352
5353 #Deprecated.  Use event notification and message templates
5354 #(L<FS::msg_template>) instead.
5355
5356 #Sends a templated email notification to the customer (see L<Text::Template>).
5357
5358 #OPTIONS is a hash and may include
5359
5360 #I<from> - the email sender (default is invoice_from)
5361
5362 #I<to> - comma-separated scalar or arrayref of recipients
5363 #   (default is invoicing_list)
5364
5365 #I<subject> - The subject line of the sent email notification
5366 #   (default is "Notice from company_name")
5367
5368 #I<extra_fields> - a hashref of name/value pairs which will be substituted
5369 #   into the template
5370
5371 #The following variables are vavailable in the template.
5372
5373 #I<$first> - the customer first name
5374 #I<$last> - the customer last name
5375 #I<$company> - the customer company
5376 #I<$payby> - a description of the method of payment for the customer
5377 #            # would be nice to use FS::payby::shortname
5378 #I<$payinfo> - the account information used to collect for this customer
5379 #I<$expdate> - the expiration of the customer payment in seconds from epoch
5380
5381 #=cut
5382
5383 #sub notify {
5384 #  my ($self, $template, %options) = @_;
5385
5386 #  return unless $conf->exists($template);
5387
5388 #  my $from = $conf->invoice_from_full($self->agentnum)
5389 #    if $conf->exists('invoice_from', $self->agentnum);
5390 #  $from = $options{from} if exists($options{from});
5391
5392 #  my $to = join(',', $self->invoicing_list_emailonly);
5393 #  $to = $options{to} if exists($options{to});
5394 #
5395 #  my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
5396 #    if $conf->exists('company_name', $self->agentnum);
5397 #  $subject = $options{subject} if exists($options{subject});
5398
5399 #  my $notify_template = new Text::Template (TYPE => 'ARRAY',
5400 #                                            SOURCE => [ map "$_\n",
5401 #                                              $conf->config($template)]
5402 #                                           )
5403 #    or die "can't create new Text::Template object: Text::Template::ERROR";
5404 #  $notify_template->compile()
5405 #    or die "can't compile template: Text::Template::ERROR";
5406
5407 #  $FS::notify_template::_template::company_name =
5408 #    $conf->config('company_name', $self->agentnum);
5409 #  $FS::notify_template::_template::company_address =
5410 #    join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
5411
5412 #  my $paydate = $self->paydate || '2037-12-31';
5413 #  $FS::notify_template::_template::first = $self->first;
5414 #  $FS::notify_template::_template::last = $self->last;
5415 #  $FS::notify_template::_template::company = $self->company;
5416 #  $FS::notify_template::_template::payinfo = $self->mask_payinfo;
5417 #  my $payby = $self->payby;
5418 #  my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5419 #  my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5420
5421 #  #credit cards expire at the end of the month/year of their exp date
5422 #  if ($payby eq 'CARD' || $payby eq 'DCRD') {
5423 #    $FS::notify_template::_template::payby = 'credit card';
5424 #    ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5425 #    $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5426 #    $expire_time--;
5427 #  }elsif ($payby eq 'COMP') {
5428 #    $FS::notify_template::_template::payby = 'complimentary account';
5429 #  }else{
5430 #    $FS::notify_template::_template::payby = 'current method';
5431 #  }
5432 #  $FS::notify_template::_template::expdate = $expire_time;
5433
5434 #  for (keys %{$options{extra_fields}}){
5435 #    no strict "refs";
5436 #    ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5437 #  }
5438
5439 #  send_email(from => $from,
5440 #             to => $to,
5441 #             subject => $subject,
5442 #             body => $notify_template->fill_in( PACKAGE =>
5443 #                                                'FS::notify_template::_template'                                              ),
5444 #            );
5445
5446 #}
5447
5448 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5449
5450 Generates a templated notification to the customer (see L<Text::Template>).
5451
5452 OPTIONS is a hash and may include
5453
5454 I<extra_fields> - a hashref of name/value pairs which will be substituted
5455    into the template.  These values may override values mentioned below
5456    and those from the customer record.
5457
5458 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5459
5460 The following variables are available in the template instead of or in addition
5461 to the fields of the customer record.
5462
5463 I<$payby> - a description of the method of payment for the customer
5464             # would be nice to use FS::payby::shortname
5465 I<$payinfo> - the masked account information used to collect for this customer
5466 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5467 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5468
5469 =cut
5470
5471 # a lot like cust_bill::print_latex
5472 sub generate_letter {
5473   my ($self, $template, %options) = @_;
5474
5475   warn "Template $template does not exist" && return
5476     unless $conf->exists($template) || $options{'template_text'};
5477
5478   my $template_source = $options{'template_text'}
5479                         ? [ $options{'template_text'} ]
5480                         : [ map "$_\n", $conf->config($template) ];
5481
5482   my $letter_template = new Text::Template
5483                         ( TYPE       => 'ARRAY',
5484                           SOURCE     => $template_source,
5485                           DELIMITERS => [ '[@--', '--@]' ],
5486                         )
5487     or die "can't create new Text::Template object: Text::Template::ERROR";
5488
5489   $letter_template->compile()
5490     or die "can't compile template: Text::Template::ERROR";
5491
5492   my %letter_data = map { $_ => $self->$_ } $self->fields;
5493   $letter_data{payinfo} = $self->mask_payinfo;
5494
5495   #my $paydate = $self->paydate || '2037-12-31';
5496   my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
5497
5498   my $payby = $self->payby;
5499   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5500   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5501
5502   #credit cards expire at the end of the month/year of their exp date
5503   if ($payby eq 'CARD' || $payby eq 'DCRD') {
5504     $letter_data{payby} = 'credit card';
5505     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5506     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5507     $expire_time--;
5508   }elsif ($payby eq 'COMP') {
5509     $letter_data{payby} = 'complimentary account';
5510   }else{
5511     $letter_data{payby} = 'current method';
5512   }
5513   $letter_data{expdate} = $expire_time;
5514
5515   for (keys %{$options{extra_fields}}){
5516     $letter_data{$_} = $options{extra_fields}->{$_};
5517   }
5518
5519   unless(exists($letter_data{returnaddress})){
5520     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5521                                                   $self->agent_template)
5522                      );
5523     if ( length($retadd) ) {
5524       $letter_data{returnaddress} = $retadd;
5525     } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5526       $letter_data{returnaddress} =
5527         join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5528                           s/$/\\\\\*/;
5529                           $_;
5530                         }
5531                     ( $conf->config('company_name', $self->agentnum),
5532                       $conf->config('company_address', $self->agentnum),
5533                     )
5534         );
5535     } else {
5536       $letter_data{returnaddress} = '~';
5537     }
5538   }
5539
5540   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5541
5542   $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5543
5544   my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5545
5546   my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5547                            DIR      => $dir,
5548                            SUFFIX   => '.eps',
5549                            UNLINK   => 0,
5550                          ) or die "can't open temp file: $!\n";
5551   print $lh $conf->config_binary('logo.eps', $self->agentnum)
5552     or die "can't write temp file: $!\n";
5553   close $lh;
5554   $letter_data{'logo_file'} = $lh->filename;
5555
5556   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5557                            DIR      => $dir,
5558                            SUFFIX   => '.tex',
5559                            UNLINK   => 0,
5560                          ) or die "can't open temp file: $!\n";
5561
5562   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5563   close $fh;
5564   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5565   return ($1, $letter_data{'logo_file'});
5566
5567 }
5568
5569 =item print_ps TEMPLATE
5570
5571 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5572
5573 =cut
5574
5575 sub print_ps {
5576   my $self = shift;
5577   my($file, $lfile) = $self->generate_letter(@_);
5578   my $ps = FS::Misc::generate_ps($file);
5579   unlink($file.'.tex');
5580   unlink($lfile);
5581
5582   $ps;
5583 }
5584
5585 =item print TEMPLATE
5586
5587 Prints the filled in template.
5588
5589 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5590
5591 =cut
5592
5593 sub queueable_print {
5594   my %opt = @_;
5595
5596   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5597     or die "invalid customer number: " . $opt{custnum};
5598
5599 #do not backport this change to 3.x
5600 #  my $error = $self->print( { 'template' => $opt{template} } );
5601   my $error = $self->print( $opt{'template'} );
5602   die $error if $error;
5603 }
5604
5605 sub print {
5606   my ($self, $template) = (shift, shift);
5607   do_print(
5608     [ $self->print_ps($template) ],
5609     'agentnum' => $self->agentnum,
5610   );
5611 }
5612
5613 #these three subs should just go away once agent stuff is all config overrides
5614
5615 sub agent_template {
5616   my $self = shift;
5617   $self->_agent_plandata('agent_templatename');
5618 }
5619
5620 sub agent_invoice_from {
5621   my $self = shift;
5622   $self->_agent_plandata('agent_invoice_from');
5623 }
5624
5625 sub _agent_plandata {
5626   my( $self, $option ) = @_;
5627
5628   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
5629   #agent-specific Conf
5630
5631   use FS::part_event::Condition;
5632
5633   my $agentnum = $self->agentnum;
5634
5635   my $regexp = regexp_sql();
5636
5637   my $part_event_option =
5638     qsearchs({
5639       'select'    => 'part_event_option.*',
5640       'table'     => 'part_event_option',
5641       'addl_from' => q{
5642         LEFT JOIN part_event USING ( eventpart )
5643         LEFT JOIN part_event_option AS peo_agentnum
5644           ON ( part_event.eventpart = peo_agentnum.eventpart
5645                AND peo_agentnum.optionname = 'agentnum'
5646                AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5647              )
5648         LEFT JOIN part_event_condition
5649           ON ( part_event.eventpart = part_event_condition.eventpart
5650                AND part_event_condition.conditionname = 'cust_bill_age'
5651              )
5652         LEFT JOIN part_event_condition_option
5653           ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5654                AND part_event_condition_option.optionname = 'age'
5655              )
5656       },
5657       #'hashref'   => { 'optionname' => $option },
5658       #'hashref'   => { 'part_event_option.optionname' => $option },
5659       'extra_sql' =>
5660         " WHERE part_event_option.optionname = ". dbh->quote($option).
5661         " AND action = 'cust_bill_send_agent' ".
5662         " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5663         " AND peo_agentnum.optionname = 'agentnum' ".
5664         " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5665         " ORDER BY
5666            CASE WHEN part_event_condition_option.optionname IS NULL
5667            THEN -1
5668            ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5669         " END
5670           , part_event.weight".
5671         " LIMIT 1"
5672     });
5673
5674   unless ( $part_event_option ) {
5675     return $self->agent->invoice_template || ''
5676       if $option eq 'agent_templatename';
5677     return '';
5678   }
5679
5680   $part_event_option->optionvalue;
5681
5682 }
5683
5684 sub process_o2m_qsearch {
5685   my $self = shift;
5686   my $table = shift;
5687   return qsearch($table, @_) unless $table eq 'contact';
5688
5689   my $hashref = shift;
5690   my %hash = %$hashref;
5691   ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5692     or die 'guru meditation #4343';
5693
5694   qsearch({ 'table'     => 'contact',
5695             'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5696             'hashref'   => \%hash,
5697             'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5698                            " cust_contact.custnum = $custnum "
5699          });
5700 }
5701
5702 sub process_o2m_qsearchs {
5703   my $self = shift;
5704   my $table = shift;
5705   return qsearchs($table, @_) unless $table eq 'contact';
5706
5707   my $hashref = shift;
5708   my %hash = %$hashref;
5709   ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5710     or die 'guru meditation #2121';
5711
5712   qsearchs({ 'table'     => 'contact',
5713              'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5714              'hashref'   => \%hash,
5715              'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5716                             " cust_contact.custnum = $custnum "
5717           });
5718 }
5719
5720 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5721
5722 Subroutine (not a method), designed to be called from the queue.
5723
5724 Takes a list of options and values.
5725
5726 Pulls up the customer record via the custnum option and calls bill_and_collect.
5727
5728 =cut
5729
5730 sub queued_bill {
5731   my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5732
5733   my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5734   warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5735
5736   #without this errors don't get rolled back
5737   $args{'fatal'} = 1; # runs from job queue, will be caught
5738
5739   $cust_main->bill_and_collect( %args );
5740 }
5741
5742 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5743
5744 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5745 C<collect> part.  This is used in batch tax calculation, where invoice
5746 generation and collection events have to be completely separated.
5747
5748 =cut
5749
5750 sub queued_collect {
5751   my (%args) = @_;
5752   my $cust_main = FS::cust_main->by_key($args{'custnum'});
5753
5754   $cust_main->collect(%args);
5755 }
5756
5757 sub process_bill_and_collect {
5758   my $job = shift;
5759   my $param = shift;
5760   my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5761       or die "custnum '$param->{custnum}' not found!\n";
5762   $param->{'job'}   = $job;
5763   $param->{'fatal'} = 1; # runs from job queue, will be caught
5764   $param->{'retry'} = 1;
5765
5766   local $@;
5767   eval { $cust_main->bill_and_collect( %$param) };
5768   if ( $@ ) {
5769     die $@ =~ /cancel_pkgs cannot be run inside a transaction/
5770       ? "Bill Now unavailable for customer with pending package expiration\n"
5771       : $@;
5772   }
5773 }
5774
5775 =item pending_invoice_count
5776
5777 Return number of cust_bill with pending=Y for this customer
5778
5779 =cut
5780
5781 sub pending_invoice_count {
5782   FS::cust_bill->count( 'custnum = '.shift->custnum."AND pending = 'Y'" );
5783 }
5784
5785 =item cust_locations_missing_district
5786
5787 Always returns empty list, unless tax_district_method eq 'wa_sales'
5788
5789 Return cust_location rows for this customer, associated with active
5790 customer packages, where tax district column is empty.  Presense of
5791 these rows should block billing, because invoice would be generated
5792 with incorrect taxes
5793
5794 =cut
5795
5796 sub cust_locations_missing_district {
5797   my ( $self ) = @_;
5798
5799   my $tax_district_method = FS::Conf->new->config('tax_district_method');
5800
5801   return ()
5802     unless $tax_district_method
5803         && $tax_district_method eq 'wa_sales';
5804
5805   qsearch({
5806     table => 'cust_location',
5807     select => 'cust_location.*',
5808     addl_from => '
5809       LEFT JOIN cust_main USING (custnum)
5810       LEFT JOIN cust_pkg ON cust_location.locationnum = cust_pkg.locationnum
5811     ',
5812     extra_sql => sprintf(q{
5813         WHERE cust_location.state = 'WA'
5814         AND   cust_location.custnum = %s
5815         AND (
5816              cust_location.district IS NULL
5817           or cust_location.district = ''
5818         )
5819         AND cust_pkg.pkgnum IS NOT NULL
5820         AND (
5821              cust_pkg.cancel > %s
5822           OR cust_pkg.cancel IS NULL
5823         )
5824       },
5825       $self->custnum, time()
5826     ),
5827   });
5828 }
5829
5830 #starting to take quite a while for big dbs
5831 #   (JRNL: journaled so it only happens once per database)
5832 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5833 # JRNL seq scan of cust_main on signupdate... index signupdate?  will that help?
5834 # JRNL seq scan of cust_main on paydate... index on substrings?  maybe set an
5835 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5836 # JRNL leading/trailing spaces in first, last, company
5837 # JRNL migrate to cust_payby
5838 # - otaker upgrade?  journal and call it good?  (double check to make sure
5839 #    we're not still setting otaker here)
5840 #
5841 #only going to get worse with new location stuff...
5842
5843 sub _upgrade_data { #class method
5844   my ($class, %opts) = @_;
5845
5846   my @statements = (
5847     'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5848   );
5849
5850   #this seems to be the only expensive one.. why does it take so long?
5851   unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5852     push @statements,
5853       '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';
5854     FS::upgrade_journal->set_done('cust_main__signupdate');
5855   }
5856
5857   unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5858
5859     # fix yyyy-m-dd formatted paydates
5860     if ( driver_name =~ /^mysql/i ) {
5861       push @statements,
5862       "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5863     } else { # the SQL standard
5864       push @statements,
5865       "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5866     }
5867     FS::upgrade_journal->set_done('cust_main__paydate');
5868   }
5869
5870   unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5871
5872     push @statements, #fix the weird BILL with a cc# in payinfo problem
5873       #DCRD to be safe
5874       "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5875
5876     FS::upgrade_journal->set_done('cust_main__payinfo');
5877
5878   }
5879
5880   my $t = time;
5881   foreach my $sql ( @statements ) {
5882     my $sth = dbh->prepare($sql) or die dbh->errstr;
5883     $sth->execute or die $sth->errstr;
5884     #warn ( (time - $t). " seconds\n" );
5885     #$t = time;
5886   }
5887
5888   local($ignore_expired_card) = 1;
5889   local($ignore_banned_card) = 1;
5890   local($skip_fuzzyfiles) = 1;
5891   local($import) = 1; #prevent automatic geocoding (need its own variable?)
5892
5893   unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5894
5895     #we don't want to decrypt them, just stuff them as-is into cust_payby
5896     local(@encrypted_fields) = ();
5897
5898     local($FS::cust_payby::ignore_expired_card) = 1;
5899     local($FS::cust_payby::ignore_banned_card)  = 1;
5900     local($FS::cust_payby::ignore_cardtype)     = 1;
5901
5902     my @payfields = qw( payby payinfo paycvv paymask
5903                         paydate paystart_month paystart_year payissue
5904                         payname paystate paytype payip
5905                       );
5906
5907     my $search = new FS::Cursor {
5908       'table'     => 'cust_main',
5909       'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5910     };
5911
5912     while (my $cust_main = $search->fetch) {
5913
5914       unless ( $cust_main->payby =~ /^(BILL|COMP)$/ ) {
5915
5916         my $cust_payby = new FS::cust_payby {
5917           'custnum' => $cust_main->custnum,
5918           'weight'  => 1,
5919           map { $_ => $cust_main->$_(); } @payfields
5920         };
5921
5922         my $error = $cust_payby->insert;
5923         die $error if $error;
5924
5925       }
5926
5927       # at the time we do this, also migrate paytype into cust_pay_batch
5928       # so that batches that are open before the migration can still be
5929       # processed
5930       if ( $cust_main->get('paytype') ) {
5931         my @cust_pay_batch = qsearch('cust_pay_batch', {
5932             'custnum' => $cust_main->custnum,
5933             'payby'   => 'CHEK',
5934             'paytype' => '',
5935         });
5936         foreach my $cust_pay_batch (@cust_pay_batch) {
5937           $cust_pay_batch->set('paytype', $cust_main->get('paytype'));
5938           my $error = $cust_pay_batch->replace;
5939           die "$error (setting cust_pay_batch.paytype)" if $error;
5940         }
5941       }
5942
5943       $cust_main->complimentary('Y') if $cust_main->payby eq 'COMP';
5944
5945       $cust_main->invoice_attn( $cust_main->payname )
5946         if $cust_main->payby eq 'BILL' && $cust_main->payname;
5947       $cust_main->po_number( $cust_main->payinfo )
5948         if $cust_main->payby eq 'BILL' && $cust_main->payinfo;
5949
5950       $cust_main->setfield($_, '') foreach @payfields;
5951       my $error = $cust_main->replace;
5952       die "Error upgradging payment information for custnum ".
5953           $cust_main->custnum. ": $error"
5954         if $error;
5955
5956     };
5957
5958     FS::upgrade_journal->set_done('cust_main__cust_payby');
5959   }
5960
5961   FS::cust_main::Location->_upgrade_data(%opts);
5962
5963   unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5964
5965     foreach my $cust_main ( qsearch({
5966       'table'     => 'cust_main',
5967       'hashref'   => {},
5968       'extra_sql' => 'WHERE '.
5969                        join(' OR ',
5970                          map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '%  %'",
5971                            qw( first last company )
5972                        ),
5973     }) ) {
5974       my $error = $cust_main->replace;
5975       die $error if $error;
5976     }
5977
5978     FS::upgrade_journal->set_done('cust_main__trimspaces');
5979
5980   }
5981
5982   $class->_upgrade_otaker(%opts);
5983
5984   # turn on encryption as part of regular upgrade, so all new records are immediately encrypted
5985   # existing records will be encrypted in queueable_upgrade (below)
5986   unless ($conf->exists('encryptionpublickey') || $conf->exists('encryptionprivatekey')) {
5987     eval "use FS::Setup";
5988     die $@ if $@;
5989     FS::Setup::enable_encryption();
5990   }
5991
5992 }
5993
5994 sub queueable_upgrade {
5995   my $class = shift;
5996
5997   ### encryption gets turned on in _upgrade_data, above
5998
5999   eval "use FS::upgrade_journal";
6000   die $@ if $@;
6001
6002   # prior to 2013 (commit f16665c9) payinfo was stored in history if not encrypted,
6003   # clear that out before encrypting/tokenizing anything else
6004   if (!FS::upgrade_journal->is_done('clear_payinfo_history')) {
6005     foreach my $table ('cust_payby','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') {
6006       my $sql = 'UPDATE h_'.$table.' SET payinfo = NULL WHERE payinfo IS NOT NULL';
6007       my $sth = dbh->prepare($sql) or die dbh->errstr;
6008       $sth->execute or die $sth->errstr;
6009     }
6010     FS::upgrade_journal->set_done('clear_payinfo_history');
6011   }
6012
6013   # fix Tokenized paycardtype and encrypt old records
6014   if (    ! FS::upgrade_journal->is_done('paycardtype_Tokenized')
6015        || ! FS::upgrade_journal->is_done('encryption_check')
6016      )
6017   {
6018
6019     # allow replacement of closed cust_pay/cust_refund records
6020     local $FS::payinfo_Mixin::allow_closed_replace = 1;
6021
6022     # because it looks like nothing's changing
6023     local $FS::Record::no_update_diff = 1;
6024
6025     # commit everything immediately
6026     local $FS::UID::AutoCommit = 1;
6027
6028     # encrypt what's there
6029     foreach my $table ('cust_payby','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') {
6030       my $tclass = 'FS::'.$table;
6031       my $lastrecnum = 0;
6032       my @recnums = ();
6033       while (my $recnum = _upgrade_next_recnum(dbh,$table,\$lastrecnum,\@recnums)) {
6034         my $record = $tclass->by_key($recnum);
6035         next unless $record; # small chance it's been deleted, that's ok
6036         next unless grep { $record->payby eq $_ } @FS::Record::encrypt_payby;
6037         # window for possible conflict is practically nonexistant,
6038         #   but just in case...
6039         $record = $record->select_for_update;
6040         if (!$record->custnum && $table eq 'cust_pay_pending') {
6041           $record->set('custnum_pending',1);
6042         }
6043         $record->paycardtype('') if $record->paycardtype eq 'Tokenized';
6044
6045         local($ignore_expired_card) = 1;
6046         local($ignore_banned_card) = 1;
6047         local($skip_fuzzyfiles) = 1;
6048         local($import) = 1;#prevent automatic geocoding (need its own variable?)
6049
6050         my $error = $record->replace;
6051         die "Error replacing $table ".$record->get($record->primary_key).": $error" if $error;
6052       }
6053     }
6054
6055     FS::upgrade_journal->set_done('paycardtype_Tokenized');
6056     FS::upgrade_journal->set_done('encryption_check') if $conf->exists('encryption');
6057   }
6058
6059   # now that everything's encrypted, tokenize...
6060   FS::cust_main::Billing_Realtime::token_check(@_);
6061 }
6062
6063 # not entirely false laziness w/ Billing_Realtime::_token_check_next_recnum
6064 # cust_payby might get deleted while this runs
6065 # not a method!
6066 sub _upgrade_next_recnum {
6067   my ($dbh,$table,$lastrecnum,$recnums) = @_;
6068   my $recnum = shift @$recnums;
6069   return $recnum if $recnum;
6070   my $tclass = 'FS::'.$table;
6071   my $paycardtypecheck = ($table ne 'cust_pay_pending') ? q( OR paycardtype = 'Tokenized') : '';
6072   my $sql = 'SELECT '.$tclass->primary_key.
6073             ' FROM '.$table.
6074             ' WHERE '.$tclass->primary_key.' > '.$$lastrecnum.
6075             "   AND payby IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
6076             "   AND ( length(payinfo) < 80$paycardtypecheck ) ".
6077             ' ORDER BY '.$tclass->primary_key.' LIMIT 500';
6078   my $sth = $dbh->prepare($sql) or die $dbh->errstr;
6079   $sth->execute() or die $sth->errstr;
6080   my @recnums;
6081   while (my $rec = $sth->fetchrow_hashref) {
6082     push @$recnums, $rec->{$tclass->primary_key};
6083   }
6084   $sth->finish();
6085   $$lastrecnum = $$recnums[-1];
6086   return shift @$recnums;
6087 }
6088
6089 =back
6090
6091 =head1 BUGS
6092
6093 The delete method.
6094
6095 The delete method should possibly take an FS::cust_main object reference
6096 instead of a scalar customer number.
6097
6098 Bill and collect options should probably be passed as references instead of a
6099 list.
6100
6101 There should probably be a configuration file with a list of allowed credit
6102 card types.
6103
6104 No multiple currency support (probably a larger project than just this module).
6105
6106 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
6107
6108 Birthdates rely on negative epoch values.
6109
6110 The payby for card/check batches is broken.  With mixed batching, bad
6111 things will happen.
6112
6113 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
6114
6115 =head1 SEE ALSO
6116
6117 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
6118 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
6119 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
6120
6121 =cut
6122
6123 1;