FS/FS/cust_main.pm

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