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