FS/FS/cust_main.pm

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