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