FS/FS/cust_main.pm

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