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 vars qw( $DEBUG $me $conf
  21              @encrypted_fields
  22              $import
  23              $ignore_expired_card $ignore_banned_card $ignore_illegal_zip
  24              $ignore_invalid_card
  25              $skip_fuzzyfiles
  26              @paytypes
  27            );
  28 use Carp;
  29 use Scalar::Util qw( blessed );
  30 use Time::Local qw(timelocal);
  31 use Storable qw(thaw);
  32 use MIME::Base64;
  33 use Data::Dumper;
  34 use Tie::IxHash;
  35 use Digest::MD5 qw(md5_base64);
  36 use Date::Format;
  37 #use Date::Manip;
  38 use File::Temp; #qw( tempfile );
  39 use Business::CreditCard 0.28;
  40 use Locale::Country;
  41 use FS::UID qw( dbh driver_name );
  42 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
  43 use FS::Cursor;
  44 use FS::Misc qw( generate_email send_email generate_ps do_print );
  45 use FS::Msgcat qw(gettext);
  46 use FS::CurrentUser;
  47 use FS::TicketSystem;
  48 use FS::payby;
  49 use FS::cust_pkg;
  50 use FS::cust_svc;
  51 use FS::cust_bill;
  52 use FS::cust_bill_void;
  53 use FS::legacy_cust_bill;
  54 use FS::cust_pay;
  55 use FS::cust_pay_pending;
  56 use FS::cust_pay_void;
  57 use FS::cust_pay_batch;
  58 use FS::cust_credit;
  59 use FS::cust_refund;
  60 use FS::part_referral;
  61 use FS::cust_main_county;
  62 use FS::cust_location;
  63 use FS::cust_class;
  64 use FS::cust_main_exemption;
  65 use FS::cust_tax_adjustment;
  66 use FS::cust_tax_location;
  67 use FS::agent_currency;
  68 use FS::cust_main_invoice;
  69 use FS::cust_tag;
  70 use FS::prepay_credit;
  71 use FS::queue;
  72 use FS::part_pkg;
  73 use FS::part_export;
  74 #use FS::cust_event;
  75 use FS::type_pkgs;
  76 use FS::payment_gateway;
  77 use FS::agent_payment_gateway;
  78 use FS::banned_pay;
  79 use FS::cust_main_note;
  80 use FS::cust_attachment;
  81 use FS::contact;
  82 use FS::Locales;
  83 use FS::upgrade_journal;
  84 use FS::sales;
  85 use FS::cust_payby;
  86
  87 # 1 is mostly method/subroutine entry and options
  88 # 2 traces progress of some operations
  89 # 3 is even more information including possibly sensitive data
  90 $DEBUG = 0;
  91 $me = '[FS::cust_main]';
  92
  93 $import = 0;
  94 $ignore_expired_card = 0;
  95 $ignore_banned_card = 0;
  96 $ignore_invalid_card = 0;
  97
  98 $skip_fuzzyfiles = 0;
  99
 100 @encrypted_fields = ('payinfo', 'paycvv');
 101 sub nohistory_fields { ('payinfo', 'paycvv'); }
 102
 103 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
 104
 105 #ask FS::UID to run this stuff for us later
 106 #$FS::UID::callback{'FS::cust_main'} = sub {
 107 install_callback FS::UID sub {
 108   $conf = new FS::Conf;
 109   #yes, need it for stuff below (prolly should be cached)
 110   $ignore_invalid_card = $conf->exists('allow_invalid_cards');
 111 };
 112
 113 sub _cache {
 114   my $self = shift;
 115   my ( $hashref, $cache ) = @_;
 116   if ( exists $hashref->{'pkgnum'} ) {
 117     #@{ $self->{'_pkgnum'} } = ();
 118     my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
 119     $self->{'_pkgnum'} = $subcache;
 120     #push @{ $self->{'_pkgnum'} },
 121     FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
 122   }
 123 }
 124
 125 =head1 NAME
 126
 127 FS::cust_main - Object methods for cust_main records
 128
 129 =head1 SYNOPSIS
 130
 131   use FS::cust_main;
 132
 133   $record = new FS::cust_main \%hash;
 134   $record = new FS::cust_main { 'column' => 'value' };
 135
 136   $error = $record->insert;
 137
 138   $error = $new_record->replace($old_record);
 139
 140   $error = $record->delete;
 141
 142   $error = $record->check;
 143
 144   @cust_pkg = $record->all_pkgs;
 145
 146   @cust_pkg = $record->ncancelled_pkgs;
 147
 148   @cust_pkg = $record->suspended_pkgs;
 149
 150   $error = $record->bill;
 151   $error = $record->bill %options;
 152   $error = $record->bill 'time' => $time;
 153
 154   $error = $record->collect;
 155   $error = $record->collect %options;
 156   $error = $record->collect 'invoice_time'   => $time,
 157                           ;
 158
 159 =head1 DESCRIPTION
 160
 161 An FS::cust_main object represents a customer.  FS::cust_main inherits from
 162 FS::Record.  The following fields are currently supported:
 163
 164 =over 4
 165
 166 =item custnum
 167
 168 Primary key (assigned automatically for new customers)
 169
 170 =item agentnum
 171
 172 Agent (see L<FS::agent>)
 173
 174 =item refnum
 175
 176 Advertising source (see L<FS::part_referral>)
 177
 178 =item first
 179
 180 First name
 181
 182 =item last
 183
 184 Last name
 185
 186 =item ss
 187
 188 Cocial security number (optional)
 189
 190 =item company
 191
 192 (optional)
 193
 194 =item daytime
 195
 196 phone (optional)
 197
 198 =item night
 199
 200 phone (optional)
 201
 202 =item fax
 203
 204 phone (optional)
 205
 206 =item mobile
 207
 208 phone (optional)
 209
 210 =item payby
 211
 212 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
 213
 214 =item payinfo
 215
 216 Payment Information (See L<FS::payinfo_Mixin> for data format)
 217
 218 =item paymask
 219
 220 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
 221
 222 =item paycvv
 223
 224 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
 225
 226 =item paydate
 227
 228 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
 229
 230 =item paystart_month
 231
 232 Start date month (maestro/solo cards only)
 233
 234 =item paystart_year
 235
 236 Start date year (maestro/solo cards only)
 237
 238 =item payissue
 239
 240 Issue number (maestro/solo cards only)
 241
 242 =item payname
 243
 244 Name on card or billing name
 245
 246 =item payip
 247
 248 IP address from which payment information was received
 249
 250 =item tax
 251
 252 Tax exempt, empty or `Y'
 253
 254 =item usernum
 255
 256 Order taker (see L<FS::access_user>)
 257
 258 =item comments
 259
 260 Comments (optional)
 261
 262 =item referral_custnum
 263
 264 Referring customer number
 265
 266 =item spool_cdr
 267
 268 Enable individual CDR spooling, empty or `Y'
 269
 270 =item dundate
 271
 272 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
 273
 274 =item squelch_cdr
 275
 276 Discourage individual CDR printing, empty or `Y'
 277
 278 =item edit_subject
 279
 280 Allow self-service editing of ticket subjects, empty or 'Y'
 281
 282 =item calling_list_exempt
 283
 284 Do not call, empty or 'Y'
 285
 286 =back
 287
 288 =head1 METHODS
 289
 290 =over 4
 291
 292 =item new HASHREF
 293
 294 Creates a new customer.  To add the customer to the database, see L<"insert">.
 295
 296 Note that this stores the hash reference, not a distinct copy of the hash it
 297 points to.  You can ask the object for a copy with the I<hash> method.
 298
 299 =cut
 300
 301 sub table { 'cust_main'; }
 302
 303 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
 304
 305 Adds this customer to the database.  If there is an error, returns the error,
 306 otherwise returns false.
 307
 308 Usually the customer's location will not yet exist in the database, and
 309 the C<bill_location> and C<ship_location> pseudo-fields must be set to
 310 uninserted L<FS::cust_location> objects.  These will be inserted and linked
 311 (in both directions) to the new customer record.  If they're references
 312 to the same object, they will become the same location.
 313
 314 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
 315 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
 316 are inserted atomicly, or the transaction is rolled back.  Passing an empty
 317 hash reference is equivalent to not supplying this parameter.  There should be
 318 a better explanation of this, but until then, here's an example:
 319
 320   use Tie::RefHash;
 321   tie %hash, 'Tie::RefHash'; #this part is important
 322   %hash = (
 323     $cust_pkg => [ $svc_acct ],
 324     ...
 325   );
 326   $cust_main->insert( \%hash );
 327
 328 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
 329 be set as the invoicing list (see L<"invoicing_list">).  Errors return as
 330 expected and rollback the entire transaction; it is not necessary to call
 331 check_invoicing_list first.  The invoicing_list is set after the records in the
 332 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
 333 invoicing_list destination to the newly-created svc_acct.  Here's an example:
 334
 335   $cust_main->insert( {}, [ $email, 'POST' ] );
 336
 337 Currently available options are: I<depend_jobnum>, I<noexport>,
 338 I<tax_exemption> and I<prospectnum>.
 339
 340 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
 341 on the supplied jobnum (they will not run until the specific job completes).
 342 This can be used to defer provisioning until some action completes (such
 343 as running the customer's credit card successfully).
 344
 345 The I<noexport> option is deprecated.  If I<noexport> is set true, no
 346 provisioning jobs (exports) are scheduled.  (You can schedule them later with
 347 the B<reexport> method.)
 348
 349 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
 350 of tax names and exemption numbers.  FS::cust_main_exemption records will be
 351 created and inserted.
 352
 353 If I<prospectnum> is set, moves contacts and locations from that prospect.
 354
 355 If I<contact> is set to an arrayref of FS::contact objects, inserts those
 356 new contacts with this new customer.
 357
 358 =cut
 359
 360 sub insert {
 361   my $self = shift;
 362   my $cust_pkgs = @_ ? shift : {};
 363   my $invoicing_list = @_ ? shift : '';
 364   my %options = @_;
 365   warn "$me insert called with options ".
 366        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
 367     if $DEBUG;
 368
 369   local $SIG{HUP} = 'IGNORE';
 370   local $SIG{INT} = 'IGNORE';
 371   local $SIG{QUIT} = 'IGNORE';
 372   local $SIG{TERM} = 'IGNORE';
 373   local $SIG{TSTP} = 'IGNORE';
 374   local $SIG{PIPE} = 'IGNORE';
 375
 376   my $oldAutoCommit = $FS::UID::AutoCommit;
 377   local $FS::UID::AutoCommit = 0;
 378   my $dbh = dbh;
 379
 380   my $prepay_identifier = '';
 381   my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
 382   my $payby = '';
 383   if ( $self->payby eq 'PREPAY' ) {
 384
 385     $self->payby('BILL');
 386     $prepay_identifier = $self->payinfo;
 387     $self->payinfo('');
 388
 389     warn "  looking up prepaid card $prepay_identifier\n"
 390       if $DEBUG > 1;
 391
 392     my $error = $self->get_prepay( $prepay_identifier,
 393                                    'amount_ref'     => \$amount,
 394                                    'seconds_ref'    => \$seconds,
 395                                    'upbytes_ref'    => \$upbytes,
 396                                    'downbytes_ref'  => \$downbytes,
 397                                    'totalbytes_ref' => \$totalbytes,
 398                                  );
 399     if ( $error ) {
 400       $dbh->rollback if $oldAutoCommit;
 401       #return "error applying prepaid card (transaction rolled back): $error";
 402       return $error;
 403     }
 404
 405     $payby = 'PREP' if $amount;
 406
 407   } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|PPAL)$/ ) {
 408
 409     $payby = $1;
 410     $self->payby('BILL');
 411     $amount = $self->paid;
 412
 413   }
 414
 415   # insert locations
 416   foreach my $l (qw(bill_location ship_location)) {
 417     my $loc = delete $self->hashref->{$l};
 418     # XXX if we're moving a prospect's locations, do that here
 419     if ( !$loc ) {
 420       #return "$l not set";
 421       #location-less customer records are now permitted
 422       next;
 423     }
 424
 425     if ( !$loc->locationnum ) {
 426       # warn the location that we're going to insert it with no custnum
 427       $loc->set(custnum_pending => 1);
 428       warn "  inserting $l\n"
 429         if $DEBUG > 1;
 430       my $error = $loc->insert;
 431       if ( $error ) {
 432         $dbh->rollback if $oldAutoCommit;
 433         my $label = $l eq 'ship_location' ? 'service' : 'billing';
 434         return "$error (in $label location)";
 435       }
 436     }
 437     elsif ( ($loc->custnum || 0) > 0 or $loc->prospectnum ) {
 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_textn('custbatch')
1744     || $self->ut_name('last')
1745     || $self->ut_name('first')
1746     || $self->ut_snumbern('signupdate')
1747     || $self->ut_snumbern('birthdate')
1748     || $self->ut_namen('spouse_last')
1749     || $self->ut_namen('spouse_first')
1750     || $self->ut_snumbern('spouse_birthdate')
1751     || $self->ut_snumbern('anniversary_date')
1752     || $self->ut_textn('company')
1753     || $self->ut_textn('ship_company')
1754     || $self->ut_anything('comments')
1755     || $self->ut_numbern('referral_custnum')
1756     || $self->ut_textn('stateid')
1757     || $self->ut_textn('stateid_state')
1758     || $self->ut_textn('invoice_terms')
1759     || $self->ut_floatn('cdr_termination_percentage')
1760     || $self->ut_floatn('credit_limit')
1761     || $self->ut_numbern('billday')
1762     || $self->ut_numbern('prorate_day')
1763     || $self->ut_flag('edit_subject')
1764     || $self->ut_flag('calling_list_exempt')
1765     || $self->ut_flag('invoice_noemail')
1766     || $self->ut_flag('message_noemail')
1767     || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1768     || $self->ut_currencyn('currency')
1769   ;
1770
1771   foreach (qw(company ship_company)) {
1772     my $company = $self->get($_);
1773     $company =~ s/^\s+//;
1774     $company =~ s/\s+$//;
1775     $company =~ s/\s+/ /g;
1776     $self->set($_, $company);
1777   }
1778
1779   #barf.  need message catalogs.  i18n.  etc.
1780   $error .= "Please select an advertising source."
1781     if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1782   return $error if $error;
1783
1784   my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1785     or return "Unknown agent";
1786
1787   if ( $self->currency ) {
1788     my $agent_currency = qsearchs( 'agent_currency', {
1789       'agentnum' => $agent->agentnum,
1790       'currency' => $self->currency,
1791     })
1792       or return "Agent ". $agent->agent.
1793                 " not permitted to offer ".  $self->currency. " invoicing";
1794   }
1795
1796   return "Unknown refnum"
1797     unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1798
1799   return "Unknown referring custnum: ". $self->referral_custnum
1800     unless ! $self->referral_custnum
1801            || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1802
1803   if ( $self->ss eq '' ) {
1804     $self->ss('');
1805   } else {
1806     my $ss = $self->ss;
1807     $ss =~ s/\D//g;
1808     $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1809       or return "Illegal social security number: ". $self->ss;
1810     $self->ss("$1-$2-$3");
1811   }
1812
1813   # cust_main_county verification now handled by cust_location check
1814
1815   $error =
1816        $self->ut_phonen('daytime', $self->country)
1817     || $self->ut_phonen('night',   $self->country)
1818     || $self->ut_phonen('fax',     $self->country)
1819     || $self->ut_phonen('mobile',  $self->country)
1820   ;
1821   return $error if $error;
1822
1823   if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1824        && ! $import
1825        && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1826      ) {
1827
1828     my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1829                           ? 'Day Phone'
1830                           : FS::Msgcat::_gettext('daytime');
1831     my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1832                         ? 'Night Phone'
1833                         : FS::Msgcat::_gettext('night');
1834
1835     my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1836                         ? 'Mobile Phone'
1837                         : FS::Msgcat::_gettext('mobile');
1838
1839     return "$daytime_label, $night_label or $mobile_label is required"
1840
1841   }
1842
1843   ### start of stuff moved to cust_payby
1844   # then mostly kept here to support upgrades (can remove in 5.x)
1845   #  but modified to allow everything to be empty
1846
1847   if ( $self->payby ) {
1848     FS::payby->can_payby($self->table, $self->payby)
1849       or return "Illegal payby: ". $self->payby;
1850   } else {
1851     $self->payby('');
1852   }
1853
1854   $error =    $self->ut_numbern('paystart_month')
1855            || $self->ut_numbern('paystart_year')
1856            || $self->ut_numbern('payissue')
1857            || $self->ut_textn('paytype')
1858   ;
1859   return $error if $error;
1860
1861   if ( $self->payip eq '' ) {
1862     $self->payip('');
1863   } else {
1864     $error = $self->ut_ip('payip');
1865     return $error if $error;
1866   }
1867
1868   # If it is encrypted and the private key is not availaible then we can't
1869   # check the credit card.
1870   my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1871
1872   # Need some kind of global flag to accept invalid cards, for testing
1873   # on scrubbed data.
1874   if ( !$import && !$ignore_invalid_card && $check_payinfo &&
1875     $self->payby =~ /^(CARD|DCRD)$/ ) {
1876
1877     my $payinfo = $self->payinfo;
1878     $payinfo =~ s/\D//g;
1879     $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1880       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1881     $payinfo = $1;
1882     $self->payinfo($payinfo);
1883     validate($payinfo)
1884       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1885
1886     return gettext('unknown_card_type')
1887       if $self->payinfo !~ /^99\d{14}$/ #token
1888       && cardtype($self->payinfo) eq "Unknown";
1889
1890     unless ( $ignore_banned_card ) {
1891       my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1892       if ( $ban ) {
1893         if ( $ban->bantype eq 'warn' ) {
1894           #or others depending on value of $ban->reason ?
1895           return '_duplicate_card'.
1896                  ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1897                  ' until '.         time2str('%a %h %o at %r', $ban->_end_date).
1898                  ' (ban# '. $ban->bannum. ')'
1899             unless $self->override_ban_warn;
1900         } else {
1901           return 'Banned credit card: banned on '.
1902                  time2str('%a %h %o at %r', $ban->_date).
1903                  ' by '. $ban->otaker.
1904                  ' (ban# '. $ban->bannum. ')';
1905         }
1906       }
1907     }
1908
1909     if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1910       if ( cardtype($self->payinfo) eq 'American Express card' ) {
1911         $self->paycvv =~ /^(\d{4})$/
1912           or return "CVV2 (CID) for American Express cards is four digits.";
1913         $self->paycvv($1);
1914       } else {
1915         $self->paycvv =~ /^(\d{3})$/
1916           or return "CVV2 (CVC2/CID) is three digits.";
1917         $self->paycvv($1);
1918       }
1919     } else {
1920       $self->paycvv('');
1921     }
1922
1923     my $cardtype = cardtype($payinfo);
1924     if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1925
1926       return "Start date or issue number is required for $cardtype cards"
1927         unless $self->paystart_month && $self->paystart_year or $self->payissue;
1928
1929       return "Start month must be between 1 and 12"
1930         if $self->paystart_month
1931            and $self->paystart_month < 1 || $self->paystart_month > 12;
1932
1933       return "Start year must be 1990 or later"
1934         if $self->paystart_year
1935            and $self->paystart_year < 1990;
1936
1937       return "Issue number must be beween 1 and 99"
1938         if $self->payissue
1939           and $self->payissue < 1 || $self->payissue > 99;
1940
1941     } else {
1942       $self->paystart_month('');
1943       $self->paystart_year('');
1944       $self->payissue('');
1945     }
1946
1947   } elsif ( !$ignore_invalid_card && $check_payinfo &&
1948     $self->payby =~ /^(CHEK|DCHK)$/ ) {
1949
1950     my $payinfo = $self->payinfo;
1951     $payinfo =~ s/[^\d\@\.]//g;
1952     if ( $conf->config('echeck-country') eq 'CA' ) {
1953       $payinfo =~ /^(\d+)\@(\d{5})\.(\d{3})$/
1954         or return 'invalid echeck account@branch.bank';
1955       $payinfo = "$1\@$2.$3";
1956     } elsif ( $conf->config('echeck-country') eq 'US' ) {
1957       $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1958       $payinfo = "$1\@$2";
1959     } else {
1960       $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@routing';
1961       $payinfo = "$1\@$2";
1962     }
1963     $self->payinfo($payinfo);
1964     $self->paycvv('');
1965
1966     unless ( $ignore_banned_card ) {
1967       my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1968       if ( $ban ) {
1969         if ( $ban->bantype eq 'warn' ) {
1970           #or others depending on value of $ban->reason ?
1971           return '_duplicate_ach' unless $self->override_ban_warn;
1972         } else {
1973           return 'Banned ACH account: banned on '.
1974                  time2str('%a %h %o at %r', $ban->_date).
1975                  ' by '. $ban->otaker.
1976                  ' (ban# '. $ban->bannum. ')';
1977         }
1978       }
1979     }
1980
1981   } elsif ( $self->payby eq 'LECB' ) {
1982
1983     my $payinfo = $self->payinfo;
1984     $payinfo =~ s/\D//g;
1985     $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1986     $payinfo = $1;
1987     $self->payinfo($payinfo);
1988     $self->paycvv('');
1989
1990   } elsif ( $self->payby eq 'BILL' ) {
1991
1992     $error = $self->ut_textn('payinfo');
1993     return "Illegal P.O. number: ". $self->payinfo if $error;
1994     $self->paycvv('');
1995
1996   } elsif ( $self->payby eq 'COMP' ) {
1997
1998     my $curuser = $FS::CurrentUser::CurrentUser;
1999     if (    ! $self->custnum
2000          && ! $curuser->access_right('Complimentary customer')
2001        )
2002     {
2003       return "You are not permitted to create complimentary accounts."
2004     }
2005
2006     $error = $self->ut_textn('payinfo');
2007     return "Illegal comp account issuer: ". $self->payinfo if $error;
2008     $self->paycvv('');
2009
2010   } elsif ( $self->payby eq 'PREPAY' ) {
2011
2012     my $payinfo = $self->payinfo;
2013     $payinfo =~ s/\W//g; #anything else would just confuse things
2014     $self->payinfo($payinfo);
2015     $error = $self->ut_alpha('payinfo');
2016     return "Illegal prepayment identifier: ". $self->payinfo if $error;
2017     return "Unknown prepayment identifier"
2018       unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2019     $self->paycvv('');
2020
2021   }
2022
2023   if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2024     return "Expiration date required"
2025       # shouldn't payinfo_check do this?
2026       unless ! $self->payby
2027             || $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD|PPAL)$/;
2028     $self->paydate('');
2029   } else {
2030     my( $m, $y );
2031     if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2032       ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2033     } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2034       ( $m, $y ) = ( $2, "19$1" );
2035     } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2036       ( $m, $y ) = ( $3, "20$2" );
2037     } else {
2038       return "Illegal expiration date: ". $self->paydate;
2039     }
2040     $m = sprintf('%02d',$m);
2041     $self->paydate("$y-$m-01");
2042     my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2043     return gettext('expired_card')
2044       if !$import
2045       && !$ignore_expired_card
2046       && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2047   }
2048
2049   if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2050        ( ! $conf->exists('require_cardname')
2051          || $self->payby !~ /^(CARD|DCRD)$/  )
2052   ) {
2053     $self->payname( $self->first. " ". $self->getfield('last') );
2054   } else {
2055
2056     if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2057       $self->payname =~ /^([\w \,\.\-\']*)$/
2058         or return gettext('illegal_name'). " payname: ". $self->payname;
2059       $self->payname($1);
2060     } else {
2061       $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2062         or return gettext('illegal_name'). " payname: ". $self->payname;
2063       $self->payname($1);
2064     }
2065
2066   }
2067
2068   ### end of stuff moved to cust_payby
2069
2070   return "Please select an invoicing locale"
2071     if ! $self->locale
2072     && ! $self->custnum
2073     && $conf->exists('cust_main-require_locale');
2074
2075   foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2076     $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2077     $self->$flag($1);
2078   }
2079
2080   $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2081
2082   warn "$me check AFTER: \n". $self->_dump
2083     if $DEBUG > 2;
2084
2085   $self->SUPER::check;
2086 }
2087
2088 =item addr_fields
2089
2090 Returns a list of fields which have ship_ duplicates.
2091
2092 =cut
2093
2094 sub addr_fields {
2095   qw( last first company
2096       address1 address2 city county state zip country
2097       latitude longitude
2098       daytime night fax mobile
2099     );
2100 }
2101
2102 =item has_ship_address
2103
2104 Returns true if this customer record has a separate shipping address.
2105
2106 =cut
2107
2108 sub has_ship_address {
2109   my $self = shift;
2110   $self->bill_locationnum != $self->ship_locationnum;
2111 }
2112
2113 =item location_hash
2114
2115 Returns a list of key/value pairs, with the following keys: address1,
2116 adddress2, city, county, state, zip, country, district, and geocode.  The
2117 shipping address is used if present.
2118
2119 =cut
2120
2121 sub location_hash {
2122   my $self = shift;
2123   $self->ship_location->location_hash;
2124 }
2125
2126 =item cust_location
2127
2128 Returns all locations (see L<FS::cust_location>) for this customer.
2129
2130 =cut
2131
2132 sub cust_location {
2133   my $self = shift;
2134   qsearch('cust_location', { 'custnum'     => $self->custnum,
2135                              'prospectnum' => '' } );
2136 }
2137
2138 =item cust_contact
2139
2140 Returns all contacts (see L<FS::contact>) for this customer.
2141
2142 =cut
2143
2144 #already used :/ sub contact {
2145 sub cust_contact {
2146   my $self = shift;
2147   qsearch('contact', { 'custnum' => $self->custnum } );
2148 }
2149
2150 =item cust_payby
2151
2152 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2153
2154 =cut
2155
2156 sub cust_payby {
2157   my $self = shift;
2158   qsearch({
2159     'table'    => 'cust_payby',
2160     'hashref'  => { 'custnum' => $self->custnum },
2161     'order_by' => 'ORDER BY weight ASC',
2162   });
2163 }
2164
2165 =item unsuspend
2166
2167 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2168 and L<FS::cust_pkg>) for this customer.  Always returns a list: an empty list
2169 on success or a list of errors.
2170
2171 =cut
2172
2173 sub unsuspend {
2174   my $self = shift;
2175   grep { $_->unsuspend } $self->suspended_pkgs;
2176 }
2177
2178 =item suspend
2179
2180 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2181
2182 Returns a list: an empty list on success or a list of errors.
2183
2184 =cut
2185
2186 sub suspend {
2187   my $self = shift;
2188   grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2189 }
2190
2191 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2192
2193 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2194 PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref instead
2195 of a list of pkgparts; the hashref has the following keys:
2196
2197 =over 4
2198
2199 =item pkgparts - listref of pkgparts
2200
2201 =item (other options are passed to the suspend method)
2202
2203 =back
2204
2205
2206 Returns a list: an empty list on success or a list of errors.
2207
2208 =cut
2209
2210 sub suspend_if_pkgpart {
2211   my $self = shift;
2212   my (@pkgparts, %opt);
2213   if (ref($_[0]) eq 'HASH'){
2214     @pkgparts = @{$_[0]{pkgparts}};
2215     %opt      = %{$_[0]};
2216   }else{
2217     @pkgparts = @_;
2218   }
2219   grep { $_->suspend(%opt) }
2220     grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2221       $self->unsuspended_pkgs;
2222 }
2223
2224 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2225
2226 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2227 given PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref
2228 instead of a list of pkgparts; the hashref has the following keys:
2229
2230 =over 4
2231
2232 =item pkgparts - listref of pkgparts
2233
2234 =item (other options are passed to the suspend method)
2235
2236 =back
2237
2238 Returns a list: an empty list on success or a list of errors.
2239
2240 =cut
2241
2242 sub suspend_unless_pkgpart {
2243   my $self = shift;
2244   my (@pkgparts, %opt);
2245   if (ref($_[0]) eq 'HASH'){
2246     @pkgparts = @{$_[0]{pkgparts}};
2247     %opt      = %{$_[0]};
2248   }else{
2249     @pkgparts = @_;
2250   }
2251   grep { $_->suspend(%opt) }
2252     grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2253       $self->unsuspended_pkgs;
2254 }
2255
2256 =item cancel [ OPTION => VALUE ... ]
2257
2258 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2259
2260 Available options are:
2261
2262 =over 4
2263
2264 =item quiet - can be set true to supress email cancellation notices.
2265
2266 =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.
2267
2268 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2269
2270 =item nobill - can be set true to skip billing if it might otherwise be done.
2271
2272 =back
2273
2274 Always returns a list: an empty list on success or a list of errors.
2275
2276 =cut
2277
2278 # nb that dates are not specified as valid options to this method
2279
2280 sub cancel {
2281   my( $self, %opt ) = @_;
2282
2283   warn "$me cancel called on customer ". $self->custnum. " with options ".
2284        join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2285     if $DEBUG;
2286
2287   return ( 'access denied' )
2288     unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2289
2290   if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2291
2292     #should try decryption (we might have the private key)
2293     # and if not maybe queue a job for the server that does?
2294     return ( "Can't (yet) ban encrypted credit cards" )
2295       if $self->is_encrypted($self->payinfo);
2296
2297     my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2298     my $error = $ban->insert;
2299     return ( $error ) if $error;
2300
2301   }
2302
2303   my @pkgs = $self->ncancelled_pkgs;
2304
2305   if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2306     $opt{nobill} = 1;
2307     my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2308     warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2309       if $error;
2310   }
2311
2312   warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2313        scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2314     if $DEBUG;
2315
2316   grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2317 }
2318
2319 sub _banned_pay_hashref {
2320   my $self = shift;
2321
2322   my %payby2ban = (
2323     'CARD' => 'CARD',
2324     'DCRD' => 'CARD',
2325     'CHEK' => 'CHEK',
2326     'DCHK' => 'CHEK'
2327   );
2328
2329   {
2330     'payby'   => $payby2ban{$self->payby},
2331     'payinfo' => $self->payinfo,
2332     #don't ever *search* on reason! #'reason'  =>
2333   };
2334 }
2335
2336 sub _new_banned_pay_hashref {
2337   my $self = shift;
2338   my $hr = $self->_banned_pay_hashref;
2339   $hr->{payinfo} = md5_base64($hr->{payinfo});
2340   $hr;
2341 }
2342
2343 =item notes
2344
2345 Returns all notes (see L<FS::cust_main_note>) for this customer.
2346
2347 =cut
2348
2349 sub notes {
2350   my($self,$orderby_classnum) = (shift,shift);
2351   my $orderby = "_DATE DESC";
2352   $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2353   qsearch( 'cust_main_note',
2354            { 'custnum' => $self->custnum },
2355            '',
2356            "ORDER BY $orderby",
2357          );
2358 }
2359
2360 =item agent
2361
2362 Returns the agent (see L<FS::agent>) for this customer.
2363
2364 =item agent_name
2365
2366 Returns the agent name (see L<FS::agent>) for this customer.
2367
2368 =cut
2369
2370 sub agent_name {
2371   my $self = shift;
2372   $self->agent->agent;
2373 }
2374
2375 =item cust_tag
2376
2377 Returns any tags associated with this customer, as FS::cust_tag objects,
2378 or an empty list if there are no tags.
2379
2380 =item part_tag
2381
2382 Returns any tags associated with this customer, as FS::part_tag objects,
2383 or an empty list if there are no tags.
2384
2385 =cut
2386
2387 sub part_tag {
2388   my $self = shift;
2389   map $_->part_tag, $self->cust_tag;
2390 }
2391
2392
2393 =item cust_class
2394
2395 Returns the customer class, as an FS::cust_class object, or the empty string
2396 if there is no customer class.
2397
2398 =item categoryname
2399
2400 Returns the customer category name, or the empty string if there is no customer
2401 category.
2402
2403 =cut
2404
2405 sub categoryname {
2406   my $self = shift;
2407   my $cust_class = $self->cust_class;
2408   $cust_class
2409     ? $cust_class->categoryname
2410     : '';
2411 }
2412
2413 =item classname
2414
2415 Returns the customer class name, or the empty string if there is no customer
2416 class.
2417
2418 =cut
2419
2420 sub classname {
2421   my $self = shift;
2422   my $cust_class = $self->cust_class;
2423   $cust_class
2424     ? $cust_class->classname
2425     : '';
2426 }
2427
2428 =item BILLING METHODS
2429
2430 Documentation on billing methods has been moved to
2431 L<FS::cust_main::Billing>.
2432
2433 =item REALTIME BILLING METHODS
2434
2435 Documentation on realtime billing methods has been moved to
2436 L<FS::cust_main::Billing_Realtime>.
2437
2438 =item remove_cvv
2439
2440 Removes the I<paycvv> field from the database directly.
2441
2442 If there is an error, returns the error, otherwise returns false.
2443
2444 =cut
2445
2446 sub remove_cvv {
2447   my $self = shift;
2448   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2449     or return dbh->errstr;
2450   $sth->execute($self->custnum)
2451     or return $sth->errstr;
2452   $self->paycvv('');
2453   '';
2454 }
2455
2456 =item batch_card OPTION => VALUE...
2457
2458 Adds a payment for this invoice to the pending credit card batch (see
2459 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2460 runs the payment using a realtime gateway.
2461
2462 Options may include:
2463
2464 B<amount>: the amount to be paid; defaults to the customer's balance minus
2465 any payments in transit.
2466
2467 B<payby>: the payment method; defaults to cust_main.payby
2468
2469 B<realtime>: runs this as a realtime payment instead of adding it to a
2470 batch.  Deprecated.
2471
2472 B<invnum>: sets cust_pay_batch.invnum.
2473
2474 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2475 the billing address for the payment; defaults to the customer's billing
2476 location.
2477
2478 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2479 date, and name; defaults to those fields in cust_main.
2480
2481 =cut
2482
2483 sub batch_card {
2484   my ($self, %options) = @_;
2485
2486   my $amount;
2487   if (exists($options{amount})) {
2488     $amount = $options{amount};
2489   }else{
2490     $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2491   }
2492   return '' unless $amount > 0;
2493
2494   my $invnum = delete $options{invnum};
2495   my $payby = $options{payby} || $self->payby;  #still dubious
2496
2497   if ($options{'realtime'}) {
2498     return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2499                                 $amount,
2500                                 %options,
2501                               );
2502   }
2503
2504   my $oldAutoCommit = $FS::UID::AutoCommit;
2505   local $FS::UID::AutoCommit = 0;
2506   my $dbh = dbh;
2507
2508   #this needs to handle mysql as well as Pg, like svc_acct.pm
2509   #(make it into a common function if folks need to do batching with mysql)
2510   $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2511     or return "Cannot lock pay_batch: " . $dbh->errstr;
2512
2513   my %pay_batch = (
2514     'status' => 'O',
2515     'payby'  => FS::payby->payby2payment($payby),
2516   );
2517   $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2518
2519   my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2520
2521   unless ( $pay_batch ) {
2522     $pay_batch = new FS::pay_batch \%pay_batch;
2523     my $error = $pay_batch->insert;
2524     if ( $error ) {
2525       $dbh->rollback if $oldAutoCommit;
2526       die "error creating new batch: $error\n";
2527     }
2528   }
2529
2530   my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2531       'batchnum' => $pay_batch->batchnum,
2532       'custnum'  => $self->custnum,
2533   } );
2534
2535   foreach (qw( address1 address2 city state zip country latitude longitude
2536                payby payinfo paydate payname ))
2537   {
2538     $options{$_} = '' unless exists($options{$_});
2539   }
2540
2541   my $loc = $self->bill_location;
2542
2543   my $cust_pay_batch = new FS::cust_pay_batch ( {
2544     'batchnum' => $pay_batch->batchnum,
2545     'invnum'   => $invnum || 0,                    # is there a better value?
2546                                                    # this field should be
2547                                                    # removed...
2548                                                    # cust_bill_pay_batch now
2549     'custnum'  => $self->custnum,
2550     'last'     => $self->getfield('last'),
2551     'first'    => $self->getfield('first'),
2552     'address1' => $options{address1} || $loc->address1,
2553     'address2' => $options{address2} || $loc->address2,
2554     'city'     => $options{city}     || $loc->city,
2555     'state'    => $options{state}    || $loc->state,
2556     'zip'      => $options{zip}      || $loc->zip,
2557     'country'  => $options{country}  || $loc->country,
2558     'payby'    => $options{payby}    || $self->payby,
2559     'payinfo'  => $options{payinfo}  || $self->payinfo,
2560     'exp'      => $options{paydate}  || $self->paydate,
2561     'payname'  => $options{payname}  || $self->payname,
2562     'amount'   => $amount,                         # consolidating
2563   } );
2564
2565   $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2566     if $old_cust_pay_batch;
2567
2568   my $error;
2569   if ($old_cust_pay_batch) {
2570     $error = $cust_pay_batch->replace($old_cust_pay_batch)
2571   } else {
2572     $error = $cust_pay_batch->insert;
2573   }
2574
2575   if ( $error ) {
2576     $dbh->rollback if $oldAutoCommit;
2577     die $error;
2578   }
2579
2580   my $unapplied =   $self->total_unapplied_credits
2581                   + $self->total_unapplied_payments
2582                   + $self->in_transit_payments;
2583   foreach my $cust_bill ($self->open_cust_bill) {
2584     #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2585     my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2586       'invnum' => $cust_bill->invnum,
2587       'paybatchnum' => $cust_pay_batch->paybatchnum,
2588       'amount' => $cust_bill->owed,
2589       '_date' => time,
2590     };
2591     if ($unapplied >= $cust_bill_pay_batch->amount){
2592       $unapplied -= $cust_bill_pay_batch->amount;
2593       next;
2594     }else{
2595       $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2596                                    $cust_bill_pay_batch->amount - $unapplied ));      $unapplied = 0;
2597     }
2598     $error = $cust_bill_pay_batch->insert;
2599     if ( $error ) {
2600       $dbh->rollback if $oldAutoCommit;
2601       die $error;
2602     }
2603   }
2604
2605   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2606   '';
2607 }
2608
2609 =item total_owed
2610
2611 Returns the total owed for this customer on all invoices
2612 (see L<FS::cust_bill/owed>).
2613
2614 =cut
2615
2616 sub total_owed {
2617   my $self = shift;
2618   $self->total_owed_date(2145859200); #12/31/2037
2619 }
2620
2621 =item total_owed_date TIME
2622
2623 Returns the total owed for this customer on all invoices with date earlier than
2624 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2625 see L<Time::Local> and L<Date::Parse> for conversion functions.
2626
2627 =cut
2628
2629 sub total_owed_date {
2630   my $self = shift;
2631   my $time = shift;
2632
2633   my $custnum = $self->custnum;
2634
2635   my $owed_sql = FS::cust_bill->owed_sql;
2636
2637   my $sql = "
2638     SELECT SUM($owed_sql) FROM cust_bill
2639       WHERE custnum = $custnum
2640         AND _date <= $time
2641   ";
2642
2643   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2644
2645 }
2646
2647 =item total_owed_pkgnum PKGNUM
2648
2649 Returns the total owed on all invoices for this customer's specific package
2650 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2651
2652 =cut
2653
2654 sub total_owed_pkgnum {
2655   my( $self, $pkgnum ) = @_;
2656   $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2657 }
2658
2659 =item total_owed_date_pkgnum TIME PKGNUM
2660
2661 Returns the total owed for this customer's specific package when using
2662 experimental package balances on all invoices with date earlier than
2663 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2664 see L<Time::Local> and L<Date::Parse> for conversion functions.
2665
2666 =cut
2667
2668 sub total_owed_date_pkgnum {
2669   my( $self, $time, $pkgnum ) = @_;
2670
2671   my $total_bill = 0;
2672   foreach my $cust_bill (
2673     grep { $_->_date <= $time }
2674       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2675   ) {
2676     $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2677   }
2678   sprintf( "%.2f", $total_bill );
2679
2680 }
2681
2682 =item total_paid
2683
2684 Returns the total amount of all payments.
2685
2686 =cut
2687
2688 sub total_paid {
2689   my $self = shift;
2690   my $total = 0;
2691   $total += $_->paid foreach $self->cust_pay;
2692   sprintf( "%.2f", $total );
2693 }
2694
2695 =item total_unapplied_credits
2696
2697 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2698 customer.  See L<FS::cust_credit/credited>.
2699
2700 =item total_credited
2701
2702 Old name for total_unapplied_credits.  Don't use.
2703
2704 =cut
2705
2706 sub total_credited {
2707   #carp "total_credited deprecated, use total_unapplied_credits";
2708   shift->total_unapplied_credits(@_);
2709 }
2710
2711 sub total_unapplied_credits {
2712   my $self = shift;
2713
2714   my $custnum = $self->custnum;
2715
2716   my $unapplied_sql = FS::cust_credit->unapplied_sql;
2717
2718   my $sql = "
2719     SELECT SUM($unapplied_sql) FROM cust_credit
2720       WHERE custnum = $custnum
2721   ";
2722
2723   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2724
2725 }
2726
2727 =item total_unapplied_credits_pkgnum PKGNUM
2728
2729 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2730 customer.  See L<FS::cust_credit/credited>.
2731
2732 =cut
2733
2734 sub total_unapplied_credits_pkgnum {
2735   my( $self, $pkgnum ) = @_;
2736   my $total_credit = 0;
2737   $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2738   sprintf( "%.2f", $total_credit );
2739 }
2740
2741
2742 =item total_unapplied_payments
2743
2744 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2745 See L<FS::cust_pay/unapplied>.
2746
2747 =cut
2748
2749 sub total_unapplied_payments {
2750   my $self = shift;
2751
2752   my $custnum = $self->custnum;
2753
2754   my $unapplied_sql = FS::cust_pay->unapplied_sql;
2755
2756   my $sql = "
2757     SELECT SUM($unapplied_sql) FROM cust_pay
2758       WHERE custnum = $custnum
2759   ";
2760
2761   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2762
2763 }
2764
2765 =item total_unapplied_payments_pkgnum PKGNUM
2766
2767 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2768 specific package when using experimental package balances.  See
2769 L<FS::cust_pay/unapplied>.
2770
2771 =cut
2772
2773 sub total_unapplied_payments_pkgnum {
2774   my( $self, $pkgnum ) = @_;
2775   my $total_unapplied = 0;
2776   $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2777   sprintf( "%.2f", $total_unapplied );
2778 }
2779
2780
2781 =item total_unapplied_refunds
2782
2783 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2784 customer.  See L<FS::cust_refund/unapplied>.
2785
2786 =cut
2787
2788 sub total_unapplied_refunds {
2789   my $self = shift;
2790   my $custnum = $self->custnum;
2791
2792   my $unapplied_sql = FS::cust_refund->unapplied_sql;
2793
2794   my $sql = "
2795     SELECT SUM($unapplied_sql) FROM cust_refund
2796       WHERE custnum = $custnum
2797   ";
2798
2799   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2800
2801 }
2802
2803 =item balance
2804
2805 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2806 total_unapplied_credits minus total_unapplied_payments).
2807
2808 =cut
2809
2810 sub balance {
2811   my $self = shift;
2812   $self->balance_date_range;
2813 }
2814
2815 =item balance_date TIME
2816
2817 Returns the balance for this customer, only considering invoices with date
2818 earlier than TIME (total_owed_date minus total_credited minus
2819 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
2820 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
2821 functions.
2822
2823 =cut
2824
2825 sub balance_date {
2826   my $self = shift;
2827   $self->balance_date_range(shift);
2828 }
2829
2830 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2831
2832 Returns the balance for this customer, optionally considering invoices with
2833 date earlier than START_TIME, and not later than END_TIME
2834 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2835
2836 Times are specified as SQL fragments or numeric
2837 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
2838 L<Date::Parse> for conversion functions.  The empty string can be passed
2839 to disable that time constraint completely.
2840
2841 Available options are:
2842
2843 =over 4
2844
2845 =item unapplied_date
2846
2847 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)
2848
2849 =back
2850
2851 =cut
2852
2853 sub balance_date_range {
2854   my $self = shift;
2855   my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2856             ') FROM cust_main WHERE custnum='. $self->custnum;
2857   sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2858 }
2859
2860 =item balance_pkgnum PKGNUM
2861
2862 Returns the balance for this customer's specific package when using
2863 experimental package balances (total_owed plus total_unrefunded, minus
2864 total_unapplied_credits minus total_unapplied_payments)
2865
2866 =cut
2867
2868 sub balance_pkgnum {
2869   my( $self, $pkgnum ) = @_;
2870
2871   sprintf( "%.2f",
2872       $self->total_owed_pkgnum($pkgnum)
2873 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2874 #    + $self->total_unapplied_refunds_pkgnum($pkgnum)
2875     - $self->total_unapplied_credits_pkgnum($pkgnum)
2876     - $self->total_unapplied_payments_pkgnum($pkgnum)
2877   );
2878 }
2879
2880 =item in_transit_payments
2881
2882 Returns the total of requests for payments for this customer pending in
2883 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
2884
2885 =cut
2886
2887 sub in_transit_payments {
2888   my $self = shift;
2889   my $in_transit_payments = 0;
2890   foreach my $pay_batch ( qsearch('pay_batch', {
2891     'status' => 'I',
2892   } ) ) {
2893     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2894       'batchnum' => $pay_batch->batchnum,
2895       'custnum' => $self->custnum,
2896     } ) ) {
2897       $in_transit_payments += $cust_pay_batch->amount;
2898     }
2899   }
2900   sprintf( "%.2f", $in_transit_payments );
2901 }
2902
2903 =item payment_info
2904
2905 Returns a hash of useful information for making a payment.
2906
2907 =over 4
2908
2909 =item balance
2910
2911 Current balance.
2912
2913 =item payby
2914
2915 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2916 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2917 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2918
2919 =back
2920
2921 For credit card transactions:
2922
2923 =over 4
2924
2925 =item card_type 1
2926
2927 =item payname
2928
2929 Exact name on card
2930
2931 =back
2932
2933 For electronic check transactions:
2934
2935 =over 4
2936
2937 =item stateid_state
2938
2939 =back
2940
2941 =cut
2942
2943 sub payment_info {
2944   my $self = shift;
2945
2946   my %return = ();
2947
2948   $return{balance} = $self->balance;
2949
2950   $return{payname} = $self->payname
2951                      || ( $self->first. ' '. $self->get('last') );
2952
2953   $return{$_} = $self->bill_location->$_
2954     for qw(address1 address2 city state zip);
2955
2956   $return{payby} = $self->payby;
2957   $return{stateid_state} = $self->stateid_state;
2958
2959   if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2960     $return{card_type} = cardtype($self->payinfo);
2961     $return{payinfo} = $self->paymask;
2962
2963     @return{'month', 'year'} = $self->paydate_monthyear;
2964
2965   }
2966
2967   if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2968     my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2969     $return{payinfo1} = $payinfo1;
2970     $return{payinfo2} = $payinfo2;
2971     $return{paytype}  = $self->paytype;
2972     $return{paystate} = $self->paystate;
2973
2974   }
2975
2976   #doubleclick protection
2977   my $_date = time;
2978   $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2979
2980   %return;
2981
2982 }
2983
2984 =item paydate_monthyear
2985
2986 Returns a two-element list consisting of the month and year of this customer's
2987 paydate (credit card expiration date for CARD customers)
2988
2989 =cut
2990
2991 sub paydate_monthyear {
2992   my $self = shift;
2993   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2994     ( $2, $1 );
2995   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2996     ( $1, $3 );
2997   } else {
2998     ('', '');
2999   }
3000 }
3001
3002 =item paydate_epoch
3003
3004 Returns the exact time in seconds corresponding to the payment method
3005 expiration date.  For CARD/DCRD customers this is the end of the month;
3006 for others (COMP is the only other payby that uses paydate) it's the start.
3007 Returns 0 if the paydate is empty or set to the far future.
3008
3009 =cut
3010
3011 sub paydate_epoch {
3012   my $self = shift;
3013   my ($month, $year) = $self->paydate_monthyear;
3014   return 0 if !$year or $year >= 2037;
3015   if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3016     $month++;
3017     if ( $month == 13 ) {
3018       $month = 1;
3019       $year++;
3020     }
3021     return timelocal(0,0,0,1,$month-1,$year) - 1;
3022   }
3023   else {
3024     return timelocal(0,0,0,1,$month-1,$year);
3025   }
3026 }
3027
3028 =item paydate_epoch_sql
3029
3030 Class method.  Returns an SQL expression to obtain the payment expiration date
3031 as a number of seconds.
3032
3033 =cut
3034
3035 # Special expiration date behavior for non-CARD/DCRD customers has been
3036 # carefully preserved.  Do we really use that?
3037 sub paydate_epoch_sql {
3038   my $class = shift;
3039   my $table = shift || 'cust_main';
3040   my ($case1, $case2);
3041   if ( driver_name eq 'Pg' ) {
3042     $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3043     $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3044   }
3045   elsif ( lc(driver_name) eq 'mysql' ) {
3046     $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3047     $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3048   }
3049   else { return '' }
3050   return "CASE WHEN $table.payby IN('CARD','DCRD')
3051   THEN ($case1)
3052   ELSE ($case2)
3053   END"
3054 }
3055
3056 =item tax_exemption TAXNAME
3057
3058 =cut
3059
3060 sub tax_exemption {
3061   my( $self, $taxname ) = @_;
3062
3063   qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3064                                      'taxname' => $taxname,
3065                                    },
3066           );
3067 }
3068
3069 =item cust_main_exemption
3070
3071 =item invoicing_list [ ARRAYREF ]
3072
3073 If an arguement is given, sets these email addresses as invoice recipients
3074 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
3075 (except as warnings), so use check_invoicing_list first.
3076
3077 Returns a list of email addresses (with svcnum entries expanded).
3078
3079 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
3080 check it without disturbing anything by passing nothing.
3081
3082 This interface may change in the future.
3083
3084 =cut
3085
3086 sub invoicing_list {
3087   my( $self, $arrayref ) = @_;
3088
3089   if ( $arrayref ) {
3090     my @cust_main_invoice;
3091     if ( $self->custnum ) {
3092       @cust_main_invoice =
3093         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3094     } else {
3095       @cust_main_invoice = ();
3096     }
3097     foreach my $cust_main_invoice ( @cust_main_invoice ) {
3098       #warn $cust_main_invoice->destnum;
3099       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3100         #warn $cust_main_invoice->destnum;
3101         my $error = $cust_main_invoice->delete;
3102         warn $error if $error;
3103       }
3104     }
3105     if ( $self->custnum ) {
3106       @cust_main_invoice =
3107         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3108     } else {
3109       @cust_main_invoice = ();
3110     }
3111     my %seen = map { $_->address => 1 } @cust_main_invoice;
3112     foreach my $address ( @{$arrayref} ) {
3113       next if exists $seen{$address} && $seen{$address};
3114       $seen{$address} = 1;
3115       my $cust_main_invoice = new FS::cust_main_invoice ( {
3116         'custnum' => $self->custnum,
3117         'dest'    => $address,
3118       } );
3119       my $error = $cust_main_invoice->insert;
3120       warn $error if $error;
3121     }
3122   }
3123
3124   if ( $self->custnum ) {
3125     map { $_->address }
3126       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3127   } else {
3128     ();
3129   }
3130
3131 }
3132
3133 =item check_invoicing_list ARRAYREF
3134
3135 Checks these arguements as valid input for the invoicing_list method.  If there
3136 is an error, returns the error, otherwise returns false.
3137
3138 =cut
3139
3140 sub check_invoicing_list {
3141   my( $self, $arrayref ) = @_;
3142
3143   foreach my $address ( @$arrayref ) {
3144
3145     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3146       return 'Can\'t add FAX invoice destination with a blank FAX number.';
3147     }
3148
3149     my $cust_main_invoice = new FS::cust_main_invoice ( {
3150       'custnum' => $self->custnum,
3151       'dest'    => $address,
3152     } );
3153     my $error = $self->custnum
3154                 ? $cust_main_invoice->check
3155                 : $cust_main_invoice->checkdest
3156     ;
3157     return $error if $error;
3158
3159   }
3160
3161   return "Email address required"
3162     if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3163     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3164
3165   '';
3166 }
3167
3168 =item set_default_invoicing_list
3169
3170 Sets the invoicing list to all accounts associated with this customer,
3171 overwriting any previous invoicing list.
3172
3173 =cut
3174
3175 sub set_default_invoicing_list {
3176   my $self = shift;
3177   $self->invoicing_list($self->all_emails);
3178 }
3179
3180 =item all_emails
3181
3182 Returns the email addresses of all accounts provisioned for this customer.
3183
3184 =cut
3185
3186 sub all_emails {
3187   my $self = shift;
3188   my %list;
3189   foreach my $cust_pkg ( $self->all_pkgs ) {
3190     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3191     my @svc_acct =
3192       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3193         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3194           @cust_svc;
3195     $list{$_}=1 foreach map { $_->email } @svc_acct;
3196   }
3197   keys %list;
3198 }
3199
3200 =item invoicing_list_addpost
3201
3202 Adds postal invoicing to this customer.  If this customer is already configured
3203 to receive postal invoices, does nothing.
3204
3205 =cut
3206
3207 sub invoicing_list_addpost {
3208   my $self = shift;
3209   return if grep { $_ eq 'POST' } $self->invoicing_list;
3210   my @invoicing_list = $self->invoicing_list;
3211   push @invoicing_list, 'POST';
3212   $self->invoicing_list(\@invoicing_list);
3213 }
3214
3215 =item invoicing_list_emailonly
3216
3217 Returns the list of email invoice recipients (invoicing_list without non-email
3218 destinations such as POST and FAX).
3219
3220 =cut
3221
3222 sub invoicing_list_emailonly {
3223   my $self = shift;
3224   warn "$me invoicing_list_emailonly called"
3225     if $DEBUG;
3226   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3227 }
3228
3229 =item invoicing_list_emailonly_scalar
3230
3231 Returns the list of email invoice recipients (invoicing_list without non-email
3232 destinations such as POST and FAX) as a comma-separated scalar.
3233
3234 =cut
3235
3236 sub invoicing_list_emailonly_scalar {
3237   my $self = shift;
3238   warn "$me invoicing_list_emailonly_scalar called"
3239     if $DEBUG;
3240   join(', ', $self->invoicing_list_emailonly);
3241 }
3242
3243 =item referral_custnum_cust_main
3244
3245 Returns the customer who referred this customer (or the empty string, if
3246 this customer was not referred).
3247
3248 Note the difference with referral_cust_main method: This method,
3249 referral_custnum_cust_main returns the single customer (if any) who referred
3250 this customer, while referral_cust_main returns an array of customers referred
3251 BY this customer.
3252
3253 =cut
3254
3255 sub referral_custnum_cust_main {
3256   my $self = shift;
3257   return '' unless $self->referral_custnum;
3258   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3259 }
3260
3261 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3262
3263 Returns an array of customers referred by this customer (referral_custnum set
3264 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
3265 customers referred by customers referred by this customer and so on, inclusive.
3266 The default behavior is DEPTH 1 (no recursion).
3267
3268 Note the difference with referral_custnum_cust_main method: This method,
3269 referral_cust_main, returns an array of customers referred BY this customer,
3270 while referral_custnum_cust_main returns the single customer (if any) who
3271 referred this customer.
3272
3273 =cut
3274
3275 sub referral_cust_main {
3276   my $self = shift;
3277   my $depth = @_ ? shift : 1;
3278   my $exclude = @_ ? shift : {};
3279
3280   my @cust_main =
3281     map { $exclude->{$_->custnum}++; $_; }
3282       grep { ! $exclude->{ $_->custnum } }
3283         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3284
3285   if ( $depth > 1 ) {
3286     push @cust_main,
3287       map { $_->referral_cust_main($depth-1, $exclude) }
3288         @cust_main;
3289   }
3290
3291   @cust_main;
3292 }
3293
3294 =item referral_cust_main_ncancelled
3295
3296 Same as referral_cust_main, except only returns customers with uncancelled
3297 packages.
3298
3299 =cut
3300
3301 sub referral_cust_main_ncancelled {
3302   my $self = shift;
3303   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3304 }
3305
3306 =item referral_cust_pkg [ DEPTH ]
3307
3308 Like referral_cust_main, except returns a flat list of all unsuspended (and
3309 uncancelled) packages for each customer.  The number of items in this list may
3310 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3311
3312 =cut
3313
3314 sub referral_cust_pkg {
3315   my $self = shift;
3316   my $depth = @_ ? shift : 1;
3317
3318   map { $_->unsuspended_pkgs }
3319     grep { $_->unsuspended_pkgs }
3320       $self->referral_cust_main($depth);
3321 }
3322
3323 =item referring_cust_main
3324
3325 Returns the single cust_main record for the customer who referred this customer
3326 (referral_custnum), or false.
3327
3328 =cut
3329
3330 sub referring_cust_main {
3331   my $self = shift;
3332   return '' unless $self->referral_custnum;
3333   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3334 }
3335
3336 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3337
3338 Applies a credit to this customer.  If there is an error, returns the error,
3339 otherwise returns false.
3340
3341 REASON can be a text string, an FS::reason object, or a scalar reference to
3342 a reasonnum.  If a text string, it will be automatically inserted as a new
3343 reason, and a 'reason_type' option must be passed to indicate the
3344 FS::reason_type for the new reason.
3345
3346 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3347 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3348 I<commission_pkgnum>.
3349
3350 Any other options are passed to FS::cust_credit::insert.
3351
3352 =cut
3353
3354 sub credit {
3355   my( $self, $amount, $reason, %options ) = @_;
3356
3357   my $cust_credit = new FS::cust_credit {
3358     'custnum' => $self->custnum,
3359     'amount'  => $amount,
3360   };
3361
3362   if ( ref($reason) ) {
3363
3364     if ( ref($reason) eq 'SCALAR' ) {
3365       $cust_credit->reasonnum( $$reason );
3366     } else {
3367       $cust_credit->reasonnum( $reason->reasonnum );
3368     }
3369
3370   } else {
3371     $cust_credit->set('reason', $reason)
3372   }
3373
3374   $cust_credit->$_( delete $options{$_} )
3375     foreach grep exists($options{$_}),
3376               qw( addlinfo eventnum ),
3377               map "commission_$_", qw( agentnum salesnum pkgnum );
3378
3379   $cust_credit->insert(%options);
3380
3381 }
3382
3383 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3384
3385 Creates a one-time charge for this customer.  If there is an error, returns
3386 the error, otherwise returns false.
3387
3388 New-style, with a hashref of options:
3389
3390   my $error = $cust_main->charge(
3391                                   {
3392                                     'amount'     => 54.32,
3393                                     'quantity'   => 1,
3394                                     'start_date' => str2time('7/4/2009'),
3395                                     'pkg'        => 'Description',
3396                                     'comment'    => 'Comment',
3397                                     'additional' => [], #extra invoice detail
3398                                     'classnum'   => 1,  #pkg_class
3399
3400                                     'setuptax'   => '', # or 'Y' for tax exempt
3401
3402                                     'locationnum'=> 1234, # optional
3403
3404                                     #internal taxation
3405                                     'taxclass'   => 'Tax class',
3406
3407                                     #vendor taxation
3408                                     'taxproduct' => 2,  #part_pkg_taxproduct
3409                                     'override'   => {}, #XXX describe
3410
3411                                     #will be filled in with the new object
3412                                     'cust_pkg_ref' => \$cust_pkg,
3413
3414                                     #generate an invoice immediately
3415                                     'bill_now' => 0,
3416                                     'invoice_terms' => '', #with these terms
3417                                   }
3418                                 );
3419
3420 Old-style:
3421
3422   my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3423
3424 =cut
3425
3426 sub charge {
3427   my $self = shift;
3428   my ( $amount, $quantity, $start_date, $classnum );
3429   my ( $pkg, $comment, $additional );
3430   my ( $setuptax, $taxclass );   #internal taxes
3431   my ( $taxproduct, $override ); #vendor (CCH) taxes
3432   my $no_auto = '';
3433   my $cust_pkg_ref = '';
3434   my ( $bill_now, $invoice_terms ) = ( 0, '' );
3435   my $locationnum;
3436   if ( ref( $_[0] ) ) {
3437     $amount     = $_[0]->{amount};
3438     $quantity   = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3439     $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3440     $no_auto    = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3441     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3442     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
3443                                            : '$'. sprintf("%.2f",$amount);
3444     $setuptax   = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3445     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3446     $classnum   = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3447     $additional = $_[0]->{additional} || [];
3448     $taxproduct = $_[0]->{taxproductnum};
3449     $override   = { '' => $_[0]->{tax_override} };
3450     $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3451     $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3452     $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3453     $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3454   } else {
3455     $amount     = shift;
3456     $quantity   = 1;
3457     $start_date = '';
3458     $pkg        = @_ ? shift : 'One-time charge';
3459     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
3460     $setuptax   = '';
3461     $taxclass   = @_ ? shift : '';
3462     $additional = [];
3463   }
3464
3465   local $SIG{HUP} = 'IGNORE';
3466   local $SIG{INT} = 'IGNORE';
3467   local $SIG{QUIT} = 'IGNORE';
3468   local $SIG{TERM} = 'IGNORE';
3469   local $SIG{TSTP} = 'IGNORE';
3470   local $SIG{PIPE} = 'IGNORE';
3471
3472   my $oldAutoCommit = $FS::UID::AutoCommit;
3473   local $FS::UID::AutoCommit = 0;
3474   my $dbh = dbh;
3475
3476   my $part_pkg = new FS::part_pkg ( {
3477     'pkg'           => $pkg,
3478     'comment'       => $comment,
3479     'plan'          => 'flat',
3480     'freq'          => 0,
3481     'disabled'      => 'Y',
3482     'classnum'      => ( $classnum ? $classnum : '' ),
3483     'setuptax'      => $setuptax,
3484     'taxclass'      => $taxclass,
3485     'taxproductnum' => $taxproduct,
3486   } );
3487
3488   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3489                         ( 0 .. @$additional - 1 )
3490                   ),
3491                   'additional_count' => scalar(@$additional),
3492                   'setup_fee' => $amount,
3493                 );
3494
3495   my $error = $part_pkg->insert( options       => \%options,
3496                                  tax_overrides => $override,
3497                                );
3498   if ( $error ) {
3499     $dbh->rollback if $oldAutoCommit;
3500     return $error;
3501   }
3502
3503   my $pkgpart = $part_pkg->pkgpart;
3504   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3505   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3506     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3507     $error = $type_pkgs->insert;
3508     if ( $error ) {
3509       $dbh->rollback if $oldAutoCommit;
3510       return $error;
3511     }
3512   }
3513
3514   my $cust_pkg = new FS::cust_pkg ( {
3515     'custnum'    => $self->custnum,
3516     'pkgpart'    => $pkgpart,
3517     'quantity'   => $quantity,
3518     'start_date' => $start_date,
3519     'no_auto'    => $no_auto,
3520     'locationnum'=> $locationnum,
3521   } );
3522
3523   $error = $cust_pkg->insert;
3524   if ( $error ) {
3525     $dbh->rollback if $oldAutoCommit;
3526     return $error;
3527   } elsif ( $cust_pkg_ref ) {
3528     ${$cust_pkg_ref} = $cust_pkg;
3529   }
3530
3531   if ( $bill_now ) {
3532     my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3533                              'pkg_list'      => [ $cust_pkg ],
3534                            );
3535     if ( $error ) {
3536       $dbh->rollback if $oldAutoCommit;
3537       return $error;
3538     }
3539   }
3540
3541   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3542   return '';
3543
3544 }
3545
3546 #=item charge_postal_fee
3547 #
3548 #Applies a one time charge this customer.  If there is an error,
3549 #returns the error, returns the cust_pkg charge object or false
3550 #if there was no charge.
3551 #
3552 #=cut
3553 #
3554 # This should be a customer event.  For that to work requires that bill
3555 # also be a customer event.
3556
3557 sub charge_postal_fee {
3558   my $self = shift;
3559
3560   my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3561   return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3562
3563   my $cust_pkg = new FS::cust_pkg ( {
3564     'custnum'  => $self->custnum,
3565     'pkgpart'  => $pkgpart,
3566     'quantity' => 1,
3567   } );
3568
3569   my $error = $cust_pkg->insert;
3570   $error ? $error : $cust_pkg;
3571 }
3572
3573 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3574
3575 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3576
3577 Optionally, a list or hashref of additional arguments to the qsearch call can
3578 be passed.
3579
3580 =cut
3581
3582 sub cust_bill {
3583   my $self = shift;
3584   my $opt = ref($_[0]) ? shift : { @_ };
3585
3586   #return $self->num_cust_bill unless wantarray || keys %$opt;
3587
3588   $opt->{'table'} = 'cust_bill';
3589   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3590   $opt->{'hashref'}{'custnum'} = $self->custnum;
3591   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3592
3593   map { $_ } #behavior of sort undefined in scalar context
3594     sort { $a->_date <=> $b->_date }
3595       qsearch($opt);
3596 }
3597
3598 =item open_cust_bill
3599
3600 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3601 customer.
3602
3603 =cut
3604
3605 sub open_cust_bill {
3606   my $self = shift;
3607
3608   $self->cust_bill(
3609     'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3610     #@_
3611   );
3612
3613 }
3614
3615 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3616
3617 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3618
3619 =cut
3620
3621 sub legacy_cust_bill {
3622   my $self = shift;
3623
3624   #return $self->num_legacy_cust_bill unless wantarray;
3625
3626   map { $_ } #behavior of sort undefined in scalar context
3627     sort { $a->_date <=> $b->_date }
3628       qsearch({ 'table'    => 'legacy_cust_bill',
3629                 'hashref'  => { 'custnum' => $self->custnum, },
3630                 'order_by' => 'ORDER BY _date ASC',
3631              });
3632 }
3633
3634 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3635
3636 Returns all the statements (see L<FS::cust_statement>) for this customer.
3637
3638 Optionally, a list or hashref of additional arguments to the qsearch call can
3639 be passed.
3640
3641 =cut
3642
3643 =item cust_bill_void
3644
3645 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3646
3647 =cut
3648
3649 sub cust_bill_void {
3650   my $self = shift;
3651
3652   map { $_ } #return $self->num_cust_bill_void unless wantarray;
3653   sort { $a->_date <=> $b->_date }
3654     qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3655 }
3656
3657 sub cust_statement {
3658   my $self = shift;
3659   my $opt = ref($_[0]) ? shift : { @_ };
3660
3661   #return $self->num_cust_statement unless wantarray || keys %$opt;
3662
3663   $opt->{'table'} = 'cust_statement';
3664   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3665   $opt->{'hashref'}{'custnum'} = $self->custnum;
3666   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3667
3668   map { $_ } #behavior of sort undefined in scalar context
3669     sort { $a->_date <=> $b->_date }
3670       qsearch($opt);
3671 }
3672
3673 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3674
3675 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3676
3677 Optionally, a list or hashref of additional arguments to the qsearch call can
3678 be passed following the SVCDB.
3679
3680 =cut
3681
3682 sub svc_x {
3683   my $self = shift;
3684   my $svcdb = shift;
3685   if ( ! $svcdb =~ /^svc_\w+$/ ) {
3686     warn "$me svc_x requires a svcdb";
3687     return;
3688   }
3689   my $opt = ref($_[0]) ? shift : { @_ };
3690
3691   $opt->{'table'} = $svcdb;
3692   $opt->{'addl_from'} =
3693     'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3694     ($opt->{'addl_from'} || '');
3695
3696   my $custnum = $self->custnum;
3697   $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3698   my $where = "cust_pkg.custnum = $custnum";
3699
3700   my $extra_sql = $opt->{'extra_sql'} || '';
3701   if ( keys %{ $opt->{'hashref'} } ) {
3702     $extra_sql = " AND $where $extra_sql";
3703   }
3704   else {
3705     if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3706       $extra_sql = "WHERE $where AND $1";
3707     }
3708     else {
3709       $extra_sql = "WHERE $where $extra_sql";
3710     }
3711   }
3712   $opt->{'extra_sql'} = $extra_sql;
3713
3714   qsearch($opt);
3715 }
3716
3717 # required for use as an eventtable;
3718 sub svc_acct {
3719   my $self = shift;
3720   $self->svc_x('svc_acct', @_);
3721 }
3722
3723 =item cust_credit
3724
3725 Returns all the credits (see L<FS::cust_credit>) for this customer.
3726
3727 =cut
3728
3729 sub cust_credit {
3730   my $self = shift;
3731   map { $_ } #return $self->num_cust_credit unless wantarray;
3732   sort { $a->_date <=> $b->_date }
3733     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3734 }
3735
3736 =item cust_credit_pkgnum
3737
3738 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3739 package when using experimental package balances.
3740
3741 =cut
3742
3743 sub cust_credit_pkgnum {
3744   my( $self, $pkgnum ) = @_;
3745   map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3746   sort { $a->_date <=> $b->_date }
3747     qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3748                               'pkgnum'  => $pkgnum,
3749                             }
3750     );
3751 }
3752
3753 =item cust_credit_void
3754
3755 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3756
3757 =cut
3758
3759 sub cust_credit_void {
3760   my $self = shift;
3761   map { $_ }
3762   sort { $a->_date <=> $b->_date }
3763     qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3764 }
3765
3766 =item cust_pay
3767
3768 Returns all the payments (see L<FS::cust_pay>) for this customer.
3769
3770 =cut
3771
3772 sub cust_pay {
3773   my $self = shift;
3774   return $self->num_cust_pay unless wantarray;
3775   sort { $a->_date <=> $b->_date }
3776     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3777 }
3778
3779 =item num_cust_pay
3780
3781 Returns the number of payments (see L<FS::cust_pay>) for this customer.  Also
3782 called automatically when the cust_pay method is used in a scalar context.
3783
3784 =cut
3785
3786 sub num_cust_pay {
3787   my $self = shift;
3788   my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3789   my $sth = dbh->prepare($sql) or die dbh->errstr;
3790   $sth->execute($self->custnum) or die $sth->errstr;
3791   $sth->fetchrow_arrayref->[0];
3792 }
3793
3794 =item cust_pay_pkgnum
3795
3796 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3797 package when using experimental package balances.
3798
3799 =cut
3800
3801 sub cust_pay_pkgnum {
3802   my( $self, $pkgnum ) = @_;
3803   map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3804   sort { $a->_date <=> $b->_date }
3805     qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3806                            'pkgnum'  => $pkgnum,
3807                          }
3808     );
3809 }
3810
3811 =item cust_pay_void
3812
3813 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3814
3815 =cut
3816
3817 sub cust_pay_void {
3818   my $self = shift;
3819   map { $_ } #return $self->num_cust_pay_void unless wantarray;
3820   sort { $a->_date <=> $b->_date }
3821     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3822 }
3823
3824 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3825
3826 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
3827
3828 Optionally, a list or hashref of additional arguments to the qsearch call can
3829 be passed.
3830
3831 =cut
3832
3833 sub cust_pay_batch {
3834   my $self = shift;
3835   my $opt = ref($_[0]) ? shift : { @_ };
3836
3837   #return $self->num_cust_statement unless wantarray || keys %$opt;
3838
3839   $opt->{'table'} = 'cust_pay_batch';
3840   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3841   $opt->{'hashref'}{'custnum'} = $self->custnum;
3842   $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3843
3844   map { $_ } #behavior of sort undefined in scalar context
3845     sort { $a->paybatchnum <=> $b->paybatchnum }
3846       qsearch($opt);
3847 }
3848
3849 =item cust_pay_pending
3850
3851 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3852 (without status "done").
3853
3854 =cut
3855
3856 sub cust_pay_pending {
3857   my $self = shift;
3858   return $self->num_cust_pay_pending unless wantarray;
3859   sort { $a->_date <=> $b->_date }
3860     qsearch( 'cust_pay_pending', {
3861                                    'custnum' => $self->custnum,
3862                                    'status'  => { op=>'!=', value=>'done' },
3863                                  },
3864            );
3865 }
3866
3867 =item cust_pay_pending_attempt
3868
3869 Returns all payment attempts / declined payments for this customer, as pending
3870 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3871 a corresponding payment (see L<FS::cust_pay>).
3872
3873 =cut
3874
3875 sub cust_pay_pending_attempt {
3876   my $self = shift;
3877   return $self->num_cust_pay_pending_attempt unless wantarray;
3878   sort { $a->_date <=> $b->_date }
3879     qsearch( 'cust_pay_pending', {
3880                                    'custnum' => $self->custnum,
3881                                    'status'  => 'done',
3882                                    'paynum'  => '',
3883                                  },
3884            );
3885 }
3886
3887 =item num_cust_pay_pending
3888
3889 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3890 customer (without status "done").  Also called automatically when the
3891 cust_pay_pending method is used in a scalar context.
3892
3893 =cut
3894
3895 sub num_cust_pay_pending {
3896   my $self = shift;
3897   $self->scalar_sql(
3898     " SELECT COUNT(*) FROM cust_pay_pending ".
3899       " WHERE custnum = ? AND status != 'done' ",
3900     $self->custnum
3901   );
3902 }
3903
3904 =item num_cust_pay_pending_attempt
3905
3906 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3907 customer, with status "done" but without a corresp.  Also called automatically when the
3908 cust_pay_pending method is used in a scalar context.
3909
3910 =cut
3911
3912 sub num_cust_pay_pending_attempt {
3913   my $self = shift;
3914   $self->scalar_sql(
3915     " SELECT COUNT(*) FROM cust_pay_pending ".
3916       " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3917     $self->custnum
3918   );
3919 }
3920
3921 =item cust_refund
3922
3923 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3924
3925 =cut
3926
3927 sub cust_refund {
3928   my $self = shift;
3929   map { $_ } #return $self->num_cust_refund unless wantarray;
3930   sort { $a->_date <=> $b->_date }
3931     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3932 }
3933
3934 =item display_custnum
3935
3936 Returns the displayed customer number for this customer: agent_custid if
3937 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3938
3939 =cut
3940
3941 sub display_custnum {
3942   my $self = shift;
3943
3944   my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3945   if ( my $special = $conf->config('cust_main-custnum-display_special') ) {
3946     if ( $special eq 'CoStAg' ) {
3947       $prefix = uc( join('',
3948         $self->country,
3949         ($self->state =~ /^(..)/),
3950         $prefix || ($self->agent->agent =~ /^(..)/)
3951       ) );
3952     }
3953     elsif ( $special eq 'CoStCl' ) {
3954       $prefix = uc( join('',
3955         $self->country,
3956         ($self->state =~ /^(..)/),
3957         ($self->classnum ? $self->cust_class->classname =~ /^(..)/ : '__')
3958       ) );
3959     }
3960     # add any others here if needed
3961   }
3962
3963   my $length = $conf->config('cust_main-custnum-display_length');
3964   if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3965     return $self->agent_custid;
3966   } elsif ( $prefix ) {
3967     $length = 8 if !defined($length);
3968     return $prefix .
3969            sprintf('%0'.$length.'d', $self->custnum)
3970   } elsif ( $length ) {
3971     return sprintf('%0'.$length.'d', $self->custnum);
3972   } else {
3973     return $self->custnum;
3974   }
3975 }
3976
3977 =item name
3978
3979 Returns a name string for this customer, either "Company (Last, First)" or
3980 "Last, First".
3981
3982 =cut
3983
3984 sub name {
3985   my $self = shift;
3986   my $name = $self->contact;
3987   $name = $self->company. " ($name)" if $self->company;
3988   $name;
3989 }
3990
3991 =item service_contact
3992
3993 Returns the L<FS::contact> object for this customer that has the 'Service'
3994 contact class, or undef if there is no such contact.  Deprecated; don't use
3995 this in new code.
3996
3997 =cut
3998
3999 sub service_contact {
4000   my $self = shift;
4001   if ( !exists($self->{service_contact}) ) {
4002     my $classnum = $self->scalar_sql(
4003       'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4004     ) || 0; #if it's zero, qsearchs will return nothing
4005     $self->{service_contact} = qsearchs('contact', {
4006         'classnum' => $classnum, 'custnum' => $self->custnum
4007       }) || undef;
4008   }
4009   $self->{service_contact};
4010 }
4011
4012 =item ship_name
4013
4014 Returns a name string for this (service/shipping) contact, either
4015 "Company (Last, First)" or "Last, First".
4016
4017 =cut
4018
4019 sub ship_name {
4020   my $self = shift;
4021
4022   my $name = $self->ship_contact;
4023   $name = $self->company. " ($name)" if $self->company;
4024   $name;
4025 }
4026
4027 =item name_short
4028
4029 Returns a name string for this customer, either "Company" or "First Last".
4030
4031 =cut
4032
4033 sub name_short {
4034   my $self = shift;
4035   $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4036 }
4037
4038 =item ship_name_short
4039
4040 Returns a name string for this (service/shipping) contact, either "Company"
4041 or "First Last".
4042
4043 =cut
4044
4045 sub ship_name_short {
4046   my $self = shift;
4047   $self->service_contact
4048     ? $self->ship_contact_firstlast
4049     : $self->name_short
4050 }
4051
4052 =item contact
4053
4054 Returns this customer's full (billing) contact name only, "Last, First"
4055
4056 =cut
4057
4058 sub contact {
4059   my $self = shift;
4060   $self->get('last'). ', '. $self->first;
4061 }
4062
4063 =item ship_contact
4064
4065 Returns this customer's full (shipping) contact name only, "Last, First"
4066
4067 =cut
4068
4069 sub ship_contact {
4070   my $self = shift;
4071   my $contact = $self->service_contact || $self;
4072   $contact->get('last') . ', ' . $contact->get('first');
4073 }
4074
4075 =item contact_firstlast
4076
4077 Returns this customers full (billing) contact name only, "First Last".
4078
4079 =cut
4080
4081 sub contact_firstlast {
4082   my $self = shift;
4083   $self->first. ' '. $self->get('last');
4084 }
4085
4086 =item ship_contact_firstlast
4087
4088 Returns this customer's full (shipping) contact name only, "First Last".
4089
4090 =cut
4091
4092 sub ship_contact_firstlast {
4093   my $self = shift;
4094   my $contact = $self->service_contact || $self;
4095   $contact->get('first') . ' '. $contact->get('last');
4096 }
4097
4098 #XXX this doesn't work in 3.x+
4099 #=item country_full
4100 #
4101 #Returns this customer's full country name
4102 #
4103 #=cut
4104 #
4105 #sub country_full {
4106 #  my $self = shift;
4107 #  code2country($self->country);
4108 #}
4109
4110 sub bill_country_full {
4111   my $self = shift;
4112   code2country($self->bill_location->country);
4113 }
4114
4115 sub ship_country_full {
4116   my $self = shift;
4117   code2country($self->ship_location->country);
4118 }
4119
4120 =item county_state_county [ PREFIX ]
4121
4122 Returns a string consisting of just the county, state and country.
4123
4124 =cut
4125
4126 sub county_state_country {
4127   my $self = shift;
4128   my $locationnum;
4129   if ( @_ && $_[0] && $self->has_ship_address ) {
4130     $locationnum = $self->ship_locationnum;
4131   } else {
4132     $locationnum = $self->bill_locationnum;
4133   }
4134   my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4135   $cust_location->county_state_country;
4136 }
4137
4138 =item geocode DATA_VENDOR
4139
4140 Returns a value for the customer location as encoded by DATA_VENDOR.
4141 Currently this only makes sense for "CCH" as DATA_VENDOR.
4142
4143 =cut
4144
4145 =item cust_status
4146
4147 =item status
4148
4149 Returns a status string for this customer, currently:
4150
4151 =over 4
4152
4153 =item prospect - No packages have ever been ordered
4154
4155 =item ordered - Recurring packages all are new (not yet billed).
4156
4157 =item active - One or more recurring packages is active
4158
4159 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4160
4161 =item suspended - All non-cancelled recurring packages are suspended
4162
4163 =item cancelled - All recurring packages are cancelled
4164
4165 =back
4166
4167 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4168 cust_main-status_module configuration option.
4169
4170 =cut
4171
4172 sub status { shift->cust_status(@_); }
4173
4174 sub cust_status {
4175   my $self = shift;
4176   for my $status ( FS::cust_main->statuses() ) {
4177     my $method = $status.'_sql';
4178     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4179     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4180     $sth->execute( ($self->custnum) x $numnum )
4181       or die "Error executing 'SELECT $sql': ". $sth->errstr;
4182     return $status if $sth->fetchrow_arrayref->[0];
4183   }
4184 }
4185
4186 =item ucfirst_cust_status
4187
4188 =item ucfirst_status
4189
4190 Returns the status with the first character capitalized.
4191
4192 =cut
4193
4194 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4195
4196 sub ucfirst_cust_status {
4197   my $self = shift;
4198   ucfirst($self->cust_status);
4199 }
4200
4201 =item statuscolor
4202
4203 Returns a hex triplet color string for this customer's status.
4204
4205 =cut
4206
4207 sub statuscolor { shift->cust_statuscolor(@_); }
4208
4209 sub cust_statuscolor {
4210   my $self = shift;
4211   __PACKAGE__->statuscolors->{$self->cust_status};
4212 }
4213
4214 =item tickets [ STATUS ]
4215
4216 Returns an array of hashes representing the customer's RT tickets.
4217
4218 An optional status (or arrayref or hashref of statuses) may be specified.
4219
4220 =cut
4221
4222 sub tickets {
4223   my $self = shift;
4224   my $status = ( @_ && $_[0] ) ? shift : '';
4225
4226   my $num = $conf->config('cust_main-max_tickets') || 10;
4227   my @tickets = ();
4228
4229   if ( $conf->config('ticket_system') ) {
4230     unless ( $conf->config('ticket_system-custom_priority_field') ) {
4231
4232       @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4233                                                         $num,
4234                                                         undef,
4235                                                         $status,
4236                                                       )
4237                   };
4238
4239     } else {
4240
4241       foreach my $priority (
4242         $conf->config('ticket_system-custom_priority_field-values'), ''
4243       ) {
4244         last if scalar(@tickets) >= $num;
4245         push @tickets,
4246           @{ FS::TicketSystem->customer_tickets( $self->custnum,
4247                                                  $num - scalar(@tickets),
4248                                                  $priority,
4249                                                  $status,
4250                                                )
4251            };
4252       }
4253     }
4254   }
4255   (@tickets);
4256 }
4257
4258 # Return services representing svc_accts in customer support packages
4259 sub support_services {
4260   my $self = shift;
4261   my %packages = map { $_ => 1 } $conf->config('support_packages');
4262
4263   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4264     grep { $_->part_svc->svcdb eq 'svc_acct' }
4265     map { $_->cust_svc }
4266     grep { exists $packages{ $_->pkgpart } }
4267     $self->ncancelled_pkgs;
4268
4269 }
4270
4271 # Return a list of latitude/longitude for one of the services (if any)
4272 sub service_coordinates {
4273   my $self = shift;
4274
4275   my @svc_X =
4276     grep { $_->latitude && $_->longitude }
4277     map { $_->svc_x }
4278     map { $_->cust_svc }
4279     $self->ncancelled_pkgs;
4280
4281   scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4282 }
4283
4284 =item masked FIELD
4285
4286 Returns a masked version of the named field
4287
4288 =cut
4289
4290 sub masked {
4291 my ($self,$field) = @_;
4292
4293 # Show last four
4294
4295 'x'x(length($self->getfield($field))-4).
4296   substr($self->getfield($field), (length($self->getfield($field))-4));
4297
4298 }
4299
4300 =back
4301
4302 =head1 CLASS METHODS
4303
4304 =over 4
4305
4306 =item statuses
4307
4308 Class method that returns the list of possible status strings for customers
4309 (see L<the status method|/status>).  For example:
4310
4311   @statuses = FS::cust_main->statuses();
4312
4313 =cut
4314
4315 sub statuses {
4316   my $self = shift;
4317   keys %{ $self->statuscolors };
4318 }
4319
4320 =item cust_status_sql
4321
4322 Returns an SQL fragment to determine the status of a cust_main record, as a
4323 string.
4324
4325 =cut
4326
4327 sub cust_status_sql {
4328   my $sql = 'CASE';
4329   for my $status ( FS::cust_main->statuses() ) {
4330     my $method = $status.'_sql';
4331     $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4332   }
4333   $sql .= ' END';
4334   return $sql;
4335 }
4336
4337
4338 =item prospect_sql
4339
4340 Returns an SQL expression identifying prospective cust_main records (customers
4341 with no packages ever ordered)
4342
4343 =cut
4344
4345 use vars qw($select_count_pkgs);
4346 $select_count_pkgs =
4347   "SELECT COUNT(*) FROM cust_pkg
4348     WHERE cust_pkg.custnum = cust_main.custnum";
4349
4350 sub select_count_pkgs_sql {
4351   $select_count_pkgs;
4352 }
4353
4354 sub prospect_sql {
4355   " 0 = ( $select_count_pkgs ) ";
4356 }
4357
4358 =item ordered_sql
4359
4360 Returns an SQL expression identifying ordered cust_main records (customers with
4361 no active packages, but recurring packages not yet setup or one time charges
4362 not yet billed).
4363
4364 =cut
4365
4366 sub ordered_sql {
4367   FS::cust_main->none_active_sql.
4368   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4369 }
4370
4371 =item active_sql
4372
4373 Returns an SQL expression identifying active cust_main records (customers with
4374 active recurring packages).
4375
4376 =cut
4377
4378 sub active_sql {
4379   " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4380 }
4381
4382 =item none_active_sql
4383
4384 Returns an SQL expression identifying cust_main records with no active
4385 recurring packages.  This includes customers of status prospect, ordered,
4386 inactive, and suspended.
4387
4388 =cut
4389
4390 sub none_active_sql {
4391   " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4392 }
4393
4394 =item inactive_sql
4395
4396 Returns an SQL expression identifying inactive cust_main records (customers with
4397 no active recurring packages, but otherwise unsuspended/uncancelled).
4398
4399 =cut
4400
4401 sub inactive_sql {
4402   FS::cust_main->none_active_sql.
4403   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4404 }
4405
4406 =item susp_sql
4407 =item suspended_sql
4408
4409 Returns an SQL expression identifying suspended cust_main records.
4410
4411 =cut
4412
4413
4414 sub suspended_sql { susp_sql(@_); }
4415 sub susp_sql {
4416   FS::cust_main->none_active_sql.
4417   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4418 }
4419
4420 =item cancel_sql
4421 =item cancelled_sql
4422
4423 Returns an SQL expression identifying cancelled cust_main records.
4424
4425 =cut
4426
4427 sub cancel_sql { shift->cancelled_sql(@_); }
4428
4429 =item uncancel_sql
4430 =item uncancelled_sql
4431
4432 Returns an SQL expression identifying un-cancelled cust_main records.
4433
4434 =cut
4435
4436 sub uncancelled_sql { uncancel_sql(@_); }
4437 sub uncancel_sql { "
4438   ( 0 < ( $select_count_pkgs
4439                    AND ( cust_pkg.cancel IS NULL
4440                          OR cust_pkg.cancel = 0
4441                        )
4442         )
4443     OR 0 = ( $select_count_pkgs )
4444   )
4445 "; }
4446
4447 =item balance_sql
4448
4449 Returns an SQL fragment to retreive the balance.
4450
4451 =cut
4452
4453 sub balance_sql { "
4454     ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4455         WHERE cust_bill.custnum   = cust_main.custnum     )
4456   - ( SELECT COALESCE( SUM(paid),    0 ) FROM cust_pay
4457         WHERE cust_pay.custnum    = cust_main.custnum     )
4458   - ( SELECT COALESCE( SUM(amount),  0 ) FROM cust_credit
4459         WHERE cust_credit.custnum = cust_main.custnum     )
4460   + ( SELECT COALESCE( SUM(refund),  0 ) FROM cust_refund
4461         WHERE cust_refund.custnum = cust_main.custnum     )
4462 "; }
4463
4464 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4465
4466 Returns an SQL fragment to retreive the balance for this customer, optionally
4467 considering invoices with date earlier than START_TIME, and not
4468 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4469 total_unapplied_payments).
4470
4471 Times are specified as SQL fragments or numeric
4472 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
4473 L<Date::Parse> for conversion functions.  The empty string can be passed
4474 to disable that time constraint completely.
4475
4476 Available options are:
4477
4478 =over 4
4479
4480 =item unapplied_date
4481
4482 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)
4483
4484 =item total
4485
4486 (unused.  obsolete?)
4487 set to true to remove all customer comparison clauses, for totals
4488
4489 =item where
4490
4491 (unused.  obsolete?)
4492 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4493
4494 =item join
4495
4496 (unused.  obsolete?)
4497 JOIN clause (typically used with the total option)
4498
4499 =item cutoff
4500
4501 An absolute cutoff time.  Payments, credits, and refunds I<applied> after this
4502 time will be ignored.  Note that START_TIME and END_TIME only limit the date
4503 range for invoices and I<unapplied> payments, credits, and refunds.
4504
4505 =back
4506
4507 =cut
4508
4509 sub balance_date_sql {
4510   my( $class, $start, $end, %opt ) = @_;
4511
4512   my $cutoff = $opt{'cutoff'};
4513
4514   my $owed         = FS::cust_bill->owed_sql($cutoff);
4515   my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4516   my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4517   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
4518
4519   my $j = $opt{'join'} || '';
4520
4521   my $owed_wh   = $class->_money_table_where( 'cust_bill',   $start,$end,%opt );
4522   my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4523   my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4524   my $pay_wh    = $class->_money_table_where( 'cust_pay',    $start,$end,%opt );
4525
4526   "   ( SELECT COALESCE(SUM($owed),         0) FROM cust_bill   $j $owed_wh   )
4527     + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4528     - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4529     - ( SELECT COALESCE(SUM($unapp_pay),    0) FROM cust_pay    $j $pay_wh    )
4530   ";
4531
4532 }
4533
4534 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4535
4536 Returns an SQL fragment to retreive the total unapplied payments for this
4537 customer, only considering payments with date earlier than START_TIME, and
4538 optionally not later than END_TIME.
4539
4540 Times are specified as SQL fragments or numeric
4541 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
4542 L<Date::Parse> for conversion functions.  The empty string can be passed
4543 to disable that time constraint completely.
4544
4545 Available options are:
4546
4547 =cut
4548
4549 sub unapplied_payments_date_sql {
4550   my( $class, $start, $end, %opt ) = @_;
4551
4552   my $cutoff = $opt{'cutoff'};
4553
4554   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
4555
4556   my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4557                                                           'unapplied_date'=>1 );
4558
4559   " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4560 }
4561
4562 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4563
4564 Helper method for balance_date_sql; name (and usage) subject to change
4565 (suggestions welcome).
4566
4567 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4568 cust_refund, cust_credit or cust_pay).
4569
4570 If TABLE is "cust_bill" or the unapplied_date option is true, only
4571 considers records with date earlier than START_TIME, and optionally not
4572 later than END_TIME .
4573
4574 =cut
4575
4576 sub _money_table_where {
4577   my( $class, $table, $start, $end, %opt ) = @_;
4578
4579   my @where = ();
4580   push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4581   if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4582     push @where, "$table._date <= $start" if defined($start) && length($start);
4583     push @where, "$table._date >  $end"   if defined($end)   && length($end);
4584   }
4585   push @where, @{$opt{'where'}} if $opt{'where'};
4586   my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4587
4588   $where;
4589
4590 }
4591
4592 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4593 use FS::cust_main::Search;
4594 sub search {
4595   my $class = shift;
4596   FS::cust_main::Search->search(@_);
4597 }
4598
4599 =back
4600
4601 =head1 SUBROUTINES
4602
4603 =over 4
4604
4605 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4606
4607 Deprecated.  Use event notification and message templates
4608 (L<FS::msg_template>) instead.
4609
4610 Sends a templated email notification to the customer (see L<Text::Template>).
4611
4612 OPTIONS is a hash and may include
4613
4614 I<from> - the email sender (default is invoice_from)
4615
4616 I<to> - comma-separated scalar or arrayref of recipients
4617    (default is invoicing_list)
4618
4619 I<subject> - The subject line of the sent email notification
4620    (default is "Notice from company_name")
4621
4622 I<extra_fields> - a hashref of name/value pairs which will be substituted
4623    into the template
4624
4625 The following variables are vavailable in the template.
4626
4627 I<$first> - the customer first name
4628 I<$last> - the customer last name
4629 I<$company> - the customer company
4630 I<$payby> - a description of the method of payment for the customer
4631             # would be nice to use FS::payby::shortname
4632 I<$payinfo> - the account information used to collect for this customer
4633 I<$expdate> - the expiration of the customer payment in seconds from epoch
4634
4635 =cut
4636
4637 sub notify {
4638   my ($self, $template, %options) = @_;
4639
4640   return unless $conf->exists($template);
4641
4642   my $from = $conf->config('invoice_from', $self->agentnum)
4643     if $conf->exists('invoice_from', $self->agentnum);
4644   $from = $options{from} if exists($options{from});
4645
4646   my $to = join(',', $self->invoicing_list_emailonly);
4647   $to = $options{to} if exists($options{to});
4648
4649   my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4650     if $conf->exists('company_name', $self->agentnum);
4651   $subject = $options{subject} if exists($options{subject});
4652
4653   my $notify_template = new Text::Template (TYPE => 'ARRAY',
4654                                             SOURCE => [ map "$_\n",
4655                                               $conf->config($template)]
4656                                            )
4657     or die "can't create new Text::Template object: Text::Template::ERROR";
4658   $notify_template->compile()
4659     or die "can't compile template: Text::Template::ERROR";
4660
4661   $FS::notify_template::_template::company_name =
4662     $conf->config('company_name', $self->agentnum);
4663   $FS::notify_template::_template::company_address =
4664     join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4665
4666   my $paydate = $self->paydate || '2037-12-31';
4667   $FS::notify_template::_template::first = $self->first;
4668   $FS::notify_template::_template::last = $self->last;
4669   $FS::notify_template::_template::company = $self->company;
4670   $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4671   my $payby = $self->payby;
4672   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4673   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4674
4675   #credit cards expire at the end of the month/year of their exp date
4676   if ($payby eq 'CARD' || $payby eq 'DCRD') {
4677     $FS::notify_template::_template::payby = 'credit card';
4678     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4679     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4680     $expire_time--;
4681   }elsif ($payby eq 'COMP') {
4682     $FS::notify_template::_template::payby = 'complimentary account';
4683   }else{
4684     $FS::notify_template::_template::payby = 'current method';
4685   }
4686   $FS::notify_template::_template::expdate = $expire_time;
4687
4688   for (keys %{$options{extra_fields}}){
4689     no strict "refs";
4690     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4691   }
4692
4693   send_email(from => $from,
4694              to => $to,
4695              subject => $subject,
4696              body => $notify_template->fill_in( PACKAGE =>
4697                                                 'FS::notify_template::_template'                                              ),
4698             );
4699
4700 }
4701
4702 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4703
4704 Generates a templated notification to the customer (see L<Text::Template>).
4705
4706 OPTIONS is a hash and may include
4707
4708 I<extra_fields> - a hashref of name/value pairs which will be substituted
4709    into the template.  These values may override values mentioned below
4710    and those from the customer record.
4711
4712 The following variables are available in the template instead of or in addition
4713 to the fields of the customer record.
4714
4715 I<$payby> - a description of the method of payment for the customer
4716             # would be nice to use FS::payby::shortname
4717 I<$payinfo> - the masked account information used to collect for this customer
4718 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4719 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4720
4721 =cut
4722
4723 # a lot like cust_bill::print_latex
4724 sub generate_letter {
4725   my ($self, $template, %options) = @_;
4726
4727   return unless $conf->exists($template);
4728
4729   my $letter_template = new Text::Template
4730                         ( TYPE       => 'ARRAY',
4731                           SOURCE     => [ map "$_\n", $conf->config($template)],
4732                           DELIMITERS => [ '[@--', '--@]' ],
4733                         )
4734     or die "can't create new Text::Template object: Text::Template::ERROR";
4735
4736   $letter_template->compile()
4737     or die "can't compile template: Text::Template::ERROR";
4738
4739   my %letter_data = map { $_ => $self->$_ } $self->fields;
4740   $letter_data{payinfo} = $self->mask_payinfo;
4741
4742   #my $paydate = $self->paydate || '2037-12-31';
4743   my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4744
4745   my $payby = $self->payby;
4746   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4747   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4748
4749   #credit cards expire at the end of the month/year of their exp date
4750   if ($payby eq 'CARD' || $payby eq 'DCRD') {
4751     $letter_data{payby} = 'credit card';
4752     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4753     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4754     $expire_time--;
4755   }elsif ($payby eq 'COMP') {
4756     $letter_data{payby} = 'complimentary account';
4757   }else{
4758     $letter_data{payby} = 'current method';
4759   }
4760   $letter_data{expdate} = $expire_time;
4761
4762   for (keys %{$options{extra_fields}}){
4763     $letter_data{$_} = $options{extra_fields}->{$_};
4764   }
4765
4766   unless(exists($letter_data{returnaddress})){
4767     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4768                                                   $self->agent_template)
4769                      );
4770     if ( length($retadd) ) {
4771       $letter_data{returnaddress} = $retadd;
4772     } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4773       $letter_data{returnaddress} =
4774         join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4775                           s/$/\\\\\*/;
4776                           $_;
4777                         }
4778                     ( $conf->config('company_name', $self->agentnum),
4779                       $conf->config('company_address', $self->agentnum),
4780                     )
4781         );
4782     } else {
4783       $letter_data{returnaddress} = '~';
4784     }
4785   }
4786
4787   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4788
4789   $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4790
4791   my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4792
4793   my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4794                            DIR      => $dir,
4795                            SUFFIX   => '.eps',
4796                            UNLINK   => 0,
4797                          ) or die "can't open temp file: $!\n";
4798   print $lh $conf->config_binary('logo.eps', $self->agentnum)
4799     or die "can't write temp file: $!\n";
4800   close $lh;
4801   $letter_data{'logo_file'} = $lh->filename;
4802
4803   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4804                            DIR      => $dir,
4805                            SUFFIX   => '.tex',
4806                            UNLINK   => 0,
4807                          ) or die "can't open temp file: $!\n";
4808
4809   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4810   close $fh;
4811   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4812   return ($1, $letter_data{'logo_file'});
4813
4814 }
4815
4816 =item print_ps TEMPLATE
4817
4818 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4819
4820 =cut
4821
4822 sub print_ps {
4823   my $self = shift;
4824   my($file, $lfile) = $self->generate_letter(@_);
4825   my $ps = FS::Misc::generate_ps($file);
4826   unlink($file.'.tex');
4827   unlink($lfile);
4828
4829   $ps;
4830 }
4831
4832 =item print TEMPLATE
4833
4834 Prints the filled in template.
4835
4836 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4837
4838 =cut
4839
4840 sub queueable_print {
4841   my %opt = @_;
4842
4843   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4844     or die "invalid customer number: " . $opt{custnum};
4845
4846   my $error = $self->print( { 'template' => $opt{template} } );
4847   die $error if $error;
4848 }
4849
4850 sub print {
4851   my ($self, $template) = (shift, shift);
4852   do_print(
4853     [ $self->print_ps($template) ],
4854     'agentnum' => $self->agentnum,
4855   );
4856 }
4857
4858 #these three subs should just go away once agent stuff is all config overrides
4859
4860 sub agent_template {
4861   my $self = shift;
4862   $self->_agent_plandata('agent_templatename');
4863 }
4864
4865 sub agent_invoice_from {
4866   my $self = shift;
4867   $self->_agent_plandata('agent_invoice_from');
4868 }
4869
4870 sub _agent_plandata {
4871   my( $self, $option ) = @_;
4872
4873   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
4874   #agent-specific Conf
4875
4876   use FS::part_event::Condition;
4877
4878   my $agentnum = $self->agentnum;
4879
4880   my $regexp = regexp_sql();
4881
4882   my $part_event_option =
4883     qsearchs({
4884       'select'    => 'part_event_option.*',
4885       'table'     => 'part_event_option',
4886       'addl_from' => q{
4887         LEFT JOIN part_event USING ( eventpart )
4888         LEFT JOIN part_event_option AS peo_agentnum
4889           ON ( part_event.eventpart = peo_agentnum.eventpart
4890                AND peo_agentnum.optionname = 'agentnum'
4891                AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4892              )
4893         LEFT JOIN part_event_condition
4894           ON ( part_event.eventpart = part_event_condition.eventpart
4895                AND part_event_condition.conditionname = 'cust_bill_age'
4896              )
4897         LEFT JOIN part_event_condition_option
4898           ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4899                AND part_event_condition_option.optionname = 'age'
4900              )
4901       },
4902       #'hashref'   => { 'optionname' => $option },
4903       #'hashref'   => { 'part_event_option.optionname' => $option },
4904       'extra_sql' =>
4905         " WHERE part_event_option.optionname = ". dbh->quote($option).
4906         " AND action = 'cust_bill_send_agent' ".
4907         " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4908         " AND peo_agentnum.optionname = 'agentnum' ".
4909         " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4910         " ORDER BY
4911            CASE WHEN part_event_condition_option.optionname IS NULL
4912            THEN -1
4913            ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4914         " END
4915           , part_event.weight".
4916         " LIMIT 1"
4917     });
4918
4919   unless ( $part_event_option ) {
4920     return $self->agent->invoice_template || ''
4921       if $option eq 'agent_templatename';
4922     return '';
4923   }
4924
4925   $part_event_option->optionvalue;
4926
4927 }
4928
4929 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4930
4931 Subroutine (not a method), designed to be called from the queue.
4932
4933 Takes a list of options and values.
4934
4935 Pulls up the customer record via the custnum option and calls bill_and_collect.
4936
4937 =cut
4938
4939 sub queued_bill {
4940   my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4941
4942   my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4943   warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4944
4945   #without this errors don't get rolled back
4946   $args{'fatal'} = 1; # runs from job queue, will be caught
4947
4948   $cust_main->bill_and_collect( %args );
4949 }
4950
4951 sub process_bill_and_collect {
4952   my $job = shift;
4953   my $param = thaw(decode_base64(shift));
4954   my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
4955       or die "custnum '$param->{custnum}' not found!\n";
4956   $param->{'job'}   = $job;
4957   $param->{'fatal'} = 1; # runs from job queue, will be caught
4958   $param->{'retry'} = 1;
4959
4960   $cust_main->bill_and_collect( %$param );
4961 }
4962
4963 #starting to take quite a while for big dbs
4964 #   (JRNL: journaled so it only happens once per database)
4965 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
4966 # JRNL seq scan of cust_main on signupdate... index signupdate?  will that help?
4967 # JRNL seq scan of cust_main on paydate... index on substrings?  maybe set an
4968 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
4969 # JRNL leading/trailing spaces in first, last, company
4970 # JRNL migrate to cust_payby
4971 # - otaker upgrade?  journal and call it good?  (double check to make sure
4972 #    we're not still setting otaker here)
4973 #
4974 #only going to get worse with new location stuff...
4975
4976 sub _upgrade_data { #class method
4977   my ($class, %opts) = @_;
4978
4979   my @statements = (
4980     'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
4981   );
4982
4983   #this seems to be the only expensive one.. why does it take so long?
4984   unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
4985     push @statements,
4986       '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';
4987     FS::upgrade_journal->set_done('cust_main__signupdate');
4988   }
4989
4990   unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
4991
4992     # fix yyyy-m-dd formatted paydates
4993     if ( driver_name =~ /^mysql/i ) {
4994       push @statements,
4995       "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4996     } else { # the SQL standard
4997       push @statements,
4998       "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4999     }
5000     FS::upgrade_journal->set_done('cust_main__paydate');
5001   }
5002
5003   unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5004
5005     push @statements, #fix the weird BILL with a cc# in payinfo problem
5006       #DCRD to be safe
5007       "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5008
5009     FS::upgrade_journal->set_done('cust_main__payinfo');
5010
5011   }
5012
5013   my $t = time;
5014   foreach my $sql ( @statements ) {
5015     my $sth = dbh->prepare($sql) or die dbh->errstr;
5016     $sth->execute or die $sth->errstr;
5017     #warn ( (time - $t). " seconds\n" );
5018     #$t = time;
5019   }
5020
5021   local($ignore_expired_card) = 1;
5022   local($ignore_banned_card) = 1;
5023   local($skip_fuzzyfiles) = 1;
5024   local($import) = 1; #prevent automatic geocoding (need its own variable?)
5025
5026   FS::cust_main::Location->_upgrade_data(%opts);
5027
5028   unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5029
5030     foreach my $cust_main ( qsearch({
5031       'table'     => 'cust_main',
5032       'hashref'   => {},
5033       'extra_sql' => 'WHERE '.
5034                        join(' OR ',
5035                          map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '%  %'",
5036                            qw( first last company )
5037                        ),
5038     }) ) {
5039       my $error = $cust_main->replace;
5040       die $error if $error;
5041     }
5042
5043     FS::upgrade_journal->set_done('cust_main__trimspaces');
5044
5045   }
5046
5047   unless ( FS::upgrade_journal->is_done('cust_main__cust_payby') ) {
5048
5049     #we don't want to decrypt them, just stuff them as-is into cust_payby
5050     local(@encrypted_fields) = ();
5051
5052     local($FS::cust_payby::ignore_expired_card) = 1;
5053     local($FS::cust_payby::ignore_banned_card) = 1;
5054
5055     my @payfields = qw( payby payinfo paycvv paymask
5056                         paydate paystart_month paystart_year payissue
5057                         payname paystate paytype payip
5058                       );
5059
5060     my $search = new FS::Cursor {
5061       'table'     => 'cust_main',
5062       'extra_sql' => " WHERE ( payby IS NOT NULL AND payby != '' ) ",
5063     };
5064
5065     while (my $cust_main = $search->fetch) {
5066
5067       my $cust_payby = new FS::cust_payby {
5068         'custnum' => $cust_main->custnum,
5069         'weight'  => 1,
5070         map { $_ => $cust_main->$_(); } @payfields
5071       };
5072
5073       my $error = $cust_payby->insert;
5074       die $error if $error;
5075
5076       $cust_main->setfield($_, '') foreach @payfields;
5077       $error = $cust_main->replace;
5078       die $error if $error;
5079
5080     };
5081
5082     FS::upgrade_journal->set_done('cust_main__cust_payby');
5083   }
5084
5085   $class->_upgrade_otaker(%opts);
5086
5087 }
5088
5089 =back
5090
5091 =head1 BUGS
5092
5093 The delete method.
5094
5095 The delete method should possibly take an FS::cust_main object reference
5096 instead of a scalar customer number.
5097
5098 Bill and collect options should probably be passed as references instead of a
5099 list.
5100
5101 There should probably be a configuration file with a list of allowed credit
5102 card types.
5103
5104 No multiple currency support (probably a larger project than just this module).
5105
5106 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5107
5108 Birthdates rely on negative epoch values.
5109
5110 The payby for card/check batches is broken.  With mixed batching, bad
5111 things will happen.
5112
5113 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5114
5115 =head1 SEE ALSO
5116
5117 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5118 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5119 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
5120
5121 =cut
5122
5123 1;
5124