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