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