FS/FS/cust_main.pm

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