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