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