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