FS/FS/cust_main.pm

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