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