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