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