FS/FS/cust_main.pm

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