suspend event option to skip packages with a start_date, RT#83847
[freeside.git] / FS / FS / cust_main.pm
1 package FS::cust_main;
2 use base qw( FS::cust_main::Packages
3              FS::cust_main::Status
4              FS::cust_main::NationalID
5              FS::cust_main::Billing
6              FS::cust_main::Billing_Realtime
7              FS::cust_main::Billing_Batch
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::cust_main::Merge
13              FS::cust_main::API
14              FS::otaker_Mixin FS::cust_main_Mixin
15              FS::geocode_Mixin FS::Quotable_Mixin FS::Sales_Mixin
16              FS::o2m_Common
17              FS::Record
18            );
19
20 require 5.006;
21 use strict;
22 use Carp;
23 use Try::Tiny;
24 use Scalar::Util qw( blessed );
25 use List::Util qw(min);
26 use Tie::IxHash;
27 use File::Temp; #qw( tempfile );
28 use Data::Dumper;
29 use Time::Local qw(timelocal);
30 use Date::Format;
31 #use Date::Manip;
32 use Email::Address;
33 use Business::CreditCard 0.28;
34 use FS::UID qw( dbh driver_name );
35 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
36 use FS::Cursor;
37 use FS::Misc qw( generate_ps do_print money_pretty card_types );
38 use FS::Msgcat qw(gettext);
39 use FS::CurrentUser;
40 use FS::TicketSystem;
41 use FS::payby;
42 use FS::cust_pkg;
43 use FS::cust_svc;
44 use FS::cust_bill;
45 use FS::cust_bill_void;
46 use FS::legacy_cust_bill;
47 use FS::cust_pay;
48 use FS::cust_pay_pending;
49 use FS::cust_pay_void;
50 use FS::cust_pay_batch;
51 use FS::cust_credit;
52 use FS::cust_refund;
53 use FS::part_referral;
54 use FS::cust_main_county;
55 use FS::cust_location;
56 use FS::cust_class;
57 use FS::tax_status;
58 use FS::cust_main_exemption;
59 use FS::cust_tax_adjustment;
60 use FS::cust_tax_location;
61 use FS::agent_currency;
62 use FS::cust_main_invoice;
63 use FS::cust_tag;
64 use FS::prepay_credit;
65 use FS::queue;
66 use FS::part_pkg;
67 use FS::part_export;
68 #use FS::cust_event;
69 use FS::type_pkgs;
70 use FS::payment_gateway;
71 use FS::agent_payment_gateway;
72 use FS::banned_pay;
73 use FS::cust_main_note;
74 use FS::cust_attachment;
75 use FS::cust_contact;
76 use FS::Locales;
77 use FS::upgrade_journal;
78 use FS::sales;
79 use FS::cust_payby;
80 use FS::contact;
81 use FS::reason;
82 use FS::Misc::Savepoint;
83 use FS::DBI;
84
85 # 1 is mostly method/subroutine entry and options
86 # 2 traces progress of some operations
87 # 3 is even more information including possibly sensitive data
88 our $DEBUG = 0;
89 our $me = '[FS::cust_main]';
90
91 our $import = 0;
92 our $ignore_expired_card = 0;
93 our $ignore_banned_card = 0;
94 our $ignore_invalid_card = 0;
95
96 our $skip_fuzzyfiles = 0;
97
98 our $ucfirst_nowarn = 0;
99
100 #this info is in cust_payby as of 4.x
101 #this and the fields themselves can be removed in 5.x
102 our @encrypted_fields = ('payinfo', 'paycvv');
103 sub nohistory_fields { ('payinfo', 'paycvv'); }
104
105 our $conf;
106 our $default_agent_custid;
107 our $custnum_display_length;
108 #ask FS::UID to run this stuff for us later
109 #$FS::UID::callback{'FS::cust_main'} = sub { 
110 install_callback FS::UID sub { 
111   $conf = new FS::Conf;
112   $ignore_invalid_card    = $conf->exists('allow_invalid_cards');
113   $default_agent_custid   = $conf->exists('cust_main-default_agent_custid');
114   $custnum_display_length = $conf->config('cust_main-custnum-display_length');
115 };
116
117 sub _cache {
118   my $self = shift;
119   my ( $hashref, $cache ) = @_;
120   if ( exists $hashref->{'pkgnum'} ) {
121     #@{ $self->{'_pkgnum'} } = ();
122     my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
123     $self->{'_pkgnum'} = $subcache;
124     #push @{ $self->{'_pkgnum'} },
125     FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
126   }
127 }
128
129 =head1 NAME
130
131 FS::cust_main - Object methods for cust_main records
132
133 =head1 SYNOPSIS
134
135   use FS::cust_main;
136
137   $record = new FS::cust_main \%hash;
138   $record = new FS::cust_main { 'column' => 'value' };
139
140   $error = $record->insert;
141
142   $error = $new_record->replace($old_record);
143
144   $error = $record->delete;
145
146   $error = $record->check;
147
148   @cust_pkg = $record->all_pkgs;
149
150   @cust_pkg = $record->ncancelled_pkgs;
151
152   @cust_pkg = $record->suspended_pkgs;
153
154   $error = $record->bill;
155   $error = $record->bill %options;
156   $error = $record->bill 'time' => $time;
157
158   $error = $record->collect;
159   $error = $record->collect %options;
160   $error = $record->collect 'invoice_time'   => $time,
161                           ;
162
163 =head1 DESCRIPTION
164
165 An FS::cust_main object represents a customer.  FS::cust_main inherits from 
166 FS::Record.  The following fields are currently supported:
167
168 =over 4
169
170 =item custnum
171
172 Primary key (assigned automatically for new customers)
173
174 =item agentnum
175
176 Agent (see L<FS::agent>)
177
178 =item refnum
179
180 Advertising source (see L<FS::part_referral>)
181
182 =item first
183
184 First name
185
186 =item last
187
188 Last name
189
190 =item ss
191
192 Cocial security number (optional)
193
194 =item company
195
196 (optional)
197
198 =item daytime
199
200 phone (optional)
201
202 =item night
203
204 phone (optional)
205
206 =item fax
207
208 phone (optional)
209
210 =item mobile
211
212 phone (optional)
213
214 =item payby
215
216 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
217
218 =item payinfo
219
220 Payment Information (See L<FS::payinfo_Mixin> for data format)
221
222 =item paymask
223
224 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
225
226 =item paycvv
227
228 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
229
230 =item paydate
231
232 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
233
234 =item paystart_month
235
236 Start date month (maestro/solo cards only)
237
238 =item paystart_year
239
240 Start date year (maestro/solo cards only)
241
242 =item payissue
243
244 Issue number (maestro/solo cards only)
245
246 =item payname
247
248 Name on card or billing name
249
250 =item payip
251
252 IP address from which payment information was received
253
254 =item tax
255
256 Tax exempt, empty or `Y'
257
258 =item usernum
259
260 Order taker (see L<FS::access_user>)
261
262 =item comments
263
264 Comments (optional)
265
266 =item referral_custnum
267
268 Referring customer number
269
270 =item spool_cdr
271
272 Enable individual CDR spooling, empty or `Y'
273
274 =item dundate
275
276 A suggestion to events (see L<FS::part_bill_event>) to delay until this unix timestamp
277
278 =item squelch_cdr
279
280 Discourage individual CDR printing, empty or `Y'
281
282 =item edit_subject
283
284 Allow self-service editing of ticket subjects, empty or 'Y'
285
286 =item calling_list_exempt
287
288 Do not call, empty or 'Y'
289
290 =item invoice_ship_address
291
292 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
293
294 =back
295
296 =head1 METHODS
297
298 =over 4
299
300 =item new HASHREF
301
302 Creates a new customer.  To add the customer to the database, see L<"insert">.
303
304 Note that this stores the hash reference, not a distinct copy of the hash it
305 points to.  You can ask the object for a copy with the I<hash> method.
306
307 =cut
308
309 sub table { 'cust_main'; }
310
311 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
312
313 Adds this customer to the database.  If there is an error, returns the error,
314 otherwise returns false.
315
316 Usually the customer's location will not yet exist in the database, and
317 the C<bill_location> and C<ship_location> pseudo-fields must be set to 
318 uninserted L<FS::cust_location> objects.  These will be inserted and linked
319 (in both directions) to the new customer record.  If they're references 
320 to the same object, they will become the same location.
321
322 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
323 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
324 are inserted atomicly, or the transaction is rolled back.  Passing an empty
325 hash reference is equivalent to not supplying this parameter.  There should be
326 a better explanation of this, but until then, here's an example:
327
328   use Tie::RefHash;
329   tie %hash, 'Tie::RefHash'; #this part is important
330   %hash = (
331     $cust_pkg => [ $svc_acct ],
332     ...
333   );
334   $cust_main->insert( \%hash );
335
336 INVOICING_LIST_ARYREF: No longer supported.
337
338 Currently available options are: I<depend_jobnum>, I<noexport>,
339 I<tax_exemption>, I<prospectnum>, I<contact> and I<contact_params>.
340
341 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
342 on the supplied jobnum (they will not run until the specific job completes).
343 This can be used to defer provisioning until some action completes (such
344 as running the customer's credit card successfully).
345
346 The I<noexport> option is deprecated.  If I<noexport> is set true, no
347 provisioning jobs (exports) are scheduled.  (You can schedule them later with
348 the B<reexport> method.)
349
350 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
351 of tax names and exemption numbers.  FS::cust_main_exemption records will be
352 created and inserted.
353
354 If I<prospectnum> is set, moves contacts and locations from that prospect.
355
356 If I<contact> is set to an arrayref of FS::contact objects, those will be
357 inserted.
358
359 If I<contact_params> is set to a hashref of CGI parameters (and I<contact> is
360 unset), inserts those new contacts with this new customer.  Handles CGI
361 paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
362
363 If I<cust_payby_params> is set to a hashref o fCGI parameters, inserts those
364 new stored payment records with this new customer.  Handles CGI parameters
365 for an "m2" multiple entry field as passed by edit/cust_main.cgi
366
367 =cut
368
369 sub insert {
370   my $self = shift;
371   my $cust_pkgs = @_ ? shift : {};
372   my $invoicing_list;
373   if ( $_[0] and ref($_[0]) eq 'ARRAY' ) {
374     warn "cust_main::insert using deprecated invoicing list argument";
375     $invoicing_list = shift;
376   }
377   my %options = @_;
378   warn "$me insert called with options ".
379        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
380     if $DEBUG;
381
382   return "You are not permitted to change customer invoicing terms."
383     if $self->invoice_terms #i.e. not the default
384     && ! $FS::CurrentUser::CurrentUser->access_right('Edit customer invoice terms');
385
386   local $SIG{HUP} = 'IGNORE';
387   local $SIG{INT} = 'IGNORE';
388   local $SIG{QUIT} = 'IGNORE';
389   local $SIG{TERM} = 'IGNORE';
390   local $SIG{TSTP} = 'IGNORE';
391   local $SIG{PIPE} = 'IGNORE';
392
393   my $oldAutoCommit = $FS::UID::AutoCommit;
394   local $FS::UID::AutoCommit = 0;
395   my $dbh = dbh;
396
397   my $prepay_identifier = '';
398   my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
399   my $payby = '';
400   if ( $self->payby eq 'PREPAY' ) {
401
402     $self->payby(''); #'BILL');
403     $prepay_identifier = $self->payinfo;
404     $self->payinfo('');
405
406     warn "  looking up prepaid card $prepay_identifier\n"
407       if $DEBUG > 1;
408
409     my $error = $self->get_prepay( $prepay_identifier,
410                                    'amount_ref'     => \$amount,
411                                    'seconds_ref'    => \$seconds,
412                                    'upbytes_ref'    => \$upbytes,
413                                    'downbytes_ref'  => \$downbytes,
414                                    'totalbytes_ref' => \$totalbytes,
415                                  );
416     if ( $error ) {
417       $dbh->rollback if $oldAutoCommit;
418       #return "error applying prepaid card (transaction rolled back): $error";
419       return $error;
420     }
421
422     $payby = 'PREP' if $amount;
423
424   } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
425
426     $payby = $1;
427     $self->payby(''); #'BILL');
428     $amount = $self->paid;
429
430   }
431
432   # insert locations
433   foreach my $l (qw(bill_location ship_location)) {
434
435     my $loc = delete $self->hashref->{$l} or next;
436
437     if ( !$loc->locationnum ) {
438       # warn the location that we're going to insert it with no custnum
439       $loc->set(custnum_pending => 1);
440       warn "  inserting $l\n"
441         if $DEBUG > 1;
442       my $error = $loc->insert;
443       if ( $error ) {
444         $dbh->rollback if $oldAutoCommit;
445         my $label = $l eq 'ship_location' ? 'service' : 'billing';
446         return "$error (in $label location)";
447       }
448
449     } elsif ( $loc->prospectnum ) {
450
451       $loc->prospectnum('');
452       $loc->set(custnum_pending => 1);
453       my $error = $loc->replace;
454       if ( $error ) {
455         $dbh->rollback if $oldAutoCommit;
456         my $label = $l eq 'ship_location' ? 'service' : 'billing';
457         return "$error (moving $label location)";
458       }
459
460     } elsif ( ($loc->custnum || 0) > 0 ) {
461       # then it somehow belongs to another customer--shouldn't happen
462       $dbh->rollback if $oldAutoCommit;
463       return "$l belongs to customer ".$loc->custnum;
464     }
465     # else it already belongs to this customer 
466     # (happens when ship_location is identical to bill_location)
467
468     $self->set($l.'num', $loc->locationnum);
469
470     if ( $self->get($l.'num') eq '' ) {
471       $dbh->rollback if $oldAutoCommit;
472       return "$l not set";
473     }
474   }
475
476   warn "  inserting $self\n"
477     if $DEBUG > 1;
478
479   $self->signupdate(time) unless $self->signupdate;
480
481   $self->auto_agent_custid()
482     if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
483
484   my $error =  $self->check_payinfo_cardtype
485             || $self->SUPER::insert;
486   if ( $error ) {
487     $dbh->rollback if $oldAutoCommit;
488     #return "inserting cust_main record (transaction rolled back): $error";
489     return $error;
490   }
491
492   # now set cust_location.custnum
493   foreach my $l (qw(bill_location ship_location)) {
494     warn "  setting $l.custnum\n"
495       if $DEBUG > 1;
496     my $loc = $self->$l or next;
497     unless ( $loc->custnum ) {
498       $loc->set(custnum => $self->custnum);
499       $error ||= $loc->replace;
500     }
501
502     if ( $error ) {
503       $dbh->rollback if $oldAutoCommit;
504       return "error setting $l custnum: $error";
505     }
506   }
507
508   warn "  setting customer tags\n"
509     if $DEBUG > 1;
510
511   foreach my $tagnum ( @{ $self->tagnum || [] } ) {
512     my $cust_tag = new FS::cust_tag { 'tagnum'  => $tagnum,
513                                       'custnum' => $self->custnum };
514     my $error = $cust_tag->insert;
515     if ( $error ) {
516       $dbh->rollback if $oldAutoCommit;
517       return $error;
518     }
519   }
520
521   my $prospectnum = delete $options{'prospectnum'};
522   if ( $prospectnum ) {
523
524     warn "  moving contacts and locations from prospect $prospectnum\n"
525       if $DEBUG > 1;
526
527     my $prospect_main =
528       qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
529     unless ( $prospect_main ) {
530       $dbh->rollback if $oldAutoCommit;
531       return "Unknown prospectnum $prospectnum";
532     }
533     $prospect_main->custnum($self->custnum);
534     $prospect_main->disabled('Y');
535     my $error = $prospect_main->replace;
536     if ( $error ) {
537       $dbh->rollback if $oldAutoCommit;
538       return $error;
539     }
540
541     foreach my $prospect_contact ( $prospect_main->prospect_contact ) {
542       my $cust_contact = new FS::cust_contact {
543         'custnum' => $self->custnum,
544         'invoice_dest' => 'Y', # invoice_dest currently not set for prospect contacts
545         map { $_ => $prospect_contact->$_() } qw( contactnum classnum comment )
546       };
547       my $error =  $cust_contact->insert
548                 || $prospect_contact->delete;
549       if ( $error ) {
550         $dbh->rollback if $oldAutoCommit;
551         return $error;
552       }
553     }
554
555     my @cust_location = $prospect_main->cust_location;
556     my @qual = $prospect_main->qual;
557
558     foreach my $r ( @cust_location, @qual ) {
559       $r->prospectnum('');
560       $r->custnum($self->custnum);
561       my $error = $r->replace;
562       if ( $error ) {
563         $dbh->rollback if $oldAutoCommit;
564         return $error;
565       }
566     }
567     # since we set invoice_dest on all migrated prospect contacts (for now),
568     # don't process invoicing_list.
569     delete $options{'invoicing_list'};
570     $invoicing_list = undef;
571   }
572
573   warn "  setting contacts\n"
574     if $DEBUG > 1;
575
576   $invoicing_list ||= $options{'invoicing_list'};
577   if ( $invoicing_list ) {
578
579     $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
580
581     my $email = '';
582     foreach my $dest (@$invoicing_list ) {
583       if ($dest eq 'POST') {
584         $self->set('postal_invoice', 'Y');
585       } else {
586
587         my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
588         if ( $contact_email ) {
589           my $cust_contact = FS::cust_contact->new({
590               contactnum    => $contact_email->contactnum,
591               custnum       => $self->custnum,
592           });
593           $cust_contact->set('invoice_dest', 'Y');
594           my $error = $cust_contact->insert;
595           if ( $error ) {
596             $dbh->rollback if $oldAutoCommit;
597             return "$error (linking to email address $dest)";
598           }
599
600         } else {
601           # this email address is not yet linked to any contact
602           $email .= ',' if length($email);
603           $email .= $dest;
604         }
605       }
606     }
607
608     if ( $email ) {
609
610       my $contact = FS::contact->new({
611         'custnum'       => $self->get('custnum'),
612         'last'          => $self->get('last'),
613         'first'         => $self->get('first'),
614         'emailaddress'  => $email,
615         'invoice_dest'  => 'Y', # yes, you can set this via the contact
616       });
617       my $error = $contact->insert;
618       if ( $error ) {
619         $dbh->rollback if $oldAutoCommit;
620         return $error;
621       }
622
623     }
624
625   }
626
627   if ( my $contact = delete $options{'contact'} ) {
628
629     foreach my $c ( @$contact ) {
630       $c->custnum($self->custnum);
631       my $error = $c->insert;
632       if ( $error ) {
633         $dbh->rollback if $oldAutoCommit;
634         return $error;
635       }
636
637     }
638
639   } elsif ( my $contact_params = delete $options{'contact_params'} ) {
640
641     my $error = $self->process_o2m( 'table'  => 'contact',
642                                     'fields' => FS::contact->cgi_contact_fields,
643                                     'params' => $contact_params,
644                                   );
645     if ( $error ) {
646       $dbh->rollback if $oldAutoCommit;
647       return $error;
648     }
649   }
650
651   warn "  setting cust_payby\n"
652     if $DEBUG > 1;
653
654   if ( $options{cust_payby} ) {
655
656     foreach my $cust_payby ( @{ $options{cust_payby} } ) {
657       $cust_payby->custnum($self->custnum);
658       my $error = $cust_payby->insert;
659       if ( $error ) {
660         $dbh->rollback if $oldAutoCommit;
661         return $error;
662       }
663     }
664
665   } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
666
667     my $error = $self->process_o2m(
668       'table'         => 'cust_payby',
669       'fields'        => FS::cust_payby->cgi_cust_payby_fields,
670       'params'        => $cust_payby_params,
671       'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
672     );
673     if ( $error ) {
674       $dbh->rollback if $oldAutoCommit;
675       return $error;
676     }
677
678   }
679
680   warn "  setting cust_main_exemption\n"
681     if $DEBUG > 1;
682
683   my $tax_exemption = delete $options{'tax_exemption'};
684   if ( $tax_exemption ) {
685
686     $tax_exemption = { map { $_ => '' } @$tax_exemption }
687       if ref($tax_exemption) eq 'ARRAY';
688
689     foreach my $taxname ( keys %$tax_exemption ) {
690       my $cust_main_exemption = new FS::cust_main_exemption {
691         'custnum'       => $self->custnum,
692         'taxname'       => $taxname,
693         'exempt_number' => $tax_exemption->{$taxname},
694       };
695       my $error = $cust_main_exemption->insert;
696       if ( $error ) {
697         $dbh->rollback if $oldAutoCommit;
698         return "inserting cust_main_exemption (transaction rolled back): $error";
699       }
700     }
701   }
702
703   warn "  ordering packages\n"
704     if $DEBUG > 1;
705
706   $error = $self->order_pkgs( $cust_pkgs,
707                               %options,
708                               'seconds_ref'    => \$seconds,
709                               'upbytes_ref'    => \$upbytes,
710                               'downbytes_ref'  => \$downbytes,
711                               'totalbytes_ref' => \$totalbytes,
712                             );
713   if ( $error ) {
714     $dbh->rollback if $oldAutoCommit;
715     return $error;
716   }
717
718   if ( $seconds ) {
719     $dbh->rollback if $oldAutoCommit;
720     return "No svc_acct record to apply pre-paid time";
721   }
722   if ( $upbytes || $downbytes || $totalbytes ) {
723     $dbh->rollback if $oldAutoCommit;
724     return "No svc_acct record to apply pre-paid data";
725   }
726
727   if ( $amount ) {
728     warn "  inserting initial $payby payment of $amount\n"
729       if $DEBUG > 1;
730     $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
731     if ( $error ) {
732       $dbh->rollback if $oldAutoCommit;
733       return "inserting payment (transaction rolled back): $error";
734     }
735   }
736
737   unless ( $import || $skip_fuzzyfiles ) {
738     warn "  queueing fuzzyfiles update\n"
739       if $DEBUG > 1;
740     $error = $self->queue_fuzzyfiles_update;
741     if ( $error ) {
742       $dbh->rollback if $oldAutoCommit;
743       return "updating fuzzy search cache: $error";
744     }
745   }
746
747   # cust_main exports!
748   warn "  exporting\n" if $DEBUG > 1;
749
750   my $export_args = $options{'export_args'} || [];
751
752   my @part_export =
753     map qsearch( 'part_export', {exportnum=>$_} ),
754       $conf->config('cust_main-exports'); #, $agentnum
755
756   foreach my $part_export ( @part_export ) {
757     my $error = $part_export->export_insert($self, @$export_args);
758     if ( $error ) {
759       $dbh->rollback if $oldAutoCommit;
760       return "exporting to ". $part_export->exporttype.
761              " (transaction rolled back): $error";
762     }
763   }
764
765   #foreach my $depend_jobnum ( @$depend_jobnums ) {
766   #    warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
767   #      if $DEBUG;
768   #    foreach my $jobnum ( @jobnums ) {
769   #      my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
770   #      warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
771   #        if $DEBUG;
772   #      my $error = $queue->depend_insert($depend_jobnum);
773   #      if ( $error ) {
774   #        $dbh->rollback if $oldAutoCommit;
775   #        return "error queuing job dependancy: $error";
776   #      }
777   #    }
778   #  }
779   #
780   #}
781   #
782   #if ( exists $options{'jobnums'} ) {
783   #  push @{ $options{'jobnums'} }, @jobnums;
784   #}
785
786   warn "  insert complete; committing transaction\n"
787     if $DEBUG > 1;
788
789   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
790   '';
791
792 }
793
794 use File::CounterFile;
795 sub auto_agent_custid {
796   my $self = shift;
797
798   my $format = $conf->config('cust_main-auto_agent_custid');
799   my $agent_custid;
800   if ( $format eq '1YMMXXXXXXXX' ) {
801
802     my $counter = new File::CounterFile 'cust_main.agent_custid';
803     $counter->lock;
804
805     my $ym = 100000000000 + time2str('%y%m00000000', time);
806     if ( $ym > $counter->value ) {
807       $counter->{'value'} = $agent_custid = $ym;
808       $counter->{'updated'} = 1;
809     } else {
810       $agent_custid = $counter->inc;
811     }
812
813     $counter->unlock;
814
815   } else {
816     die "Unknown cust_main-auto_agent_custid format: $format";
817   }
818
819   $self->agent_custid($agent_custid);
820
821 }
822
823 =item PACKAGE METHODS
824
825 Documentation on customer package methods has been moved to
826 L<FS::cust_main::Packages>.
827
828 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
829
830 Recharges this (existing) customer with the specified prepaid card (see
831 L<FS::prepay_credit>), specified either by I<identifier> or as an
832 FS::prepay_credit object.  If there is an error, returns the error, otherwise
833 returns false.
834
835 Optionally, five scalar references can be passed as well.  They will have their
836 values filled in with the amount, number of seconds, and number of upload,
837 download, and total bytes applied by this prepaid card.
838
839 =cut
840
841 #the ref bullshit here should be refactored like get_prepay.  MyAccount.pm is
842 #the only place that uses these args
843 sub recharge_prepay { 
844   my( $self, $prepay_credit, $amountref, $secondsref, 
845       $upbytesref, $downbytesref, $totalbytesref ) = @_;
846
847   local $SIG{HUP} = 'IGNORE';
848   local $SIG{INT} = 'IGNORE';
849   local $SIG{QUIT} = 'IGNORE';
850   local $SIG{TERM} = 'IGNORE';
851   local $SIG{TSTP} = 'IGNORE';
852   local $SIG{PIPE} = 'IGNORE';
853
854   my $oldAutoCommit = $FS::UID::AutoCommit;
855   local $FS::UID::AutoCommit = 0;
856   my $dbh = dbh;
857
858   my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
859
860   my $error = $self->get_prepay( $prepay_credit,
861                                  'amount_ref'     => \$amount,
862                                  'seconds_ref'    => \$seconds,
863                                  'upbytes_ref'    => \$upbytes,
864                                  'downbytes_ref'  => \$downbytes,
865                                  'totalbytes_ref' => \$totalbytes,
866                                )
867            || $self->increment_seconds($seconds)
868            || $self->increment_upbytes($upbytes)
869            || $self->increment_downbytes($downbytes)
870            || $self->increment_totalbytes($totalbytes)
871            || $self->insert_cust_pay_prepay( $amount,
872                                              ref($prepay_credit)
873                                                ? $prepay_credit->identifier
874                                                : $prepay_credit
875                                            );
876
877   if ( $error ) {
878     $dbh->rollback if $oldAutoCommit;
879     return $error;
880   }
881
882   if ( defined($amountref)  ) { $$amountref  = $amount;  }
883   if ( defined($secondsref) ) { $$secondsref = $seconds; }
884   if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
885   if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
886   if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
887
888   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
889   '';
890
891 }
892
893 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
894
895 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
896 specified either by I<identifier> or as an FS::prepay_credit object.
897
898 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
899 incremented by the values of the prepaid card.
900
901 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
902 check or set this customer's I<agentnum>.
903
904 If there is an error, returns the error, otherwise returns false.
905
906 =cut
907
908
909 sub get_prepay {
910   my( $self, $prepay_credit, %opt ) = @_;
911
912   local $SIG{HUP} = 'IGNORE';
913   local $SIG{INT} = 'IGNORE';
914   local $SIG{QUIT} = 'IGNORE';
915   local $SIG{TERM} = 'IGNORE';
916   local $SIG{TSTP} = 'IGNORE';
917   local $SIG{PIPE} = 'IGNORE';
918
919   my $oldAutoCommit = $FS::UID::AutoCommit;
920   local $FS::UID::AutoCommit = 0;
921   my $dbh = dbh;
922
923   unless ( ref($prepay_credit) ) {
924
925     my $identifier = $prepay_credit;
926
927     $prepay_credit = qsearchs(
928       'prepay_credit',
929       { 'identifier' => $identifier },
930       '',
931       'FOR UPDATE'
932     );
933
934     unless ( $prepay_credit ) {
935       $dbh->rollback if $oldAutoCommit;
936       return "Invalid prepaid card: ". $identifier;
937     }
938
939   }
940
941   if ( $prepay_credit->agentnum ) {
942     if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
943       $dbh->rollback if $oldAutoCommit;
944       return "prepaid card not valid for agent ". $self->agentnum;
945     }
946     $self->agentnum($prepay_credit->agentnum);
947   }
948
949   my $error = $prepay_credit->delete;
950   if ( $error ) {
951     $dbh->rollback if $oldAutoCommit;
952     return "removing prepay_credit (transaction rolled back): $error";
953   }
954
955   ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
956     for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
957
958   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
959   '';
960
961 }
962
963 =item increment_upbytes SECONDS
964
965 Updates this customer's single or primary account (see L<FS::svc_acct>) by
966 the specified number of upbytes.  If there is an error, returns the error,
967 otherwise returns false.
968
969 =cut
970
971 sub increment_upbytes {
972   _increment_column( shift, 'upbytes', @_);
973 }
974
975 =item increment_downbytes SECONDS
976
977 Updates this customer's single or primary account (see L<FS::svc_acct>) by
978 the specified number of downbytes.  If there is an error, returns the error,
979 otherwise returns false.
980
981 =cut
982
983 sub increment_downbytes {
984   _increment_column( shift, 'downbytes', @_);
985 }
986
987 =item increment_totalbytes SECONDS
988
989 Updates this customer's single or primary account (see L<FS::svc_acct>) by
990 the specified number of totalbytes.  If there is an error, returns the error,
991 otherwise returns false.
992
993 =cut
994
995 sub increment_totalbytes {
996   _increment_column( shift, 'totalbytes', @_);
997 }
998
999 =item increment_seconds SECONDS
1000
1001 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1002 the specified number of seconds.  If there is an error, returns the error,
1003 otherwise returns false.
1004
1005 =cut
1006
1007 sub increment_seconds {
1008   _increment_column( shift, 'seconds', @_);
1009 }
1010
1011 =item _increment_column AMOUNT
1012
1013 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1014 the specified number of seconds or bytes.  If there is an error, returns
1015 the error, otherwise returns false.
1016
1017 =cut
1018
1019 sub _increment_column {
1020   my( $self, $column, $amount ) = @_;
1021   warn "$me increment_column called: $column, $amount\n"
1022     if $DEBUG;
1023
1024   return '' unless $amount;
1025
1026   my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1027                       $self->ncancelled_pkgs;
1028
1029   if ( ! @cust_pkg ) {
1030     return 'No packages with primary or single services found'.
1031            ' to apply pre-paid time';
1032   } elsif ( scalar(@cust_pkg) > 1 ) {
1033     #maybe have a way to specify the package/account?
1034     return 'Multiple packages found to apply pre-paid time';
1035   }
1036
1037   my $cust_pkg = $cust_pkg[0];
1038   warn "  found package pkgnum ". $cust_pkg->pkgnum. "\n"
1039     if $DEBUG > 1;
1040
1041   my @cust_svc =
1042     $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1043
1044   if ( ! @cust_svc ) {
1045     return 'No account found to apply pre-paid time';
1046   } elsif ( scalar(@cust_svc) > 1 ) {
1047     return 'Multiple accounts found to apply pre-paid time';
1048   }
1049   
1050   my $svc_acct = $cust_svc[0]->svc_x;
1051   warn "  found service svcnum ". $svc_acct->pkgnum.
1052        ' ('. $svc_acct->email. ")\n"
1053     if $DEBUG > 1;
1054
1055   $column = "increment_$column";
1056   $svc_acct->$column($amount);
1057
1058 }
1059
1060 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1061
1062 Inserts a prepayment in the specified amount for this customer.  An optional
1063 second argument can specify the prepayment identifier for tracking purposes.
1064 If there is an error, returns the error, otherwise returns false.
1065
1066 =cut
1067
1068 sub insert_cust_pay_prepay {
1069   shift->insert_cust_pay('PREP', @_);
1070 }
1071
1072 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1073
1074 Inserts a cash payment in the specified amount for this customer.  An optional
1075 second argument can specify the payment identifier for tracking purposes.
1076 If there is an error, returns the error, otherwise returns false.
1077
1078 =cut
1079
1080 sub insert_cust_pay_cash {
1081   shift->insert_cust_pay('CASH', @_);
1082 }
1083
1084 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1085
1086 Inserts a Western Union payment in the specified amount for this customer.  An
1087 optional second argument can specify the prepayment identifier for tracking
1088 purposes.  If there is an error, returns the error, otherwise returns false.
1089
1090 =cut
1091
1092 sub insert_cust_pay_west {
1093   shift->insert_cust_pay('WEST', @_);
1094 }
1095
1096 sub insert_cust_pay {
1097   my( $self, $payby, $amount ) = splice(@_, 0, 3);
1098   my $payinfo = scalar(@_) ? shift : '';
1099
1100   my $cust_pay = new FS::cust_pay {
1101     'custnum' => $self->custnum,
1102     'paid'    => sprintf('%.2f', $amount),
1103     #'_date'   => #date the prepaid card was purchased???
1104     'payby'   => $payby,
1105     'payinfo' => $payinfo,
1106   };
1107   $cust_pay->insert;
1108
1109 }
1110
1111 =item delete [ OPTION => VALUE ... ]
1112
1113 This deletes the customer.  If there is an error, returns the error, otherwise
1114 returns false.
1115
1116 This will completely remove all traces of the customer record.  This is not
1117 what you want when a customer cancels service; for that, cancel all of the
1118 customer's packages (see L</cancel>).
1119
1120 If the customer has any uncancelled packages, you need to pass a new (valid)
1121 customer number for those packages to be transferred to, as the "new_customer"
1122 option.  Cancelled packages will be deleted.  Did I mention that this is NOT
1123 what you want when a customer cancels service and that you really should be
1124 looking at L<FS::cust_pkg/cancel>?  
1125
1126 You can't delete a customer with invoices (see L<FS::cust_bill>),
1127 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1128 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1129 set the "delete_financials" option to a true value.
1130
1131 =cut
1132
1133 sub delete {
1134   my( $self, %opt ) = @_;
1135
1136   local $SIG{HUP} = 'IGNORE';
1137   local $SIG{INT} = 'IGNORE';
1138   local $SIG{QUIT} = 'IGNORE';
1139   local $SIG{TERM} = 'IGNORE';
1140   local $SIG{TSTP} = 'IGNORE';
1141   local $SIG{PIPE} = 'IGNORE';
1142
1143   my $oldAutoCommit = $FS::UID::AutoCommit;
1144   local $FS::UID::AutoCommit = 0;
1145   my $dbh = dbh;
1146
1147   if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1148      $dbh->rollback if $oldAutoCommit;
1149      return "Can't delete a master agent customer";
1150   }
1151
1152   #use FS::access_user
1153   if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1154      $dbh->rollback if $oldAutoCommit;
1155      return "Can't delete a master employee customer";
1156   }
1157
1158   tie my %financial_tables, 'Tie::IxHash',
1159     'cust_bill'      => 'invoices',
1160     'cust_statement' => 'statements',
1161     'cust_credit'    => 'credits',
1162     'cust_pay'       => 'payments',
1163     'cust_refund'    => 'refunds',
1164   ;
1165    
1166   foreach my $table ( keys %financial_tables ) {
1167
1168     my @records = $self->$table();
1169
1170     if ( @records && ! $opt{'delete_financials'} ) {
1171       $dbh->rollback if $oldAutoCommit;
1172       return "Can't delete a customer with ". $financial_tables{$table};
1173     }
1174
1175     foreach my $record ( @records ) {
1176       my $error = $record->delete;
1177       if ( $error ) {
1178         $dbh->rollback if $oldAutoCommit;
1179         return "Error deleting ". $financial_tables{$table}. ": $error\n";
1180       }
1181     }
1182
1183   }
1184
1185   my @cust_pkg = $self->ncancelled_pkgs;
1186   if ( @cust_pkg ) {
1187     my $new_custnum = $opt{'new_custnum'};
1188     unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1189       $dbh->rollback if $oldAutoCommit;
1190       return "Invalid new customer number: $new_custnum";
1191     }
1192     foreach my $cust_pkg ( @cust_pkg ) {
1193       my %hash = $cust_pkg->hash;
1194       $hash{'custnum'} = $new_custnum;
1195       my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1196       my $error = $new_cust_pkg->replace($cust_pkg,
1197                                          options => { $cust_pkg->options },
1198                                         );
1199       if ( $error ) {
1200         $dbh->rollback if $oldAutoCommit;
1201         return $error;
1202       }
1203     }
1204   }
1205   my @cancelled_cust_pkg = $self->all_pkgs;
1206   foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1207     my $error = $cust_pkg->delete;
1208     if ( $error ) {
1209       $dbh->rollback if $oldAutoCommit;
1210       return $error;
1211     }
1212   }
1213
1214   #cust_tax_adjustment in financials?
1215   #cust_pay_pending?  ouch
1216   foreach my $table (qw(
1217     cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1218     cust_payby cust_location cust_main_note cust_tax_adjustment
1219     cust_pay_void cust_pay_batch queue cust_tax_exempt
1220   )) {
1221     foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1222       my $error = $record->delete;
1223       if ( $error ) {
1224         $dbh->rollback if $oldAutoCommit;
1225         return $error;
1226       }
1227     }
1228   }
1229
1230   my $sth = $dbh->prepare(
1231     'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1232   ) or do {
1233     my $errstr = $dbh->errstr;
1234     $dbh->rollback if $oldAutoCommit;
1235     return $errstr;
1236   };
1237   $sth->execute($self->custnum) or do {
1238     my $errstr = $sth->errstr;
1239     $dbh->rollback if $oldAutoCommit;
1240     return $errstr;
1241   };
1242
1243   #tickets
1244
1245   my $ticket_dbh = '';
1246   if ($conf->config('ticket_system') eq 'RT_Internal') {
1247     $ticket_dbh = $dbh;
1248   } elsif ($conf->config('ticket_system') eq 'RT_External') {
1249     my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1250     $ticket_dbh = FS::DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1251       #or die "RT_External DBI->connect error: $DBI::errstr\n";
1252   }
1253
1254   if ( $ticket_dbh ) {
1255
1256     my $ticket_sth = $ticket_dbh->prepare(
1257       'DELETE FROM Links WHERE Target = ?'
1258     ) or do {
1259       my $errstr = $ticket_dbh->errstr;
1260       $dbh->rollback if $oldAutoCommit;
1261       return $errstr;
1262     };
1263     $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1264       or do {
1265         my $errstr = $ticket_sth->errstr;
1266         $dbh->rollback if $oldAutoCommit;
1267         return $errstr;
1268       };
1269
1270     #check and see if the customer is the only link on the ticket, and
1271     #if so, set the ticket to deleted status in RT?
1272     #maybe someday, for now this will at least fix tickets not displaying
1273
1274   }
1275
1276   #delete the customer record
1277
1278   my $error = $self->SUPER::delete;
1279   if ( $error ) {
1280     $dbh->rollback if $oldAutoCommit;
1281     return $error;
1282   }
1283
1284   # cust_main exports!
1285
1286   #my $export_args = $options{'export_args'} || [];
1287
1288   my @part_export =
1289     map qsearch( 'part_export', {exportnum=>$_} ),
1290       $conf->config('cust_main-exports'); #, $agentnum
1291
1292   foreach my $part_export ( @part_export ) {
1293     my $error = $part_export->export_delete( $self ); #, @$export_args);
1294     if ( $error ) {
1295       $dbh->rollback if $oldAutoCommit;
1296       return "exporting to ". $part_export->exporttype.
1297              " (transaction rolled back): $error";
1298     }
1299   }
1300
1301   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1302   '';
1303
1304 }
1305
1306 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1307
1308 Replaces the OLD_RECORD with this one in the database.  If there is an error,
1309 returns the error, otherwise returns false.
1310
1311 To change the customer's address, set the pseudo-fields C<bill_location> and
1312 C<ship_location>.  The address will still only change if at least one of the
1313 address fields differs from the existing values.
1314
1315 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1316 set as the contact email address for a default contact with the same name as
1317 the customer.
1318
1319 Currently available options are: I<tax_exemption>, I<cust_payby_params>, 
1320 I<contact_params>, I<invoicing_list>, and I<move_pkgs>.
1321
1322 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1323 of tax names and exemption numbers.  FS::cust_main_exemption records will be
1324 deleted and inserted as appropriate.
1325
1326 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1327 groups (describing the customer's payment methods and contacts, respectively)
1328 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1329 and L<FS::contact> for the fields these can contain.
1330
1331 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1332 should be used instead if possible.
1333
1334 If I<move_pkgs> is an arrayref, it will override the list of packages
1335 to be moved to the new address (see L<FS::cust_location/move_pkgs>.)
1336
1337 =cut
1338
1339 sub replace {
1340   my $self = shift;
1341
1342   my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1343               ? shift
1344               : $self->replace_old;
1345
1346   my @param = @_;
1347
1348   warn "$me replace called\n"
1349     if $DEBUG;
1350
1351   my $curuser = $FS::CurrentUser::CurrentUser;
1352   return "You are not permitted to create complimentary accounts."
1353     if $self->complimentary eq 'Y'
1354     && $self->complimentary ne $old->complimentary
1355     && ! $curuser->access_right('Complimentary customer');
1356
1357   local($ignore_expired_card) = 1
1358     if $old->payby  =~ /^(CARD|DCRD)$/
1359     && $self->payby =~ /^(CARD|DCRD)$/
1360     && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1361
1362   local($ignore_banned_card) = 1
1363     if (    $old->payby  =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1364          || $old->payby  =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1365     && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1366
1367   if (    $self->payby =~ /^(CARD|DCRD)$/
1368        && $old->payinfo ne $self->payinfo
1369        && $old->paymask ne $self->paymask )
1370   {
1371     my $error = $self->check_payinfo_cardtype;
1372     return $error if $error;
1373   }
1374
1375   return "Invoicing locale is required"
1376     if $old->locale
1377     && ! $self->locale
1378     && $conf->exists('cust_main-require_locale');
1379
1380   return "You are not permitted to change customer invoicing terms."
1381     if $old->invoice_terms ne $self->invoice_terms
1382     && ! $curuser->access_right('Edit customer invoice terms');
1383
1384   local $SIG{HUP} = 'IGNORE';
1385   local $SIG{INT} = 'IGNORE';
1386   local $SIG{QUIT} = 'IGNORE';
1387   local $SIG{TERM} = 'IGNORE';
1388   local $SIG{TSTP} = 'IGNORE';
1389   local $SIG{PIPE} = 'IGNORE';
1390
1391   my $oldAutoCommit = $FS::UID::AutoCommit;
1392   local $FS::UID::AutoCommit = 0;
1393   my $dbh = dbh;
1394
1395   for my $l (qw(bill_location ship_location)) {
1396     #my $old_loc = $old->$l;
1397     my $new_loc = $self->$l or next;
1398
1399     # find the existing location if there is one
1400     $new_loc->set('custnum' => $self->custnum);
1401     my $error = $new_loc->find_or_insert;
1402     if ( $error ) {
1403       $dbh->rollback if $oldAutoCommit;
1404       return $error;
1405     }
1406     $self->set($l.'num', $new_loc->locationnum);
1407   } #for $l
1408
1409   my $invoicing_list;
1410   if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1411     warn "cust_main::replace: using deprecated invoicing list argument";
1412     $invoicing_list = shift @param;
1413   }
1414
1415   my %options = @param;
1416
1417   $invoicing_list ||= $options{invoicing_list};
1418
1419   my @contacts = map { $_->contact } $self->cust_contact;
1420   # find a contact that matches the customer's name
1421   my ($implicit_contact) = grep { $_->first eq $old->get('first')
1422                               and $_->last  eq $old->get('last') }
1423                             @contacts;
1424   $implicit_contact ||= FS::contact->new({
1425       'custnum'       => $self->custnum,
1426       'locationnum'   => $self->get('bill_locationnum'),
1427   });
1428
1429   # for any of these that are already contact emails, link to the existing
1430   # contact
1431   if ( $invoicing_list ) {
1432     my $email = '';
1433
1434     # kind of like process_m2m on these, except:
1435     # - the other side is two tables in a join
1436     # - and we might have to create new contact_emails
1437     # - and possibly a new contact
1438     # 
1439     # Find existing invoice emails that aren't on the implicit contact.
1440     # Any of these that are not on the new invoicing list will be removed.
1441     my %old_email_cust_contact;
1442     foreach my $cust_contact ($self->cust_contact) {
1443       next if !$cust_contact->invoice_dest;
1444       next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1445
1446       foreach my $contact_email ($cust_contact->contact->contact_email) {
1447         $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1448       }
1449     }
1450
1451     foreach my $dest (@$invoicing_list) {
1452
1453       if ($dest eq 'POST') {
1454
1455         $self->set('postal_invoice', 'Y');
1456
1457       } elsif ( exists($old_email_cust_contact{$dest}) ) {
1458
1459         delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1460
1461       } else {
1462
1463         # See if it belongs to some other contact; if so, link it.
1464         my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1465         if ( $contact_email
1466              and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1467           my $cust_contact = qsearchs('cust_contact', {
1468               contactnum  => $contact_email->contactnum,
1469               custnum     => $self->custnum,
1470           }) || FS::cust_contact->new({
1471               contactnum    => $contact_email->contactnum,
1472               custnum       => $self->custnum,
1473           });
1474           $cust_contact->set('invoice_dest', 'Y');
1475           my $error = $cust_contact->custcontactnum ?
1476                         $cust_contact->replace : $cust_contact->insert;
1477           if ( $error ) {
1478             $dbh->rollback if $oldAutoCommit;
1479             return "$error (linking to email address $dest)";
1480           }
1481
1482         } else {
1483           # This email address is not yet linked to any contact, so it will
1484           # be added to the implicit contact.
1485           $email .= ',' if length($email);
1486           $email .= $dest;
1487         }
1488       }
1489     }
1490
1491     foreach my $remove_dest (keys %old_email_cust_contact) {
1492       my $cust_contact = $old_email_cust_contact{$remove_dest};
1493       # These were not in the list of requested destinations, so take them off.
1494       $cust_contact->set('invoice_dest', '');
1495       my $error = $cust_contact->replace;
1496       if ( $error ) {
1497         $dbh->rollback if $oldAutoCommit;
1498         return "$error (unlinking email address $remove_dest)";
1499       }
1500     }
1501
1502     # make sure it keeps up with the changed customer name, if any
1503     $implicit_contact->set('last', $self->get('last'));
1504     $implicit_contact->set('first', $self->get('first'));
1505     $implicit_contact->set('emailaddress', $email);
1506     $implicit_contact->set('invoice_dest', 'Y');
1507     $implicit_contact->set('custnum', $self->custnum);
1508     my $i_cust_contact =
1509       qsearchs('cust_contact', {
1510                                  contactnum  => $implicit_contact->contactnum,
1511                                  custnum     => $self->custnum,
1512                                }
1513       );
1514     if ( $i_cust_contact ) {
1515       $implicit_contact->set($_, $i_cust_contact->$_)
1516         foreach qw( classnum selfservice_access comment );
1517     }
1518
1519     my $error;
1520     if ( $implicit_contact->contactnum ) {
1521       $error = $implicit_contact->replace;
1522     } elsif ( length($email) ) { # don't create a new contact if not needed
1523       $error = $implicit_contact->insert;
1524     }
1525
1526     if ( $error ) {
1527       $dbh->rollback if $oldAutoCommit;
1528       return "$error (adding email address $email)";
1529     }
1530
1531   }
1532
1533   # replace the customer record
1534   my $error = $self->SUPER::replace($old);
1535
1536   if ( $error ) {
1537     $dbh->rollback if $oldAutoCommit;
1538     return $error;
1539   }
1540
1541   # now move packages to the new service location
1542   $self->set('ship_location', ''); #flush cache
1543   if ( $old->ship_locationnum and # should only be null during upgrade...
1544        $old->ship_locationnum != $self->ship_locationnum ) {
1545     $error = $old->ship_location->move_to($self->ship_location, move_pkgs => $options{'move_pkgs'});
1546     if ( $error ) {
1547       $dbh->rollback if $oldAutoCommit;
1548       return $error;
1549     }
1550   }
1551   # don't move packages based on the billing location, but 
1552   # disable it if it's no longer in use
1553   if ( $old->bill_locationnum and
1554        $old->bill_locationnum != $self->bill_locationnum ) {
1555     $error = $old->bill_location->disable_if_unused;
1556     if ( $error ) {
1557       $dbh->rollback if $oldAutoCommit;
1558       return $error;
1559     }
1560   }
1561
1562   if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1563
1564     #this could be more efficient than deleting and re-inserting, if it matters
1565     foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1566       my $error = $cust_tag->delete;
1567       if ( $error ) {
1568         $dbh->rollback if $oldAutoCommit;
1569         return $error;
1570       }
1571     }
1572     foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1573       my $cust_tag = new FS::cust_tag { 'tagnum'  => $tagnum,
1574                                         'custnum' => $self->custnum };
1575       my $error = $cust_tag->insert;
1576       if ( $error ) {
1577         $dbh->rollback if $oldAutoCommit;
1578         return $error;
1579       }
1580     }
1581
1582   }
1583
1584   my $tax_exemption = delete $options{'tax_exemption'};
1585   if ( $tax_exemption ) {
1586
1587     $tax_exemption = { map { $_ => '' } @$tax_exemption }
1588       if ref($tax_exemption) eq 'ARRAY';
1589
1590     my %cust_main_exemption =
1591       map { $_->taxname => $_ }
1592           qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1593
1594     foreach my $taxname ( keys %$tax_exemption ) {
1595
1596       if ( $cust_main_exemption{$taxname} && 
1597            $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1598          )
1599       {
1600         delete $cust_main_exemption{$taxname};
1601         next;
1602       }
1603
1604       my $cust_main_exemption = new FS::cust_main_exemption {
1605         'custnum'       => $self->custnum,
1606         'taxname'       => $taxname,
1607         'exempt_number' => $tax_exemption->{$taxname},
1608       };
1609       my $error = $cust_main_exemption->insert;
1610       if ( $error ) {
1611         $dbh->rollback if $oldAutoCommit;
1612         return "inserting cust_main_exemption (transaction rolled back): $error";
1613       }
1614     }
1615
1616     foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1617       my $error = $cust_main_exemption->delete;
1618       if ( $error ) {
1619         $dbh->rollback if $oldAutoCommit;
1620         return "deleting cust_main_exemption (transaction rolled back): $error";
1621       }
1622     }
1623
1624   }
1625
1626   if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1627
1628     my $error = $self->process_o2m(
1629       'table'         => 'cust_payby',
1630       'fields'        => FS::cust_payby->cgi_cust_payby_fields,
1631       'params'        => $cust_payby_params,
1632       'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1633     );
1634     if ( $error ) {
1635       $dbh->rollback if $oldAutoCommit;
1636       return $error;
1637     }
1638
1639   }
1640
1641   if ( my $contact_params = delete $options{'contact_params'} ) {
1642
1643     # this can potentially replace contacts that were created by the
1644     # invoicing list argument, but the UI shouldn't allow both of them
1645     # to be specified
1646
1647     my $error = $self->process_o2m(
1648       'table'         => 'contact',
1649       'fields'        => FS::contact->cgi_contact_fields,
1650       'params'        => $contact_params,
1651     );
1652     if ( $error ) {
1653       $dbh->rollback if $oldAutoCommit;
1654       return $error;
1655     }
1656
1657   }
1658
1659   unless ( $import || $skip_fuzzyfiles ) {
1660     $error = $self->queue_fuzzyfiles_update;
1661     if ( $error ) {
1662       $dbh->rollback if $oldAutoCommit;
1663       return "updating fuzzy search cache: $error";
1664     }
1665   }
1666
1667   # tax district update in cust_location
1668
1669   # cust_main exports!
1670
1671   my $export_args = $options{'export_args'} || [];
1672
1673   my @part_export =
1674     map qsearch( 'part_export', {exportnum=>$_} ),
1675       $conf->config('cust_main-exports'); #, $agentnum
1676
1677   foreach my $part_export ( @part_export ) {
1678     my $error = $part_export->export_replace( $self, $old, @$export_args);
1679     if ( $error ) {
1680       $dbh->rollback if $oldAutoCommit;
1681       return "exporting to ". $part_export->exporttype.
1682              " (transaction rolled back): $error";
1683     }
1684   }
1685
1686   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1687   '';
1688
1689 }
1690
1691 =item queue_fuzzyfiles_update
1692
1693 Used by insert & replace to update the fuzzy search cache
1694
1695 =cut
1696
1697 use FS::cust_main::Search;
1698 sub queue_fuzzyfiles_update {
1699   my $self = shift;
1700
1701   local $SIG{HUP} = 'IGNORE';
1702   local $SIG{INT} = 'IGNORE';
1703   local $SIG{QUIT} = 'IGNORE';
1704   local $SIG{TERM} = 'IGNORE';
1705   local $SIG{TSTP} = 'IGNORE';
1706   local $SIG{PIPE} = 'IGNORE';
1707
1708   my $oldAutoCommit = $FS::UID::AutoCommit;
1709   local $FS::UID::AutoCommit = 0;
1710   my $dbh = dbh;
1711
1712   foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1713     my $queue = new FS::queue { 
1714       'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1715     };
1716     my @args = "cust_main.$field", $self->get($field);
1717     my $error = $queue->insert( @args );
1718     if ( $error ) {
1719       $dbh->rollback if $oldAutoCommit;
1720       return "queueing job (transaction rolled back): $error";
1721     }
1722   }
1723
1724   my @locations = ();
1725   push @locations, $self->bill_location if $self->bill_locationnum;
1726   push @locations, $self->ship_location if @locations && $self->has_ship_address;
1727   foreach my $location (@locations) {
1728     my $queue = new FS::queue { 
1729       'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1730     };
1731     my @args = 'cust_location.address1', $location->address1;
1732     my $error = $queue->insert( @args );
1733     if ( $error ) {
1734       $dbh->rollback if $oldAutoCommit;
1735       return "queueing job (transaction rolled back): $error";
1736     }
1737   }
1738
1739   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1740   '';
1741
1742 }
1743
1744 =item check
1745
1746 Checks all fields to make sure this is a valid customer record.  If there is
1747 an error, returns the error, otherwise returns false.  Called by the insert
1748 and replace methods.
1749
1750 =cut
1751
1752 sub check {
1753   my $self = shift;
1754
1755   warn "$me check BEFORE: \n". $self->_dump
1756     if $DEBUG > 2;
1757
1758   my $error =
1759     $self->ut_numbern('custnum')
1760     || $self->ut_number('agentnum')
1761     || $self->ut_textn('agent_custid')
1762     || $self->ut_number('refnum')
1763     || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1764     || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1765     || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1766     || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1767     || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1768     || $self->ut_textn('custbatch')
1769     || $self->ut_name('last')
1770     || $self->ut_name('first')
1771     || $self->ut_snumbern('signupdate')
1772     || $self->ut_snumbern('birthdate')
1773     || $self->ut_namen('spouse_last')
1774     || $self->ut_namen('spouse_first')
1775     || $self->ut_snumbern('spouse_birthdate')
1776     || $self->ut_snumbern('anniversary_date')
1777     || $self->ut_textn('company')
1778     || $self->ut_textn('ship_company')
1779     || $self->ut_anything('comments')
1780     || $self->ut_numbern('referral_custnum')
1781     || $self->ut_textn('stateid')
1782     || $self->ut_textn('stateid_state')
1783     || $self->ut_textn('invoice_terms')
1784     || $self->ut_floatn('cdr_termination_percentage')
1785     || $self->ut_floatn('credit_limit')
1786     || $self->ut_numbern('billday')
1787     || $self->ut_numbern('prorate_day')
1788     || $self->ut_flag('force_prorate_day')
1789     || $self->ut_flag('edit_subject')
1790     || $self->ut_flag('calling_list_exempt')
1791     || $self->ut_flag('invoice_noemail')
1792     || $self->ut_flag('message_noemail')
1793     || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1794     || $self->ut_currencyn('currency')
1795     || $self->ut_textn('po_number')
1796     || $self->ut_enum('complimentary', [ '', 'Y' ])
1797     || $self->ut_flag('invoice_ship_address')
1798     || $self->ut_flag('invoice_dest')
1799   ;
1800
1801   foreach (qw(company ship_company)) {
1802     my $company = $self->get($_);
1803     $company =~ s/^\s+//; 
1804     $company =~ s/\s+$//; 
1805     $company =~ s/\s+/ /g;
1806     $self->set($_, $company);
1807   }
1808
1809   #barf.  need message catalogs.  i18n.  etc.
1810   $error .= "Please select an advertising source."
1811     if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1812   return $error if $error;
1813
1814   my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1815     or return "Unknown agent";
1816
1817   if ( $self->currency ) {
1818     my $agent_currency = qsearchs( 'agent_currency', {
1819       'agentnum' => $agent->agentnum,
1820       'currency' => $self->currency,
1821     })
1822       or return "Agent ". $agent->agent.
1823                 " not permitted to offer ".  $self->currency. " invoicing";
1824   }
1825
1826   return "Unknown refnum"
1827     unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1828
1829   return "Unknown referring custnum: ". $self->referral_custnum
1830     unless ! $self->referral_custnum 
1831            || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1832
1833   if ( $self->ss eq '' ) {
1834     $self->ss('');
1835   } else {
1836     my $ss = $self->ss;
1837     $ss =~ s/\D//g;
1838     $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1839       or return "Illegal social security number: ". $self->ss;
1840     $self->ss("$1-$2-$3");
1841   }
1842
1843   #turn off invoice_ship_address if ship & bill are the same
1844   if ($self->bill_locationnum eq $self->ship_locationnum) {
1845     $self->invoice_ship_address('');
1846   }
1847
1848   # cust_main_county verification now handled by cust_location check
1849
1850   $error =
1851        $self->ut_phonen('daytime', $self->country)
1852     || $self->ut_phonen('night',   $self->country)
1853     || $self->ut_phonen('fax',     $self->country)
1854     || $self->ut_phonen('mobile',  $self->country)
1855   ;
1856   return $error if $error;
1857
1858   if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1859        && ! $import
1860        && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1861      ) {
1862
1863     my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1864                           ? 'Day Phone'
1865                           : FS::Msgcat::_gettext('daytime');
1866     my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1867                         ? 'Night Phone'
1868                         : FS::Msgcat::_gettext('night');
1869
1870     my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1871                         ? 'Mobile Phone'
1872                         : FS::Msgcat::_gettext('mobile');
1873
1874     return "$daytime_label, $night_label or $mobile_label is required"
1875   
1876   }
1877
1878   return "Please select an invoicing locale"
1879     if ! $self->locale
1880     && ! $self->custnum
1881     && $conf->exists('cust_main-require_locale');
1882
1883   return "Please select a customer class"
1884     if ! $self->classnum
1885     && $conf->exists('cust_main-require_classnum');
1886
1887   foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1888     $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1889     $self->$flag($1);
1890   }
1891
1892   $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
1893
1894   warn "$me check AFTER: \n". $self->_dump
1895     if $DEBUG > 2;
1896
1897   $self->SUPER::check;
1898 }
1899
1900 sub check_payinfo_cardtype {
1901   my $self = shift;
1902
1903   return '' unless $self->payby =~ /^(CARD|DCRD)$/;
1904
1905   my $payinfo = $self->payinfo;
1906   $payinfo =~ s/\D//g;
1907
1908   return '' if $self->tokenized($payinfo); #token
1909
1910   my %bop_card_types = map { $_=>1 } values %{ card_types() };
1911   my $cardtype = cardtype($payinfo);
1912
1913   return "$cardtype not accepted" unless $bop_card_types{$cardtype};
1914
1915   '';
1916
1917 }
1918
1919 =item replace_check
1920
1921 Additional checks for replace only.
1922
1923 =cut
1924
1925 sub replace_check {
1926   my ($new,$old) = @_;
1927   #preserve old value if global config is set
1928   if ($old && $conf->exists('invoice-ship_address')) {
1929     $new->invoice_ship_address($old->invoice_ship_address);
1930   }
1931   return '';
1932 }
1933
1934 =item addr_fields 
1935
1936 Returns a list of fields which have ship_ duplicates.
1937
1938 =cut
1939
1940 sub addr_fields {
1941   qw( last first company
1942       locationname
1943       address1 address2 city county state zip country
1944       latitude longitude
1945       daytime night fax mobile
1946     );
1947 }
1948
1949 =item has_ship_address
1950
1951 Returns true if this customer record has a separate shipping address.
1952
1953 =cut
1954
1955 sub has_ship_address {
1956   my $self = shift;
1957   $self->bill_locationnum != $self->ship_locationnum;
1958 }
1959
1960 =item location_hash
1961
1962 Returns a list of key/value pairs, with the following keys: address1, 
1963 adddress2, city, county, state, zip, country, district, and geocode.  The 
1964 shipping address is used if present.
1965
1966 =cut
1967
1968 sub location_hash {
1969   my $self = shift;
1970   $self->ship_location->location_hash;
1971 }
1972
1973 =item cust_location
1974
1975 Returns all locations (see L<FS::cust_location>) for this customer.
1976
1977 =cut
1978
1979 sub cust_location {
1980   my $self = shift;
1981   qsearch({
1982     'table'   => 'cust_location',
1983     'hashref' => { 'custnum'     => $self->custnum,
1984                    'prospectnum' => '',
1985                  },
1986     'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
1987   });
1988 }
1989
1990 =item cust_contact
1991
1992 Returns all contact associations (see L<FS::cust_contact>) for this customer.
1993
1994 =cut
1995
1996 sub cust_contact {
1997   my $self = shift;
1998   qsearch('cust_contact', { 'custnum' => $self->custnum } );
1999 }
2000
2001 =item cust_payby PAYBY
2002
2003 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2004
2005 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
2006 Does not validate PAYBY.
2007
2008 =cut
2009
2010 sub cust_payby {
2011   my $self = shift;
2012   my @payby = @_;
2013   my $search = {
2014     'table'    => 'cust_payby',
2015     'hashref'  => { 'custnum' => $self->custnum },
2016     'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
2017   };
2018   $search->{'extra_sql'} = ' AND payby IN ( '.
2019                                join(',', map dbh->quote($_), @payby).
2020                              ' ) '
2021     if @payby;
2022
2023   qsearch($search);
2024 }
2025
2026 =item has_cust_payby_auto
2027
2028 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2029
2030 =cut
2031
2032 sub has_cust_payby_auto {
2033   my $self = shift;
2034   scalar( qsearch({ 
2035     'table'     => 'cust_payby',
2036     'hashref'   => { 'custnum' => $self->custnum, },
2037     'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2038     'order_by'  => 'LIMIT 1',
2039   }) );
2040
2041 }
2042
2043 =item unsuspend
2044
2045 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2046 and L<FS::cust_pkg>) for this customer, except those on hold.
2047
2048 Returns a list: an empty list on success or a list of errors.
2049
2050 =cut
2051
2052 sub unsuspend {
2053   my $self = shift;
2054   grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs(@_);
2055 }
2056
2057 =item release_hold
2058
2059 Unsuspends all suspended packages in the on-hold state (those without setup 
2060 dates) for this customer. 
2061
2062 =cut
2063
2064 sub release_hold {
2065   my $self = shift;
2066   grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2067 }
2068
2069 =item suspend
2070
2071 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2072
2073 Returns a list: an empty list on success or a list of errors.
2074
2075 =cut
2076
2077 sub suspend {
2078   my($self, %opt) = @_;
2079
2080   my @pkgs = $self->unsuspended_pkgs;
2081
2082   @pkgs = grep { ! $_->get('start_date') } @pkgs
2083     if $opt{skip_future_startdate};
2084
2085   grep { $_->suspend(%opt) } @pkgs;
2086 }
2087
2088 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2089
2090 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2091 PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref instead
2092 of a list of pkgparts; the hashref has the following keys:
2093
2094 =over 4
2095
2096 =item pkgparts - listref of pkgparts
2097
2098 =item (other options are passed to the suspend method)
2099
2100 =back
2101
2102
2103 Returns a list: an empty list on success or a list of errors.
2104
2105 =cut
2106
2107 sub suspend_if_pkgpart {
2108   my $self = shift;
2109   my (@pkgparts, %opt);
2110   if (ref($_[0]) eq 'HASH'){
2111     @pkgparts = @{$_[0]{pkgparts}};
2112     %opt      = %{$_[0]};
2113   }else{
2114     @pkgparts = @_;
2115   }
2116   grep { $_->suspend(%opt) }
2117     grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2118       $self->unsuspended_pkgs;
2119 }
2120
2121 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2122
2123 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2124 given PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref
2125 instead of a list of pkgparts; the hashref has the following keys:
2126
2127 =over 4
2128
2129 =item pkgparts - listref of pkgparts
2130
2131 =item (other options are passed to the suspend method)
2132
2133 =back
2134
2135 Returns a list: an empty list on success or a list of errors.
2136
2137 =cut
2138
2139 sub suspend_unless_pkgpart {
2140   my $self = shift;
2141   my (@pkgparts, %opt);
2142   if (ref($_[0]) eq 'HASH'){
2143     @pkgparts = @{$_[0]{pkgparts}};
2144     %opt      = %{$_[0]};
2145   }else{
2146     @pkgparts = @_;
2147   }
2148   grep { $_->suspend(%opt) }
2149     grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2150       $self->unsuspended_pkgs;
2151 }
2152
2153 =item cancel [ OPTION => VALUE ... ]
2154
2155 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2156 The cancellation time will be now.
2157
2158 =back
2159
2160 Always returns a list: an empty list on success or a list of errors.
2161
2162 =cut
2163
2164 sub cancel {
2165   my $self = shift;
2166   my %opt = @_;
2167   warn "$me cancel called on customer ". $self->custnum. " with options ".
2168        join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2169     if $DEBUG;
2170   my @pkgs = $self->ncancelled_pkgs;
2171
2172   $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2173 }
2174
2175 =item cancel_pkgs OPTIONS
2176
2177 Cancels a specified list of packages. OPTIONS can include:
2178
2179 =over 4
2180
2181 =item cust_pkg - an arrayref of the packages. Required.
2182
2183 =item time - the cancellation time, used to calculate final bills and
2184 unused-time credits if any. Will be passed through to the bill() and
2185 FS::cust_pkg::cancel() methods.
2186
2187 =item quiet - can be set true to supress email cancellation notices.
2188
2189 =item reason - can be set to a cancellation reason (see L<FS::reason>), either a
2190 reasonnum of an existing reason, or passing a hashref will create a new reason.
2191 The hashref should have the following keys:
2192 typenum - Reason type (see L<FS::reason_type>)
2193 reason - Text of the new reason.
2194
2195 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2196 for the individual packages, parallel to the C<cust_pkg> argument. The
2197 reason and reason_otaker arguments will be taken from those objects.
2198
2199 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2200
2201 =item nobill - can be set true to skip billing if it might otherwise be done.
2202
2203 =cut
2204
2205 sub cancel_pkgs {
2206   my( $self, %opt ) = @_;
2207
2208   # we're going to cancel services, which is not reversible
2209   #   unless exports are suppressed
2210   die "cancel_pkgs cannot be run inside a transaction"
2211     if !$FS::UID::AutoCommit && !$FS::svc_Common::noexport_hack;
2212
2213   my $oldAutoCommit = $FS::UID::AutoCommit;
2214   local $FS::UID::AutoCommit = 0;
2215
2216   savepoint_create('cancel_pkgs');
2217
2218   return ( 'access denied' )
2219     unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2220
2221   if ( $opt{'ban'} ) {
2222
2223     foreach my $cust_payby ( $self->cust_payby ) {
2224
2225       #well, if they didn't get decrypted on search, then we don't have to 
2226       # try again... queue a job for the server that does have decryption
2227       # capability if we're in a paranoid multi-server implementation?
2228       return ( "Can't (yet) ban encrypted credit cards" )
2229         if $cust_payby->is_encrypted($cust_payby->payinfo);
2230
2231       my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2232       my $error = $ban->insert;
2233       if ($error) {
2234         savepoint_rollback_and_release('cancel_pkgs');
2235         dbh->rollback if $oldAutoCommit;
2236         return ( $error );
2237       }
2238
2239     }
2240
2241   }
2242
2243   my @pkgs = @{ delete $opt{'cust_pkg'} };
2244   my $cancel_time = $opt{'time'} || time;
2245
2246   # bill all packages first, so we don't lose usage, service counts for
2247   # bulk billing, etc.
2248   if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2249     $opt{nobill} = 1;
2250     my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2251                              'cancel'   => 1,
2252                              'time'     => $cancel_time );
2253     if ($error) {
2254       warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2255       savepoint_rollback_and_release('cancel_pkgs');
2256       dbh->rollback if $oldAutoCommit;
2257       return ( "Error billing during cancellation: $error" );
2258     }
2259   }
2260   savepoint_release('cancel_pkgs');
2261   dbh->commit if $oldAutoCommit;
2262
2263   my @errors;
2264   # try to cancel each service, the same way we would for individual packages,
2265   # but in cancel weight order.
2266   my @cust_svc = map { $_->cust_svc } @pkgs;
2267   my @sorted_cust_svc =
2268     map  { $_->[0] }
2269     sort { $a->[1] <=> $b->[1] }
2270     map  { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2271   ;
2272   warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2273     $self->custnum."\n"
2274     if $DEBUG;
2275   my $i = 0;
2276   foreach my $cust_svc (@sorted_cust_svc) {
2277     my $savepoint = 'cancel_pkgs_'.$i++;
2278     savepoint_create( $savepoint );
2279     my $part_svc = $cust_svc->part_svc;
2280     next if ( defined($part_svc) and $part_svc->preserve );
2281     # immediate cancel, no date option
2282     # transactionize individually
2283     my $error = try { $cust_svc->cancel } catch { $_ };
2284     if ( $error ) {
2285       savepoint_rollback_and_release( $savepoint );
2286       dbh->rollback if $oldAutoCommit;
2287       push @errors, $error;
2288     } else {
2289       savepoint_release( $savepoint );
2290       dbh->commit if $oldAutoCommit;
2291     }
2292   }
2293   if (@errors) {
2294     return @errors;
2295   }
2296
2297   warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2298     $self->custnum. "\n"
2299     if $DEBUG;
2300
2301   my @cprs;
2302   if ($opt{'cust_pkg_reason'}) {
2303     @cprs = @{ delete $opt{'cust_pkg_reason'} };
2304   }
2305   my $null_reason;
2306   $i = 0;
2307   foreach (@pkgs) {
2308     my %lopt = %opt;
2309     my $savepoint = 'cancel_pkgs_'.$i++;
2310     savepoint_create( $savepoint );
2311     if (@cprs) {
2312       my $cpr = shift @cprs;
2313       if ( $cpr ) {
2314         $lopt{'reason'}        = $cpr->reasonnum;
2315         $lopt{'reason_otaker'} = $cpr->otaker;
2316       } else {
2317         warn "no reason found when canceling package ".$_->pkgnum."\n";
2318         # we're not actually required to pass a reason to cust_pkg::cancel,
2319         # but if we're getting to this point, something has gone awry.
2320         $null_reason ||= FS::reason->new_or_existing(
2321           reason  => 'unknown reason',
2322           type    => 'Cancel Reason',
2323           class   => 'C',
2324         );
2325         $lopt{'reason'} = $null_reason->reasonnum;
2326         $lopt{'reason_otaker'} = $FS::CurrentUser::CurrentUser->username;
2327       }
2328     }
2329     my $error = $_->cancel(%lopt);
2330     if ( $error ) {
2331       savepoint_rollback_and_release( $savepoint );
2332       dbh->rollback if $oldAutoCommit;
2333       push @errors, 'pkgnum '.$_->pkgnum.': '.$error;
2334     } else {
2335       savepoint_release( $savepoint );
2336       dbh->commit if $oldAutoCommit;
2337     }
2338   }
2339
2340   return @errors;
2341 }
2342
2343 sub _banned_pay_hashref {
2344   die 'cust_main->_banned_pay_hashref deprecated';
2345
2346   my $self = shift;
2347
2348   my %payby2ban = (
2349     'CARD' => 'CARD',
2350     'DCRD' => 'CARD',
2351     'CHEK' => 'CHEK',
2352     'DCHK' => 'CHEK'
2353   );
2354
2355   {
2356     'payby'   => $payby2ban{$self->payby},
2357     'payinfo' => $self->payinfo,
2358     #don't ever *search* on reason! #'reason'  =>
2359   };
2360 }
2361
2362 =item notes
2363
2364 Returns all notes (see L<FS::cust_main_note>) for this customer.
2365
2366 =cut
2367
2368 sub notes {
2369   my($self,$orderby_classnum) = (shift,shift);
2370   my $orderby = "sticky DESC, _date DESC";
2371   $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2372   qsearch( 'cust_main_note',
2373            { 'custnum' => $self->custnum },
2374            '',
2375            "ORDER BY $orderby",
2376          );
2377 }
2378
2379 =item agent
2380
2381 Returns the agent (see L<FS::agent>) for this customer.
2382
2383 =item agent_name
2384
2385 Returns the agent name (see L<FS::agent>) for this customer.
2386
2387 =cut
2388
2389 sub agent_name {
2390   my $self = shift;
2391   $self->agent->agent;
2392 }
2393
2394 =item cust_tag
2395
2396 Returns any tags associated with this customer, as FS::cust_tag objects,
2397 or an empty list if there are no tags.
2398
2399 =item part_tag
2400
2401 Returns any tags associated with this customer, as FS::part_tag objects,
2402 or an empty list if there are no tags.
2403
2404 =cut
2405
2406 sub part_tag {
2407   my $self = shift;
2408   map $_->part_tag, $self->cust_tag; 
2409 }
2410
2411
2412 =item cust_class
2413
2414 Returns the customer class, as an FS::cust_class object, or the empty string
2415 if there is no customer class.
2416
2417 =item categoryname 
2418
2419 Returns the customer category name, or the empty string if there is no customer
2420 category.
2421
2422 =cut
2423
2424 sub categoryname {
2425   my $self = shift;
2426   my $cust_class = $self->cust_class;
2427   $cust_class
2428     ? $cust_class->categoryname
2429     : '';
2430 }
2431
2432 =item classname 
2433
2434 Returns the customer class name, or the empty string if there is no customer
2435 class.
2436
2437 =cut
2438
2439 sub classname {
2440   my $self = shift;
2441   my $cust_class = $self->cust_class;
2442   $cust_class
2443     ? $cust_class->classname
2444     : '';
2445 }
2446
2447 =item tax_status
2448
2449 Returns the external tax status, as an FS::tax_status object, or the empty 
2450 string if there is no tax status.
2451
2452 =cut
2453
2454 sub tax_status {
2455   my $self = shift;
2456   if ( $self->taxstatusnum ) {
2457     qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2458   } else {
2459     return '';
2460   } 
2461 }
2462
2463 =item taxstatus
2464
2465 Returns the tax status code if there is one.
2466
2467 =cut
2468
2469 sub taxstatus {
2470   my $self = shift;
2471   my $tax_status = $self->tax_status;
2472   $tax_status
2473     ? $tax_status->taxstatus
2474     : '';
2475 }
2476
2477 =item BILLING METHODS
2478
2479 Documentation on billing methods has been moved to
2480 L<FS::cust_main::Billing>.
2481
2482 =item REALTIME BILLING METHODS
2483
2484 Documentation on realtime billing methods has been moved to
2485 L<FS::cust_main::Billing_Realtime>.
2486
2487 =item remove_cvv
2488
2489 Removes the I<paycvv> field from the database directly.
2490
2491 If there is an error, returns the error, otherwise returns false.
2492
2493 DEPRECATED.  Use L</remove_cvv_from_cust_payby> instead.
2494
2495 =cut
2496
2497 sub remove_cvv {
2498   die 'cust_main->remove_cvv deprecated';
2499   my $self = shift;
2500   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2501     or return dbh->errstr;
2502   $sth->execute($self->custnum)
2503     or return $sth->errstr;
2504   $self->paycvv('');
2505   '';
2506 }
2507
2508 =item total_owed
2509
2510 Returns the total owed for this customer on all invoices
2511 (see L<FS::cust_bill/owed>).
2512
2513 =cut
2514
2515 sub total_owed {
2516   my $self = shift;
2517   $self->total_owed_date(2145859200); #12/31/2037
2518 }
2519
2520 =item total_owed_date TIME
2521
2522 Returns the total owed for this customer on all invoices with date earlier than
2523 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2524 see L<Time::Local> and L<Date::Parse> for conversion functions.
2525
2526 =cut
2527
2528 sub total_owed_date {
2529   my $self = shift;
2530   my $time = shift;
2531
2532   my $custnum = $self->custnum;
2533
2534   my $owed_sql = FS::cust_bill->owed_sql;
2535
2536   my $sql = "
2537     SELECT SUM($owed_sql) FROM cust_bill
2538       WHERE custnum = $custnum
2539         AND _date <= $time
2540   ";
2541
2542   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2543
2544 }
2545
2546 =item total_owed_pkgnum PKGNUM
2547
2548 Returns the total owed on all invoices for this customer's specific package
2549 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2550
2551 =cut
2552
2553 sub total_owed_pkgnum {
2554   my( $self, $pkgnum ) = @_;
2555   $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2556 }
2557
2558 =item total_owed_date_pkgnum TIME PKGNUM
2559
2560 Returns the total owed for this customer's specific package when using
2561 experimental package balances on all invoices with date earlier than
2562 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2563 see L<Time::Local> and L<Date::Parse> for conversion functions.
2564
2565 =cut
2566
2567 sub total_owed_date_pkgnum {
2568   my( $self, $time, $pkgnum ) = @_;
2569
2570   my $total_bill = 0;
2571   foreach my $cust_bill (
2572     grep { $_->_date <= $time }
2573       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2574   ) {
2575     $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2576   }
2577   sprintf( "%.2f", $total_bill );
2578
2579 }
2580
2581 =item total_paid
2582
2583 Returns the total amount of all payments.
2584
2585 =cut
2586
2587 sub total_paid {
2588   my $self = shift;
2589   my $total = 0;
2590   $total += $_->paid foreach $self->cust_pay;
2591   sprintf( "%.2f", $total );
2592 }
2593
2594 =item total_unapplied_credits
2595
2596 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2597 customer.  See L<FS::cust_credit/credited>.
2598
2599 =item total_credited
2600
2601 Old name for total_unapplied_credits.  Don't use.
2602
2603 =cut
2604
2605 sub total_credited {
2606   #carp "total_credited deprecated, use total_unapplied_credits";
2607   shift->total_unapplied_credits(@_);
2608 }
2609
2610 sub total_unapplied_credits {
2611   my $self = shift;
2612
2613   my $custnum = $self->custnum;
2614
2615   my $unapplied_sql = FS::cust_credit->unapplied_sql;
2616
2617   my $sql = "
2618     SELECT SUM($unapplied_sql) FROM cust_credit
2619       WHERE custnum = $custnum
2620   ";
2621
2622   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2623
2624 }
2625
2626 =item total_unapplied_credits_pkgnum PKGNUM
2627
2628 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2629 customer.  See L<FS::cust_credit/credited>.
2630
2631 =cut
2632
2633 sub total_unapplied_credits_pkgnum {
2634   my( $self, $pkgnum ) = @_;
2635   my $total_credit = 0;
2636   $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2637   sprintf( "%.2f", $total_credit );
2638 }
2639
2640
2641 =item total_unapplied_payments
2642
2643 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2644 See L<FS::cust_pay/unapplied>.
2645
2646 =cut
2647
2648 sub total_unapplied_payments {
2649   my $self = shift;
2650
2651   my $custnum = $self->custnum;
2652
2653   my $unapplied_sql = FS::cust_pay->unapplied_sql;
2654
2655   my $sql = "
2656     SELECT SUM($unapplied_sql) FROM cust_pay
2657       WHERE custnum = $custnum
2658   ";
2659
2660   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2661
2662 }
2663
2664 =item total_unapplied_payments_pkgnum PKGNUM
2665
2666 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2667 specific package when using experimental package balances.  See
2668 L<FS::cust_pay/unapplied>.
2669
2670 =cut
2671
2672 sub total_unapplied_payments_pkgnum {
2673   my( $self, $pkgnum ) = @_;
2674   my $total_unapplied = 0;
2675   $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2676   sprintf( "%.2f", $total_unapplied );
2677 }
2678
2679
2680 =item total_unapplied_refunds
2681
2682 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2683 customer.  See L<FS::cust_refund/unapplied>.
2684
2685 =cut
2686
2687 sub total_unapplied_refunds {
2688   my $self = shift;
2689   my $custnum = $self->custnum;
2690
2691   my $unapplied_sql = FS::cust_refund->unapplied_sql;
2692
2693   my $sql = "
2694     SELECT SUM($unapplied_sql) FROM cust_refund
2695       WHERE custnum = $custnum
2696   ";
2697
2698   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2699
2700 }
2701
2702 =item balance
2703
2704 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2705 total_unapplied_credits minus total_unapplied_payments).
2706
2707 =cut
2708
2709 sub balance {
2710   my $self = shift;
2711   $self->balance_date_range;
2712 }
2713
2714 =item balance_date TIME
2715
2716 Returns the balance for this customer, only considering invoices with date
2717 earlier than TIME (total_owed_date minus total_credited minus
2718 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
2719 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
2720 functions.
2721
2722 =cut
2723
2724 sub balance_date {
2725   my $self = shift;
2726   $self->balance_date_range(shift);
2727 }
2728
2729 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2730
2731 Returns the balance for this customer, optionally considering invoices with
2732 date earlier than START_TIME, and not later than END_TIME
2733 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2734
2735 Times are specified as SQL fragments or numeric
2736 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
2737 L<Date::Parse> for conversion functions.  The empty string can be passed
2738 to disable that time constraint completely.
2739
2740 Accepts the same options as L</balance_date_sql>:
2741
2742 =over 4
2743
2744 =item unapplied_date
2745
2746 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)
2747
2748 =item cutoff
2749
2750 An absolute cutoff time.  Payments, credits, and refunds I<applied> after this 
2751 time will be ignored.  Note that START_TIME and END_TIME only limit the date 
2752 range for invoices and I<unapplied> payments, credits, and refunds.
2753
2754 =back
2755
2756 =cut
2757
2758 sub balance_date_range {
2759   my $self = shift;
2760   my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2761             ') FROM cust_main WHERE custnum='. $self->custnum;
2762   sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2763 }
2764
2765 =item balance_pkgnum PKGNUM
2766
2767 Returns the balance for this customer's specific package when using
2768 experimental package balances (total_owed plus total_unrefunded, minus
2769 total_unapplied_credits minus total_unapplied_payments)
2770
2771 =cut
2772
2773 sub balance_pkgnum {
2774   my( $self, $pkgnum ) = @_;
2775
2776   sprintf( "%.2f",
2777       $self->total_owed_pkgnum($pkgnum)
2778 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2779 #    + $self->total_unapplied_refunds_pkgnum($pkgnum)
2780     - $self->total_unapplied_credits_pkgnum($pkgnum)
2781     - $self->total_unapplied_payments_pkgnum($pkgnum)
2782   );
2783 }
2784
2785 =item payment_info
2786
2787 Returns a hash of useful information for making a payment.
2788
2789 =over 4
2790
2791 =item balance
2792
2793 Current balance.
2794
2795 =item payby
2796
2797 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2798 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2799 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2800
2801 =back
2802
2803 For credit card transactions:
2804
2805 =over 4
2806
2807 =item card_type 1
2808
2809 =item payname
2810
2811 Exact name on card
2812
2813 =back
2814
2815 For electronic check transactions:
2816
2817 =over 4
2818
2819 =item stateid_state
2820
2821 =back
2822
2823 =cut
2824
2825 #XXX i need to be updated for 4.x+
2826 sub payment_info {
2827   my $self = shift;
2828
2829   my %return = ();
2830
2831   $return{balance} = $self->balance;
2832
2833   $return{payname} = $self->payname
2834                      || ( $self->first. ' '. $self->get('last') );
2835
2836   $return{$_} = $self->bill_location->$_
2837     for qw(address1 address2 city state zip);
2838
2839   $return{payby} = $self->payby;
2840   $return{stateid_state} = $self->stateid_state;
2841
2842   if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2843     $return{card_type} = cardtype($self->payinfo);
2844     $return{payinfo} = $self->paymask;
2845
2846     @return{'month', 'year'} = $self->paydate_monthyear;
2847
2848   }
2849
2850   if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2851     my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2852     $return{payinfo1} = $payinfo1;
2853     $return{payinfo2} = $payinfo2;
2854     $return{paytype}  = $self->paytype;
2855     $return{paystate} = $self->paystate;
2856
2857   }
2858
2859   #doubleclick protection
2860   my $_date = time;
2861   $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2862
2863   %return;
2864
2865 }
2866
2867 =item paydate_epoch
2868
2869 Returns the next payment expiration date for this customer. If they have no
2870 payment methods that will expire, returns 0.
2871
2872 =cut
2873
2874 sub paydate_epoch {
2875   my $self = shift;
2876   # filter out the ones that individually return 0, but then return 0 if
2877   # there are no results
2878   my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
2879   min( @epochs ) || 0;
2880 }
2881
2882 =item paydate_epoch_sql
2883
2884 Returns an SQL expression to get the next payment expiration date for a
2885 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
2886 dates, so that it's safe to test for "will it expire before date X" for any
2887 date up to then.
2888
2889 =cut
2890
2891 sub paydate_epoch_sql {
2892   my $class = shift;
2893   my $paydate = FS::cust_payby->paydate_epoch_sql;
2894   "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
2895 }
2896
2897 sub tax_exemption {
2898   my( $self, $taxname ) = @_;
2899
2900   qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2901                                      'taxname' => $taxname,
2902                                    },
2903           );
2904 }
2905
2906 =item cust_main_exemption
2907
2908 =item invoicing_list
2909
2910 Returns a list of email addresses (with svcnum entries expanded), and the word
2911 'POST' if the customer receives postal invoices.
2912
2913 =cut
2914
2915 sub invoicing_list {
2916   my( $self, $arrayref ) = @_;
2917
2918   if ( $arrayref ) {
2919     warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
2920   }
2921   
2922   my @emails = $self->invoicing_list_emailonly;
2923   push @emails, 'POST' if $self->get('postal_invoice');
2924
2925   @emails;
2926 }
2927
2928 =item check_invoicing_list ARRAYREF
2929
2930 Checks these arguements as valid input for the invoicing_list method.  If there
2931 is an error, returns the error, otherwise returns false.
2932
2933 =cut
2934
2935 sub check_invoicing_list {
2936   my( $self, $arrayref ) = @_;
2937
2938   foreach my $address ( @$arrayref ) {
2939
2940     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
2941       return 'Can\'t add FAX invoice destination with a blank FAX number.';
2942     }
2943
2944     my $cust_main_invoice = new FS::cust_main_invoice ( {
2945       'custnum' => $self->custnum,
2946       'dest'    => $address,
2947     } );
2948     my $error = $self->custnum
2949                 ? $cust_main_invoice->check
2950                 : $cust_main_invoice->checkdest
2951     ;
2952     return $error if $error;
2953
2954   }
2955
2956   return "Email address required"
2957     if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
2958     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
2959
2960   '';
2961 }
2962
2963 =item all_emails
2964
2965 Returns the email addresses of all accounts provisioned for this customer.
2966
2967 =cut
2968
2969 sub all_emails {
2970   my $self = shift;
2971   my %list;
2972   foreach my $cust_pkg ( $self->all_pkgs ) {
2973     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
2974     my @svc_acct =
2975       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2976         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2977           @cust_svc;
2978     $list{$_}=1 foreach map { $_->email } @svc_acct;
2979   }
2980   keys %list;
2981 }
2982
2983 =item invoicing_list_addpost
2984
2985 Adds postal invoicing to this customer.  If this customer is already configured
2986 to receive postal invoices, does nothing.
2987
2988 =cut
2989
2990 sub invoicing_list_addpost {
2991   my $self = shift;
2992   if ( $self->get('postal_invoice') eq '' ) {
2993     $self->set('postal_invoice', 'Y');
2994     my $error = $self->replace;
2995     warn $error if $error; # should fail harder, but this is traditional
2996   }
2997 }
2998
2999 =item invoicing_list_emailonly
3000
3001 Returns the list of email invoice recipients (invoicing_list without non-email
3002 destinations such as POST and FAX).
3003
3004 =cut
3005
3006 sub invoicing_list_emailonly {
3007   my $self = shift;
3008   warn "$me invoicing_list_emailonly called"
3009     if $DEBUG;
3010   return () if !$self->custnum; # not yet inserted
3011   return map { $_->emailaddress }
3012     qsearch({
3013         table     => 'cust_contact',
3014         select    => 'emailaddress',
3015         addl_from => ' JOIN contact USING (contactnum) '.
3016                      ' JOIN contact_email USING (contactnum)',
3017         hashref   => { 'custnum' => $self->custnum, },
3018         extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
3019     });
3020 }
3021
3022 =item invoicing_list_emailonly_scalar
3023
3024 Returns the list of email invoice recipients (invoicing_list without non-email
3025 destinations such as POST and FAX) as a comma-separated scalar.
3026
3027 =cut
3028
3029 sub invoicing_list_emailonly_scalar {
3030   my $self = shift;
3031   warn "$me invoicing_list_emailonly_scalar called"
3032     if $DEBUG;
3033   join(', ', $self->invoicing_list_emailonly);
3034 }
3035
3036 =item contact_list [ CLASSNUM, DEST_FLAG... ]
3037
3038 Returns a list of contacts (L<FS::contact> objects) for the customer.
3039
3040 If no arguments are given, returns all contacts for the customer.
3041
3042 Arguments may contain classnums.  When classnums are specified, only
3043 contacts with a matching cust_contact.classnum are returned.  When a
3044 classnum of 0 is given, contacts with a null classnum are also included.
3045
3046 Arguments may also contain the dest flag names 'invoice' or 'message'.
3047 If given, contacts who's invoice_dest and/or message_dest flags are
3048 not set to 'Y' will be excluded.
3049
3050 =cut
3051
3052 sub contact_list {
3053   my $self = shift;
3054   my $search = {
3055     table       => 'contact',
3056     select      => join(', ',(
3057                     'contact.*',
3058                     'cust_contact.invoice_dest',
3059                     'cust_contact.message_dest',
3060     )),
3061     addl_from   => ' JOIN cust_contact USING (contactnum)',
3062     extra_sql   => ' WHERE cust_contact.custnum = '.$self->custnum,
3063   };
3064
3065   # Bugfix notes:
3066   #   Calling methods were relying on this method to use invoice_dest to
3067   #   block e-mail messages.  Depending on parameters, this may or may not
3068   #   have actually happened.
3069   #
3070   #   The bug could cause this SQL to be used to filter e-mail addresses:
3071   #
3072   #   AND (
3073   #     cust_contact.classnums IN (1,2,3)
3074   #     OR cust_contact.invoice_dest = 'Y'
3075   #   )
3076   #
3077   #   improperly including everybody with the opt-in flag AND everybody
3078   #   in the contact classes
3079   #
3080   # Possibility to introduce new bugs:
3081   #   If callers of this method called it incorrectly, and didn't notice
3082   #   because it seemed to send the e-mails they wanted.
3083
3084   # WHERE ...
3085   # AND (
3086   #   (
3087   #     cust_contact.classnum IN (1,2,3)
3088   #     OR
3089   #     cust_contact.classnum IS NULL
3090   #   )
3091   #   AND (
3092   #     cust_contact.invoice_dest = 'Y'
3093   #     OR
3094   #     cust_contact.message_dest = 'Y'
3095   #   )
3096   # )
3097
3098   my @and_dest;
3099   my @or_classnum;
3100   my @classnums;
3101   for (@_) {
3102     if ($_ eq 'invoice' || $_ eq 'message') {
3103       push @and_dest, " cust_contact.${_}_dest = 'Y' ";
3104     } elsif ($_ eq '0') {
3105       push @or_classnum, ' cust_contact.classnum IS NULL ';
3106     } elsif ( /^\d+$/ ) {
3107       push @classnums, $_;
3108     } else {
3109       croak "bad classnum argument '$_'";
3110     }
3111   }
3112
3113   push @or_classnum, 'cust_contact.classnum IN ('.join(',',@classnums).')'
3114     if @classnums;
3115
3116   if (@or_classnum || @and_dest) { # catch, no arguments given
3117     $search->{extra_sql} .= ' AND ( ';
3118
3119       if (@or_classnum) {
3120         $search->{extra_sql} .= ' ( ';
3121         $search->{extra_sql} .= join ' OR ', map {" $_ "} @or_classnum;
3122         $search->{extra_sql} .= ' ) ';
3123         $search->{extra_sql} .= ' AND ( ' if @and_dest;
3124       }
3125
3126       if (@and_dest) {
3127         $search->{extra_sql} .= join ' OR ', map {" $_ "} @and_dest;
3128         $search->{extra_sql} .= ' ) ' if @or_classnum;
3129       }
3130
3131     $search->{extra_sql} .= ' ) ';
3132
3133     warn "\$extra_sql: $search->{extra_sql} \n" if $DEBUG;
3134   }
3135
3136   qsearch($search);
3137 }
3138
3139 =item contact_list_email [ CLASSNUM, ... ]
3140
3141 Same as L</contact_list>, but returns email destinations instead of contact
3142 objects.
3143
3144 =cut
3145
3146 sub contact_list_email {
3147   my $self = shift;
3148   my @contacts = $self->contact_list(@_);
3149   my @emails;
3150   foreach my $contact (@contacts) {
3151     foreach my $contact_email ($contact->contact_email) {
3152       push @emails,  Email::Address->new( $contact->firstlast,
3153                                           $contact_email->emailaddress
3154                      )->format;
3155     }
3156   }
3157   @emails;
3158 }
3159
3160 =item contact_list_email_destinations
3161
3162 Returns a list of emails and whether they receive invoices or messages destinations.
3163 { emailaddress => 'email.com', invoice => 'Y', message => '', }
3164
3165 =cut
3166
3167 sub contact_list_email_destinations {
3168   my $self = shift;
3169   warn "$me contact_list_email_destinations"
3170     if $DEBUG;
3171   return () if !$self->custnum; # not yet inserted
3172   return map { $_ }
3173     qsearch({
3174         table     => 'cust_contact',
3175         select    => 'emailaddress, cust_contact.invoice_dest as invoice, cust_contact.message_dest as message',
3176         addl_from => ' JOIN contact USING (contactnum) '.
3177                      ' JOIN contact_email USING (contactnum)',
3178         hashref   => { 'custnum' => $self->custnum, },
3179         order_by  => 'ORDER BY custcontactnum DESC',
3180         extra_sql => '',
3181     });
3182 }
3183
3184 =item contact_list_name_phones
3185
3186 Returns a list of contact phone numbers.
3187 { phonetypenum => '1', phonenum => 'xxxxxxxxxx', first => 'firstname', last => 'lastname', countrycode => '1' }
3188
3189 =cut
3190
3191 sub contact_list_name_phones {
3192   my $self = shift;
3193   my $phone_type = shift;
3194
3195   warn "$me contact_list_phones" if $DEBUG;
3196
3197   return () if !$self->custnum; # not yet inserted
3198   return map { $_ }
3199     qsearch({
3200         table     => 'cust_contact',
3201         select    => 'phonetypenum, phonenum, first, last, countrycode',
3202         addl_from => ' JOIN contact USING (contactnum) '.
3203                      ' JOIN contact_phone USING (contactnum)',
3204         hashref   => { 'custnum' => $self->custnum, 'phonetypenum' => $phone_type, },
3205         order_by  => 'ORDER BY custcontactnum DESC',
3206         extra_sql => '',
3207     });
3208 }
3209
3210 =item contact_list_emailonly
3211
3212 Returns an array of hashes containing the emails. Used for displaying contact email field in advanced customer reports.
3213 [ { data => 'email.com', }, ]
3214
3215 =cut
3216
3217 sub contact_list_emailonly {
3218   my $self = shift;
3219   warn "$me contact_list_emailonly called"
3220     if $DEBUG;
3221   my @emails;
3222   foreach ($self->contact_list_email_destinations) {
3223     my $data = [
3224       {
3225         'data'  => $_->emailaddress,
3226       },
3227     ];
3228     push @emails, $data;
3229   }
3230   return \@emails;
3231 }
3232
3233 =item contact_list_cust_invoice_only
3234
3235 Returns an array of hashes containing cust_contact.invoice_dest.  Does this email receive invoices. Used for displaying email Invoice field in advanced customer reports.
3236 [ { data => 'Yes', }, ]
3237
3238 =cut
3239
3240 sub contact_list_cust_invoice_only {
3241   my $self = shift;
3242   warn "$me contact_list_cust_invoice_only called"
3243     if $DEBUG;
3244   my @emails;
3245   foreach ($self->contact_list_email_destinations) {
3246     my $invoice = $_->invoice ? 'Yes' : 'No';
3247     my $data = [
3248       {
3249         'data'  => $invoice,
3250       },
3251     ];
3252     push @emails, $data;
3253   }
3254   return \@emails;
3255 }
3256
3257 =item contact_list_cust_message_only
3258
3259 Returns an array of hashes containing cust_contact.message_dest.  Does this email receive message notifications. Used for displaying email Message field in advanced customer reports.
3260 [ { data => 'Yes', }, ]
3261
3262 =cut
3263
3264 sub contact_list_cust_message_only {
3265   my $self = shift;
3266   warn "$me contact_list_cust_message_only called"
3267     if $DEBUG;
3268   my @emails;
3269   foreach ($self->contact_list_email_destinations) {
3270     my $message = $_->message ? 'Yes' : 'No';
3271     my $data = [
3272       {
3273         'data'  => $message,
3274       },
3275     ];
3276     push @emails, $data;
3277   }
3278   return \@emails;
3279 }
3280
3281 =item referral_custnum_cust_main
3282
3283 Returns the customer who referred this customer (or the empty string, if
3284 this customer was not referred).
3285
3286 Note the difference with referral_cust_main method: This method,
3287 referral_custnum_cust_main returns the single customer (if any) who referred
3288 this customer, while referral_cust_main returns an array of customers referred
3289 BY this customer.
3290
3291 =cut
3292
3293 sub referral_custnum_cust_main {
3294   my $self = shift;
3295   return '' unless $self->referral_custnum;
3296   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3297 }
3298
3299 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3300
3301 Returns an array of customers referred by this customer (referral_custnum set
3302 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
3303 customers referred by customers referred by this customer and so on, inclusive.
3304 The default behavior is DEPTH 1 (no recursion).
3305
3306 Note the difference with referral_custnum_cust_main method: This method,
3307 referral_cust_main, returns an array of customers referred BY this customer,
3308 while referral_custnum_cust_main returns the single customer (if any) who
3309 referred this customer.
3310
3311 =cut
3312
3313 sub referral_cust_main {
3314   my $self = shift;
3315   my $depth = @_ ? shift : 1;
3316   my $exclude = @_ ? shift : {};
3317
3318   my @cust_main =
3319     map { $exclude->{$_->custnum}++; $_; }
3320       grep { ! $exclude->{ $_->custnum } }
3321         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3322
3323   if ( $depth > 1 ) {
3324     push @cust_main,
3325       map { $_->referral_cust_main($depth-1, $exclude) }
3326         @cust_main;
3327   }
3328
3329   @cust_main;
3330 }
3331
3332 =item referral_cust_main_ncancelled
3333
3334 Same as referral_cust_main, except only returns customers with uncancelled
3335 packages.
3336
3337 =cut
3338
3339 sub referral_cust_main_ncancelled {
3340   my $self = shift;
3341   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3342 }
3343
3344 =item referral_cust_pkg [ DEPTH ]
3345
3346 Like referral_cust_main, except returns a flat list of all unsuspended (and
3347 uncancelled) packages for each customer.  The number of items in this list may
3348 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3349
3350 =cut
3351
3352 sub referral_cust_pkg {
3353   my $self = shift;
3354   my $depth = @_ ? shift : 1;
3355
3356   map { $_->unsuspended_pkgs }
3357     grep { $_->unsuspended_pkgs }
3358       $self->referral_cust_main($depth);
3359 }
3360
3361 =item referring_cust_main
3362
3363 Returns the single cust_main record for the customer who referred this customer
3364 (referral_custnum), or false.
3365
3366 =cut
3367
3368 sub referring_cust_main {
3369   my $self = shift;
3370   return '' unless $self->referral_custnum;
3371   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3372 }
3373
3374 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3375
3376 Applies a credit to this customer.  If there is an error, returns the error,
3377 otherwise returns false.
3378
3379 REASON can be a text string, an FS::reason object, or a scalar reference to
3380 a reasonnum.  If a text string, it will be automatically inserted as a new
3381 reason, and a 'reason_type' option must be passed to indicate the
3382 FS::reason_type for the new reason.
3383
3384 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3385 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3386 I<commission_pkgnum>.
3387
3388 Any other options are passed to FS::cust_credit::insert.
3389
3390 =cut
3391
3392 sub credit {
3393   my( $self, $amount, $reason, %options ) = @_;
3394
3395   my $cust_credit = new FS::cust_credit {
3396     'custnum' => $self->custnum,
3397     'amount'  => $amount,
3398   };
3399
3400   if ( ref($reason) ) {
3401
3402     if ( ref($reason) eq 'SCALAR' ) {
3403       $cust_credit->reasonnum( $$reason );
3404     } else {
3405       $cust_credit->reasonnum( $reason->reasonnum );
3406     }
3407
3408   } else {
3409     $cust_credit->set('reason', $reason)
3410   }
3411
3412   $cust_credit->$_( delete $options{$_} )
3413     foreach grep exists($options{$_}),
3414               qw( addlinfo eventnum ),
3415               map "commission_$_", qw( agentnum salesnum pkgnum );
3416
3417   $cust_credit->insert(%options);
3418
3419 }
3420
3421 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3422
3423 Creates a one-time charge for this customer.  If there is an error, returns
3424 the error, otherwise returns false.
3425
3426 New-style, with a hashref of options:
3427
3428   my $error = $cust_main->charge(
3429                                   {
3430                                     'amount'     => 54.32,
3431                                     'quantity'   => 1,
3432                                     'start_date' => str2time('7/4/2009'),
3433                                     'pkg'        => 'Description',
3434                                     'comment'    => 'Comment',
3435                                     'additional' => [], #extra invoice detail
3436                                     'classnum'   => 1,  #pkg_class
3437
3438                                     'setuptax'   => '', # or 'Y' for tax exempt
3439
3440                                     'locationnum'=> 1234, # optional
3441
3442                                     #internal taxation
3443                                     'taxclass'   => 'Tax class',
3444
3445                                     #vendor taxation
3446                                     'taxproduct' => 2,  #part_pkg_taxproduct
3447                                     'override'   => {}, #XXX describe
3448
3449                                     #will be filled in with the new object
3450                                     'cust_pkg_ref' => \$cust_pkg,
3451
3452                                     #generate an invoice immediately
3453                                     'bill_now' => 0,
3454                                     'invoice_terms' => '', #with these terms
3455                                   }
3456                                 );
3457
3458 Old-style:
3459
3460   my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3461
3462 =cut
3463
3464 #super false laziness w/quotation::charge
3465 sub charge {
3466   my $self = shift;
3467   my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3468   my ( $pkg, $comment, $additional );
3469   my ( $setuptax, $taxclass );   #internal taxes
3470   my ( $taxproduct, $override ); #vendor (CCH) taxes
3471   my $no_auto = '';
3472   my $separate_bill = '';
3473   my $cust_pkg_ref = '';
3474   my ( $bill_now, $invoice_terms ) = ( 0, '' );
3475   my $locationnum;
3476   my ( $discountnum, $discountnum_amount, $discountnum_percent ) = ( '','','' );
3477   if ( ref( $_[0] ) ) {
3478     $amount     = $_[0]->{amount};
3479     $setup_cost = $_[0]->{setup_cost};
3480     $quantity   = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3481     $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3482     $no_auto    = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3483     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3484     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
3485                                            : '$'. sprintf("%.2f",$amount);
3486     $setuptax   = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3487     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3488     $classnum   = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3489     $additional = $_[0]->{additional} || [];
3490     $taxproduct = $_[0]->{taxproductnum};
3491     $override   = { '' => $_[0]->{tax_override} };
3492     $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3493     $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3494     $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3495     $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3496     $separate_bill = $_[0]->{separate_bill} || '';
3497     $discountnum = $_[0]->{setup_discountnum};
3498     $discountnum_amount = $_[0]->{setup_discountnum_amount};
3499     $discountnum_percent = $_[0]->{setup_discountnum_percent};
3500   } else { # yuck
3501     $amount     = shift;
3502     $setup_cost = '';
3503     $quantity   = 1;
3504     $start_date = '';
3505     $pkg        = @_ ? shift : 'One-time charge';
3506     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
3507     $setuptax   = '';
3508     $taxclass   = @_ ? shift : '';
3509     $additional = [];
3510   }
3511
3512   local $SIG{HUP} = 'IGNORE';
3513   local $SIG{INT} = 'IGNORE';
3514   local $SIG{QUIT} = 'IGNORE';
3515   local $SIG{TERM} = 'IGNORE';
3516   local $SIG{TSTP} = 'IGNORE';
3517   local $SIG{PIPE} = 'IGNORE';
3518
3519   my $oldAutoCommit = $FS::UID::AutoCommit;
3520   local $FS::UID::AutoCommit = 0;
3521   my $dbh = dbh;
3522
3523   my $part_pkg = new FS::part_pkg ( {
3524     'pkg'           => $pkg,
3525     'comment'       => $comment,
3526     'plan'          => 'flat',
3527     'freq'          => 0,
3528     'disabled'      => 'Y',
3529     'classnum'      => ( $classnum ? $classnum : '' ),
3530     'setuptax'      => $setuptax,
3531     'taxclass'      => $taxclass,
3532     'taxproductnum' => $taxproduct,
3533     'setup_cost'    => $setup_cost,
3534   } );
3535
3536   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3537                         ( 0 .. @$additional - 1 )
3538                   ),
3539                   'additional_count' => scalar(@$additional),
3540                   'setup_fee' => $amount,
3541                 );
3542
3543   my $error = $part_pkg->insert( options       => \%options,
3544                                  tax_overrides => $override,
3545                                );
3546   if ( $error ) {
3547     $dbh->rollback if $oldAutoCommit;
3548     return $error;
3549   }
3550
3551   my $pkgpart = $part_pkg->pkgpart;
3552   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3553   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3554     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3555     $error = $type_pkgs->insert;
3556     if ( $error ) {
3557       $dbh->rollback if $oldAutoCommit;
3558       return $error;
3559     }
3560   }
3561
3562   my $cust_pkg = new FS::cust_pkg ( {
3563     'custnum'                   => $self->custnum,
3564     'pkgpart'                   => $pkgpart,
3565     'quantity'                  => $quantity,
3566     'start_date'                => $start_date,
3567     'no_auto'                   => $no_auto,
3568     'separate_bill'             => $separate_bill,
3569     'locationnum'               => $locationnum,
3570     'setup_discountnum'         => $discountnum,
3571     'setup_discountnum_amount'  => $discountnum_amount,
3572     'setup_discountnum_percent' => $discountnum_percent,
3573   } );
3574
3575   $error = $cust_pkg->insert;
3576   if ( $error ) {
3577     $dbh->rollback if $oldAutoCommit;
3578     return $error;
3579   } elsif ( $cust_pkg_ref ) {
3580     ${$cust_pkg_ref} = $cust_pkg;
3581   }
3582
3583   if ( $bill_now ) {
3584     my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3585                              'pkg_list'      => [ $cust_pkg ],
3586                            );
3587     if ( $error ) {
3588       $dbh->rollback if $oldAutoCommit;
3589       return $error;
3590     }   
3591   }
3592
3593   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3594   return '';
3595
3596 }
3597
3598 #=item charge_postal_fee
3599 #
3600 #Applies a one time charge this customer.  If there is an error,
3601 #returns the error, returns the cust_pkg charge object or false
3602 #if there was no charge.
3603 #
3604 #=cut
3605 #
3606 # This should be a customer event.  For that to work requires that bill
3607 # also be a customer event.
3608
3609 sub charge_postal_fee {
3610   my $self = shift;
3611
3612   my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3613   return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3614
3615   my $cust_pkg = new FS::cust_pkg ( {
3616     'custnum'  => $self->custnum,
3617     'pkgpart'  => $pkgpart,
3618     'quantity' => 1,
3619   } );
3620
3621   my $error = $cust_pkg->insert;
3622   $error ? $error : $cust_pkg;
3623 }
3624
3625 =item num_cust_attachment_deleted
3626
3627 Returns the number of deleted attachments for this customer (see
3628 L<FS::num_cust_attachment>).
3629
3630 =cut
3631
3632 sub num_cust_attachments_deleted {
3633   my $self = shift;
3634   $self->scalar_sql(
3635     " SELECT COUNT(*) FROM cust_attachment ".
3636       " WHERE custnum = ? AND disabled IS NOT NULL AND disabled > 0",
3637     $self->custnum
3638   );
3639 }
3640
3641 =item max_invnum
3642
3643 Returns the most recent invnum (invoice number) for this customer.
3644
3645 =cut
3646
3647 sub max_invnum {
3648   my $self = shift;
3649   $self->scalar_sql(
3650     " SELECT MAX(invnum) FROM cust_bill WHERE custnum = ?",
3651     $self->custnum
3652   );
3653 }
3654
3655 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3656
3657 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3658
3659 Optionally, a list or hashref of additional arguments to the qsearch call can
3660 be passed.
3661
3662 =cut
3663
3664 sub cust_bill {
3665   my $self = shift;
3666   my $opt = ref($_[0]) ? shift : { @_ };
3667
3668   #return $self->num_cust_bill unless wantarray || keys %$opt;
3669
3670   $opt->{'table'} = 'cust_bill';
3671   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3672   $opt->{'hashref'}{'custnum'} = $self->custnum;
3673   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3674
3675   map { $_ } #behavior of sort undefined in scalar context
3676     sort { $a->_date <=> $b->_date }
3677       qsearch($opt);
3678 }
3679
3680 =item open_cust_bill
3681
3682 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3683 customer.
3684
3685 =cut
3686
3687 sub open_cust_bill {
3688   my $self = shift;
3689
3690   $self->cust_bill(
3691     'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3692     #@_
3693   );
3694
3695 }
3696
3697 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3698
3699 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3700
3701 =cut
3702
3703 sub legacy_cust_bill {
3704   my $self = shift;
3705
3706   #return $self->num_legacy_cust_bill unless wantarray;
3707
3708   map { $_ } #behavior of sort undefined in scalar context
3709     sort { $a->_date <=> $b->_date }
3710       qsearch({ 'table'    => 'legacy_cust_bill',
3711                 'hashref'  => { 'custnum' => $self->custnum, },
3712                 'order_by' => 'ORDER BY _date ASC',
3713              });
3714 }
3715
3716 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3717
3718 Returns all the statements (see L<FS::cust_statement>) for this customer.
3719
3720 Optionally, a list or hashref of additional arguments to the qsearch call can
3721 be passed.
3722
3723 =cut
3724
3725 =item cust_bill_void
3726
3727 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3728
3729 =cut
3730
3731 sub cust_bill_void {
3732   my $self = shift;
3733
3734   map { $_ } #return $self->num_cust_bill_void unless wantarray;
3735   sort { $a->_date <=> $b->_date }
3736     qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3737 }
3738
3739 sub cust_statement {
3740   my $self = shift;
3741   my $opt = ref($_[0]) ? shift : { @_ };
3742
3743   #return $self->num_cust_statement unless wantarray || keys %$opt;
3744
3745   $opt->{'table'} = 'cust_statement';
3746   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3747   $opt->{'hashref'}{'custnum'} = $self->custnum;
3748   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3749
3750   map { $_ } #behavior of sort undefined in scalar context
3751     sort { $a->_date <=> $b->_date }
3752       qsearch($opt);
3753 }
3754
3755 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3756
3757 Returns all services of type SVCDB (such as 'svc_acct') for this customer.  
3758
3759 Optionally, a list or hashref of additional arguments to the qsearch call can 
3760 be passed following the SVCDB.
3761
3762 =cut
3763
3764 sub svc_x {
3765   my $self = shift;
3766   my $svcdb = shift;
3767   if ( ! $svcdb =~ /^svc_\w+$/ ) {
3768     warn "$me svc_x requires a svcdb";
3769     return;
3770   }
3771   my $opt = ref($_[0]) ? shift : { @_ };
3772
3773   $opt->{'table'} = $svcdb;
3774   $opt->{'addl_from'} = 
3775     'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3776     ($opt->{'addl_from'} || '');
3777
3778   my $custnum = $self->custnum;
3779   $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3780   my $where = "cust_pkg.custnum = $custnum";
3781
3782   my $extra_sql = $opt->{'extra_sql'} || '';
3783   if ( keys %{ $opt->{'hashref'} } ) {
3784     $extra_sql = " AND $where $extra_sql";
3785   }
3786   else {
3787     if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3788       $extra_sql = "WHERE $where AND $1";
3789     }
3790     else {
3791       $extra_sql = "WHERE $where $extra_sql";
3792     }
3793   }
3794   $opt->{'extra_sql'} = $extra_sql;
3795
3796   qsearch($opt);
3797 }
3798
3799 # required for use as an eventtable; 
3800 sub svc_acct {
3801   my $self = shift;
3802   $self->svc_x('svc_acct', @_);
3803 }
3804
3805 =item cust_credit
3806
3807 Returns all the credits (see L<FS::cust_credit>) for this customer.
3808
3809 =cut
3810
3811 sub cust_credit {
3812   my $self = shift;
3813
3814   #return $self->num_cust_credit unless wantarray;
3815
3816   map { $_ } #behavior of sort undefined in scalar context
3817     sort { $a->_date <=> $b->_date }
3818       qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3819 }
3820
3821 =item cust_credit_pkgnum
3822
3823 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3824 package when using experimental package balances.
3825
3826 =cut
3827
3828 sub cust_credit_pkgnum {
3829   my( $self, $pkgnum ) = @_;
3830   map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3831   sort { $a->_date <=> $b->_date }
3832     qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3833                               'pkgnum'  => $pkgnum,
3834                             }
3835     );
3836 }
3837
3838 =item cust_credit_void
3839
3840 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3841
3842 =cut
3843
3844 sub cust_credit_void {
3845   my $self = shift;
3846   map { $_ }
3847   sort { $a->_date <=> $b->_date }
3848     qsearch( 'cust_credit_void', { 'custnum' => $self->custnu