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 =cut
2572
2573 sub remove_cvv {
2574   my $self = shift;
2575   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2576     or return dbh->errstr;
2577   $sth->execute($self->custnum)
2578     or return $sth->errstr;
2579   $self->paycvv('');
2580   '';
2581 }
2582
2583 =item total_owed
2584
2585 Returns the total owed for this customer on all invoices
2586 (see L<FS::cust_bill/owed>).
2587
2588 =cut
2589
2590 sub total_owed {
2591   my $self = shift;
2592   $self->total_owed_date(2145859200); #12/31/2037
2593 }
2594
2595 =item total_owed_date TIME
2596
2597 Returns the total owed for this customer on all invoices with date earlier than
2598 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2599 see L<Time::Local> and L<Date::Parse> for conversion functions.
2600
2601 =cut
2602
2603 sub total_owed_date {
2604   my $self = shift;
2605   my $time = shift;
2606
2607   my $custnum = $self->custnum;
2608
2609   my $owed_sql = FS::cust_bill->owed_sql;
2610
2611   my $sql = "
2612     SELECT SUM($owed_sql) FROM cust_bill
2613       WHERE custnum = $custnum
2614         AND _date <= $time
2615   ";
2616
2617   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2618
2619 }
2620
2621 =item total_owed_pkgnum PKGNUM
2622
2623 Returns the total owed on all invoices for this customer's specific package
2624 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2625
2626 =cut
2627
2628 sub total_owed_pkgnum {
2629   my( $self, $pkgnum ) = @_;
2630   $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2631 }
2632
2633 =item total_owed_date_pkgnum TIME PKGNUM
2634
2635 Returns the total owed for this customer's specific package when using
2636 experimental package balances on all invoices with date earlier than
2637 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2638 see L<Time::Local> and L<Date::Parse> for conversion functions.
2639
2640 =cut
2641
2642 sub total_owed_date_pkgnum {
2643   my( $self, $time, $pkgnum ) = @_;
2644
2645   my $total_bill = 0;
2646   foreach my $cust_bill (
2647     grep { $_->_date <= $time }
2648       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2649   ) {
2650     $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2651   }
2652   sprintf( "%.2f", $total_bill );
2653
2654 }
2655
2656 =item total_paid
2657
2658 Returns the total amount of all payments.
2659
2660 =cut
2661
2662 sub total_paid {
2663   my $self = shift;
2664   my $total = 0;
2665   $total += $_->paid foreach $self->cust_pay;
2666   sprintf( "%.2f", $total );
2667 }
2668
2669 =item total_unapplied_credits
2670
2671 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2672 customer.  See L<FS::cust_credit/credited>.
2673
2674 =item total_credited
2675
2676 Old name for total_unapplied_credits.  Don't use.
2677
2678 =cut
2679
2680 sub total_credited {
2681   #carp "total_credited deprecated, use total_unapplied_credits";
2682   shift->total_unapplied_credits(@_);
2683 }
2684
2685 sub total_unapplied_credits {
2686   my $self = shift;
2687
2688   my $custnum = $self->custnum;
2689
2690   my $unapplied_sql = FS::cust_credit->unapplied_sql;
2691
2692   my $sql = "
2693     SELECT SUM($unapplied_sql) FROM cust_credit
2694       WHERE custnum = $custnum
2695   ";
2696
2697   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2698
2699 }
2700
2701 =item total_unapplied_credits_pkgnum PKGNUM
2702
2703 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2704 customer.  See L<FS::cust_credit/credited>.
2705
2706 =cut
2707
2708 sub total_unapplied_credits_pkgnum {
2709   my( $self, $pkgnum ) = @_;
2710   my $total_credit = 0;
2711   $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2712   sprintf( "%.2f", $total_credit );
2713 }
2714
2715
2716 =item total_unapplied_payments
2717
2718 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2719 See L<FS::cust_pay/unapplied>.
2720
2721 =cut
2722
2723 sub total_unapplied_payments {
2724   my $self = shift;
2725
2726   my $custnum = $self->custnum;
2727
2728   my $unapplied_sql = FS::cust_pay->unapplied_sql;
2729
2730   my $sql = "
2731     SELECT SUM($unapplied_sql) FROM cust_pay
2732       WHERE custnum = $custnum
2733   ";
2734
2735   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2736
2737 }
2738
2739 =item total_unapplied_payments_pkgnum PKGNUM
2740
2741 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2742 specific package when using experimental package balances.  See
2743 L<FS::cust_pay/unapplied>.
2744
2745 =cut
2746
2747 sub total_unapplied_payments_pkgnum {
2748   my( $self, $pkgnum ) = @_;
2749   my $total_unapplied = 0;
2750   $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2751   sprintf( "%.2f", $total_unapplied );
2752 }
2753
2754
2755 =item total_unapplied_refunds
2756
2757 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2758 customer.  See L<FS::cust_refund/unapplied>.
2759
2760 =cut
2761
2762 sub total_unapplied_refunds {
2763   my $self = shift;
2764   my $custnum = $self->custnum;
2765
2766   my $unapplied_sql = FS::cust_refund->unapplied_sql;
2767
2768   my $sql = "
2769     SELECT SUM($unapplied_sql) FROM cust_refund
2770       WHERE custnum = $custnum
2771   ";
2772
2773   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2774
2775 }
2776
2777 =item balance
2778
2779 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2780 total_unapplied_credits minus total_unapplied_payments).
2781
2782 =cut
2783
2784 sub balance {
2785   my $self = shift;
2786   $self->balance_date_range;
2787 }
2788
2789 =item balance_date TIME
2790
2791 Returns the balance for this customer, only considering invoices with date
2792 earlier than TIME (total_owed_date minus total_credited minus
2793 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
2794 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
2795 functions.
2796
2797 =cut
2798
2799 sub balance_date {
2800   my $self = shift;
2801   $self->balance_date_range(shift);
2802 }
2803
2804 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2805
2806 Returns the balance for this customer, optionally considering invoices with
2807 date earlier than START_TIME, and not later than END_TIME
2808 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2809
2810 Times are specified as SQL fragments or numeric
2811 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
2812 L<Date::Parse> for conversion functions.  The empty string can be passed
2813 to disable that time constraint completely.
2814
2815 Accepts the same options as L<balance_date_sql>:
2816
2817 =over 4
2818
2819 =item unapplied_date
2820
2821 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)
2822
2823 =item cutoff
2824
2825 An absolute cutoff time.  Payments, credits, and refunds I<applied> after this
2826 time will be ignored.  Note that START_TIME and END_TIME only limit the date
2827 range for invoices and I<unapplied> payments, credits, and refunds.
2828
2829 =back
2830
2831 =cut
2832
2833 sub balance_date_range {
2834   my $self = shift;
2835   my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2836             ') FROM cust_main WHERE custnum='. $self->custnum;
2837   sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2838 }
2839
2840 =item balance_pkgnum PKGNUM
2841
2842 Returns the balance for this customer's specific package when using
2843 experimental package balances (total_owed plus total_unrefunded, minus
2844 total_unapplied_credits minus total_unapplied_payments)
2845
2846 =cut
2847
2848 sub balance_pkgnum {
2849   my( $self, $pkgnum ) = @_;
2850
2851   sprintf( "%.2f",
2852       $self->total_owed_pkgnum($pkgnum)
2853 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2854 #    + $self->total_unapplied_refunds_pkgnum($pkgnum)
2855     - $self->total_unapplied_credits_pkgnum($pkgnum)
2856     - $self->total_unapplied_payments_pkgnum($pkgnum)
2857   );
2858 }
2859
2860 =item payment_info
2861
2862 Returns a hash of useful information for making a payment.
2863
2864 =over 4
2865
2866 =item balance
2867
2868 Current balance.
2869
2870 =item payby
2871
2872 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2873 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2874 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2875
2876 =back
2877
2878 For credit card transactions:
2879
2880 =over 4
2881
2882 =item card_type 1
2883
2884 =item payname
2885
2886 Exact name on card
2887
2888 =back
2889
2890 For electronic check transactions:
2891
2892 =over 4
2893
2894 =item stateid_state
2895
2896 =back
2897
2898 =cut
2899
2900 sub payment_info {
2901   my $self = shift;
2902
2903   my %return = ();
2904
2905   $return{balance} = $self->balance;
2906
2907   $return{payname} = $self->payname
2908                      || ( $self->first. ' '. $self->get('last') );
2909
2910   $return{$_} = $self->bill_location->$_
2911     for qw(address1 address2 city state zip);
2912
2913   $return{payby} = $self->payby;
2914   $return{stateid_state} = $self->stateid_state;
2915
2916   if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2917     $return{card_type} = cardtype($self->payinfo);
2918     $return{payinfo} = $self->paymask;
2919
2920     @return{'month', 'year'} = $self->paydate_monthyear;
2921
2922   }
2923
2924   if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2925     my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2926     $return{payinfo1} = $payinfo1;
2927     $return{payinfo2} = $payinfo2;
2928     $return{paytype}  = $self->paytype;
2929     $return{paystate} = $self->paystate;
2930
2931   }
2932
2933   #doubleclick protection
2934   my $_date = time;
2935   $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2936
2937   %return;
2938
2939 }
2940
2941 =item paydate_epoch
2942
2943 Returns the next payment expiration date for this customer. If they have no
2944 payment methods that will expire, returns 0.
2945
2946 =cut
2947
2948 sub paydate_epoch {
2949   my $self = shift;
2950   # filter out the ones that individually return 0, but then return 0 if
2951   # there are no results
2952   my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
2953   min( @epochs ) || 0;
2954 }
2955
2956 =item paydate_epoch_sql
2957
2958 Returns an SQL expression to get the next payment expiration date for a
2959 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
2960 dates, so that it's safe to test for "will it expire before date X" for any
2961 date up to then.
2962
2963 =cut
2964
2965 sub paydate_epoch_sql {
2966   my $class = shift;
2967   my $paydate = FS::cust_payby->paydate_epoch_sql;
2968   "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
2969 }
2970
2971 sub tax_exemption {
2972   my( $self, $taxname ) = @_;
2973
2974   qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2975                                      'taxname' => $taxname,
2976                                    },
2977           );
2978 }
2979
2980 =item cust_main_exemption
2981
2982 =item invoicing_list
2983
2984 Returns a list of email addresses (with svcnum entries expanded), and the word
2985 'POST' if the customer receives postal invoices.
2986
2987 =cut
2988
2989 sub invoicing_list {
2990   my( $self, $arrayref ) = @_;
2991
2992   if ( $arrayref ) {
2993     warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
2994   }
2995
2996   my @emails = $self->invoicing_list_emailonly;
2997   push @emails, 'POST' if $self->get('postal_invoice');
2998
2999   @emails;
3000 }
3001
3002 =item check_invoicing_list ARRAYREF
3003
3004 Checks these arguements as valid input for the invoicing_list method.  If there
3005 is an error, returns the error, otherwise returns false.
3006
3007 =cut
3008
3009 sub check_invoicing_list {
3010   my( $self, $arrayref ) = @_;
3011
3012   foreach my $address ( @$arrayref ) {
3013
3014     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3015       return 'Can\'t add FAX invoice destination with a blank FAX number.';
3016     }
3017
3018     my $cust_main_invoice = new FS::cust_main_invoice ( {
3019       'custnum' => $self->custnum,
3020       'dest'    => $address,
3021     } );
3022     my $error = $self->custnum
3023                 ? $cust_main_invoice->check
3024                 : $cust_main_invoice->checkdest
3025     ;
3026     return $error if $error;
3027
3028   }
3029
3030   return "Email address required"
3031     if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3032     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3033
3034   '';
3035 }
3036
3037 =item all_emails
3038
3039 Returns the email addresses of all accounts provisioned for this customer.
3040
3041 =cut
3042
3043 sub all_emails {
3044   my $self = shift;
3045   my %list;
3046   foreach my $cust_pkg ( $self->all_pkgs ) {
3047     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3048     my @svc_acct =
3049       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3050         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3051           @cust_svc;
3052     $list{$_}=1 foreach map { $_->email } @svc_acct;
3053   }
3054   keys %list;
3055 }
3056
3057 =item invoicing_list_addpost
3058
3059 Adds postal invoicing to this customer.  If this customer is already configured
3060 to receive postal invoices, does nothing.
3061
3062 =cut
3063
3064 sub invoicing_list_addpost {
3065   my $self = shift;
3066   if ( $self->get('postal_invoice') eq '' ) {
3067     $self->set('postal_invoice', 'Y');
3068     my $error = $self->replace;
3069     warn $error if $error; # should fail harder, but this is traditional
3070   }
3071 }
3072
3073 =item invoicing_list_emailonly
3074
3075 Returns the list of email invoice recipients (invoicing_list without non-email
3076 destinations such as POST and FAX).
3077
3078 =cut
3079
3080 sub invoicing_list_emailonly {
3081   my $self = shift;
3082   warn "$me invoicing_list_emailonly called"
3083     if $DEBUG;
3084   return () if !$self->custnum; # not yet inserted
3085   return map { $_->emailaddress }
3086     qsearch({
3087         table     => 'cust_contact',
3088         select    => 'emailaddress',
3089         addl_from => ' JOIN contact USING (contactnum) '.
3090                      ' JOIN contact_email USING (contactnum)',
3091         hashref   => { 'custnum' => $self->custnum, },
3092         extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
3093     });
3094 }
3095
3096 =item invoicing_list_emailonly_scalar
3097
3098 Returns the list of email invoice recipients (invoicing_list without non-email
3099 destinations such as POST and FAX) as a comma-separated scalar.
3100
3101 =cut
3102
3103 sub invoicing_list_emailonly_scalar {
3104   my $self = shift;
3105   warn "$me invoicing_list_emailonly_scalar called"
3106     if $DEBUG;
3107   join(', ', $self->invoicing_list_emailonly);
3108 }
3109
3110 =item contact_list [ CLASSNUM, ... ]
3111
3112 Returns a list of contacts (L<FS::contact> objects) for the customer. If
3113 a list of contact classnums is given, returns only contacts in those
3114 classes. If the pseudo-classnum 'invoice' is given, returns contacts that
3115 are marked as invoice destinations. If '0' is given, also returns contacts
3116 with no class.
3117
3118 If no arguments are given, returns all contacts for the customer.
3119
3120 =cut
3121
3122 sub contact_list {
3123   my $self = shift;
3124   my $search = {
3125     table       => 'contact',
3126     select      => 'contact.*, cust_contact.invoice_dest',
3127     addl_from   => ' JOIN cust_contact USING (contactnum)',
3128     extra_sql   => ' WHERE cust_contact.custnum = '.$self->custnum,
3129   };
3130
3131   my @orwhere;
3132   my @classnums;
3133   foreach (@_) {
3134     if ( $_ eq 'invoice' ) {
3135       push @orwhere, 'cust_contact.invoice_dest = \'Y\'';
3136     } elsif ( $_ eq '0' ) {
3137       push @orwhere, 'cust_contact.classnum is null';
3138     } elsif ( /^\d+$/ ) {
3139       push @classnums, $_;
3140     } else {
3141       die "bad classnum argument '$_'";
3142     }
3143   }
3144
3145   if (@classnums) {
3146     push @orwhere, 'cust_contact.classnum IN ('.join(',', @classnums).')';
3147   }
3148   if (@orwhere) {
3149     $search->{extra_sql} .= ' AND (' .
3150                             join(' OR ', map "( $_ )", @orwhere) .
3151                             ')';
3152   }
3153
3154   qsearch($search);
3155 }
3156
3157 =item contact_list_email [ CLASSNUM, ... ]
3158
3159 Same as L</contact_list>, but returns email destinations instead of contact
3160 objects.
3161
3162 =cut
3163
3164 sub contact_list_email {
3165   my $self = shift;
3166   my @contacts = $self->contact_list(@_);
3167   my @emails;
3168   foreach my $contact (@contacts) {
3169     foreach my $contact_email ($contact->contact_email) {
3170       push @emails,
3171         $contact->firstlast . ' <' . $contact_email->emailaddress . '>';
3172     }
3173   }
3174   @emails;
3175 }
3176
3177 =item referral_custnum_cust_main
3178
3179 Returns the customer who referred this customer (or the empty string, if
3180 this customer was not referred).
3181
3182 Note the difference with referral_cust_main method: This method,
3183 referral_custnum_cust_main returns the single customer (if any) who referred
3184 this customer, while referral_cust_main returns an array of customers referred
3185 BY this customer.
3186
3187 =cut
3188
3189 sub referral_custnum_cust_main {
3190   my $self = shift;
3191   return '' unless $self->referral_custnum;
3192   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3193 }
3194
3195 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3196
3197 Returns an array of customers referred by this customer (referral_custnum set
3198 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
3199 customers referred by customers referred by this customer and so on, inclusive.
3200 The default behavior is DEPTH 1 (no recursion).
3201
3202 Note the difference with referral_custnum_cust_main method: This method,
3203 referral_cust_main, returns an array of customers referred BY this customer,
3204 while referral_custnum_cust_main returns the single customer (if any) who
3205 referred this customer.
3206
3207 =cut
3208
3209 sub referral_cust_main {
3210   my $self = shift;
3211   my $depth = @_ ? shift : 1;
3212   my $exclude = @_ ? shift : {};
3213
3214   my @cust_main =
3215     map { $exclude->{$_->custnum}++; $_; }
3216       grep { ! $exclude->{ $_->custnum } }
3217         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3218
3219   if ( $depth > 1 ) {
3220     push @cust_main,
3221       map { $_->referral_cust_main($depth-1, $exclude) }
3222         @cust_main;
3223   }
3224
3225   @cust_main;
3226 }
3227
3228 =item referral_cust_main_ncancelled
3229
3230 Same as referral_cust_main, except only returns customers with uncancelled
3231 packages.
3232
3233 =cut
3234
3235 sub referral_cust_main_ncancelled {
3236   my $self = shift;
3237   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3238 }
3239
3240 =item referral_cust_pkg [ DEPTH ]
3241
3242 Like referral_cust_main, except returns a flat list of all unsuspended (and
3243 uncancelled) packages for each customer.  The number of items in this list may
3244 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3245
3246 =cut
3247
3248 sub referral_cust_pkg {
3249   my $self = shift;
3250   my $depth = @_ ? shift : 1;
3251
3252   map { $_->unsuspended_pkgs }
3253     grep { $_->unsuspended_pkgs }
3254       $self->referral_cust_main($depth);
3255 }
3256
3257 =item referring_cust_main
3258
3259 Returns the single cust_main record for the customer who referred this customer
3260 (referral_custnum), or false.
3261
3262 =cut
3263
3264 sub referring_cust_main {
3265   my $self = shift;
3266   return '' unless $self->referral_custnum;
3267   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3268 }
3269
3270 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3271
3272 Applies a credit to this customer.  If there is an error, returns the error,
3273 otherwise returns false.
3274
3275 REASON can be a text string, an FS::reason object, or a scalar reference to
3276 a reasonnum.  If a text string, it will be automatically inserted as a new
3277 reason, and a 'reason_type' option must be passed to indicate the
3278 FS::reason_type for the new reason.
3279
3280 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3281 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3282 I<commission_pkgnum>.
3283
3284 Any other options are passed to FS::cust_credit::insert.
3285
3286 =cut
3287
3288 sub credit {
3289   my( $self, $amount, $reason, %options ) = @_;
3290
3291   my $cust_credit = new FS::cust_credit {
3292     'custnum' => $self->custnum,
3293     'amount'  => $amount,
3294   };
3295
3296   if ( ref($reason) ) {
3297
3298     if ( ref($reason) eq 'SCALAR' ) {
3299       $cust_credit->reasonnum( $$reason );
3300     } else {
3301       $cust_credit->reasonnum( $reason->reasonnum );
3302     }
3303
3304   } else {
3305     $cust_credit->set('reason', $reason)
3306   }
3307
3308   $cust_credit->$_( delete $options{$_} )
3309     foreach grep exists($options{$_}),
3310               qw( addlinfo eventnum ),
3311               map "commission_$_", qw( agentnum salesnum pkgnum );
3312
3313   $cust_credit->insert(%options);
3314
3315 }
3316
3317 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3318
3319 Creates a one-time charge for this customer.  If there is an error, returns
3320 the error, otherwise returns false.
3321
3322 New-style, with a hashref of options:
3323
3324   my $error = $cust_main->charge(
3325                                   {
3326                                     'amount'     => 54.32,
3327                                     'quantity'   => 1,
3328                                     'start_date' => str2time('7/4/2009'),
3329                                     'pkg'        => 'Description',
3330                                     'comment'    => 'Comment',
3331                                     'additional' => [], #extra invoice detail
3332                                     'classnum'   => 1,  #pkg_class
3333
3334                                     'setuptax'   => '', # or 'Y' for tax exempt
3335
3336                                     'locationnum'=> 1234, # optional
3337
3338                                     #internal taxation
3339                                     'taxclass'   => 'Tax class',
3340
3341                                     #vendor taxation
3342                                     'taxproduct' => 2,  #part_pkg_taxproduct
3343                                     'override'   => {}, #XXX describe
3344
3345                                     #will be filled in with the new object
3346                                     'cust_pkg_ref' => \$cust_pkg,
3347
3348                                     #generate an invoice immediately
3349                                     'bill_now' => 0,
3350                                     'invoice_terms' => '', #with these terms
3351                                   }
3352                                 );
3353
3354 Old-style:
3355
3356   my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3357
3358 =cut
3359
3360 #super false laziness w/quotation::charge
3361 sub charge {
3362   my $self = shift;
3363   my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3364   my ( $pkg, $comment, $additional );
3365   my ( $setuptax, $taxclass );   #internal taxes
3366   my ( $taxproduct, $override ); #vendor (CCH) taxes
3367   my $no_auto = '';
3368   my $separate_bill = '';
3369   my $cust_pkg_ref = '';
3370   my ( $bill_now, $invoice_terms ) = ( 0, '' );
3371   my $locationnum;
3372   if ( ref( $_[0] ) ) {
3373     $amount     = $_[0]->{amount};
3374     $setup_cost = $_[0]->{setup_cost};
3375     $quantity   = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3376     $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3377     $no_auto    = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3378     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3379     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
3380                                            : '$'. sprintf("%.2f",$amount);
3381     $setuptax   = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3382     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3383     $classnum   = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3384     $additional = $_[0]->{additional} || [];
3385     $taxproduct = $_[0]->{taxproductnum};
3386     $override   = { '' => $_[0]->{tax_override} };
3387     $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3388     $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3389     $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3390     $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3391     $separate_bill = $_[0]->{separate_bill} || '';
3392   } else { # yuck
3393     $amount     = shift;
3394     $setup_cost = '';
3395     $quantity   = 1;
3396     $start_date = '';
3397     $pkg        = @_ ? shift : 'One-time charge';
3398     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
3399     $setuptax   = '';
3400     $taxclass   = @_ ? shift : '';
3401     $additional = [];
3402   }
3403
3404   local $SIG{HUP} = 'IGNORE';
3405   local $SIG{INT} = 'IGNORE';
3406   local $SIG{QUIT} = 'IGNORE';
3407   local $SIG{TERM} = 'IGNORE';
3408   local $SIG{TSTP} = 'IGNORE';
3409   local $SIG{PIPE} = 'IGNORE';
3410
3411   my $oldAutoCommit = $FS::UID::AutoCommit;
3412   local $FS::UID::AutoCommit = 0;
3413   my $dbh = dbh;
3414
3415   my $part_pkg = new FS::part_pkg ( {
3416     'pkg'           => $pkg,
3417     'comment'       => $comment,
3418     'plan'          => 'flat',
3419     'freq'          => 0,
3420     'disabled'      => 'Y',
3421     'classnum'      => ( $classnum ? $classnum : '' ),
3422     'setuptax'      => $setuptax,
3423     'taxclass'      => $taxclass,
3424     'taxproductnum' => $taxproduct,
3425     'setup_cost'    => $setup_cost,
3426   } );
3427
3428   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3429                         ( 0 .. @$additional - 1 )
3430                   ),
3431                   'additional_count' => scalar(@$additional),
3432                   'setup_fee' => $amount,
3433                 );
3434
3435   my $error = $part_pkg->insert( options       => \%options,
3436                                  tax_overrides => $override,
3437                                );
3438   if ( $error ) {
3439     $dbh->rollback if $oldAutoCommit;
3440     return $error;
3441   }
3442
3443   my $pkgpart = $part_pkg->pkgpart;
3444   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3445   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3446     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3447     $error = $type_pkgs->insert;
3448     if ( $error ) {
3449       $dbh->rollback if $oldAutoCommit;
3450       return $error;
3451     }
3452   }
3453
3454   my $cust_pkg = new FS::cust_pkg ( {
3455     'custnum'    => $self->custnum,
3456     'pkgpart'    => $pkgpart,
3457     'quantity'   => $quantity,
3458     'start_date' => $start_date,
3459     'no_auto'    => $no_auto,
3460     'separate_bill' => $separate_bill,
3461     'locationnum'=> $locationnum,
3462   } );
3463
3464   $error = $cust_pkg->insert;
3465   if ( $error ) {
3466     $dbh->rollback if $oldAutoCommit;
3467     return $error;
3468   } elsif ( $cust_pkg_ref ) {
3469     ${$cust_pkg_ref} = $cust_pkg;
3470   }
3471
3472   if ( $bill_now ) {
3473     my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3474                              'pkg_list'      => [ $cust_pkg ],
3475                            );
3476     if ( $error ) {
3477       $dbh->rollback if $oldAutoCommit;
3478       return $error;
3479     }
3480   }
3481
3482   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3483   return '';
3484
3485 }
3486
3487 #=item charge_postal_fee
3488 #
3489 #Applies a one time charge this customer.  If there is an error,
3490 #returns the error, returns the cust_pkg charge object or false
3491 #if there was no charge.
3492 #
3493 #=cut
3494 #
3495 # This should be a customer event.  For that to work requires that bill
3496 # also be a customer event.
3497
3498 sub charge_postal_fee {
3499   my $self = shift;
3500
3501   my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3502   return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3503
3504   my $cust_pkg = new FS::cust_pkg ( {
3505     'custnum'  => $self->custnum,
3506     'pkgpart'  => $pkgpart,
3507     'quantity' => 1,
3508   } );
3509
3510   my $error = $cust_pkg->insert;
3511   $error ? $error : $cust_pkg;
3512 }
3513
3514 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3515
3516 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3517
3518 Optionally, a list or hashref of additional arguments to the qsearch call can
3519 be passed.
3520
3521 =cut
3522
3523 sub cust_bill {
3524   my $self = shift;
3525   my $opt = ref($_[0]) ? shift : { @_ };
3526
3527   #return $self->num_cust_bill unless wantarray || keys %$opt;
3528
3529   $opt->{'table'} = 'cust_bill';
3530   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3531   $opt->{'hashref'}{'custnum'} = $self->custnum;
3532   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3533
3534   map { $_ } #behavior of sort undefined in scalar context
3535     sort { $a->_date <=> $b->_date }
3536       qsearch($opt);
3537 }
3538
3539 =item open_cust_bill
3540
3541 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3542 customer.
3543
3544 =cut
3545
3546 sub open_cust_bill {
3547   my $self = shift;
3548
3549   $self->cust_bill(
3550     'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3551     #@_
3552   );
3553
3554 }
3555
3556 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3557
3558 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3559
3560 =cut
3561
3562 sub legacy_cust_bill {
3563   my $self = shift;
3564
3565   #return $self->num_legacy_cust_bill unless wantarray;
3566
3567   map { $_ } #behavior of sort undefined in scalar context
3568     sort { $a->_date <=> $b->_date }
3569       qsearch({ 'table'    => 'legacy_cust_bill',
3570                 'hashref'  => { 'custnum' => $self->custnum, },
3571                 'order_by' => 'ORDER BY _date ASC',
3572              });
3573 }
3574
3575 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3576
3577 Returns all the statements (see L<FS::cust_statement>) for this customer.
3578
3579 Optionally, a list or hashref of additional arguments to the qsearch call can
3580 be passed.
3581
3582 =cut
3583
3584 =item cust_bill_void
3585
3586 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3587
3588 =cut
3589
3590 sub cust_bill_void {
3591   my $self = shift;
3592
3593   map { $_ } #return $self->num_cust_bill_void unless wantarray;
3594   sort { $a->_date <=> $b->_date }
3595     qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3596 }
3597
3598 sub cust_statement {
3599   my $self = shift;
3600   my $opt = ref($_[0]) ? shift : { @_ };
3601
3602   #return $self->num_cust_statement unless wantarray || keys %$opt;
3603
3604   $opt->{'table'} = 'cust_statement';
3605   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3606   $opt->{'hashref'}{'custnum'} = $self->custnum;
3607   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3608
3609   map { $_ } #behavior of sort undefined in scalar context
3610     sort { $a->_date <=> $b->_date }
3611       qsearch($opt);
3612 }
3613
3614 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3615
3616 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3617
3618 Optionally, a list or hashref of additional arguments to the qsearch call can
3619 be passed following the SVCDB.
3620
3621 =cut
3622
3623 sub svc_x {
3624   my $self = shift;
3625   my $svcdb = shift;
3626   if ( ! $svcdb =~ /^svc_\w+$/ ) {
3627     warn "$me svc_x requires a svcdb";
3628     return;
3629   }
3630   my $opt = ref($_[0]) ? shift : { @_ };
3631
3632   $opt->{'table'} = $svcdb;
3633   $opt->{'addl_from'} =
3634     'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3635     ($opt->{'addl_from'} || '');
3636
3637   my $custnum = $self->custnum;
3638   $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3639   my $where = "cust_pkg.custnum = $custnum";
3640
3641   my $extra_sql = $opt->{'extra_sql'} || '';
3642   if ( keys %{ $opt->{'hashref'} } ) {
3643     $extra_sql = " AND $where $extra_sql";
3644   }
3645   else {
3646     if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3647       $extra_sql = "WHERE $where AND $1";
3648     }
3649     else {
3650       $extra_sql = "WHERE $where $extra_sql";
3651     }
3652   }
3653   $opt->{'extra_sql'} = $extra_sql;
3654
3655   qsearch($opt);
3656 }
3657
3658 # required for use as an eventtable;
3659 sub svc_acct {
3660   my $self = shift;
3661   $self->svc_x('svc_acct', @_);
3662 }
3663
3664 =item cust_credit
3665
3666 Returns all the credits (see L<FS::cust_credit>) for this customer.
3667
3668 =cut
3669
3670 sub cust_credit {
3671   my $self = shift;
3672
3673   #return $self->num_cust_credit unless wantarray;
3674
3675   map { $_ } #behavior of sort undefined in scalar context
3676     sort { $a->_date <=> $b->_date }
3677       qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3678 }
3679
3680 =item cust_credit_pkgnum
3681
3682 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3683 package when using experimental package balances.
3684
3685 =cut
3686
3687 sub cust_credit_pkgnum {
3688   my( $self, $pkgnum ) = @_;
3689   map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3690   sort { $a->_date <=> $b->_date }
3691     qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3692                               'pkgnum'  => $pkgnum,
3693                             }
3694     );
3695 }
3696
3697 =item cust_credit_void
3698
3699 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3700
3701 =cut
3702
3703 sub cust_credit_void {
3704   my $self = shift;
3705   map { $_ }
3706   sort { $a->_date <=> $b->_date }
3707     qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3708 }
3709
3710 =item cust_pay
3711
3712 Returns all the payments (see L<FS::cust_pay>) for this customer.
3713
3714 =cut
3715
3716 sub cust_pay {
3717   my $self = shift;
3718   my $opt = ref($_[0]) ? shift : { @_ };
3719
3720   return $self->num_cust_pay unless wantarray || keys %$opt;
3721
3722   $opt->{'table'} = 'cust_pay';
3723   $opt->{'hashref'}{'custnum'} = $self->custnum;
3724
3725   map { $_ } #behavior of sort undefined in scalar context
3726     sort { $a->_date <=> $b->_date }
3727       qsearch($opt);
3728
3729 }
3730
3731 =item num_cust_pay
3732
3733 Returns the number of payments (see L<FS::cust_pay>) for this customer.  Also
3734 called automatically when the cust_pay method is used in a scalar context.
3735
3736 =cut
3737
3738 sub num_cust_pay {
3739   my $self = shift;
3740   my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3741   my $sth = dbh->prepare($sql) or die dbh->errstr;
3742   $sth->execute($self->custnum) or die $sth->errstr;
3743   $sth->fetchrow_arrayref->[0];
3744 }
3745
3746 =item unapplied_cust_pay
3747
3748 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3749
3750 =cut
3751
3752 sub unapplied_cust_pay {
3753   my $self = shift;
3754
3755   $self->cust_pay(
3756     'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3757     #@_
3758   );
3759
3760 }
3761
3762 =item cust_pay_pkgnum
3763
3764 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3765 package when using experimental package balances.
3766
3767 =cut
3768
3769 sub cust_pay_pkgnum {
3770   my( $self, $pkgnum ) = @_;
3771   map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3772   sort { $a->_date <=> $b->_date }
3773     qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3774                            'pkgnum'  => $pkgnum,
3775                          }
3776     );
3777 }
3778
3779 =item cust_pay_void
3780
3781 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3782
3783 =cut
3784
3785 sub cust_pay_void {
3786   my $self = shift;
3787   map { $_ } #return $self->num_cust_pay_void unless wantarray;
3788   sort { $a->_date <=> $b->_date }
3789     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3790 }
3791
3792 =item cust_pay_pending
3793
3794 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3795 (without status "done").
3796
3797 =cut
3798
3799 sub cust_pay_pending {
3800   my $self = shift;
3801   return $self->num_cust_pay_pending unless wantarray;
3802   sort { $a->_date <=> $b->_date }
3803     qsearch( 'cust_pay_pending', {
3804                                    'custnum' => $self->custnum,
3805                                    'status'  => { op=>'!=', value=>'done' },
3806                                  },
3807            );
3808 }
3809
3810 =item cust_pay_pending_attempt
3811
3812 Returns all payment attempts / declined payments for this customer, as pending
3813 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3814 a corresponding payment (see L<FS::cust_pay>).
3815
3816 =cut
3817
3818 sub cust_pay_pending_attempt {
3819   my $self = shift;
3820   return $self->num_cust_pay_pending_attempt unless wantarray;
3821   sort { $a->_date <=> $b->_date }
3822     qsearch( 'cust_pay_pending', {
3823                                    'custnum' => $self->custnum,
3824                                    'status'  => 'done',
3825                                    'paynum'  => '',
3826                                  },
3827            );
3828 }
3829
3830 =item num_cust_pay_pending
3831
3832 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3833 customer (without status "done").  Also called automatically when the
3834 cust_pay_pending method is used in a scalar context.
3835
3836 =cut
3837
3838 sub num_cust_pay_pending {
3839   my $self = shift;
3840   $self->scalar_sql(
3841     " SELECT COUNT(*) FROM cust_pay_pending ".
3842       " WHERE custnum = ? AND status != 'done' ",
3843     $self->custnum
3844   );
3845 }
3846
3847 =item num_cust_pay_pending_attempt
3848
3849 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3850 customer, with status "done" but without a corresp.  Also called automatically when the
3851 cust_pay_pending method is used in a scalar context.
3852
3853 =cut
3854
3855 sub num_cust_pay_pending_attempt {
3856   my $self = shift;
3857   $self->scalar_sql(
3858     " SELECT COUNT(*) FROM cust_pay_pending ".
3859       " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3860     $self->custnum
3861   );
3862 }
3863
3864 =item cust_refund
3865
3866 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3867
3868 =cut
3869
3870 sub cust_refund {
3871   my $self = shift;
3872   map { $_ } #return $self->num_cust_refund unless wantarray;
3873   sort { $a->_date <=> $b->_date }
3874     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3875 }
3876
3877 =item display_custnum
3878
3879 Returns the displayed customer number for this customer: agent_custid if
3880 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3881
3882 =cut
3883
3884 sub display_custnum {
3885   my $self = shift;
3886
3887   return $self->agent_custid
3888     if $default_agent_custid && $self->agent_custid;
3889
3890   my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3891
3892   if ( $prefix ) {
3893     return $prefix .
3894            sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
3895   } elsif ( $custnum_display_length ) {
3896     return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
3897   } else {
3898     return $self->custnum;
3899   }
3900 }
3901
3902 =item name
3903
3904 Returns a name string for this customer, either "Company (Last, First)" or
3905 "Last, First".
3906
3907 =cut
3908
3909 sub name {
3910   my $self = shift;
3911   my $name = $self->contact;
3912   $name = $self->company. " ($name)" if $self->company;
3913   $name;
3914 }
3915
3916 =item service_contact
3917
3918 Returns the L<FS::contact> object for this customer that has the 'Service'
3919 contact class, or undef if there is no such contact.  Deprecated; don't use
3920 this in new code.
3921
3922 =cut
3923
3924 sub service_contact {
3925   my $self = shift;
3926   if ( !exists($self->{service_contact}) ) {
3927     my $classnum = $self->scalar_sql(
3928       'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3929     ) || 0; #if it's zero, qsearchs will return nothing
3930     my $cust_contact = qsearchs('cust_contact', {
3931         'classnum' => $classnum,
3932         'custnum'  => $self->custnum,
3933     });
3934     $self->{service_contact} = $cust_contact->contact if $cust_contact;
3935   }
3936   $self->{service_contact};
3937 }
3938
3939 =item ship_name
3940
3941 Returns a name string for this (service/shipping) contact, either
3942 "Company (Last, First)" or "Last, First".
3943
3944 =cut
3945
3946 sub ship_name {
3947   my $self = shift;
3948
3949   my $name = $self->ship_contact;
3950   $name = $self->company. " ($name)" if $self->company;
3951   $name;
3952 }
3953
3954 =item name_short
3955
3956 Returns a name string for this customer, either "Company" or "First Last".
3957
3958 =cut
3959
3960 sub name_short {
3961   my $self = shift;
3962   $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3963 }
3964
3965 =item ship_name_short
3966
3967 Returns a name string for this (service/shipping) contact, either "Company"
3968 or "First Last".
3969
3970 =cut
3971
3972 sub ship_name_short {
3973   my $self = shift;
3974   $self->service_contact
3975     ? $self->ship_contact_firstlast
3976     : $self->name_short
3977 }
3978
3979 =item contact
3980
3981 Returns this customer's full (billing) contact name only, "Last, First"
3982
3983 =cut
3984
3985 sub contact {
3986   my $self = shift;
3987   $self->get('last'). ', '. $self->first;
3988 }
3989
3990 =item ship_contact
3991
3992 Returns this customer's full (shipping) contact name only, "Last, First"
3993
3994 =cut
3995
3996 sub ship_contact {
3997   my $self = shift;
3998   my $contact = $self->service_contact || $self;
3999   $contact->get('last') . ', ' . $contact->get('first');
4000 }
4001
4002 =item contact_firstlast
4003
4004 Returns this customers full (billing) contact name only, "First Last".
4005
4006 =cut
4007
4008 sub contact_firstlast {
4009   my $self = shift;
4010   $self->first. ' '. $self->get('last');
4011 }
4012
4013 =item ship_contact_firstlast
4014
4015 Returns this customer's full (shipping) contact name only, "First Last".
4016
4017 =cut
4018
4019 sub ship_contact_firstlast {
4020   my $self = shift;
4021   my $contact = $self->service_contact || $self;
4022   $contact->get('first') . ' '. $contact->get('last');
4023 }
4024
4025 sub bill_country_full {
4026   my $self = shift;
4027   $self->bill_location->country_full;
4028 }
4029
4030 sub ship_country_full {
4031   my $self = shift;
4032   $self->ship_location->country_full;
4033 }
4034
4035 =item county_state_county [ PREFIX ]
4036
4037 Returns a string consisting of just the county, state and country.
4038
4039 =cut
4040
4041 sub county_state_country {
4042   my $self = shift;
4043   my $locationnum;
4044   if ( @_ && $_[0] && $self->has_ship_address ) {
4045     $locationnum = $self->ship_locationnum;
4046   } else {
4047     $locationnum = $self->bill_locationnum;
4048   }
4049   my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4050   $cust_location->county_state_country;
4051 }
4052
4053 =item geocode DATA_VENDOR
4054
4055 Returns a value for the customer location as encoded by DATA_VENDOR.
4056 Currently this only makes sense for "CCH" as DATA_VENDOR.
4057
4058 =cut
4059
4060 =item cust_status
4061
4062 =item status
4063
4064 Returns a status string for this customer, currently:
4065
4066 =over 4
4067
4068 =item prospect
4069
4070 No packages have ever been ordered.  Displayed as "No packages".
4071
4072 =item ordered
4073
4074 Recurring packages all are new (not yet billed).
4075
4076 =item active
4077
4078 One or more recurring packages is active.
4079
4080 =item inactive
4081
4082 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
4083
4084 =item suspended
4085
4086 All non-cancelled recurring packages are suspended.
4087
4088 =item cancelled
4089
4090 All recurring packages are cancelled.
4091
4092 =back
4093
4094 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4095 cust_main-status_module configuration option.
4096
4097 =cut
4098
4099 sub status { shift->cust_status(@_); }
4100
4101 sub cust_status {
4102   my $self = shift;
4103   return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4104   for my $status ( FS::cust_main->statuses() ) {
4105     my $method = $status.'_sql';
4106     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4107     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4108     $sth->execute( ($self->custnum) x $numnum )
4109       or die "Error executing 'SELECT $sql': ". $sth->errstr;
4110     if ( $sth->fetchrow_arrayref->[0] ) {
4111       $self->hashref->{cust_status} = $status;
4112       return $status;
4113     }
4114   }
4115 }
4116
4117 =item is_status_delay_cancel
4118
4119 Returns true if customer status is 'suspended'
4120 and all suspended cust_pkg return true for
4121 cust_pkg->is_status_delay_cancel.
4122
4123 This is not a real status, this only meant for hacking display
4124 values, because otherwise treating the customer as suspended is
4125 really the whole point of the delay_cancel option.
4126
4127 =cut
4128
4129 sub is_status_delay_cancel {
4130   my ($self) = @_;
4131   return 0 unless $self->status eq 'suspended';
4132   foreach my $cust_pkg ($self->ncancelled_pkgs) {
4133     return 0 unless $cust_pkg->is_status_delay_cancel;
4134   }
4135   return 1;
4136 }
4137
4138 =item ucfirst_cust_status
4139
4140 =item ucfirst_status
4141
4142 Deprecated, use the cust_status_label method instead.
4143
4144 Returns the status with the first character capitalized.
4145
4146 =cut
4147
4148 sub ucfirst_status {
4149   carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4150   local($ucfirst_nowarn) = 1;
4151   shift->ucfirst_cust_status(@_);
4152 }
4153
4154 sub ucfirst_cust_status {
4155   carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4156   my $self = shift;
4157   ucfirst($self->cust_status);
4158 }
4159
4160 =item cust_status_label
4161
4162 =item status_label
4163
4164 Returns the display label for this status.
4165
4166 =cut
4167
4168 sub status_label { shift->cust_status_label(@_); }
4169
4170 sub cust_status_label {
4171   my $self = shift;
4172   __PACKAGE__->statuslabels->{$self->cust_status};
4173 }
4174
4175 =item statuscolor
4176
4177 Returns a hex triplet color string for this customer's status.
4178
4179 =cut
4180
4181 sub statuscolor { shift->cust_statuscolor(@_); }
4182
4183 sub cust_statuscolor {
4184   my $self = shift;
4185   __PACKAGE__->statuscolors->{$self->cust_status};
4186 }
4187
4188 =item tickets [ STATUS ]
4189
4190 Returns an array of hashes representing the customer's RT tickets.
4191
4192 An optional status (or arrayref or hashref of statuses) may be specified.
4193
4194 =cut
4195
4196 sub tickets {
4197   my $self = shift;
4198   my $status = ( @_ && $_[0] ) ? shift : '';
4199
4200   my $num = $conf->config('cust_main-max_tickets') || 10;
4201   my @tickets = ();
4202
4203   if ( $conf->config('ticket_system') ) {
4204     unless ( $conf->config('ticket_system-custom_priority_field') ) {
4205
4206       @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4207                                                         $num,
4208                                                         undef,
4209                                                         $status,
4210                                                       )
4211                   };
4212
4213     } else {
4214
4215       foreach my $priority (
4216         $conf->config('ticket_system-custom_priority_field-values'), ''
4217       ) {
4218         last if scalar(@tickets) >= $num;
4219         push @tickets,
4220           @{ FS::TicketSystem->customer_tickets( $self->custnum,
4221                                                  $num - scalar(@tickets),
4222                                                  $priority,
4223                                                  $status,
4224                                                )
4225            };
4226       }
4227     }
4228   }
4229   (@tickets);
4230 }
4231
4232 =item appointments [ STATUS ]
4233
4234 Returns an array of hashes representing the customer's RT tickets which
4235 are appointments.
4236
4237 =cut
4238
4239 sub appointments {
4240   my $self = shift;
4241   my $status = ( @_ && $_[0] ) ? shift : '';
4242
4243   return () unless $conf->config('ticket_system');
4244
4245   my $queueid = $conf->config('ticket_system-appointment-queueid');
4246
4247   @{ FS::TicketSystem->customer_tickets( $self->custnum,
4248                                          99,
4249                                          undef,
4250                                          $status,
4251                                          $queueid,
4252                                        )
4253   };
4254 }
4255
4256 # Return services representing svc_accts in customer support packages
4257 sub support_services {
4258   my $self = shift;
4259   my %packages = map { $_ => 1 } $conf->config('support_packages');
4260
4261   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4262     grep { $_->part_svc->svcdb eq 'svc_acct' }
4263     map { $_->cust_svc }
4264     grep { exists $packages{ $_->pkgpart } }
4265     $self->ncancelled_pkgs;
4266
4267 }
4268
4269 # Return a list of latitude/longitude for one of the services (if any)
4270 sub service_coordinates {
4271   my $self = shift;
4272
4273   my @svc_X =
4274     grep { $_->latitude && $_->longitude }
4275     map { $_->svc_x }
4276     map { $_->cust_svc }
4277     $self->ncancelled_pkgs;
4278
4279   scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4280 }
4281
4282 =item masked FIELD
4283
4284 Returns a masked version of the named field
4285
4286 =cut
4287
4288 sub masked {
4289 my ($self,$field) = @_;
4290
4291 # Show last four
4292
4293 'x'x(length($self->getfield($field))-4).
4294   substr($self->getfield($field), (length($self->getfield($field))-4));
4295
4296 }
4297
4298 =item payment_history
4299
4300 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4301 cust_credit and cust_refund objects.  Each hashref has the following fields:
4302
4303 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4304
4305 I<date> - value of _date field, unix timestamp
4306
4307 I<date_pretty> - user-friendly date
4308
4309 I<description> - user-friendly description of item
4310
4311 I<amount> - impact of item on user's balance
4312 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4313 Not to be confused with the native 'amount' field in cust_credit, see below.
4314
4315 I<amount_pretty> - includes money char
4316
4317 I<balance> - customer balance, chronologically as of this item
4318
4319 I<balance_pretty> - includes money char
4320
4321 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4322
4323 I<paid> - amount paid for cust_pay records, undef for other types
4324
4325 I<credit> - amount credited for cust_credit records, undef for other types.
4326 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4327
4328 I<refund> - amount refunded for cust_refund records, undef for other types
4329
4330 The four table-specific keys always have positive values, whether they reflect charges or payments.
4331
4332 The following options may be passed to this method:
4333
4334 I<line_items> - if true, returns charges ('Line item') rather than invoices
4335
4336 I<start_date> - unix timestamp, only include records on or after.
4337 If specified, an item of type 'Previous' will also be included.
4338 It does not have table-specific fields.
4339
4340 I<end_date> - unix timestamp, only include records before
4341
4342 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4343
4344 I<conf> - optional already-loaded FS::Conf object.
4345
4346 =cut
4347
4348 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4349 # and also for sending customer statements, which should both be kept customer-friendly.
4350 # If you add anything that shouldn't be passed on through the API or exposed
4351 # to customers, add a new option to include it, don't include it by default
4352 sub payment_history {
4353   my $self = shift;
4354   my $opt = ref($_[0]) ? $_[0] : { @_ };
4355
4356   my $conf = $$opt{'conf'} || new FS::Conf;
4357   my $money_char = $conf->config("money_char") || '$',
4358
4359   #first load entire history,
4360   #need previous to calculate previous balance
4361   #loading after end_date shouldn't hurt too much?
4362   my @history = ();
4363   if ( $$opt{'line_items'} ) {
4364
4365     foreach my $cust_bill ( $self->cust_bill ) {
4366
4367       push @history, {
4368         'type'        => 'Line item',
4369         'description' => $_->desc( $self->locale ).
4370                            ( $_->sdate && $_->edate
4371                                ? ' '. time2str('%d-%b-%Y', $_->sdate).
4372                                  ' To '. time2str('%d-%b-%Y', $_->edate)
4373                                : ''
4374                            ),
4375         'amount'      => sprintf('%.2f', $_->setup + $_->recur ),
4376         'charged'     => sprintf('%.2f', $_->setup + $_->recur ),
4377         'date'        => $cust_bill->_date,
4378         'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4379       }
4380         foreach $cust_bill->cust_bill_pkg;
4381
4382     }
4383
4384   } else {
4385
4386     push @history, {
4387                      'type'        => 'Invoice',
4388                      'description' => 'Invoice #'. $_->display_invnum,
4389                      'amount'      => sprintf('%.2f', $_->charged ),
4390                      'charged'     => sprintf('%.2f', $_->charged ),
4391                      'date'        => $_->_date,
4392                      'date_pretty' => $self->time2str_local('short', $_->_date ),
4393                    }
4394       foreach $self->cust_bill;
4395
4396   }
4397
4398   push @history, {
4399                    'type'        => 'Payment',
4400                    'description' => 'Payment', #XXX type
4401                    'amount'      => sprintf('%.2f', 0 - $_->paid ),
4402                    'paid'        => sprintf('%.2f', $_->paid ),
4403                    'date'        => $_->_date,
4404                    'date_pretty' => $self->time2str_local('short', $_->_date ),
4405                  }
4406     foreach $self->cust_pay;
4407
4408   push @history, {
4409                    'type'        => 'Credit',
4410                    'description' => 'Credit', #more info?
4411                    'amount'      => sprintf('%.2f', 0 -$_->amount ),
4412                    'credit'      => sprintf('%.2f', $_->amount ),
4413                    'date'        => $_->_date,
4414                    'date_pretty' => $self->time2str_local('short', $_->_date ),
4415                  }
4416     foreach $self->cust_credit;
4417
4418   push @history, {
4419                    'type'        => 'Refund',
4420                    'description' => 'Refund', #more info?  type, like payment?
4421                    'amount'      => $_->refund,
4422                    'refund'      => $_->refund,
4423                    'date'        => $_->_date,
4424                    'date_pretty' => $self->time2str_local('short', $_->_date ),
4425                  }
4426     foreach $self->cust_refund;
4427
4428   #put it all in chronological order
4429   @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4430
4431   #calculate balance, filter items outside date range
4432   my $previous = 0;
4433   my $balance = 0;
4434   my @out = ();
4435   foreach my $item (@history) {
4436     last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4437     $balance += $$item{'amount'};
4438     if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4439       $previous += $$item{'amount'};
4440       next;
4441     }
4442     $$item{'balance'} = sprintf("%.2f",$balance);
4443     foreach my $key ( qw(amount balance) ) {
4444       $$item{$key.'_pretty'} = money_pretty($$item{$key});
4445     }
4446     push(@out,$item);
4447   }
4448
4449   # start with previous balance, if there was one
4450   if ($previous) {
4451     my $item = {
4452       'type'        => 'Previous',
4453       'description' => 'Previous balance',
4454       'amount'      => sprintf("%.2f",$previous),
4455       'balance'     => sprintf("%.2f",$previous),
4456       'date'        => $$opt{'start_date'},
4457       'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4458     };
4459     #false laziness with above
4460     foreach my $key ( qw(amount balance) ) {
4461       $$item{$key.'_pretty'} = $$item{$key};
4462       $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4463     }
4464     unshift(@out,$item);
4465   }
4466
4467   @out = reverse @history if $$opt{'reverse_sort'};
4468
4469   return @out;
4470 }
4471
4472 =item save_cust_payby
4473
4474 Saves a new cust_payby for this customer, replacing an existing entry only
4475 in select circumstances.  Does not validate input.
4476
4477 If auto is specified, marks this as the customer's primary method, or the
4478 specified weight.  Existing payment methods have their weight incremented as
4479 appropriate.
4480
4481 If bill_location is specified with auto, also sets location in cust_main.
4482
4483 Will not insert complete duplicates of existing records, or records in which the
4484 only difference from an existing record is to turn off automatic payment (will
4485 return without error.)  Will replace existing records in which the only difference
4486 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4487 Fields marked as preserved are optional, and existing values will not be overwritten with
4488 blanks when replacing.
4489
4490 Accepts the following named parameters:
4491
4492 =over 4
4493
4494 =item payment_payby
4495
4496 either CARD or CHEK
4497
4498 =item auto
4499
4500 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4501
4502 =item weight
4503
4504 optional, set higher than 1 for secondary, etc.
4505
4506 =item payinfo
4507
4508 required
4509
4510 =item paymask
4511
4512 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4513
4514 =item payname
4515
4516 required
4517
4518 =item payip
4519
4520 optional, will be preserved when replacing
4521
4522 =item paydate
4523
4524 CARD only, required
4525
4526 =item bill_location
4527
4528 CARD only, required, FS::cust_location object
4529
4530 =item paystart_month
4531
4532 CARD only, optional, will be preserved when replacing
4533
4534 =item paystart_year
4535
4536 CARD only, optional, will be preserved when replacing
4537
4538 =item payissue
4539
4540 CARD only, optional, will be preserved when replacing
4541
4542 =item paycvv
4543
4544 CARD only, only used if conf cvv-save is set appropriately
4545
4546 =item paytype
4547
4548 CHEK only
4549
4550 =item paystate
4551
4552 CHEK only
4553
4554 =back
4555
4556 =cut
4557
4558 #The code for this option is in place, but it's not currently used
4559 #
4560 # =item replace
4561 #
4562 # existing cust_payby object to be replaced (must match custnum)
4563
4564 # stateid/stateid_state/ss are not currently supported in cust_payby,
4565 # might not even work properly in 4.x, but will need to work here if ever added
4566
4567 sub save_cust_payby {
4568   my $self = shift;
4569   my %opt = @_;
4570
4571   my $old = $opt{'replace'};
4572   my $new = new FS::cust_payby { $old ? $old->hash : () };
4573   return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4574   $new->set( 'custnum' => $self->custnum );
4575
4576   my $payby = $opt{'payment_payby'};
4577   return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4578
4579   # don't allow turning off auto when replacing
4580   $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4581
4582   my @check_existing; # payby relevant to this payment_payby
4583
4584   # set payby based on auto
4585   if ( $payby eq 'CARD' ) {
4586     $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4587     @check_existing = qw( CARD DCRD );
4588   } elsif ( $payby eq 'CHEK' ) {
4589     $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4590     @check_existing = qw( CHEK DCHK );
4591   }
4592
4593   $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4594
4595   # basic fields
4596   $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4597   $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4598   $new->set( 'payname' => $opt{'payname'} );
4599   $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4600
4601   my $conf = new FS::Conf;
4602
4603   # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4604   if ( $payby eq 'CARD' &&
4605        ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4606          || $conf->exists('business-onlinepayment-verification')
4607        )
4608   ) {
4609     $new->set( 'paycvv' => $opt{'paycvv'} );
4610   } else {
4611     $new->set( 'paycvv' => '');
4612   }
4613
4614   local $SIG{HUP} = 'IGNORE';
4615   local $SIG{INT} = 'IGNORE';
4616   local $SIG{QUIT} = 'IGNORE';
4617   local $SIG{TERM} = 'IGNORE';
4618   local $SIG{TSTP} = 'IGNORE';
4619   local $SIG{PIPE} = 'IGNORE';
4620
4621   my $oldAutoCommit = $FS::UID::AutoCommit;
4622   local $FS::UID::AutoCommit = 0;
4623   my $dbh = dbh;
4624
4625   # set fields specific to payment_payby
4626   if ( $payby eq 'CARD' ) {
4627     if ($opt{'bill_location'}) {
4628       $opt{'bill_location'}->set('custnum' => $self->custnum);
4629       my $error = $opt{'bill_location'}->find_or_insert;
4630       if ( $error ) {
4631         $dbh->rollback if $oldAutoCommit;
4632         return $error;
4633       }
4634       $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4635     }
4636     foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4637       $new->set( $field => $opt{$field} );
4638     }
4639   } else {
4640     foreach my $field ( qw(paytype paystate) ) {
4641       $new->set( $field => $opt{$field} );
4642     }
4643   }
4644
4645   # other cust_payby to compare this to
4646   my @existing = $self->cust_payby(@check_existing);
4647
4648   # fields that can overwrite blanks with values, but not values with blanks
4649   my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4650
4651   my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4652   unless ($old) {
4653     # generally, we don't want to overwrite existing cust_payby with this,
4654     # but we can replace if we're only marking it auto or adding a preserved field
4655     # and we can avoid saving a total duplicate or merely turning off auto
4656 PAYBYLOOP:
4657     foreach my $cust_payby (@existing) {
4658       # check fields that absolutely should not change
4659       foreach my $field ($new->fields) {
4660         next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4661         next if grep(/^$field$/, @preserve );
4662         next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4663       }
4664       # now check fields that can replace if one value is blank
4665       my $replace = 0;
4666       foreach my $field (@preserve) {
4667         if (
4668           ( $new->get($field) and !$cust_payby->get($field) ) or
4669           ( $cust_payby->get($field) and !$new->get($field) )
4670         ) {
4671           # prevention of overwriting values with blanks happens farther below
4672           $replace = 1;
4673         } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4674           next PAYBYLOOP;
4675         }
4676       }
4677       unless ( $replace ) {
4678         # nearly identical, now check weight
4679         if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4680           # ignore identical cust_payby, and ignore attempts to turn off auto
4681           # no need to save or re-weight cust_payby (but still need to update/commit $self)
4682           $skip_cust_payby = 1;
4683           last PAYBYLOOP;
4684         }
4685         # otherwise, only change is to mark this as primary
4686       }
4687       # if we got this far, we're definitely replacing
4688       $old = $cust_payby;
4689       last PAYBYLOOP;
4690     } #PAYBYLOOP
4691   }
4692
4693   if ($old) {
4694     $new->set( 'custpaybynum' => $old->custpaybynum );
4695     # don't turn off automatic payment (but allow it to be turned on)
4696     if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4697       $opt{'auto'} = 1;
4698       $new->set( 'payby' => $old->payby );
4699       $new->set( 'weight' => 1 );
4700     }
4701     # make sure we're not overwriting values with blanks
4702     foreach my $field (@preserve) {
4703       if ( $old->get($field) and !$new->get($field) ) {
4704         $new->set( $field => $old->get($field) );
4705       }
4706     }
4707   }
4708
4709   # only overwrite cust_main bill_location if auto
4710   if ($opt{'auto'} && $opt{'bill_location'}) {
4711     $self->set('bill_location' => $opt{'bill_location'});
4712     my $error = $self->replace;
4713     if ( $error ) {
4714       $dbh->rollback if $oldAutoCommit;
4715       return $error;
4716     }
4717   }
4718
4719   # done with everything except reweighting and saving cust_payby
4720   # still need to commit changes to cust_main and cust_location
4721   if ($skip_cust_payby) {
4722     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4723     return '';
4724   }
4725
4726   # re-weight existing primary cust_pay for this payby
4727   if ($opt{'auto'}) {
4728     foreach my $cust_payby (@existing) {
4729       # relies on cust_payby return order
4730       last unless $cust_payby->payby !~ /^D/;
4731       last if $cust_payby->weight > 1;
4732       next if $new->custpaybynum eq $cust_payby->custpaybynum;
4733       next if $cust_payby->weight < ($opt{'weight'} || 1);
4734       $cust_payby->weight( $cust_payby->weight + 1 );
4735       my $error = $cust_payby->replace;
4736       if ( $error ) {
4737         $dbh->rollback if $oldAutoCommit;
4738         return "Error reweighting cust_payby: $error";
4739       }
4740     }
4741   }
4742
4743   # finally, save cust_payby
4744   my $error = $old ? $new->replace($old) : $new->insert;
4745   if ( $error ) {
4746     $dbh->rollback if $oldAutoCommit;
4747     return $error;
4748   }
4749
4750   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4751   '';
4752
4753 }
4754
4755 =back
4756
4757 =head1 CLASS METHODS
4758
4759 =over 4
4760
4761 =item statuses
4762
4763 Class method that returns the list of possible status strings for customers
4764 (see L<the status method|/status>).  For example:
4765
4766   @statuses = FS::cust_main->statuses();
4767
4768 =cut
4769
4770 sub statuses {
4771   my $self = shift;
4772   keys %{ $self->statuscolors };
4773 }
4774
4775 =item cust_status_sql
4776
4777 Returns an SQL fragment to determine the status of a cust_main record, as a
4778 string.
4779
4780 =cut
4781
4782 sub cust_status_sql {
4783   my $sql = 'CASE';
4784   for my $status ( FS::cust_main->statuses() ) {
4785     my $method = $status.'_sql';
4786     $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4787   }
4788   $sql .= ' END';
4789   return $sql;
4790 }
4791
4792
4793 =item prospect_sql
4794
4795 Returns an SQL expression identifying prospective cust_main records (customers
4796 with no packages ever ordered)
4797
4798 =cut
4799
4800 use vars qw($select_count_pkgs);
4801 $select_count_pkgs =
4802   "SELECT COUNT(*) FROM cust_pkg
4803     WHERE cust_pkg.custnum = cust_main.custnum";
4804
4805 sub select_count_pkgs_sql {
4806   $select_count_pkgs;
4807 }
4808
4809 sub prospect_sql {
4810   " 0 = ( $select_count_pkgs ) ";
4811 }
4812
4813 =item ordered_sql
4814
4815 Returns an SQL expression identifying ordered cust_main records (customers with
4816 no active packages, but recurring packages not yet setup or one time charges
4817 not yet billed).
4818
4819 =cut
4820
4821 sub ordered_sql {
4822   FS::cust_main->none_active_sql.
4823   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4824 }
4825
4826 =item active_sql
4827
4828 Returns an SQL expression identifying active cust_main records (customers with
4829 active recurring packages).
4830
4831 =cut
4832
4833 sub active_sql {
4834   " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4835 }
4836
4837 =item none_active_sql
4838
4839 Returns an SQL expression identifying cust_main records with no active
4840 recurring packages.  This includes customers of status prospect, ordered,
4841 inactive, and suspended.
4842
4843 =cut
4844
4845 sub none_active_sql {
4846   " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4847 }
4848
4849 =item inactive_sql
4850
4851 Returns an SQL expression identifying inactive cust_main records (customers with
4852 no active recurring packages, but otherwise unsuspended/uncancelled).
4853
4854 =cut
4855
4856 sub inactive_sql {
4857   FS::cust_main->none_active_sql.
4858   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4859 }
4860
4861 =item susp_sql
4862 =item suspended_sql
4863
4864 Returns an SQL expression identifying suspended cust_main records.
4865
4866 =cut
4867
4868
4869 sub suspended_sql { susp_sql(@_); }
4870 sub susp_sql {
4871   FS::cust_main->none_active_sql.
4872   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4873 }
4874
4875 =item cancel_sql
4876 =item cancelled_sql
4877
4878 Returns an SQL expression identifying cancelled cust_main records.
4879
4880 =cut
4881
4882 sub cancel_sql { shift->cancelled_sql(@_); }
4883
4884 =item uncancel_sql
4885 =item uncancelled_sql
4886
4887 Returns an SQL expression identifying un-cancelled cust_main records.
4888
4889 =cut
4890
4891 sub uncancelled_sql { uncancel_sql(@_); }
4892 sub uncancel_sql { "
4893   ( 0 < ( $select_count_pkgs
4894                    AND ( cust_pkg.cancel IS NULL
4895                          OR cust_pkg.cancel = 0
4896                        )
4897         )
4898     OR 0 = ( $select_count_pkgs )
4899   )
4900 "; }
4901
4902 =item balance_sql
4903
4904 Returns an SQL fragment to retreive the balance.
4905
4906 =cut
4907
4908 sub balance_sql { "
4909     ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4910         WHERE cust_bill.custnum   = cust_main.custnum     )
4911   - ( SELECT COALESCE( SUM(paid),    0 ) FROM cust_pay
4912         WHERE cust_pay.custnum    = cust_main.custnum     )
4913   - ( SELECT COALESCE( SUM(amount),  0 ) FROM cust_credit
4914         WHERE cust_credit.custnum = cust_main.custnum     )
4915   + ( SELECT COALESCE( SUM(refund),  0 ) FROM cust_refund
4916         WHERE cust_refund.custnum = cust_main.custnum     )
4917 "; }
4918
4919 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4920
4921 Returns an SQL fragment to retreive the balance for this customer, optionally
4922 considering invoices with date earlier than START_TIME, and not
4923 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4924 total_unapplied_payments).
4925
4926 Times are specified as SQL fragments or numeric
4927 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
4928 L<Date::Parse> for conversion functions.  The empty string can be passed
4929 to disable that time constraint completely.
4930
4931 Available options are:
4932
4933 =over 4
4934
4935 =item unapplied_date
4936
4937 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)
4938
4939 =item total
4940
4941 (unused.  obsolete?)
4942 set to true to remove all customer comparison clauses, for totals
4943
4944 =item where
4945
4946 (unused.  obsolete?)
4947 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4948
4949 =item join
4950
4951 (unused.  obsolete?)
4952 JOIN clause (typically used with the total option)
4953
4954 =item cutoff
4955
4956 An absolute cutoff time.  Payments, credits, and refunds I<applied> after this
4957 time will be ignored.  Note that START_TIME and END_TIME only limit the date
4958 range for invoices and I<unapplied> payments, credits, and refunds.
4959
4960 =back
4961
4962 =cut
4963
4964 sub balance_date_sql {
4965   my( $class, $start, $end, %opt ) = @_;
4966
4967   my $cutoff = $opt{'cutoff'};
4968
4969   my $owed         = FS::cust_bill->owed_sql($cutoff);
4970   my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4971   my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4972   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
4973
4974   my $j = $opt{'join'} || '';
4975
4976   my $owed_wh   = $class->_money_table_where( 'cust_bill',   $start,$end,%opt );
4977   my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4978   my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4979   my $pay_wh    = $class->_money_table_where( 'cust_pay',    $start,$end,%opt );
4980
4981   "   ( SELECT COALESCE(SUM($owed),         0) FROM cust_bill   $j $owed_wh   )
4982     + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4983     - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4984     - ( SELECT COALESCE(SUM($unapp_pay),    0) FROM cust_pay    $j $pay_wh    )
4985   ";
4986
4987 }
4988
4989 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4990
4991 Returns an SQL fragment to retreive the total unapplied payments for this
4992 customer, only considering payments with date earlier than START_TIME, and
4993 optionally not later than END_TIME.
4994
4995 Times are specified as SQL fragments or numeric
4996 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
4997 L<Date::Parse> for conversion functions.  The empty string can be passed
4998 to disable that time constraint completely.
4999
5000 Available options are:
5001
5002 =cut
5003
5004 sub unapplied_payments_date_sql {
5005   my( $class, $start, $end, %opt ) = @_;
5006
5007   my $cutoff = $opt{'cutoff'};
5008
5009   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
5010
5011   my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
5012                                                           'unapplied_date'=>1 );
5013
5014   " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
5015 }
5016
5017 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5018
5019 Helper method for balance_date_sql; name (and usage) subject to change
5020 (suggestions welcome).
5021
5022 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5023 cust_refund, cust_credit or cust_pay).
5024
5025 If TABLE is "cust_bill" or the unapplied_date option is true, only
5026 considers records with date earlier than START_TIME, and optionally not
5027 later than END_TIME .
5028
5029 =cut
5030
5031 sub _money_table_where {
5032   my( $class, $table, $start, $end, %opt ) = @_;
5033
5034   my @where = ();
5035   push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5036   if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5037     push @where, "$table._date <= $start" if defined($start) && length($start);
5038     push @where, "$table._date >  $end"   if defined($end)   && length($end);
5039   }
5040   push @where, @{$opt{'where'}} if $opt{'where'};
5041   my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5042
5043   $where;
5044
5045 }
5046
5047 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
5048 use FS::cust_main::Search;
5049 sub search {
5050   my $class = shift;
5051   FS::cust_main::Search->search(@_);
5052 }
5053
5054 =back
5055
5056 =head1 SUBROUTINES
5057
5058 =over 4
5059
5060 #=item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5061
5062 #Deprecated.  Use event notification and message templates
5063 #(L<FS::msg_template>) instead.
5064
5065 #Sends a templated email notification to the customer (see L<Text::Template>).
5066
5067 #OPTIONS is a hash and may include
5068
5069 #I<from> - the email sender (default is invoice_from)
5070
5071 #I<to> - comma-separated scalar or arrayref of recipients
5072 #   (default is invoicing_list)
5073
5074 #I<subject> - The subject line of the sent email notification
5075 #   (default is "Notice from company_name")
5076
5077 #I<extra_fields> - a hashref of name/value pairs which will be substituted
5078 #   into the template
5079
5080 #The following variables are vavailable in the template.
5081
5082 #I<$first> - the customer first name
5083 #I<$last> - the customer last name
5084 #I<$company> - the customer company
5085 #I<$payby> - a description of the method of payment for the customer
5086 #            # would be nice to use FS::payby::shortname
5087 #I<$payinfo> - the account information used to collect for this customer
5088 #I<$expdate> - the expiration of the customer payment in seconds from epoch
5089
5090 #=cut
5091
5092 #sub notify {
5093 #  my ($self, $template, %options) = @_;
5094
5095 #  return unless $conf->exists($template);
5096
5097 #  my $from = $conf->invoice_from_full($self->agentnum)
5098 #    if $conf->exists('invoice_from', $self->agentnum);
5099 #  $from = $options{from} if exists($options{from});
5100
5101 #  my $to = join(',', $self->invoicing_list_emailonly);
5102 #  $to = $options{to} if exists($options{to});
5103 #
5104 #  my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
5105 #    if $conf->exists('company_name', $self->agentnum);
5106 #  $subject = $options{subject} if exists($options{subject});
5107
5108 #  my $notify_template = new Text::Template (TYPE => 'ARRAY',
5109 #                                            SOURCE => [ map "$_\n",
5110 #                                              $conf->config($template)]
5111 #                                           )
5112 #    or die "can't create new Text::Template object: Text::Template::ERROR";
5113 #  $notify_template->compile()
5114 #    or die "can't compile template: Text::Template::ERROR";
5115
5116 #  $FS::notify_template::_template::company_name =
5117 #    $conf->config('company_name', $self->agentnum);
5118 #  $FS::notify_template::_template::company_address =
5119 #    join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
5120
5121 #  my $paydate = $self->paydate || '2037-12-31';
5122 #  $FS::notify_template::_template::first = $self->first;
5123 #  $FS::notify_template::_template::last = $self->last;
5124 #  $FS::notify_template::_template::company = $self->company;
5125 #  $FS::notify_template::_template::payinfo = $self->mask_payinfo;
5126 #  my $payby = $self->payby;
5127 #  my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5128 #  my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5129
5130 #  #credit cards expire at the end of the month/year of their exp date
5131 #  if ($payby eq 'CARD' || $payby eq 'DCRD') {
5132 #    $FS::notify_template::_template::payby = 'credit card';
5133 #    ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5134 #    $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5135 #    $expire_time--;
5136 #  }elsif ($payby eq 'COMP') {
5137 #    $FS::notify_template::_template::payby = 'complimentary account';
5138 #  }else{
5139 #    $FS::notify_template::_template::payby = 'current method';
5140 #  }
5141 #  $FS::notify_template::_template::expdate = $expire_time;
5142
5143 #  for (keys %{$options{extra_fields}}){
5144 #    no strict "refs";
5145 #    ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5146 #  }
5147
5148 #  send_email(from => $from,
5149 #             to => $to,
5150 #             subject => $subject,
5151 #             body => $notify_template->fill_in( PACKAGE =>
5152 #                                                'FS::notify_template::_template'                                              ),
5153 #            );
5154
5155 #}
5156
5157 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5158
5159 Generates a templated notification to the customer (see L<Text::Template>).
5160
5161 OPTIONS is a hash and may include
5162
5163 I<extra_fields> - a hashref of name/value pairs which will be substituted
5164    into the template.  These values may override values mentioned below
5165    and those from the customer record.
5166
5167 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5168
5169 The following variables are available in the template instead of or in addition
5170 to the fields of the customer record.
5171
5172 I<$payby> - a description of the method of payment for the customer
5173             # would be nice to use FS::payby::shortname
5174 I<$payinfo> - the masked account information used to collect for this customer
5175 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5176 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5177
5178 =cut
5179
5180 # a lot like cust_bill::print_latex
5181 sub generate_letter {
5182   my ($self, $template, %options) = @_;
5183
5184   warn "Template $template does not exist" && return
5185     unless $conf->exists($template) || $options{'template_text'};
5186
5187   my $template_source = $options{'template_text'}
5188                         ? [ $options{'template_text'} ]
5189                         : [ map "$_\n", $conf->config($template) ];
5190
5191   my $letter_template = new Text::Template
5192                         ( TYPE       => 'ARRAY',
5193                           SOURCE     => $template_source,
5194                           DELIMITERS => [ '[@--', '--@]' ],
5195                         )
5196     or die "can't create new Text::Template object: Text::Template::ERROR";
5197
5198   $letter_template->compile()
5199     or die "can't compile template: Text::Template::ERROR";
5200
5201   my %letter_data = map { $_ => $self->$_ } $self->fields;
5202   $letter_data{payinfo} = $self->mask_payinfo;
5203
5204   #my $paydate = $self->paydate || '2037-12-31';
5205   my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
5206
5207   my $payby = $self->payby;
5208   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5209   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5210
5211   #credit cards expire at the end of the month/year of their exp date
5212   if ($payby eq 'CARD' || $payby eq 'DCRD') {
5213     $letter_data{payby} = 'credit card';
5214     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5215     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5216     $expire_time--;
5217   }elsif ($payby eq 'COMP') {
5218     $letter_data{payby} = 'complimentary account';
5219   }else{
5220     $letter_data{payby} = 'current method';
5221   }
5222   $letter_data{expdate} = $expire_time;
5223
5224   for (keys %{$options{extra_fields}}){
5225     $letter_data{$_} = $options{extra_fields}->{$_};
5226   }
5227
5228   unless(exists($letter_data{returnaddress})){
5229     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5230                                                   $self->agent_template)
5231                      );
5232     if ( length($retadd) ) {
5233       $letter_data{returnaddress} = $retadd;
5234     } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5235       $letter_data{returnaddress} =
5236         join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5237                           s/$/\\\\\*/;
5238                           $_;
5239                         }
5240                     ( $conf->config('company_name', $self->agentnum),
5241                       $conf->config('company_address', $self->agentnum),
5242                     )
5243         );
5244     } else {
5245       $letter_data{returnaddress} = '~';
5246     }
5247   }
5248
5249   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5250
5251   $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5252
5253   my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5254
5255   my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5256                            DIR      => $dir,
5257                            SUFFIX   => '.eps',
5258                            UNLINK   => 0,
5259                          ) or die "can't open temp file: $!\n";
5260   print $lh $conf->config_binary('logo.eps', $self->agentnum)
5261     or die "can't write temp file: $!\n";
5262   close $lh;
5263   $letter_data{'logo_file'} = $lh->filename;
5264
5265   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5266                            DIR      => $dir,
5267                            SUFFIX   => '.tex',
5268                            UNLINK   => 0,
5269                          ) or die "can't open temp file: $!\n";
5270
5271   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5272   close $fh;
5273   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5274   return ($1, $letter_data{'logo_file'});
5275
5276 }
5277
5278 =item print_ps TEMPLATE
5279
5280 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5281
5282 =cut
5283
5284 sub print_ps {
5285   my $self = shift;
5286   my($file, $lfile) = $self->generate_letter(@_);
5287   my $ps = FS::Misc::generate_ps($file);
5288   unlink($file.'.tex');
5289   unlink($lfile);
5290
5291   $ps;
5292 }
5293
5294 =item print TEMPLATE
5295
5296 Prints the filled in template.
5297
5298 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5299
5300 =cut
5301
5302 sub queueable_print {
5303   my %opt = @_;
5304
5305   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5306     or die "invalid customer number: " . $opt{custnum};
5307
5308 #do not backport this change to 3.x
5309 #  my $error = $self->print( { 'template' => $opt{template} } );
5310   my $error = $self->print( $opt{'template'} );
5311   die $error if $error;
5312 }
5313
5314 sub print {
5315   my ($self, $template) = (shift, shift);
5316   do_print(
5317     [ $self->print_ps($template) ],
5318     'agentnum' => $self->agentnum,
5319   );
5320 }
5321
5322 #these three subs should just go away once agent stuff is all config overrides
5323
5324 sub agent_template {
5325   my $self = shift;
5326   $self->_agent_plandata('agent_templatename');
5327 }
5328
5329 sub agent_invoice_from {
5330   my $self = shift;
5331   $self->_agent_plandata('agent_invoice_from');
5332 }
5333
5334 sub _agent_plandata {
5335   my( $self, $option ) = @_;
5336
5337   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
5338   #agent-specific Conf
5339
5340   use FS::part_event::Condition;
5341
5342   my $agentnum = $self->agentnum;
5343
5344   my $regexp = regexp_sql();
5345
5346   my $part_event_option =
5347     qsearchs({
5348       'select'    => 'part_event_option.*',
5349       'table'     => 'part_event_option',
5350       'addl_from' => q{
5351         LEFT JOIN part_event USING ( eventpart )
5352         LEFT JOIN part_event_option AS peo_agentnum
5353           ON ( part_event.eventpart = peo_agentnum.eventpart
5354                AND peo_agentnum.optionname = 'agentnum'
5355                AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5356              )
5357         LEFT JOIN part_event_condition
5358           ON ( part_event.eventpart = part_event_condition.eventpart
5359                AND part_event_condition.conditionname = 'cust_bill_age'
5360              )
5361         LEFT JOIN part_event_condition_option
5362           ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5363                AND part_event_condition_option.optionname = 'age'
5364              )
5365       },
5366       #'hashref'   => { 'optionname' => $option },
5367       #'hashref'   => { 'part_event_option.optionname' => $option },
5368       'extra_sql' =>
5369         " WHERE part_event_option.optionname = ". dbh->quote($option).
5370         " AND action = 'cust_bill_send_agent' ".
5371         " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5372         " AND peo_agentnum.optionname = 'agentnum' ".
5373         " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5374         " ORDER BY
5375            CASE WHEN part_event_condition_option.optionname IS NULL
5376            THEN -1
5377            ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5378         " END
5379           , part_event.weight".
5380         " LIMIT 1"
5381     });
5382
5383   unless ( $part_event_option ) {
5384     return $self->agent->invoice_template || ''
5385       if $option eq 'agent_templatename';
5386     return '';
5387   }
5388
5389   $part_event_option->optionvalue;
5390
5391 }
5392
5393 sub process_o2m_qsearch {
5394   my $self = shift;
5395   my $table = shift;
5396   return qsearch($table, @_) unless $table eq 'contact';
5397
5398   my $hashref = shift;
5399   my %hash = %$hashref;
5400   ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5401     or die 'guru meditation #4343';
5402
5403   qsearch({ 'table'     => 'contact',
5404             'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5405             'hashref'   => \%hash,
5406             'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5407                            " cust_contact.custnum = $custnum "
5408          });
5409 }
5410
5411 sub process_o2m_qsearchs {
5412   my $self = shift;
5413   my $table = shift;
5414   return qsearchs($table, @_) unless $table eq 'contact';
5415
5416   my $hashref = shift;
5417   my %hash = %$hashref;
5418   ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5419     or die 'guru meditation #2121';
5420
5421   qsearchs({ 'table'     => 'contact',
5422              'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5423              'hashref'   => \%hash,
5424              'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5425                             " cust_contact.custnum = $custnum "
5426           });
5427 }
5428
5429 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5430
5431 Subroutine (not a method), designed to be called from the queue.
5432
5433 Takes a list of options and values.
5434
5435 Pulls up the customer record via the custnum option and calls bill_and_collect.
5436
5437 =cut
5438
5439 sub queued_bill {
5440   my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5441
5442   my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5443   warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5444
5445   #without this errors don't get rolled back
5446   $args{'fatal'} = 1; # runs from job queue, will be caught
5447
5448   $cust_main->bill_and_collect( %args );
5449 }
5450
5451 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5452
5453 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5454 C<collect> part.  This is used in batch tax calculation, where invoice
5455 generation and collection events have to be completely separated.
5456
5457 =cut
5458
5459 sub queued_collect {
5460   my (%args) = @_;
5461   my $cust_main = FS::cust_main->by_key($args{'custnum'});
5462
5463   $cust_main->collect(%args);
5464 }
5465
5466 sub process_bill_and_collect {
5467   my $job = shift;
5468   my $param = shift;
5469   my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5470       or die "custnum '$param->{custnum}' not found!\n";
5471   $param->{'job'}   = $job;
5472   $param->{'fatal'} = 1; # runs from job queue, will be caught
5473   $param->{'retry'} = 1;
5474
5475   $cust_main->bill_and_collect( %$param );
5476 }
5477
5478 #starting to take quite a while for big dbs
5479 #   (JRNL: journaled so it only happens once per database)
5480 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5481 # JRNL seq scan of cust_main on signupdate... index signupdate?  will that help?
5482 # JRNL seq scan of cust_main on paydate... index on substrings?  maybe set an
5483 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5484 # JRNL leading/trailing spaces in first, last, company
5485 # JRNL migrate to cust_payby
5486 # - otaker upgrade?  journal and call it good?  (double check to make sure
5487 #    we're not still setting otaker here)
5488 #
5489 #only going to get worse with new location stuff...
5490
5491 sub _upgrade_data { #class method
5492   my ($class, %opts) = @_;
5493
5494   my @statements = (
5495     'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5496   );
5497
5498   #this seems to be the only expensive one.. why does it take so long?
5499   unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5500     push @statements,
5501       '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';
5502     FS::upgrade_journal->set_done('cust_main__signupdate');
5503   }
5504
5505   unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5506
5507     # fix yyyy-m-dd formatted paydates
5508     if ( driver_name =~ /^mysql/i ) {
5509       push @statements,
5510       "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5511     } else { # the SQL standard
5512       push @statements,
5513       "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5514     }
5515     FS::upgrade_journal->set_done('cust_main__paydate');
5516   }
5517
5518   unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5519
5520     push @statements, #fix the weird BILL with a cc# in payinfo problem
5521       #DCRD to be safe
5522       "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5523
5524     FS::upgrade_journal->set_done('cust_main__payinfo');
5525
5526   }
5527
5528   my $t = time;
5529   foreach my $sql ( @statements ) {
5530     my $sth = dbh->prepare($sql) or die dbh->errstr;
5531     $sth->execute or die $sth->errstr;
5532     #warn ( (time - $t). " seconds\n" );
5533     #$t = time;
5534   }
5535
5536   local($ignore_expired_card) = 1;
5537   local($ignore_banned_card) = 1;
5538   local($skip_fuzzyfiles) = 1;
5539   local($import) = 1; #prevent automatic geocoding (need its own variable?)
5540
5541   unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5542
5543     #we don't want to decrypt them, just stuff them as-is into cust_payby
5544     local(@encrypted_fields) = ();
5545
5546     local($FS::cust_payby::ignore_expired_card) = 1;
5547     local($FS::cust_payby::ignore_banned_card)  = 1;
5548     local($FS::cust_payby::ignore_cardtype)     = 1;
5549
5550     my @payfields = qw( payby payinfo paycvv paymask
5551                         paydate paystart_month paystart_year payissue
5552                         payname paystate paytype payip
5553                       );
5554
5555     my $search = new FS::Cursor {
5556       'table'     => 'cust_main',
5557       'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5558     };
5559
5560     while (my $cust_main = $search->fetch) {
5561
5562       unless ( $cust_main->payby =~ /^(BILL|COMP)$/ ) {
5563
5564         my $cust_payby = new FS::cust_payby {
5565           'custnum' => $cust_main->custnum,
5566           'weight'  => 1,
5567           map { $_ => $cust_main->$_(); } @payfields
5568         };
5569
5570         my $error = $cust_payby->insert;
5571         die $error if $error;
5572
5573       }
5574
5575       # at the time we do this, also migrate paytype into cust_pay_batch
5576       # so that batches that are open before the migration can still be
5577       # processed
5578       my @cust_pay_batch = qsearch('cust_pay_batch', {
5579           'custnum' => $cust_main->custnum,
5580           'payby'   => 'CHEK',
5581           'paytype' => '',
5582       });
5583       foreach my $cust_pay_batch (@cust_pay_batch) {
5584         $cust_pay_batch->set('paytype', $cust_main->get('paytype'));
5585         my $error = $cust_pay_batch->replace;
5586         die "$error (setting cust_pay_batch.paytype)" if $error;
5587       }
5588
5589       $cust_main->complimentary('Y') if $cust_main->payby eq 'COMP';
5590
5591       $cust_main->invoice_attn( $cust_main->payname )
5592         if $cust_main->payby eq 'BILL' && $cust_main->payname;
5593       $cust_main->po_number( $cust_main->payinfo )
5594         if $cust_main->payby eq 'BILL' && $cust_main->payinfo;
5595
5596       $cust_main->setfield($_, '') foreach @payfields;
5597       my $error = $cust_main->replace;
5598       die "Error upgradging payment information for custnum ".
5599           $cust_main->custnum. ": $error"
5600         if $error;
5601
5602     };
5603
5604     FS::upgrade_journal->set_done('cust_main__cust_payby');
5605   }
5606
5607   FS::cust_main::Location->_upgrade_data(%opts);
5608
5609   unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5610
5611     foreach my $cust_main ( qsearch({
5612       'table'     => 'cust_main',
5613       'hashref'   => {},
5614       'extra_sql' => 'WHERE '.
5615                        join(' OR ',
5616                          map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '%  %'",
5617                            qw( first last company )
5618                        ),
5619     }) ) {
5620       my $error = $cust_main->replace;
5621       die $error if $error;
5622     }
5623
5624     FS::upgrade_journal->set_done('cust_main__trimspaces');
5625
5626   }
5627
5628   $class->_upgrade_otaker(%opts);
5629
5630 }
5631
5632 =back
5633
5634 =head1 BUGS
5635
5636 The delete method.
5637
5638 The delete method should possibly take an FS::cust_main object reference
5639 instead of a scalar customer number.
5640
5641 Bill and collect options should probably be passed as references instead of a
5642 list.
5643
5644 There should probably be a configuration file with a list of allowed credit
5645 card types.
5646
5647 No multiple currency support (probably a larger project than just this module).
5648
5649 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5650
5651 Birthdates rely on negative epoch values.
5652
5653 The payby for card/check batches is broken.  With mixed batching, bad
5654 things will happen.
5655
5656 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5657
5658 =head1 SEE ALSO
5659
5660 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5661 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5662 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
5663
5664 =cut
5665
5666 1;
5667