FS/FS/cust_main.pm

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