FS/FS/cust_main.pm

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