FS/FS/cust_main.pm

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