FS/FS/cust_main.pm

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