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     || $self->ut_enum('edit_subject', [ '', 'Y' ] )
1690   ;
1691
1692   #barf.  need message catalogs.  i18n.  etc.
1693   $error .= "Please select an advertising source."
1694     if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1695   return $error if $error;
1696
1697   return "Unknown agent"
1698     unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1699
1700   return "Unknown refnum"
1701     unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1702
1703   return "Unknown referring custnum: ". $self->referral_custnum
1704     unless ! $self->referral_custnum
1705            || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1706
1707   if ( $self->censustract ne '' ) {
1708     $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1709       or return "Illegal census tract: ". $self->censustract;
1710
1711     $self->censustract("$1.$2");
1712   }
1713
1714   if ( $self->ss eq '' ) {
1715     $self->ss('');
1716   } else {
1717     my $ss = $self->ss;
1718     $ss =~ s/\D//g;
1719     $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1720       or return "Illegal social security number: ". $self->ss;
1721     $self->ss("$1-$2-$3");
1722   }
1723
1724
1725 # bad idea to disable, causes billing to fail because of no tax rates later
1726 # except we don't fail any more
1727   unless ( $import ) {
1728     unless ( qsearch('cust_main_county', {
1729       'country' => $self->country,
1730       'state'   => '',
1731      } ) ) {
1732       return "Unknown state/county/country: ".
1733         $self->state. "/". $self->county. "/". $self->country
1734         unless qsearch('cust_main_county',{
1735           'state'   => $self->state,
1736           'county'  => $self->county,
1737           'country' => $self->country,
1738         } );
1739     }
1740   }
1741
1742   $error =
1743     $self->ut_phonen('daytime', $self->country)
1744     || $self->ut_phonen('night', $self->country)
1745     || $self->ut_phonen('fax', $self->country)
1746   ;
1747   return $error if $error;
1748
1749   unless ( $ignore_illegal_zip ) {
1750     $error = $self->ut_zip('zip', $self->country);
1751     return $error if $error;
1752   }
1753
1754   if ( $conf->exists('cust_main-require_phone')
1755        && ! length($self->daytime) && ! length($self->night)
1756      ) {
1757
1758     my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1759                           ? 'Day Phone'
1760                           : FS::Msgcat::_gettext('daytime');
1761     my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1762                         ? 'Night Phone'
1763                         : FS::Msgcat::_gettext('night');
1764
1765     return "$daytime_label or $night_label is required"
1766
1767   }
1768
1769   if ( $self->has_ship_address
1770        && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1771                         $self->addr_fields )
1772      )
1773   {
1774     my $error =
1775       $self->ut_name('ship_last')
1776       || $self->ut_name('ship_first')
1777       || $self->ut_textn('ship_company')
1778       || $self->ut_text('ship_address1')
1779       || $self->ut_textn('ship_address2')
1780       || $self->ut_text('ship_city')
1781       || $self->ut_textn('ship_county')
1782       || $self->ut_textn('ship_state')
1783       || $self->ut_country('ship_country')
1784     ;
1785     return $error if $error;
1786
1787     #false laziness with above
1788     unless ( qsearchs('cust_main_county', {
1789       'country' => $self->ship_country,
1790       'state'   => '',
1791      } ) ) {
1792       return "Unknown ship_state/ship_county/ship_country: ".
1793         $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1794         unless qsearch('cust_main_county',{
1795           'state'   => $self->ship_state,
1796           'county'  => $self->ship_county,
1797           'country' => $self->ship_country,
1798         } );
1799     }
1800     #eofalse
1801
1802     $error =
1803       $self->ut_phonen('ship_daytime', $self->ship_country)
1804       || $self->ut_phonen('ship_night', $self->ship_country)
1805       || $self->ut_phonen('ship_fax', $self->ship_country)
1806     ;
1807     return $error if $error;
1808
1809     unless ( $ignore_illegal_zip ) {
1810       $error = $self->ut_zip('ship_zip', $self->ship_country);
1811       return $error if $error;
1812     }
1813     return "Unit # is required."
1814       if $self->ship_address2 =~ /^\s*$/
1815       && $conf->exists('cust_main-require_address2');
1816
1817   } else { # ship_ info eq billing info, so don't store dup info in database
1818
1819     $self->setfield("ship_$_", '')
1820       foreach $self->addr_fields;
1821
1822     return "Unit # is required."
1823       if $self->address2 =~ /^\s*$/
1824       && $conf->exists('cust_main-require_address2');
1825
1826   }
1827
1828   #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1829   #  or return "Illegal payby: ". $self->payby;
1830   #$self->payby($1);
1831   FS::payby->can_payby($self->table, $self->payby)
1832     or return "Illegal payby: ". $self->payby;
1833
1834   $error =    $self->ut_numbern('paystart_month')
1835            || $self->ut_numbern('paystart_year')
1836            || $self->ut_numbern('payissue')
1837            || $self->ut_textn('paytype')
1838   ;
1839   return $error if $error;
1840
1841   if ( $self->payip eq '' ) {
1842     $self->payip('');
1843   } else {
1844     $error = $self->ut_ip('payip');
1845     return $error if $error;
1846   }
1847
1848   # If it is encrypted and the private key is not availaible then we can't
1849   # check the credit card.
1850   my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1851
1852   if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1853
1854     my $payinfo = $self->payinfo;
1855     $payinfo =~ s/\D//g;
1856     $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1857       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1858     $payinfo = $1;
1859     $self->payinfo($payinfo);
1860     validate($payinfo)
1861       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1862
1863     return gettext('unknown_card_type')
1864       if $self->payinfo !~ /^99\d{14}$/ #token
1865       && cardtype($self->payinfo) eq "Unknown";
1866
1867     unless ( $ignore_banned_card ) {
1868       my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1869       if ( $ban ) {
1870         return 'Banned credit card: banned on '.
1871                time2str('%a %h %o at %r', $ban->_date).
1872                ' by '. $ban->otaker.
1873                ' (ban# '. $ban->bannum. ')';
1874       }
1875     }
1876
1877     if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1878       if ( cardtype($self->payinfo) eq 'American Express card' ) {
1879         $self->paycvv =~ /^(\d{4})$/
1880           or return "CVV2 (CID) for American Express cards is four digits.";
1881         $self->paycvv($1);
1882       } else {
1883         $self->paycvv =~ /^(\d{3})$/
1884           or return "CVV2 (CVC2/CID) is three digits.";
1885         $self->paycvv($1);
1886       }
1887     } else {
1888       $self->paycvv('');
1889     }
1890
1891     my $cardtype = cardtype($payinfo);
1892     if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1893
1894       return "Start date or issue number is required for $cardtype cards"
1895         unless $self->paystart_month && $self->paystart_year or $self->payissue;
1896
1897       return "Start month must be between 1 and 12"
1898         if $self->paystart_month
1899            and $self->paystart_month < 1 || $self->paystart_month > 12;
1900
1901       return "Start year must be 1990 or later"
1902         if $self->paystart_year
1903            and $self->paystart_year < 1990;
1904
1905       return "Issue number must be beween 1 and 99"
1906         if $self->payissue
1907           and $self->payissue < 1 || $self->payissue > 99;
1908
1909     } else {
1910       $self->paystart_month('');
1911       $self->paystart_year('');
1912       $self->payissue('');
1913     }
1914
1915   } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1916
1917     my $payinfo = $self->payinfo;
1918     $payinfo =~ s/[^\d\@\.]//g;
1919     if ( $conf->exists('cust_main-require-bank-branch') ) {
1920       $payinfo =~ /^(\d+)\@(\d+)\.(\d+)$/ or return 'invalid echeck account@branch.bank';
1921       $payinfo = "$1\@$2.$3";
1922     }
1923     elsif ( $conf->exists('echeck-nonus') ) {
1924       $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1925       $payinfo = "$1\@$2";
1926     } else {
1927       $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1928       $payinfo = "$1\@$2";
1929     }
1930     $self->payinfo($payinfo);
1931     $self->paycvv('');
1932
1933     unless ( $ignore_banned_card ) {
1934       my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1935       if ( $ban ) {
1936         return 'Banned ACH account: banned on '.
1937                time2str('%a %h %o at %r', $ban->_date).
1938                ' by '. $ban->otaker.
1939                ' (ban# '. $ban->bannum. ')';
1940       }
1941     }
1942
1943   } elsif ( $self->payby eq 'LECB' ) {
1944
1945     my $payinfo = $self->payinfo;
1946     $payinfo =~ s/\D//g;
1947     $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1948     $payinfo = $1;
1949     $self->payinfo($payinfo);
1950     $self->paycvv('');
1951
1952   } elsif ( $self->payby eq 'BILL' ) {
1953
1954     $error = $self->ut_textn('payinfo');
1955     return "Illegal P.O. number: ". $self->payinfo if $error;
1956     $self->paycvv('');
1957
1958   } elsif ( $self->payby eq 'COMP' ) {
1959
1960     my $curuser = $FS::CurrentUser::CurrentUser;
1961     if (    ! $self->custnum
1962          && ! $curuser->access_right('Complimentary customer')
1963        )
1964     {
1965       return "You are not permitted to create complimentary accounts."
1966     }
1967
1968     $error = $self->ut_textn('payinfo');
1969     return "Illegal comp account issuer: ". $self->payinfo if $error;
1970     $self->paycvv('');
1971
1972   } elsif ( $self->payby eq 'PREPAY' ) {
1973
1974     my $payinfo = $self->payinfo;
1975     $payinfo =~ s/\W//g; #anything else would just confuse things
1976     $self->payinfo($payinfo);
1977     $error = $self->ut_alpha('payinfo');
1978     return "Illegal prepayment identifier: ". $self->payinfo if $error;
1979     return "Unknown prepayment identifier"
1980       unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1981     $self->paycvv('');
1982
1983   }
1984
1985   if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1986     return "Expiration date required"
1987       unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1988     $self->paydate('');
1989   } else {
1990     my( $m, $y );
1991     if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1992       ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1993     } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1994       ( $m, $y ) = ( $2, "19$1" );
1995     } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1996       ( $m, $y ) = ( $3, "20$2" );
1997     } else {
1998       return "Illegal expiration date: ". $self->paydate;
1999     }
2000     $m = sprintf('%02d',$m);
2001     $self->paydate("$y-$m-01");
2002     my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2003     return gettext('expired_card')
2004       if !$import
2005       && !$ignore_expired_card
2006       && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2007   }
2008
2009   if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2010        ( ! $conf->exists('require_cardname')
2011          || $self->payby !~ /^(CARD|DCRD)$/  )
2012   ) {
2013     $self->payname( $self->first. " ". $self->getfield('last') );
2014   } else {
2015     $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2016       or return gettext('illegal_name'). " payname: ". $self->payname;
2017     $self->payname($1);
2018   }
2019
2020   foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2021     $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2022     $self->$flag($1);
2023   }
2024
2025   $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2026
2027   warn "$me check AFTER: \n". $self->_dump
2028     if $DEBUG > 2;
2029
2030   $self->SUPER::check;
2031 }
2032
2033 =item addr_fields
2034
2035 Returns a list of fields which have ship_ duplicates.
2036
2037 =cut
2038
2039 sub addr_fields {
2040   qw( last first company
2041       address1 address2 city county state zip country
2042       daytime night fax
2043     );
2044 }
2045
2046 =item has_ship_address
2047
2048 Returns true if this customer record has a separate shipping address.
2049
2050 =cut
2051
2052 sub has_ship_address {
2053   my $self = shift;
2054   scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
2055 }
2056
2057 =item location_hash
2058
2059 Returns a list of key/value pairs, with the following keys: address1, adddress2,
2060 city, county, state, zip, country, and geocode.  The shipping address is used if present.
2061
2062 =cut
2063
2064 =item cust_location
2065
2066 Returns all locations (see L<FS::cust_location>) for this customer.
2067
2068 =cut
2069
2070 sub cust_location {
2071   my $self = shift;
2072   qsearch('cust_location', { 'custnum' => $self->custnum } );
2073 }
2074
2075 =item cust_contact
2076
2077 Returns all contacts (see L<FS::contact>) for this customer.
2078
2079 =cut
2080
2081 #already used :/ sub contact {
2082 sub cust_contact {
2083   my $self = shift;
2084   qsearch('contact', { 'custnum' => $self->custnum } );
2085 }
2086
2087 =item unsuspend
2088
2089 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2090 and L<FS::cust_pkg>) for this customer.  Always returns a list: an empty list
2091 on success or a list of errors.
2092
2093 =cut
2094
2095 sub unsuspend {
2096   my $self = shift;
2097   grep { $_->unsuspend } $self->suspended_pkgs;
2098 }
2099
2100 =item suspend
2101
2102 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2103
2104 Returns a list: an empty list on success or a list of errors.
2105
2106 =cut
2107
2108 sub suspend {
2109   my $self = shift;
2110   grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2111 }
2112
2113 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2114
2115 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2116 PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref instead
2117 of a list of pkgparts; the hashref has the following keys:
2118
2119 =over 4
2120
2121 =item pkgparts - listref of pkgparts
2122
2123 =item (other options are passed to the suspend method)
2124
2125 =back
2126
2127
2128 Returns a list: an empty list on success or a list of errors.
2129
2130 =cut
2131
2132 sub suspend_if_pkgpart {
2133   my $self = shift;
2134   my (@pkgparts, %opt);
2135   if (ref($_[0]) eq 'HASH'){
2136     @pkgparts = @{$_[0]{pkgparts}};
2137     %opt      = %{$_[0]};
2138   }else{
2139     @pkgparts = @_;
2140   }
2141   grep { $_->suspend(%opt) }
2142     grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2143       $self->unsuspended_pkgs;
2144 }
2145
2146 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2147
2148 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2149 given PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref
2150 instead of a list of pkgparts; the hashref has the following keys:
2151
2152 =over 4
2153
2154 =item pkgparts - listref of pkgparts
2155
2156 =item (other options are passed to the suspend method)
2157
2158 =back
2159
2160 Returns a list: an empty list on success or a list of errors.
2161
2162 =cut
2163
2164 sub suspend_unless_pkgpart {
2165   my $self = shift;
2166   my (@pkgparts, %opt);
2167   if (ref($_[0]) eq 'HASH'){
2168     @pkgparts = @{$_[0]{pkgparts}};
2169     %opt      = %{$_[0]};
2170   }else{
2171     @pkgparts = @_;
2172   }
2173   grep { $_->suspend(%opt) }
2174     grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2175       $self->unsuspended_pkgs;
2176 }
2177
2178 =item cancel [ OPTION => VALUE ... ]
2179
2180 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2181
2182 Available options are:
2183
2184 =over 4
2185
2186 =item quiet - can be set true to supress email cancellation notices.
2187
2188 =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.
2189
2190 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2191
2192 =item nobill - can be set true to skip billing if it might otherwise be done.
2193
2194 =back
2195
2196 Always returns a list: an empty list on success or a list of errors.
2197
2198 =cut
2199
2200 # nb that dates are not specified as valid options to this method
2201
2202 sub cancel {
2203   my( $self, %opt ) = @_;
2204
2205   warn "$me cancel called on customer ". $self->custnum. " with options ".
2206        join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2207     if $DEBUG;
2208
2209   return ( 'access denied' )
2210     unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2211
2212   if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2213
2214     #should try decryption (we might have the private key)
2215     # and if not maybe queue a job for the server that does?
2216     return ( "Can't (yet) ban encrypted credit cards" )
2217       if $self->is_encrypted($self->payinfo);
2218
2219     my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2220     my $error = $ban->insert;
2221     return ( $error ) if $error;
2222
2223   }
2224
2225   my @pkgs = $self->ncancelled_pkgs;
2226
2227   if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2228     $opt{nobill} = 1;
2229     my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2230     warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2231       if $error;
2232   }
2233
2234   warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2235        scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2236     if $DEBUG;
2237
2238   grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2239 }
2240
2241 sub _banned_pay_hashref {
2242   my $self = shift;
2243
2244   my %payby2ban = (
2245     'CARD' => 'CARD',
2246     'DCRD' => 'CARD',
2247     'CHEK' => 'CHEK',
2248     'DCHK' => 'CHEK'
2249   );
2250
2251   {
2252     'payby'   => $payby2ban{$self->payby},
2253     'payinfo' => md5_base64($self->payinfo),
2254     #don't ever *search* on reason! #'reason'  =>
2255   };
2256 }
2257
2258 =item notes
2259
2260 Returns all notes (see L<FS::cust_main_note>) for this customer.
2261
2262 =cut
2263
2264 sub notes {
2265   my($self,$orderby_classnum) = (shift,shift);
2266   my $orderby = "_DATE DESC";
2267   $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2268   qsearch( 'cust_main_note',
2269            { 'custnum' => $self->custnum },
2270            '',
2271            "ORDER BY $orderby",
2272          );
2273 }
2274
2275 =item agent
2276
2277 Returns the agent (see L<FS::agent>) for this customer.
2278
2279 =cut
2280
2281 sub agent {
2282   my $self = shift;
2283   qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2284 }
2285
2286 =item agent_name
2287
2288 Returns the agent name (see L<FS::agent>) for this customer.
2289
2290 =cut
2291
2292 sub agent_name {
2293   my $self = shift;
2294   $self->agent->agent;
2295 }
2296
2297 =item cust_tag
2298
2299 Returns any tags associated with this customer, as FS::cust_tag objects,
2300 or an empty list if there are no tags.
2301
2302 =cut
2303
2304 sub cust_tag {
2305   my $self = shift;
2306   qsearch('cust_tag', { 'custnum' => $self->custnum } );
2307 }
2308
2309 =item part_tag
2310
2311 Returns any tags associated with this customer, as FS::part_tag objects,
2312 or an empty list if there are no tags.
2313
2314 =cut
2315
2316 sub part_tag {
2317   my $self = shift;
2318   map $_->part_tag, $self->cust_tag;
2319 }
2320
2321
2322 =item cust_class
2323
2324 Returns the customer class, as an FS::cust_class object, or the empty string
2325 if there is no customer class.
2326
2327 =cut
2328
2329 sub cust_class {
2330   my $self = shift;
2331   if ( $self->classnum ) {
2332     qsearchs('cust_class', { 'classnum' => $self->classnum } );
2333   } else {
2334     return '';
2335   }
2336 }
2337
2338 =item categoryname
2339
2340 Returns the customer category name, or the empty string if there is no customer
2341 category.
2342
2343 =cut
2344
2345 sub categoryname {
2346   my $self = shift;
2347   my $cust_class = $self->cust_class;
2348   $cust_class
2349     ? $cust_class->categoryname
2350     : '';
2351 }
2352
2353 =item classname
2354
2355 Returns the customer class name, or the empty string if there is no customer
2356 class.
2357
2358 =cut
2359
2360 sub classname {
2361   my $self = shift;
2362   my $cust_class = $self->cust_class;
2363   $cust_class
2364     ? $cust_class->classname
2365     : '';
2366 }
2367
2368 =item BILLING METHODS
2369
2370 Documentation on billing methods has been moved to
2371 L<FS::cust_main::Billing>.
2372
2373 =item REALTIME BILLING METHODS
2374
2375 Documentation on realtime billing methods has been moved to
2376 L<FS::cust_main::Billing_Realtime>.
2377
2378 =item remove_cvv
2379
2380 Removes the I<paycvv> field from the database directly.
2381
2382 If there is an error, returns the error, otherwise returns false.
2383
2384 =cut
2385
2386 sub remove_cvv {
2387   my $self = shift;
2388   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2389     or return dbh->errstr;
2390   $sth->execute($self->custnum)
2391     or return $sth->errstr;
2392   $self->paycvv('');
2393   '';
2394 }
2395
2396 =item batch_card OPTION => VALUE...
2397
2398 Adds a payment for this invoice to the pending credit card batch (see
2399 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2400 runs the payment using a realtime gateway.
2401
2402 =cut
2403
2404 sub batch_card {
2405   my ($self, %options) = @_;
2406
2407   my $amount;
2408   if (exists($options{amount})) {
2409     $amount = $options{amount};
2410   }else{
2411     $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2412   }
2413   return '' unless $amount > 0;
2414
2415   my $invnum = delete $options{invnum};
2416   my $payby = $options{payby} || $self->payby;  #still dubious
2417
2418   if ($options{'realtime'}) {
2419     return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2420                                 $amount,
2421                                 %options,
2422                               );
2423   }
2424
2425   my $oldAutoCommit = $FS::UID::AutoCommit;
2426   local $FS::UID::AutoCommit = 0;
2427   my $dbh = dbh;
2428
2429   #this needs to handle mysql as well as Pg, like svc_acct.pm
2430   #(make it into a common function if folks need to do batching with mysql)
2431   $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2432     or return "Cannot lock pay_batch: " . $dbh->errstr;
2433
2434   my %pay_batch = (
2435     'status' => 'O',
2436     'payby'  => FS::payby->payby2payment($payby),
2437   );
2438
2439   my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2440
2441   unless ( $pay_batch ) {
2442     $pay_batch = new FS::pay_batch \%pay_batch;
2443     my $error = $pay_batch->insert;
2444     if ( $error ) {
2445       $dbh->rollback if $oldAutoCommit;
2446       die "error creating new batch: $error\n";
2447     }
2448   }
2449
2450   my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2451       'batchnum' => $pay_batch->batchnum,
2452       'custnum'  => $self->custnum,
2453   } );
2454
2455   foreach (qw( address1 address2 city state zip country payby payinfo paydate
2456                payname )) {
2457     $options{$_} = '' unless exists($options{$_});
2458   }
2459
2460   my $cust_pay_batch = new FS::cust_pay_batch ( {
2461     'batchnum' => $pay_batch->batchnum,
2462     'invnum'   => $invnum || 0,                    # is there a better value?
2463                                                    # this field should be
2464                                                    # removed...
2465                                                    # cust_bill_pay_batch now
2466     'custnum'  => $self->custnum,
2467     'last'     => $self->getfield('last'),
2468     'first'    => $self->getfield('first'),
2469     'address1' => $options{address1} || $self->address1,
2470     'address2' => $options{address2} || $self->address2,
2471     'city'     => $options{city}     || $self->city,
2472     'state'    => $options{state}    || $self->state,
2473     'zip'      => $options{zip}      || $self->zip,
2474     'country'  => $options{country}  || $self->country,
2475     'payby'    => $options{payby}    || $self->payby,
2476     'payinfo'  => $options{payinfo}  || $self->payinfo,
2477     'exp'      => $options{paydate}  || $self->paydate,
2478     'payname'  => $options{payname}  || $self->payname,
2479     'amount'   => $amount,                         # consolidating
2480   } );
2481
2482   $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2483     if $old_cust_pay_batch;
2484
2485   my $error;
2486   if ($old_cust_pay_batch) {
2487     $error = $cust_pay_batch->replace($old_cust_pay_batch)
2488   } else {
2489     $error = $cust_pay_batch->insert;
2490   }
2491
2492   if ( $error ) {
2493     $dbh->rollback if $oldAutoCommit;
2494     die $error;
2495   }
2496
2497   my $unapplied =   $self->total_unapplied_credits
2498                   + $self->total_unapplied_payments
2499                   + $self->in_transit_payments;
2500   foreach my $cust_bill ($self->open_cust_bill) {
2501     #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2502     my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2503       'invnum' => $cust_bill->invnum,
2504       'paybatchnum' => $cust_pay_batch->paybatchnum,
2505       'amount' => $cust_bill->owed,
2506       '_date' => time,
2507     };
2508     if ($unapplied >= $cust_bill_pay_batch->amount){
2509       $unapplied -= $cust_bill_pay_batch->amount;
2510       next;
2511     }else{
2512       $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2513                                    $cust_bill_pay_batch->amount - $unapplied ));      $unapplied = 0;
2514     }
2515     $error = $cust_bill_pay_batch->insert;
2516     if ( $error ) {
2517       $dbh->rollback if $oldAutoCommit;
2518       die $error;
2519     }
2520   }
2521
2522   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2523   '';
2524 }
2525
2526 =item total_owed
2527
2528 Returns the total owed for this customer on all invoices
2529 (see L<FS::cust_bill/owed>).
2530
2531 =cut
2532
2533 sub total_owed {
2534   my $self = shift;
2535   $self->total_owed_date(2145859200); #12/31/2037
2536 }
2537
2538 =item total_owed_date TIME
2539
2540 Returns the total owed for this customer on all invoices with date earlier than
2541 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2542 see L<Time::Local> and L<Date::Parse> for conversion functions.
2543
2544 =cut
2545
2546 sub total_owed_date {
2547   my $self = shift;
2548   my $time = shift;
2549
2550   my $custnum = $self->custnum;
2551
2552   my $owed_sql = FS::cust_bill->owed_sql;
2553
2554   my $sql = "
2555     SELECT SUM($owed_sql) FROM cust_bill
2556       WHERE custnum = $custnum
2557         AND _date <= $time
2558   ";
2559
2560   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2561
2562 }
2563
2564 =item total_owed_pkgnum PKGNUM
2565
2566 Returns the total owed on all invoices for this customer's specific package
2567 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2568
2569 =cut
2570
2571 sub total_owed_pkgnum {
2572   my( $self, $pkgnum ) = @_;
2573   $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2574 }
2575
2576 =item total_owed_date_pkgnum TIME PKGNUM
2577
2578 Returns the total owed for this customer's specific package when using
2579 experimental package balances on all invoices with date earlier than
2580 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2581 see L<Time::Local> and L<Date::Parse> for conversion functions.
2582
2583 =cut
2584
2585 sub total_owed_date_pkgnum {
2586   my( $self, $time, $pkgnum ) = @_;
2587
2588   my $total_bill = 0;
2589   foreach my $cust_bill (
2590     grep { $_->_date <= $time }
2591       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2592   ) {
2593     $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2594   }
2595   sprintf( "%.2f", $total_bill );
2596
2597 }
2598
2599 =item total_paid
2600
2601 Returns the total amount of all payments.
2602
2603 =cut
2604
2605 sub total_paid {
2606   my $self = shift;
2607   my $total = 0;
2608   $total += $_->paid foreach $self->cust_pay;
2609   sprintf( "%.2f", $total );
2610 }
2611
2612 =item total_unapplied_credits
2613
2614 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2615 customer.  See L<FS::cust_credit/credited>.
2616
2617 =item total_credited
2618
2619 Old name for total_unapplied_credits.  Don't use.
2620
2621 =cut
2622
2623 sub total_credited {
2624   #carp "total_credited deprecated, use total_unapplied_credits";
2625   shift->total_unapplied_credits(@_);
2626 }
2627
2628 sub total_unapplied_credits {
2629   my $self = shift;
2630
2631   my $custnum = $self->custnum;
2632
2633   my $unapplied_sql = FS::cust_credit->unapplied_sql;
2634
2635   my $sql = "
2636     SELECT SUM($unapplied_sql) FROM cust_credit
2637       WHERE custnum = $custnum
2638   ";
2639
2640   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2641
2642 }
2643
2644 =item total_unapplied_credits_pkgnum PKGNUM
2645
2646 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2647 customer.  See L<FS::cust_credit/credited>.
2648
2649 =cut
2650
2651 sub total_unapplied_credits_pkgnum {
2652   my( $self, $pkgnum ) = @_;
2653   my $total_credit = 0;
2654   $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2655   sprintf( "%.2f", $total_credit );
2656 }
2657
2658
2659 =item total_unapplied_payments
2660
2661 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2662 See L<FS::cust_pay/unapplied>.
2663
2664 =cut
2665
2666 sub total_unapplied_payments {
2667   my $self = shift;
2668
2669   my $custnum = $self->custnum;
2670
2671   my $unapplied_sql = FS::cust_pay->unapplied_sql;
2672
2673   my $sql = "
2674     SELECT SUM($unapplied_sql) FROM cust_pay
2675       WHERE custnum = $custnum
2676   ";
2677
2678   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2679
2680 }
2681
2682 =item total_unapplied_payments_pkgnum PKGNUM
2683
2684 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2685 specific package when using experimental package balances.  See
2686 L<FS::cust_pay/unapplied>.
2687
2688 =cut
2689
2690 sub total_unapplied_payments_pkgnum {
2691   my( $self, $pkgnum ) = @_;
2692   my $total_unapplied = 0;
2693   $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2694   sprintf( "%.2f", $total_unapplied );
2695 }
2696
2697
2698 =item total_unapplied_refunds
2699
2700 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2701 customer.  See L<FS::cust_refund/unapplied>.
2702
2703 =cut
2704
2705 sub total_unapplied_refunds {
2706   my $self = shift;
2707   my $custnum = $self->custnum;
2708
2709   my $unapplied_sql = FS::cust_refund->unapplied_sql;
2710
2711   my $sql = "
2712     SELECT SUM($unapplied_sql) FROM cust_refund
2713       WHERE custnum = $custnum
2714   ";
2715
2716   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2717
2718 }
2719
2720 =item balance
2721
2722 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2723 total_unapplied_credits minus total_unapplied_payments).
2724
2725 =cut
2726
2727 sub balance {
2728   my $self = shift;
2729   $self->balance_date_range;
2730 }
2731
2732 =item balance_date TIME
2733
2734 Returns the balance for this customer, only considering invoices with date
2735 earlier than TIME (total_owed_date minus total_credited minus
2736 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
2737 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
2738 functions.
2739
2740 =cut
2741
2742 sub balance_date {
2743   my $self = shift;
2744   $self->balance_date_range(shift);
2745 }
2746
2747 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2748
2749 Returns the balance for this customer, optionally considering invoices with
2750 date earlier than START_TIME, and not later than END_TIME
2751 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2752
2753 Times are specified as SQL fragments or numeric
2754 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
2755 L<Date::Parse> for conversion functions.  The empty string can be passed
2756 to disable that time constraint completely.
2757
2758 Available options are:
2759
2760 =over 4
2761
2762 =item unapplied_date
2763
2764 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)
2765
2766 =back
2767
2768 =cut
2769
2770 sub balance_date_range {
2771   my $self = shift;
2772   my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2773             ') FROM cust_main WHERE custnum='. $self->custnum;
2774   sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2775 }
2776
2777 =item balance_pkgnum PKGNUM
2778
2779 Returns the balance for this customer's specific package when using
2780 experimental package balances (total_owed plus total_unrefunded, minus
2781 total_unapplied_credits minus total_unapplied_payments)
2782
2783 =cut
2784
2785 sub balance_pkgnum {
2786   my( $self, $pkgnum ) = @_;
2787
2788   sprintf( "%.2f",
2789       $self->total_owed_pkgnum($pkgnum)
2790 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2791 #    + $self->total_unapplied_refunds_pkgnum($pkgnum)
2792     - $self->total_unapplied_credits_pkgnum($pkgnum)
2793     - $self->total_unapplied_payments_pkgnum($pkgnum)
2794   );
2795 }
2796
2797 =item in_transit_payments
2798
2799 Returns the total of requests for payments for this customer pending in
2800 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
2801
2802 =cut
2803
2804 sub in_transit_payments {
2805   my $self = shift;
2806   my $in_transit_payments = 0;
2807   foreach my $pay_batch ( qsearch('pay_batch', {
2808     'status' => 'I',
2809   } ) ) {
2810     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2811       'batchnum' => $pay_batch->batchnum,
2812       'custnum' => $self->custnum,
2813     } ) ) {
2814       $in_transit_payments += $cust_pay_batch->amount;
2815     }
2816   }
2817   sprintf( "%.2f", $in_transit_payments );
2818 }
2819
2820 =item payment_info
2821
2822 Returns a hash of useful information for making a payment.
2823
2824 =over 4
2825
2826 =item balance
2827
2828 Current balance.
2829
2830 =item payby
2831
2832 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2833 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2834 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2835
2836 =back
2837
2838 For credit card transactions:
2839
2840 =over 4
2841
2842 =item card_type 1
2843
2844 =item payname
2845
2846 Exact name on card
2847
2848 =back
2849
2850 For electronic check transactions:
2851
2852 =over 4
2853
2854 =item stateid_state
2855
2856 =back
2857
2858 =cut
2859
2860 sub payment_info {
2861   my $self = shift;
2862
2863   my %return = ();
2864
2865   $return{balance} = $self->balance;
2866
2867   $return{payname} = $self->payname
2868                      || ( $self->first. ' '. $self->get('last') );
2869
2870   $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
2871
2872   $return{payby} = $self->payby;
2873   $return{stateid_state} = $self->stateid_state;
2874
2875   if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2876     $return{card_type} = cardtype($self->payinfo);
2877     $return{payinfo} = $self->paymask;
2878
2879     @return{'month', 'year'} = $self->paydate_monthyear;
2880
2881   }
2882
2883   if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2884     my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2885     $return{payinfo1} = $payinfo1;
2886     $return{payinfo2} = $payinfo2;
2887     $return{paytype}  = $self->paytype;
2888     $return{paystate} = $self->paystate;
2889
2890   }
2891
2892   #doubleclick protection
2893   my $_date = time;
2894   $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2895
2896   %return;
2897
2898 }
2899
2900 =item paydate_monthyear
2901
2902 Returns a two-element list consisting of the month and year of this customer's
2903 paydate (credit card expiration date for CARD customers)
2904
2905 =cut
2906
2907 sub paydate_monthyear {
2908   my $self = shift;
2909   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2910     ( $2, $1 );
2911   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2912     ( $1, $3 );
2913   } else {
2914     ('', '');
2915   }
2916 }
2917
2918 =item paydate_epoch
2919
2920 Returns the exact time in seconds corresponding to the payment method
2921 expiration date.  For CARD/DCRD customers this is the end of the month;
2922 for others (COMP is the only other payby that uses paydate) it's the start.
2923 Returns 0 if the paydate is empty or set to the far future.
2924
2925 =cut
2926
2927 sub paydate_epoch {
2928   my $self = shift;
2929   my ($month, $year) = $self->paydate_monthyear;
2930   return 0 if !$year or $year >= 2037;
2931   if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
2932     $month++;
2933     if ( $month == 13 ) {
2934       $month = 1;
2935       $year++;
2936     }
2937     return timelocal(0,0,0,1,$month-1,$year) - 1;
2938   }
2939   else {
2940     return timelocal(0,0,0,1,$month-1,$year);
2941   }
2942 }
2943
2944 =item paydate_epoch_sql
2945
2946 Class method.  Returns an SQL expression to obtain the payment expiration date
2947 as a number of seconds.
2948
2949 =cut
2950
2951 # Special expiration date behavior for non-CARD/DCRD customers has been
2952 # carefully preserved.  Do we really use that?
2953 sub paydate_epoch_sql {
2954   my $class = shift;
2955   my $table = shift || 'cust_main';
2956   my ($case1, $case2);
2957   if ( driver_name eq 'Pg' ) {
2958     $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
2959     $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
2960   }
2961   elsif ( lc(driver_name) eq 'mysql' ) {
2962     $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
2963     $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
2964   }
2965   else { return '' }
2966   return "CASE WHEN $table.payby IN('CARD','DCRD')
2967   THEN ($case1)
2968   ELSE ($case2)
2969   END"
2970 }
2971
2972 =item tax_exemption TAXNAME
2973
2974 =cut
2975
2976 sub tax_exemption {
2977   my( $self, $taxname ) = @_;
2978
2979   qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2980                                      'taxname' => $taxname,
2981                                    },
2982           );
2983 }
2984
2985 =item cust_main_exemption
2986
2987 =cut
2988
2989 sub cust_main_exemption {
2990   my $self = shift;
2991   qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
2992 }
2993
2994 =item invoicing_list [ ARRAYREF ]
2995
2996 If an arguement is given, sets these email addresses as invoice recipients
2997 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
2998 (except as warnings), so use check_invoicing_list first.
2999
3000 Returns a list of email addresses (with svcnum entries expanded).
3001
3002 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
3003 check it without disturbing anything by passing nothing.
3004
3005 This interface may change in the future.
3006
3007 =cut
3008
3009 sub invoicing_list {
3010   my( $self, $arrayref ) = @_;
3011
3012   if ( $arrayref ) {
3013     my @cust_main_invoice;
3014     if ( $self->custnum ) {
3015       @cust_main_invoice =
3016         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3017     } else {
3018       @cust_main_invoice = ();
3019     }
3020     foreach my $cust_main_invoice ( @cust_main_invoice ) {
3021       #warn $cust_main_invoice->destnum;
3022       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3023         #warn $cust_main_invoice->destnum;
3024         my $error = $cust_main_invoice->delete;
3025         warn $error if $error;
3026       }
3027     }
3028     if ( $self->custnum ) {
3029       @cust_main_invoice =
3030         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3031     } else {
3032       @cust_main_invoice = ();
3033     }
3034     my %seen = map { $_->address => 1 } @cust_main_invoice;
3035     foreach my $address ( @{$arrayref} ) {
3036       next if exists $seen{$address} && $seen{$address};
3037       $seen{$address} = 1;
3038       my $cust_main_invoice = new FS::cust_main_invoice ( {
3039         'custnum' => $self->custnum,
3040         'dest'    => $address,
3041       } );
3042       my $error = $cust_main_invoice->insert;
3043       warn $error if $error;
3044     }
3045   }
3046
3047   if ( $self->custnum ) {
3048     map { $_->address }
3049       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3050   } else {
3051     ();
3052   }
3053
3054 }
3055
3056 =item check_invoicing_list ARRAYREF
3057
3058 Checks these arguements as valid input for the invoicing_list method.  If there
3059 is an error, returns the error, otherwise returns false.
3060
3061 =cut
3062
3063 sub check_invoicing_list {
3064   my( $self, $arrayref ) = @_;
3065
3066   foreach my $address ( @$arrayref ) {
3067
3068     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3069       return 'Can\'t add FAX invoice destination with a blank FAX number.';
3070     }
3071
3072     my $cust_main_invoice = new FS::cust_main_invoice ( {
3073       'custnum' => $self->custnum,
3074       'dest'    => $address,
3075     } );
3076     my $error = $self->custnum
3077                 ? $cust_main_invoice->check
3078                 : $cust_main_invoice->checkdest
3079     ;
3080     return $error if $error;
3081
3082   }
3083
3084   return "Email address required"
3085     if $conf->exists('cust_main-require_invoicing_list_email')
3086     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3087
3088   '';
3089 }
3090
3091 =item set_default_invoicing_list
3092
3093 Sets the invoicing list to all accounts associated with this customer,
3094 overwriting any previous invoicing list.
3095
3096 =cut
3097
3098 sub set_default_invoicing_list {
3099   my $self = shift;
3100   $self->invoicing_list($self->all_emails);
3101 }
3102
3103 =item all_emails
3104
3105 Returns the email addresses of all accounts provisioned for this customer.
3106
3107 =cut
3108
3109 sub all_emails {
3110   my $self = shift;
3111   my %list;
3112   foreach my $cust_pkg ( $self->all_pkgs ) {
3113     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3114     my @svc_acct =
3115       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3116         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3117           @cust_svc;
3118     $list{$_}=1 foreach map { $_->email } @svc_acct;
3119   }
3120   keys %list;
3121 }
3122
3123 =item invoicing_list_addpost
3124
3125 Adds postal invoicing to this customer.  If this customer is already configured
3126 to receive postal invoices, does nothing.
3127
3128 =cut
3129
3130 sub invoicing_list_addpost {
3131   my $self = shift;
3132   return if grep { $_ eq 'POST' } $self->invoicing_list;
3133   my @invoicing_list = $self->invoicing_list;
3134   push @invoicing_list, 'POST';
3135   $self->invoicing_list(\@invoicing_list);
3136 }
3137
3138 =item invoicing_list_emailonly
3139
3140 Returns the list of email invoice recipients (invoicing_list without non-email
3141 destinations such as POST and FAX).
3142
3143 =cut
3144
3145 sub invoicing_list_emailonly {
3146   my $self = shift;
3147   warn "$me invoicing_list_emailonly called"
3148     if $DEBUG;
3149   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3150 }
3151
3152 =item invoicing_list_emailonly_scalar
3153
3154 Returns the list of email invoice recipients (invoicing_list without non-email
3155 destinations such as POST and FAX) as a comma-separated scalar.
3156
3157 =cut
3158
3159 sub invoicing_list_emailonly_scalar {
3160   my $self = shift;
3161   warn "$me invoicing_list_emailonly_scalar called"
3162     if $DEBUG;
3163   join(', ', $self->invoicing_list_emailonly);
3164 }
3165
3166 =item referral_custnum_cust_main
3167
3168 Returns the customer who referred this customer (or the empty string, if
3169 this customer was not referred).
3170
3171 Note the difference with referral_cust_main method: This method,
3172 referral_custnum_cust_main returns the single customer (if any) who referred
3173 this customer, while referral_cust_main returns an array of customers referred
3174 BY this customer.
3175
3176 =cut
3177
3178 sub referral_custnum_cust_main {
3179   my $self = shift;
3180   return '' unless $self->referral_custnum;
3181   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3182 }
3183
3184 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3185
3186 Returns an array of customers referred by this customer (referral_custnum set
3187 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
3188 customers referred by customers referred by this customer and so on, inclusive.
3189 The default behavior is DEPTH 1 (no recursion).
3190
3191 Note the difference with referral_custnum_cust_main method: This method,
3192 referral_cust_main, returns an array of customers referred BY this customer,
3193 while referral_custnum_cust_main returns the single customer (if any) who
3194 referred this customer.
3195
3196 =cut
3197
3198 sub referral_cust_main {
3199   my $self = shift;
3200   my $depth = @_ ? shift : 1;
3201   my $exclude = @_ ? shift : {};
3202
3203   my @cust_main =
3204     map { $exclude->{$_->custnum}++; $_; }
3205       grep { ! $exclude->{ $_->custnum } }
3206         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3207
3208   if ( $depth > 1 ) {
3209     push @cust_main,
3210       map { $_->referral_cust_main($depth-1, $exclude) }
3211         @cust_main;
3212   }
3213
3214   @cust_main;
3215 }
3216
3217 =item referral_cust_main_ncancelled
3218
3219 Same as referral_cust_main, except only returns customers with uncancelled
3220 packages.
3221
3222 =cut
3223
3224 sub referral_cust_main_ncancelled {
3225   my $self = shift;
3226   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3227 }
3228
3229 =item referral_cust_pkg [ DEPTH ]
3230
3231 Like referral_cust_main, except returns a flat list of all unsuspended (and
3232 uncancelled) packages for each customer.  The number of items in this list may
3233 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3234
3235 =cut
3236
3237 sub referral_cust_pkg {
3238   my $self = shift;
3239   my $depth = @_ ? shift : 1;
3240
3241   map { $_->unsuspended_pkgs }
3242     grep { $_->unsuspended_pkgs }
3243       $self->referral_cust_main($depth);
3244 }
3245
3246 =item referring_cust_main
3247
3248 Returns the single cust_main record for the customer who referred this customer
3249 (referral_custnum), or false.
3250
3251 =cut
3252
3253 sub referring_cust_main {
3254   my $self = shift;
3255   return '' unless $self->referral_custnum;
3256   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3257 }
3258
3259 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3260
3261 Applies a credit to this customer.  If there is an error, returns the error,
3262 otherwise returns false.
3263
3264 REASON can be a text string, an FS::reason object, or a scalar reference to
3265 a reasonnum.  If a text string, it will be automatically inserted as a new
3266 reason, and a 'reason_type' option must be passed to indicate the
3267 FS::reason_type for the new reason.
3268
3269 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3270
3271 Any other options are passed to FS::cust_credit::insert.
3272
3273 =cut
3274
3275 sub credit {
3276   my( $self, $amount, $reason, %options ) = @_;
3277
3278   my $cust_credit = new FS::cust_credit {
3279     'custnum' => $self->custnum,
3280     'amount'  => $amount,
3281   };
3282
3283   if ( ref($reason) ) {
3284
3285     if ( ref($reason) eq 'SCALAR' ) {
3286       $cust_credit->reasonnum( $$reason );
3287     } else {
3288       $cust_credit->reasonnum( $reason->reasonnum );
3289     }
3290
3291   } else {
3292     $cust_credit->set('reason', $reason)
3293   }
3294
3295   for (qw( addlinfo eventnum )) {
3296     $cust_credit->$_( delete $options{$_} )
3297       if exists($options{$_});
3298   }
3299
3300   $cust_credit->insert(%options);
3301
3302 }
3303
3304 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3305
3306 Creates a one-time charge for this customer.  If there is an error, returns
3307 the error, otherwise returns false.
3308
3309 New-style, with a hashref of options:
3310
3311   my $error = $cust_main->charge(
3312                                   {
3313                                     'amount'     => 54.32,
3314                                     'quantity'   => 1,
3315                                     'start_date' => str2time('7/4/2009'),
3316                                     'pkg'        => 'Description',
3317                                     'comment'    => 'Comment',
3318                                     'additional' => [], #extra invoice detail
3319                                     'classnum'   => 1,  #pkg_class
3320
3321                                     'setuptax'   => '', # or 'Y' for tax exempt
3322
3323                                     #internal taxation
3324                                     'taxclass'   => 'Tax class',
3325
3326                                     #vendor taxation
3327                                     'taxproduct' => 2,  #part_pkg_taxproduct
3328                                     'override'   => {}, #XXX describe
3329
3330                                     #will be filled in with the new object
3331                                     'cust_pkg_ref' => \$cust_pkg,
3332
3333                                     #generate an invoice immediately
3334                                     'bill_now' => 0,
3335                                     'invoice_terms' => '', #with these terms
3336                                   }
3337                                 );
3338
3339 Old-style:
3340
3341   my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3342
3343 =cut
3344
3345 sub charge {
3346   my $self = shift;
3347   my ( $amount, $quantity, $start_date, $classnum );
3348   my ( $pkg, $comment, $additional );
3349   my ( $setuptax, $taxclass );   #internal taxes
3350   my ( $taxproduct, $override ); #vendor (CCH) taxes
3351   my $no_auto = '';
3352   my $cust_pkg_ref = '';
3353   my ( $bill_now, $invoice_terms ) = ( 0, '' );
3354   if ( ref( $_[0] ) ) {
3355     $amount     = $_[0]->{amount};
3356     $quantity   = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3357     $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3358     $no_auto    = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3359     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3360     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
3361                                            : '$'. sprintf("%.2f",$amount);
3362     $setuptax   = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3363     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3364     $classnum   = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3365     $additional = $_[0]->{additional} || [];
3366     $taxproduct = $_[0]->{taxproductnum};
3367     $override   = { '' => $_[0]->{tax_override} };
3368     $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3369     $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3370     $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3371   } else {
3372     $amount     = shift;
3373     $quantity   = 1;
3374     $start_date = '';
3375     $pkg        = @_ ? shift : 'One-time charge';
3376     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
3377     $setuptax   = '';
3378     $taxclass   = @_ ? shift : '';
3379     $additional = [];
3380   }
3381
3382   local $SIG{HUP} = 'IGNORE';
3383   local $SIG{INT} = 'IGNORE';
3384   local $SIG{QUIT} = 'IGNORE';
3385   local $SIG{TERM} = 'IGNORE';
3386   local $SIG{TSTP} = 'IGNORE';
3387   local $SIG{PIPE} = 'IGNORE';
3388
3389   my $oldAutoCommit = $FS::UID::AutoCommit;
3390   local $FS::UID::AutoCommit = 0;
3391   my $dbh = dbh;
3392
3393   my $part_pkg = new FS::part_pkg ( {
3394     'pkg'           => $pkg,
3395     'comment'       => $comment,
3396     'plan'          => 'flat',
3397     'freq'          => 0,
3398     'disabled'      => 'Y',
3399     'classnum'      => ( $classnum ? $classnum : '' ),
3400     'setuptax'      => $setuptax,
3401     'taxclass'      => $taxclass,
3402     'taxproductnum' => $taxproduct,
3403   } );
3404
3405   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3406                         ( 0 .. @$additional - 1 )
3407                   ),
3408                   'additional_count' => scalar(@$additional),
3409                   'setup_fee' => $amount,
3410                 );
3411
3412   my $error = $part_pkg->insert( options       => \%options,
3413                                  tax_overrides => $override,
3414                                );
3415   if ( $error ) {
3416     $dbh->rollback if $oldAutoCommit;
3417     return $error;
3418   }
3419
3420   my $pkgpart = $part_pkg->pkgpart;
3421   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3422   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3423     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3424     $error = $type_pkgs->insert;
3425     if ( $error ) {
3426       $dbh->rollback if $oldAutoCommit;
3427       return $error;
3428     }
3429   }
3430
3431   my $cust_pkg = new FS::cust_pkg ( {
3432     'custnum'    => $self->custnum,
3433     'pkgpart'    => $pkgpart,
3434     'quantity'   => $quantity,
3435     'start_date' => $start_date,
3436     'no_auto'    => $no_auto,
3437   } );
3438
3439   $error = $cust_pkg->insert;
3440   if ( $error ) {
3441     $dbh->rollback if $oldAutoCommit;
3442     return $error;
3443   } elsif ( $cust_pkg_ref ) {
3444     ${$cust_pkg_ref} = $cust_pkg;
3445   }
3446
3447   if ( $bill_now ) {
3448     my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3449                              'pkg_list'      => [ $cust_pkg ],
3450                            );
3451     if ( $error ) {
3452       $dbh->rollback if $oldAutoCommit;
3453       return $error;
3454     }
3455   }
3456
3457   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3458   return '';
3459
3460 }
3461
3462 #=item charge_postal_fee
3463 #
3464 #Applies a one time charge this customer.  If there is an error,
3465 #returns the error, returns the cust_pkg charge object or false
3466 #if there was no charge.
3467 #
3468 #=cut
3469 #
3470 # This should be a customer event.  For that to work requires that bill
3471 # also be a customer event.
3472
3473 sub charge_postal_fee {
3474   my $self = shift;
3475
3476   my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3477   return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3478
3479   my $cust_pkg = new FS::cust_pkg ( {
3480     'custnum'  => $self->custnum,
3481     'pkgpart'  => $pkgpart,
3482     'quantity' => 1,
3483   } );
3484
3485   my $error = $cust_pkg->insert;
3486   $error ? $error : $cust_pkg;
3487 }
3488
3489 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3490
3491 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3492
3493 Optionally, a list or hashref of additional arguments to the qsearch call can
3494 be passed.
3495
3496 =cut
3497
3498 sub cust_bill {
3499   my $self = shift;
3500   my $opt = ref($_[0]) ? shift : { @_ };
3501
3502   #return $self->num_cust_bill unless wantarray || keys %$opt;
3503
3504   $opt->{'table'} = 'cust_bill';
3505   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3506   $opt->{'hashref'}{'custnum'} = $self->custnum;
3507   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3508
3509   map { $_ } #behavior of sort undefined in scalar context
3510     sort { $a->_date <=> $b->_date }
3511       qsearch($opt);
3512 }
3513
3514 =item open_cust_bill
3515
3516 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3517 customer.
3518
3519 =cut
3520
3521 sub open_cust_bill {
3522   my $self = shift;
3523
3524   $self->cust_bill(
3525     'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3526     #@_
3527   );
3528
3529 }
3530
3531 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3532
3533 Returns all the statements (see L<FS::cust_statement>) for this customer.
3534
3535 Optionally, a list or hashref of additional arguments to the qsearch call can
3536 be passed.
3537
3538 =cut
3539
3540 sub cust_statement {
3541   my $self = shift;
3542   my $opt = ref($_[0]) ? shift : { @_ };
3543
3544   #return $self->num_cust_statement unless wantarray || keys %$opt;
3545
3546   $opt->{'table'} = 'cust_statement';
3547   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3548   $opt->{'hashref'}{'custnum'} = $self->custnum;
3549   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3550
3551   map { $_ } #behavior of sort undefined in scalar context
3552     sort { $a->_date <=> $b->_date }
3553       qsearch($opt);
3554 }
3555
3556 =item cust_credit
3557
3558 Returns all the credits (see L<FS::cust_credit>) for this customer.
3559
3560 =cut
3561
3562 sub cust_credit {
3563   my $self = shift;
3564   map { $_ } #return $self->num_cust_credit unless wantarray;
3565   sort { $a->_date <=> $b->_date }
3566     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3567 }
3568
3569 =item cust_credit_pkgnum
3570
3571 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3572 package when using experimental package balances.
3573
3574 =cut
3575
3576 sub cust_credit_pkgnum {
3577   my( $self, $pkgnum ) = @_;
3578   map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3579   sort { $a->_date <=> $b->_date }
3580     qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3581                               'pkgnum'  => $pkgnum,
3582                             }
3583     );
3584 }
3585
3586 =item cust_pay
3587
3588 Returns all the payments (see L<FS::cust_pay>) for this customer.
3589
3590 =cut
3591
3592 sub cust_pay {
3593   my $self = shift;
3594   return $self->num_cust_pay unless wantarray;
3595   sort { $a->_date <=> $b->_date }
3596     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3597 }
3598
3599 =item num_cust_pay
3600
3601 Returns the number of payments (see L<FS::cust_pay>) for this customer.  Also
3602 called automatically when the cust_pay method is used in a scalar context.
3603
3604 =cut
3605
3606 sub num_cust_pay {
3607   my $self = shift;
3608   my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3609   my $sth = dbh->prepare($sql) or die dbh->errstr;
3610   $sth->execute($self->custnum) or die $sth->errstr;
3611   $sth->fetchrow_arrayref->[0];
3612 }
3613
3614 =item cust_pay_pkgnum
3615
3616 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3617 package when using experimental package balances.
3618
3619 =cut
3620
3621 sub cust_pay_pkgnum {
3622   my( $self, $pkgnum ) = @_;
3623   map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3624   sort { $a->_date <=> $b->_date }
3625     qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3626                            'pkgnum'  => $pkgnum,
3627                          }
3628     );
3629 }
3630
3631 =item cust_pay_void
3632
3633 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3634
3635 =cut
3636
3637 sub cust_pay_void {
3638   my $self = shift;
3639   map { $_ } #return $self->num_cust_pay_void unless wantarray;
3640   sort { $a->_date <=> $b->_date }
3641     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3642 }
3643
3644 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3645
3646 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
3647
3648 Optionally, a list or hashref of additional arguments to the qsearch call can
3649 be passed.
3650
3651 =cut
3652
3653 sub cust_pay_batch {
3654   my $self = shift;
3655   my $opt = ref($_[0]) ? shift : { @_ };
3656
3657   #return $self->num_cust_statement unless wantarray || keys %$opt;
3658
3659   $opt->{'table'} = 'cust_pay_batch';
3660   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3661   $opt->{'hashref'}{'custnum'} = $self->custnum;
3662   $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3663
3664   map { $_ } #behavior of sort undefined in scalar context
3665     sort { $a->paybatchnum <=> $b->paybatchnum }
3666       qsearch($opt);
3667 }
3668
3669 =item cust_pay_pending
3670
3671 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3672 (without status "done").
3673
3674 =cut
3675
3676 sub cust_pay_pending {
3677   my $self = shift;
3678   return $self->num_cust_pay_pending unless wantarray;
3679   sort { $a->_date <=> $b->_date }
3680     qsearch( 'cust_pay_pending', {
3681                                    'custnum' => $self->custnum,
3682                                    'status'  => { op=>'!=', value=>'done' },
3683                                  },
3684            );
3685 }
3686
3687 =item cust_pay_pending_attempt
3688
3689 Returns all payment attempts / declined payments for this customer, as pending
3690 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3691 a corresponding payment (see L<FS::cust_pay>).
3692
3693 =cut
3694
3695 sub cust_pay_pending_attempt {
3696   my $self = shift;
3697   return $self->num_cust_pay_pending_attempt unless wantarray;
3698   sort { $a->_date <=> $b->_date }
3699     qsearch( 'cust_pay_pending', {
3700                                    'custnum' => $self->custnum,
3701                                    'status'  => 'done',
3702                                    'paynum'  => '',
3703                                  },
3704            );
3705 }
3706
3707 =item num_cust_pay_pending
3708
3709 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3710 customer (without status "done").  Also called automatically when the
3711 cust_pay_pending method is used in a scalar context.
3712
3713 =cut
3714
3715 sub num_cust_pay_pending {
3716   my $self = shift;
3717   $self->scalar_sql(
3718     " SELECT COUNT(*) FROM cust_pay_pending ".
3719       " WHERE custnum = ? AND status != 'done' ",
3720     $self->custnum
3721   );
3722 }
3723
3724 =item num_cust_pay_pending_attempt
3725
3726 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3727 customer, with status "done" but without a corresp.  Also called automatically when the
3728 cust_pay_pending method is used in a scalar context.
3729
3730 =cut
3731
3732 sub num_cust_pay_pending_attempt {
3733   my $self = shift;
3734   $self->scalar_sql(
3735     " SELECT COUNT(*) FROM cust_pay_pending ".
3736       " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3737     $self->custnum
3738   );
3739 }
3740
3741 =item cust_refund
3742
3743 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3744
3745 =cut
3746
3747 sub cust_refund {
3748   my $self = shift;
3749   map { $_ } #return $self->num_cust_refund unless wantarray;
3750   sort { $a->_date <=> $b->_date }
3751     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3752 }
3753
3754 =item display_custnum
3755
3756 Returns the displayed customer number for this customer: agent_custid if
3757 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3758
3759 =cut
3760
3761 sub display_custnum {
3762   my $self = shift;
3763   if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3764     return $self->agent_custid;
3765   } else {
3766     return $self->custnum;
3767   }
3768 }
3769
3770 =item name
3771
3772 Returns a name string for this customer, either "Company (Last, First)" or
3773 "Last, First".
3774
3775 =cut
3776
3777 sub name {
3778   my $self = shift;
3779   my $name = $self->contact;
3780   $name = $self->company. " ($name)" if $self->company;
3781   $name;
3782 }
3783
3784 =item ship_name
3785
3786 Returns a name string for this (service/shipping) contact, either
3787 "Company (Last, First)" or "Last, First".
3788
3789 =cut
3790
3791 sub ship_name {
3792   my $self = shift;
3793   if ( $self->get('ship_last') ) {
3794     my $name = $self->ship_contact;
3795     $name = $self->ship_company. " ($name)" if $self->ship_company;
3796     $name;
3797   } else {
3798     $self->name;
3799   }
3800 }
3801
3802 =item name_short
3803
3804 Returns a name string for this customer, either "Company" or "First Last".
3805
3806 =cut
3807
3808 sub name_short {
3809   my $self = shift;
3810   $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3811 }
3812
3813 =item ship_name_short
3814
3815 Returns a name string for this (service/shipping) contact, either "Company"
3816 or "First Last".
3817
3818 =cut
3819
3820 sub ship_name_short {
3821   my $self = shift;
3822   if ( $self->get('ship_last') ) {
3823     $self->ship_company !~ /^\s*$/
3824       ? $self->ship_company
3825       : $self->ship_contact_firstlast;
3826   } else {
3827     $self->name_company_or_firstlast;
3828   }
3829 }
3830
3831 =item contact
3832
3833 Returns this customer's full (billing) contact name only, "Last, First"
3834
3835 =cut
3836
3837 sub contact {
3838   my $self = shift;
3839   $self->get('last'). ', '. $self->first;
3840 }
3841
3842 =item ship_contact
3843
3844 Returns this customer's full (shipping) contact name only, "Last, First"
3845
3846 =cut
3847
3848 sub ship_contact {
3849   my $self = shift;
3850   $self->get('ship_last')
3851     ? $self->get('ship_last'). ', '. $self->ship_first
3852     : $self->contact;
3853 }
3854
3855 =item contact_firstlast
3856
3857 Returns this customers full (billing) contact name only, "First Last".
3858
3859 =cut
3860
3861 sub contact_firstlast {
3862   my $self = shift;
3863   $self->first. ' '. $self->get('last');
3864 }
3865
3866 =item ship_contact_firstlast
3867
3868 Returns this customer's full (shipping) contact name only, "First Last".
3869
3870 =cut
3871
3872 sub ship_contact_firstlast {
3873   my $self = shift;
3874   $self->get('ship_last')
3875     ? $self->first. ' '. $self->get('ship_last')
3876     : $self->contact_firstlast;
3877 }
3878
3879 =item country_full
3880
3881 Returns this customer's full country name
3882
3883 =cut
3884
3885 sub country_full {
3886   my $self = shift;
3887   code2country($self->country);
3888 }
3889
3890 =item geocode DATA_VENDOR
3891
3892 Returns a value for the customer location as encoded by DATA_VENDOR.
3893 Currently this only makes sense for "CCH" as DATA_VENDOR.
3894
3895 =cut
3896
3897 =item cust_status
3898
3899 =item status
3900
3901 Returns a status string for this customer, currently:
3902
3903 =over 4
3904
3905 =item prospect - No packages have ever been ordered
3906
3907 =item ordered - Recurring packages all are new (not yet billed).
3908
3909 =item active - One or more recurring packages is active
3910
3911 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
3912
3913 =item suspended - All non-cancelled recurring packages are suspended
3914
3915 =item cancelled - All recurring packages are cancelled
3916
3917 =back
3918
3919 Behavior of inactive vs. cancelled edge cases can be adjusted with the
3920 cust_main-status_module configuration option.
3921
3922 =cut
3923
3924 sub status { shift->cust_status(@_); }
3925
3926 sub cust_status {
3927   my $self = shift;
3928   for my $status ( FS::cust_main->statuses() ) {
3929     my $method = $status.'_sql';
3930     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3931     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3932     $sth->execute( ($self->custnum) x $numnum )
3933       or die "Error executing 'SELECT $sql': ". $sth->errstr;
3934     return $status if $sth->fetchrow_arrayref->[0];
3935   }
3936 }
3937
3938 =item ucfirst_cust_status
3939
3940 =item ucfirst_status
3941
3942 Returns the status with the first character capitalized.
3943
3944 =cut
3945
3946 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
3947
3948 sub ucfirst_cust_status {
3949   my $self = shift;
3950   ucfirst($self->cust_status);
3951 }
3952
3953 =item statuscolor
3954
3955 Returns a hex triplet color string for this customer's status.
3956
3957 =cut
3958
3959 sub statuscolor { shift->cust_statuscolor(@_); }
3960
3961 sub cust_statuscolor {
3962   my $self = shift;
3963   __PACKAGE__->statuscolors->{$self->cust_status};
3964 }
3965
3966 =item tickets
3967
3968 Returns an array of hashes representing the customer's RT tickets.
3969
3970 =cut
3971
3972 sub tickets {
3973   my $self = shift;
3974
3975   my $num = $conf->config('cust_main-max_tickets') || 10;
3976   my @tickets = ();
3977
3978   if ( $conf->config('ticket_system') ) {
3979     unless ( $conf->config('ticket_system-custom_priority_field') ) {
3980
3981       @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
3982
3983     } else {
3984
3985       foreach my $priority (
3986         $conf->config('ticket_system-custom_priority_field-values'), ''
3987       ) {
3988         last if scalar(@tickets) >= $num;
3989         push @tickets,
3990           @{ FS::TicketSystem->customer_tickets( $self->custnum,
3991                                                  $num - scalar(@tickets),
3992                                                  $priority,
3993                                                )
3994            };
3995       }
3996     }
3997   }
3998   (@tickets);
3999 }
4000
4001 # Return services representing svc_accts in customer support packages
4002 sub support_services {
4003   my $self = shift;
4004   my %packages = map { $_ => 1 } $conf->config('support_packages');
4005
4006   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4007     grep { $_->part_svc->svcdb eq 'svc_acct' }
4008     map { $_->cust_svc }
4009     grep { exists $packages{ $_->pkgpart } }
4010     $self->ncancelled_pkgs;
4011
4012 }
4013
4014 # Return a list of latitude/longitude for one of the services (if any)
4015 sub service_coordinates {
4016   my $self = shift;
4017
4018   my @svc_X =
4019     grep { $_->latitude && $_->longitude }
4020     map { $_->svc_x }
4021     map { $_->cust_svc }
4022     $self->ncancelled_pkgs;
4023
4024   scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4025 }
4026
4027 =item masked FIELD
4028
4029 Returns a masked version of the named field
4030
4031 =cut
4032
4033 sub masked {
4034 my ($self,$field) = @_;
4035
4036 # Show last four
4037
4038 'x'x(length($self->getfield($field))-4).
4039   substr($self->getfield($field), (length($self->getfield($field))-4));
4040
4041 }
4042
4043 =back
4044
4045 =head1 CLASS METHODS
4046
4047 =over 4
4048
4049 =item statuses
4050
4051 Class method that returns the list of possible status strings for customers
4052 (see L<the status method|/status>).  For example:
4053
4054   @statuses = FS::cust_main->statuses();
4055
4056 =cut
4057
4058 sub statuses {
4059   my $self = shift;
4060   keys %{ $self->statuscolors };
4061 }
4062
4063 =item cust_status_sql
4064
4065 Returns an SQL fragment to determine the status of a cust_main record, as a
4066 string.
4067
4068 =cut
4069
4070 sub cust_status_sql {
4071   my $sql = 'CASE';
4072   for my $status ( FS::cust_main->statuses() ) {
4073     my $method = $status.'_sql';
4074     $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4075   }
4076   $sql .= ' END';
4077   return $sql;
4078 }
4079
4080
4081 =item prospect_sql
4082
4083 Returns an SQL expression identifying prospective cust_main records (customers
4084 with no packages ever ordered)
4085
4086 =cut
4087
4088 use vars qw($select_count_pkgs);
4089 $select_count_pkgs =
4090   "SELECT COUNT(*) FROM cust_pkg
4091     WHERE cust_pkg.custnum = cust_main.custnum";
4092
4093 sub select_count_pkgs_sql {
4094   $select_count_pkgs;
4095 }
4096
4097 sub prospect_sql {
4098   " 0 = ( $select_count_pkgs ) ";
4099 }
4100
4101 =item ordered_sql
4102
4103 Returns an SQL expression identifying ordered cust_main records (customers with
4104 no active packages, but recurring packages not yet setup or one time charges
4105 not yet billed).
4106
4107 =cut
4108
4109 sub ordered_sql {
4110   FS::cust_main->none_active_sql.
4111   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4112 }
4113
4114 =item active_sql
4115
4116 Returns an SQL expression identifying active cust_main records (customers with
4117 active recurring packages).
4118
4119 =cut
4120
4121 sub active_sql {
4122   " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4123 }
4124
4125 =item none_active_sql
4126
4127 Returns an SQL expression identifying cust_main records with no active
4128 recurring packages.  This includes customers of status prospect, ordered,
4129 inactive, and suspended.
4130
4131 =cut
4132
4133 sub none_active_sql {
4134   " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4135 }
4136
4137 =item inactive_sql
4138
4139 Returns an SQL expression identifying inactive cust_main records (customers with
4140 no active recurring packages, but otherwise unsuspended/uncancelled).
4141
4142 =cut
4143
4144 sub inactive_sql {
4145   FS::cust_main->none_active_sql.
4146   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4147 }
4148
4149 =item susp_sql
4150 =item suspended_sql
4151
4152 Returns an SQL expression identifying suspended cust_main records.
4153
4154 =cut
4155
4156
4157 sub suspended_sql { susp_sql(@_); }
4158 sub susp_sql {
4159   FS::cust_main->none_active_sql.
4160   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4161 }
4162
4163 =item cancel_sql
4164 =item cancelled_sql
4165
4166 Returns an SQL expression identifying cancelled cust_main records.
4167
4168 =cut
4169
4170 sub cancel_sql { shift->cancelled_sql(@_); }
4171
4172 =item uncancel_sql
4173 =item uncancelled_sql
4174
4175 Returns an SQL expression identifying un-cancelled cust_main records.
4176
4177 =cut
4178
4179 sub uncancelled_sql { uncancel_sql(@_); }
4180 sub uncancel_sql { "
4181   ( 0 < ( $select_count_pkgs
4182                    AND ( cust_pkg.cancel IS NULL
4183                          OR cust_pkg.cancel = 0
4184                        )
4185         )
4186     OR 0 = ( $select_count_pkgs )
4187   )
4188 "; }
4189
4190 =item balance_sql
4191
4192 Returns an SQL fragment to retreive the balance.
4193
4194 =cut
4195
4196 sub balance_sql { "
4197     ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4198         WHERE cust_bill.custnum   = cust_main.custnum     )
4199   - ( SELECT COALESCE( SUM(paid),    0 ) FROM cust_pay
4200         WHERE cust_pay.custnum    = cust_main.custnum     )
4201   - ( SELECT COALESCE( SUM(amount),  0 ) FROM cust_credit
4202         WHERE cust_credit.custnum = cust_main.custnum     )
4203   + ( SELECT COALESCE( SUM(refund),  0 ) FROM cust_refund
4204         WHERE cust_refund.custnum = cust_main.custnum     )
4205 "; }
4206
4207 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4208
4209 Returns an SQL fragment to retreive the balance for this customer, optionally
4210 considering invoices with date earlier than START_TIME, and not
4211 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4212 total_unapplied_payments).
4213
4214 Times are specified as SQL fragments or numeric
4215 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
4216 L<Date::Parse> for conversion functions.  The empty string can be passed
4217 to disable that time constraint completely.
4218
4219 Available options are:
4220
4221 =over 4
4222
4223 =item unapplied_date
4224
4225 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)
4226
4227 =item total
4228
4229 (unused.  obsolete?)
4230 set to true to remove all customer comparison clauses, for totals
4231
4232 =item where
4233
4234 (unused.  obsolete?)
4235 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4236
4237 =item join
4238
4239 (unused.  obsolete?)
4240 JOIN clause (typically used with the total option)
4241
4242 =item cutoff
4243
4244 An absolute cutoff time.  Payments, credits, and refunds I<applied> after this
4245 time will be ignored.  Note that START_TIME and END_TIME only limit the date
4246 range for invoices and I<unapplied> payments, credits, and refunds.
4247
4248 =back
4249
4250 =cut
4251
4252 sub balance_date_sql {
4253   my( $class, $start, $end, %opt ) = @_;
4254
4255   my $cutoff = $opt{'cutoff'};
4256
4257   my $owed         = FS::cust_bill->owed_sql($cutoff);
4258   my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4259   my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4260   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
4261
4262   my $j = $opt{'join'} || '';
4263
4264   my $owed_wh   = $class->_money_table_where( 'cust_bill',   $start,$end,%opt );
4265   my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4266   my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4267   my $pay_wh    = $class->_money_table_where( 'cust_pay',    $start,$end,%opt );
4268
4269   "   ( SELECT COALESCE(SUM($owed),         0) FROM cust_bill   $j $owed_wh   )
4270     + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4271     - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4272     - ( SELECT COALESCE(SUM($unapp_pay),    0) FROM cust_pay    $j $pay_wh    )
4273   ";
4274
4275 }
4276
4277 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4278
4279 Returns an SQL fragment to retreive the total unapplied payments for this
4280 customer, only considering payments with date earlier than START_TIME, and
4281 optionally not later than END_TIME.
4282
4283 Times are specified as SQL fragments or numeric
4284 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
4285 L<Date::Parse> for conversion functions.  The empty string can be passed
4286 to disable that time constraint completely.
4287
4288 Available options are:
4289
4290 =cut
4291
4292 sub unapplied_payments_date_sql {
4293   my( $class, $start, $end, %opt ) = @_;
4294
4295   my $cutoff = $opt{'cutoff'};
4296
4297   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
4298
4299   my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4300                                                           'unapplied_date'=>1 );
4301
4302   " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4303 }
4304
4305 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4306
4307 Helper method for balance_date_sql; name (and usage) subject to change
4308 (suggestions welcome).
4309
4310 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4311 cust_refund, cust_credit or cust_pay).
4312
4313 If TABLE is "cust_bill" or the unapplied_date option is true, only
4314 considers records with date earlier than START_TIME, and optionally not
4315 later than END_TIME .
4316
4317 =cut
4318
4319 sub _money_table_where {
4320   my( $class, $table, $start, $end, %opt ) = @_;
4321
4322   my @where = ();
4323   push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4324   if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4325     push @where, "$table._date <= $start" if defined($start) && length($start);
4326     push @where, "$table._date >  $end"   if defined($end)   && length($end);
4327   }
4328   push @where, @{$opt{'where'}} if $opt{'where'};
4329   my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4330
4331   $where;
4332
4333 }
4334
4335 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4336 use FS::cust_main::Search;
4337 sub search {
4338   my $class = shift;
4339   FS::cust_main::Search->search(@_);
4340 }
4341
4342 =back
4343
4344 =head1 SUBROUTINES
4345
4346 =over 4
4347
4348 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
4349
4350 =cut
4351
4352 use FS::cust_main::Search;
4353 sub append_fuzzyfiles {
4354   #my( $first, $last, $company ) = @_;
4355
4356   FS::cust_main::Search::check_and_rebuild_fuzzyfiles();
4357
4358   use Fcntl qw(:flock);
4359
4360   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
4361
4362   foreach my $field (@fuzzyfields) {
4363     my $value = shift;
4364
4365     if ( $value ) {
4366
4367       open(CACHE,">>$dir/cust_main.$field")
4368         or die "can't open $dir/cust_main.$field: $!";
4369       flock(CACHE,LOCK_EX)
4370         or die "can't lock $dir/cust_main.$field: $!";
4371
4372       print CACHE "$value\n";
4373
4374       flock(CACHE,LOCK_UN)
4375         or die "can't unlock $dir/cust_main.$field: $!";
4376       close CACHE;
4377     }
4378
4379   }
4380
4381   1;
4382 }
4383
4384 =item batch_charge
4385
4386 =cut
4387
4388 sub batch_charge {
4389   my $param = shift;
4390   #warn join('-',keys %$param);
4391   my $fh = $param->{filehandle};
4392   my $agentnum = $param->{agentnum};
4393   my $format = $param->{format};
4394
4395   my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4396
4397   my @fields;
4398   if ( $format eq 'simple' ) {
4399     @fields = qw( custnum agent_custid amount pkg );
4400   } else {
4401     die "unknown format $format";
4402   }
4403
4404   eval "use Text::CSV_XS;";
4405   die $@ if $@;
4406
4407   my $csv = new Text::CSV_XS;
4408   #warn $csv;
4409   #warn $fh;
4410
4411   my $imported = 0;
4412   #my $columns;
4413
4414   local $SIG{HUP} = 'IGNORE';
4415   local $SIG{INT} = 'IGNORE';
4416   local $SIG{QUIT} = 'IGNORE';
4417   local $SIG{TERM} = 'IGNORE';
4418   local $SIG{TSTP} = 'IGNORE';
4419   local $SIG{PIPE} = 'IGNORE';
4420
4421   my $oldAutoCommit = $FS::UID::AutoCommit;
4422   local $FS::UID::AutoCommit = 0;
4423   my $dbh = dbh;
4424
4425   #while ( $columns = $csv->getline($fh) ) {
4426   my $line;
4427   while ( defined($line=<$fh>) ) {
4428
4429     $csv->parse($line) or do {
4430       $dbh->rollback if $oldAutoCommit;
4431       return "can't parse: ". $csv->error_input();
4432     };
4433
4434     my @columns = $csv->fields();
4435     #warn join('-',@columns);
4436
4437     my %row = ();
4438     foreach my $field ( @fields ) {
4439       $row{$field} = shift @columns;
4440     }
4441
4442     if ( $row{custnum} && $row{agent_custid} ) {
4443       dbh->rollback if $oldAutoCommit;
4444       return "can't specify custnum with agent_custid $row{agent_custid}";
4445     }
4446
4447     my %hash = ();
4448     if ( $row{agent_custid} && $agentnum ) {
4449       %hash = ( 'agent_custid' => $row{agent_custid},
4450                 'agentnum'     => $agentnum,
4451               );
4452     }
4453
4454     if ( $row{custnum} ) {
4455       %hash = ( 'custnum' => $row{custnum} );
4456     }
4457
4458     unless ( scalar(keys %hash) ) {
4459       $dbh->rollback if $oldAutoCommit;
4460       return "can't find customer without custnum or agent_custid and agentnum";
4461     }
4462
4463     my $cust_main = qsearchs('cust_main', { %hash } );
4464     unless ( $cust_main ) {
4465       $dbh->rollback if $oldAutoCommit;
4466       my $custnum = $row{custnum} || $row{agent_custid};
4467       return "unknown custnum $custnum";
4468     }
4469
4470     if ( $row{'amount'} > 0 ) {
4471       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4472       if ( $error ) {
4473         $dbh->rollback if $oldAutoCommit;
4474         return $error;
4475       }
4476       $imported++;
4477     } elsif ( $row{'amount'} < 0 ) {
4478       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4479                                       $row{'pkg'}                         );
4480       if ( $error ) {
4481         $dbh->rollback if $oldAutoCommit;
4482         return $error;
4483       }
4484       $imported++;
4485     } else {
4486       #hmm?
4487     }
4488
4489   }
4490
4491   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4492
4493   return "Empty file!" unless $imported;
4494
4495   ''; #no error
4496
4497 }
4498
4499 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4500
4501 Deprecated.  Use event notification and message templates
4502 (L<FS::msg_template>) instead.
4503
4504 Sends a templated email notification to the customer (see L<Text::Template>).
4505
4506 OPTIONS is a hash and may include
4507
4508 I<from> - the email sender (default is invoice_from)
4509
4510 I<to> - comma-separated scalar or arrayref of recipients
4511    (default is invoicing_list)
4512
4513 I<subject> - The subject line of the sent email notification
4514    (default is "Notice from company_name")
4515
4516 I<extra_fields> - a hashref of name/value pairs which will be substituted
4517    into the template
4518
4519 The following variables are vavailable in the template.
4520
4521 I<$first> - the customer first name
4522 I<$last> - the customer last name
4523 I<$company> - the customer company
4524 I<$payby> - a description of the method of payment for the customer
4525             # would be nice to use FS::payby::shortname
4526 I<$payinfo> - the account information used to collect for this customer
4527 I<$expdate> - the expiration of the customer payment in seconds from epoch
4528
4529 =cut
4530
4531 sub notify {
4532   my ($self, $template, %options) = @_;
4533
4534   return unless $conf->exists($template);
4535
4536   my $from = $conf->config('invoice_from', $self->agentnum)
4537     if $conf->exists('invoice_from', $self->agentnum);
4538   $from = $options{from} if exists($options{from});
4539
4540   my $to = join(',', $self->invoicing_list_emailonly);
4541   $to = $options{to} if exists($options{to});
4542
4543   my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4544     if $conf->exists('company_name', $self->agentnum);
4545   $subject = $options{subject} if exists($options{subject});
4546
4547   my $notify_template = new Text::Template (TYPE => 'ARRAY',
4548                                             SOURCE => [ map "$_\n",
4549                                               $conf->config($template)]
4550                                            )
4551     or die "can't create new Text::Template object: Text::Template::ERROR";
4552   $notify_template->compile()
4553     or die "can't compile template: Text::Template::ERROR";
4554
4555   $FS::notify_template::_template::company_name =
4556     $conf->config('company_name', $self->agentnum);
4557   $FS::notify_template::_template::company_address =
4558     join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4559
4560   my $paydate = $self->paydate || '2037-12-31';
4561   $FS::notify_template::_template::first = $self->first;
4562   $FS::notify_template::_template::last = $self->last;
4563   $FS::notify_template::_template::company = $self->company;
4564   $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4565   my $payby = $self->payby;
4566   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4567   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4568
4569   #credit cards expire at the end of the month/year of their exp date
4570   if ($payby eq 'CARD' || $payby eq 'DCRD') {
4571     $FS::notify_template::_template::payby = 'credit card';
4572     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4573     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4574     $expire_time--;
4575   }elsif ($payby eq 'COMP') {
4576     $FS::notify_template::_template::payby = 'complimentary account';
4577   }else{
4578     $FS::notify_template::_template::payby = 'current method';
4579   }
4580   $FS::notify_template::_template::expdate = $expire_time;
4581
4582   for (keys %{$options{extra_fields}}){
4583     no strict "refs";
4584     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4585   }
4586
4587   send_email(from => $from,
4588              to => $to,
4589              subject => $subject,
4590              body => $notify_template->fill_in( PACKAGE =>
4591                                                 'FS::notify_template::_template'                                              ),
4592             );
4593
4594 }
4595
4596 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4597
4598 Generates a templated notification to the customer (see L<Text::Template>).
4599
4600 OPTIONS is a hash and may include
4601
4602 I<extra_fields> - a hashref of name/value pairs which will be substituted
4603    into the template.  These values may override values mentioned below
4604    and those from the customer record.
4605
4606 The following variables are available in the template instead of or in addition
4607 to the fields of the customer record.
4608
4609 I<$payby> - a description of the method of payment for the customer
4610             # would be nice to use FS::payby::shortname
4611 I<$payinfo> - the masked account information used to collect for this customer
4612 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4613 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4614
4615 =cut
4616
4617 # a lot like cust_bill::print_latex
4618 sub generate_letter {
4619   my ($self, $template, %options) = @_;
4620
4621   return unless $conf->exists($template);
4622
4623   my $letter_template = new Text::Template
4624                         ( TYPE       => 'ARRAY',
4625                           SOURCE     => [ map "$_\n", $conf->config($template)],
4626                           DELIMITERS => [ '[@--', '--@]' ],
4627                         )
4628     or die "can't create new Text::Template object: Text::Template::ERROR";
4629
4630   $letter_template->compile()
4631     or die "can't compile template: Text::Template::ERROR";
4632
4633   my %letter_data = map { $_ => $self->$_ } $self->fields;
4634   $letter_data{payinfo} = $self->mask_payinfo;
4635
4636   #my $paydate = $self->paydate || '2037-12-31';
4637   my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4638
4639   my $payby = $self->payby;
4640   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4641   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4642
4643   #credit cards expire at the end of the month/year of their exp date
4644   if ($payby eq 'CARD' || $payby eq 'DCRD') {
4645     $letter_data{payby} = 'credit card';
4646     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4647     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4648     $expire_time--;
4649   }elsif ($payby eq 'COMP') {
4650     $letter_data{payby} = 'complimentary account';
4651   }else{
4652     $letter_data{payby} = 'current method';
4653   }
4654   $letter_data{expdate} = $expire_time;
4655
4656   for (keys %{$options{extra_fields}}){
4657     $letter_data{$_} = $options{extra_fields}->{$_};
4658   }
4659
4660   unless(exists($letter_data{returnaddress})){
4661     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4662                                                   $self->agent_template)
4663                      );
4664     if ( length($retadd) ) {
4665       $letter_data{returnaddress} = $retadd;
4666     } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4667       $letter_data{returnaddress} =
4668         join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4669                           s/$/\\\\\*/;
4670                           $_;
4671                         }
4672                     ( $conf->config('company_name', $self->agentnum),
4673                       $conf->config('company_address', $self->agentnum),
4674                     )
4675         );
4676     } else {
4677       $letter_data{returnaddress} = '~';
4678     }
4679   }
4680
4681   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4682
4683   $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4684
4685   my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4686
4687   my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4688                            DIR      => $dir,
4689                            SUFFIX   => '.eps',
4690                            UNLINK   => 0,
4691                          ) or die "can't open temp file: $!\n";
4692   print $lh $conf->config_binary('logo.eps', $self->agentnum)
4693     or die "can't write temp file: $!\n";
4694   close $lh;
4695   $letter_data{'logo_file'} = $lh->filename;
4696
4697   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4698                            DIR      => $dir,
4699                            SUFFIX   => '.tex',
4700                            UNLINK   => 0,
4701                          ) or die "can't open temp file: $!\n";
4702
4703   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4704   close $fh;
4705   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4706   return ($1, $letter_data{'logo_file'});
4707
4708 }
4709
4710 =item print_ps TEMPLATE
4711
4712 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4713
4714 =cut
4715
4716 sub print_ps {
4717   my $self = shift;
4718   my($file, $lfile) = $self->generate_letter(@_);
4719   my $ps = FS::Misc::generate_ps($file);
4720   unlink($file.'.tex');
4721   unlink($lfile);
4722
4723   $ps;
4724 }
4725
4726 =item print TEMPLATE
4727
4728 Prints the filled in template.
4729
4730 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4731
4732 =cut
4733
4734 sub queueable_print {
4735   my %opt = @_;
4736
4737   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4738     or die "invalid customer number: " . $opt{custvnum};
4739
4740   my $error = $self->print( $opt{template} );
4741   die $error if $error;
4742 }
4743
4744 sub print {
4745   my ($self, $template) = (shift, shift);
4746   do_print [ $self->print_ps($template) ];
4747 }
4748
4749 #these three subs should just go away once agent stuff is all config overrides
4750
4751 sub agent_template {
4752   my $self = shift;
4753   $self->_agent_plandata('agent_templatename');
4754 }
4755
4756 sub agent_invoice_from {
4757   my $self = shift;
4758   $self->_agent_plandata('agent_invoice_from');
4759 }
4760
4761 sub _agent_plandata {
4762   my( $self, $option ) = @_;
4763
4764   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
4765   #agent-specific Conf
4766
4767   use FS::part_event::Condition;
4768
4769   my $agentnum = $self->agentnum;
4770
4771   my $regexp = regexp_sql();
4772
4773   my $part_event_option =
4774     qsearchs({
4775       'select'    => 'part_event_option.*',
4776       'table'     => 'part_event_option',
4777       'addl_from' => q{
4778         LEFT JOIN part_event USING ( eventpart )
4779         LEFT JOIN part_event_option AS peo_agentnum
4780           ON ( part_event.eventpart = peo_agentnum.eventpart
4781                AND peo_agentnum.optionname = 'agentnum'
4782                AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4783              )
4784         LEFT JOIN part_event_condition
4785           ON ( part_event.eventpart = part_event_condition.eventpart
4786                AND part_event_condition.conditionname = 'cust_bill_age'
4787              )
4788         LEFT JOIN part_event_condition_option
4789           ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4790                AND part_event_condition_option.optionname = 'age'
4791              )
4792       },
4793       #'hashref'   => { 'optionname' => $option },
4794       #'hashref'   => { 'part_event_option.optionname' => $option },
4795       'extra_sql' =>
4796         " WHERE part_event_option.optionname = ". dbh->quote($option).
4797         " AND action = 'cust_bill_send_agent' ".
4798         " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4799         " AND peo_agentnum.optionname = 'agentnum' ".
4800         " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4801         " ORDER BY
4802            CASE WHEN part_event_condition_option.optionname IS NULL
4803            THEN -1
4804            ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4805         " END
4806           , part_event.weight".
4807         " LIMIT 1"
4808     });
4809
4810   unless ( $part_event_option ) {
4811     return $self->agent->invoice_template || ''
4812       if $option eq 'agent_templatename';
4813     return '';
4814   }
4815
4816   $part_event_option->optionvalue;
4817
4818 }
4819
4820 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4821
4822 Subroutine (not a method), designed to be called from the queue.
4823
4824 Takes a list of options and values.
4825
4826 Pulls up the customer record via the custnum option and calls bill_and_collect.
4827
4828 =cut
4829
4830 sub queued_bill {
4831   my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4832
4833   my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4834   warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4835
4836   $cust_main->bill_and_collect( %args );
4837 }
4838
4839 sub process_bill_and_collect {
4840   my $job = shift;
4841   my $param = thaw(decode_base64(shift));
4842   my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
4843       or die "custnum '$param->{custnum}' not found!\n";
4844   $param->{'job'}   = $job;
4845   $param->{'fatal'} = 1; # runs from job queue, will be caught
4846   $param->{'retry'} = 1;
4847
4848   $cust_main->bill_and_collect( %$param );
4849 }
4850
4851 sub _upgrade_data { #class method
4852   my ($class, %opts) = @_;
4853
4854   my @statements = (
4855     'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
4856     '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',
4857   );
4858   # fix yyyy-m-dd formatted paydates
4859   if ( driver_name =~ /^mysql$/i ) {
4860     push @statements,
4861     "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4862   }
4863   else { # the SQL standard
4864     push @statements,
4865     "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4866   }
4867
4868   foreach my $sql ( @statements ) {
4869     my $sth = dbh->prepare($sql) or die dbh->errstr;
4870     $sth->execute or die $sth->errstr;
4871   }
4872
4873   local($ignore_expired_card) = 1;
4874   local($ignore_illegal_zip) = 1;
4875   local($ignore_banned_card) = 1;
4876   local($skip_fuzzyfiles) = 1;
4877   $class->_upgrade_otaker(%opts);
4878
4879 }
4880
4881 =back
4882
4883 =head1 BUGS
4884
4885 The delete method.
4886
4887 The delete method should possibly take an FS::cust_main object reference
4888 instead of a scalar customer number.
4889
4890 Bill and collect options should probably be passed as references instead of a
4891 list.
4892
4893 There should probably be a configuration file with a list of allowed credit
4894 card types.
4895
4896 No multiple currency support (probably a larger project than just this module).
4897
4898 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
4899
4900 Birthdates rely on negative epoch values.
4901
4902 The payby for card/check batches is broken.  With mixed batching, bad
4903 things will happen.
4904
4905 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
4906
4907 =head1 SEE ALSO
4908
4909 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
4910 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
4911 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
4912
4913 =cut
4914
4915 1;
4916