2 use base qw( FS::cust_main::Packages
4 FS::cust_main::NationalID
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
14 FS::otaker_Mixin FS::cust_main_Mixin
15 FS::geocode_Mixin FS::Quotable_Mixin FS::Sales_Mixin
24 use Scalar::Util qw( blessed );
25 use List::Util qw(min);
27 use File::Temp; #qw( tempfile );
29 use Time::Local qw(timelocal);
33 use Business::CreditCard 0.28;
34 use FS::UID qw( dbh driver_name );
35 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
37 use FS::Misc qw( generate_ps do_print money_pretty card_types );
38 use FS::Msgcat qw(gettext);
45 use FS::cust_bill_void;
46 use FS::legacy_cust_bill;
48 use FS::cust_pay_pending;
49 use FS::cust_pay_void;
50 use FS::cust_pay_batch;
53 use FS::part_referral;
54 use FS::cust_main_county;
55 use FS::cust_location;
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;
64 use FS::prepay_credit;
70 use FS::payment_gateway;
71 use FS::agent_payment_gateway;
73 use FS::cust_main_note;
74 use FS::cust_attachment;
77 use FS::upgrade_journal;
83 # 1 is mostly method/subroutine entry and options
84 # 2 traces progress of some operations
85 # 3 is even more information including possibly sensitive data
87 our $me = '[FS::cust_main]';
90 our $ignore_expired_card = 0;
91 our $ignore_banned_card = 0;
92 our $ignore_invalid_card = 0;
94 our $skip_fuzzyfiles = 0;
96 our $ucfirst_nowarn = 0;
98 #this info is in cust_payby as of 4.x
99 #this and the fields themselves can be removed in 5.x
100 our @encrypted_fields = ('payinfo', 'paycvv');
101 sub nohistory_fields { ('payinfo', 'paycvv'); }
104 our $default_agent_custid;
105 our $custnum_display_length;
106 #ask FS::UID to run this stuff for us later
107 #$FS::UID::callback{'FS::cust_main'} = sub {
108 install_callback FS::UID sub {
109 $conf = new FS::Conf;
110 $ignore_invalid_card = $conf->exists('allow_invalid_cards');
111 $default_agent_custid = $conf->exists('cust_main-default_agent_custid');
112 $custnum_display_length = $conf->config('cust_main-custnum-display_length');
117 my ( $hashref, $cache ) = @_;
118 if ( exists $hashref->{'pkgnum'} ) {
119 #@{ $self->{'_pkgnum'} } = ();
120 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
121 $self->{'_pkgnum'} = $subcache;
122 #push @{ $self->{'_pkgnum'} },
123 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
129 FS::cust_main - Object methods for cust_main records
135 $record = new FS::cust_main \%hash;
136 $record = new FS::cust_main { 'column' => 'value' };
138 $error = $record->insert;
140 $error = $new_record->replace($old_record);
142 $error = $record->delete;
144 $error = $record->check;
146 @cust_pkg = $record->all_pkgs;
148 @cust_pkg = $record->ncancelled_pkgs;
150 @cust_pkg = $record->suspended_pkgs;
152 $error = $record->bill;
153 $error = $record->bill %options;
154 $error = $record->bill 'time' => $time;
156 $error = $record->collect;
157 $error = $record->collect %options;
158 $error = $record->collect 'invoice_time' => $time,
163 An FS::cust_main object represents a customer. FS::cust_main inherits from
164 FS::Record. The following fields are currently supported:
170 Primary key (assigned automatically for new customers)
174 Agent (see L<FS::agent>)
178 Advertising source (see L<FS::part_referral>)
190 Cocial security number (optional)
214 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
218 Payment Information (See L<FS::payinfo_Mixin> for data format)
222 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
226 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
230 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
234 Start date month (maestro/solo cards only)
238 Start date year (maestro/solo cards only)
242 Issue number (maestro/solo cards only)
246 Name on card or billing name
250 IP address from which payment information was received
254 Tax exempt, empty or `Y'
258 Order taker (see L<FS::access_user>)
264 =item referral_custnum
266 Referring customer number
270 Enable individual CDR spooling, empty or `Y'
274 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
278 Discourage individual CDR printing, empty or `Y'
282 Allow self-service editing of ticket subjects, empty or 'Y'
284 =item calling_list_exempt
286 Do not call, empty or 'Y'
288 =item invoice_ship_address
290 Display ship_address ("Service address") on invoices for this customer, empty or 'Y'
300 Creates a new customer. To add the customer to the database, see L<"insert">.
302 Note that this stores the hash reference, not a distinct copy of the hash it
303 points to. You can ask the object for a copy with the I<hash> method.
307 sub table { 'cust_main'; }
309 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
311 Adds this customer to the database. If there is an error, returns the error,
312 otherwise returns false.
314 Usually the customer's location will not yet exist in the database, and
315 the C<bill_location> and C<ship_location> pseudo-fields must be set to
316 uninserted L<FS::cust_location> objects. These will be inserted and linked
317 (in both directions) to the new customer record. If they're references
318 to the same object, they will become the same location.
320 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
321 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
322 are inserted atomicly, or the transaction is rolled back. Passing an empty
323 hash reference is equivalent to not supplying this parameter. There should be
324 a better explanation of this, but until then, here's an example:
327 tie %hash, 'Tie::RefHash'; #this part is important
329 $cust_pkg => [ $svc_acct ],
332 $cust_main->insert( \%hash );
334 INVOICING_LIST_ARYREF: No longer supported.
336 Currently available options are: I<depend_jobnum>, I<noexport>,
337 I<tax_exemption>, I<prospectnum>, I<contact> and I<contact_params>.
339 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
340 on the supplied jobnum (they will not run until the specific job completes).
341 This can be used to defer provisioning until some action completes (such
342 as running the customer's credit card successfully).
344 The I<noexport> option is deprecated. If I<noexport> is set true, no
345 provisioning jobs (exports) are scheduled. (You can schedule them later with
346 the B<reexport> method.)
348 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
349 of tax names and exemption numbers. FS::cust_main_exemption records will be
350 created and inserted.
352 If I<prospectnum> is set, moves contacts and locations from that prospect.
354 If I<contact> is set to an arrayref of FS::contact objects, those will be
357 If I<contact_params> is set to a hashref of CGI parameters (and I<contact> is
358 unset), inserts those new contacts with this new customer. Handles CGI
359 paramaters for an "m2" multiple entry field as passed by edit/cust_main.cgi
361 If I<cust_payby_params> is set to a hashref o fCGI parameters, inserts those
362 new stored payment records with this new customer. Handles CGI parameters
363 for an "m2" multiple entry field as passed by edit/cust_main.cgi
369 my $cust_pkgs = @_ ? shift : {};
371 if ( $_[0] and ref($_[0]) eq 'ARRAY' ) {
372 warn "cust_main::insert using deprecated invoicing list argument";
373 $invoicing_list = shift;
376 warn "$me insert called with options ".
377 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
380 return "You are not permitted to change customer invoicing terms."
381 if $self->invoice_terms #i.e. not the default
382 && ! $FS::CurrentUser::CurrentUser->access_right('Edit customer invoice terms');
384 local $SIG{HUP} = 'IGNORE';
385 local $SIG{INT} = 'IGNORE';
386 local $SIG{QUIT} = 'IGNORE';
387 local $SIG{TERM} = 'IGNORE';
388 local $SIG{TSTP} = 'IGNORE';
389 local $SIG{PIPE} = 'IGNORE';
391 my $oldAutoCommit = $FS::UID::AutoCommit;
392 local $FS::UID::AutoCommit = 0;
395 my $prepay_identifier = '';
396 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
398 if ( $self->payby eq 'PREPAY' ) {
400 $self->payby(''); #'BILL');
401 $prepay_identifier = $self->payinfo;
404 warn " looking up prepaid card $prepay_identifier\n"
407 my $error = $self->get_prepay( $prepay_identifier,
408 'amount_ref' => \$amount,
409 'seconds_ref' => \$seconds,
410 'upbytes_ref' => \$upbytes,
411 'downbytes_ref' => \$downbytes,
412 'totalbytes_ref' => \$totalbytes,
415 $dbh->rollback if $oldAutoCommit;
416 #return "error applying prepaid card (transaction rolled back): $error";
420 $payby = 'PREP' if $amount;
422 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD|MCHK|PPAL)$/ ) {
425 $self->payby(''); #'BILL');
426 $amount = $self->paid;
431 foreach my $l (qw(bill_location ship_location)) {
433 my $loc = delete $self->hashref->{$l} or next;
435 if ( !$loc->locationnum ) {
436 # warn the location that we're going to insert it with no custnum
437 $loc->set(custnum_pending => 1);
438 warn " inserting $l\n"
440 my $error = $loc->insert;
442 $dbh->rollback if $oldAutoCommit;
443 my $label = $l eq 'ship_location' ? 'service' : 'billing';
444 return "$error (in $label location)";
447 } elsif ( $loc->prospectnum ) {
449 $loc->prospectnum('');
450 $loc->set(custnum_pending => 1);
451 my $error = $loc->replace;
453 $dbh->rollback if $oldAutoCommit;
454 my $label = $l eq 'ship_location' ? 'service' : 'billing';
455 return "$error (moving $label location)";
458 } elsif ( ($loc->custnum || 0) > 0 ) {
459 # then it somehow belongs to another customer--shouldn't happen
460 $dbh->rollback if $oldAutoCommit;
461 return "$l belongs to customer ".$loc->custnum;
463 # else it already belongs to this customer
464 # (happens when ship_location is identical to bill_location)
466 $self->set($l.'num', $loc->locationnum);
468 if ( $self->get($l.'num') eq '' ) {
469 $dbh->rollback if $oldAutoCommit;
474 warn " inserting $self\n"
477 $self->signupdate(time) unless $self->signupdate;
479 $self->auto_agent_custid()
480 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
482 my $error = $self->check_payinfo_cardtype
483 || $self->SUPER::insert;
485 $dbh->rollback if $oldAutoCommit;
486 #return "inserting cust_main record (transaction rolled back): $error";
490 # now set cust_location.custnum
491 foreach my $l (qw(bill_location ship_location)) {
492 warn " setting $l.custnum\n"
494 my $loc = $self->$l or next;
495 unless ( $loc->custnum ) {
496 $loc->set(custnum => $self->custnum);
497 $error ||= $loc->replace;
501 $dbh->rollback if $oldAutoCommit;
502 return "error setting $l custnum: $error";
506 warn " setting customer tags\n"
509 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
510 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
511 'custnum' => $self->custnum };
512 my $error = $cust_tag->insert;
514 $dbh->rollback if $oldAutoCommit;
519 my $prospectnum = delete $options{'prospectnum'};
520 if ( $prospectnum ) {
522 warn " moving contacts and locations from prospect $prospectnum\n"
526 qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
527 unless ( $prospect_main ) {
528 $dbh->rollback if $oldAutoCommit;
529 return "Unknown prospectnum $prospectnum";
531 $prospect_main->custnum($self->custnum);
532 $prospect_main->disabled('Y');
533 my $error = $prospect_main->replace;
535 $dbh->rollback if $oldAutoCommit;
539 foreach my $prospect_contact ( $prospect_main->prospect_contact ) {
540 my $cust_contact = new FS::cust_contact {
541 'custnum' => $self->custnum,
542 'invoice_dest' => 'Y', # invoice_dest currently not set for prospect contacts
543 map { $_ => $prospect_contact->$_() } qw( contactnum classnum comment )
545 my $error = $cust_contact->insert
546 || $prospect_contact->delete;
548 $dbh->rollback if $oldAutoCommit;
553 my @cust_location = $prospect_main->cust_location;
554 my @qual = $prospect_main->qual;
556 foreach my $r ( @cust_location, @qual ) {
558 $r->custnum($self->custnum);
559 my $error = $r->replace;
561 $dbh->rollback if $oldAutoCommit;
565 # since we set invoice_dest on all migrated prospect contacts (for now),
566 # don't process invoicing_list.
567 delete $options{'invoicing_list'};
568 $invoicing_list = undef;
571 warn " setting contacts\n"
574 $invoicing_list ||= $options{'invoicing_list'};
575 if ( $invoicing_list ) {
577 $invoicing_list = [ $invoicing_list ] if !ref($invoicing_list);
580 foreach my $dest (@$invoicing_list ) {
581 if ($dest eq 'POST') {
582 $self->set('postal_invoice', 'Y');
585 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
586 if ( $contact_email ) {
587 my $cust_contact = FS::cust_contact->new({
588 contactnum => $contact_email->contactnum,
589 custnum => $self->custnum,
591 $cust_contact->set('invoice_dest', 'Y');
592 my $error = $cust_contact->insert;
594 $dbh->rollback if $oldAutoCommit;
595 return "$error (linking to email address $dest)";
599 # this email address is not yet linked to any contact
600 $email .= ',' if length($email);
608 my $contact = FS::contact->new({
609 'custnum' => $self->get('custnum'),
610 'last' => $self->get('last'),
611 'first' => $self->get('first'),
612 'emailaddress' => $email,
613 'invoice_dest' => 'Y', # yes, you can set this via the contact
615 my $error = $contact->insert;
617 $dbh->rollback if $oldAutoCommit;
625 if ( my $contact = delete $options{'contact'} ) {
627 foreach my $c ( @$contact ) {
628 $c->custnum($self->custnum);
629 my $error = $c->insert;
631 $dbh->rollback if $oldAutoCommit;
637 } elsif ( my $contact_params = delete $options{'contact_params'} ) {
639 my $error = $self->process_o2m( 'table' => 'contact',
640 'fields' => FS::contact->cgi_contact_fields,
641 'params' => $contact_params,
644 $dbh->rollback if $oldAutoCommit;
649 warn " setting cust_payby\n"
652 if ( $options{cust_payby} ) {
654 foreach my $cust_payby ( @{ $options{cust_payby} } ) {
655 $cust_payby->custnum($self->custnum);
656 my $error = $cust_payby->insert;
658 $dbh->rollback if $oldAutoCommit;
663 } elsif ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
665 my $error = $self->process_o2m(
666 'table' => 'cust_payby',
667 'fields' => FS::cust_payby->cgi_cust_payby_fields,
668 'params' => $cust_payby_params,
669 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
672 $dbh->rollback if $oldAutoCommit;
678 warn " setting cust_main_exemption\n"
681 my $tax_exemption = delete $options{'tax_exemption'};
682 if ( $tax_exemption ) {
684 $tax_exemption = { map { $_ => '' } @$tax_exemption }
685 if ref($tax_exemption) eq 'ARRAY';
687 foreach my $taxname ( keys %$tax_exemption ) {
688 my $cust_main_exemption = new FS::cust_main_exemption {
689 'custnum' => $self->custnum,
690 'taxname' => $taxname,
691 'exempt_number' => $tax_exemption->{$taxname},
693 my $error = $cust_main_exemption->insert;
695 $dbh->rollback if $oldAutoCommit;
696 return "inserting cust_main_exemption (transaction rolled back): $error";
701 warn " ordering packages\n"
704 $error = $self->order_pkgs( $cust_pkgs,
706 'seconds_ref' => \$seconds,
707 'upbytes_ref' => \$upbytes,
708 'downbytes_ref' => \$downbytes,
709 'totalbytes_ref' => \$totalbytes,
712 $dbh->rollback if $oldAutoCommit;
717 $dbh->rollback if $oldAutoCommit;
718 return "No svc_acct record to apply pre-paid time";
720 if ( $upbytes || $downbytes || $totalbytes ) {
721 $dbh->rollback if $oldAutoCommit;
722 return "No svc_acct record to apply pre-paid data";
726 warn " inserting initial $payby payment of $amount\n"
728 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
730 $dbh->rollback if $oldAutoCommit;
731 return "inserting payment (transaction rolled back): $error";
735 unless ( $import || $skip_fuzzyfiles ) {
736 warn " queueing fuzzyfiles update\n"
738 $error = $self->queue_fuzzyfiles_update;
740 $dbh->rollback if $oldAutoCommit;
741 return "updating fuzzy search cache: $error";
745 # FS::geocode_Mixin::after_insert or something?
746 if ( $conf->config('tax_district_method') and !$import ) {
747 # if anything non-empty, try to look it up
748 my $queue = new FS::queue {
749 'job' => 'FS::geocode_Mixin::process_district_update',
750 'custnum' => $self->custnum,
752 my $error = $queue->insert( ref($self), $self->custnum );
754 $dbh->rollback if $oldAutoCommit;
755 return "queueing tax district update: $error";
760 warn " exporting\n" if $DEBUG > 1;
762 my $export_args = $options{'export_args'} || [];
765 map qsearch( 'part_export', {exportnum=>$_} ),
766 $conf->config('cust_main-exports'); #, $agentnum
768 foreach my $part_export ( @part_export ) {
769 my $error = $part_export->export_insert($self, @$export_args);
771 $dbh->rollback if $oldAutoCommit;
772 return "exporting to ". $part_export->exporttype.
773 " (transaction rolled back): $error";
777 #foreach my $depend_jobnum ( @$depend_jobnums ) {
778 # warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
780 # foreach my $jobnum ( @jobnums ) {
781 # my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
782 # warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
784 # my $error = $queue->depend_insert($depend_jobnum);
786 # $dbh->rollback if $oldAutoCommit;
787 # return "error queuing job dependancy: $error";
794 #if ( exists $options{'jobnums'} ) {
795 # push @{ $options{'jobnums'} }, @jobnums;
798 warn " insert complete; committing transaction\n"
801 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
806 use File::CounterFile;
807 sub auto_agent_custid {
810 my $format = $conf->config('cust_main-auto_agent_custid');
812 if ( $format eq '1YMMXXXXXXXX' ) {
814 my $counter = new File::CounterFile 'cust_main.agent_custid';
817 my $ym = 100000000000 + time2str('%y%m00000000', time);
818 if ( $ym > $counter->value ) {
819 $counter->{'value'} = $agent_custid = $ym;
820 $counter->{'updated'} = 1;
822 $agent_custid = $counter->inc;
828 die "Unknown cust_main-auto_agent_custid format: $format";
831 $self->agent_custid($agent_custid);
835 =item PACKAGE METHODS
837 Documentation on customer package methods has been moved to
838 L<FS::cust_main::Packages>.
840 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
842 Recharges this (existing) customer with the specified prepaid card (see
843 L<FS::prepay_credit>), specified either by I<identifier> or as an
844 FS::prepay_credit object. If there is an error, returns the error, otherwise
847 Optionally, five scalar references can be passed as well. They will have their
848 values filled in with the amount, number of seconds, and number of upload,
849 download, and total bytes applied by this prepaid card.
853 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
854 #the only place that uses these args
855 sub recharge_prepay {
856 my( $self, $prepay_credit, $amountref, $secondsref,
857 $upbytesref, $downbytesref, $totalbytesref ) = @_;
859 local $SIG{HUP} = 'IGNORE';
860 local $SIG{INT} = 'IGNORE';
861 local $SIG{QUIT} = 'IGNORE';
862 local $SIG{TERM} = 'IGNORE';
863 local $SIG{TSTP} = 'IGNORE';
864 local $SIG{PIPE} = 'IGNORE';
866 my $oldAutoCommit = $FS::UID::AutoCommit;
867 local $FS::UID::AutoCommit = 0;
870 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
872 my $error = $self->get_prepay( $prepay_credit,
873 'amount_ref' => \$amount,
874 'seconds_ref' => \$seconds,
875 'upbytes_ref' => \$upbytes,
876 'downbytes_ref' => \$downbytes,
877 'totalbytes_ref' => \$totalbytes,
879 || $self->increment_seconds($seconds)
880 || $self->increment_upbytes($upbytes)
881 || $self->increment_downbytes($downbytes)
882 || $self->increment_totalbytes($totalbytes)
883 || $self->insert_cust_pay_prepay( $amount,
885 ? $prepay_credit->identifier
890 $dbh->rollback if $oldAutoCommit;
894 if ( defined($amountref) ) { $$amountref = $amount; }
895 if ( defined($secondsref) ) { $$secondsref = $seconds; }
896 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
897 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
898 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
900 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
905 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
907 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
908 specified either by I<identifier> or as an FS::prepay_credit object.
910 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
911 incremented by the values of the prepaid card.
913 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
914 check or set this customer's I<agentnum>.
916 If there is an error, returns the error, otherwise returns false.
922 my( $self, $prepay_credit, %opt ) = @_;
924 local $SIG{HUP} = 'IGNORE';
925 local $SIG{INT} = 'IGNORE';
926 local $SIG{QUIT} = 'IGNORE';
927 local $SIG{TERM} = 'IGNORE';
928 local $SIG{TSTP} = 'IGNORE';
929 local $SIG{PIPE} = 'IGNORE';
931 my $oldAutoCommit = $FS::UID::AutoCommit;
932 local $FS::UID::AutoCommit = 0;
935 unless ( ref($prepay_credit) ) {
937 my $identifier = $prepay_credit;
939 $prepay_credit = qsearchs(
941 { 'identifier' => $identifier },
946 unless ( $prepay_credit ) {
947 $dbh->rollback if $oldAutoCommit;
948 return "Invalid prepaid card: ". $identifier;
953 if ( $prepay_credit->agentnum ) {
954 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
955 $dbh->rollback if $oldAutoCommit;
956 return "prepaid card not valid for agent ". $self->agentnum;
958 $self->agentnum($prepay_credit->agentnum);
961 my $error = $prepay_credit->delete;
963 $dbh->rollback if $oldAutoCommit;
964 return "removing prepay_credit (transaction rolled back): $error";
967 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
968 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
970 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
975 =item increment_upbytes SECONDS
977 Updates this customer's single or primary account (see L<FS::svc_acct>) by
978 the specified number of upbytes. If there is an error, returns the error,
979 otherwise returns false.
983 sub increment_upbytes {
984 _increment_column( shift, 'upbytes', @_);
987 =item increment_downbytes SECONDS
989 Updates this customer's single or primary account (see L<FS::svc_acct>) by
990 the specified number of downbytes. If there is an error, returns the error,
991 otherwise returns false.
995 sub increment_downbytes {
996 _increment_column( shift, 'downbytes', @_);
999 =item increment_totalbytes SECONDS
1001 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1002 the specified number of totalbytes. If there is an error, returns the error,
1003 otherwise returns false.
1007 sub increment_totalbytes {
1008 _increment_column( shift, 'totalbytes', @_);
1011 =item increment_seconds SECONDS
1013 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1014 the specified number of seconds. If there is an error, returns the error,
1015 otherwise returns false.
1019 sub increment_seconds {
1020 _increment_column( shift, 'seconds', @_);
1023 =item _increment_column AMOUNT
1025 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1026 the specified number of seconds or bytes. If there is an error, returns
1027 the error, otherwise returns false.
1031 sub _increment_column {
1032 my( $self, $column, $amount ) = @_;
1033 warn "$me increment_column called: $column, $amount\n"
1036 return '' unless $amount;
1038 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1039 $self->ncancelled_pkgs;
1041 if ( ! @cust_pkg ) {
1042 return 'No packages with primary or single services found'.
1043 ' to apply pre-paid time';
1044 } elsif ( scalar(@cust_pkg) > 1 ) {
1045 #maybe have a way to specify the package/account?
1046 return 'Multiple packages found to apply pre-paid time';
1049 my $cust_pkg = $cust_pkg[0];
1050 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1054 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1056 if ( ! @cust_svc ) {
1057 return 'No account found to apply pre-paid time';
1058 } elsif ( scalar(@cust_svc) > 1 ) {
1059 return 'Multiple accounts found to apply pre-paid time';
1062 my $svc_acct = $cust_svc[0]->svc_x;
1063 warn " found service svcnum ". $svc_acct->pkgnum.
1064 ' ('. $svc_acct->email. ")\n"
1067 $column = "increment_$column";
1068 $svc_acct->$column($amount);
1072 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1074 Inserts a prepayment in the specified amount for this customer. An optional
1075 second argument can specify the prepayment identifier for tracking purposes.
1076 If there is an error, returns the error, otherwise returns false.
1080 sub insert_cust_pay_prepay {
1081 shift->insert_cust_pay('PREP', @_);
1084 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1086 Inserts a cash payment in the specified amount for this customer. An optional
1087 second argument can specify the payment identifier for tracking purposes.
1088 If there is an error, returns the error, otherwise returns false.
1092 sub insert_cust_pay_cash {
1093 shift->insert_cust_pay('CASH', @_);
1096 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1098 Inserts a Western Union payment in the specified amount for this customer. An
1099 optional second argument can specify the prepayment identifier for tracking
1100 purposes. If there is an error, returns the error, otherwise returns false.
1104 sub insert_cust_pay_west {
1105 shift->insert_cust_pay('WEST', @_);
1108 sub insert_cust_pay {
1109 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1110 my $payinfo = scalar(@_) ? shift : '';
1112 my $cust_pay = new FS::cust_pay {
1113 'custnum' => $self->custnum,
1114 'paid' => sprintf('%.2f', $amount),
1115 #'_date' => #date the prepaid card was purchased???
1117 'payinfo' => $payinfo,
1123 =item delete [ OPTION => VALUE ... ]
1125 This deletes the customer. If there is an error, returns the error, otherwise
1128 This will completely remove all traces of the customer record. This is not
1129 what you want when a customer cancels service; for that, cancel all of the
1130 customer's packages (see L</cancel>).
1132 If the customer has any uncancelled packages, you need to pass a new (valid)
1133 customer number for those packages to be transferred to, as the "new_customer"
1134 option. Cancelled packages will be deleted. Did I mention that this is NOT
1135 what you want when a customer cancels service and that you really should be
1136 looking at L<FS::cust_pkg/cancel>?
1138 You can't delete a customer with invoices (see L<FS::cust_bill>),
1139 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1140 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1141 set the "delete_financials" option to a true value.
1146 my( $self, %opt ) = @_;
1148 local $SIG{HUP} = 'IGNORE';
1149 local $SIG{INT} = 'IGNORE';
1150 local $SIG{QUIT} = 'IGNORE';
1151 local $SIG{TERM} = 'IGNORE';
1152 local $SIG{TSTP} = 'IGNORE';
1153 local $SIG{PIPE} = 'IGNORE';
1155 my $oldAutoCommit = $FS::UID::AutoCommit;
1156 local $FS::UID::AutoCommit = 0;
1159 if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1160 $dbh->rollback if $oldAutoCommit;
1161 return "Can't delete a master agent customer";
1164 #use FS::access_user
1165 if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1166 $dbh->rollback if $oldAutoCommit;
1167 return "Can't delete a master employee customer";
1170 tie my %financial_tables, 'Tie::IxHash',
1171 'cust_bill' => 'invoices',
1172 'cust_statement' => 'statements',
1173 'cust_credit' => 'credits',
1174 'cust_pay' => 'payments',
1175 'cust_refund' => 'refunds',
1178 foreach my $table ( keys %financial_tables ) {
1180 my @records = $self->$table();
1182 if ( @records && ! $opt{'delete_financials'} ) {
1183 $dbh->rollback if $oldAutoCommit;
1184 return "Can't delete a customer with ". $financial_tables{$table};
1187 foreach my $record ( @records ) {
1188 my $error = $record->delete;
1190 $dbh->rollback if $oldAutoCommit;
1191 return "Error deleting ". $financial_tables{$table}. ": $error\n";
1197 my @cust_pkg = $self->ncancelled_pkgs;
1199 my $new_custnum = $opt{'new_custnum'};
1200 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1201 $dbh->rollback if $oldAutoCommit;
1202 return "Invalid new customer number: $new_custnum";
1204 foreach my $cust_pkg ( @cust_pkg ) {
1205 my %hash = $cust_pkg->hash;
1206 $hash{'custnum'} = $new_custnum;
1207 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1208 my $error = $new_cust_pkg->replace($cust_pkg,
1209 options => { $cust_pkg->options },
1212 $dbh->rollback if $oldAutoCommit;
1217 my @cancelled_cust_pkg = $self->all_pkgs;
1218 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1219 my $error = $cust_pkg->delete;
1221 $dbh->rollback if $oldAutoCommit;
1226 #cust_tax_adjustment in financials?
1227 #cust_pay_pending? ouch
1228 foreach my $table (qw(
1229 cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1230 cust_payby cust_location cust_main_note cust_tax_adjustment
1231 cust_pay_void cust_pay_batch queue cust_tax_exempt
1233 foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1234 my $error = $record->delete;
1236 $dbh->rollback if $oldAutoCommit;
1242 my $sth = $dbh->prepare(
1243 'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1245 my $errstr = $dbh->errstr;
1246 $dbh->rollback if $oldAutoCommit;
1249 $sth->execute($self->custnum) or do {
1250 my $errstr = $sth->errstr;
1251 $dbh->rollback if $oldAutoCommit;
1257 my $ticket_dbh = '';
1258 if ($conf->config('ticket_system') eq 'RT_Internal') {
1260 } elsif ($conf->config('ticket_system') eq 'RT_External') {
1261 my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1262 $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1263 #or die "RT_External DBI->connect error: $DBI::errstr\n";
1266 if ( $ticket_dbh ) {
1268 my $ticket_sth = $ticket_dbh->prepare(
1269 'DELETE FROM Links WHERE Target = ?'
1271 my $errstr = $ticket_dbh->errstr;
1272 $dbh->rollback if $oldAutoCommit;
1275 $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1277 my $errstr = $ticket_sth->errstr;
1278 $dbh->rollback if $oldAutoCommit;
1282 #check and see if the customer is the only link on the ticket, and
1283 #if so, set the ticket to deleted status in RT?
1284 #maybe someday, for now this will at least fix tickets not displaying
1288 #delete the customer record
1290 my $error = $self->SUPER::delete;
1292 $dbh->rollback if $oldAutoCommit;
1296 # cust_main exports!
1298 #my $export_args = $options{'export_args'} || [];
1301 map qsearch( 'part_export', {exportnum=>$_} ),
1302 $conf->config('cust_main-exports'); #, $agentnum
1304 foreach my $part_export ( @part_export ) {
1305 my $error = $part_export->export_delete( $self ); #, @$export_args);
1307 $dbh->rollback if $oldAutoCommit;
1308 return "exporting to ". $part_export->exporttype.
1309 " (transaction rolled back): $error";
1313 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1318 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1320 Replaces the OLD_RECORD with this one in the database. If there is an error,
1321 returns the error, otherwise returns false.
1323 To change the customer's address, set the pseudo-fields C<bill_location> and
1324 C<ship_location>. The address will still only change if at least one of the
1325 address fields differs from the existing values.
1327 INVOICING_LIST_ARYREF: If you pass an arrayref to this method, it will be
1328 set as the contact email address for a default contact with the same name as
1331 Currently available options are: I<tax_exemption>, I<cust_payby_params>,
1332 I<contact_params>, I<invoicing_list>, and I<move_pkgs>.
1334 The I<tax_exemption> option can be set to an arrayref of tax names or a hashref
1335 of tax names and exemption numbers. FS::cust_main_exemption records will be
1336 deleted and inserted as appropriate.
1338 I<cust_payby_params> and I<contact_params> can be hashrefs of named parameter
1339 groups (describing the customer's payment methods and contacts, respectively)
1340 in the style supported by L<FS::o2m_Common/process_o2m>. See L<FS::cust_payby>
1341 and L<FS::contact> for the fields these can contain.
1343 I<invoicing_list> is a synonym for the INVOICING_LIST_ARYREF parameter, and
1344 should be used instead if possible.
1346 If I<move_pkgs> is an arrayref, it will override the list of packages
1347 to be moved to the new address (see L<FS::cust_location/move_pkgs>.)
1354 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1356 : $self->replace_old;
1360 warn "$me replace called\n"
1363 my $curuser = $FS::CurrentUser::CurrentUser;
1364 return "You are not permitted to create complimentary accounts."
1365 if $self->complimentary eq 'Y'
1366 && $self->complimentary ne $old->complimentary
1367 && ! $curuser->access_right('Complimentary customer');
1369 local($ignore_expired_card) = 1
1370 if $old->payby =~ /^(CARD|DCRD)$/
1371 && $self->payby =~ /^(CARD|DCRD)$/
1372 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1374 local($ignore_banned_card) = 1
1375 if ( $old->payby =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1376 || $old->payby =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1377 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1379 if ( $self->payby =~ /^(CARD|DCRD)$/
1380 && $old->payinfo ne $self->payinfo
1381 && $old->paymask ne $self->paymask )
1383 my $error = $self->check_payinfo_cardtype;
1384 return $error if $error;
1387 return "Invoicing locale is required"
1390 && $conf->exists('cust_main-require_locale');
1392 return "You are not permitted to change customer invoicing terms."
1393 if $old->invoice_terms ne $self->invoice_terms
1394 && ! $curuser->access_right('Edit customer invoice terms');
1396 local $SIG{HUP} = 'IGNORE';
1397 local $SIG{INT} = 'IGNORE';
1398 local $SIG{QUIT} = 'IGNORE';
1399 local $SIG{TERM} = 'IGNORE';
1400 local $SIG{TSTP} = 'IGNORE';
1401 local $SIG{PIPE} = 'IGNORE';
1403 my $oldAutoCommit = $FS::UID::AutoCommit;
1404 local $FS::UID::AutoCommit = 0;
1407 for my $l (qw(bill_location ship_location)) {
1408 #my $old_loc = $old->$l;
1409 my $new_loc = $self->$l or next;
1411 # find the existing location if there is one
1412 $new_loc->set('custnum' => $self->custnum);
1413 my $error = $new_loc->find_or_insert;
1415 $dbh->rollback if $oldAutoCommit;
1418 $self->set($l.'num', $new_loc->locationnum);
1422 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1423 warn "cust_main::replace: using deprecated invoicing list argument";
1424 $invoicing_list = shift @param;
1427 my %options = @param;
1429 $invoicing_list ||= $options{invoicing_list};
1431 my @contacts = map { $_->contact } $self->cust_contact;
1432 # find a contact that matches the customer's name
1433 my ($implicit_contact) = grep { $_->first eq $old->get('first')
1434 and $_->last eq $old->get('last') }
1436 $implicit_contact ||= FS::contact->new({
1437 'custnum' => $self->custnum,
1438 'locationnum' => $self->get('bill_locationnum'),
1441 # for any of these that are already contact emails, link to the existing
1443 if ( $invoicing_list ) {
1446 # kind of like process_m2m on these, except:
1447 # - the other side is two tables in a join
1448 # - and we might have to create new contact_emails
1449 # - and possibly a new contact
1451 # Find existing invoice emails that aren't on the implicit contact.
1452 # Any of these that are not on the new invoicing list will be removed.
1453 my %old_email_cust_contact;
1454 foreach my $cust_contact ($self->cust_contact) {
1455 next if !$cust_contact->invoice_dest;
1456 next if $cust_contact->contactnum == ($implicit_contact->contactnum || 0);
1458 foreach my $contact_email ($cust_contact->contact->contact_email) {
1459 $old_email_cust_contact{ $contact_email->emailaddress } = $cust_contact;
1463 foreach my $dest (@$invoicing_list) {
1465 if ($dest eq 'POST') {
1467 $self->set('postal_invoice', 'Y');
1469 } elsif ( exists($old_email_cust_contact{$dest}) ) {
1471 delete $old_email_cust_contact{$dest}; # don't need to remove it, then
1475 # See if it belongs to some other contact; if so, link it.
1476 my $contact_email = qsearchs('contact_email', { emailaddress => $dest });
1478 and $contact_email->contactnum != ($implicit_contact->contactnum || 0) ) {
1479 my $cust_contact = qsearchs('cust_contact', {
1480 contactnum => $contact_email->contactnum,
1481 custnum => $self->custnum,
1482 }) || FS::cust_contact->new({
1483 contactnum => $contact_email->contactnum,
1484 custnum => $self->custnum,
1486 $cust_contact->set('invoice_dest', 'Y');
1487 my $error = $cust_contact->custcontactnum ?
1488 $cust_contact->replace : $cust_contact->insert;
1490 $dbh->rollback if $oldAutoCommit;
1491 return "$error (linking to email address $dest)";
1495 # This email address is not yet linked to any contact, so it will
1496 # be added to the implicit contact.
1497 $email .= ',' if length($email);
1503 foreach my $remove_dest (keys %old_email_cust_contact) {
1504 my $cust_contact = $old_email_cust_contact{$remove_dest};
1505 # These were not in the list of requested destinations, so take them off.
1506 $cust_contact->set('invoice_dest', '');
1507 my $error = $cust_contact->replace;
1509 $dbh->rollback if $oldAutoCommit;
1510 return "$error (unlinking email address $remove_dest)";
1514 # make sure it keeps up with the changed customer name, if any
1515 $implicit_contact->set('last', $self->get('last'));
1516 $implicit_contact->set('first', $self->get('first'));
1517 $implicit_contact->set('emailaddress', $email);
1518 $implicit_contact->set('invoice_dest', 'Y');
1519 $implicit_contact->set('custnum', $self->custnum);
1520 my $i_cust_contact =
1521 qsearchs('cust_contact', {
1522 contactnum => $implicit_contact->contactnum,
1523 custnum => $self->custnum,
1526 if ( $i_cust_contact ) {
1527 $implicit_contact->set($_, $i_cust_contact->$_)
1528 foreach qw( classnum selfservice_access comment );
1532 if ( $implicit_contact->contactnum ) {
1533 $error = $implicit_contact->replace;
1534 } elsif ( length($email) ) { # don't create a new contact if not needed
1535 $error = $implicit_contact->insert;
1539 $dbh->rollback if $oldAutoCommit;
1540 return "$error (adding email address $email)";
1545 # replace the customer record
1546 my $error = $self->SUPER::replace($old);
1549 $dbh->rollback if $oldAutoCommit;
1553 # now move packages to the new service location
1554 $self->set('ship_location', ''); #flush cache
1555 if ( $old->ship_locationnum and # should only be null during upgrade...
1556 $old->ship_locationnum != $self->ship_locationnum ) {
1557 $error = $old->ship_location->move_to($self->ship_location, move_pkgs => $options{'move_pkgs'});
1559 $dbh->rollback if $oldAutoCommit;
1563 # don't move packages based on the billing location, but
1564 # disable it if it's no longer in use
1565 if ( $old->bill_locationnum and
1566 $old->bill_locationnum != $self->bill_locationnum ) {
1567 $error = $old->bill_location->disable_if_unused;
1569 $dbh->rollback if $oldAutoCommit;
1574 if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1576 #this could be more efficient than deleting and re-inserting, if it matters
1577 foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1578 my $error = $cust_tag->delete;
1580 $dbh->rollback if $oldAutoCommit;
1584 foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1585 my $cust_tag = new FS::cust_tag { 'tagnum' => $tagnum,
1586 'custnum' => $self->custnum };
1587 my $error = $cust_tag->insert;
1589 $dbh->rollback if $oldAutoCommit;
1596 my $tax_exemption = delete $options{'tax_exemption'};
1597 if ( $tax_exemption ) {
1599 $tax_exemption = { map { $_ => '' } @$tax_exemption }
1600 if ref($tax_exemption) eq 'ARRAY';
1602 my %cust_main_exemption =
1603 map { $_->taxname => $_ }
1604 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1606 foreach my $taxname ( keys %$tax_exemption ) {
1608 if ( $cust_main_exemption{$taxname} &&
1609 $cust_main_exemption{$taxname}->exempt_number eq $tax_exemption->{$taxname}
1612 delete $cust_main_exemption{$taxname};
1616 my $cust_main_exemption = new FS::cust_main_exemption {
1617 'custnum' => $self->custnum,
1618 'taxname' => $taxname,
1619 'exempt_number' => $tax_exemption->{$taxname},
1621 my $error = $cust_main_exemption->insert;
1623 $dbh->rollback if $oldAutoCommit;
1624 return "inserting cust_main_exemption (transaction rolled back): $error";
1628 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1629 my $error = $cust_main_exemption->delete;
1631 $dbh->rollback if $oldAutoCommit;
1632 return "deleting cust_main_exemption (transaction rolled back): $error";
1638 if ( my $cust_payby_params = delete $options{'cust_payby_params'} ) {
1640 my $error = $self->process_o2m(
1641 'table' => 'cust_payby',
1642 'fields' => FS::cust_payby->cgi_cust_payby_fields,
1643 'params' => $cust_payby_params,
1644 'hash_callback' => \&FS::cust_payby::cgi_hash_callback,
1647 $dbh->rollback if $oldAutoCommit;
1653 if ( my $contact_params = delete $options{'contact_params'} ) {
1655 # this can potentially replace contacts that were created by the
1656 # invoicing list argument, but the UI shouldn't allow both of them
1659 my $error = $self->process_o2m(
1660 'table' => 'contact',
1661 'fields' => FS::contact->cgi_contact_fields,
1662 'params' => $contact_params,
1665 $dbh->rollback if $oldAutoCommit;
1671 unless ( $import || $skip_fuzzyfiles ) {
1672 $error = $self->queue_fuzzyfiles_update;
1674 $dbh->rollback if $oldAutoCommit;
1675 return "updating fuzzy search cache: $error";
1679 # tax district update in cust_location
1681 # cust_main exports!
1683 my $export_args = $options{'export_args'} || [];
1686 map qsearch( 'part_export', {exportnum=>$_} ),
1687 $conf->config('cust_main-exports'); #, $agentnum
1689 foreach my $part_export ( @part_export ) {
1690 my $error = $part_export->export_replace( $self, $old, @$export_args);
1692 $dbh->rollback if $oldAutoCommit;
1693 return "exporting to ". $part_export->exporttype.
1694 " (transaction rolled back): $error";
1698 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1703 =item queue_fuzzyfiles_update
1705 Used by insert & replace to update the fuzzy search cache
1709 use FS::cust_main::Search;
1710 sub queue_fuzzyfiles_update {
1713 local $SIG{HUP} = 'IGNORE';
1714 local $SIG{INT} = 'IGNORE';
1715 local $SIG{QUIT} = 'IGNORE';
1716 local $SIG{TERM} = 'IGNORE';
1717 local $SIG{TSTP} = 'IGNORE';
1718 local $SIG{PIPE} = 'IGNORE';
1720 my $oldAutoCommit = $FS::UID::AutoCommit;
1721 local $FS::UID::AutoCommit = 0;
1724 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
1725 my $queue = new FS::queue {
1726 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1728 my @args = "cust_main.$field", $self->get($field);
1729 my $error = $queue->insert( @args );
1731 $dbh->rollback if $oldAutoCommit;
1732 return "queueing job (transaction rolled back): $error";
1737 push @locations, $self->bill_location if $self->bill_locationnum;
1738 push @locations, $self->ship_location if @locations && $self->has_ship_address;
1739 foreach my $location (@locations) {
1740 my $queue = new FS::queue {
1741 'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
1743 my @args = 'cust_location.address1', $location->address1;
1744 my $error = $queue->insert( @args );
1746 $dbh->rollback if $oldAutoCommit;
1747 return "queueing job (transaction rolled back): $error";
1751 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1758 Checks all fields to make sure this is a valid customer record. If there is
1759 an error, returns the error, otherwise returns false. Called by the insert
1760 and replace methods.
1767 warn "$me check BEFORE: \n". $self->_dump
1771 $self->ut_numbern('custnum')
1772 || $self->ut_number('agentnum')
1773 || $self->ut_textn('agent_custid')
1774 || $self->ut_number('refnum')
1775 || $self->ut_foreign_keyn('bill_locationnum', 'cust_location','locationnum')
1776 || $self->ut_foreign_keyn('ship_locationnum', 'cust_location','locationnum')
1777 || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1778 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
1779 || $self->ut_foreign_keyn('taxstatusnum', 'tax_status', 'taxstatusnum')
1780 || $self->ut_textn('custbatch')
1781 || $self->ut_name('last')
1782 || $self->ut_name('first')
1783 || $self->ut_snumbern('signupdate')
1784 || $self->ut_snumbern('birthdate')
1785 || $self->ut_namen('spouse_last')
1786 || $self->ut_namen('spouse_first')
1787 || $self->ut_snumbern('spouse_birthdate')
1788 || $self->ut_snumbern('anniversary_date')
1789 || $self->ut_textn('company')
1790 || $self->ut_textn('ship_company')
1791 || $self->ut_anything('comments')
1792 || $self->ut_numbern('referral_custnum')
1793 || $self->ut_textn('stateid')
1794 || $self->ut_textn('stateid_state')
1795 || $self->ut_textn('invoice_terms')
1796 || $self->ut_floatn('cdr_termination_percentage')
1797 || $self->ut_floatn('credit_limit')
1798 || $self->ut_numbern('billday')
1799 || $self->ut_numbern('prorate_day')
1800 || $self->ut_flag('force_prorate_day')
1801 || $self->ut_flag('edit_subject')
1802 || $self->ut_flag('calling_list_exempt')
1803 || $self->ut_flag('invoice_noemail')
1804 || $self->ut_flag('message_noemail')
1805 || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1806 || $self->ut_currencyn('currency')
1807 || $self->ut_textn('po_number')
1808 || $self->ut_enum('complimentary', [ '', 'Y' ])
1809 || $self->ut_flag('invoice_ship_address')
1810 || $self->ut_flag('invoice_dest')
1813 foreach (qw(company ship_company)) {
1814 my $company = $self->get($_);
1815 $company =~ s/^\s+//;
1816 $company =~ s/\s+$//;
1817 $company =~ s/\s+/ /g;
1818 $self->set($_, $company);
1821 #barf. need message catalogs. i18n. etc.
1822 $error .= "Please select an advertising source."
1823 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1824 return $error if $error;
1826 my $agent = qsearchs( 'agent', { 'agentnum' => $self->agentnum } )
1827 or return "Unknown agent";
1829 if ( $self->currency ) {
1830 my $agent_currency = qsearchs( 'agent_currency', {
1831 'agentnum' => $agent->agentnum,
1832 'currency' => $self->currency,
1834 or return "Agent ". $agent->agent.
1835 " not permitted to offer ". $self->currency. " invoicing";
1838 return "Unknown refnum"
1839 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1841 return "Unknown referring custnum: ". $self->referral_custnum
1842 unless ! $self->referral_custnum
1843 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1845 if ( $self->ss eq '' ) {
1850 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1851 or return "Illegal social security number: ". $self->ss;
1852 $self->ss("$1-$2-$3");
1855 #turn off invoice_ship_address if ship & bill are the same
1856 if ($self->bill_locationnum eq $self->ship_locationnum) {
1857 $self->invoice_ship_address('');
1860 # cust_main_county verification now handled by cust_location check
1863 $self->ut_phonen('daytime', $self->country)
1864 || $self->ut_phonen('night', $self->country)
1865 || $self->ut_phonen('fax', $self->country)
1866 || $self->ut_phonen('mobile', $self->country)
1868 return $error if $error;
1870 if ( $conf->exists('cust_main-require_phone', $self->agentnum)
1872 && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1875 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1877 : FS::Msgcat::_gettext('daytime');
1878 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1880 : FS::Msgcat::_gettext('night');
1882 my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1884 : FS::Msgcat::_gettext('mobile');
1886 return "$daytime_label, $night_label or $mobile_label is required"
1890 return "Please select an invoicing locale"
1893 && $conf->exists('cust_main-require_locale');
1895 return "Please select a customer class"
1896 if ! $self->classnum
1897 && $conf->exists('cust_main-require_classnum');
1899 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1900 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1904 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
1906 warn "$me check AFTER: \n". $self->_dump
1909 $self->SUPER::check;
1912 sub check_payinfo_cardtype {
1915 return '' unless $self->payby =~ /^(CARD|DCRD)$/;
1917 my $payinfo = $self->payinfo;
1918 $payinfo =~ s/\D//g;
1920 return '' if $self->tokenized($payinfo); #token
1922 my %bop_card_types = map { $_=>1 } values %{ card_types() };
1923 my $cardtype = cardtype($payinfo);
1925 return "$cardtype not accepted" unless $bop_card_types{$cardtype};
1933 Additional checks for replace only.
1938 my ($new,$old) = @_;
1939 #preserve old value if global config is set
1940 if ($old && $conf->exists('invoice-ship_address')) {
1941 $new->invoice_ship_address($old->invoice_ship_address);
1948 Returns a list of fields which have ship_ duplicates.
1953 qw( last first company
1955 address1 address2 city county state zip country
1957 daytime night fax mobile
1961 =item has_ship_address
1963 Returns true if this customer record has a separate shipping address.
1967 sub has_ship_address {
1969 $self->bill_locationnum != $self->ship_locationnum;
1974 Returns a list of key/value pairs, with the following keys: address1,
1975 adddress2, city, county, state, zip, country, district, and geocode. The
1976 shipping address is used if present.
1982 $self->ship_location->location_hash;
1987 Returns all locations (see L<FS::cust_location>) for this customer.
1994 'table' => 'cust_location',
1995 'hashref' => { 'custnum' => $self->custnum,
1996 'prospectnum' => '',
1998 'order_by' => 'ORDER BY country, LOWER(state), LOWER(city), LOWER(county), LOWER(address1), LOWER(address2)',
2004 Returns all contact associations (see L<FS::cust_contact>) for this customer.
2010 qsearch('cust_contact', { 'custnum' => $self->custnum } );
2013 =item cust_payby PAYBY
2015 Returns all payment methods (see L<FS::cust_payby>) for this customer.
2017 If one or more PAYBY are specified, returns only payment methods for specified PAYBY.
2018 Does not validate PAYBY.
2026 'table' => 'cust_payby',
2027 'hashref' => { 'custnum' => $self->custnum },
2028 'order_by' => "ORDER BY payby IN ('CARD','CHEK') DESC, weight ASC",
2030 $search->{'extra_sql'} = ' AND payby IN ( '.
2031 join(',', map dbh->quote($_), @payby).
2038 =item has_cust_payby_auto
2040 Returns true if customer has an automatic payment method ('CARD' or 'CHEK')
2044 sub has_cust_payby_auto {
2047 'table' => 'cust_payby',
2048 'hashref' => { 'custnum' => $self->custnum, },
2049 'extra_sql' => " AND payby IN ( 'CARD', 'CHEK' ) ",
2050 'order_by' => 'LIMIT 1',
2057 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2058 and L<FS::cust_pkg>) for this customer, except those on hold.
2060 Returns a list: an empty list on success or a list of errors.
2066 grep { ($_->get('setup')) && $_->unsuspend } $self->suspended_pkgs;
2071 Unsuspends all suspended packages in the on-hold state (those without setup
2072 dates) for this customer.
2078 grep { (!$_->setup) && $_->unsuspend } $self->suspended_pkgs;
2083 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2085 Returns a list: an empty list on success or a list of errors.
2091 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2094 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2096 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2097 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2098 of a list of pkgparts; the hashref has the following keys:
2102 =item pkgparts - listref of pkgparts
2104 =item (other options are passed to the suspend method)
2109 Returns a list: an empty list on success or a list of errors.
2113 sub suspend_if_pkgpart {
2115 my (@pkgparts, %opt);
2116 if (ref($_[0]) eq 'HASH'){
2117 @pkgparts = @{$_[0]{pkgparts}};
2122 grep { $_->suspend(%opt) }
2123 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2124 $self->unsuspended_pkgs;
2127 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2129 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2130 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2131 instead of a list of pkgparts; the hashref has the following keys:
2135 =item pkgparts - listref of pkgparts
2137 =item (other options are passed to the suspend method)
2141 Returns a list: an empty list on success or a list of errors.
2145 sub suspend_unless_pkgpart {
2147 my (@pkgparts, %opt);
2148 if (ref($_[0]) eq 'HASH'){
2149 @pkgparts = @{$_[0]{pkgparts}};
2154 grep { $_->suspend(%opt) }
2155 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2156 $self->unsuspended_pkgs;
2159 =item cancel [ OPTION => VALUE ... ]
2161 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2162 The cancellation time will be now.
2166 Always returns a list: an empty list on success or a list of errors.
2173 warn "$me cancel called on customer ". $self->custnum. " with options ".
2174 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2176 my @pkgs = $self->ncancelled_pkgs;
2178 $self->cancel_pkgs( %opt, 'cust_pkg' => \@pkgs );
2181 =item cancel_pkgs OPTIONS
2183 Cancels a specified list of packages. OPTIONS can include:
2187 =item cust_pkg - an arrayref of the packages. Required.
2189 =item time - the cancellation time, used to calculate final bills and
2190 unused-time credits if any. Will be passed through to the bill() and
2191 FS::cust_pkg::cancel() methods.
2193 =item quiet - can be set true to supress email cancellation notices.
2195 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a
2196 reasonnum of an existing reason, or passing a hashref will create a new reason.
2197 The hashref should have the following keys:
2198 typenum - Reason type (see L<FS::reason_type>)
2199 reason - Text of the new reason.
2201 =item cust_pkg_reason - can be an arrayref of L<FS::cust_pkg_reason> objects
2202 for the individual packages, parallel to the C<cust_pkg> argument. The
2203 reason and reason_otaker arguments will be taken from those objects.
2205 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2207 =item nobill - can be set true to skip billing if it might otherwise be done.
2212 my( $self, %opt ) = @_;
2214 # we're going to cancel services, which is not reversible
2215 die "cancel_pkgs cannot be run inside a transaction"
2216 if $FS::UID::AutoCommit == 0;
2218 local $FS::UID::AutoCommit = 0;
2220 return ( 'access denied' )
2221 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2223 if ( $opt{'ban'} ) {
2225 foreach my $cust_payby ( $self->cust_payby ) {
2227 #well, if they didn't get decrypted on search, then we don't have to
2228 # try again... queue a job for the server that does have decryption
2229 # capability if we're in a paranoid multi-server implementation?
2230 return ( "Can't (yet) ban encrypted credit cards" )
2231 if $cust_payby->is_encrypted($cust_payby->payinfo);
2233 my $ban = new FS::banned_pay $cust_payby->_new_banned_pay_hashref;
2234 my $error = $ban->insert;
2244 my @pkgs = @{ delete $opt{'cust_pkg'} };
2245 my $cancel_time = $opt{'time'} || time;
2247 # bill all packages first, so we don't lose usage, service counts for
2248 # bulk billing, etc.
2249 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2251 my $error = $self->bill( 'pkg_list' => [ @pkgs ],
2253 'time' => $cancel_time );
2255 warn "Error billing during cancel, custnum ". $self->custnum. ": $error";
2257 return ( "Error billing during cancellation: $error" );
2263 # try to cancel each service, the same way we would for individual packages,
2264 # but in cancel weight order.
2265 my @cust_svc = map { $_->cust_svc } @pkgs;
2266 my @sorted_cust_svc =
2268 sort { $a->[1] <=> $b->[1] }
2269 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; } @cust_svc
2271 warn "$me removing ".scalar(@sorted_cust_svc)." service(s) for customer ".
2274 foreach my $cust_svc (@sorted_cust_svc) {
2275 my $part_svc = $cust_svc->part_svc;
2276 next if ( defined($part_svc) and $part_svc->preserve );
2277 # immediate cancel, no date option
2278 # transactionize individually
2279 my $error = try { $cust_svc->cancel } catch { $_ };
2282 push @errors, $error;
2291 warn "$me cancelling ". scalar(@pkgs) ." package(s) for customer ".
2292 $self->custnum. "\n"
2296 if ($opt{'cust_pkg_reason'}) {
2297 @cprs = @{ delete $opt{'cust_pkg_reason'} };
2303 my $cpr = shift @cprs;
2305 $lopt{'reason'} = $cpr->reasonnum;
2306 $lopt{'reason_otaker'} = $cpr->otaker;
2308 warn "no reason found when canceling package ".$_->pkgnum."\n";
2309 # we're not actually required to pass a reason to cust_pkg::cancel,
2310 # but if we're getting to this point, something has gone awry.
2311 $null_reason ||= FS::reason->new_or_existing(
2312 reason => 'unknown reason',
2313 type => 'Cancel Reason',
2316 $lopt{'reason'} = $null_reason->reasonnum;
2317 $lopt{'reason_otaker'} = $FS::CurrentUser::CurrentUser->username;
2320 my $error = $_->cancel(%lopt);
2323 push @errors, 'pkgnum '.$_->pkgnum.': '.$error;
2332 sub _banned_pay_hashref {
2333 die 'cust_main->_banned_pay_hashref deprecated';
2345 'payby' => $payby2ban{$self->payby},
2346 'payinfo' => $self->payinfo,
2347 #don't ever *search* on reason! #'reason' =>
2353 Returns all notes (see L<FS::cust_main_note>) for this customer.
2358 my($self,$orderby_classnum) = (shift,shift);
2359 my $orderby = "sticky DESC, _date DESC";
2360 $orderby = "classnum ASC, $orderby" if $orderby_classnum;
2361 qsearch( 'cust_main_note',
2362 { 'custnum' => $self->custnum },
2364 "ORDER BY $orderby",
2370 Returns the agent (see L<FS::agent>) for this customer.
2374 Returns the agent name (see L<FS::agent>) for this customer.
2380 $self->agent->agent;
2385 Returns any tags associated with this customer, as FS::cust_tag objects,
2386 or an empty list if there are no tags.
2390 Returns any tags associated with this customer, as FS::part_tag objects,
2391 or an empty list if there are no tags.
2397 map $_->part_tag, $self->cust_tag;
2403 Returns the customer class, as an FS::cust_class object, or the empty string
2404 if there is no customer class.
2408 Returns the customer category name, or the empty string if there is no customer
2415 my $cust_class = $self->cust_class;
2417 ? $cust_class->categoryname
2423 Returns the customer class name, or the empty string if there is no customer
2430 my $cust_class = $self->cust_class;
2432 ? $cust_class->classname
2438 Returns the external tax status, as an FS::tax_status object, or the empty
2439 string if there is no tax status.
2445 if ( $self->taxstatusnum ) {
2446 qsearchs('tax_status', { 'taxstatusnum' => $self->taxstatusnum } );
2454 Returns the tax status code if there is one.
2460 my $tax_status = $self->tax_status;
2462 ? $tax_status->taxstatus
2466 =item BILLING METHODS
2468 Documentation on billing methods has been moved to
2469 L<FS::cust_main::Billing>.
2471 =item REALTIME BILLING METHODS
2473 Documentation on realtime billing methods has been moved to
2474 L<FS::cust_main::Billing_Realtime>.
2478 Removes the I<paycvv> field from the database directly.
2480 If there is an error, returns the error, otherwise returns false.
2482 DEPRECATED. Use L</remove_cvv_from_cust_payby> instead.
2487 die 'cust_main->remove_cvv deprecated';
2489 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2490 or return dbh->errstr;
2491 $sth->execute($self->custnum)
2492 or return $sth->errstr;
2499 Returns the total owed for this customer on all invoices
2500 (see L<FS::cust_bill/owed>).
2506 $self->total_owed_date(2145859200); #12/31/2037
2509 =item total_owed_date TIME
2511 Returns the total owed for this customer on all invoices with date earlier than
2512 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2513 see L<Time::Local> and L<Date::Parse> for conversion functions.
2517 sub total_owed_date {
2521 my $custnum = $self->custnum;
2523 my $owed_sql = FS::cust_bill->owed_sql;
2526 SELECT SUM($owed_sql) FROM cust_bill
2527 WHERE custnum = $custnum
2531 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2535 =item total_owed_pkgnum PKGNUM
2537 Returns the total owed on all invoices for this customer's specific package
2538 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2542 sub total_owed_pkgnum {
2543 my( $self, $pkgnum ) = @_;
2544 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2547 =item total_owed_date_pkgnum TIME PKGNUM
2549 Returns the total owed for this customer's specific package when using
2550 experimental package balances on all invoices with date earlier than
2551 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2552 see L<Time::Local> and L<Date::Parse> for conversion functions.
2556 sub total_owed_date_pkgnum {
2557 my( $self, $time, $pkgnum ) = @_;
2560 foreach my $cust_bill (
2561 grep { $_->_date <= $time }
2562 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2564 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2566 sprintf( "%.2f", $total_bill );
2572 Returns the total amount of all payments.
2579 $total += $_->paid foreach $self->cust_pay;
2580 sprintf( "%.2f", $total );
2583 =item total_unapplied_credits
2585 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2586 customer. See L<FS::cust_credit/credited>.
2588 =item total_credited
2590 Old name for total_unapplied_credits. Don't use.
2594 sub total_credited {
2595 #carp "total_credited deprecated, use total_unapplied_credits";
2596 shift->total_unapplied_credits(@_);
2599 sub total_unapplied_credits {
2602 my $custnum = $self->custnum;
2604 my $unapplied_sql = FS::cust_credit->unapplied_sql;
2607 SELECT SUM($unapplied_sql) FROM cust_credit
2608 WHERE custnum = $custnum
2611 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2615 =item total_unapplied_credits_pkgnum PKGNUM
2617 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2618 customer. See L<FS::cust_credit/credited>.
2622 sub total_unapplied_credits_pkgnum {
2623 my( $self, $pkgnum ) = @_;
2624 my $total_credit = 0;
2625 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2626 sprintf( "%.2f", $total_credit );
2630 =item total_unapplied_payments
2632 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2633 See L<FS::cust_pay/unapplied>.
2637 sub total_unapplied_payments {
2640 my $custnum = $self->custnum;
2642 my $unapplied_sql = FS::cust_pay->unapplied_sql;
2645 SELECT SUM($unapplied_sql) FROM cust_pay
2646 WHERE custnum = $custnum
2649 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2653 =item total_unapplied_payments_pkgnum PKGNUM
2655 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2656 specific package when using experimental package balances. See
2657 L<FS::cust_pay/unapplied>.
2661 sub total_unapplied_payments_pkgnum {
2662 my( $self, $pkgnum ) = @_;
2663 my $total_unapplied = 0;
2664 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2665 sprintf( "%.2f", $total_unapplied );
2669 =item total_unapplied_refunds
2671 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2672 customer. See L<FS::cust_refund/unapplied>.
2676 sub total_unapplied_refunds {
2678 my $custnum = $self->custnum;
2680 my $unapplied_sql = FS::cust_refund->unapplied_sql;
2683 SELECT SUM($unapplied_sql) FROM cust_refund
2684 WHERE custnum = $custnum
2687 sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2693 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2694 total_unapplied_credits minus total_unapplied_payments).
2700 $self->balance_date_range;
2703 =item balance_date TIME
2705 Returns the balance for this customer, only considering invoices with date
2706 earlier than TIME (total_owed_date minus total_credited minus
2707 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
2708 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
2715 $self->balance_date_range(shift);
2718 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2720 Returns the balance for this customer, optionally considering invoices with
2721 date earlier than START_TIME, and not later than END_TIME
2722 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2724 Times are specified as SQL fragments or numeric
2725 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
2726 L<Date::Parse> for conversion functions. The empty string can be passed
2727 to disable that time constraint completely.
2729 Accepts the same options as L<balance_date_sql>:
2733 =item unapplied_date
2735 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)
2739 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
2740 time will be ignored. Note that START_TIME and END_TIME only limit the date
2741 range for invoices and I<unapplied> payments, credits, and refunds.
2747 sub balance_date_range {
2749 my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2750 ') FROM cust_main WHERE custnum='. $self->custnum;
2751 sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2754 =item balance_pkgnum PKGNUM
2756 Returns the balance for this customer's specific package when using
2757 experimental package balances (total_owed plus total_unrefunded, minus
2758 total_unapplied_credits minus total_unapplied_payments)
2762 sub balance_pkgnum {
2763 my( $self, $pkgnum ) = @_;
2766 $self->total_owed_pkgnum($pkgnum)
2767 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2768 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
2769 - $self->total_unapplied_credits_pkgnum($pkgnum)
2770 - $self->total_unapplied_payments_pkgnum($pkgnum)
2776 Returns a hash of useful information for making a payment.
2786 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2787 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2788 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2792 For credit card transactions:
2804 For electronic check transactions:
2814 #XXX i need to be updated for 4.x+
2820 $return{balance} = $self->balance;
2822 $return{payname} = $self->payname
2823 || ( $self->first. ' '. $self->get('last') );
2825 $return{$_} = $self->bill_location->$_
2826 for qw(address1 address2 city state zip);
2828 $return{payby} = $self->payby;
2829 $return{stateid_state} = $self->stateid_state;
2831 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2832 $return{card_type} = cardtype($self->payinfo);
2833 $return{payinfo} = $self->paymask;
2835 @return{'month', 'year'} = $self->paydate_monthyear;
2839 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2840 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2841 $return{payinfo1} = $payinfo1;
2842 $return{payinfo2} = $payinfo2;
2843 $return{paytype} = $self->paytype;
2844 $return{paystate} = $self->paystate;
2848 #doubleclick protection
2850 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2858 Returns the next payment expiration date for this customer. If they have no
2859 payment methods that will expire, returns 0.
2865 # filter out the ones that individually return 0, but then return 0 if
2866 # there are no results
2867 my @epochs = grep { $_ > 0 } map { $_->paydate_epoch } $self->cust_payby;
2868 min( @epochs ) || 0;
2871 =item paydate_epoch_sql
2873 Returns an SQL expression to get the next payment expiration date for a
2874 customer. Returns 2143260000 (2037-12-01) if there are no payment expiration
2875 dates, so that it's safe to test for "will it expire before date X" for any
2880 sub paydate_epoch_sql {
2882 my $paydate = FS::cust_payby->paydate_epoch_sql;
2883 "(SELECT COALESCE(MIN($paydate), 2143260000) FROM cust_payby WHERE cust_payby.custnum = cust_main.custnum)";
2887 my( $self, $taxname ) = @_;
2889 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2890 'taxname' => $taxname,
2895 =item cust_main_exemption
2897 =item invoicing_list
2899 Returns a list of email addresses (with svcnum entries expanded), and the word
2900 'POST' if the customer receives postal invoices.
2904 sub invoicing_list {
2905 my( $self, $arrayref ) = @_;
2908 warn "FS::cust_main::invoicing_list(ARRAY) is no longer supported.";
2911 my @emails = $self->invoicing_list_emailonly;
2912 push @emails, 'POST' if $self->get('postal_invoice');
2917 =item check_invoicing_list ARRAYREF
2919 Checks these arguements as valid input for the invoicing_list method. If there
2920 is an error, returns the error, otherwise returns false.
2924 sub check_invoicing_list {
2925 my( $self, $arrayref ) = @_;
2927 foreach my $address ( @$arrayref ) {
2929 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
2930 return 'Can\'t add FAX invoice destination with a blank FAX number.';
2933 my $cust_main_invoice = new FS::cust_main_invoice ( {
2934 'custnum' => $self->custnum,
2937 my $error = $self->custnum
2938 ? $cust_main_invoice->check
2939 : $cust_main_invoice->checkdest
2941 return $error if $error;
2945 return "Email address required"
2946 if $conf->exists('cust_main-require_invoicing_list_email', $self->agentnum)
2947 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
2954 Returns the email addresses of all accounts provisioned for this customer.
2961 foreach my $cust_pkg ( $self->all_pkgs ) {
2962 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
2964 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2965 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2967 $list{$_}=1 foreach map { $_->email } @svc_acct;
2972 =item invoicing_list_addpost
2974 Adds postal invoicing to this customer. If this customer is already configured
2975 to receive postal invoices, does nothing.
2979 sub invoicing_list_addpost {
2981 if ( $self->get('postal_invoice') eq '' ) {
2982 $self->set('postal_invoice', 'Y');
2983 my $error = $self->replace;
2984 warn $error if $error; # should fail harder, but this is traditional
2988 =item invoicing_list_emailonly
2990 Returns the list of email invoice recipients (invoicing_list without non-email
2991 destinations such as POST and FAX).
2995 sub invoicing_list_emailonly {
2997 warn "$me invoicing_list_emailonly called"
2999 return () if !$self->custnum; # not yet inserted
3000 return map { $_->emailaddress }
3002 table => 'cust_contact',
3003 select => 'emailaddress',
3004 addl_from => ' JOIN contact USING (contactnum) '.
3005 ' JOIN contact_email USING (contactnum)',
3006 hashref => { 'custnum' => $self->custnum, },
3007 extra_sql => q( AND cust_contact.invoice_dest = 'Y'),
3011 =item invoicing_list_emailonly_scalar
3013 Returns the list of email invoice recipients (invoicing_list without non-email
3014 destinations such as POST and FAX) as a comma-separated scalar.
3018 sub invoicing_list_emailonly_scalar {
3020 warn "$me invoicing_list_emailonly_scalar called"
3022 join(', ', $self->invoicing_list_emailonly);
3025 =item contact_list [ CLASSNUM, DEST_FLAG... ]
3027 Returns a list of contacts (L<FS::contact> objects) for the customer.
3029 If no arguments are given, returns all contacts for the customer.
3031 Arguments may contain classnums. When classnums are specified, only
3032 contacts with a matching cust_contact.classnum are returned. When a
3033 classnum of 0 is given, contacts with a null classnum are also included.
3035 Arguments may also contain the dest flag names 'invoice' or 'message'.
3036 If given, contacts who's invoice_dest and/or message_dest flags are
3037 not set to 'Y' will be excluded.
3045 select => join(', ',(
3047 'cust_contact.invoice_dest',
3048 'cust_contact.message_dest',
3050 addl_from => ' JOIN cust_contact USING (contactnum)',
3051 extra_sql => ' WHERE cust_contact.custnum = '.$self->custnum,
3055 # Calling methods were relying on this method to use invoice_dest to
3056 # block e-mail messages. Depending on parameters, this may or may not
3057 # have actually happened.
3059 # The bug could cause this SQL to be used to filter e-mail addresses:
3062 # cust_contact.classnums IN (1,2,3)
3063 # OR cust_contact.invoice_dest = 'Y'
3066 # improperly including everybody with the opt-in flag AND everybody
3067 # in the contact classes
3069 # Possibility to introduce new bugs:
3070 # If callers of this method called it incorrectly, and didn't notice
3071 # because it seemed to send the e-mails they wanted.
3076 # cust_contact.classnum IN (1,2,3)
3078 # cust_contact.classnum IS NULL
3081 # cust_contact.invoice_dest = 'Y'
3083 # cust_contact.message_dest = 'Y'
3091 if ($_ eq 'invoice' || $_ eq 'message') {
3092 push @and_dest, " cust_contact.${_}_dest = 'Y' ";
3093 } elsif ($_ eq '0') {
3094 push @or_classnum, ' cust_contact.classnum IS NULL ';
3095 } elsif ( /^\d+$/ ) {
3096 push @classnums, $_;
3098 croak "bad classnum argument '$_'";
3102 push @or_classnum, 'cust_contact.classnum IN ('.join(',',@classnums).')'
3105 if (@or_classnum || @and_dest) { # catch, no arguments given
3106 $search->{extra_sql} .= ' AND ( ';
3109 $search->{extra_sql} .= ' ( ';
3110 $search->{extra_sql} .= join ' OR ', map {" $_ "} @or_classnum;
3111 $search->{extra_sql} .= ' ) ';
3112 $search->{extra_sql} .= ' AND ( ' if @and_dest;
3116 $search->{extra_sql} .= join ' OR ', map {" $_ "} @and_dest;
3117 $search->{extra_sql} .= ' ) ' if @or_classnum;
3120 $search->{extra_sql} .= ' ) ';
3122 warn "\$extra_sql: $search->{extra_sql} \n" if $DEBUG;
3128 =item contact_list_email [ CLASSNUM, ... ]
3130 Same as L</contact_list>, but returns email destinations instead of contact
3135 sub contact_list_email {
3137 my @contacts = $self->contact_list(@_);
3139 foreach my $contact (@contacts) {
3140 foreach my $contact_email ($contact->contact_email) {
3141 push @emails, Email::Address->new( $contact->firstlast,
3142 $contact_email->emailaddress
3149 =item referral_custnum_cust_main
3151 Returns the customer who referred this customer (or the empty string, if
3152 this customer was not referred).
3154 Note the difference with referral_cust_main method: This method,
3155 referral_custnum_cust_main returns the single customer (if any) who referred
3156 this customer, while referral_cust_main returns an array of customers referred
3161 sub referral_custnum_cust_main {
3163 return '' unless $self->referral_custnum;
3164 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3167 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3169 Returns an array of customers referred by this customer (referral_custnum set
3170 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3171 customers referred by customers referred by this customer and so on, inclusive.
3172 The default behavior is DEPTH 1 (no recursion).
3174 Note the difference with referral_custnum_cust_main method: This method,
3175 referral_cust_main, returns an array of customers referred BY this customer,
3176 while referral_custnum_cust_main returns the single customer (if any) who
3177 referred this customer.
3181 sub referral_cust_main {
3183 my $depth = @_ ? shift : 1;
3184 my $exclude = @_ ? shift : {};
3187 map { $exclude->{$_->custnum}++; $_; }
3188 grep { ! $exclude->{ $_->custnum } }
3189 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3193 map { $_->referral_cust_main($depth-1, $exclude) }
3200 =item referral_cust_main_ncancelled
3202 Same as referral_cust_main, except only returns customers with uncancelled
3207 sub referral_cust_main_ncancelled {
3209 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3212 =item referral_cust_pkg [ DEPTH ]
3214 Like referral_cust_main, except returns a flat list of all unsuspended (and
3215 uncancelled) packages for each customer. The number of items in this list may
3216 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3220 sub referral_cust_pkg {
3222 my $depth = @_ ? shift : 1;
3224 map { $_->unsuspended_pkgs }
3225 grep { $_->unsuspended_pkgs }
3226 $self->referral_cust_main($depth);
3229 =item referring_cust_main
3231 Returns the single cust_main record for the customer who referred this customer
3232 (referral_custnum), or false.
3236 sub referring_cust_main {
3238 return '' unless $self->referral_custnum;
3239 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3242 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3244 Applies a credit to this customer. If there is an error, returns the error,
3245 otherwise returns false.
3247 REASON can be a text string, an FS::reason object, or a scalar reference to
3248 a reasonnum. If a text string, it will be automatically inserted as a new
3249 reason, and a 'reason_type' option must be passed to indicate the
3250 FS::reason_type for the new reason.
3252 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3253 Likewise for I<eventnum>, I<commission_agentnum>, I<commission_salesnum> and
3254 I<commission_pkgnum>.
3256 Any other options are passed to FS::cust_credit::insert.
3261 my( $self, $amount, $reason, %options ) = @_;
3263 my $cust_credit = new FS::cust_credit {
3264 'custnum' => $self->custnum,
3265 'amount' => $amount,
3268 if ( ref($reason) ) {
3270 if ( ref($reason) eq 'SCALAR' ) {
3271 $cust_credit->reasonnum( $$reason );
3273 $cust_credit->reasonnum( $reason->reasonnum );
3277 $cust_credit->set('reason', $reason)
3280 $cust_credit->$_( delete $options{$_} )
3281 foreach grep exists($options{$_}),
3282 qw( addlinfo eventnum ),
3283 map "commission_$_", qw( agentnum salesnum pkgnum );
3285 $cust_credit->insert(%options);
3289 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3291 Creates a one-time charge for this customer. If there is an error, returns
3292 the error, otherwise returns false.
3294 New-style, with a hashref of options:
3296 my $error = $cust_main->charge(
3300 'start_date' => str2time('7/4/2009'),
3301 'pkg' => 'Description',
3302 'comment' => 'Comment',
3303 'additional' => [], #extra invoice detail
3304 'classnum' => 1, #pkg_class
3306 'setuptax' => '', # or 'Y' for tax exempt
3308 'locationnum'=> 1234, # optional
3311 'taxclass' => 'Tax class',
3314 'taxproduct' => 2, #part_pkg_taxproduct
3315 'override' => {}, #XXX describe
3317 #will be filled in with the new object
3318 'cust_pkg_ref' => \$cust_pkg,
3320 #generate an invoice immediately
3322 'invoice_terms' => '', #with these terms
3328 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3332 #super false laziness w/quotation::charge
3335 my ( $amount, $setup_cost, $quantity, $start_date, $classnum );
3336 my ( $pkg, $comment, $additional );
3337 my ( $setuptax, $taxclass ); #internal taxes
3338 my ( $taxproduct, $override ); #vendor (CCH) taxes
3340 my $separate_bill = '';
3341 my $cust_pkg_ref = '';
3342 my ( $bill_now, $invoice_terms ) = ( 0, '' );
3344 my ( $discountnum, $discountnum_amount, $discountnum_percent ) = ( '','','' );
3345 if ( ref( $_[0] ) ) {
3346 $amount = $_[0]->{amount};
3347 $setup_cost = $_[0]->{setup_cost};
3348 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3349 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3350 $no_auto = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3351 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3352 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
3353 : '$'. sprintf("%.2f",$amount);
3354 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3355 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3356 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3357 $additional = $_[0]->{additional} || [];
3358 $taxproduct = $_[0]->{taxproductnum};
3359 $override = { '' => $_[0]->{tax_override} };
3360 $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3361 $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3362 $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3363 $locationnum = $_[0]->{locationnum} || $self->ship_locationnum;
3364 $separate_bill = $_[0]->{separate_bill} || '';
3365 $discountnum = $_[0]->{setup_discountnum};
3366 $discountnum_amount = $_[0]->{setup_discountnum_amount};
3367 $discountnum_percent = $_[0]->{setup_discountnum_percent};
3373 $pkg = @_ ? shift : 'One-time charge';
3374 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3376 $taxclass = @_ ? shift : '';
3380 local $SIG{HUP} = 'IGNORE';
3381 local $SIG{INT} = 'IGNORE';
3382 local $SIG{QUIT} = 'IGNORE';
3383 local $SIG{TERM} = 'IGNORE';
3384 local $SIG{TSTP} = 'IGNORE';
3385 local $SIG{PIPE} = 'IGNORE';
3387 my $oldAutoCommit = $FS::UID::AutoCommit;
3388 local $FS::UID::AutoCommit = 0;
3391 my $part_pkg = new FS::part_pkg ( {
3393 'comment' => $comment,
3397 'classnum' => ( $classnum ? $classnum : '' ),
3398 'setuptax' => $setuptax,
3399 'taxclass' => $taxclass,
3400 'taxproductnum' => $taxproduct,
3401 'setup_cost' => $setup_cost,
3404 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3405 ( 0 .. @$additional - 1 )
3407 'additional_count' => scalar(@$additional),
3408 'setup_fee' => $amount,
3411 my $error = $part_pkg->insert( options => \%options,
3412 tax_overrides => $override,
3415 $dbh->rollback if $oldAutoCommit;
3419 my $pkgpart = $part_pkg->pkgpart;
3420 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3421 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3422 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3423 $error = $type_pkgs->insert;
3425 $dbh->rollback if $oldAutoCommit;
3430 my $cust_pkg = new FS::cust_pkg ( {
3431 'custnum' => $self->custnum,
3432 'pkgpart' => $pkgpart,
3433 'quantity' => $quantity,
3434 'start_date' => $start_date,
3435 'no_auto' => $no_auto,
3436 'separate_bill' => $separate_bill,
3437 'locationnum' => $locationnum,
3438 'setup_discountnum' => $discountnum,
3439 'setup_discountnum_amount' => $discountnum_amount,
3440 'setup_discountnum_percent' => $discountnum_percent,
3443 $error = $cust_pkg->insert;
3445 $dbh->rollback if $oldAutoCommit;
3447 } elsif ( $cust_pkg_ref ) {
3448 ${$cust_pkg_ref} = $cust_pkg;
3452 my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3453 'pkg_list' => [ $cust_pkg ],
3456 $dbh->rollback if $oldAutoCommit;
3461 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3466 #=item charge_postal_fee
3468 #Applies a one time charge this customer. If there is an error,
3469 #returns the error, returns the cust_pkg charge object or false
3470 #if there was no charge.
3474 # This should be a customer event. For that to work requires that bill
3475 # also be a customer event.
3477 sub charge_postal_fee {
3480 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3481 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3483 my $cust_pkg = new FS::cust_pkg ( {
3484 'custnum' => $self->custnum,
3485 'pkgpart' => $pkgpart,
3489 my $error = $cust_pkg->insert;
3490 $error ? $error : $cust_pkg;
3493 =item num_cust_attachment_deleted
3495 Returns the number of deleted attachments for this customer (see
3496 L<FS::num_cust_attachment>).
3500 sub num_cust_attachments_deleted {
3503 " SELECT COUNT(*) FROM cust_attachment ".
3504 " WHERE custnum = ? AND disabled IS NOT NULL AND disabled > 0",
3511 Returns the most recent invnum (invoice number) for this customer.
3518 " SELECT MAX(invnum) FROM cust_bill WHERE custnum = ?",
3523 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3525 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3527 Optionally, a list or hashref of additional arguments to the qsearch call can
3534 my $opt = ref($_[0]) ? shift : { @_ };
3536 #return $self->num_cust_bill unless wantarray || keys %$opt;
3538 $opt->{'table'} = 'cust_bill';
3539 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3540 $opt->{'hashref'}{'custnum'} = $self->custnum;
3541 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3543 map { $_ } #behavior of sort undefined in scalar context
3544 sort { $a->_date <=> $b->_date }
3548 =item open_cust_bill
3550 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3555 sub open_cust_bill {
3559 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3565 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3567 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3571 sub legacy_cust_bill {
3574 #return $self->num_legacy_cust_bill unless wantarray;
3576 map { $_ } #behavior of sort undefined in scalar context
3577 sort { $a->_date <=> $b->_date }
3578 qsearch({ 'table' => 'legacy_cust_bill',
3579 'hashref' => { 'custnum' => $self->custnum, },
3580 'order_by' => 'ORDER BY _date ASC',
3584 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3586 Returns all the statements (see L<FS::cust_statement>) for this customer.
3588 Optionally, a list or hashref of additional arguments to the qsearch call can
3593 =item cust_bill_void
3595 Returns all the voided invoices (see L<FS::cust_bill_void>) for this customer.
3599 sub cust_bill_void {
3602 map { $_ } #return $self->num_cust_bill_void unless wantarray;
3603 sort { $a->_date <=> $b->_date }
3604 qsearch( 'cust_bill_void', { 'custnum' => $self->custnum } )
3607 sub cust_statement {
3609 my $opt = ref($_[0]) ? shift : { @_ };
3611 #return $self->num_cust_statement unless wantarray || keys %$opt;
3613 $opt->{'table'} = 'cust_statement';
3614 $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3615 $opt->{'hashref'}{'custnum'} = $self->custnum;
3616 $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3618 map { $_ } #behavior of sort undefined in scalar context
3619 sort { $a->_date <=> $b->_date }
3623 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3625 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3627 Optionally, a list or hashref of additional arguments to the qsearch call can
3628 be passed following the SVCDB.
3635 if ( ! $svcdb =~ /^svc_\w+$/ ) {
3636 warn "$me svc_x requires a svcdb";
3639 my $opt = ref($_[0]) ? shift : { @_ };
3641 $opt->{'table'} = $svcdb;
3642 $opt->{'addl_from'} =
3643 'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3644 ($opt->{'addl_from'} || '');
3646 my $custnum = $self->custnum;
3647 $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3648 my $where = "cust_pkg.custnum = $custnum";
3650 my $extra_sql = $opt->{'extra_sql'} || '';
3651 if ( keys %{ $opt->{'hashref'} } ) {
3652 $extra_sql = " AND $where $extra_sql";
3655 if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3656 $extra_sql = "WHERE $where AND $1";
3659 $extra_sql = "WHERE $where $extra_sql";
3662 $opt->{'extra_sql'} = $extra_sql;
3667 # required for use as an eventtable;
3670 $self->svc_x('svc_acct', @_);
3675 Returns all the credits (see L<FS::cust_credit>) for this customer.
3682 #return $self->num_cust_credit unless wantarray;
3684 map { $_ } #behavior of sort undefined in scalar context
3685 sort { $a->_date <=> $b->_date }
3686 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3689 =item cust_credit_pkgnum
3691 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3692 package when using experimental package balances.
3696 sub cust_credit_pkgnum {
3697 my( $self, $pkgnum ) = @_;
3698 map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3699 sort { $a->_date <=> $b->_date }
3700 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3701 'pkgnum' => $pkgnum,
3706 =item cust_credit_void
3708 Returns all voided credits (see L<FS::cust_credit_void>) for this customer.
3712 sub cust_credit_void {
3715 sort { $a->_date <=> $b->_date }
3716 qsearch( 'cust_credit_void', { 'custnum' => $self->custnum } )
3721 Returns all the payments (see L<FS::cust_pay>) for this customer.
3727 my $opt = ref($_[0]) ? shift : { @_ };
3729 return $self->num_cust_pay unless wantarray || keys %$opt;
3731 $opt->{'table'} = 'cust_pay';
3732 $opt->{'hashref'}{'custnum'} = $self->custnum;
3734 map { $_ } #behavior of sort undefined in scalar context
3735 sort { $a->_date <=> $b->_date }
3742 Returns the number of payments (see L<FS::cust_pay>) for this customer. Also
3743 called automatically when the cust_pay method is used in a scalar context.
3749 my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3750 my $sth = dbh->prepare($sql) or die dbh->errstr;
3751 $sth->execute($self->custnum) or die $sth->errstr;
3752 $sth->fetchrow_arrayref->[0];
3755 =item unapplied_cust_pay
3757 Returns all the unapplied payments (see L<FS::cust_pay>) for this customer.
3761 sub unapplied_cust_pay {
3765 'extra_sql' => ' AND '. FS::cust_pay->unapplied_sql. ' > 0',
3771 =item cust_pay_pkgnum
3773 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3774 package when using experimental package balances.
3778 sub cust_pay_pkgnum {
3779 my( $self, $pkgnum ) = @_;
3780 map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3781 sort { $a->_date <=> $b->_date }
3782 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3783 'pkgnum' => $pkgnum,
3790 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3796 map { $_ } #return $self->num_cust_pay_void unless wantarray;
3797 sort { $a->_date <=> $b->_date }
3798 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3801 =item cust_pay_pending
3803 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3804 (without status "done").
3808 sub cust_pay_pending {
3810 return $self->num_cust_pay_pending unless wantarray;
3811 sort { $a->_date <=> $b->_date }
3812 qsearch( 'cust_pay_pending', {
3813 'custnum' => $self->custnum,
3814 'status' => { op=>'!=', value=>'done' },
3819 =item cust_pay_pending_attempt
3821 Returns all payment attempts / declined payments for this customer, as pending
3822 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3823 a corresponding payment (see L<FS::cust_pay>).
3827 sub cust_pay_pending_attempt {
3829 return $self->num_cust_pay_pending_attempt unless wantarray;
3830 sort { $a->_date <=> $b->_date }
3831 qsearch( 'cust_pay_pending', {
3832 'custnum' => $self->custnum,
3839 =item num_cust_pay_pending
3841 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3842 customer (without status "done"). Also called automatically when the
3843 cust_pay_pending method is used in a scalar context.
3847 sub num_cust_pay_pending {
3850 " SELECT COUNT(*) FROM cust_pay_pending ".
3851 " WHERE custnum = ? AND status != 'done' ",
3856 =item num_cust_pay_pending_attempt
3858 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3859 customer, with status "done" but without a corresp. Also called automatically when the
3860 cust_pay_pending method is used in a scalar context.
3864 sub num_cust_pay_pending_attempt {
3867 " SELECT COUNT(*) FROM cust_pay_pending ".
3868 " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3875 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3881 map { $_ } #return $self->num_cust_refund unless wantarray;
3882 sort { $a->_date <=> $b->_date }
3883 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3886 =item display_custnum
3888 Returns the displayed customer number for this customer: agent_custid if
3889 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3893 sub display_custnum {
3896 return $self->agent_custid
3897 if $default_agent_custid && $self->agent_custid;
3899 my $prefix = $conf->config('cust_main-custnum-display_prefix', $self->agentnum) || '';
3903 sprintf('%0'.($custnum_display_length||8).'d', $self->custnum)
3904 } elsif ( $custnum_display_length ) {
3905 return sprintf('%0'.$custnum_display_length.'d', $self->custnum);
3907 return $self->custnum;
3913 Returns a name string for this customer, either "Company (Last, First)" or
3920 my $name = $self->contact;
3921 $name = $self->company. " ($name)" if $self->company;
3925 =item batch_payment_payname
3927 Returns a name string for this customer, either "cust_batch_payment->payname" or "First Last" or "Company,
3928 based on if a company name exists and is the account being used a business account.
3932 sub batch_payment_payname {
3934 my $cust_pay_batch = shift;
3937 if ($cust_pay_batch->{Hash}->{payby} eq "CARD") { $name = $cust_pay_batch->payname; }
3938 else { $name = $self->first .' '. $self->last; }
3940 $name = $self->company
3941 if (($cust_pay_batch->{Hash}->{paytype} eq "Business checking" || $cust_pay_batch->{Hash}->{paytype} eq "Business savings") && $self->company);
3946 =item service_contact
3948 Returns the L<FS::contact> object for this customer that has the 'Service'
3949 contact class, or undef if there is no such contact. Deprecated; don't use
3954 sub service_contact {
3956 if ( !exists($self->{service_contact}) ) {
3957 my $classnum = $self->scalar_sql(
3958 'SELECT classnum FROM contact_class WHERE classname = \'Service\''
3959 ) || 0; #if it's zero, qsearchs will return nothing
3960 my $cust_contact = qsearchs('cust_contact', {
3961 'classnum' => $classnum,
3962 'custnum' => $self->custnum,
3964 $self->{service_contact} = $cust_contact->contact if $cust_contact;
3966 $self->{service_contact};
3971 Returns a name string for this (service/shipping) contact, either
3972 "Company (Last, First)" or "Last, First".
3979 my $name = $self->ship_contact;
3980 $name = $self->company. " ($name)" if $self->company;
3986 Returns a name string for this customer, either "Company" or "First Last".
3992 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3995 =item ship_name_short
3997 Returns a name string for this (service/shipping) contact, either "Company"
4002 sub ship_name_short {
4004 $self->service_contact
4005 ? $self->ship_contact_firstlast
4011 Returns this customer's full (billing) contact name only, "Last, First"
4017 $self->get('last'). ', '. $self->first;
4022 Returns this customer's full (shipping) contact name only, "Last, First"
4028 my $contact = $self->service_contact || $self;
4029 $contact->get('last') . ', ' . $contact->get('first');
4032 =item contact_firstlast
4034 Returns this customers full (billing) contact name only, "First Last".
4038 sub contact_firstlast {
4040 $self->first. ' '. $self->get('last');
4043 =item ship_contact_firstlast
4045 Returns this customer's full (shipping) contact name only, "First Last".
4049 sub ship_contact_firstlast {
4051 my $contact = $self->service_contact || $self;
4052 $contact->get('first') . ' '. $contact->get('last');
4055 sub bill_country_full {
4057 $self->bill_location->country_full;
4060 sub ship_country_full {
4062 $self->ship_location->country_full;
4065 =item county_state_county [ PREFIX ]
4067 Returns a string consisting of just the county, state and country.
4071 sub county_state_country {
4074 if ( @_ && $_[0] && $self->has_ship_address ) {
4075 $locationnum = $self->ship_locationnum;
4077 $locationnum = $self->bill_locationnum;
4079 my $cust_location = qsearchs('cust_location', { locationnum=>$locationnum });
4080 $cust_location->county_state_country;
4083 =item geocode DATA_VENDOR
4085 Returns a value for the customer location as encoded by DATA_VENDOR.
4086 Currently this only makes sense for "CCH" as DATA_VENDOR.
4094 Returns a status string for this customer, currently:
4100 No packages have ever been ordered. Displayed as "No packages".
4104 Recurring packages all are new (not yet billed).
4108 One or more recurring packages is active.
4112 No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled).
4116 All non-cancelled recurring packages are suspended.
4120 All recurring packages are cancelled.
4124 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4125 cust_main-status_module configuration option.
4129 sub status { shift->cust_status(@_); }
4133 return $self->hashref->{cust_status} if $self->hashref->{cust_status};
4134 for my $status ( FS::cust_main->statuses() ) {
4135 my $method = $status.'_sql';
4136 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4137 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4138 $sth->execute( ($self->custnum) x $numnum )
4139 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4140 if ( $sth->fetchrow_arrayref->[0] ) {
4141 $self->hashref->{cust_status} = $status;
4147 =item is_status_delay_cancel
4149 Returns true if customer status is 'suspended'
4150 and all suspended cust_pkg return true for
4151 cust_pkg->is_status_delay_cancel.
4153 This is not a real status, this only meant for hacking display
4154 values, because otherwise treating the customer as suspended is
4155 really the whole point of the delay_cancel option.
4159 sub is_status_delay_cancel {
4161 return 0 unless $self->status eq 'suspended';
4162 foreach my $cust_pkg ($self->ncancelled_pkgs) {
4163 return 0 unless $cust_pkg->is_status_delay_cancel;
4168 =item ucfirst_cust_status
4170 =item ucfirst_status
4172 Deprecated, use the cust_status_label method instead.
4174 Returns the status with the first character capitalized.
4178 sub ucfirst_status {
4179 carp "ucfirst_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4180 local($ucfirst_nowarn) = 1;
4181 shift->ucfirst_cust_status(@_);
4184 sub ucfirst_cust_status {
4185 carp "ucfirst_cust_status deprecated, use cust_status_label" unless $ucfirst_nowarn;
4187 ucfirst($self->cust_status);
4190 =item cust_status_label
4194 Returns the display label for this status.
4198 sub status_label { shift->cust_status_label(@_); }
4200 sub cust_status_label {
4202 __PACKAGE__->statuslabels->{$self->cust_status};
4207 Returns a hex triplet color string for this customer's status.
4211 sub statuscolor { shift->cust_statuscolor(@_); }
4213 sub cust_statuscolor {
4215 __PACKAGE__->statuscolors->{$self->cust_status};
4218 =item tickets [ STATUS ]
4220 Returns an array of hashes representing the customer's RT tickets.
4222 An optional status (or arrayref or hashref of statuses) may be specified.
4228 my $status = ( @_ && $_[0] ) ? shift : '';
4230 my $num = $conf->config('cust_main-max_tickets') || 10;
4233 if ( $conf->config('ticket_system') ) {
4234 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4236 @tickets = @{ FS::TicketSystem->customer_tickets( $self->custnum,
4245 foreach my $priority (
4246 $conf->config('ticket_system-custom_priority_field-values'), ''
4248 last if scalar(@tickets) >= $num;
4250 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4251 $num - scalar(@tickets),
4262 =item appointments [ STATUS ]
4264 Returns an array of hashes representing the customer's RT tickets which
4271 my $status = ( @_ && $_[0] ) ? shift : '';
4273 return () unless $conf->config('ticket_system');
4275 my $queueid = $conf->config('ticket_system-appointment-queueid');
4277 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4286 # Return services representing svc_accts in customer support packages
4287 sub support_services {
4289 my %packages = map { $_ => 1 } $conf->config('support_packages');
4291 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4292 grep { $_->part_svc->svcdb eq 'svc_acct' }
4293 map { $_->cust_svc }
4294 grep { exists $packages{ $_->pkgpart } }
4295 $self->ncancelled_pkgs;
4299 # Return a list of latitude/longitude for one of the services (if any)
4300 sub service_coordinates {
4304 grep { $_->latitude && $_->longitude }
4306 map { $_->cust_svc }
4307 $self->ncancelled_pkgs;
4309 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4314 Returns a masked version of the named field
4319 my ($self,$field) = @_;
4323 'x'x(length($self->getfield($field))-4).
4324 substr($self->getfield($field), (length($self->getfield($field))-4));
4328 =item payment_history
4330 Returns an array of hashrefs standardizing information from cust_bill, cust_pay,
4331 cust_credit and cust_refund objects. Each hashref has the following fields:
4333 I<type> - one of 'Line item', 'Invoice', 'Payment', 'Credit', 'Refund' or 'Previous'
4335 I<date> - value of _date field, unix timestamp
4337 I<date_pretty> - user-friendly date
4339 I<description> - user-friendly description of item
4341 I<amount> - impact of item on user's balance
4342 (positive for Invoice/Refund/Line item, negative for Payment/Credit.)
4343 Not to be confused with the native 'amount' field in cust_credit, see below.
4345 I<amount_pretty> - includes money char
4347 I<balance> - customer balance, chronologically as of this item
4349 I<balance_pretty> - includes money char
4351 I<charged> - amount charged for cust_bill (Invoice or Line item) records, undef for other types
4353 I<paid> - amount paid for cust_pay records, undef for other types
4355 I<credit> - amount credited for cust_credit records, undef for other types.
4356 Literally the 'amount' field from cust_credit, renamed here to avoid confusion.
4358 I<refund> - amount refunded for cust_refund records, undef for other types
4360 The four table-specific keys always have positive values, whether they reflect charges or payments.
4362 The following options may be passed to this method:
4364 I<line_items> - if true, returns charges ('Line item') rather than invoices
4366 I<start_date> - unix timestamp, only include records on or after.
4367 If specified, an item of type 'Previous' will also be included.
4368 It does not have table-specific fields.
4370 I<end_date> - unix timestamp, only include records before
4372 I<reverse_sort> - order from newest to oldest (default is oldest to newest)
4374 I<conf> - optional already-loaded FS::Conf object.
4378 # Caution: this gets used by FS::ClientAPI::MyAccount::billing_history,
4379 # and also for sending customer statements, which should both be kept customer-friendly.
4380 # If you add anything that shouldn't be passed on through the API or exposed
4381 # to customers, add a new option to include it, don't include it by default
4382 sub payment_history {
4384 my $opt = ref($_[0]) ? $_[0] : { @_ };
4386 my $conf = $$opt{'conf'} || new FS::Conf;
4387 my $money_char = $conf->config("money_char") || '$',
4389 #first load entire history,
4390 #need previous to calculate previous balance
4391 #loading after end_date shouldn't hurt too much?
4393 if ( $$opt{'line_items'} ) {
4395 foreach my $cust_bill ( $self->cust_bill ) {
4398 'type' => 'Line item',
4399 'description' => $_->desc( $self->locale ).
4400 ( $_->sdate && $_->edate
4401 ? ' '. time2str('%d-%b-%Y', $_->sdate).
4402 ' To '. time2str('%d-%b-%Y', $_->edate)
4405 'amount' => sprintf('%.2f', $_->setup + $_->recur ),
4406 'charged' => sprintf('%.2f', $_->setup + $_->recur ),
4407 'date' => $cust_bill->_date,
4408 'date_pretty' => $self->time2str_local('short', $cust_bill->_date ),
4410 foreach $cust_bill->cust_bill_pkg;
4417 'type' => 'Invoice',
4418 'description' => 'Invoice #'. $_->display_invnum,
4419 'amount' => sprintf('%.2f', $_->charged ),
4420 'charged' => sprintf('%.2f', $_->charged ),
4421 'date' => $_->_date,
4422 'date_pretty' => $self->time2str_local('short', $_->_date ),
4424 foreach $self->cust_bill;
4429 'type' => 'Payment',
4430 'description' => 'Payment', #XXX type
4431 'amount' => sprintf('%.2f', 0 - $_->paid ),
4432 'paid' => sprintf('%.2f', $_->paid ),
4433 'date' => $_->_date,
4434 'date_pretty' => $self->time2str_local('short', $_->_date ),
4436 foreach $self->cust_pay;
4440 'description' => 'Credit', #more info?
4441 'amount' => sprintf('%.2f', 0 -$_->amount ),
4442 'credit' => sprintf('%.2f', $_->amount ),
4443 'date' => $_->_date,
4444 'date_pretty' => $self->time2str_local('short', $_->_date ),
4446 foreach $self->cust_credit;
4450 'description' => 'Refund', #more info? type, like payment?
4451 'amount' => $_->refund,
4452 'refund' => $_->refund,
4453 'date' => $_->_date,
4454 'date_pretty' => $self->time2str_local('short', $_->_date ),
4456 foreach $self->cust_refund;
4458 #put it all in chronological order
4459 @history = sort { $a->{'date'} <=> $b->{'date'} } @history;
4461 #calculate balance, filter items outside date range
4465 foreach my $item (@history) {
4466 last if $$opt{'end_date'} && ($$item{'date'} >= $$opt{'end_date'});
4467 $balance += $$item{'amount'};
4468 if ($$opt{'start_date'} && ($$item{'date'} < $$opt{'start_date'})) {
4469 $previous += $$item{'amount'};
4472 $$item{'balance'} = sprintf("%.2f",$balance);
4473 foreach my $key ( qw(amount balance) ) {
4474 $$item{$key.'_pretty'} = money_pretty($$item{$key});
4479 # start with previous balance, if there was one
4482 'type' => 'Previous',
4483 'description' => 'Previous balance',
4484 'amount' => sprintf("%.2f",$previous),
4485 'balance' => sprintf("%.2f",$previous),
4486 'date' => $$opt{'start_date'},
4487 'date_pretty' => $self->time2str_local('short', $$opt{'start_date'} ),
4489 #false laziness with above
4490 foreach my $key ( qw(amount balance) ) {
4491 $$item{$key.'_pretty'} = $$item{$key};
4492 $$item{$key.'_pretty'} =~ s/^(-?)/$1$money_char/;
4494 unshift(@out,$item);
4497 @out = reverse @history if $$opt{'reverse_sort'};
4502 =item save_cust_payby
4504 Saves a new cust_payby for this customer, replacing an existing entry only
4505 in select circumstances. Does not validate input.
4507 If auto is specified, marks this as the customer's primary method, or the
4508 specified weight. Existing payment methods have their weight incremented as
4511 If bill_location is specified with auto, also sets location in cust_main.
4513 Will not insert complete duplicates of existing records, or records in which the
4514 only difference from an existing record is to turn off automatic payment (will
4515 return without error.) Will replace existing records in which the only difference
4516 is to add a value to a previously empty preserved field and/or turn on automatic payment.
4517 Fields marked as preserved are optional, and existing values will not be overwritten with
4518 blanks when replacing.
4520 Accepts the following named parameters:
4530 save as an automatic payment type (CARD/CHEK if true, DCRD/DCHK if false)
4534 optional, set higher than 1 for secondary, etc.
4542 optional, but should be specified for anything that might be tokenized, will be preserved when replacing
4550 optional, will be preserved when replacing
4558 CARD only, required, FS::cust_location object
4560 =item paystart_month
4562 CARD only, optional, will be preserved when replacing
4566 CARD only, optional, will be preserved when replacing
4570 CARD only, optional, will be preserved when replacing
4574 CARD only, only used if conf cvv-save is set appropriately
4584 =item saved_cust_payby
4586 scalar reference, for returning saved object
4592 #The code for this option is in place, but it's not currently used
4596 # existing cust_payby object to be replaced (must match custnum)
4598 # stateid/stateid_state/ss are not currently supported in cust_payby,
4599 # might not even work properly in 4.x, but will need to work here if ever added
4601 sub save_cust_payby {
4605 my $old = $opt{'replace'};
4606 my $new = new FS::cust_payby { $old ? $old->hash : () };
4607 return "Customer number does not match" if $new->custnum and $new->custnum != $self->custnum;
4608 $new->set( 'custnum' => $self->custnum );
4610 my $payby = $opt{'payment_payby'};
4611 return "Bad payby" unless grep(/^$payby$/,('CARD','CHEK'));
4613 # don't allow turning off auto when replacing
4614 $opt{'auto'} ||= 1 if $old and $old->payby !~ /^D/;
4616 my @check_existing; # payby relevant to this payment_payby
4618 # set payby based on auto
4619 if ( $payby eq 'CARD' ) {
4620 $new->set( 'payby' => ( $opt{'auto'} ? 'CARD' : 'DCRD' ) );
4621 @check_existing = qw( CARD DCRD );
4622 } elsif ( $payby eq 'CHEK' ) {
4623 $new->set( 'payby' => ( $opt{'auto'} ? 'CHEK' : 'DCHK' ) );
4624 @check_existing = qw( CHEK DCHK );
4627 $new->set( 'weight' => $opt{'auto'} ? $opt{'weight'} : '' );
4630 $new->payinfo($opt{'payinfo'}); # sets default paymask, but not if it's already tokenized
4631 $new->paymask($opt{'paymask'}) if $opt{'paymask'}; # in case it's been tokenized, override with loaded paymask
4632 $new->set( 'payname' => $opt{'payname'} );
4633 $new->set( 'payip' => $opt{'payip'} ); # will be preserved below
4635 my $conf = new FS::Conf;
4637 # compare to FS::cust_main::realtime_bop - check both to make sure working correctly
4638 if ( $payby eq 'CARD' &&
4639 ( (grep { $_ eq cardtype($opt{'payinfo'}) } $conf->config('cvv-save'))
4640 || $conf->exists('business-onlinepayment-verification')
4643 $new->set( 'paycvv' => $opt{'paycvv'} );
4645 $new->set( 'paycvv' => '');
4648 local $SIG{HUP} = 'IGNORE';
4649 local $SIG{INT} = 'IGNORE';
4650 local $SIG{QUIT} = 'IGNORE';
4651 local $SIG{TERM} = 'IGNORE';
4652 local $SIG{TSTP} = 'IGNORE';
4653 local $SIG{PIPE} = 'IGNORE';
4655 my $oldAutoCommit = $FS::UID::AutoCommit;
4656 local $FS::UID::AutoCommit = 0;
4659 # set fields specific to payment_payby
4660 if ( $payby eq 'CARD' ) {
4661 if ($opt{'bill_location'}) {
4662 $opt{'bill_location'}->set('custnum' => $self->custnum);
4663 my $error = $opt{'bill_location'}->find_or_insert;
4665 $dbh->rollback if $oldAutoCommit;
4668 $new->set( 'locationnum' => $opt{'bill_location'}->locationnum );
4670 foreach my $field ( qw( paydate paystart_month paystart_year payissue ) ) {
4671 $new->set( $field => $opt{$field} );
4674 foreach my $field ( qw(paytype paystate) ) {
4675 $new->set( $field => $opt{$field} );
4679 # other cust_payby to compare this to
4680 my @existing = $self->cust_payby(@check_existing);
4682 # fields that can overwrite blanks with values, but not values with blanks
4683 my @preserve = qw( paymask locationnum paystart_month paystart_year payissue payip );
4685 my $skip_cust_payby = 0; # true if we don't need to save or reweight cust_payby
4687 # generally, we don't want to overwrite existing cust_payby with this,
4688 # but we can replace if we're only marking it auto or adding a preserved field
4689 # and we can avoid saving a total duplicate or merely turning off auto
4691 foreach my $cust_payby (@existing) {
4692 # check fields that absolutely should not change
4693 foreach my $field ($new->fields) {
4694 next if grep(/^$field$/, qw( custpaybynum payby weight ) );
4695 next if grep(/^$field$/, @preserve );
4696 next PAYBYLOOP unless $new->get($field) eq $cust_payby->get($field);
4697 # check if paymask exists, if so stop and don't save, no need for a duplicate.
4698 return '' if $new->get('paymask') eq $cust_payby->get('paymask');
4700 # now check fields that can replace if one value is blank
4702 foreach my $field (@preserve) {
4704 ( $new->get($field) and !$cust_payby->get($field) ) or
4705 ( $cust_payby->get($field) and !$new->get($field) )
4707 # prevention of overwriting values with blanks happens farther below
4709 } elsif ( $new->get($field) ne $cust_payby->get($field) ) {
4713 unless ( $replace ) {
4714 # nearly identical, now check weight
4715 if ($new->get('weight') eq $cust_payby->get('weight') or !$new->get('weight')) {
4716 # ignore identical cust_payby, and ignore attempts to turn off auto
4717 # no need to save or re-weight cust_payby (but still need to update/commit $self)
4718 $skip_cust_payby = 1;
4721 # otherwise, only change is to mark this as primary
4723 # if we got this far, we're definitely replacing
4730 $new->set( 'custpaybynum' => $old->custpaybynum );
4731 # don't turn off automatic payment (but allow it to be turned on)
4732 if ($new->payby =~ /^D/ and $new->payby ne $old->payby) {
4734 $new->set( 'payby' => $old->payby );
4735 $new->set( 'weight' => 1 );
4737 # make sure we're not overwriting values with blanks
4738 foreach my $field (@preserve) {
4739 if ( $old->get($field) and !$new->get($field) ) {
4740 $new->set( $field => $old->get($field) );
4745 # only overwrite cust_main bill_location if auto
4746 if ($opt{'auto'} && $opt{'bill_location'}) {
4747 $self->set('bill_location' => $opt{'bill_location'});
4748 my $error = $self->replace;
4750 $dbh->rollback if $oldAutoCommit;
4755 # done with everything except reweighting and saving cust_payby
4756 # still need to commit changes to cust_main and cust_location
4757 if ($skip_cust_payby) {
4758 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4762 # re-weight existing primary cust_pay for this payby
4764 foreach my $cust_payby (@existing) {
4765 # relies on cust_payby return order
4766 last unless $cust_payby->payby !~ /^D/;
4767 last if $cust_payby->weight > 1;
4768 next if $new->custpaybynum eq $cust_payby->custpaybynum;
4769 next if $cust_payby->weight < ($opt{'weight'} || 1);
4770 $cust_payby->weight( $cust_payby->weight + 1 );
4771 my $error = $cust_payby->replace;
4773 $dbh->rollback if $oldAutoCommit;
4774 return "Error reweighting cust_payby: $error";
4779 # finally, save cust_payby
4780 my $error = $old ? $new->replace($old) : $new->insert;
4782 $dbh->rollback if $oldAutoCommit;
4786 ${$opt{'saved_cust_payby'}} = $new
4787 if $opt{'saved_cust_payby'};
4789 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4794 =item remove_cvv_from_cust_payby PAYINFO
4796 Removes paycvv from associated cust_payby with matching PAYINFO.
4800 sub remove_cvv_from_cust_payby {
4801 my ($self,$payinfo) = @_;
4803 my $oldAutoCommit = $FS::UID::AutoCommit;
4804 local $FS::UID::AutoCommit = 0;
4807 foreach my $cust_payby ( qsearch('cust_payby',{ custnum => $self->custnum }) ) {
4808 next unless $cust_payby->payinfo eq $payinfo; # can't qsearch on payinfo
4809 $cust_payby->paycvv('');
4810 my $error = $cust_payby->replace;
4812 $dbh->rollback if $oldAutoCommit;
4817 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4823 =head1 CLASS METHODS
4829 Class method that returns the list of possible status strings for customers
4830 (see L<the status method|/status>). For example:
4832 @statuses = FS::cust_main->statuses();
4838 keys %{ $self->statuscolors };
4841 =item cust_status_sql
4843 Returns an SQL fragment to determine the status of a cust_main record, as a
4848 sub cust_status_sql {
4850 for my $status ( FS::cust_main->statuses() ) {
4851 my $method = $status.'_sql';
4852 $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4861 Returns an SQL expression identifying prospective cust_main records (customers
4862 with no packages ever ordered)
4866 use vars qw($select_count_pkgs);
4867 $select_count_pkgs =
4868 "SELECT COUNT(*) FROM cust_pkg
4869 WHERE cust_pkg.custnum = cust_main.custnum";
4871 sub select_count_pkgs_sql {
4876 " 0 = ( $select_count_pkgs ) ";
4881 Returns an SQL expression identifying ordered cust_main records (customers with
4882 no active packages, but recurring packages not yet setup or one time charges
4888 FS::cust_main->none_active_sql.
4889 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4894 Returns an SQL expression identifying active cust_main records (customers with
4895 active recurring packages).
4900 " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4903 =item none_active_sql
4905 Returns an SQL expression identifying cust_main records with no active
4906 recurring packages. This includes customers of status prospect, ordered,
4907 inactive, and suspended.
4911 sub none_active_sql {
4912 " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4917 Returns an SQL expression identifying inactive cust_main records (customers with
4918 no active recurring packages, but otherwise unsuspended/uncancelled).
4923 FS::cust_main->none_active_sql.
4924 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4930 Returns an SQL expression identifying suspended cust_main records.
4935 sub suspended_sql { susp_sql(@_); }
4937 FS::cust_main->none_active_sql.
4938 " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4944 Returns an SQL expression identifying cancelled cust_main records.
4948 sub cancel_sql { shift->cancelled_sql(@_); }
4951 =item uncancelled_sql
4953 Returns an SQL expression identifying un-cancelled cust_main records.
4957 sub uncancelled_sql { uncancel_sql(@_); }
4960 "( NOT (".$self->cancelled_sql.") )"; #sensitive to cust_main-status_module
4965 Returns an SQL fragment to retreive the balance.
4970 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4971 WHERE cust_bill.custnum = cust_main.custnum )
4972 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
4973 WHERE cust_pay.custnum = cust_main.custnum )
4974 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
4975 WHERE cust_credit.custnum = cust_main.custnum )
4976 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
4977 WHERE cust_refund.custnum = cust_main.custnum )
4980 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4982 Returns an SQL fragment to retreive the balance for this customer, optionally
4983 considering invoices with date earlier than START_TIME, and not
4984 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4985 total_unapplied_payments).
4987 Times are specified as SQL fragments or numeric
4988 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
4989 L<Date::Parse> for conversion functions. The empty string can be passed
4990 to disable that time constraint completely.
4992 Available options are:
4996 =item unapplied_date
4998 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)
5003 set to true to remove all customer comparison clauses, for totals
5008 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5013 JOIN clause (typically used with the total option)
5017 An absolute cutoff time. Payments, credits, and refunds I<applied> after this
5018 time will be ignored. Note that START_TIME and END_TIME only limit the date
5019 range for invoices and I<unapplied> payments, credits, and refunds.
5025 sub balance_date_sql {
5026 my( $class, $start, $end, %opt ) = @_;
5028 my $cutoff = $opt{'cutoff'};
5030 my $owed = FS::cust_bill->owed_sql($cutoff);
5031 my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
5032 my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
5033 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5035 my $j = $opt{'join'} || '';
5037 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5038 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5039 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5040 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5042 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5043 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5044 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5045 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5050 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
5052 Returns an SQL fragment to retreive the total unapplied payments for this
5053 customer, only considering payments with date earlier than START_TIME, and
5054 optionally not later than END_TIME.
5056 Times are specified as SQL fragments or numeric
5057 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5058 L<Date::Parse> for conversion functions. The empty string can be passed
5059 to disable that time constraint completely.
5061 Available options are:
5065 sub unapplied_payments_date_sql {
5066 my( $class, $start, $end, %opt ) = @_;
5068 my $cutoff = $opt{'cutoff'};
5070 my $unapp_pay = FS::cust_pay->unapplied_sql($cutoff);
5072 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
5073 'unapplied_date'=>1 );
5075 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
5078 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5080 Helper method for balance_date_sql; name (and usage) subject to change
5081 (suggestions welcome).
5083 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5084 cust_refund, cust_credit or cust_pay).
5086 If TABLE is "cust_bill" or the unapplied_date option is true, only
5087 considers records with date earlier than START_TIME, and optionally not
5088 later than END_TIME .
5092 sub _money_table_where {
5093 my( $class, $table, $start, $end, %opt ) = @_;
5096 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5097 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5098 push @where, "$table._date <= $start" if defined($start) && length($start);
5099 push @where, "$table._date > $end" if defined($end) && length($end);
5101 push @where, @{$opt{'where'}} if $opt{'where'};
5102 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5108 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
5109 use FS::cust_main::Search;
5112 FS::cust_main::Search->search(@_);
5121 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5123 Generates a templated notification to the customer (see L<Text::Template>).
5125 OPTIONS is a hash and may include
5127 I<extra_fields> - a hashref of name/value pairs which will be substituted
5128 into the template. These values may override values mentioned below
5129 and those from the customer record.
5131 I<template_text> - if present, ignores TEMPLATE_NAME and uses the provided text
5133 The following variables are available in the template instead of or in addition
5134 to the fields of the customer record.
5136 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5140 # a lot like cust_bill::print_latex
5141 sub generate_letter {
5142 my ($self, $template, %options) = @_;
5144 warn "Template $template does not exist" && return
5145 unless $conf->exists($template) || $options{'template_text'};
5147 my $template_source = $options{'template_text'}
5148 ? [ $options{'template_text'} ]
5149 : [ map "$_\n", $conf->config($template) ];
5151 my $letter_template = new Text::Template
5153 SOURCE => $template_source,
5154 DELIMITERS => [ '[@--', '--@]' ],
5156 or die "can't create new Text::Template object: Text::Template::ERROR";
5158 $letter_template->compile()
5159 or die "can't compile template: Text::Template::ERROR";
5161 my %letter_data = map { $_ => $self->$_ } $self->fields;
5163 for (keys %{$options{extra_fields}}){
5164 $letter_data{$_} = $options{extra_fields}->{$_};
5167 unless(exists($letter_data{returnaddress})){
5168 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5169 $self->agent_template)
5171 if ( length($retadd) ) {
5172 $letter_data{returnaddress} = $retadd;
5173 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
5174 $letter_data{returnaddress} =
5175 join( "\n", map { s/( {2,})/'~' x length($1)/eg;
5179 ( $conf->config('company_name', $self->agentnum),
5180 $conf->config('company_address', $self->agentnum),
5184 $letter_data{returnaddress} = '~';
5188 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5190 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
5192 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
5194 my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5198 ) or die "can't open temp file: $!\n";
5199 print $lh $conf->config_binary('logo.eps', $self->agentnum)
5200 or die "can't write temp file: $!\n";
5202 $letter_data{'logo_file'} = $lh->filename;
5204 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5208 ) or die "can't open temp file: $!\n";
5210 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5212 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5213 return ($1, $letter_data{'logo_file'});
5217 =item print_ps TEMPLATE
5219 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5225 my($file, $lfile) = $self->generate_letter(@_);
5226 my $ps = FS::Misc::generate_ps($file);
5227 unlink($file.'.tex');
5233 =item print TEMPLATE
5235 Prints the filled in template.
5237 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5241 sub queueable_print {
5244 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5245 or die "invalid customer number: " . $opt{custnum};
5247 #do not backport this change to 3.x
5248 # my $error = $self->print( { 'template' => $opt{template} } );
5249 my $error = $self->print( $opt{'template'} );
5250 die $error if $error;
5254 my ($self, $template) = (shift, shift);
5256 [ $self->print_ps($template) ],
5257 'agentnum' => $self->agentnum,
5261 #these three subs should just go away once agent stuff is all config overrides
5263 sub agent_template {
5265 $self->_agent_plandata('agent_templatename');
5268 sub agent_invoice_from {
5270 $self->_agent_plandata('agent_invoice_from');
5273 sub _agent_plandata {
5274 my( $self, $option ) = @_;
5276 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5277 #agent-specific Conf
5279 use FS::part_event::Condition;
5281 my $agentnum = $self->agentnum;
5283 my $regexp = regexp_sql();
5285 my $part_event_option =
5287 'select' => 'part_event_option.*',
5288 'table' => 'part_event_option',
5290 LEFT JOIN part_event USING ( eventpart )
5291 LEFT JOIN part_event_option AS peo_agentnum
5292 ON ( part_event.eventpart = peo_agentnum.eventpart
5293 AND peo_agentnum.optionname = 'agentnum'
5294 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5296 LEFT JOIN part_event_condition
5297 ON ( part_event.eventpart = part_event_condition.eventpart
5298 AND part_event_condition.conditionname = 'cust_bill_age'
5300 LEFT JOIN part_event_condition_option
5301 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
5302 AND part_event_condition_option.optionname = 'age'
5305 #'hashref' => { 'optionname' => $option },
5306 #'hashref' => { 'part_event_option.optionname' => $option },
5308 " WHERE part_event_option.optionname = ". dbh->quote($option).
5309 " AND action = 'cust_bill_send_agent' ".
5310 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5311 " AND peo_agentnum.optionname = 'agentnum' ".
5312 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
5314 CASE WHEN part_event_condition_option.optionname IS NULL
5316 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
5318 , part_event.weight".
5322 unless ( $part_event_option ) {
5323 return $self->agent->invoice_template || ''
5324 if $option eq 'agent_templatename';
5328 $part_event_option->optionvalue;
5332 sub process_o2m_qsearch {
5335 return qsearch($table, @_) unless $table eq 'contact';
5337 my $hashref = shift;
5338 my %hash = %$hashref;
5339 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5340 or die 'guru meditation #4343';
5342 qsearch({ 'table' => 'contact',
5343 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5344 'hashref' => \%hash,
5345 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5346 " cust_contact.custnum = $custnum "
5350 sub process_o2m_qsearchs {
5353 return qsearchs($table, @_) unless $table eq 'contact';
5355 my $hashref = shift;
5356 my %hash = %$hashref;
5357 ( my $custnum = delete $hash{'custnum'} ) =~ /^(\d+)$/
5358 or die 'guru meditation #2121';
5360 qsearchs({ 'table' => 'contact',
5361 'addl_from' => 'LEFT JOIN cust_contact USING ( contactnum )',
5362 'hashref' => \%hash,
5363 'extra_sql' => ( keys %hash ? ' AND ' : ' WHERE ' ).
5364 " cust_contact.custnum = $custnum "
5368 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5370 Subroutine (not a method), designed to be called from the queue.
5372 Takes a list of options and values.
5374 Pulls up the customer record via the custnum option and calls bill_and_collect.
5379 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5381 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5382 warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
5384 #without this errors don't get rolled back
5385 $args{'fatal'} = 1; # runs from job queue, will be caught
5387 $cust_main->bill_and_collect( %args );
5390 =item queued_collect 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
5392 Like queued_bill, but instead of C<bill_and_collect>, just runs the
5393 C<collect> part. This is used in batch tax calculation, where invoice
5394 generation and collection events have to be completely separated.
5398 sub queued_collect {
5400 my $cust_main = FS::cust_main->by_key($args{'custnum'});
5402 $cust_main->collect(%args);
5405 sub process_bill_and_collect {
5408 my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
5409 or die "custnum '$param->{custnum}' not found!\n";
5410 $param->{'job'} = $job;
5411 $param->{'fatal'} = 1; # runs from job queue, will be caught
5412 $param->{'retry'} = 1;
5414 $cust_main->bill_and_collect( %$param );
5417 #starting to take quite a while for big dbs
5418 # (JRNL: journaled so it only happens once per database)
5419 # - seq scan of h_cust_main (yuck), but not going to index paycvv, so
5420 # JRNL seq scan of cust_main on signupdate... index signupdate? will that help?
5421 # JRNL seq scan of cust_main on paydate... index on substrings? maybe set an
5422 # JRNL seq scan of cust_main on payinfo.. certainly not going toi ndex that...
5423 # JRNL leading/trailing spaces in first, last, company
5424 # JRNL migrate to cust_payby
5425 # - otaker upgrade? journal and call it good? (double check to make sure
5426 # we're not still setting otaker here)
5428 #only going to get worse with new location stuff...
5430 sub _upgrade_data { #class method
5431 my ($class, %opts) = @_;
5433 my @statements = ();
5435 #this seems to be the only expensive one.. why does it take so long?
5436 unless ( FS::upgrade_journal->is_done('cust_main__signupdate') ) {
5438 'UPDATE cust_main SET signupdate = (SELECT signupdate FROM h_cust_main WHERE signupdate IS NOT NULL AND h_cust_main.custnum = cust_main.custnum ORDER BY historynum DESC LIMIT 1) WHERE signupdate IS NULL';
5439 FS::upgrade_journal->set_done('cust_main__signupdate');
5443 foreach my $sql ( @statements ) {
5444 my $sth = dbh->prepare($sql) or die dbh->errstr;
5445 $sth->execute or die $sth->errstr;
5446 #warn ( (time - $t). " seconds\n" );
5450 local($ignore_expired_card) = 1;
5451 local($ignore_banned_card) = 1;
5452 local($skip_fuzzyfiles) = 1;
5453 local($import) = 1; #prevent automatic geocoding (need its own variable?)
5455 FS::cust_main::Location->_upgrade_data(%opts);
5457 unless ( FS::upgrade_journal->is_done('cust_main__trimspaces') ) {
5459 foreach my $cust_main ( qsearch({
5460 'table' => 'cust_main',
5462 'extra_sql' => 'WHERE '.
5464 map "$_ LIKE ' %' OR $_ LIKE '% ' OR $_ LIKE '% %'",
5465 qw( first last company )
5468 my $error = $cust_main->replace;
5469 die $error if $error;
5472 FS::upgrade_journal->set_done('cust_main__trimspaces');
5476 $class->_upgrade_otaker(%opts);
5478 # turn on encryption as part of regular upgrade, so all new records are immediately encrypted
5479 # existing records will be encrypted in queueable_upgrade (below)
5480 unless ($conf->exists('encryptionpublickey') || $conf->exists('encryptionprivatekey')) {
5481 eval "use FS::Setup";
5483 FS::Setup::enable_encryption();
5488 sub queueable_upgrade {
5491 ### encryption gets turned on in _upgrade_data, above
5493 eval "use FS::upgrade_journal";
5496 # prior to 2013 (commit f16665c9) payinfo was stored in history if not
5497 # encrypted, clear that out before encrypting/tokenizing anything else
5498 if (!FS::upgrade_journal->is_done('clear_payinfo_history')) {
5499 foreach my $table (qw(
5500 cust_payby cust_pay_pending cust_pay cust_pay_void cust_refund
5503 'UPDATE h_'.$table.' SET payinfo = NULL WHERE payinfo IS NOT NULL';
5504 my $sth = dbh->prepare($sql) or die dbh->errstr;
5505 $sth->execute or die $sth->errstr;
5507 FS::upgrade_journal->set_done('clear_payinfo_history');
5510 # fix Tokenized paycardtype and encrypt old records
5511 if ( ! FS::upgrade_journal->is_done('paycardtype_Tokenized')
5512 || ! FS::upgrade_journal->is_done('encryption_check')
5516 # allow replacement of closed cust_pay/cust_refund records
5517 local $FS::payinfo_Mixin::allow_closed_replace = 1;
5519 # because it looks like nothing's changing
5520 local $FS::Record::no_update_diff = 1;
5522 # commit everything immediately
5523 local $FS::UID::AutoCommit = 1;
5525 # encrypt what's there
5526 foreach my $table (qw(
5527 cust_payby cust_pay_pending cust_pay cust_pay_void cust_refund
5529 my $tclass = 'FS::'.$table;
5533 my $recnum = _upgrade_next_recnum(dbh,$table,\$lastrecnum,\@recnums)
5535 my $record = $tclass->by_key($recnum);
5536 next unless $record; # small chance it's been deleted, that's ok
5537 next unless grep { $record->payby eq $_ } @FS::Record::encrypt_payby;
5538 # window for possible conflict is practically nonexistant,
5539 # but just in case...
5540 $record = $record->select_for_update;
5541 if (!$record->custnum && $table eq 'cust_pay_pending') {
5542 $record->set('custnum_pending',1);
5544 $record->paycardtype('') if $record->paycardtype eq 'Tokenized';
5546 local($ignore_expired_card) = 1;
5547 local($ignore_banned_card) = 1;
5548 local($skip_fuzzyfiles) = 1;
5549 local($import) = 1;#prevent automatic geocoding (need its own variable?)
5551 my $error = $record->replace;
5552 die "Error replacing $table ".$record->get($record->primary_key).": $error" if $error;
5556 FS::upgrade_journal->set_done('paycardtype_Tokenized');
5557 FS::upgrade_journal->set_done('encryption_check') if $conf->exists('encryption');
5560 # now that everything's encrypted, tokenize...
5561 FS::cust_main::Billing_Realtime::token_check(@_);
5564 # not entirely false laziness w/ Billing_Realtime::_token_check_next_recnum
5565 # cust_payby might get deleted while this runs
5567 sub _upgrade_next_recnum {
5568 my ($dbh,$table,$lastrecnum,$recnums) = @_;
5569 my $recnum = shift @$recnums;
5570 return $recnum if $recnum;
5571 my $tclass = 'FS::'.$table;
5572 my $paycardtypecheck = ($table ne 'cust_pay_pending') ? q( OR paycardtype = 'Tokenized') : '';
5573 my $sql = 'SELECT '.$tclass->primary_key.
5575 ' WHERE '.$tclass->primary_key.' > '.$$lastrecnum.
5576 " AND payby IN ( 'CARD', 'DCRD', 'CHEK', 'DCHK' ) ".
5577 " AND ( length(payinfo) < 80$paycardtypecheck ) ".
5578 ' ORDER BY '.$tclass->primary_key.' LIMIT 500';
5579 my $sth = $dbh->prepare($sql) or die $dbh->errstr;
5580 $sth->execute() or die $sth->errstr;
5582 while (my $rec = $sth->fetchrow_hashref) {
5583 push @$recnums, $rec->{$tclass->primary_key};
5586 $$lastrecnum = $$recnums[-1];
5587 return shift @$recnums;
5596 The delete method should possibly take an FS::cust_main object reference
5597 instead of a scalar customer number.
5599 Bill and collect options should probably be passed as references instead of a
5602 There should probably be a configuration file with a list of allowed credit
5605 No multiple currency support (probably a larger project than just this module).
5607 Birthdates rely on negative epoch values.
5609 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5613 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5614 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5615 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.