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