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 The cancellation time will be now.
2130
2131 =back
2132
2133 Always returns a list: an empty list on success or a list of errors.
2134
2135 =cut
2136
2137 sub cancel {
2138   my $self = shift;
2139   my %opt = @_;
2140   warn "$me cancel called on customer ". $self->custnum. " with options ".
2141        join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2142     if $DEBUG;
2143   my @pkgs = $self->ncancelled_pkgs;
2144
2145   $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2146 }
2147
2148 =item cancel_pkgs OPTIONS
2149
2150 Cancels a specified list of packages. OPTIONS can include:
2151
2152 =over 4
2153
2154 =item cust_pkg - an arrayref of the packages. Required.
2155
2156 =item time - the cancellation time, used to calculate final bills and
2157 unused-time credits if any. Will be passed through to the bill() and
2158 FS::cust_pkg::cancel() methods.
2159
2160 =item quiet - can be set true to supress email cancellation notices.
2161
2162 =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.
2163
2164 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2165 for the individual packages, parallel to the C<cust_pkg> argument. The
2166 reason and reason_otaker arguments will be taken from those objects.
2167
2168 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2169
2170 =item nobill - can be set true to skip billing if it might otherwise be done.
2171
2172 =cut
2173
2174 sub cancel_pkgs {
2175   my( $self, %opt ) = @_;
2176
2177   # we're going to cancel services, which is not reversible
2178   die "cancel_pkgs cannot be run inside a transaction"
2179     if $FS::UID::AutoCommit == 0;
2180
2181   local $FS::UID::AutoCommit = 0;
2182
2183   return ( 'access denied' )
2184     unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2185
2186   if ( $opt{'ban'} ) {
2187
2188     foreach my $cust_payby ( $self->cust_payby ) {
2189
2190       #well, if they didn't get decrypted on search, then we don't have to
2191       # try again... queue a job for the server that does have decryption
2192       # capability if we're in a paranoid multi-server implementation?
2193       return ( "Can't (yet) ban encrypted credit cards" )
2194         if $cust_payby->is_encrypted($cust_payby->payinfo);
2195
2196       my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2197       my $error = $ban->insert;
2198       if ($error) {
2199         dbh->rollback;
2200         return ( $error );
2201       }
2202
2203     }
2204
2205   }
2206
2207   my @pkgs = @{ delete $opt{'cust_pkg'} };
2208   my $cancel_time = $opt{'time'} || time;
2209
2210   # bill all packages first, so we don't lose usage, service counts for
2211   # bulk billing, etc.
2212   if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2213     $opt{nobill} = 1;
2214     my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2215                              'cancel'   => 1,
2216                              'time'     => $cancel_time );
2217     if ($error) {
2218       warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2219       dbh->rollback;
2220       return ( "Error billing during cancellation: $error" );
2221     }
2222   }
2223   dbh->commit;
2224
2225   $FS::UID::AutoCommit = 1;
2226   my @errors;
2227   # now cancel all services, the same way we would for individual packages.
2228   # if any of them fail, cancel the rest anyway.
2229   my @cust_svc = map { $_->cust_svc } @pkgs;
2230   my @sorted_cust_svc =
2231     map  { $_->[0] }
2232     sort { $a->[1] <=> $b->[1] }
2233     map  { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2234   ;
2235   warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2236     $self->custnum."\n"
2237     if $DEBUG;
2238   foreach my $cust_svc (@sorted_cust_svc) {
2239     my $part_svc = $cust_svc->part_svc;
2240     next if ( defined($part_svc) and $part_svc->preserve );
2241     my $error = $cust_svc->cancel; # immediate cancel, no date option
2242     push @errors, $error if $error;
2243   }
2244   if (@errors) {
2245     return @errors;
2246   }
2247
2248   warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2249     $self->custnum. "\n"
2250     if $DEBUG;
2251
2252   my @cprs;
2253   if ($opt{'cust_pkg_reason'}) {
2254     @cprs = @{ delete $opt{'cust_pkg_reason'} };
2255   }
2256   foreach (@pkgs) {
2257     my %lopt = %opt;
2258     if (@cprs) {
2259       my $cpr = shift @cprs;
2260       $lopt{'reason'}        = $cpr->reasonnum;
2261       $lopt{'reason_otaker'} = $cpr->otaker;
2262     }
2263     my $error = $_->cancel(%lopt);
2264     push @errors, 'pkgnum '.$_->pkgnum.': '.$error if $error;
2265   }
2266
2267   return @errors;
2268 }
2269
2270 sub _banned_pay_hashref {
2271   die 'cust_main->_banned_pay_hashref deprecated';
2272
2273   my $self = shift;
2274
2275   my %payby2ban = (
2276     'CARD' => 'CARD',
2277     'DCRD' => 'CARD',
2278     'CHEK' => 'CHEK',
2279     'DCHK' => 'CHEK'
2280   );
2281
2282   {
2283     'payby'   => $payby2ban{$self->payby},
2284     'payinfo' => $self->payinfo,
2285     #don't ever *search* on reason! #'reason'  =>
2286   };
2287 }
2288
2289 =item notes
2290
2291 Returns all notes (see L<FS::cust_main_note>) for this customer.
2292
2293 =cut
2294
2295 sub notes {
2296   my($self,$orderby_classnum) = (shift,shift);
2297   my $orderby = "sticky DESC, _date DESC";
2298   $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2299   qsearch( 'cust_main_note',
2300            { 'custnum' => $self->custnum },
2301            '',
2302            "ORDER BY $orderby",
2303          );
2304 }
2305
2306 =item agent
2307
2308 Returns the agent (see L<FS::agent>) for this customer.
2309
2310 =item agent_name
2311
2312 Returns the agent name (see L<FS::agent>) for this customer.
2313
2314 =cut
2315
2316 sub agent_name {
2317   my $self = shift;
2318   $self->agent->agent;
2319 }
2320
2321 =item cust_tag
2322
2323 Returns any tags associated with this customer, as FS::cust_tag objects,
2324 or an empty list if there are no tags.
2325
2326 =item part_tag
2327
2328 Returns any tags associated with this customer, as FS::part_tag objects,
2329 or an empty list if there are no tags.
2330
2331 =cut
2332
2333 sub part_tag {
2334   my $self = shift;
2335   map $_->part_tag, $self->cust_tag;
2336 }
2337
2338
2339 =item cust_class
2340
2341 Returns the customer class, as an FS::cust_class object, or the empty string
2342 if there is no customer class.
2343
2344 =item categoryname
2345
2346 Returns the customer category name, or the empty string if there is no customer
2347 category.
2348
2349 =cut
2350
2351 sub categoryname {
2352   my $self = shift;
2353   my $cust_class = $self->cust_class;
2354   $cust_class
2355     ? $cust_class->categoryname
2356     : '';
2357 }
2358
2359 =item classname
2360
2361 Returns the customer class name, or the empty string if there is no customer
2362 class.
2363
2364 =cut
2365
2366 sub classname {
2367   my $self = shift;
2368   my $cust_class = $self->cust_class;
2369   $cust_class
2370     ? $cust_class->classname
2371     : '';
2372 }
2373
2374 =item tax_status
2375
2376 Returns the external tax status, as an FS::tax_status object, or the empty
2377 string if there is no tax status.
2378
2379 =cut
2380
2381 sub tax_status {
2382   my $self = shift;
2383   if ( $self->taxstatusnum ) {
2384     qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2385   } else {
2386     return '';
2387   }
2388 }
2389
2390 =item taxstatus
2391
2392 Returns the tax status code if there is one.
2393
2394 =cut
2395
2396 sub taxstatus {
2397   my $self = shift;
2398   my $tax_status = $self->tax_status;
2399   $tax_status
2400     ? $tax_status->taxstatus
2401     : '';
2402 }
2403
2404 =item BILLING METHODS
2405
2406 Documentation on billing methods has been moved to
2407 L<FS::cust_main::Billing>.
2408
2409 =item REALTIME BILLING METHODS
2410
2411 Documentation on realtime billing methods has been moved to
2412 L<FS::cust_main::Billing_Realtime>.
2413
2414 =item remove_cvv
2415
2416 Removes the I<paycvv> field from the database directly.
2417
2418 If there is an error, returns the error, otherwise returns false.
2419
2420 DEPRECATED.  Use L</remove_cvv_from_cust_payby> instead.
2421
2422 =cut
2423
2424 sub remove_cvv {
2425   die 'cust_main->remove_cvv deprecated';
2426   my $self = shift;
2427   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2428     or return dbh->errstr;
2429   $sth->execute($self->custnum)
2430     or return $sth->errstr;
2431   $self->paycvv('');
2432   '';
2433 }
2434
2435 =item total_owed
2436
2437 Returns the total owed for this customer on all invoices
2438 (see L<FS::cust_bill/owed>).
2439
2440 =cut
2441
2442 sub total_owed {
2443   my $self = shift;
2444   $self->total_owed_date(2145859200); #12/31/2037
2445 }
2446
2447 =item total_owed_date TIME
2448
2449 Returns the total owed for this customer on all invoices with date earlier than
2450 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2451 see L<Time::Local> and L<Date::Parse> for conversion functions.
2452
2453 =cut
2454
2455 sub total_owed_date {
2456   my $self = shift;
2457   my $time = shift;
2458
2459   my $custnum = $self->custnum;
2460
2461   my $owed_sql = FS::cust_bill->owed_sql;
2462
2463   my $sql = "
2464     SELECT SUM($owed_sql) FROM cust_bill
2465       WHERE custnum = $custnum
2466         AND _date <= $time
2467   ";
2468
2469   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2470
2471 }
2472
2473 =item total_owed_pkgnum PKGNUM
2474
2475 Returns the total owed on all invoices for this customer's specific package
2476 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2477
2478 =cut
2479
2480 sub total_owed_pkgnum {
2481   my( $self, $pkgnum ) = @_;
2482   $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2483 }
2484
2485 =item total_owed_date_pkgnum TIME PKGNUM
2486
2487 Returns the total owed for this customer's specific package when using
2488 experimental package balances on all invoices with date earlier than
2489 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2490 see L<Time::Local> and L<Date::Parse> for conversion functions.
2491
2492 =cut
2493
2494 sub total_owed_date_pkgnum {
2495   my( $self, $time, $pkgnum ) = @_;
2496
2497   my $total_bill = 0;
2498   foreach my $cust_bill (
2499     grep { $_->_date <= $time }
2500       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2501   ) {
2502     $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2503   }
2504   sprintf( "%.2f", $total_bill );
2505
2506 }
2507
2508 =item total_paid
2509
2510 Returns the total amount of all payments.
2511
2512 =cut
2513
2514 sub total_paid {
2515   my $self = shift;
2516   my $total = 0;
2517   $total += $_->paid foreach $self->cust_pay;
2518   sprintf( "%.2f", $total );
2519 }
2520
2521 =item total_unapplied_credits
2522
2523 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2524 customer.  See L<FS::cust_credit/credited>.
2525
2526 =item total_credited
2527
2528 Old name for total_unapplied_credits.  Don't use.
2529
2530 =cut
2531
2532 sub total_credited {
2533   #carp "total_credited deprecated, use total_unapplied_credits";
2534   shift->total_unapplied_credits(@_);
2535 }
2536
2537 sub total_unapplied_credits {
2538   my $self = shift;
2539
2540   my $custnum = $self->custnum;
2541
2542   my $unapplied_sql = FS::cust_credit->unapplied_sql;
2543
2544   my $sql = "
2545     SELECT SUM($unapplied_sql) FROM cust_credit
2546       WHERE custnum = $custnum
2547   ";
2548
2549   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2550
2551 }
2552
2553 =item total_unapplied_credits_pkgnum PKGNUM
2554
2555 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2556 customer.  See L<FS::cust_credit/credited>.
2557
2558 =cut
2559
2560 sub total_unapplied_credits_pkgnum {
2561   my( $self, $pkgnum ) = @_;
2562   my $total_credit = 0;
2563   $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2564   sprintf( "%.2f", $total_credit );
2565 }
2566
2567
2568 =item total_unapplied_payments
2569
2570 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2571 See L<FS::cust_pay/unapplied>.
2572
2573 =cut
2574
2575 sub total_unapplied_payments {
2576   my $self = shift;
2577
2578   my $custnum = $self->custnum;
2579
2580   my $unapplied_sql = FS::cust_pay->unapplied_sql;
2581
2582   my $sql = "
2583     SELECT SUM($unapplied_sql) FROM cust_pay
2584       WHERE custnum = $custnum
2585   ";
2586
2587   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2588
2589 }
2590
2591 =item total_unapplied_payments_pkgnum PKGNUM
2592
2593 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2594 specific package when using experimental package balances.  See
2595 L<FS::cust_pay/unapplied>.
2596
2597 =cut
2598
2599 sub total_unapplied_payments_pkgnum {
2600   my( $self, $pkgnum ) = @_;
2601   my $total_unapplied = 0;
2602   $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2603   sprintf( "%.2f", $total_unapplied );
2604 }
2605
2606
2607 =item total_unapplied_refunds
2608
2609 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2610 customer.  See L<FS::cust_refund/unapplied>.
2611
2612 =cut
2613
2614 sub total_unapplied_refunds {
2615   my $self = shift;
2616   my $custnum = $self->custnum;
2617
2618   my $unapplied_sql = FS::cust_refund->unapplied_sql;
2619
2620   my $sql = "
2621     SELECT SUM($unapplied_sql) FROM cust_refund
2622       WHERE custnum = $custnum
2623   ";
2624
2625   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2626
2627 }
2628
2629 =item balance
2630
2631 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2632 total_unapplied_credits minus total_unapplied_payments).
2633
2634 =cut
2635
2636 sub balance {
2637   my $self = shift;
2638   $self->balance_date_range;
2639 }
2640
2641 =item balance_date TIME
2642
2643 Returns the balance for this customer, only considering invoices with date
2644 earlier than TIME (total_owed_date minus total_credited minus
2645 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
2646 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
2647 functions.
2648
2649 =cut
2650
2651 sub balance_date {
2652   my $self = shift;
2653   $self->balance_date_range(shift);
2654 }
2655
2656 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2657
2658 Returns the balance for this customer, optionally considering invoices with
2659 date earlier than START_TIME, and not later than END_TIME
2660 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2661
2662 Times are specified as SQL fragments or numeric
2663 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
2664 L<Date::Parse> for conversion functions.  The empty string can be passed
2665 to disable that time constraint completely.
2666
2667 Accepts the same options as L<balance_date_sql>:
2668
2669 =over 4
2670
2671 =item unapplied_date
2672
2673 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)
2674
2675 =item cutoff
2676
2677 An absolute cutoff time.  Payments, credits, and refunds I<applied> after this
2678 time will be ignored.  Note that START_TIME and END_TIME only limit the date
2679 range for invoices and I<unapplied> payments, credits, and refunds.
2680
2681 =back
2682
2683 =cut
2684
2685 sub balance_date_range {
2686   my $self = shift;
2687   my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2688             ') FROM cust_main WHERE custnum='. $self->custnum;
2689   sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2690 }
2691
2692 =item balance_pkgnum PKGNUM
2693
2694 Returns the balance for this customer's specific package when using
2695 experimental package balances (total_owed plus total_unrefunded, minus
2696 total_unapplied_credits minus total_unapplied_payments)
2697
2698 =cut
2699
2700 sub balance_pkgnum {
2701   my( $self, $pkgnum ) = @_;
2702
2703   sprintf( "%.2f",
2704       $self->total_owed_pkgnum($pkgnum)
2705 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2706 #    + $self->total_unapplied_refunds_pkgnum($pkgnum)
2707     - $self->total_unapplied_credits_pkgnum($pkgnum)
2708     - $self->total_unapplied_payments_pkgnum($pkgnum)
2709   );
2710 }
2711
2712 =item payment_info
2713
2714 Returns a hash of useful information for making a payment.
2715
2716 =over 4
2717
2718 =item balance
2719
2720 Current balance.
2721
2722 =item payby
2723
2724 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2725 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2726 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2727
2728 =back
2729
2730 For credit card transactions:
2731
2732 =over 4
2733
2734 =item card_type 1
2735
2736 =item payname
2737
2738 Exact name on card
2739
2740 =back
2741
2742 For electronic check transactions:
2743
2744 =over 4
2745
2746 =item stateid_state
2747
2748 =back
2749
2750 =cut
2751
2752 #XXX i need to be updated for 4.x+
2753 sub payment_info {
2754   my $self = shift;
2755
2756   my %return = ();
2757
2758   $return{balance} = $self->balance;
2759
2760   $return{payname} = $self->payname
2761                      || ( $self->first. ' '. $self->get('last') );
2762
2763   $return{$_} = $self->bill_location->$_
2764     for qw(address1 address2 city state zip);
2765
2766   $return{payby} = $self->payby;
2767   $return{stateid_state} = $self->stateid_state;
2768
2769   if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2770     $return{card_type} = cardtype($self->payinfo);
2771     $return{payinfo} = $self->paymask;
2772
2773     @return{'month', 'year'} = $self->paydate_monthyear;
2774
2775   }
2776
2777   if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2778     my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2779     $return{payinfo1} = $payinfo1;
2780     $return{payinfo2} = $payinfo2;
2781     $return{paytype}  = $self->paytype;
2782     $return{paystate} = $self->paystate;
2783
2784   }
2785
2786   #doubleclick protection
2787   my $_date = time;
2788   $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2789
2790   %return;
2791
2792 }
2793
2794 =item paydate_epoch
2795
2796 Returns the next payment expiration date for this customer. If they have no
2797 payment methods that will expire, returns 0.
2798
2799 =cut
2800
2801 sub paydate_epoch {
2802   my $self = shift;
2803   # filter out the ones that individually return 0, but then return 0 if
2804   # there are no results
2805   my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
2806   min( @epochs ) || 0;
2807 }
2808
2809 =item paydate_epoch_sql
2810
2811 Returns an SQL expression to get the next payment expiration date for a
2812 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
2813 dates, so that it's safe to test for "will it expire before date X" for any
2814 date up to then.
2815
2816 =cut
2817
2818 sub paydate_epoch_sql {
2819   my $class = shift;
2820   my $paydate = FS::cust_payby->paydate_epoch_sql;
2821   "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
2822 }
2823
2824 sub tax_exemption {
2825   my( $self, $taxname ) = @_;
2826
2827   qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2828                                      'taxname' => $taxname,
2829                                    },
2830           );
2831 }
2832
2833 =item cust_main_exemption
2834
2835 =item invoicing_list
2836
2837 Returns a list of email addresses (with svcnum entries expanded), and the word
2838 'POST' if the customer receives postal invoices.
2839
2840 =cut
2841
2842 sub invoicing_list {
2843   my( $self, $arrayref ) = @_;
2844
2845   if ( $arrayref ) {
2846     warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
2847   }
2848
2849   my @emails = $self->invoicing_list_emailonly;
2850   push @emails, 'POST' if $self->get('postal_invoice');
2851
2852   @emails;
2853 }
2854
2855 =item check_invoicing_list ARRAYREF
2856
2857 Checks these arguements as valid input for the invoicing_list method.  If there
2858 is an error, returns the error, otherwise returns false.
2859
2860 =cut
2861
2862 sub check_invoicing_list {
2863   my( $self, $arrayref ) = @_;
2864
2865   foreach my $address ( @$arrayref ) {
2866
2867     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
2868       return 'Can\'t add FAX invoice destination with a blank FAX number.';
2869     }
2870
2871     my $cust_main_invoice = new FS::cust_main_invoice ( {
2872       'custnum' => $self->custnum,
2873       'dest'    => $address,
2874     } );
2875     my $error = $self->custnum
2876                 ? $cust_main_invoice->check
2877                 : $cust_main_invoice->checkdest
2878     ;
2879     return $error if $error;
2880
2881   }
2882
2883   return "Email address required"
2884     if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
2885     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
2886
2887   '';
2888 }
2889
2890 =item all_emails
2891
2892 Returns the email addresses of all accounts provisioned for this customer.
2893
2894 =cut
2895
2896 sub all_emails {
2897   my $self = shift;
2898   my %list;
2899   foreach my $cust_pkg ( $self->all_pkgs ) {
2900     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
2901     my @svc_acct =
2902       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2903         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2904           @cust_svc;
2905     $list{$_}=1 foreach map { $_->email } @svc_acct;
2906   }
2907   keys %list;
2908 }
2909
2910 =item invoicing_list_addpost
2911
2912 Adds postal invoicing to this customer.  If this customer is already configured
2913 to receive postal invoices, does nothing.
2914
2915 =cut
2916
2917 sub invoicing_list_addpost {
2918   my $self = shift;
2919   if ( $self->get('postal_invoice') eq '' ) {
2920     $self->set('postal_invoice', 'Y');
2921     my $error = $self->replace;
2922     warn $error if $error; # should fail harder, but this is traditional
2923   }
2924 }
2925
2926 =item invoicing_list_emailonly
2927
2928 Returns the list of email invoice recipients (invoicing_list without non-email
2929 destinations such as POST and FAX).
2930
2931 =cut
2932
2933 sub invoicing_list_emailonly {
2934   my $self = shift;
2935   warn "$me invoicing_list_emailonly called"
2936     if $DEBUG;
2937   return () if !$self->custnum; # not yet inserted
2938   return map { $_->emailaddress }
2939     qsearch({
2940         table     => 'cust_contact',
2941         select    => 'emailaddress',
2942         addl_from => ' JOIN contact USING (contactnum) '.
2943                      ' JOIN contact_email USING (contactnum)',
2944         hashref   => { 'custnum' => $self->custnum, },
2945         extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
2946     });
2947 }
2948
2949 =item invoicing_list_emailonly_scalar
2950
2951 Returns the list of email invoice recipients (invoicing_list without non-email
2952 destinations such as POST and FAX) as a comma-separated scalar.
2953
2954 =cut
2955
2956 sub invoicing_list_emailonly_scalar {
2957   my $self = shift;
2958   warn "$me invoicing_list_emailonly_scalar called"
2959     if $DEBUG;
2960   join(', ', $self->invoicing_list_emailonly);
2961 }
2962
2963 =item contact_list [ CLASSNUM, ... ]
2964
2965 Returns a list of contacts (L<FS::contact> objects) for the customer. If
2966 a list of contact classnums is given, returns only contacts in those
2967 classes. If the pseudo-classnum 'invoice' is given, returns contacts that
2968 are marked as invoice destinations. If '0' is given, also returns contacts
2969 with no class.
2970
2971 If no arguments are given, returns all contacts for the customer.
2972
2973 =cut
2974
2975 sub contact_list {
2976   my $self = shift;
2977   my $search = {
2978     table       => 'contact',
2979     select      => 'contact.*, cust_contact.invoice_dest',
2980     addl_from   => ' JOIN cust_contact USING (contactnum)',
2981     extra_sql   => ' WHERE cust_contact.custnum = '.$self->custnum,
2982   };
2983
2984   my @orwhere;
2985   my @classnums;
2986   foreach (@_) {
2987     if ( $_ eq 'invoice' ) {
2988       push @orwhere, 'cust_contact.invoice_dest = \'Y\'';
2989     } elsif ( $_ eq '0' ) {
2990       push @orwhere, 'cust_contact.classnum is null';
2991     } elsif ( /^\d+$/ ) {
2992       push @classnums, $_;
2993     } else {
2994       die "bad classnum argument '$_'";
2995     }
2996   }
2997
2998   if (@classnums) {
2999     push @orwhere, 'cust_contact.classnum IN ('.join(',', @classnums).')';
3000   }
3001   if (@orwhere) {
3002     $search->{extra_sql} .= ' AND (' .
3003                             join(' OR ', map "( $_ )", @orwhere) .
3004                             ')';
3005   }
3006
3007   qsearch($search);
3008 }
3009
3010 =item contact_list_email [ CLASSNUM, ... ]
3011
3012 Same as L</contact_list>, but returns email destinations instead of contact
3013 objects.
3014
3015 =cut
3016
3017 sub contact_list_email {
3018   my $self = shift;
3019   my @contacts = $self->contact_list(@_);
3020   my @emails;
3021   foreach my $contact (@contacts) {
3022     foreach my $contact_email ($contact->contact_email) {
3023       push @emails,
3024         $contact->firstlast . ' <' . $contact_email->emailaddress . '>';
3025     }
3026   }
3027   @emails;
3028 }
3029
3030 =item referral_custnum_cust_main
3031
3032 Returns the customer who referred this customer (or the empty string, if
3033 this customer was not referred).
3034
3035 Note the difference with referral_cust_main method: This method,
3036 referral_custnum_cust_main returns the single customer (if any) who referred
3037 this customer, while referral_cust_main returns an array of customers referred
3038 BY this customer.
3039
3040 =cut
3041
3042 sub referral_custnum_cust_main {
3043   my $self = shift;
3044   return '' unless $self->referral_custnum;
3045   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3046 }
3047
3048 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3049
3050 Returns an array of customers referred by this customer (referral_custnum set
3051 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
3052 customers referred by customers referred by this customer and so on, inclusive.
3053 The default behavior is DEPTH 1 (no recursion).
3054
3055 Note the difference with referral_custnum_cust_main method: This method,
3056 referral_cust_main, returns an array of customers referred BY this customer,
3057 while referral_custnum_cust_main returns the single customer (if any) who
3058 referred this customer.
3059
3060 =cut
3061
3062 sub referral_cust_main {
3063   my $self = shift;
3064   my $depth = @_ ? shift : 1;
3065   my $exclude = @_ ? shift : {};
3066
3067   my @cust_main =
3068     map { $exclude->{$_->custnum}++; $_; }
3069       grep { ! $exclude->{ $_->custnum } }
3070         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3071
3072   if ( $depth > 1 ) {
3073     push @cust_main,
3074       map { $_->referral_cust_main($depth-1, $exclude) }
3075         @cust_main;
3076   }
3077
3078   @cust_main;
3079 }
3080
3081 =item referral_cust_main_ncancelled
3082
3083 Same as referral_cust_main, except only returns customers with uncancelled
3084 packages.
3085
3086 =cut
3087
3088 sub referral_cust_main_ncancelled {
3089   my $self = shift;
3090   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3091 }
3092
3093 =item referral_cust_pkg [ DEPTH ]
3094
3095 Like referral_cust_main, except returns a flat list of all unsuspended (and
3096 uncancelled) packages for each customer.  The number of items in this list may
3097 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3098
3099 =cut
3100
3101 sub referral_cust_pkg {
3102   my $self = shift;
3103   my $depth = @_ ? shift : 1;
3104
3105   map { $_->unsuspended_pkgs }
3106     grep { $_->unsuspended_pkgs }
3107       $self->referral_cust_main($depth);
3108 }
3109
3110 =item referring_cust_main
3111
3112 Returns the single cust_main record for the customer who referred this customer
3113 (referral_custnum), or false.
3114
3115 =cut
3116
3117 sub referring_cust_main {
3118   my $self = shift;
3119   return '' unless $self->referral_custnum;
3120   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3121 }
3122
3123 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3124
3125 Applies a credit to this customer.  If there is an error, returns the error,
3126 otherwise returns false.
3127
3128 REASON can be a text string, an FS::reason object, or a scalar reference to
3129 a reasonnum.  If a text string, it will be automatically inserted as a new
3130 reason, and a 'reason_type' option must be passed to indicate the
3131 FS::reason_type for the new reason.
3132
3133 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3134 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3135 I<commission_pkgnum>.
3136
3137 Any other options are passed to FS::cust_credit::insert.
3138
3139 =cut
3140
3141 sub credit {
3142   my( $self, $amount, $reason, %options ) = @_;
3143
3144   my $cust_credit = new FS::cust_credit {
3145     'custnum' => $self->custnum,
3146     'amount'  => $amount,
3147   };
3148
3149   if ( ref($reason) ) {
3150
3151     if ( ref($reason) eq 'SCALAR' ) {
3152       $cust_credit->reasonnum( $$reason );
3153     } else {
3154       $cust_credit->reasonnum( $reason->reasonnum );
3155     }
3156
3157   } else {
3158     $cust_credit->set('reason', $reason)
3159   }
3160
3161   $cust_credit->$_( delete $options{$_} )
3162     foreach grep exists($options{$_}),
3163               qw( addlinfo eventnum ),
3164               map "commission_$_", qw( agentnum salesnum pkgnum );
3165
3166   $cust_credit->insert(%options);
3167
3168 }
3169
3170 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3171
3172 Creates a one-time charge for this customer.  If there is an error, returns
3173 the error, otherwise returns false.
3174
3175 New-style, with a hashref of options:
3176
3177   my $error = $cust_main->charge(
3178                                   {
3179                                     'amount'     => 54.32,
3180                                     'quantity'   => 1,
3181                                     'start_date' => str2time('7/4/2009'),
3182                                     'pkg'        => 'Description',
3183                                     'comment'    => 'Comment',
3184                                     'additional' => [], #extra invoice detail
3185                                     'classnum'   => 1,  #pkg_class
3186
3187                                     'setuptax'   => '', # or 'Y' for tax exempt
3188
3189                                     'locationnum'=> 1234, # optional
3190
3191                                     #internal taxation
3192                                     'taxclass'   => 'Tax class',
3193
3194                                     #vendor taxation
3195                                     'taxproduct' => 2,  #part_pkg_taxproduct
3196                                     'override'   => {}, #XXX describe
3197
3198                                     #will be filled in with the new object
3199                                     'cust_pkg_ref' => \$cust_pkg,
3200
3201                                     #generate an invoice immediately
3202                                     'bill_now' => 0,
3203                                     'invoice_terms' => '', #with these terms
3204                                   }
3205                                 );
3206
3207 Old-style:
3208
3209   my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3210
3211 =cut
3212
3213 #super false laziness w/quotation::charge
3214 sub charge {
3215   my $self = shift;
3216   my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3217   my ( $pkg, $comment, $additional );
3218   my ( $setuptax, $taxclass );   #internal taxes
3219   my ( $taxproduct, $override ); #vendor (CCH) taxes
3220   my $no_auto = '';
3221   my $separate_bill = '';
3222   my $cust_pkg_ref = '';
3223   my ( $bill_now, $invoice_terms ) = ( 0, '' );
3224   my $locationnum;
3225   if ( ref( $_[0] ) ) {
3226     $amount     = $_[0]->{amount};
3227     $setup_cost = $_[0]->{setup_cost};
3228     $quantity   = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3229     $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3230     $no_auto    = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3231     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3232     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
3233                                            : '$'. sprintf("%.2f",$amount);
3234     $setuptax   = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3235     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3236     $classnum   = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3237     $additional = $_[0]->{additional} || [];
3238     $taxproduct = $_[0]->{taxproductnum};
3239     $override   = { '' => $_[0]->{tax_override} };
3240     $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3241     $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3242     $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3243     $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3244     $separate_bill = $_[0]->{separate_bill} || '';
3245   } else { # yuck
3246     $amount     = shift;
3247     $setup_cost = '';
3248     $quantity   = 1;
3249     $start_date = '';
3250     $pkg        = @_ ? shift : 'One-time charge';
3251     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
3252     $setuptax   = '';
3253     $taxclass   = @_ ? shift : '';
3254     $additional = [];
3255   }
3256
3257   local $SIG{HUP} = 'IGNORE';
3258   local $SIG{INT} = 'IGNORE';
3259   local $SIG{QUIT} = 'IGNORE';
3260   local $SIG{TERM} = 'IGNORE';
3261   local $SIG{TSTP} = 'IGNORE';
3262   local $SIG{PIPE} = 'IGNORE';
3263
3264   my $oldAutoCommit = $FS::UID::AutoCommit;
3265   local $FS::UID::AutoCommit = 0;
3266   my $dbh = dbh;
3267
3268   my $part_pkg = new FS::part_pkg ( {
3269     'pkg'           => $pkg,
3270     'comment'       => $comment,
3271     'plan'          => 'flat',
3272     'freq'          => 0,
3273     'disabled'      => 'Y',
3274     'classnum'      => ( $classnum ? $classnum : '' ),
3275     'setuptax'      => $setuptax,
3276     'taxclass'      => $taxclass,
3277     'taxproductnum' => $taxproduct,
3278     'setup_cost'    => $setup_cost,
3279   } );
3280
3281   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3282                         ( 0 .. @$additional - 1 )
3283                   ),
3284                   'additional_count' => scalar(@$additional),
3285                   'setup_fee' => $amount,
3286                 );
3287
3288   my $error = $part_pkg->insert( options       => \%options,
3289                                  tax_overrides => $override,
3290                                );
3291   if ( $error ) {
3292     $dbh->rollback if $oldAutoCommit;
3293     return $error;
3294   }
3295
3296   my $pkgpart = $part_pkg->pkgpart;
3297   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3298   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3299     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3300     $error = $type_pkgs->insert;
3301     if ( $error ) {
3302       $dbh->rollback if $oldAutoCommit;
3303       return $error;
3304     }
3305   }
3306
3307   my $cust_pkg = new FS::cust_pkg ( {
3308     'custnum'    => $self->custnum,
3309     'pkgpart'    => $pkgpart,
3310     'quantity'   => $quantity,
3311     'start_date' => $start_date,
3312     'no_auto'    => $no_auto,
3313     'separate_bill' => $separate_bill,
3314     'locationnum'=> $locationnum,
3315   } );
3316
3317   $error = $cust_pkg->insert;
3318   if ( $error ) {
3319     $dbh->rollback if $oldAutoCommit;
3320     return $error;
3321   } elsif ( $cust_pkg_ref ) {
3322     ${$cust_pkg_ref} = $cust_pkg;
3323   }
3324
3325   if ( $bill_now ) {
3326     my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3327                              'pkg_list'      => [ $cust_pkg ],
3328                            );
3329     if ( $error ) {
3330       $dbh->rollback if $oldAutoCommit;
3331       return $error;
3332     }
3333   }
3334
3335   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3336   return '';
3337
3338 }
3339
3340 #=item charge_postal_fee
3341 #
3342 #Applies a one time charge this customer.  If there is an error,
3343 #returns the error, returns the cust_pkg charge object or false
3344 #if there was no charge.
3345 #
3346 #=cut
3347 #
3348 # This should be a customer event.  For that to work requires that bill
3349 # also be a customer event.
3350
3351 sub charge_postal_fee {
3352   my $self = shift;
3353
3354   my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3355   return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3356
3357   my $cust_pkg = new FS::cust_pkg ( {
3358     'custnum'  => $self->custnum,
3359     'pkgpart'  => $pkgpart,
3360     'quantity' => 1,
3361   } );
3362
3363   my $error = $cust_pkg->insert;
3364   $error ? $error : $cust_pkg;
3365 }
3366
3367 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3368
3369 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3370
3371 Optionally, a list or hashref of additional arguments to the qsearch call can
3372 be passed.
3373
3374 =cut
3375
3376 sub cust_bill {
3377   my $self = shift;
3378   my $opt = ref($_[0]) ? shift : { @_ };
3379
3380   #return $self->num_cust_bill unless wantarray || keys %$opt;
3381
3382   $opt->{'table'} = 'cust_bill';
3383   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3384   $opt->{'hashref'}{'custnum'} = $self->custnum;
3385   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3386
3387   map { $_ } #behavior of sort undefined in scalar context
3388     sort { $a->_date <=> $b->_date }
3389       qsearch($opt);
3390 }
3391
3392 =item open_cust_bill
3393
3394 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3395 customer.
3396
3397 =cut
3398
3399 sub open_cust_bill {
3400   my $self = shift;
3401
3402   $self->cust_bill(
3403     'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3404     #@_
3405   );
3406
3407 }
3408
3409 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3410
3411 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3412
3413 =cut
3414
3415 sub legacy_cust_bill {
3416   my $self = shift;
3417
3418   #return $self->num_legacy_cust_bill unless wantarray;
3419
3420   map { $_ } #behavior of sort undefined in scalar context
3421     sort { $a->_date <=> $b->_date }
3422       qsearch({ 'table'    => 'legacy_cust_bill',
3423                 'hashref'  => { 'custnum' => $self->custnum, },
3424                 'order_by' => 'ORDER BY _date ASC',
3425              });
3426 }
3427
3428 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3429
3430 Returns all the statements (see L<FS::cust_statement>) for this customer.
3431
3432 Optionally, a list or hashref of additional arguments to the qsearch call can
3433 be passed.
3434
3435 =cut
3436
3437 =item cust_bill_void
3438
3439 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3440
3441 =cut
3442
3443 sub cust_bill_void {
3444   my $self = shift;
3445
3446   map { $_ } #return $self->num_cust_bill_void unless wantarray;
3447   sort { $a->_date <=> $b->_date }
3448     qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3449 }
3450
3451 sub cust_statement {
3452   my $self = shift;
3453   my $opt = ref($_[0]) ? shift : { @_ };
3454
3455   #return $self->num_cust_statement unless wantarray || keys %$opt;
3456
3457   $opt->{'table'} = 'cust_statement';
3458   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3459   $opt->{'hashref'}{'custnum'} = $self->custnum;
3460   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3461
3462   map { $_ } #behavior of sort undefined in scalar context
3463     sort { $a->_date <=> $b->_date }
3464       qsearch($opt);
3465 }
3466
3467 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3468
3469 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3470
3471 Optionally, a list or hashref of additional arguments to the qsearch call can
3472 be passed following the SVCDB.
3473
3474 =cut
3475
3476 sub svc_x {
3477   my $self = shift;
3478   my $svcdb = shift;
3479   if ( ! $svcdb =~ /^svc_\w+$/ ) {
3480     warn "$me svc_x requires a svcdb";
3481     return;
3482   }
3483   my $opt = ref($_[0]) ? shift : { @_ };
3484
3485   $opt->{'table'} = $svcdb;
3486   $opt->{'addl_from'} =
3487     'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3488     ($opt->{'addl_from'} || '');
3489
3490   my $custnum = $self->custnum;
3491   $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3492   my $where = "cust_pkg.custnum = $custnum";
3493
3494   my $extra_sql = $opt->{'extra_sql'} || '';
3495   if ( keys %{ $opt->{'hashref'} } ) {
3496     $extra_sql = " AND $where $extra_sql";
3497   }
3498   else {
3499     if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3500       $extra_sql = "WHERE $where AND $1";
3501     }
3502     else {
3503       $extra_sql = "WHERE $where $extra_sql";
3504     }
3505   }
3506   $opt->{'extra_sql'} = $extra_sql;
3507
3508   qsearch($opt);
3509 }
3510
3511 # required for use as an eventtable;
3512 sub svc_acct {
3513   my $self = shift;
3514   $self->svc_x('svc_acct', @_);
3515 }
3516
3517 =item cust_credit
3518
3519 Returns all the credits (see L<FS::cust_credit>) for this customer.
3520
3521 =cut
3522
3523 sub cust_credit {
3524   my $self = shift;
3525
3526   #return $self->num_cust_credit unless wantarray;
3527
3528   map { $_ } #behavior of sort undefined in scalar context
3529     sort { $a->_date <=> $b->_date }
3530       qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3531 }
3532
3533 =item cust_credit_pkgnum
3534
3535 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3536 package when using experimental package balances.
3537
3538 =cut
3539
3540 sub cust_credit_pkgnum {
3541   my( $self, $pkgnum ) = @_;
3542   map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3543   sort { $a->_date <=> $b->_date }
3544     qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3545                               'pkgnum'  => $pkgnum,
3546                             }
3547     );
3548 }
3549
3550 =item cust_credit_void
3551
3552 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3553
3554 =cut
3555
3556 sub cust_credit_void {
3557   my $self = shift;
3558   map { $_ }
3559   sort { $a->_date <=> $b->_date }
3560     qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3561 }
3562
3563 =item cust_pay
3564
3565 Returns all the payments (see L<FS::cust_pay>) for this customer.
3566
3567 =cut
3568
3569 sub cust_pay {
3570   my $self = shift;
3571   my $opt = ref($_[0]) ? shift : { @_ };
3572
3573   return $self->num_cust_pay unless wantarray || keys %$opt;
3574
3575   $opt->{'table'} = 'cust_pay';
3576   $opt->{'hashref'}{'custnum'} = $self->custnum;
3577
3578   map { $_ } #behavior of sort undefined in scalar context
3579     sort { $a->_date <=> $b->_date }
3580       qsearch($opt);
3581
3582 }
3583
3584 =item num_cust_pay
3585
3586 Returns the number of payments (see L<FS::cust_pay>) for this customer.  Also
3587 called automatically when the cust_pay method is used in a scalar context.
3588
3589 =cut
3590
3591 sub num_cust_pay {
3592   my $self = shift;
3593   my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3594   my $sth = dbh->prepare($sql) or die dbh->errstr;
3595   $sth->execute($self->custnum) or die $sth->errstr;
3596   $sth->fetchrow_arrayref->[0];
3597 }
3598
3599 =item unapplied_cust_pay
3600
3601 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3602
3603 =cut
3604
3605 sub unapplied_cust_pay {
3606   my $self = shift;
3607
3608   $self->cust_pay(
3609     'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3610     #@_
3611   );
3612
3613 }
3614
3615 =item cust_pay_pkgnum
3616
3617 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3618 package when using experimental package balances.
3619
3620 =cut
3621
3622 sub cust_pay_pkgnum {
3623   my( $self, $pkgnum ) = @_;
3624   map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3625   sort { $a->_date <=> $b->_date }
3626     qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3627                            'pkgnum'  => $pkgnum,
3628                          }
3629     );
3630 }
3631
3632 =item cust_pay_void
3633
3634 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3635
3636 =cut
3637
3638 sub cust_pay_void {
3639   my $self = shift;
3640   map { $_ } #return $self->num_cust_pay_void unless wantarray;
3641   sort { $a->_date <=> $b->_date }
3642     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3643 }
3644
3645 =item cust_pay_pending
3646
3647 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3648 (without status "done").
3649
3650 =cut
3651
3652 sub cust_pay_pending {
3653   my $self = shift;
3654   return $self->num_cust_pay_pending unless wantarray;
3655   sort { $a->_date <=> $b->_date }
3656     qsearch( 'cust_pay_pending', {
3657                                    'custnum' => $self->custnum,
3658                                    'status'  => { op=>'!=', value=>'done' },
3659                                  },
3660            );
3661 }
3662
3663 =item cust_pay_pending_attempt
3664
3665 Returns all payment attempts / declined payments for this customer, as pending
3666 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3667 a corresponding payment (see L<FS::cust_pay>).
3668
3669 =cut
3670
3671 sub cust_pay_pending_attempt {
3672   my $self = shift;
3673   return $self->num_cust_pay_pending_attempt unless wantarray;
3674   sort { $a->_date <=> $b->_date }
3675     qsearch( 'cust_pay_pending', {
3676                                    'custnum' => $self->custnum,
3677                                    'status'  => 'done',
3678                                    'paynum'  => '',
3679                                  },
3680            );
3681 }
3682
3683 =item num_cust_pay_pending
3684
3685 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3686 customer (without status "done").  Also called automatically when the
3687 cust_pay_pending method is used in a scalar context.
3688
3689 =cut
3690
3691 sub num_cust_pay_pending {
3692   my $self = shift;
3693   $self->scalar_sql(
3694     " SELECT COUNT(*) FROM cust_pay_pending ".
3695       " WHERE custnum = ? AND status != 'done' ",
3696     $self->custnum
3697   );
3698 }
3699
3700 =item num_cust_pay_pending_attempt
3701
3702 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3703 customer, with status "done" but without a corresp.  Also called automatically when the
3704 cust_pay_pending method is used in a scalar context.
3705
3706 =cut
3707
3708 sub num_cust_pay_pending_attempt {
3709   my $self = shift;
3710   $self->scalar_sql(
3711     " SELECT COUNT(*) FROM cust_pay_pending ".
3712       " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3713     $self->custnum
3714   );
3715 }
3716
3717 =item cust_refund
3718
3719 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3720
3721 =cut
3722
3723 sub cust_refund {
3724   my $self = shift;
3725   map { $_ } #return $self->num_cust_refund unless wantarray;
3726   sort { $a->_date <=> $b->_date }
3727     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3728 }
3729
3730 =item display_custnum
3731
3732 Returns the displayed customer number for this customer: agent_custid if
3733 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3734
3735 =cut
3736
3737 sub display_custnum {
3738   my $self = shift;
3739
3740   return $self->agent_custid
3741     if $default_agent_custid && $self->agent_custid;
3742
3743   my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3744
3745   if ( $prefix ) {
3746     return $prefix .
3747            sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
3748   } elsif ( $custnum_display_length ) {
3749     return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
3750   } else {
3751     return $self->custnum;
3752   }
3753 }
3754
3755 =item name
3756
3757 Returns a name string for this customer, either "Company (Last, First)" or
3758 "Last, First".
3759
3760 =cut
3761
3762 sub name {
3763   my $self = shift;
3764   my $name = $self->contact;
3765   $name = $self->company. " ($name)" if $self->company;
3766   $name;
3767 }
3768
3769 =item service_contact
3770
3771 Returns the L<FS::contact> object for this customer that has the 'Service'
3772 contact class, or undef if there is no such contact.  Deprecated; don't use
3773 this in new code.
3774
3775 =cut
3776
3777 sub service_contact {
3778   my $self = shift;
3779   if ( !exists($self->{service_contact}) ) {
3780     my $classnum = $self->scalar_sql(
3781       'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3782     ) || 0; #if it's zero, qsearchs will return nothing
3783     my $cust_contact = qsearchs('cust_contact', {
3784         'classnum' => $classnum,
3785         'custnum'  => $self->custnum,
3786     });
3787     $self->{service_contact} = $cust_contact->contact if $cust_contact;
3788   }
3789   $self->{service_contact};
3790 }
3791
3792 =item ship_name
3793
3794 Returns a name string for this (service/shipping) contact, either
3795 "Company (Last, First)" or "Last, First".
3796
3797 =cut
3798
3799 sub ship_name {
3800   my $self = shift;
3801
3802   my $name = $self->ship_contact;
3803   $name = $self->company. " ($name)" if $self->company;
3804   $name;
3805 }
3806
3807 =item name_short
3808
3809 Returns a name string for this customer, either "Company" or "First Last".
3810
3811 =cut
3812
3813 sub name_short {
3814   my $self = shift;
3815   $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3816 }
3817
3818 =item ship_name_short
3819
3820 Returns a name string for this (service/shipping) contact, either "Company"
3821 or "First Last".
3822
3823 =cut
3824
3825 sub ship_name_short {
3826   my $self = shift;
3827   $self->service_contact
3828     ? $self->ship_contact_firstlast
3829     : $self->name_short
3830 }
3831
3832 =item contact
3833
3834 Returns this customer's full (billing) contact name only, "Last, First"
3835
3836 =cut
3837
3838 sub contact {
3839   my $self = shift;
3840   $self->get('last'). ', '. $self->first;
3841 }
3842
3843 =item ship_contact
3844
3845 Returns this customer's full (shipping) contact name only, "Last, First"
3846
3847 =cut
3848
3849 sub ship_contact {
3850   my $self = shift;
3851   my $contact = $self->service_contact || $self;
3852   $contact->get('last') . ', ' . $contact->get('first');
3853 }
3854
3855 =item contact_firstlast
3856
3857 Returns this customers full (billing) contact name only, "First Last".
3858
3859 =cut
3860
3861 sub contact_firstlast {
3862   my $self = shift;
3863   $self->first. ' '. $self->get('last');
3864 }
3865
3866 =item ship_contact_firstlast
3867
3868 Returns this customer's full (shipping) contact name only, "First Last".
3869
3870 =cut
3871
3872 sub ship_contact_firstlast {
3873   my $self = shift;
3874   my $contact = $self->service_contact || $self;
3875   $contact->get('first') . ' '. $contact->get('last');
3876 }
3877
3878 sub bill_country_full {
3879   my $self = shift;
3880   $self->bill_location->country_full;
3881 }
3882
3883 sub ship_country_full {
3884   my $self = shift;
3885   $self->ship_location->country_full;
3886 }
3887
3888 =item county_state_county [ PREFIX ]
3889
3890 Returns a string consisting of just the county, state and country.
3891
3892 =cut
3893
3894 sub county_state_country {
3895   my $self = shift;
3896   my $locationnum;
3897   if ( @_ && $_[0] && $self->has_ship_address ) {
3898     $locationnum = $self->ship_locationnum;
3899   } else {
3900     $locationnum = $self->bill_locationnum;
3901   }
3902   my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
3903   $cust_location->county_state_country;
3904 }
3905
3906 =item geocode DATA_VENDOR
3907
3908 Returns a value for the customer location as encoded by DATA_VENDOR.
3909 Currently this only makes sense for "CCH" as DATA_VENDOR.
3910
3911 =cut
3912
3913 =item cust_status
3914
3915 =item status
3916
3917 Returns a status string for this customer, currently:
3918
3919 =over 4
3920
3921 =item prospect
3922
3923 No packages have ever been ordered.  Displayed as "No packages".
3924
3925 =item ordered
3926
3927 Recurring packages all are new (not yet billed).
3928
3929 =item active
3930
3931 One or more recurring packages is active.
3932
3933 =item inactive
3934
3935 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
3936
3937 =item suspended
3938
3939 All non-cancelled recurring packages are suspended.
3940
3941 =item cancelled
3942
3943 All recurring packages are cancelled.
3944
3945 =back
3946
3947 Behavior of inactive vs. cancelled edge cases can be adjusted with the
3948 cust_main-status_module configuration option.
3949
3950 =cut
3951
3952 sub status { shift->cust_status(@_); }
3953
3954 sub cust_status {
3955   my $self = shift;
3956   return $self->hashref->{cust_status} if $self->hashref->{cust_status};
3957   for my $status ( FS::cust_main->statuses() ) {
3958     my $method = $status.'_sql';
3959     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3960     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3961     $sth->execute( ($self->custnum) x $numnum )
3962       or die "Error executing 'SELECT $sql': ". $sth->errstr;
3963     if ( $sth->fetchrow_arrayref->[0] ) {
3964       $self->hashref->{cust_status} = $status;
3965       return $status;
3966     }
3967   }
3968 }
3969
3970 =item is_status_delay_cancel
3971
3972 Returns true if customer status is 'suspended'
3973 and all suspended cust_pkg return true for
3974 cust_pkg->is_status_delay_cancel.
3975
3976 This is not a real status, this only meant for hacking display
3977 values, because otherwise treating the customer as suspended is
3978 really the whole point of the delay_cancel option.
3979
3980 =cut
3981
3982 sub is_status_delay_cancel {
3983   my ($self) = @_;
3984   return 0 unless $self->status eq 'suspended';
3985   foreach my $cust_pkg ($self->ncancelled_pkgs) {
3986     return 0 unless $cust_pkg->is_status_delay_cancel;
3987   }
3988   return 1;
3989 }
3990
3991 =item ucfirst_cust_status
3992
3993 =item ucfirst_status
3994
3995 Deprecated, use the cust_status_label method instead.
3996
3997 Returns the status with the first character capitalized.
3998
3999 =cut
4000
4001 sub ucfirst_status {
4002   carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4003   local($ucfirst_nowarn) = 1;
4004   shift->ucfirst_cust_status(@_);
4005 }
4006
4007 sub ucfirst_cust_status {
4008   carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4009   my $self = shift;
4010   ucfirst($self->cust_status);
4011 }
4012
4013 =item cust_status_label
4014
4015 =item status_label
4016
4017 Returns the display label for this status.
4018
4019 =cut
4020
4021 sub status_label { shift->cust_status_label(@_); }
4022
4023 sub cust_status_label {
4024   my $self = shift;
4025   __PACKAGE__->statuslabels->{$self->cust_status};
4026 }
4027
4028 =item statuscolor
4029
4030 Returns a hex triplet color string for this customer's status.
4031
4032 =cut
4033
4034 sub statuscolor { shift->cust_statuscolor(@_); }
4035
4036 sub cust_statuscolor {
4037   my $self = shift;
4038   __PACKAGE__->statuscolors->{$self->cust_status};
4039 }
4040
4041 =item tickets [ STATUS ]
4042
4043 Returns an array of hashes representing the customer's RT tickets.
4044
4045 An optional status (or arrayref or hashref of statuses) may be specified.
4046
4047 =cut
4048
4049 sub tickets {
4050   my $self = shift;
4051   my $status = ( @_ && $_[0] ) ? shift : '';
4052
4053   my $num = $conf->config('cust_main-max_tickets') || 10;
4054   my @tickets = ();
4055
4056   if ( $conf->config('ticket_system') ) {
4057     unless ( $conf->config('ticket_system-custom_priority_field') ) {
4058
4059       @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4060                                                         $num,
4061                                                         undef,
4062                                                         $status,
4063                                                       )
4064                   };
4065
4066     } else {
4067
4068       foreach my $priority (
4069         $conf->config('ticket_system-custom_priority_field-values'), ''
4070       ) {
4071         last if scalar(@tickets) >= $num;
4072         push @tickets,
4073           @{ FS::TicketSystem->customer_tickets( $self->custnum,
4074                                                  $num - scalar(@tickets),
4075                                                  $priority,
4076                                                  $status,
4077                                                )
4078            };
4079       }
4080     }
4081   }
4082   (@tickets);
4083 }
4084
4085 =item appointments [ STATUS ]
4086
4087 Returns an array of hashes representing the customer's RT tickets which
4088 are appointments.
4089
4090 =cut
4091
4092 sub appointments {
4093   my $self = shift;
4094   my $status = ( @_ && $_[0] ) ? shift : '';
4095
4096   return () unless $conf->config('ticket_system');
4097
4098   my $queueid = $conf->config('ticket_system-appointment-queueid');
4099
4100   @{ FS::TicketSystem->customer_tickets( $self->custnum,
4101                                          99,
4102                                          undef,
4103                                          $status,
4104                                          $queueid,
4105                                        )
4106   };
4107 }
4108
4109 # Return services representing svc_accts in customer support packages
4110 sub support_services {
4111   my $self = shift;
4112   my %packages = map { $_ => 1 } $conf->config('support_packages');
4113
4114   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4115     grep { $_->part_svc->svcdb eq 'svc_acct' }
4116     map { $_->cust_svc }
4117     grep { exists $packages{ $_->pkgpart } }
4118     $self->ncancelled_pkgs;
4119
4120 }
4121
4122 # Return a list of latitude/longitude for one of the services (if any)
4123 sub service_coordinates {
4124   my $self = shift;
4125
4126   my @svc_X =
4127     grep { $_->latitude && $_->longitude }
4128     map { $_->svc_x }
4129     map { $_->cust_svc }
4130     $self->ncancelled_pkgs;
4131
4132   scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4133 }
4134
4135 =item masked FIELD
4136
4137 Returns a masked version of the named field
4138
4139 =cut
4140
4141 sub masked {
4142 my ($self,$field) = @_;
4143
4144 # Show last four
4145
4146 'x'x(length($self->getfield($field))-4).
4147   substr($self->getfield($field), (length($self->getfield($field))-4));
4148
4149 }
4150
4151 =item payment_history
4152
4153 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4154 cust_credit and cust_refund objects.  Each hashref has the following fields:
4155
4156 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4157
4158 I<date> - value of _date field, unix timestamp
4159
4160 I<date_pretty> - user-friendly date
4161
4162 I<description> - user-friendly description of item
4163
4164 I<amount> - impact of item on user's balance
4165 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4166 Not to be confused with the native 'amount' field in cust_credit, see below.
4167
4168 I<amount_pretty> - includes money char
4169
4170 I<balance> - customer balance, chronologically as of this item
4171
4172 I<balance_pretty> - includes money char
4173
4174 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4175
4176 I<paid> - amount paid for cust_pay records, undef for other types
4177
4178 I<credit> - amount credited for cust_credit records, undef for other types.
4179 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4180
4181 I<refund> - amount refunded for cust_refund records, undef for other types
4182
4183 The four table-specific keys always have positive values, whether they reflect charges or payments.
4184
4185 The following options may be passed to this method:
4186
4187 I<line_items> - if true, returns charges ('Line item') rather than invoices
4188
4189 I<start_date> - unix timestamp, only include records on or after.
4190 If specified, an item of type 'Previous' will also be included.
4191 It does not have table-specific fields.
4192
4193 I<end_date> - unix timestamp, only include records before
4194
4195 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4196
4197 I<conf> - optional already-loaded FS::Conf object.
4198
4199 =cut
4200
4201 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4202 # and also for sending customer statements, which should both be kept customer-friendly.
4203 # If you add anything that shouldn't be passed on through the API or exposed
4204 # to customers, add a new option to include it, don't include it by default
4205 sub payment_history {
4206   my $self = shift;
4207   my $opt = ref($_[0]) ? $_[0] : { @_ };
4208
4209   my $conf = $$opt{'conf'} || new FS::Conf;
4210   my $money_char = $conf->config("money_char") || '$',
4211
4212   #first load entire history,
4213   #need previous to calculate previous balance
4214   #loading after end_date shouldn't hurt too much?
4215   my @history = ();
4216   if ( $$opt{'line_items'} ) {
4217
4218     foreach my $cust_bill ( $self->cust_bill ) {
4219
4220       push @history, {
4221         'type'        => 'Line item',
4222         'description' => $_->desc( $self->locale ).
4223                            ( $_->sdate && $_->edate
4224                                ? ' '. time2str('%d-%b-%Y', $_->sdate).
4225                                  ' To '. time2str('%d-%b-%Y', $_->edate)
4226                                : ''
4227                            ),
4228         'amount'      => sprintf('%.2f', $_->setup + $_->recur ),
4229         'charged'     => sprintf('%.2f', $_->setup + $_->recur ),
4230         'date'        => $cust_bill->_date,
4231         'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4232       }
4233         foreach $cust_bill->cust_bill_pkg;
4234
4235     }
4236
4237   } else {
4238
4239     push @history, {
4240                      'type'        => 'Invoice',
4241                      'description' => 'Invoice #'. $_->display_invnum,
4242                      'amount'      => sprintf('%.2f', $_->charged ),
4243                      'charged'     => sprintf('%.2f', $_->charged ),
4244                      'date'        => $_->_date,
4245                      'date_pretty' => $self->time2str_local('short', $_->_date ),
4246                    }
4247       foreach $self->cust_bill;
4248
4249   }
4250
4251   push @history, {
4252                    'type'        => 'Payment',
4253                    'description' => 'Payment', #XXX type
4254                    'amount'      => sprintf('%.2f', 0 - $_->paid ),
4255                    'paid'        => sprintf('%.2f', $_->paid ),
4256                    'date'        => $_->_date,
4257                    'date_pretty' => $self->time2str_local('short', $_->_date ),
4258                  }
4259     foreach $self->cust_pay;
4260
4261   push @history, {
4262                    'type'        => 'Credit',
4263                    'description' => 'Credit', #more info?
4264                    'amount'      => sprintf('%.2f', 0 -$_->amount ),
4265                    'credit'      => sprintf('%.2f', $_->amount ),
4266                    'date'        => $_->_date,
4267                    'date_pretty' => $self->time2str_local('short', $_->_date ),
4268                  }
4269     foreach $self->cust_credit;
4270
4271   push @history, {
4272                    'type'        => 'Refund',
4273                    'description' => 'Refund', #more info?  type, like payment?
4274                    'amount'      => $_->refund,
4275                    'refund'      => $_->refund,
4276                    'date'        => $_->_date,
4277                    'date_pretty' => $self->time2str_local('short', $_->_date ),
4278                  }
4279     foreach $self->cust_refund;
4280
4281   #put it all in chronological order
4282   @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4283
4284   #calculate balance, filter items outside date range
4285   my $previous = 0;
4286   my $balance = 0;
4287   my @out = ();
4288   foreach my $item (@history) {
4289     last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4290     $balance += $$item{'amount'};
4291     if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4292       $previous += $$item{'amount'};
4293       next;
4294     }
4295     $$item{'balance'} = sprintf("%.2f",$balance);
4296     foreach my $key ( qw(amount balance) ) {
4297       $$item{$key.'_pretty'} = money_pretty($$item{$key});
4298     }
4299     push(@out,$item);
4300   }
4301
4302   # start with previous balance, if there was one
4303   if ($previous) {
4304     my $item = {
4305       'type'        => 'Previous',
4306       'description' => 'Previous balance',
4307       'amount'      => sprintf("%.2f",$previous),
4308       'balance'     => sprintf("%.2f",$previous),
4309       'date'        => $$opt{'start_date'},
4310       'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4311     };
4312     #false laziness with above
4313     foreach my $key ( qw(amount balance) ) {
4314       $$item{$key.'_pretty'} = $$item{$key};
4315       $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4316     }
4317     unshift(@out,$item);
4318   }
4319
4320   @out = reverse @history if $$opt{'reverse_sort'};
4321
4322   return @out;
4323 }
4324
4325 =item save_cust_payby
4326
4327 Saves a new cust_payby for this customer, replacing an existing entry only
4328 in select circumstances.  Does not validate input.
4329
4330 If auto is specified, marks this as the customer's primary method, or the
4331 specified weight.  Existing payment methods have their weight incremented as
4332 appropriate.
4333
4334 If bill_location is specified with auto, also sets location in cust_main.
4335
4336 Will not insert complete duplicates of existing records, or records in which the
4337 only difference from an existing record is to turn off automatic payment (will
4338 return without error.)  Will replace existing records in which the only difference
4339 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4340 Fields marked as preserved are optional, and existing values will not be overwritten with
4341 blanks when replacing.
4342
4343 Accepts the following named parameters:
4344
4345 =over 4
4346
4347 =item payment_payby
4348
4349 either CARD or CHEK
4350
4351 =item auto
4352
4353 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4354
4355 =item weight
4356
4357 optional, set higher than 1 for secondary, etc.
4358
4359 =item payinfo
4360
4361 required
4362
4363 =item paymask
4364
4365 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4366
4367 =item payname
4368
4369 required
4370
4371 =item payip
4372
4373 optional, will be preserved when replacing
4374
4375 =item paydate
4376
4377 CARD only, required
4378
4379 =item bill_location
4380
4381 CARD only, required, FS::cust_location object
4382
4383 =item paystart_month
4384
4385 CARD only, optional, will be preserved when replacing
4386
4387 =item paystart_year
4388
4389 CARD only, optional, will be preserved when replacing
4390
4391 =item payissue
4392
4393 CARD only, optional, will be preserved when replacing
4394
4395 =item paycvv
4396
4397 CARD only, only used if conf cvv-save is set appropriately
4398
4399 =item paytype
4400
4401 CHEK only
4402
4403 =item paystate
4404
4405 CHEK only
4406
4407 =back
4408
4409 =cut
4410
4411 #The code for this option is in place, but it's not currently used
4412 #
4413 # =item replace
4414 #
4415 # existing cust_payby object to be replaced (must match custnum)
4416
4417 # stateid/stateid_state/ss are not currently supported in cust_payby,
4418 # might not even work properly in 4.x, but will need to work here if ever added
4419
4420 sub save_cust_payby {
4421   my $self = shift;
4422   my %opt = @_;
4423
4424   my $old = $opt{'replace'};
4425   my $new = new FS::cust_payby { $old ? $old->hash : () };
4426   return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4427   $new->set( 'custnum' => $self->custnum );
4428
4429   my $payby = $opt{'payment_payby'};
4430   return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4431
4432   # don't allow turning off auto when replacing
4433   $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4434
4435   my @check_existing; # payby relevant to this payment_payby
4436
4437   # set payby based on auto
4438   if ( $payby eq 'CARD' ) {
4439     $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4440     @check_existing = qw( CARD DCRD );
4441   } elsif ( $payby eq 'CHEK' ) {
4442     $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4443     @check_existing = qw( CHEK DCHK );
4444   }
4445
4446   $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4447
4448   # basic fields
4449   $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4450   $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4451   $new->set( 'payname' => $opt{'payname'} );
4452   $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4453
4454   my $conf = new FS::Conf;
4455
4456   # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4457   if ( $payby eq 'CARD' &&
4458        ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4459          || $conf->exists('business-onlinepayment-verification')
4460        )
4461   ) {
4462     $new->set( 'paycvv' => $opt{'paycvv'} );
4463   } else {
4464     $new->set( 'paycvv' => '');
4465   }
4466
4467   local $SIG{HUP} = 'IGNORE';
4468   local $SIG{INT} = 'IGNORE';
4469   local $SIG{QUIT} = 'IGNORE';
4470   local $SIG{TERM} = 'IGNORE';
4471   local $SIG{TSTP} = 'IGNORE';
4472   local $SIG{PIPE} = 'IGNORE';
4473
4474   my $oldAutoCommit = $FS::UID::AutoCommit;
4475   local $FS::UID::AutoCommit = 0;
4476   my $dbh = dbh;
4477
4478   # set fields specific to payment_payby
4479   if ( $payby eq 'CARD' ) {
4480     if ($opt{'bill_location'}) {
4481       $opt{'bill_location'}->set('custnum' => $self->custnum);
4482       my $error = $opt{'bill_location'}->find_or_insert;
4483       if ( $error ) {
4484         $dbh->rollback if $oldAutoCommit;
4485         return $error;
4486       }
4487       $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4488     }
4489     foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4490       $new->set( $field => $opt{$field} );
4491     }
4492   } else {
4493     foreach my $field ( qw(paytype paystate) ) {
4494       $new->set( $field => $opt{$field} );
4495     }
4496   }
4497
4498   # other cust_payby to compare this to
4499   my @existing = $self->cust_payby(@check_existing);
4500
4501   # fields that can overwrite blanks with values, but not values with blanks
4502   my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4503
4504   my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4505   unless ($old) {
4506     # generally, we don't want to overwrite existing cust_payby with this,
4507     # but we can replace if we're only marking it auto or adding a preserved field
4508     # and we can avoid saving a total duplicate or merely turning off auto
4509 PAYBYLOOP:
4510     foreach my $cust_payby (@existing) {
4511       # check fields that absolutely should not change
4512       foreach my $field ($new->fields) {
4513         next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4514         next if grep(/^$field$/, @preserve );
4515         next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4516       }
4517       # now check fields that can replace if one value is blank
4518       my $replace = 0;
4519       foreach my $field (@preserve) {
4520         if (
4521           ( $new->get($field) and !$cust_payby->get($field) ) or
4522           ( $cust_payby->get($field) and !$new->get($field) )
4523         ) {
4524           # prevention of overwriting values with blanks happens farther below
4525           $replace = 1;
4526         } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4527           next PAYBYLOOP;
4528         }
4529       }
4530       unless ( $replace ) {
4531         # nearly identical, now check weight
4532         if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4533           # ignore identical cust_payby, and ignore attempts to turn off auto
4534           # no need to save or re-weight cust_payby (but still need to update/commit $self)
4535           $skip_cust_payby = 1;
4536           last PAYBYLOOP;
4537         }
4538         # otherwise, only change is to mark this as primary
4539       }
4540       # if we got this far, we're definitely replacing
4541       $old = $cust_payby;
4542       last PAYBYLOOP;
4543     } #PAYBYLOOP
4544   }
4545
4546   if ($old) {
4547     $new->set( 'custpaybynum' => $old->custpaybynum );
4548     # don't turn off automatic payment (but allow it to be turned on)
4549     if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4550       $opt{'auto'} = 1;
4551       $new->set( 'payby' => $old->payby );
4552       $new->set( 'weight' => 1 );
4553     }
4554     # make sure we're not overwriting values with blanks
4555     foreach my $field (@preserve) {
4556       if ( $old->get($field) and !$new->get($field) ) {
4557         $new->set( $field => $old->get($field) );
4558       }
4559     }
4560   }
4561
4562   # only overwrite cust_main bill_location if auto
4563   if ($opt{'auto'} && $opt{'bill_location'}) {
4564     $self->set('bill_location' => $opt{'bill_location'});
4565     my $error = $self->replace;
4566     if ( $error ) {
4567       $dbh->rollback if $oldAutoCommit;
4568       return $error;
4569     }
4570   }
4571
4572   # done with everything except reweighting and saving cust_payby
4573   # still need to commit changes to cust_main and cust_location
4574   if ($skip_cust_payby) {
4575     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4576     return '';
4577   }
4578
4579   # re-weight existing primary cust_pay for this payby
4580   if ($opt{'auto'}) {
4581     foreach my $cust_payby (@existing) {
4582       # relies on cust_payby return order
4583       last unless $cust_payby->payby !~ /^D/;
4584       last if $cust_payby->weight > 1;
4585       next if $new->custpaybynum eq $cust_payby->custpaybynum;
4586       next if $cust_payby->weight < ($opt{'weight'} || 1);
4587       $cust_payby->weight( $cust_payby->weight + 1 );
4588       my $error = $cust_payby->replace;
4589       if ( $error ) {
4590         $dbh->rollback if $oldAutoCommit;
4591         return "Error reweighting cust_payby: $error";
4592       }
4593     }
4594   }
4595
4596   # finally, save cust_payby
4597   my $error = $old ? $new->replace($old) : $new->insert;
4598   if ( $error ) {
4599     $dbh->rollback if $oldAutoCommit;
4600     return $error;
4601   }
4602
4603   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4604   '';
4605
4606 }
4607
4608 =item remove_cvv_from_cust_payby PAYINFO
4609
4610 Removes paycvv from associated cust_payby with matching PAYINFO.
4611
4612 =cut
4613
4614 sub remove_cvv_from_cust_payby {
4615   my ($self,$payinfo) = @_;
4616
4617   my $oldAutoCommit = $FS::UID::AutoCommit;
4618   local $FS::UID::AutoCommit = 0;
4619   my $dbh = dbh;
4620
4621   foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
4622     next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
4623     $cust_payby->paycvv('');
4624     my $error = $cust_payby->replace;
4625     if ($error) {
4626       $dbh->rollback if $oldAutoCommit;
4627       return $error;
4628     }
4629   }
4630
4631   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4632   '';
4633 }
4634
4635 =back
4636
4637 =head1 CLASS METHODS
4638
4639 =over 4
4640
4641 =item statuses
4642
4643 Class method that returns the list of possible status strings for customers
4644 (see L<the status method|/status>).  For example:
4645
4646   @statuses = FS::cust_main->statuses();
4647
4648 =cut
4649
4650 sub statuses {
4651   my $self = shift;
4652   keys %{ $self->statuscolors };
4653 }
4654
4655 =item cust_status_sql
4656
4657 Returns an SQL fragment to determine the status of a cust_main record, as a
4658 string.
4659
4660 =cut
4661
4662 sub cust_status_sql {
4663   my $sql = 'CASE';
4664   for my $status ( FS::cust_main->statuses() ) {
4665     my $method = $status.'_sql';
4666     $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4667   }
4668   $sql .= ' END';
4669   return $sql;
4670 }
4671
4672
4673 =item prospect_sql
4674
4675 Returns an SQL expression identifying prospective cust_main records (customers
4676 with no packages ever ordered)
4677
4678 =cut
4679
4680 use vars qw($select_count_pkgs);
4681 $select_count_pkgs =
4682   "SELECT COUNT(*) FROM cust_pkg
4683     WHERE cust_pkg.custnum = cust_main.custnum";
4684
4685 sub select_count_pkgs_sql {
4686   $select_count_pkgs;
4687 }
4688
4689 sub prospect_sql {
4690   " 0 = ( $select_count_pkgs ) ";
4691 }
4692
4693 =item ordered_sql
4694
4695 Returns an SQL expression identifying ordered cust_main records (customers with
4696 no active packages, but recurring packages not yet setup or one time charges
4697 not yet billed).
4698
4699 =cut
4700
4701 sub ordered_sql {
4702   FS::cust_main->none_active_sql.
4703   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4704 }
4705
4706 =item active_sql
4707
4708 Returns an SQL expression identifying active cust_main records (customers with
4709 active recurring packages).
4710
4711 =cut
4712
4713 sub active_sql {
4714   " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4715 }
4716
4717 =item none_active_sql
4718
4719 Returns an SQL expression identifying cust_main records with no active
4720 recurring packages.  This includes customers of status prospect, ordered,
4721 inactive, and suspended.
4722
4723 =cut
4724
4725 sub none_active_sql {
4726   " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4727 }
4728
4729 =item inactive_sql
4730
4731 Returns an SQL expression identifying inactive cust_main records (customers with
4732 no active recurring packages, but otherwise unsuspended/uncancelled).
4733
4734 =cut
4735
4736 sub inactive_sql {
4737   FS::cust_main->none_active_sql.
4738   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4739 }
4740
4741 =item susp_sql
4742 =item suspended_sql
4743
4744 Returns an SQL expression identifying suspended cust_main records.
4745
4746 =cut
4747
4748
4749 sub suspended_sql { susp_sql(@_); }
4750 sub susp_sql {
4751   FS::cust_main->none_active_sql.
4752   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4753 }
4754
4755 =item cancel_sql
4756 =item cancelled_sql
4757
4758 Returns an SQL expression identifying cancelled cust_main records.
4759
4760 =cut
4761
4762 sub cancel_sql { shift->cancelled_sql(@_); }
4763
4764 =item uncancel_sql
4765 =item uncancelled_sql
4766
4767 Returns an SQL expression identifying un-cancelled cust_main records.
4768
4769 =cut
4770
4771 sub uncancelled_sql { uncancel_sql(@_); }
4772 sub uncancel_sql { "
4773   ( 0 < ( $select_count_pkgs
4774                    AND ( cust_pkg.cancel IS NULL
4775                          OR cust_pkg.cancel = 0
4776                        )
4777         )
4778     OR 0 = ( $select_count_pkgs )
4779   )
4780 "; }
4781
4782 =item balance_sql
4783
4784 Returns an SQL fragment to retreive the balance.
4785
4786 =cut
4787
4788 sub balance_sql { "
4789     ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4790         WHERE cust_bill.custnum   = cust_main.custnum     )
4791   - ( SELECT COALESCE( SUM(paid),    0 ) FROM cust_pay
4792         WHERE cust_pay.custnum    = cust_main.custnum     )
4793   - ( SELECT COALESCE( SUM(amount),  0 ) FROM cust_credit
4794         WHERE cust_credit.custnum = cust_main.custnum     )
4795   + ( SELECT COALESCE( SUM(refund),  0 ) FROM cust_refund
4796         WHERE cust_refund.custnum = cust_main.custnum     )
4797 "; }
4798
4799 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4800
4801 Returns an SQL fragment to retreive the balance for this customer, optionally
4802 considering invoices with date earlier than START_TIME, and not
4803 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4804 total_unapplied_payments).
4805
4806 Times are specified as SQL fragments or numeric
4807 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
4808 L<Date::Parse> for conversion functions.  The empty string can be passed
4809 to disable that time constraint completely.
4810
4811 Available options are:
4812
4813 =over 4
4814
4815 =item unapplied_date
4816
4817 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)
4818
4819 =item total
4820
4821 (unused.  obsolete?)
4822 set to true to remove all customer comparison clauses, for totals
4823
4824 =item where
4825
4826 (unused.  obsolete?)
4827 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4828
4829 =item join
4830
4831 (unused.  obsolete?)
4832 JOIN clause (typically used with the total option)
4833
4834 =item cutoff
4835
4836 An absolute cutoff time.  Payments, credits, and refunds I<applied> after this
4837 time will be ignored.  Note that START_TIME and END_TIME only limit the date
4838 range for invoices and I<unapplied> payments, credits, and refunds.
4839
4840 =back
4841
4842 =cut
4843
4844 sub balance_date_sql {
4845   my( $class, $start, $end, %opt ) = @_;
4846
4847   my $cutoff = $opt{'cutoff'};
4848
4849   my $owed         = FS::cust_bill->owed_sql($cutoff);
4850   my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4851   my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4852   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
4853
4854   my $j = $opt{'join'} || '';
4855
4856   my $owed_wh   = $class->_money_table_where( 'cust_bill',   $start,$end,%opt );
4857   my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4858   my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4859   my $pay_wh    = $class->_money_table_where( 'cust_pay',    $start,$end,%opt );
4860
4861   "   ( SELECT COALESCE(SUM($owed),         0) FROM cust_bill   $j $owed_wh   )
4862     + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4863     - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4864     - ( SELECT COALESCE(SUM($unapp_pay),    0) FROM cust_pay    $j $pay_wh    )
4865   ";
4866
4867 }
4868
4869 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4870
4871 Returns an SQL fragment to retreive the total unapplied payments for this
4872 customer, only considering payments with date earlier than START_TIME, and
4873 optionally not later than END_TIME.
4874
4875 Times are specified as SQL fragments or numeric
4876 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
4877 L<Date::Parse> for conversion functions.  The empty string can be passed
4878 to disable that time constraint completely.
4879
4880 Available options are:
4881
4882 =cut
4883
4884 sub unapplied_payments_date_sql {
4885   my( $class, $start, $end, %opt ) = @_;
4886
4887   my $cutoff = $opt{'cutoff'};
4888
4889   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
4890
4891   my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4892                                                           'unapplied_date'=>1 );
4893
4894   " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4895 }
4896
4897 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4898
4899 Helper method for balance_date_sql; name (and usage) subject to change
4900 (suggestions welcome).
4901
4902 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4903 cust_refund, cust_credit or cust_pay).
4904
4905 If TABLE is "cust_bill" or the unapplied_date option is true, only
4906 considers records with date earlier than START_TIME, and optionally not
4907 later than END_TIME .
4908
4909 =cut
4910
4911 sub _money_table_where {
4912   my( $class, $table, $start, $end, %opt ) = @_;
4913
4914   my @where = ();
4915   push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4916   if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4917     push @where, "$table._date <= $start" if defined($start) && length($start);
4918     push @where, "$table._date >  $end"   if defined($end)   && length($end);
4919   }
4920   push @where, @{$opt{'where'}} if $opt{'where'};
4921   my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4922
4923   $where;
4924
4925 }
4926
4927 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4928 use FS::cust_main::Search;
4929 sub search {
4930   my $class = shift;
4931   FS::cust_main::Search->search(@_);
4932 }
4933
4934 =back
4935
4936 =head1 SUBROUTINES
4937
4938 =over 4
4939
4940 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4941
4942 Generates a templated notification to the customer (see L<Text::Template>).
4943
4944 OPTIONS is a hash and may include
4945
4946 I<extra_fields> - a hashref of name/value pairs which will be substituted
4947    into the template.  These values may override values mentioned below
4948    and those from the customer record.
4949
4950 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
4951
4952 The following variables are available in the template instead of or in addition
4953 to the fields of the customer record.
4954
4955 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4956
4957 =cut
4958
4959 # a lot like cust_bill::print_latex
4960 sub generate_letter {
4961   my ($self, $template, %options) = @_;
4962
4963   warn "Template $template does not exist" && return
4964     unless $conf->exists($template) || $options{'template_text'};
4965
4966   my $template_source = $options{'template_text'}
4967                         ? [ $options{'template_text'} ]
4968                         : [ map "$_\n", $conf->config($template) ];
4969
4970   my $letter_template = new Text::Template
4971                         ( TYPE       => 'ARRAY',
4972                           SOURCE     => $template_source,
4973                           DELIMITERS => [ '[@--', '--@]' ],
4974                         )
4975     or die "can't create new Text::Template object: Text::Template::ERROR";
4976
4977   $letter_template->compile()
4978     or die "can't compile template: Text::Template::ERROR";
4979
4980   my %letter_data = map { $_ => $self->$_ } $self->fields;
4981
4982   for (keys %{$options{extra_fields}}){
4983     $letter_data{$_} = $options{extra_fields}->{$_};
4984   }
4985
4986   unless(exists($letter_data{returnaddress})){
4987     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4988                                                   $self->agent_template)
4989                      );
4990     if ( length($retadd) ) {
4991       $letter_data{returnaddress} = $retadd;
4992     } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4993       $letter_data{returnaddress} =
4994         join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4995                           s/$/\\\\\*/;
4996                           $_;
4997                         }
4998                     ( $conf->config('company_name', $self->agentnum),
4999                       $conf->config('company_address', $self->agentnum),
5000                     )
5001         );
5002     } else {
5003       $letter_data{returnaddress} = '~';
5004     }
5005   }
5006
5007   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5008
5009   $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5010
5011   my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5012
5013   my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5014                            DIR      => $dir,
5015                            SUFFIX   => '.eps',
5016                            UNLINK   => 0,
5017                          ) or die "can't open temp file: $!\n";
5018   print $lh $conf->config_binary('logo.eps', $self->agentnum)
5019     or die "can't write temp file: $!\n";
5020   close $lh;
5021   $letter_data{'logo_file'} = $lh->filename;
5022
5023   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5024                            DIR      => $dir,
5025                            SUFFIX   => '.tex',
5026                            UNLINK   => 0,
5027                          ) or die "can't open temp file: $!\n";
5028
5029   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5030   close $fh;
5031   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5032   return ($1, $letter_data{'logo_file'});
5033
5034 }
5035
5036 =item print_ps TEMPLATE
5037
5038 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5039
5040 =cut
5041
5042 sub print_ps {
5043   my $self = shift;
5044   my($file, $lfile) = $self->generate_letter(@_);
5045   my $ps = FS::Misc::generate_ps($file);
5046   unlink($file.'.tex');
5047   unlink($lfile);
5048
5049   $ps;
5050 }
5051
5052 =item print TEMPLATE
5053
5054 Prints the filled in template.
5055
5056 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5057
5058 =cut
5059
5060 sub queueable_print {
5061   my %opt = @_;
5062
5063   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5064     or die "invalid customer number: " . $opt{custnum};
5065
5066 #do not backport this change to 3.x
5067 #  my $error = $self->print( { 'template' => $opt{template} } );
5068   my $error = $self->print( $opt{'template'} );
5069   die $error if $error;
5070 }
5071
5072 sub print {
5073   my ($self, $template) = (shift, shift);
5074   do_print(
5075     [ $self->print_ps($template) ],
5076     'agentnum' => $self->agentnum,
5077   );
5078 }
5079
5080 #these three subs should just go away once agent stuff is all config overrides
5081
5082 sub agent_template {
5083   my $self = shift;
5084   $self->_agent_plandata('agent_templatename');
5085 }
5086
5087 sub agent_invoice_from {
5088   my $self = shift;
5089   $self->_agent_plandata('agent_invoice_from');
5090 }
5091
5092 sub _agent_plandata {
5093   my( $self, $option ) = @_;
5094
5095   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
5096   #agent-specific Conf
5097
5098   use FS::part_event::Condition;
5099
5100   my $agentnum = $self->agentnum;
5101
5102   my $regexp = regexp_sql();
5103
5104   my $part_event_option =
5105     qsearchs({
5106       'select'    => 'part_event_option.*',
5107       'table'     => 'part_event_option',
5108       'addl_from' => q{
5109         LEFT JOIN part_event USING ( eventpart )
5110         LEFT JOIN part_event_option AS peo_agentnum
5111           ON ( part_event.eventpart = peo_agentnum.eventpart
5112                AND peo_agentnum.optionname = 'agentnum'
5113                AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5114              )
5115         LEFT JOIN part_event_condition
5116           ON ( part_event.eventpart = part_event_condition.eventpart
5117                AND part_event_condition.conditionname = 'cust_bill_age'
5118              )
5119         LEFT JOIN part_event_condition_option
5120           ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5121                AND part_event_condition_option.optionname = 'age'
5122              )
5123       },
5124       #'hashref'   => { 'optionname' => $option },
5125       #'hashref'   => { 'part_event_option.optionname' => $option },
5126       'extra_sql' =>
5127         " WHERE part_event_option.optionname = ". dbh->quote($option).
5128         " AND action = 'cust_bill_send_agent' ".
5129         " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5130         " AND peo_agentnum.optionname = 'agentnum' ".
5131         " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5132         " ORDER BY
5133            CASE WHEN part_event_condition_option.optionname IS NULL
5134            THEN -1
5135            ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5136         " END
5137           , part_event.weight".
5138         " LIMIT 1"
5139     });
5140
5141   unless ( $part_event_option ) {
5142     return $self->agent->invoice_template || ''
5143       if $option eq 'agent_templatename';
5144     return '';
5145   }
5146
5147   $part_event_option->optionvalue;
5148
5149 }
5150
5151 sub process_o2m_qsearch {
5152   my $self = shift;
5153   my $table = shift;
5154   return qsearch($table, @_) unless $table eq 'contact';
5155
5156   my $hashref = shift;
5157   my %hash = %$hashref;
5158   ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5159     or die 'guru meditation #4343';
5160
5161   qsearch({ 'table'     => 'contact',
5162             'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5163             'hashref'   => \%hash,
5164             'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5165                            " cust_contact.custnum = $custnum "
5166          });
5167 }
5168
5169 sub process_o2m_qsearchs {
5170   my $self = shift;
5171   my $table = shift;
5172   return qsearchs($table, @_) unless $table eq 'contact';
5173
5174   my $hashref = shift;
5175   my %hash = %$hashref;
5176   ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5177     or die 'guru meditation #2121';
5178
5179   qsearchs({ 'table'     => 'contact',
5180              'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5181              'hashref'   => \%hash,
5182              'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5183                             " cust_contact.custnum = $custnum "
5184           });
5185 }
5186
5187 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5188
5189 Subroutine (not a method), designed to be called from the queue.
5190
5191 Takes a list of options and values.
5192
5193 Pulls up the customer record via the custnum option and calls bill_and_collect.
5194
5195 =cut
5196
5197 sub queued_bill {
5198   my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5199
5200   my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5201   warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5202
5203   #without this errors don't get rolled back
5204   $args{'fatal'} = 1; # runs from job queue, will be caught
5205
5206   $cust_main->bill_and_collect( %args );
5207 }
5208
5209 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5210
5211 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5212 C<collect> part.  This is used in batch tax calculation, where invoice
5213 generation and collection events have to be completely separated.
5214
5215 =cut
5216
5217 sub queued_collect {
5218   my (%args) = @_;
5219   my $cust_main = FS::cust_main->by_key($args{'custnum'});
5220
5221   $cust_main->collect(%args);
5222 }
5223
5224 sub process_bill_and_collect {
5225   my $job = shift;
5226   my $param = shift;
5227   my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5228       or die "custnum '$param->{custnum}' not found!\n";
5229   $param->{'job'}   = $job;
5230   $param->{'fatal'} = 1; # runs from job queue, will be caught
5231   $param->{'retry'} = 1;
5232
5233   $cust_main->bill_and_collect( %$param );
5234 }
5235
5236 #starting to take quite a while for big dbs
5237 #   (JRNL: journaled so it only happens once per database)
5238 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5239 # JRNL seq scan of cust_main on signupdate... index signupdate?  will that help?
5240 # JRNL seq scan of cust_main on paydate... index on substrings?  maybe set an
5241 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5242 # JRNL leading/trailing spaces in first, last, company
5243 # JRNL migrate to cust_payby
5244 # - otaker upgrade?  journal and call it good?  (double check to make sure
5245 #    we're not still setting otaker here)
5246 #
5247 #only going to get worse with new location stuff...
5248
5249 sub _upgrade_data { #class method
5250   my ($class, %opts) = @_;
5251
5252   my @statements = ();
5253
5254   #this seems to be the only expensive one.. why does it take so long?
5255   unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5256     push @statements,
5257       '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';
5258     FS::upgrade_journal->set_done('cust_main__signupdate');
5259   }
5260
5261   my $t = time;
5262   foreach my $sql ( @statements ) {
5263     my $sth = dbh->prepare($sql) or die dbh->errstr;
5264     $sth->execute or die $sth->errstr;
5265     #warn ( (time - $t). " seconds\n" );
5266     #$t = time;
5267   }
5268
5269   local($ignore_expired_card) = 1;
5270   local($ignore_banned_card) = 1;
5271   local($skip_fuzzyfiles) = 1;
5272   local($import) = 1; #prevent automatic geocoding (need its own variable?)
5273
5274   FS::cust_main::Location->_upgrade_data(%opts);
5275
5276   unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5277
5278     foreach my $cust_main ( qsearch({
5279       'table'     => 'cust_main',
5280       'hashref'   => {},
5281       'extra_sql' => 'WHERE '.
5282                        join(' OR ',
5283                          map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '%  %'",
5284                            qw( first last company )
5285                        ),
5286     }) ) {
5287       my $error = $cust_main->replace;
5288       die $error if $error;
5289     }
5290
5291     FS::upgrade_journal->set_done('cust_main__trimspaces');
5292
5293   }
5294
5295   $class->_upgrade_otaker(%opts);
5296
5297 }
5298
5299 =back
5300
5301 =head1 BUGS
5302
5303 The delete method.
5304
5305 The delete method should possibly take an FS::cust_main object reference
5306 instead of a scalar customer number.
5307
5308 Bill and collect options should probably be passed as references instead of a
5309 list.
5310
5311 There should probably be a configuration file with a list of allowed credit
5312 card types.
5313
5314 No multiple currency support (probably a larger project than just this module).
5315
5316 Birthdates rely on negative epoch values.
5317
5318 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5319
5320 =head1 SEE ALSO
5321
5322 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5323 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5324 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
5325
5326 =cut
5327
5328 1;
5329