FS/FS/cust_main.pm

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