FS/FS/cust_main.pm

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