FS/FS/cust_main.pm

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