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