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