FS/FS/cust_main.pm

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