FS/FS/cust_main.pm

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