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
2150   if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2151        ( ! $conf->exists('require_cardname')
2152          || $self->payby !~ /^(CARD|DCRD)$/  )
2153   ) {
2154     $self->payname( $self->first. " ". $self->getfield('last') );
2155   } else {
2156
2157     if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2158       $self->payname =~ /^([\w \,\.\-\']*)$/
2159         or return gettext('illegal_name'). " payname: ". $self->payname;
2160       $self->payname($1);
2161     } else {
2162       $self->payname =~ /^([\w \,\.\-\'\&]*)$/
2163         or return gettext('illegal_name'). " payname: ". $self->payname;
2164       $self->payname($1);
2165     }
2166
2167   }
2168
2169   return "Please select an invoicing locale"
2170     if ! $self->locale
2171     && ! $self->custnum
2172     && $conf->exists('cust_main-require_locale');
2173
2174   return "Please select a customer class"
2175     if ! $self->classnum
2176     && $conf->exists('cust_main-require_classnum');
2177
2178   foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2179     $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2180     $self->$flag($1);
2181   }
2182
2183   $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2184
2185   warn "$me check AFTER: \n". $self->_dump
2186     if $DEBUG > 2;
2187
2188   $self->SUPER::check;
2189 }
2190
2191 sub check_payinfo_cardtype {
2192   my $self = shift;
2193
2194   return '' unless $self->payby =~ /^(CARD|DCRD)$/;
2195
2196   my $payinfo = $self->payinfo;
2197   $payinfo =~ s/\D//g;
2198
2199   if ( $payinfo =~ /^99\d{14}$/ ) {
2200     return '';
2201   }
2202
2203   my %bop_card_types = map { $_=>1 } values %{ card_types() };
2204   my $cardtype = cardtype($payinfo);
2205   $self->set('paycardtype', $cardtype);
2206
2207   return "$cardtype not accepted" unless $bop_card_types{$cardtype};
2208
2209   '';
2210
2211 }
2212
2213 =item replace_check
2214
2215 Additional checks for replace only.
2216
2217 =cut
2218
2219 sub replace_check {
2220   my ($new,$old) = @_;
2221   #preserve old value if global config is set
2222   if ($old && $conf->exists('invoice-ship_address')) {
2223     $new->invoice_ship_address($old->invoice_ship_address);
2224   }
2225   return '';
2226 }
2227
2228 =item addr_fields
2229
2230 Returns a list of fields which have ship_ duplicates.
2231
2232 =cut
2233
2234 sub addr_fields {
2235   qw( last first company
2236       locationname
2237       address1 address2 city county state zip country
2238       latitude longitude
2239       daytime night fax mobile
2240     );
2241 }
2242
2243 =item has_ship_address
2244
2245 Returns true if this customer record has a separate shipping address.
2246
2247 =cut
2248
2249 sub has_ship_address {
2250   my $self = shift;
2251   $self->bill_locationnum != $self->ship_locationnum;
2252 }
2253
2254 =item location_hash
2255
2256 Returns a list of key/value pairs, with the following keys: address1,
2257 adddress2, city, county, state, zip, country, district, and geocode.  The
2258 shipping address is used if present.
2259
2260 =cut
2261
2262 sub location_hash {
2263   my $self = shift;
2264   $self->ship_location->location_hash;
2265 }
2266
2267 =item cust_location
2268
2269 Returns all locations (see L<FS::cust_location>) for this customer.
2270
2271 =cut
2272
2273 sub cust_location {
2274   my $self = shift;
2275   qsearch('cust_location', { 'custnum' => $self->custnum,
2276                              'prospectnum' => '' } );
2277 }
2278
2279 =item cust_contact
2280
2281 Returns all contacts (see L<FS::contact>) for this customer.
2282
2283 =cut
2284
2285 #already used :/ sub contact {
2286 sub cust_contact {
2287   my $self = shift;
2288   qsearch('contact', { 'custnum' => $self->custnum } );
2289 }
2290
2291 =item unsuspend
2292
2293 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2294 and L<FS::cust_pkg>) for this customer, except those on hold.
2295
2296 Returns a list: an empty list on success or a list of errors.
2297
2298 =cut
2299
2300 sub unsuspend {
2301   my $self = shift;
2302   grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2303 }
2304
2305 =item release_hold
2306
2307 Unsuspends all suspended packages in the on-hold state (those without setup
2308 dates) for this customer.
2309
2310 =cut
2311
2312 sub release_hold {
2313   my $self = shift;
2314   grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2315 }
2316
2317 =item suspend
2318
2319 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2320
2321 Returns a list: an empty list on success or a list of errors.
2322
2323 =cut
2324
2325 sub suspend {
2326   my $self = shift;
2327   grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2328 }
2329
2330 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2331
2332 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2333 PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref instead
2334 of a list of pkgparts; the hashref has the following keys:
2335
2336 =over 4
2337
2338 =item pkgparts - listref of pkgparts
2339
2340 =item (other options are passed to the suspend method)
2341
2342 =back
2343
2344
2345 Returns a list: an empty list on success or a list of errors.
2346
2347 =cut
2348
2349 sub suspend_if_pkgpart {
2350   my $self = shift;
2351   my (@pkgparts, %opt);
2352   if (ref($_[0]) eq 'HASH'){
2353     @pkgparts = @{$_[0]{pkgparts}};
2354     %opt      = %{$_[0]};
2355   }else{
2356     @pkgparts = @_;
2357   }
2358   grep { $_->suspend(%opt) }
2359     grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2360       $self->unsuspended_pkgs;
2361 }
2362
2363 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2364
2365 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2366 given PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref
2367 instead of a list of pkgparts; the hashref has the following keys:
2368
2369 =over 4
2370
2371 =item pkgparts - listref of pkgparts
2372
2373 =item (other options are passed to the suspend method)
2374
2375 =back
2376
2377 Returns a list: an empty list on success or a list of errors.
2378
2379 =cut
2380
2381 sub suspend_unless_pkgpart {
2382   my $self = shift;
2383   my (@pkgparts, %opt);
2384   if (ref($_[0]) eq 'HASH'){
2385     @pkgparts = @{$_[0]{pkgparts}};
2386     %opt      = %{$_[0]};
2387   }else{
2388     @pkgparts = @_;
2389   }
2390   grep { $_->suspend(%opt) }
2391     grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2392       $self->unsuspended_pkgs;
2393 }
2394
2395 =item cancel [ OPTION => VALUE ... ]
2396
2397 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2398 The cancellation time will be now.
2399
2400 =back
2401
2402 Always returns a list: an empty list on success or a list of errors.
2403
2404 =cut
2405
2406 sub cancel {
2407   my $self = shift;
2408   my %opt = @_;
2409   warn "$me cancel called on customer ". $self->custnum. " with options ".
2410        join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2411     if $DEBUG;
2412   my @pkgs = $self->ncancelled_pkgs;
2413
2414   $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2415 }
2416
2417 =item cancel_pkgs OPTIONS
2418
2419 Cancels a specified list of packages. OPTIONS can include:
2420
2421 =over 4
2422
2423 =item cust_pkg - an arrayref of the packages. Required.
2424
2425 =item time - the cancellation time, used to calculate final bills and
2426 unused-time credits if any. Will be passed through to the bill() and
2427 FS::cust_pkg::cancel() methods.
2428
2429 =item quiet - can be set true to supress email cancellation notices.
2430
2431 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a
2432 reasonnum of an existing reason, or passing a hashref will create a new reason.
2433 The hashref should have the following keys:
2434 typenum - Reason type (see L<FS::reason_type>)
2435 reason - Text of the new reason.
2436
2437 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2438 for the individual packages, parallel to the C<cust_pkg> argument. The
2439 reason and reason_otaker arguments will be taken from those objects.
2440
2441 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2442
2443 =item nobill - can be set true to skip billing if it might otherwise be done.
2444
2445 =cut
2446
2447 sub cancel_pkgs {
2448   my( $self, %opt ) = @_;
2449
2450   # we're going to cancel services, which is not reversible
2451   # but on 3.x, don't strictly enforce this
2452   warn "cancel_pkgs should not be run inside a transaction"
2453     if $FS::UID::AutoCommit == 0;
2454
2455   local $FS::UID::AutoCommit = 0;
2456
2457   return ( 'access denied' )
2458     unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2459
2460   if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2461
2462     #should try decryption (we might have the private key)
2463     # and if not maybe queue a job for the server that does?
2464     return ( "Can't (yet) ban encrypted credit cards" )
2465       if $self->is_encrypted($self->payinfo);
2466
2467     my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2468     my $error = $ban->insert;
2469     if ($error) {
2470       dbh->rollback;
2471       return ( $error );
2472     }
2473
2474   }
2475
2476   my @pkgs = @{ delete $opt{'cust_pkg'} };
2477   my $cancel_time = $opt{'time'} || time;
2478
2479   # bill all packages first, so we don't lose usage, service counts for
2480   # bulk billing, etc.
2481   if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2482     $opt{nobill} = 1;
2483     my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2484                              'cancel'   => 1,
2485                              'time'     => $cancel_time );
2486     if ($error) {
2487       warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2488       dbh->rollback;
2489       return ( "Error billing during cancellation: $error" );
2490     }
2491   }
2492   dbh->commit;
2493
2494   $FS::UID::AutoCommit = 1;
2495   my @errors;
2496   # now cancel all services, the same way we would for individual packages.
2497   # if any of them fail, cancel the rest anyway.
2498   my @cust_svc = map { $_->cust_svc } @pkgs;
2499   my @sorted_cust_svc =
2500     map  { $_->[0] }
2501     sort { $a->[1] <=> $b->[1] }
2502     map  { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2503   ;
2504   warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2505     $self->custnum."\n"
2506     if $DEBUG;
2507   foreach my $cust_svc (@sorted_cust_svc) {
2508     my $part_svc = $cust_svc->part_svc;
2509     next if ( defined($part_svc) and $part_svc->preserve );
2510     my $error = $cust_svc->cancel; # immediate cancel, no date option
2511     push @errors, $error if $error;
2512   }
2513   if (@errors) {
2514     return @errors;
2515   }
2516
2517   warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2518     $self->custnum. "\n"
2519     if $DEBUG;
2520
2521   my @cprs;
2522   if ($opt{'cust_pkg_reason'}) {
2523     @cprs = @{ delete $opt{'cust_pkg_reason'} };
2524   }
2525   my $null_reason;
2526   foreach (@pkgs) {
2527     my %lopt = %opt;
2528     if (@cprs) {
2529       my $cpr = shift @cprs;
2530       if ( $cpr ) {
2531         $lopt{'reason'}        = $cpr->reasonnum;
2532         $lopt{'reason_otaker'} = $cpr->otaker;
2533       } else {
2534         warn "no reason found when canceling package ".$_->pkgnum."\n";
2535         $lopt{'reason'} = '';
2536       }
2537     }
2538     my $error = $_->cancel(%lopt);
2539     push @errors, 'pkgnum '.$_->pkgnum.': '.$error if $error;
2540   }
2541
2542   return @errors;
2543 }
2544
2545 sub _banned_pay_hashref {
2546   my $self = shift;
2547
2548   my %payby2ban = (
2549     'CARD' => 'CARD',
2550     'DCRD' => 'CARD',
2551     'CHEK' => 'CHEK',
2552     'DCHK' => 'CHEK'
2553   );
2554
2555   {
2556     'payby'   => $payby2ban{$self->payby},
2557     'payinfo' => $self->payinfo,
2558     #don't ever *search* on reason! #'reason'  =>
2559   };
2560 }
2561
2562 sub _new_banned_pay_hashref {
2563   my $self = shift;
2564   my $hr = $self->_banned_pay_hashref;
2565   $hr->{payinfo} = md5_base64($hr->{payinfo});
2566   $hr;
2567 }
2568
2569 =item notes
2570
2571 Returns all notes (see L<FS::cust_main_note>) for this customer.
2572
2573 =cut
2574
2575 sub notes {
2576   my($self,$orderby_classnum) = (shift,shift);
2577   my $orderby = "sticky DESC, _date DESC";
2578   $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2579   qsearch( 'cust_main_note',
2580            { 'custnum' => $self->custnum },
2581            '',
2582            "ORDER BY $orderby",
2583          );
2584 }
2585
2586 =item agent
2587
2588 Returns the agent (see L<FS::agent>) for this customer.
2589
2590 =cut
2591
2592 sub agent {
2593   my $self = shift;
2594   qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2595 }
2596
2597 =item agent_name
2598
2599 Returns the agent name (see L<FS::agent>) for this customer.
2600
2601 =cut
2602
2603 sub agent_name {
2604   my $self = shift;
2605   $self->agent->agent;
2606 }
2607
2608 =item cust_tag
2609
2610 Returns any tags associated with this customer, as FS::cust_tag objects,
2611 or an empty list if there are no tags.
2612
2613 =cut
2614
2615 sub cust_tag {
2616   my $self = shift;
2617   qsearch('cust_tag', { 'custnum' => $self->custnum } );
2618 }
2619
2620 =item part_tag
2621
2622 Returns any tags associated with this customer, as FS::part_tag objects,
2623 or an empty list if there are no tags.
2624
2625 =cut
2626
2627 sub part_tag {
2628   my $self = shift;
2629   map $_->part_tag, $self->cust_tag;
2630 }
2631
2632
2633 =item cust_class
2634
2635 Returns the customer class, as an FS::cust_class object, or the empty string
2636 if there is no customer class.
2637
2638 =cut
2639
2640 sub cust_class {
2641   my $self = shift;
2642   if ( $self->classnum ) {
2643     qsearchs('cust_class', { 'classnum' => $self->classnum } );
2644   } else {
2645     return '';
2646   }
2647 }
2648
2649 =item categoryname
2650
2651 Returns the customer category name, or the empty string if there is no customer
2652 category.
2653
2654 =cut
2655
2656 sub categoryname {
2657   my $self = shift;
2658   my $cust_class = $self->cust_class;
2659   $cust_class
2660     ? $cust_class->categoryname
2661     : '';
2662 }
2663
2664 =item classname
2665
2666 Returns the customer class name, or the empty string if there is no customer
2667 class.
2668
2669 =cut
2670
2671 sub classname {
2672   my $self = shift;
2673   my $cust_class = $self->cust_class;
2674   $cust_class
2675     ? $cust_class->classname
2676     : '';
2677 }
2678
2679 =item BILLING METHODS
2680
2681 Documentation on billing methods has been moved to
2682 L<FS::cust_main::Billing>.
2683
2684 =item REALTIME BILLING METHODS
2685
2686 Documentation on realtime billing methods has been moved to
2687 L<FS::cust_main::Billing_Realtime>.
2688
2689 =item remove_cvv
2690
2691 Removes the I<paycvv> field from the database directly.
2692
2693 If there is an error, returns the error, otherwise returns false.
2694
2695 =cut
2696
2697 sub remove_cvv {
2698   my $self = shift;
2699   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2700     or return dbh->errstr;
2701   $sth->execute($self->custnum)
2702     or return $sth->errstr;
2703   $self->paycvv('');
2704   '';
2705 }
2706
2707 =item batch_card OPTION => VALUE...
2708
2709 Adds a payment for this invoice to the pending credit card batch (see
2710 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2711 runs the payment using a realtime gateway.
2712
2713 Options may include:
2714
2715 B<amount>: the amount to be paid; defaults to the customer's balance minus
2716 any payments in transit.
2717
2718 B<payby>: the payment method; defaults to cust_main.payby
2719
2720 B<realtime>: runs this as a realtime payment instead of adding it to a
2721 batch.  Deprecated.
2722
2723 B<invnum>: sets cust_pay_batch.invnum.
2724
2725 B<address1>, B<address2>, B<city>, B<state>, B<zip>, B<country>: sets
2726 the billing address for the payment; defaults to the customer's billing
2727 location.
2728
2729 B<payinfo>, B<paydate>, B<payname>: sets the payment account, expiration
2730 date, and name; defaults to those fields in cust_main.
2731
2732 =cut
2733
2734 sub batch_card {
2735   my ($self, %options) = @_;
2736
2737   my $amount;
2738   if (exists($options{amount})) {
2739     $amount = $options{amount};
2740   }else{
2741     $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2742   }
2743   if ($amount <= 0) {
2744     warn(sprintf("Customer balance %.2f - in transit amount %.2f is <= 0.\n",
2745         $self->balance,
2746         $self->in_transit_payments
2747     ));
2748     return;
2749   }
2750
2751   my $invnum = delete $options{invnum};
2752   my $payby = $options{payby} || $self->payby;  #still dubious
2753
2754   if ($options{'realtime'}) {
2755     return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2756                                 $amount,
2757                                 %options,
2758                               );
2759   }
2760
2761   my $oldAutoCommit = $FS::UID::AutoCommit;
2762   local $FS::UID::AutoCommit = 0;
2763   my $dbh = dbh;
2764
2765   #this needs to handle mysql as well as Pg, like svc_acct.pm
2766   #(make it into a common function if folks need to do batching with mysql)
2767   $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2768     or return "Cannot lock pay_batch: " . $dbh->errstr;
2769
2770   my %pay_batch = (
2771     'status' => 'O',
2772     'payby'  => FS::payby->payby2payment($payby),
2773   );
2774   $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2775
2776   my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2777
2778   unless ( $pay_batch ) {
2779     $pay_batch = new FS::pay_batch \%pay_batch;
2780     my $error = $pay_batch->insert;
2781     if ( $error ) {
2782       $dbh->rollback if $oldAutoCommit;
2783       die "error creating new batch: $error\n";
2784     }
2785   }
2786
2787   my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2788       'batchnum' => $pay_batch->batchnum,
2789       'custnum'  => $self->custnum,
2790   } );
2791
2792   foreach (qw( address1 address2 city state zip country latitude longitude
2793                payby payinfo paydate payname paycode paytype ))
2794   {
2795     $options{$_} = '' unless exists($options{$_});
2796   }
2797
2798   my $loc = $self->bill_location;
2799
2800   my $cust_pay_batch = new FS::cust_pay_batch ( {
2801     'batchnum' => $pay_batch->batchnum,
2802     'invnum'   => $invnum || 0,                    # is there a better value?
2803                                                    # this field should be
2804                                                    # removed...
2805                                                    # cust_bill_pay_batch now
2806     'custnum'  => $self->custnum,
2807     'last'     => $self->getfield('last'),
2808     'first'    => $self->getfield('first'),
2809     'address1' => $options{address1} || $loc->address1,
2810     'address2' => $options{address2} || $loc->address2,
2811     'city'     => $options{city}     || $loc->city,
2812     'state'    => $options{state}    || $loc->state,
2813     'zip'      => $options{zip}      || $loc->zip,
2814     'country'  => $options{country}  || $loc->country,
2815     'payby'    => $options{payby}    || $self->payby,
2816     'payinfo'  => $options{payinfo}  || $self->payinfo,
2817     'exp'      => $options{paydate}  || $self->paydate,
2818     'payname'  => $options{payname}  || $self->payname,
2819     'amount'   => $amount,                         # consolidating
2820     'paycode'  => $options{paycode}  || '',
2821   } );
2822
2823   $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2824     if $old_cust_pay_batch;
2825
2826   my $error;
2827   if ($old_cust_pay_batch) {
2828     $error = $cust_pay_batch->replace($old_cust_pay_batch)
2829   } else {
2830     $error = $cust_pay_batch->insert;
2831   }
2832
2833   if ( $error ) {
2834     $dbh->rollback if $oldAutoCommit;
2835     die $error;
2836   }
2837
2838   my $unapplied =   $self->total_unapplied_credits
2839                   + $self->total_unapplied_payments
2840                   + $self->in_transit_payments;
2841   foreach my $cust_bill ($self->open_cust_bill) {
2842     #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2843     my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2844       'invnum' => $cust_bill->invnum,
2845       'paybatchnum' => $cust_pay_batch->paybatchnum,
2846       'amount' => $cust_bill->owed,
2847       '_date' => time,
2848     };
2849     if ($unapplied >= $cust_bill_pay_batch->amount){
2850       $unapplied -= $cust_bill_pay_batch->amount;
2851       next;
2852     }else{
2853       $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2854                                    $cust_bill_pay_batch->amount - $unapplied ));      $unapplied = 0;
2855     }
2856     $error = $cust_bill_pay_batch->insert;
2857     if ( $error ) {
2858       $dbh->rollback if $oldAutoCommit;
2859       die $error;
2860     }
2861   }
2862
2863   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2864   '';
2865 }
2866
2867 =item total_owed
2868
2869 Returns the total owed for this customer on all invoices
2870 (see L<FS::cust_bill/owed>).
2871
2872 =cut
2873
2874 sub total_owed {
2875   my $self = shift;
2876   $self->total_owed_date(2145859200); #12/31/2037
2877 }
2878
2879 =item total_owed_date TIME
2880
2881 Returns the total owed for this customer on all invoices with date earlier than
2882 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2883 see L<Time::Local> and L<Date::Parse> for conversion functions.
2884
2885 =cut
2886
2887 sub total_owed_date {
2888   my $self = shift;
2889   my $time = shift;
2890
2891   my $custnum = $self->custnum;
2892
2893   my $owed_sql = FS::cust_bill->owed_sql;
2894
2895   my $sql = "
2896     SELECT SUM($owed_sql) FROM cust_bill
2897       WHERE custnum = $custnum
2898         AND _date <= $time
2899   ";
2900
2901   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2902
2903 }
2904
2905 =item total_owed_pkgnum PKGNUM
2906
2907 Returns the total owed on all invoices for this customer's specific package
2908 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2909
2910 =cut
2911
2912 sub total_owed_pkgnum {
2913   my( $self, $pkgnum ) = @_;
2914   $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2915 }
2916
2917 =item total_owed_date_pkgnum TIME PKGNUM
2918
2919 Returns the total owed for this customer's specific package when using
2920 experimental package balances on all invoices with date earlier than
2921 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2922 see L<Time::Local> and L<Date::Parse> for conversion functions.
2923
2924 =cut
2925
2926 sub total_owed_date_pkgnum {
2927   my( $self, $time, $pkgnum ) = @_;
2928
2929   my $total_bill = 0;
2930   foreach my $cust_bill (
2931     grep { $_->_date <= $time }
2932       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2933   ) {
2934     $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2935   }
2936   sprintf( "%.2f", $total_bill );
2937
2938 }
2939
2940 =item total_paid
2941
2942 Returns the total amount of all payments.
2943
2944 =cut
2945
2946 sub total_paid {
2947   my $self = shift;
2948   my $total = 0;
2949   $total += $_->paid foreach $self->cust_pay;
2950   sprintf( "%.2f", $total );
2951 }
2952
2953 =item total_unapplied_credits
2954
2955 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2956 customer.  See L<FS::cust_credit/credited>.
2957
2958 =item total_credited
2959
2960 Old name for total_unapplied_credits.  Don't use.
2961
2962 =cut
2963
2964 sub total_credited {
2965   #carp "total_credited deprecated, use total_unapplied_credits";
2966   shift->total_unapplied_credits(@_);
2967 }
2968
2969 sub total_unapplied_credits {
2970   my $self = shift;
2971
2972   my $custnum = $self->custnum;
2973
2974   my $unapplied_sql = FS::cust_credit->unapplied_sql;
2975
2976   my $sql = "
2977     SELECT SUM($unapplied_sql) FROM cust_credit
2978       WHERE custnum = $custnum
2979   ";
2980
2981   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2982
2983 }
2984
2985 =item total_unapplied_credits_pkgnum PKGNUM
2986
2987 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2988 customer.  See L<FS::cust_credit/credited>.
2989
2990 =cut
2991
2992 sub total_unapplied_credits_pkgnum {
2993   my( $self, $pkgnum ) = @_;
2994   my $total_credit = 0;
2995   $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2996   sprintf( "%.2f", $total_credit );
2997 }
2998
2999
3000 =item total_unapplied_payments
3001
3002 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3003 See L<FS::cust_pay/unapplied>.
3004
3005 =cut
3006
3007 sub total_unapplied_payments {
3008   my $self = shift;
3009
3010   my $custnum = $self->custnum;
3011
3012   my $unapplied_sql = FS::cust_pay->unapplied_sql;
3013
3014   my $sql = "
3015     SELECT SUM($unapplied_sql) FROM cust_pay
3016       WHERE custnum = $custnum
3017   ";
3018
3019   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
3020
3021 }
3022
3023 =item total_unapplied_payments_pkgnum PKGNUM
3024
3025 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
3026 specific package when using experimental package balances.  See
3027 L<FS::cust_pay/unapplied>.
3028
3029 =cut
3030
3031 sub total_unapplied_payments_pkgnum {
3032   my( $self, $pkgnum ) = @_;
3033   my $total_unapplied = 0;
3034   $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
3035   sprintf( "%.2f", $total_unapplied );
3036 }
3037
3038
3039 =item total_unapplied_refunds
3040
3041 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
3042 customer.  See L<FS::cust_refund/unapplied>.
3043
3044 =cut
3045
3046 sub total_unapplied_refunds {
3047   my $self = shift;
3048   my $custnum = $self->custnum;
3049
3050   my $unapplied_sql = FS::cust_refund->unapplied_sql;
3051
3052   my $sql = "
3053     SELECT SUM($unapplied_sql) FROM cust_refund
3054       WHERE custnum = $custnum
3055   ";
3056
3057   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
3058
3059 }
3060
3061 =item balance
3062
3063 Returns the balance for this customer (total_owed plus total_unrefunded, minus
3064 total_unapplied_credits minus total_unapplied_payments).
3065
3066 =cut
3067
3068 sub balance {
3069   my $self = shift;
3070   $self->balance_date_range;
3071 }
3072
3073 =item balance_date TIME
3074
3075 Returns the balance for this customer, only considering invoices with date
3076 earlier than TIME (total_owed_date minus total_credited minus
3077 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
3078 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
3079 functions.
3080
3081 =cut
3082
3083 sub balance_date {
3084   my $self = shift;
3085   $self->balance_date_range(shift);
3086 }
3087
3088 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
3089
3090 Returns the balance for this customer, optionally considering invoices with
3091 date earlier than START_TIME, and not later than END_TIME
3092 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
3093
3094 Times are specified as SQL fragments or numeric
3095 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
3096 L<Date::Parse> for conversion functions.  The empty string can be passed
3097 to disable that time constraint completely.
3098
3099 Accepts the same options as L<balance_date_sql>:
3100
3101 =over 4
3102
3103 =item unapplied_date
3104
3105 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)
3106
3107 =item cutoff
3108
3109 An absolute cutoff time.  Payments, credits, and refunds I<applied> after this
3110 time will be ignored.  Note that START_TIME and END_TIME only limit the date
3111 range for invoices and I<unapplied> payments, credits, and refunds.
3112
3113 =back
3114
3115 =cut
3116
3117 sub balance_date_range {
3118   my $self = shift;
3119   my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
3120             ') FROM cust_main WHERE custnum='. $self->custnum;
3121   sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
3122 }
3123
3124 =item balance_pkgnum PKGNUM
3125
3126 Returns the balance for this customer's specific package when using
3127 experimental package balances (total_owed plus total_unrefunded, minus
3128 total_unapplied_credits minus total_unapplied_payments)
3129
3130 =cut
3131
3132 sub balance_pkgnum {
3133   my( $self, $pkgnum ) = @_;
3134
3135   sprintf( "%.2f",
3136       $self->total_owed_pkgnum($pkgnum)
3137 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
3138 #    + $self->total_unapplied_refunds_pkgnum($pkgnum)
3139     - $self->total_unapplied_credits_pkgnum($pkgnum)
3140     - $self->total_unapplied_payments_pkgnum($pkgnum)
3141   );
3142 }
3143
3144 =item in_transit_payments
3145
3146 Returns the total of requests for payments for this customer pending in
3147 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
3148
3149 =cut
3150
3151 sub in_transit_payments {
3152   my $self = shift;
3153   my $in_transit_payments = 0;
3154   foreach my $pay_batch ( qsearch('pay_batch', {
3155     'status' => 'I',
3156   } ) ) {
3157     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
3158       'batchnum' => $pay_batch->batchnum,
3159       'custnum' => $self->custnum,
3160       'status'  => '',
3161     } ) ) {
3162       $in_transit_payments += $cust_pay_batch->amount;
3163     }
3164   }
3165   sprintf( "%.2f", $in_transit_payments );
3166 }
3167
3168 =item payment_info
3169
3170 Returns a hash of useful information for making a payment.
3171
3172 =over 4
3173
3174 =item balance
3175
3176 Current balance.
3177
3178 =item payby
3179
3180 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
3181 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
3182 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
3183
3184 =back
3185
3186 For credit card transactions:
3187
3188 =over 4
3189
3190 =item card_type 1
3191
3192 =item payname
3193
3194 Exact name on card
3195
3196 =back
3197
3198 For electronic check transactions:
3199
3200 =over 4
3201
3202 =item stateid_state
3203
3204 =back
3205
3206 =cut
3207
3208 sub payment_info {
3209   my $self = shift;
3210
3211   my %return = ();
3212
3213   $return{balance} = $self->balance;
3214
3215   $return{payname} = $self->payname
3216                      || ( $self->first. ' '. $self->get('last') );
3217
3218   $return{$_} = $self->bill_location->$_
3219     for qw(address1 address2 city state zip);
3220
3221   $return{payby} = $self->payby;
3222   $return{stateid_state} = $self->stateid_state;
3223
3224   if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
3225     $return{card_type} = cardtype($self->payinfo);
3226     $return{payinfo} = $self->paymask;
3227
3228     @return{'month', 'year'} = $self->paydate_monthyear;
3229
3230   }
3231
3232   if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
3233     my ($payinfo1, $payinfo2) = split '@', $self->paymask;
3234     $return{payinfo1} = $payinfo1;
3235     $return{payinfo2} = $payinfo2;
3236     $return{paytype}  = $self->paytype;
3237     $return{paystate} = $self->paystate;
3238
3239   }
3240
3241   #doubleclick protection
3242   my $_date = time;
3243   $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
3244
3245   %return;
3246
3247 }
3248
3249 =item paydate_monthyear
3250
3251 Returns a two-element list consisting of the month and year of this customer's
3252 paydate (credit card expiration date for CARD customers)
3253
3254 =cut
3255
3256 sub paydate_monthyear {
3257   my $self = shift;
3258   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3259     ( $2, $1 );
3260   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3261     ( $1, $3 );
3262   } else {
3263     ('', '');
3264   }
3265 }
3266
3267 =item paydate_epoch
3268
3269 Returns the exact time in seconds corresponding to the payment method
3270 expiration date.  For CARD/DCRD customers this is the end of the month;
3271 for others (COMP is the only other payby that uses paydate) it's the start.
3272 Returns 0 if the paydate is empty or set to the far future.
3273
3274 =cut
3275
3276 sub paydate_epoch {
3277   my $self = shift;
3278   my ($month, $year) = $self->paydate_monthyear;
3279   return 0 if !$year or $year >= 2037;
3280   if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3281     $month++;
3282     if ( $month == 13 ) {
3283       $month = 1;
3284       $year++;
3285     }
3286     return timelocal(0,0,0,1,$month-1,$year) - 1;
3287   }
3288   else {
3289     return timelocal(0,0,0,1,$month-1,$year);
3290   }
3291 }
3292
3293 =item paydate_epoch_sql
3294
3295 Class method.  Returns an SQL expression to obtain the payment expiration date
3296 as a number of seconds.
3297
3298 =cut
3299
3300 # Special expiration date behavior for non-CARD/DCRD customers has been
3301 # carefully preserved.  Do we really use that?
3302 sub paydate_epoch_sql {
3303   my $class = shift;
3304   my $table = shift || 'cust_main';
3305   my ($case1, $case2);
3306   if ( driver_name eq 'Pg' ) {
3307     $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3308     $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3309   }
3310   elsif ( lc(driver_name) eq 'mysql' ) {
3311     $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3312     $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3313   }
3314   else { return '' }
3315   return "CASE WHEN $table.payby IN('CARD','DCRD')
3316   THEN ($case1)
3317   ELSE ($case2)
3318   END"
3319 }
3320
3321 =item tax_exemption TAXNAME
3322
3323 =cut
3324
3325 sub tax_exemption {
3326   my( $self, $taxname ) = @_;
3327
3328   qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3329                                      'taxname' => $taxname,
3330                                    },
3331           );
3332 }
3333
3334 =item cust_main_exemption
3335
3336 =cut
3337
3338 sub cust_main_exemption {
3339   my $self = shift;
3340   qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3341 }
3342
3343 =item invoicing_list [ ARRAYREF ]
3344
3345 If an arguement is given, sets these email addresses as invoice recipients
3346 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
3347 (except as warnings), so use check_invoicing_list first.
3348
3349 Returns a list of email addresses (with svcnum entries expanded).
3350
3351 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
3352 check it without disturbing anything by passing nothing.
3353
3354 This interface may change in the future.
3355
3356 =cut
3357
3358 sub invoicing_list {
3359   my( $self, $arrayref ) = @_;
3360
3361   if ( $arrayref ) {
3362     my @cust_main_invoice;
3363     if ( $self->custnum ) {
3364       @cust_main_invoice =
3365         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3366     } else {
3367       @cust_main_invoice = ();
3368     }
3369     foreach my $cust_main_invoice ( @cust_main_invoice ) {
3370       #warn $cust_main_invoice->destnum;
3371       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3372         #warn $cust_main_invoice->destnum;
3373         my $error = $cust_main_invoice->delete;
3374         warn $error if $error;
3375       }
3376     }
3377     if ( $self->custnum ) {
3378       @cust_main_invoice =
3379         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3380     } else {
3381       @cust_main_invoice = ();
3382     }
3383     my %seen = map { $_->address => 1 } @cust_main_invoice;
3384     foreach my $address ( @{$arrayref} ) {
3385       next if exists $seen{$address} && $seen{$address};
3386       $seen{$address} = 1;
3387       my $cust_main_invoice = new FS::cust_main_invoice ( {
3388         'custnum' => $self->custnum,
3389         'dest'    => $address,
3390       } );
3391       my $error = $cust_main_invoice->insert;
3392       warn $error if $error;
3393     }
3394   }
3395
3396   if ( $self->custnum ) {
3397     map { $_->address }
3398       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3399   } else {
3400     ();
3401   }
3402
3403 }
3404
3405 =item check_invoicing_list ARRAYREF
3406
3407 Checks these arguements as valid input for the invoicing_list method.  If there
3408 is an error, returns the error, otherwise returns false.
3409
3410 =cut
3411
3412 sub check_invoicing_list {
3413   my( $self, $arrayref ) = @_;
3414
3415   foreach my $address ( @$arrayref ) {
3416
3417     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3418       return 'Can\'t add FAX invoice destination with a blank FAX number.';
3419     }
3420
3421     my $cust_main_invoice = new FS::cust_main_invoice ( {
3422       'custnum' => $self->custnum,
3423       'dest'    => $address,
3424     } );
3425     my $error = $self->custnum
3426                 ? $cust_main_invoice->check
3427                 : $cust_main_invoice->checkdest
3428     ;
3429     return $error if $error;
3430
3431   }
3432
3433   return "Email address required"
3434     if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
3435     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3436
3437   '';
3438 }
3439
3440 =item set_default_invoicing_list
3441
3442 Sets the invoicing list to all accounts associated with this customer,
3443 overwriting any previous invoicing list.
3444
3445 =cut
3446
3447 sub set_default_invoicing_list {
3448   my $self = shift;
3449   $self->invoicing_list($self->all_emails);
3450 }
3451
3452 =item all_emails
3453
3454 Returns the email addresses of all accounts provisioned for this customer.
3455
3456 =cut
3457
3458 sub all_emails {
3459   my $self = shift;
3460   my %list;
3461   foreach my $cust_pkg ( $self->all_pkgs ) {
3462     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3463     my @svc_acct =
3464       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3465         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3466           @cust_svc;
3467     $list{$_}=1 foreach map { $_->email } @svc_acct;
3468   }
3469   keys %list;
3470 }
3471
3472 =item invoicing_list_addpost
3473
3474 Adds postal invoicing to this customer.  If this customer is already configured
3475 to receive postal invoices, does nothing.
3476
3477 =cut
3478
3479 sub invoicing_list_addpost {
3480   my $self = shift;
3481   return if grep { $_ eq 'POST' } $self->invoicing_list;
3482   my @invoicing_list = $self->invoicing_list;
3483   push @invoicing_list, 'POST';
3484   $self->invoicing_list(\@invoicing_list);
3485 }
3486
3487 =item invoicing_list_emailonly
3488
3489 Returns the list of email invoice recipients (invoicing_list without non-email
3490 destinations such as POST and FAX).
3491
3492 =cut
3493
3494 sub invoicing_list_emailonly {
3495   my $self = shift;
3496   warn "$me invoicing_list_emailonly called"
3497     if $DEBUG;
3498   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3499 }
3500
3501 =item invoicing_list_emailonly_scalar
3502
3503 Returns the list of email invoice recipients (invoicing_list without non-email
3504 destinations such as POST and FAX) as a comma-separated scalar.
3505
3506 =cut
3507
3508 sub invoicing_list_emailonly_scalar {
3509   my $self = shift;
3510   warn "$me invoicing_list_emailonly_scalar called"
3511     if $DEBUG;
3512   join(', ', $self->invoicing_list_emailonly);
3513 }
3514
3515 =item contact_list [ CLASSNUM, ... ]
3516
3517 Returns a list of contacts (L<FS::contact> objects) for the customer. If
3518 a list of contact classnums is given, returns only contacts in those
3519 classes. If '0' is given, also returns contacts with no class.
3520
3521 If no arguments are given, returns all contacts for the customer.
3522
3523 =cut
3524
3525 sub contact_list {
3526   my $self = shift;
3527   my $search = {
3528     table       => 'contact',
3529     select      => 'contact.*',
3530     extra_sql   => ' WHERE contact.custnum = '.$self->custnum,
3531   };
3532
3533   my @orwhere;
3534   my @classnums;
3535   foreach (@_) {
3536     if ( $_ eq '0' ) {
3537       push @orwhere, 'contact.classnum is null';
3538     } elsif ( /^\d+$/ ) {
3539       push @classnums, $_;
3540     } else {
3541       die "bad classnum argument '$_'";
3542     }
3543   }
3544
3545   if (@classnums) {
3546     push @orwhere, 'contact.classnum IN ('.join(',', @classnums).')';
3547   }
3548   if (@orwhere) {
3549     $search->{extra_sql} .= ' AND (' .
3550                             join(' OR ', map "( $_ )", @orwhere) .
3551                             ')';
3552   }
3553
3554   qsearch($search);
3555 }
3556
3557 =item contact_list_email [ CLASSNUM, ... ]
3558
3559 Same as L</contact_list>, but returns email destinations instead of contact
3560 objects. Also accepts 'invoice' as an argument, in which case this will also
3561 return the invoice email address if any.
3562
3563 =cut
3564
3565 sub contact_list_email {
3566   my $self = shift;
3567   my @classnums;
3568   my $and_invoice;
3569   foreach (@_) {
3570     if (/^invoice$/) {
3571       $and_invoice = 1;
3572     } else {
3573       push @classnums, $_;
3574     }
3575   }
3576   my %emails;
3577   # if the only argument passed was 'invoice' then no classnums are
3578   # intended, so skip this.
3579   if ( @classnums ) {
3580     my @contacts = $self->contact_list(@classnums);
3581     foreach my $contact (@contacts) {
3582       foreach my $contact_email ($contact->contact_email) {
3583         # unlike on 4.x, we have a separate list of invoice email
3584         # destinations.
3585         # make sure they're not redundant with contact emails
3586         $emails{ $contact_email->emailaddress } =
3587           Email::Address->new( $contact->firstlast,
3588                                $contact_email->emailaddress
3589                              )->format;
3590       }
3591     }
3592   }
3593   if ( $and_invoice ) {
3594     foreach my $email ($self->invoicing_list_emailonly) {
3595       $emails{ $email } ||=
3596         Email::Address->new( $self->name_short, $email )->format;
3597     }
3598   }
3599   values %emails;
3600 }
3601
3602 =item referral_custnum_cust_main
3603
3604 Returns the customer who referred this customer (or the empty string, if
3605 this customer was not referred).
3606
3607 Note the difference with referral_cust_main method: This method,
3608 referral_custnum_cust_main returns the single customer (if any) who referred
3609 this customer, while referral_cust_main returns an array of customers referred
3610 BY this customer.
3611
3612 =cut
3613
3614 sub referral_custnum_cust_main {
3615   my $self = shift;
3616   return '' unless $self->referral_custnum;
3617   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3618 }
3619
3620 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3621
3622 Returns an array of customers referred by this customer (referral_custnum set
3623 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
3624 customers referred by customers referred by this customer and so on, inclusive.
3625 The default behavior is DEPTH 1 (no recursion).
3626
3627 Note the difference with referral_custnum_cust_main method: This method,
3628 referral_cust_main, returns an array of customers referred BY this customer,
3629 while referral_custnum_cust_main returns the single customer (if any) who
3630 referred this customer.
3631
3632 =cut
3633
3634 sub referral_cust_main {
3635   my $self = shift;
3636   my $depth = @_ ? shift : 1;
3637   my $exclude = @_ ? shift : {};
3638
3639   my @cust_main =
3640     map { $exclude->{$_->custnum}++; $_; }
3641       grep { ! $exclude->{ $_->custnum } }
3642         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3643
3644   if ( $depth > 1 ) {
3645     push @cust_main,
3646       map { $_->referral_cust_main($depth-1, $exclude) }
3647         @cust_main;
3648   }
3649
3650   @cust_main;
3651 }
3652
3653 =item referral_cust_main_ncancelled
3654
3655 Same as referral_cust_main, except only returns customers with uncancelled
3656 packages.
3657
3658 =cut
3659
3660 sub referral_cust_main_ncancelled {
3661   my $self = shift;
3662   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3663 }
3664
3665 =item referral_cust_pkg [ DEPTH ]
3666
3667 Like referral_cust_main, except returns a flat list of all unsuspended (and
3668 uncancelled) packages for each customer.  The number of items in this list may
3669 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3670
3671 =cut
3672
3673 sub referral_cust_pkg {
3674   my $self = shift;
3675   my $depth = @_ ? shift : 1;
3676
3677   map { $_->unsuspended_pkgs }
3678     grep { $_->unsuspended_pkgs }
3679       $self->referral_cust_main($depth);
3680 }
3681
3682 =item referring_cust_main
3683
3684 Returns the single cust_main record for the customer who referred this customer
3685 (referral_custnum), or false.
3686
3687 =cut
3688
3689 sub referring_cust_main {
3690   my $self = shift;
3691   return '' unless $self->referral_custnum;
3692   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3693 }
3694
3695 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3696
3697 Applies a credit to this customer.  If there is an error, returns the error,
3698 otherwise returns false.
3699
3700 REASON can be a text string, an FS::reason object, or a scalar reference to
3701 a reasonnum.  If a text string, it will be automatically inserted as a new
3702 reason, and a 'reason_type' option must be passed to indicate the
3703 FS::reason_type for the new reason.
3704
3705 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3706 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3707 I<commission_pkgnum>.
3708
3709 Any other options are passed to FS::cust_credit::insert.
3710
3711 =cut
3712
3713 sub credit {
3714   my( $self, $amount, $reason, %options ) = @_;
3715
3716   my $cust_credit = new FS::cust_credit {
3717     'custnum' => $self->custnum,
3718     'amount'  => $amount,
3719   };
3720
3721   if ( ref($reason) ) {
3722
3723     if ( ref($reason) eq 'SCALAR' ) {
3724       $cust_credit->reasonnum( $$reason );
3725     } else {
3726       $cust_credit->reasonnum( $reason->reasonnum );
3727     }
3728
3729   } else {
3730     $cust_credit->set('reason', $reason)
3731   }
3732
3733   $cust_credit->$_( delete $options{$_} )
3734     foreach grep exists($options{$_}),
3735               qw( addlinfo eventnum ),
3736               map "commission_$_", qw( agentnum salesnum pkgnum );
3737
3738   $cust_credit->insert(%options);
3739
3740 }
3741
3742 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3743
3744 Creates a one-time charge for this customer.  If there is an error, returns
3745 the error, otherwise returns false.
3746
3747 New-style, with a hashref of options:
3748
3749   my $error = $cust_main->charge(
3750                                   {
3751                                     'amount'     => 54.32,
3752                                     'quantity'   => 1,
3753                                     'start_date' => str2time('7/4/2009'),
3754                                     'pkg'        => 'Description',
3755                                     'comment'    => 'Comment',
3756                                     'additional' => [], #extra invoice detail
3757                                     'classnum'   => 1,  #pkg_class
3758
3759                                     'setuptax'   => '', # or 'Y' for tax exempt
3760
3761                                     'locationnum'=> 1234, # optional
3762
3763                                     #internal taxation
3764                                     'taxclass'   => 'Tax class',
3765
3766                                     #vendor taxation
3767                                     'taxproduct' => 2,  #part_pkg_taxproduct
3768                                     'override'   => {}, #XXX describe
3769
3770                                     #will be filled in with the new object
3771                                     'cust_pkg_ref' => \$cust_pkg,
3772
3773                                     #generate an invoice immediately
3774                                     'bill_now' => 0,
3775                                     'invoice_terms' => '', #with these terms
3776                                   }
3777                                 );
3778
3779 Old-style:
3780
3781   my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3782
3783 =cut
3784
3785 #super false laziness w/quotation::charge
3786 sub charge {
3787   my $self = shift;
3788   my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3789   my ( $pkg, $comment, $additional );
3790   my ( $setuptax, $taxclass );   #internal taxes
3791   my ( $taxproduct, $override ); #vendor (CCH) taxes
3792   my $no_auto = '';
3793   my $separate_bill = '';
3794   my $cust_pkg_ref = '';
3795   my ( $bill_now, $invoice_terms ) = ( 0, '' );
3796   my $locationnum;
3797   if ( ref( $_[0] ) ) {
3798     $amount     = $_[0]->{amount};
3799     $setup_cost = $_[0]->{setup_cost};
3800     $quantity   = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3801     $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3802     $no_auto    = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3803     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3804     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
3805                                            : '$'. sprintf("%.2f",$amount);
3806     $setuptax   = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3807     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3808     $classnum   = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3809     $additional = $_[0]->{additional} || [];
3810     $taxproduct = $_[0]->{taxproductnum};
3811     $override   = { '' => $_[0]->{tax_override} };
3812     $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3813     $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3814     $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3815     $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3816     $separate_bill = $_[0]->{separate_bill} || '';
3817   } else { # yuck
3818     $amount     = shift;
3819     $setup_cost = '';
3820     $quantity   = 1;
3821     $start_date = '';
3822     $pkg        = @_ ? shift : 'One-time charge';
3823     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
3824     $setuptax   = '';
3825     $taxclass   = @_ ? shift : '';
3826     $additional = [];
3827   }
3828
3829   local $SIG{HUP} = 'IGNORE';
3830   local $SIG{INT} = 'IGNORE';
3831   local $SIG{QUIT} = 'IGNORE';
3832   local $SIG{TERM} = 'IGNORE';
3833   local $SIG{TSTP} = 'IGNORE';
3834   local $SIG{PIPE} = 'IGNORE';
3835
3836   my $oldAutoCommit = $FS::UID::AutoCommit;
3837   local $FS::UID::AutoCommit = 0;
3838   my $dbh = dbh;
3839
3840   my $part_pkg = new FS::part_pkg ( {
3841     'pkg'           => $pkg,
3842     'comment'       => $comment,
3843     'plan'          => 'flat',
3844     'freq'          => 0,
3845     'disabled'      => 'Y',
3846     'classnum'      => ( $classnum ? $classnum : '' ),
3847     'setuptax'      => $setuptax,
3848     'taxclass'      => $taxclass,
3849     'taxproductnum' => $taxproduct,
3850     'setup_cost'    => $setup_cost,
3851   } );
3852
3853   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3854                         ( 0 .. @$additional - 1 )
3855                   ),
3856                   'additional_count' => scalar(@$additional),
3857                   'setup_fee' => $amount,
3858                 );
3859
3860   my $error = $part_pkg->insert( options       => \%options,
3861                                  tax_overrides => $override,
3862                                );
3863   if ( $error ) {
3864     $dbh->rollback if $oldAutoCommit;
3865     return $error;
3866   }
3867
3868   my $pkgpart = $part_pkg->pkgpart;
3869   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3870   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3871     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3872     $error = $type_pkgs->insert;
3873     if ( $error ) {
3874       $dbh->rollback if $oldAutoCommit;
3875       return $error;
3876     }
3877   }
3878
3879   my $cust_pkg = new FS::cust_pkg ( {
3880     'custnum'    => $self->custnum,
3881     'pkgpart'    => $pkgpart,
3882     'quantity'   => $quantity,
3883     'start_date' => $start_date,
3884     'no_auto'    => $no_auto,
3885     'separate_bill' => $separate_bill,
3886     'locationnum'=> $locationnum,
3887   } );
3888
3889   $error = $cust_pkg->insert;
3890   if ( $error ) {
3891     $dbh->rollback if $oldAutoCommit;
3892     return $error;
3893   } elsif ( $cust_pkg_ref ) {
3894     ${$cust_pkg_ref} = $cust_pkg;
3895   }
3896
3897   if ( $bill_now ) {
3898     my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3899                              'pkg_list'      => [ $cust_pkg ],
3900                            );
3901     if ( $error ) {
3902       $dbh->rollback if $oldAutoCommit;
3903       return $error;
3904     }
3905   }
3906
3907   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3908   return '';
3909
3910 }
3911
3912 #=item charge_postal_fee
3913 #
3914 #Applies a one time charge this customer.  If there is an error,
3915 #returns the error, returns the cust_pkg charge object or false
3916 #if there was no charge.
3917 #
3918 #=cut
3919 #
3920 # This should be a customer event.  For that to work requires that bill
3921 # also be a customer event.
3922
3923 sub charge_postal_fee {
3924   my $self = shift;
3925
3926   my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3927   return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3928
3929   my $cust_pkg = new FS::cust_pkg ( {
3930     'custnum'  => $self->custnum,
3931     'pkgpart'  => $pkgpart,
3932     'quantity' => 1,
3933   } );
3934
3935   my $error = $cust_pkg->insert;
3936   $error ? $error : $cust_pkg;
3937 }
3938
3939 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3940
3941 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3942
3943 Optionally, a list or hashref of additional arguments to the qsearch call can
3944 be passed.
3945
3946 =cut
3947
3948 sub cust_bill {
3949   my $self = shift;
3950   my $opt = ref($_[0]) ? shift : { @_ };
3951
3952   #return $self->num_cust_bill unless wantarray || keys %$opt;
3953
3954   $opt->{'table'} = 'cust_bill';
3955   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3956   $opt->{'hashref'}{'custnum'} = $self->custnum;
3957   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3958
3959   map { $_ } #behavior of sort undefined in scalar context
3960     sort { $a->_date <=> $b->_date }
3961       qsearch($opt);
3962 }
3963
3964 =item open_cust_bill
3965
3966 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3967 customer.
3968
3969 =cut
3970
3971 sub open_cust_bill {
3972   my $self = shift;
3973
3974   $self->cust_bill(
3975     'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3976     #@_
3977   );
3978
3979 }
3980
3981 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3982
3983 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3984
3985 =cut
3986
3987 sub legacy_cust_bill {
3988   my $self = shift;
3989
3990   #return $self->num_legacy_cust_bill unless wantarray;
3991
3992   map { $_ } #behavior of sort undefined in scalar context
3993     sort { $a->_date <=> $b->_date }
3994       qsearch({ 'table'    => 'legacy_cust_bill',
3995                 'hashref'  => { 'custnum' => $self->custnum, },
3996                 'order_by' => 'ORDER BY _date ASC',
3997              });
3998 }
3999
4000 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
4001
4002 Returns all the statements (see L<FS::cust_statement>) for this customer.
4003
4004 Optionally, a list or hashref of additional arguments to the qsearch call can
4005 be passed.
4006
4007 =cut
4008
4009 =item cust_bill_void
4010
4011 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
4012
4013 =cut
4014
4015 sub cust_bill_void {
4016   my $self = shift;
4017
4018   map { $_ } #return $self->num_cust_bill_void unless wantarray;
4019   sort { $a->_date <=> $b->_date }
4020     qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
4021 }
4022
4023 sub cust_statement {
4024   my $self = shift;
4025   my $opt = ref($_[0]) ? shift : { @_ };
4026
4027   #return $self->num_cust_statement unless wantarray || keys %$opt;
4028
4029   $opt->{'table'} = 'cust_statement';
4030   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
4031   $opt->{'hashref'}{'custnum'} = $self->custnum;
4032   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
4033
4034   map { $_ } #behavior of sort undefined in scalar context
4035     sort { $a->_date <=> $b->_date }
4036       qsearch($opt);
4037 }
4038
4039 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
4040
4041 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
4042
4043 Optionally, a list or hashref of additional arguments to the qsearch call can
4044 be passed following the SVCDB.
4045
4046 =cut
4047
4048 sub svc_x {
4049   my $self = shift;
4050   my $svcdb = shift;
4051   if ( ! $svcdb =~ /^svc_\w+$/ ) {
4052     warn "$me svc_x requires a svcdb";
4053     return;
4054   }
4055   my $opt = ref($_[0]) ? shift : { @_ };
4056
4057   $opt->{'table'} = $svcdb;
4058   $opt->{'addl_from'} =
4059     'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
4060     ($opt->{'addl_from'} || '');
4061
4062   my $custnum = $self->custnum;
4063   $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
4064   my $where = "cust_pkg.custnum = $custnum";
4065
4066   my $extra_sql = $opt->{'extra_sql'} || '';
4067   if ( keys %{ $opt->{'hashref'} } ) {
4068     $extra_sql = " AND $where $extra_sql";
4069   }
4070   else {
4071     if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
4072       $extra_sql = "WHERE $where AND $1";
4073     }
4074     else {
4075       $extra_sql = "WHERE $where $extra_sql";
4076     }
4077   }
4078   $opt->{'extra_sql'} = $extra_sql;
4079
4080   qsearch($opt);
4081 }
4082
4083 # required for use as an eventtable;
4084 sub svc_acct {
4085   my $self = shift;
4086   $self->svc_x('svc_acct', @_);
4087 }
4088
4089 =item cust_credit
4090
4091 Returns all the credits (see L<FS::cust_credit>) for this customer.
4092
4093 =cut
4094
4095 sub cust_credit {
4096   my $self = shift;
4097   map { $_ } #return $self->num_cust_credit unless wantarray;
4098   sort { $a->_date <=> $b->_date }
4099     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4100 }
4101
4102 =item cust_credit_pkgnum
4103
4104 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
4105 package when using experimental package balances.
4106
4107 =cut
4108
4109 sub cust_credit_pkgnum {
4110   my( $self, $pkgnum ) = @_;
4111   map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
4112   sort { $a->_date <=> $b->_date }
4113     qsearch( 'cust_credit', { 'custnum' => $self->custnum,
4114                               'pkgnum'  => $pkgnum,
4115                             }
4116     );
4117 }
4118
4119 =item cust_credit_void
4120
4121 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
4122
4123 =cut
4124
4125 sub cust_credit_void {
4126   my $self = shift;
4127   map { $_ }
4128   sort { $a->_date <=> $b->_date }
4129     qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
4130 }
4131
4132 =item cust_pay
4133
4134 Returns all the payments (see L<FS::cust_pay>) for this customer.
4135
4136 =cut
4137
4138 sub cust_pay {
4139   my $self = shift;
4140   my $opt = ref($_[0]) ? shift : { @_ };
4141
4142   return $self->num_cust_pay unless wantarray || keys %$opt;
4143
4144   $opt->{'table'} = 'cust_pay';
4145   $opt->{'hashref'}{'custnum'} = $self->custnum;
4146
4147   map { $_ } #behavior of sort undefined in scalar context
4148     sort { $a->_date <=> $b->_date }
4149       qsearch($opt);
4150
4151 }
4152
4153 =item num_cust_pay
4154
4155 Returns the number of payments (see L<FS::cust_pay>) for this customer.  Also
4156 called automatically when the cust_pay method is used in a scalar context.
4157
4158 =cut
4159
4160 sub num_cust_pay {
4161   my $self = shift;
4162   my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
4163   my $sth = dbh->prepare($sql) or die dbh->errstr;
4164   $sth->execute($self->custnum) or die $sth->errstr;
4165   $sth->fetchrow_arrayref->[0];
4166 }
4167
4168 =item unapplied_cust_pay
4169
4170 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
4171
4172 =cut
4173
4174 sub unapplied_cust_pay {
4175   my $self = shift;
4176
4177   $self->cust_pay(
4178     'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
4179     #@_
4180   );
4181
4182 }
4183
4184 =item cust_pay_pkgnum
4185
4186 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
4187 package when using experimental package balances.
4188
4189 =cut
4190
4191 sub cust_pay_pkgnum {
4192   my( $self, $pkgnum ) = @_;
4193   map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
4194   sort { $a->_date <=> $b->_date }
4195     qsearch( 'cust_pay', { 'custnum' => $self->custnum,
4196                            'pkgnum'  => $pkgnum,
4197                          }
4198     );
4199 }
4200
4201 =item cust_pay_void
4202
4203 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4204
4205 =cut
4206
4207 sub cust_pay_void {
4208   my $self = shift;
4209   map { $_ } #return $self->num_cust_pay_void unless wantarray;
4210   sort { $a->_date <=> $b->_date }
4211     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4212 }
4213
4214 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
4215
4216 Returns all batched payments (see L<FS::cust_pay_batch>) for this customer.
4217
4218 Optionally, a list or hashref of additional arguments to the qsearch call can
4219 be passed.
4220
4221 =cut
4222
4223 sub cust_pay_batch {
4224   my $self = shift;
4225   my $opt = ref($_[0]) ? shift : { @_ };
4226
4227   #return $self->num_cust_statement unless wantarray || keys %$opt;
4228
4229   $opt->{'table'} = 'cust_pay_batch';
4230   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
4231   $opt->{'hashref'}{'custnum'} = $self->custnum;
4232   $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
4233
4234   map { $_ } #behavior of sort undefined in scalar context
4235     sort { $a->paybatchnum <=> $b->paybatchnum }
4236       qsearch($opt);
4237 }
4238
4239 =item cust_pay_pending
4240
4241 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
4242 (without status "done").
4243
4244 =cut
4245
4246 sub cust_pay_pending {
4247   my $self = shift;
4248   return $self->num_cust_pay_pending unless wantarray;
4249   sort { $a->_date <=> $b->_date }
4250     qsearch( 'cust_pay_pending', {
4251                                    'custnum' => $self->custnum,
4252                                    'status'  => { op=>'!=', value=>'done' },
4253                                  },
4254            );
4255 }
4256
4257 =item cust_pay_pending_attempt
4258
4259 Returns all payment attempts / declined payments for this customer, as pending
4260 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
4261 a corresponding payment (see L<FS::cust_pay>).
4262
4263 =cut
4264
4265 sub cust_pay_pending_attempt {
4266   my $self = shift;
4267   return $self->num_cust_pay_pending_attempt unless wantarray;
4268   sort { $a->_date <=> $b->_date }
4269     qsearch( 'cust_pay_pending', {
4270                                    'custnum' => $self->custnum,
4271                                    'status'  => 'done',
4272                                    'paynum'  => '',
4273                                  },
4274            );
4275 }
4276
4277 =item num_cust_pay_pending
4278
4279 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
4280 customer (without status "done").  Also called automatically when the
4281 cust_pay_pending method is used in a scalar context.
4282
4283 =cut
4284
4285 sub num_cust_pay_pending {
4286   my $self = shift;
4287   $self->scalar_sql(
4288     " SELECT COUNT(*) FROM cust_pay_pending ".
4289       " WHERE custnum = ? AND status != 'done' ",
4290     $self->custnum
4291   );
4292 }
4293
4294 =item num_cust_pay_pending_attempt
4295
4296 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
4297 customer, with status "done" but without a corresp.  Also called automatically when the
4298 cust_pay_pending method is used in a scalar context.
4299
4300 =cut
4301
4302 sub num_cust_pay_pending_attempt {
4303   my $self = shift;
4304   $self->scalar_sql(
4305     " SELECT COUNT(*) FROM cust_pay_pending ".
4306       " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
4307     $self->custnum
4308   );
4309 }
4310
4311 =item cust_refund
4312
4313 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4314
4315 =cut
4316
4317 sub cust_refund {
4318   my $self = shift;
4319   map { $_ } #return $self->num_cust_refund unless wantarray;
4320   sort { $a->_date <=> $b->_date }
4321     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4322 }
4323
4324 =item display_custnum
4325
4326 Returns the displayed customer number for this customer: agent_custid if
4327 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
4328
4329 =cut
4330
4331 sub display_custnum {
4332   my $self = shift;
4333
4334   return $self->agent_custid
4335     if $default_agent_custid && $self->agent_custid;
4336
4337   my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
4338
4339   if ( $prefix ) {
4340     return $prefix .
4341            sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
4342   } elsif ( $custnum_display_length ) {
4343     return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
4344   } else {
4345     return $self->custnum;
4346   }
4347 }
4348
4349 =item name
4350
4351 Returns a name string for this customer, either "Company (Last, First)" or
4352 "Last, First".
4353
4354 =cut
4355
4356 sub name {
4357   my $self = shift;
4358   my $name = $self->contact;
4359   $name = $self->company. " ($name)" if $self->company;
4360   $name;
4361 }
4362
4363 =item service_contact
4364
4365 Returns the L<FS::contact> object for this customer that has the 'Service'
4366 contact class, or undef if there is no such contact.  Deprecated; don't use
4367 this in new code.
4368
4369 =cut
4370
4371 sub service_contact {
4372   my $self = shift;
4373   if ( !exists($self->{service_contact}) ) {
4374     my $classnum = $self->scalar_sql(
4375       'SELECT classnum FROM contact_class WHERE classname = \'Service\''
4376     ) || 0; #if it's zero, qsearchs will return nothing
4377     $self->{service_contact} = qsearchs('contact', {
4378         'classnum' => $classnum, 'custnum' => $self->custnum
4379       }) || undef;
4380   }
4381   $self->{service_contact};
4382 }
4383
4384 =item ship_name
4385
4386 Returns a name string for this (service/shipping) contact, either
4387 "Company (Last, First)" or "Last, First".
4388
4389 =cut
4390
4391 sub ship_name {
4392   my $self = shift;
4393
4394   my $name = $self->ship_contact;
4395   $name = $self->company. " ($name)" if $self->company;
4396   $name;
4397 }
4398
4399 =item name_short
4400
4401 Returns a name string for this customer, either "Company" or "First Last".
4402
4403 =cut
4404
4405 sub name_short {
4406   my $self = shift;
4407   $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
4408 }
4409
4410 =item ship_name_short
4411
4412 Returns a name string for this (service/shipping) contact, either "Company"
4413 or "First Last".
4414
4415 =cut
4416
4417 sub ship_name_short {
4418   my $self = shift;
4419   $self->service_contact
4420     ? $self->ship_contact_firstlast
4421     : $self->name_short
4422 }
4423
4424 =item contact
4425
4426 Returns this customer's full (billing) contact name only, "Last, First"
4427
4428 =cut
4429
4430 sub contact {
4431   my $self = shift;
4432   $self->get('last'). ', '. $self->first;
4433 }
4434
4435 =item ship_contact
4436
4437 Returns this customer's full (shipping) contact name only, "Last, First"
4438
4439 =cut
4440
4441 sub ship_contact {
4442   my $self = shift;
4443   my $contact = $self->service_contact || $self;
4444   $contact->get('last') . ', ' . $contact->get('first');
4445 }
4446
4447 =item contact_firstlast
4448
4449 Returns this customers full (billing) contact name only, "First Last".
4450
4451 =cut
4452
4453 sub contact_firstlast {
4454   my $self = shift;
4455   $self->first. ' '. $self->get('last');
4456 }
4457
4458 =item ship_contact_firstlast
4459
4460 Returns this customer's full (shipping) contact name only, "First Last".
4461
4462 =cut
4463
4464 sub ship_contact_firstlast {
4465   my $self = shift;
4466   my $contact = $self->service_contact || $self;
4467   $contact->get('first') . ' '. $contact->get('last');
4468 }
4469
4470 sub bill_country_full {
4471   my $self = shift;
4472   $self->bill_location->country_full;
4473 }
4474
4475 sub ship_country_full {
4476   my $self = shift;
4477   $self->ship_location->country_full;
4478 }
4479
4480 =item county_state_county [ PREFIX ]
4481
4482 Returns a string consisting of just the county, state and country.
4483
4484 =cut
4485
4486 sub county_state_country {
4487   my $self = shift;
4488   my $locationnum;
4489   if ( @_ && $_[0] && $self->has_ship_address ) {
4490     $locationnum = $self->ship_locationnum;
4491   } else {
4492     $locationnum = $self->bill_locationnum;
4493   }
4494   my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4495   $cust_location->county_state_country;
4496 }
4497
4498 =item geocode DATA_VENDOR
4499
4500 Returns a value for the customer location as encoded by DATA_VENDOR.
4501 Currently this only makes sense for "CCH" as DATA_VENDOR.
4502
4503 =cut
4504
4505 =item cust_status
4506
4507 =item status
4508
4509 Returns a status string for this customer, currently:
4510
4511 =over 4
4512
4513 =item prospect - No packages have ever been ordered
4514
4515 =item ordered - Recurring packages all are new (not yet billed).
4516
4517 =item active - One or more recurring packages is active
4518
4519 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4520
4521 =item suspended - All non-cancelled recurring packages are suspended
4522
4523 =item cancelled - All recurring packages are cancelled
4524
4525 =back
4526
4527 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4528 cust_main-status_module configuration option.
4529
4530 =cut
4531
4532 sub status { shift->cust_status(@_); }
4533
4534 sub cust_status {
4535   my $self = shift;
4536   return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4537   for my $status ( FS::cust_main->statuses() ) {
4538     my $method = $status.'_sql';
4539     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4540     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4541     $sth->execute( ($self->custnum) x $numnum )
4542       or die "Error executing 'SELECT $sql': ". $sth->errstr;
4543     if ( $sth->fetchrow_arrayref->[0] ) {
4544       $self->hashref->{cust_status} = $status;
4545       return $status;
4546     }
4547   }
4548 }
4549
4550 =item is_status_delay_cancel
4551
4552 Returns true if customer status is 'suspended'
4553 and all suspended cust_pkg return true for
4554 cust_pkg->is_status_delay_cancel.
4555
4556 This is not a real status, this only meant for hacking display
4557 values, because otherwise treating the customer as suspended is
4558 really the whole point of the delay_cancel option.
4559
4560 =cut
4561
4562 sub is_status_delay_cancel {
4563   my ($self) = @_;
4564   return 0 unless $self->status eq 'suspended';
4565   foreach my $cust_pkg ($self->ncancelled_pkgs) {
4566     return 0 unless $cust_pkg->is_status_delay_cancel;
4567   }
4568   return 1;
4569 }
4570
4571 =item ucfirst_cust_status
4572
4573 =item ucfirst_status
4574
4575 Returns the status with the first character capitalized.
4576
4577 =cut
4578
4579 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4580
4581 sub ucfirst_cust_status {
4582   my $self = shift;
4583   ucfirst($self->cust_status);
4584 }
4585
4586 =item statuscolor
4587
4588 Returns a hex triplet color string for this customer's status.
4589
4590 =cut
4591
4592 sub statuscolor { shift->cust_statuscolor(@_); }
4593
4594 sub cust_statuscolor {
4595   my $self = shift;
4596   __PACKAGE__->statuscolors->{$self->cust_status};
4597 }
4598
4599 =item tickets [ STATUS ]
4600
4601 Returns an array of hashes representing the customer's RT tickets.
4602
4603 An optional status (or arrayref or hashref of statuses) may be specified.
4604
4605 =cut
4606
4607 sub tickets {
4608   my $self = shift;
4609   my $status = ( @_ && $_[0] ) ? shift : '';
4610
4611   my $num = $conf->config('cust_main-max_tickets') || 10;
4612   my @tickets = ();
4613
4614   if ( $conf->config('ticket_system') ) {
4615     unless ( $conf->config('ticket_system-custom_priority_field') ) {
4616
4617       @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4618                                                         $num,
4619                                                         undef,
4620                                                         $status,
4621                                                       )
4622                   };
4623
4624     } else {
4625
4626       foreach my $priority (
4627         $conf->config('ticket_system-custom_priority_field-values'), ''
4628       ) {
4629         last if scalar(@tickets) >= $num;
4630         push @tickets,
4631           @{ FS::TicketSystem->customer_tickets( $self->custnum,
4632                                                  $num - scalar(@tickets),
4633                                                  $priority,
4634                                                  $status,
4635                                                )
4636            };
4637       }
4638     }
4639   }
4640   (@tickets);
4641 }
4642
4643 =item appointments [ STATUS ]
4644
4645 Returns an array of hashes representing the customer's RT tickets which
4646 are appointments.
4647
4648 =cut
4649
4650 sub appointments {
4651   my $self = shift;
4652   my $status = ( @_ && $_[0] ) ? shift : '';
4653
4654   return () unless $conf->config('ticket_system');
4655
4656   my $queueid = $conf->config('ticket_system-appointment-queueid');
4657
4658   @{ FS::TicketSystem->customer_tickets( $self->custnum,
4659                                          99,
4660                                          undef,
4661                                          $status,
4662                                          $queueid,
4663                                        )
4664   };
4665 }
4666
4667 # Return services representing svc_accts in customer support packages
4668 sub support_services {
4669   my $self = shift;
4670   my %packages = map { $_ => 1 } $conf->config('support_packages');
4671
4672   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4673     grep { $_->part_svc->svcdb eq 'svc_acct' }
4674     map { $_->cust_svc }
4675     grep { exists $packages{ $_->pkgpart } }
4676     $self->ncancelled_pkgs;
4677
4678 }
4679
4680 # Return a list of latitude/longitude for one of the services (if any)
4681 sub service_coordinates {
4682   my $self = shift;
4683
4684   my @svc_X =
4685     grep { $_->latitude && $_->longitude }
4686     map { $_->svc_x }
4687     map { $_->cust_svc }
4688     $self->ncancelled_pkgs;
4689
4690   scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4691 }
4692
4693 =item masked FIELD
4694
4695 Returns a masked version of the named field
4696
4697 =cut
4698
4699 sub masked {
4700 my ($self,$field) = @_;
4701
4702 # Show last four
4703
4704 'x'x(length($self->getfield($field))-4).
4705   substr($self->getfield($field), (length($self->getfield($field))-4));
4706
4707 }
4708
4709 =item payment_history
4710
4711 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4712 cust_credit and cust_refund objects.  Each hashref has the following fields:
4713
4714 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4715
4716 I<date> - value of _date field, unix timestamp
4717
4718 I<date_pretty> - user-friendly date
4719
4720 I<description> - user-friendly description of item
4721
4722 I<amount> - impact of item on user's balance
4723 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4724 Not to be confused with the native 'amount' field in cust_credit, see below.
4725
4726 I<amount_pretty> - includes money char
4727
4728 I<balance> - customer balance, chronologically as of this item
4729
4730 I<balance_pretty> - includes money char
4731
4732 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4733
4734 I<paid> - amount paid for cust_pay records, undef for other types
4735
4736 I<credit> - amount credited for cust_credit records, undef for other types.
4737 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4738
4739 I<refund> - amount refunded for cust_refund records, undef for other types
4740
4741 The four table-specific keys always have positive values, whether they reflect charges or payments.
4742
4743 The following options may be passed to this method:
4744
4745 I<line_items> - if true, returns charges ('Line item') rather than invoices
4746
4747 I<start_date> - unix timestamp, only include records on or after.
4748 If specified, an item of type 'Previous' will also be included.
4749 It does not have table-specific fields.
4750
4751 I<end_date> - unix timestamp, only include records before
4752
4753 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4754
4755 I<conf> - optional already-loaded FS::Conf object.
4756
4757 =cut
4758
4759 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4760 # and also for sending customer statements, which should both be kept customer-friendly.
4761 # If you add anything that shouldn't be passed on through the API or exposed
4762 # to customers, add a new option to include it, don't include it by default
4763 sub payment_history {
4764   my $self = shift;
4765   my $opt = ref($_[0]) ? $_[0] : { @_ };
4766
4767   my $conf = $$opt{'conf'} || new FS::Conf;
4768   my $money_char = $conf->config("money_char") || '$',
4769
4770   #first load entire history,
4771   #need previous to calculate previous balance
4772   #loading after end_date shouldn't hurt too much?
4773   my @history = ();
4774   if ( $$opt{'line_items'} ) {
4775
4776     foreach my $cust_bill ( $self->cust_bill ) {
4777
4778       push @history, {
4779         'type'        => 'Line item',
4780         'description' => $_->desc( $self->locale ).
4781                            ( $_->sdate && $_->edate
4782                                ? ' '. time2str('%d-%b-%Y', $_->sdate).
4783                                  ' To '. time2str('%d-%b-%Y', $_->edate)
4784                                : ''
4785                            ),
4786         'amount'      => sprintf('%.2f', $_->setup + $_->recur ),
4787         'charged'     => sprintf('%.2f', $_->setup + $_->recur ),
4788         'date'        => $cust_bill->_date,
4789         'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4790       }
4791         foreach $cust_bill->cust_bill_pkg;
4792
4793     }
4794
4795   } else {
4796
4797     push @history, {
4798                      'type'        => 'Invoice',
4799                      'description' => 'Invoice #'. $_->display_invnum,
4800                      'amount'      => sprintf('%.2f', $_->charged ),
4801                      'charged'     => sprintf('%.2f', $_->charged ),
4802                      'date'        => $_->_date,
4803                      'date_pretty' => $self->time2str_local('short', $_->_date ),
4804                    }
4805       foreach $self->cust_bill;
4806
4807   }
4808
4809   push @history, {
4810                    'type'        => 'Payment',
4811                    'description' => 'Payment', #XXX type
4812                    'amount'      => sprintf('%.2f', 0 - $_->paid ),
4813                    'paid'        => sprintf('%.2f', $_->paid ),
4814                    'date'        => $_->_date,
4815                    'date_pretty' => $self->time2str_local('short', $_->_date ),
4816                  }
4817     foreach $self->cust_pay;
4818
4819   push @history, {
4820                    'type'        => 'Credit',
4821                    'description' => 'Credit', #more info?
4822                    'amount'      => sprintf('%.2f', 0 -$_->amount ),
4823                    'credit'      => sprintf('%.2f', $_->amount ),
4824                    'date'        => $_->_date,
4825                    'date_pretty' => $self->time2str_local('short', $_->_date ),
4826                  }
4827     foreach $self->cust_credit;
4828
4829   push @history, {
4830                    'type'        => 'Refund',
4831                    'description' => 'Refund', #more info?  type, like payment?
4832                    'amount'      => $_->refund,
4833                    'refund'      => $_->refund,
4834                    'date'        => $_->_date,
4835                    'date_pretty' => $self->time2str_local('short', $_->_date ),
4836                  }
4837     foreach $self->cust_refund;
4838
4839   #put it all in chronological order
4840   @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4841
4842   #calculate balance, filter items outside date range
4843   my $previous = 0;
4844   my $balance = 0;
4845   my @out = ();
4846   foreach my $item (@history) {
4847     last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4848     $balance += $$item{'amount'};
4849     if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4850       $previous += $$item{'amount'};
4851       next;
4852     }
4853     $$item{'balance'} = sprintf("%.2f",$balance);
4854     foreach my $key ( qw(amount balance) ) {
4855       $$item{$key.'_pretty'} = money_pretty($$item{$key});
4856     }
4857     push(@out,$item);
4858   }
4859
4860   # start with previous balance, if there was one
4861   if ($previous) {
4862     my $item = {
4863       'type'        => 'Previous',
4864       'description' => 'Previous balance',
4865       'amount'      => sprintf("%.2f",$previous),
4866       'balance'     => sprintf("%.2f",$previous),
4867       'date'        => $$opt{'start_date'},
4868       'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4869     };
4870     #false laziness with above
4871     foreach my $key ( qw(amount balance) ) {
4872       $$item{$key.'_pretty'} = $$item{$key};
4873       $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4874     }
4875     unshift(@out,$item);
4876   }
4877
4878   @out = reverse @history if $$opt{'reverse_sort'};
4879
4880   return @out;
4881 }
4882
4883 =back
4884
4885 =head1 CLASS METHODS
4886
4887 =over 4
4888
4889 =item statuses
4890
4891 Class method that returns the list of possible status strings for customers
4892 (see L<the status method|/status>).  For example:
4893
4894   @statuses = FS::cust_main->statuses();
4895
4896 =cut
4897
4898 sub statuses {
4899   my $self = shift;
4900   keys %{ $self->statuscolors };
4901 }
4902
4903 =item cust_status_sql
4904
4905 Returns an SQL fragment to determine the status of a cust_main record, as a
4906 string.
4907
4908 =cut
4909
4910 sub cust_status_sql {
4911   my $sql = 'CASE';
4912   for my $status ( FS::cust_main->statuses() ) {
4913     my $method = $status.'_sql';
4914     $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4915   }
4916   $sql .= ' END';
4917   return $sql;
4918 }
4919
4920
4921 =item prospect_sql
4922
4923 Returns an SQL expression identifying prospective cust_main records (customers
4924 with no packages ever ordered)
4925
4926 =cut
4927
4928 use vars qw($select_count_pkgs);
4929 $select_count_pkgs =
4930   "SELECT COUNT(*) FROM cust_pkg
4931     WHERE cust_pkg.custnum = cust_main.custnum";
4932
4933 sub select_count_pkgs_sql {
4934   $select_count_pkgs;
4935 }
4936
4937 sub prospect_sql {
4938   " 0 = ( $select_count_pkgs ) ";
4939 }
4940
4941 =item ordered_sql
4942
4943 Returns an SQL expression identifying ordered cust_main records (customers with
4944 no active packages, but recurring packages not yet setup or one time charges
4945 not yet billed).
4946
4947 =cut
4948
4949 sub ordered_sql {
4950   FS::cust_main->none_active_sql.
4951   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4952 }
4953
4954 =item active_sql
4955
4956 Returns an SQL expression identifying active cust_main records (customers with
4957 active recurring packages).
4958
4959 =cut
4960
4961 sub active_sql {
4962   " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4963 }
4964
4965 =item none_active_sql
4966
4967 Returns an SQL expression identifying cust_main records with no active
4968 recurring packages.  This includes customers of status prospect, ordered,
4969 inactive, and suspended.
4970
4971 =cut
4972
4973 sub none_active_sql {
4974   " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4975 }
4976
4977 =item inactive_sql
4978
4979 Returns an SQL expression identifying inactive cust_main records (customers with
4980 no active recurring packages, but otherwise unsuspended/uncancelled).
4981
4982 =cut
4983
4984 sub inactive_sql {
4985   FS::cust_main->none_active_sql.
4986   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4987 }
4988
4989 =item susp_sql
4990 =item suspended_sql
4991
4992 Returns an SQL expression identifying suspended cust_main records.
4993
4994 =cut
4995
4996
4997 sub suspended_sql { susp_sql(@_); }
4998 sub susp_sql {
4999   FS::cust_main->none_active_sql.
5000   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
5001 }
5002
5003 =item cancel_sql
5004 =item cancelled_sql
5005
5006 Returns an SQL expression identifying cancelled cust_main records.
5007
5008 =cut
5009
5010 sub cancel_sql { shift->cancelled_sql(@_); }
5011
5012 =item uncancel_sql
5013 =item uncancelled_sql
5014
5015 Returns an SQL expression identifying un-cancelled cust_main records.
5016
5017 =cut
5018
5019 sub uncancelled_sql { uncancel_sql(@_); }
5020 sub uncancel_sql {
5021   my $self = shift;
5022   "( NOT (".$self->cancelled_sql.") )"; #sensitive to cust_main-status_module
5023 }
5024
5025 =item balance_sql
5026
5027 Returns an SQL fragment to retreive the balance.
5028
5029 =cut
5030
5031 sub balance_sql { "
5032     ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5033         WHERE cust_bill.custnum   = cust_main.custnum     )
5034   - ( SELECT COALESCE( SUM(paid),    0 ) FROM cust_pay
5035         WHERE cust_pay.custnum    = cust_main.custnum     )
5036   - ( SELECT COALESCE( SUM(amount),  0 ) FROM cust_credit
5037         WHERE cust_credit.custnum = cust_main.custnum     )
5038   + ( SELECT COALESCE( SUM(refund),  0 ) FROM cust_refund
5039         WHERE cust_refund.custnum = cust_main.custnum     )
5040 "; }
5041
5042 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
5043
5044 Returns an SQL fragment to retreive the balance for this customer, optionally
5045 considering invoices with date earlier than START_TIME, and not
5046 later than END_TIME (total_owed_date minus total_unapplied_credits minus
5047 total_unapplied_payments).
5048
5049 Times are specified as SQL fragments or numeric
5050 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
5051 L<Date::Parse> for conversion functions.  The empty string can be passed
5052 to disable that time constraint completely.
5053
5054 Available options are:
5055
5056 =over 4
5057
5058 =item unapplied_date
5059
5060 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)
5061
5062 =item total
5063
5064 (unused.  obsolete?)
5065 set to true to remove all customer comparison clauses, for totals
5066
5067 =item where
5068
5069 (unused.  obsolete?)
5070 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5071
5072 =item join
5073
5074 (unused.  obsolete?)
5075 JOIN clause (typically used with the total option)
5076
5077 =item cutoff
5078
5079 An absolute cutoff time.  Payments, credits, and refunds I<applied> after this
5080 time will be ignored.  Note that START_TIME and END_TIME only limit the date
5081 range for invoices and I<unapplied> payments, credits, and refunds.
5082
5083 =back
5084
5085 =cut
5086
5087 sub balance_date_sql {
5088   my( $class, $start, $end, %opt ) = @_;
5089
5090   my $cutoff = $opt{'cutoff'};
5091
5092   my $owed         = FS::cust_bill->owed_sql($cutoff);
5093   my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
5094   my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
5095   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
5096
5097   my $j = $opt{'join'} || '';
5098
5099   my $owed_wh   = $class->_money_table_where( 'cust_bill',   $start,$end,%opt );
5100   my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5101   my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5102   my $pay_wh    = $class->_money_table_where( 'cust_pay',    $start,$end,%opt );
5103
5104   "   ( SELECT COALESCE(SUM($owed),         0) FROM cust_bill   $j $owed_wh   )
5105     + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5106     - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5107     - ( SELECT COALESCE(SUM($unapp_pay),    0) FROM cust_pay    $j $pay_wh    )
5108   ";
5109
5110 }
5111
5112 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
5113
5114 Returns an SQL fragment to retreive the total unapplied payments for this
5115 customer, only considering payments with date earlier than START_TIME, and
5116 optionally not later than END_TIME.
5117
5118 Times are specified as SQL fragments or numeric
5119 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
5120 L<Date::Parse> for conversion functions.  The empty string can be passed
5121 to disable that time constraint completely.
5122
5123 Available options are:
5124
5125 =cut
5126
5127 sub unapplied_payments_date_sql {
5128   my( $class, $start, $end, %opt ) = @_;
5129
5130   my $cutoff = $opt{'cutoff'};
5131
5132   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
5133
5134   my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
5135                                                           'unapplied_date'=>1 );
5136
5137   " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
5138 }
5139
5140 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5141
5142 Helper method for balance_date_sql; name (and usage) subject to change
5143 (suggestions welcome).
5144
5145 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5146 cust_refund, cust_credit or cust_pay).
5147
5148 If TABLE is "cust_bill" or the unapplied_date option is true, only
5149 considers records with date earlier than START_TIME, and optionally not
5150 later than END_TIME .
5151
5152 =cut
5153
5154 sub _money_table_where {
5155   my( $class, $table, $start, $end, %opt ) = @_;
5156
5157   my @where = ();
5158   push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5159   if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5160     push @where, "$table._date <= $start" if defined($start) && length($start);
5161     push @where, "$table._date >  $end"   if defined($end)   && length($end);
5162   }
5163   push @where, @{$opt{'where'}} if $opt{'where'};
5164   my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5165
5166   $where;
5167
5168 }
5169
5170 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
5171 use FS::cust_main::Search;
5172 sub search {
5173   my $class = shift;
5174   FS::cust_main::Search->search(@_);
5175 }
5176
5177 =back
5178
5179 =head1 SUBROUTINES
5180
5181 =over 4
5182
5183 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5184
5185 Deprecated.  Use event notification and message templates
5186 (L<FS::msg_template>) instead.
5187
5188 Sends a templated email notification to the customer (see L<Text::Template>).
5189
5190 OPTIONS is a hash and may include
5191
5192 I<from> - the email sender (default is invoice_from)
5193
5194 I<to> - comma-separated scalar or arrayref of recipients
5195    (default is invoicing_list)
5196
5197 I<subject> - The subject line of the sent email notification
5198    (default is "Notice from company_name")
5199
5200 I<extra_fields> - a hashref of name/value pairs which will be substituted
5201    into the template
5202
5203 The following variables are vavailable in the template.
5204
5205 I<$first> - the customer first name
5206 I<$last> - the customer last name
5207 I<$company> - the customer company
5208 I<$payby> - a description of the method of payment for the customer
5209             # would be nice to use FS::payby::shortname
5210 I<$payinfo> - the account information used to collect for this customer
5211 I<$expdate> - the expiration of the customer payment in seconds from epoch
5212
5213 =cut
5214
5215 sub notify {
5216   my ($self, $template, %options) = @_;
5217
5218   return unless $conf->exists($template);
5219
5220   my $from = $conf->invoice_from_full($self->agentnum)
5221     if $conf->exists('invoice_from', $self->agentnum);
5222   $from = $options{from} if exists($options{from});
5223
5224   my $to = join(',', $self->invoicing_list_emailonly);
5225   $to = $options{to} if exists($options{to});
5226
5227   my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
5228     if $conf->exists('company_name', $self->agentnum);
5229   $subject = $options{subject} if exists($options{subject});
5230
5231   my $notify_template = new Text::Template (TYPE => 'ARRAY',
5232                                             SOURCE => [ map "$_\n",
5233                                               $conf->config($template)]
5234                                            )
5235     or die "can't create new Text::Template object: Text::Template::ERROR";
5236   $notify_template->compile()
5237     or die "can't compile template: Text::Template::ERROR";
5238
5239   $FS::notify_template::_template::company_name =
5240     $conf->config('company_name', $self->agentnum);
5241   $FS::notify_template::_template::company_address =
5242     join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
5243
5244   my $paydate = $self->paydate || '2037-12-31';
5245   $FS::notify_template::_template::first = $self->first;
5246   $FS::notify_template::_template::last = $self->last;
5247   $FS::notify_template::_template::company = $self->company;
5248   $FS::notify_template::_template::payinfo = $self->mask_payinfo;
5249   my $payby = $self->payby;
5250   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5251   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5252
5253   #credit cards expire at the end of the month/year of their exp date
5254   if ($payby eq 'CARD' || $payby eq 'DCRD') {
5255     $FS::notify_template::_template::payby = 'credit card';
5256     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5257     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5258     $expire_time--;
5259   }elsif ($payby eq 'COMP') {
5260     $FS::notify_template::_template::payby = 'complimentary account';
5261   }else{
5262     $FS::notify_template::_template::payby = 'current method';
5263   }
5264   $FS::notify_template::_template::expdate = $expire_time;
5265
5266   for (keys %{$options{extra_fields}}){
5267     no strict "refs";
5268     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5269   }
5270
5271   send_email(from => $from,
5272              to => $to,
5273              subject => $subject,
5274              body => $notify_template->fill_in( PACKAGE =>
5275                                                 'FS::notify_template::_template'                                              ),
5276             );
5277
5278 }
5279
5280 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5281
5282 Generates a templated notification to the customer (see L<Text::Template>).
5283
5284 OPTIONS is a hash and may include
5285
5286 I<extra_fields> - a hashref of name/value pairs which will be substituted
5287    into the template.  These values may override values mentioned below
5288    and those from the customer record.
5289
5290 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5291
5292 The following variables are available in the template instead of or in addition
5293 to the fields of the customer record.
5294
5295 I<$payby> - a description of the method of payment for the customer
5296             # would be nice to use FS::payby::shortname
5297 I<$payinfo> - the masked account information used to collect for this customer
5298 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5299 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5300
5301 =cut
5302
5303 # a lot like cust_bill::print_latex
5304 sub generate_letter {
5305   my ($self, $template, %options) = @_;
5306
5307   warn "Template $template does not exist" && return
5308     unless $conf->exists($template) || $options{'template_text'};
5309
5310   my $template_source = $options{'template_text'}
5311                         ? [ $options{'template_text'} ]
5312                         : [ map "$_\n", $conf->config($template) ];
5313
5314   my $letter_template = new Text::Template
5315                         ( TYPE       => 'ARRAY',
5316                           SOURCE     => $template_source,
5317                           DELIMITERS => [ '[@--', '--@]' ],
5318                         )
5319     or die "can't create new Text::Template object: Text::Template::ERROR";
5320
5321   $letter_template->compile()
5322     or die "can't compile template: Text::Template::ERROR";
5323
5324   my %letter_data = map { $_ => $self->$_ } $self->fields;
5325   $letter_data{payinfo} = $self->mask_payinfo;
5326
5327   #my $paydate = $self->paydate || '2037-12-31';
5328   my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
5329
5330   my $payby = $self->payby;
5331   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5332   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5333
5334   #credit cards expire at the end of the month/year of their exp date
5335   if ($payby eq 'CARD' || $payby eq 'DCRD') {
5336     $letter_data{payby} = 'credit card';
5337     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5338     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5339     $expire_time--;
5340   }elsif ($payby eq 'COMP') {
5341     $letter_data{payby} = 'complimentary account';
5342   }else{
5343     $letter_data{payby} = 'current method';
5344   }
5345   $letter_data{expdate} = $expire_time;
5346
5347   for (keys %{$options{extra_fields}}){
5348     $letter_data{$_} = $options{extra_fields}->{$_};
5349   }
5350
5351   unless(exists($letter_data{returnaddress})){
5352     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5353                                                   $self->agent_template)
5354                      );
5355     if ( length($retadd) ) {
5356       $letter_data{returnaddress} = $retadd;
5357     } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5358       $letter_data{returnaddress} =
5359         join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5360                           s/$/\\\\\*/;
5361                           $_;
5362                         }
5363                     ( $conf->config('company_name', $self->agentnum),
5364                       $conf->config('company_address', $self->agentnum),
5365                     )
5366         );
5367     } else {
5368       $letter_data{returnaddress} = '~';
5369     }
5370   }
5371
5372   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5373
5374   $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5375
5376   my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5377
5378   my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5379                            DIR      => $dir,
5380                            SUFFIX   => '.eps',
5381                            UNLINK   => 0,
5382                          ) or die "can't open temp file: $!\n";
5383   print $lh $conf->config_binary('logo.eps', $self->agentnum)
5384     or die "can't write temp file: $!\n";
5385   close $lh;
5386   $letter_data{'logo_file'} = $lh->filename;
5387
5388   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5389                            DIR      => $dir,
5390                            SUFFIX   => '.tex',
5391                            UNLINK   => 0,
5392                          ) or die "can't open temp file: $!\n";
5393
5394   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5395   close $fh;
5396   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5397   return ($1, $letter_data{'logo_file'});
5398
5399 }
5400
5401 =item print_ps TEMPLATE
5402
5403 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5404
5405 =cut
5406
5407 sub print_ps {
5408   my $self = shift;
5409   my($file, $lfile) = $self->generate_letter(@_);
5410   my $ps = FS::Misc::generate_ps($file);
5411   unlink($file.'.tex');
5412   unlink($lfile);
5413
5414   $ps;
5415 }
5416
5417 =item print TEMPLATE
5418
5419 Prints the filled in template.
5420
5421 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5422
5423 =cut
5424
5425 sub queueable_print {
5426   my %opt = @_;
5427
5428   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5429     or die "invalid customer number: " . $opt{custnum};
5430
5431   my $error = $self->print( { 'template' => $opt{template} } );
5432   die $error if $error;
5433 }
5434
5435 sub print {
5436   my ($self, $template) = (shift, shift);
5437   do_print(
5438     [ $self->print_ps($template) ],
5439     'agentnum' => $self->agentnum,
5440   );
5441 }
5442
5443 #these three subs should just go away once agent stuff is all config overrides
5444
5445 sub agent_template {
5446   my $self = shift;
5447   $self->_agent_plandata('agent_templatename');
5448 }
5449
5450 sub agent_invoice_from {
5451   my $self = shift;
5452   $self->_agent_plandata('agent_invoice_from');
5453 }
5454
5455 sub _agent_plandata {
5456   my( $self, $option ) = @_;
5457
5458   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
5459   #agent-specific Conf
5460
5461   use FS::part_event::Condition;
5462
5463   my $agentnum = $self->agentnum;
5464
5465   my $regexp = regexp_sql();
5466
5467   my $part_event_option =
5468     qsearchs({
5469       'select'    => 'part_event_option.*',
5470       'table'     => 'part_event_option',
5471       'addl_from' => q{
5472         LEFT JOIN part_event USING ( eventpart )
5473         LEFT JOIN part_event_option AS peo_agentnum
5474           ON ( part_event.eventpart = peo_agentnum.eventpart
5475                AND peo_agentnum.optionname = 'agentnum'
5476                AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5477              )
5478         LEFT JOIN part_event_condition
5479           ON ( part_event.eventpart = part_event_condition.eventpart
5480                AND part_event_condition.conditionname = 'cust_bill_age'
5481              )
5482         LEFT JOIN part_event_condition_option
5483           ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5484                AND part_event_condition_option.optionname = 'age'
5485              )
5486       },
5487       #'hashref'   => { 'optionname' => $option },
5488       #'hashref'   => { 'part_event_option.optionname' => $option },
5489       'extra_sql' =>
5490         " WHERE part_event_option.optionname = ". dbh->quote($option).
5491         " AND action = 'cust_bill_send_agent' ".
5492         " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5493         " AND peo_agentnum.optionname = 'agentnum' ".
5494         " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5495         " ORDER BY
5496            CASE WHEN part_event_condition_option.optionname IS NULL
5497            THEN -1
5498            ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5499         " END
5500           , part_event.weight".
5501         " LIMIT 1"
5502     });
5503
5504   unless ( $part_event_option ) {
5505     return $self->agent->invoice_template || ''
5506       if $option eq 'agent_templatename';
5507     return '';
5508   }
5509
5510   $part_event_option->optionvalue;
5511
5512 }
5513
5514 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5515
5516 Subroutine (not a method), designed to be called from the queue.
5517
5518 Takes a list of options and values.
5519
5520 Pulls up the customer record via the custnum option and calls bill_and_collect.
5521
5522 =cut
5523
5524 sub queued_bill {
5525   my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5526
5527   my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5528   warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5529
5530   #without this errors don't get rolled back
5531   $args{'fatal'} = 1; # runs from job queue, will be caught
5532
5533   $cust_main->bill_and_collect( %args );
5534 }
5535
5536 sub process_bill_and_collect {
5537   my $job = shift;
5538   my $param = thaw(decode_base64(shift));
5539   my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5540       or die "custnum '$param->{custnum}' not found!\n";
5541   $param->{'job'}   = $job;
5542   $param->{'fatal'} = 1; # runs from job queue, will be caught
5543   $param->{'retry'} = 1;
5544
5545   $cust_main->bill_and_collect( %$param );
5546 }
5547
5548 #starting to take quite a while for big dbs
5549 #   (JRNL: journaled so it only happens once per database)
5550 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5551 # JRNL seq scan of cust_main on signupdate... index signupdate?  will that help?
5552 # JRNL seq scan of cust_main on paydate... index on substrings?  maybe set an
5553 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5554 # JRNL leading/trailing spaces in first, last, company
5555 # - otaker upgrade?  journal and call it good?  (double check to make sure
5556 #    we're not still setting otaker here)
5557 #
5558 #only going to get worse with new location stuff...
5559
5560 sub _upgrade_data { #class method
5561   my ($class, %opts) = @_;
5562
5563   my @statements = (
5564     'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5565   );
5566
5567   #this seems to be the only expensive one.. why does it take so long?
5568   unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5569     push @statements,
5570       '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';
5571     FS::upgrade_journal->set_done('cust_main__signupdate');
5572   }
5573
5574   unless ( FS::upgrade_journal->is_done('cust_main__paydate') ) {
5575
5576     # fix yyyy-m-dd formatted paydates
5577     if ( driver_name =~ /^mysql/i ) {
5578       push @statements,
5579       "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5580     } else { # the SQL standard
5581       push @statements,
5582       "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5583     }
5584     FS::upgrade_journal->set_done('cust_main__paydate');
5585   }
5586
5587   unless ( FS::upgrade_journal->is_done('cust_main__payinfo') ) {
5588
5589     push @statements, #fix the weird BILL with a cc# in payinfo problem
5590       #DCRD to be safe
5591       "UPDATE cust_main SET payby = 'DCRD' WHERE payby = 'BILL' and length(payinfo) = 16 and payinfo ". regexp_sql. q( '^[0-9]*$' );
5592
5593     FS::upgrade_journal->set_done('cust_main__payinfo');
5594
5595   }
5596
5597   my $t = time;
5598   foreach my $sql ( @statements ) {
5599     my $sth = dbh->prepare($sql) or die dbh->errstr;
5600     $sth->execute or die $sth->errstr;
5601     #warn ( (time - $t). " seconds\n" );
5602     #$t = time;
5603   }
5604
5605   local($ignore_expired_card) = 1;
5606   local($ignore_banned_card) = 1;
5607   local($skip_fuzzyfiles) = 1;
5608   local($import) = 1; #prevent automatic geocoding (need its own variable?)
5609
5610   FS::cust_main::Location->_upgrade_data(%opts);
5611
5612   unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5613
5614     foreach my $cust_main ( qsearch({
5615       'table'     => 'cust_main',
5616       'hashref'   => {},
5617       'extra_sql' => 'WHERE '.
5618                        join(' OR ',
5619                          map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '%  %'",
5620                            qw( first last company )
5621                        ),
5622     }) ) {
5623       my $error = $cust_main->replace;
5624       die $error if $error;
5625     }
5626
5627     FS::upgrade_journal->set_done('cust_main__trimspaces');
5628
5629   }
5630
5631   $class->_upgrade_otaker(%opts);
5632
5633   # turn on encryption as part of regular upgrade, so all new records are immediately encrypted
5634   # existing records will be encrypted in queueable_upgrade (below)
5635   unless ($conf->exists('encryptionpublickey') || $conf->exists('encryptionprivatekey')) {
5636     eval "use FS::Setup";
5637     die $@ if $@;
5638     FS::Setup::enable_encryption();
5639   }
5640
5641 }
5642
5643 sub queueable_upgrade {
5644   my $class = shift;
5645
5646   ### encryption gets turned on in _upgrade_data, above
5647
5648   eval "use FS::upgrade_journal";
5649   die $@ if $@;
5650
5651   # prior to 2013 (commit f16665c9) payinfo was stored in history if not encrypted,
5652   # clear that out before encrypting/tokenizing anything else
5653   if (!FS::upgrade_journal->is_done('clear_payinfo_history')) {
5654     foreach my $table ('cust_main','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') {
5655       my $sql = 'UPDATE h_'.$table.' SET payinfo = NULL WHERE payinfo IS NOT NULL';
5656       my $sth = dbh->prepare($sql) or die dbh->errstr;
5657       $sth->execute or die $sth->errstr;
5658     }
5659     FS::upgrade_journal->set_done('clear_payinfo_history');
5660   }
5661
5662   # fix Tokenized paycardtype and encrypt old records
5663   if (    ! FS::upgrade_journal->is_done('paycardtype_Tokenized')
5664        || ! FS::upgrade_journal->is_done('encryption_check')
5665      )
5666   {
5667
5668     # allow replacement of closed cust_pay/cust_refund records
5669     local $FS::payinfo_Mixin::allow_closed_replace = 1;
5670
5671     # because it looks like nothing's changing
5672     local $FS::Record::no_update_diff = 1;
5673
5674     # commit everything immediately
5675     local $FS::UID::AutoCommit = 1;
5676
5677     # encrypt what's there
5678     foreach my $table ('cust_main','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') {
5679       my $tclass = 'FS::'.$table;
5680       my $lastrecnum = 0;
5681       my @recnums = ();
5682       while (my $recnum = _upgrade_next_recnum(dbh,$table,\$lastrecnum,\@recnums)) {
5683         my $record = $tclass->by_key($recnum);
5684         next unless $record; # small chance it's been deleted, that's ok
5685         next unless grep { $record->payby eq $_ } @FS::Record::encrypt_payby;
5686         # window for possible conflict is practically nonexistant,
5687         #   but just in case...
5688         $record = $record->select_for_update;
5689         if (!$record->custnum && $table eq 'cust_pay_pending') {
5690           $record->set('custnum_pending',1);
5691         }
5692         $record->paycardtype('') if $record->paycardtype eq 'Tokenized';
5693
5694         local($ignore_expired_card) = 1;
5695         local($ignore_banned_card) = 1;
5696         local($skip_fuzzyfiles) = 1;
5697         local($import) = 1;#prevent automatic geocoding (need its own variable?)
5698
5699         my $error = $record->replace;
5700         die "Error replacing $table ".$record->get($record->primary_key).": $error" if $error;
5701       }
5702     }
5703
5704     FS::upgrade_journal->set_done('paycardtype_Tokenized');
5705     FS::upgrade_journal->set_done('encryption_check') if $conf->exists('encryption');
5706   }
5707
5708 }
5709
5710 # not entirely false laziness w/ Billing_Realtime::_token_check_next_recnum
5711 # cust_payby might get deleted while this runs
5712 # not a method!
5713 sub _upgrade_next_recnum {
5714   my ($dbh,$table,$lastrecnum,$recnums) = @_;
5715   my $recnum = shift @$recnums;
5716   return $recnum if $recnum;
5717   my $tclass = 'FS::'.$table;
5718   my $paycardtypecheck = ($table ne 'cust_pay_pending') ? q( OR paycardtype = 'Tokenized') : '';
5719   my $sql = 'SELECT '.$tclass->primary_key.
5720             ' FROM '.$table.
5721             ' WHERE '.$tclass->primary_key.' > '.$$lastrecnum.
5722             "   AND payby IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
5723             "   AND ( length(payinfo) < 80$paycardtypecheck ) ".
5724             ' ORDER BY '.$tclass->primary_key.' LIMIT 500';
5725   my $sth = $dbh->prepare($sql) or die $dbh->errstr;
5726   $sth->execute() or die $sth->errstr;
5727   my @recnums;
5728   while (my $rec = $sth->fetchrow_hashref) {
5729     push @$recnums, $rec->{$tclass->primary_key};
5730   }
5731   $sth->finish();
5732   $$lastrecnum = $$recnums[-1];
5733   return shift @$recnums;
5734 }
5735
5736 =back
5737
5738 =head1 BUGS
5739
5740 The delete method.
5741
5742 The delete method should possibly take an FS::cust_main object reference
5743 instead of a scalar customer number.
5744
5745 Bill and collect options should probably be passed as references instead of a
5746 list.
5747
5748 There should probably be a configuration file with a list of allowed credit
5749 card types.
5750
5751 No multiple currency support (probably a larger project than just this module).
5752
5753 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5754
5755 Birthdates rely on negative epoch values.
5756
5757 The payby for card/check batches is broken.  With mixed batching, bad
5758 things will happen.
5759
5760 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5761
5762 =head1 SEE ALSO
5763
5764 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5765 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5766 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
5767
5768 =cut
5769
5770 1;
5771