FS/FS/cust_main.pm

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