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