FS/FS/cust_main.pm

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