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