FS/FS/cust_main.pm

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