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