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