FS/FS/cust_main.pm

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