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