4 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf @encrypted_fields
5 $import $skip_fuzzyfiles $ignore_expired_card );
6 use vars qw( $realtime_bop_decline_quiet ); #ugh
11 eval "use Time::Local;";
12 die "Time::Local minimum version 1.05 required with Perl versions before 5.6"
13 if $] < 5.006 && !defined($Time::Local::VERSION);
14 #eval "use Time::Local qw(timelocal timelocal_nocheck);";
15 eval "use Time::Local qw(timelocal_nocheck);";
17 use Digest::MD5 qw(md5_base64);
21 use String::Approx qw(amatch);
22 use Business::CreditCard 0.28;
23 use FS::UID qw( getotaker dbh );
24 use FS::Record qw( qsearchs qsearch dbdef );
25 use FS::Misc qw( send_email );
26 use FS::Msgcat qw(gettext);
30 use FS::cust_bill_pkg;
32 use FS::cust_pay_void;
35 use FS::part_referral;
36 use FS::cust_main_county;
38 use FS::cust_main_invoice;
39 use FS::cust_credit_bill;
40 use FS::cust_bill_pay;
41 use FS::prepay_credit;
44 use FS::part_bill_event;
45 use FS::cust_bill_event;
46 use FS::cust_tax_exempt;
47 use FS::cust_tax_exempt_pkg;
49 use FS::payment_gateway;
50 use FS::agent_payment_gateway;
53 @ISA = qw( FS::Record );
55 @EXPORT_OK = qw( smart_search );
57 $realtime_bop_decline_quiet = 0;
59 # 1 is mostly method/subroutine entry and options
60 # 2 traces progress of some operations
61 # 3 is even more information including possibly sensitive data
63 $me = '[FS::cust_main]';
67 $ignore_expired_card = 0;
69 @encrypted_fields = ('payinfo', 'paycvv');
71 #ask FS::UID to run this stuff for us later
72 #$FS::UID::callback{'FS::cust_main'} = sub {
73 install_callback FS::UID sub {
75 #yes, need it for stuff below (prolly should be cached)
80 my ( $hashref, $cache ) = @_;
81 if ( exists $hashref->{'pkgnum'} ) {
82 # #@{ $self->{'_pkgnum'} } = ();
83 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
84 $self->{'_pkgnum'} = $subcache;
85 #push @{ $self->{'_pkgnum'} },
86 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
92 FS::cust_main - Object methods for cust_main records
98 $record = new FS::cust_main \%hash;
99 $record = new FS::cust_main { 'column' => 'value' };
101 $error = $record->insert;
103 $error = $new_record->replace($old_record);
105 $error = $record->delete;
107 $error = $record->check;
109 @cust_pkg = $record->all_pkgs;
111 @cust_pkg = $record->ncancelled_pkgs;
113 @cust_pkg = $record->suspended_pkgs;
115 $error = $record->bill;
116 $error = $record->bill %options;
117 $error = $record->bill 'time' => $time;
119 $error = $record->collect;
120 $error = $record->collect %options;
121 $error = $record->collect 'invoice_time' => $time,
126 An FS::cust_main object represents a customer. FS::cust_main inherits from
127 FS::Record. The following fields are currently supported:
131 =item custnum - primary key (assigned automatically for new customers)
133 =item agentnum - agent (see L<FS::agent>)
135 =item refnum - Advertising source (see L<FS::part_referral>)
141 =item ss - social security number (optional)
143 =item company - (optional)
147 =item address2 - (optional)
151 =item county - (optional, see L<FS::cust_main_county>)
153 =item state - (see L<FS::cust_main_county>)
157 =item country - (see L<FS::cust_main_county>)
159 =item daytime - phone (optional)
161 =item night - phone (optional)
163 =item fax - phone (optional)
165 =item ship_first - name
167 =item ship_last - name
169 =item ship_company - (optional)
173 =item ship_address2 - (optional)
177 =item ship_county - (optional, see L<FS::cust_main_county>)
179 =item ship_state - (see L<FS::cust_main_county>)
183 =item ship_country - (see L<FS::cust_main_county>)
185 =item ship_daytime - phone (optional)
187 =item ship_night - phone (optional)
189 =item ship_fax - phone (optional)
193 I<CARD> (credit card - automatic), I<DCRD> (credit card - on-demand), I<CHEK> (electronic check - automatic), I<DCHK> (electronic check - on-demand), I<LECB> (Phone bill billing), I<BILL> (billing), I<COMP> (free), or I<PREPAY> (special billing type: applies a credit - see L<FS::prepay_credit> and sets billing type to I<BILL>)
197 Card Number, P.O., comp issuer (4-8 lowercase alphanumerics; think username) or prepayment identifier (see L<FS::prepay_credit>)
202 my($self,$payinfo) = @_;
203 if ( defined($payinfo) ) {
204 $self->paymask($payinfo);
205 $self->setfield('payinfo', $payinfo); # This is okay since we are the 'setter'
207 $payinfo = $self->getfield('payinfo'); # This is okay since we are the 'getter'
215 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
219 =item paymask - Masked payment type
225 Mask all but the last four characters.
229 Mask all but last 2 of account number and bank routing number.
233 Do nothing, return the unmasked string.
242 # If it doesn't exist then generate it
243 my $paymask=$self->getfield('paymask');
244 if (!defined($value) && (!defined($paymask) || $paymask eq '')) {
245 $value = $self->payinfo;
248 if ( defined($value) && !$self->is_encrypted($value)) {
249 my $payinfo = $value;
250 my $payby = $self->payby;
251 if ($payby eq 'CARD' || $payby eq 'DCRD') { # Credit Cards (Show last four)
252 $paymask = 'x'x(length($payinfo)-4). substr($payinfo,(length($payinfo)-4));
253 } elsif ($payby eq 'CHEK' ||
254 $payby eq 'DCHK' ) { # Checks (Show last 2 @ bank)
255 my( $account, $aba ) = split('@', $payinfo );
256 $paymask = 'x'x(length($account)-2). substr($account,(length($account)-2))."@".$aba;
257 } else { # Tie up loose ends
260 $self->setfield('paymask', $paymask); # This is okay since we are the 'setter'
261 } elsif (defined($value) && $self->is_encrypted($value)) {
267 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
269 =item paystart_month - start date month (maestro/solo cards only)
271 =item paystart_year - start date year (maestro/solo cards only)
273 =item payissue - issue number (maestro/solo cards only)
275 =item payname - name on card or billing name
277 =item payip - IP address from which payment information was received
279 =item tax - tax exempt, empty or `Y'
281 =item otaker - order taker (assigned automatically, see L<FS::UID>)
283 =item comments - comments (optional)
285 =item referral_custnum - referring customer number
287 =item spool_cdr - Enable individual CDR spooling, empty or `Y'
297 Creates a new customer. To add the customer to the database, see L<"insert">.
299 Note that this stores the hash reference, not a distinct copy of the hash it
300 points to. You can ask the object for a copy with the I<hash> method.
304 sub table { 'cust_main'; }
306 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
308 Adds this customer to the database. If there is an error, returns the error,
309 otherwise returns false.
311 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
312 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
313 are inserted atomicly, or the transaction is rolled back. Passing an empty
314 hash reference is equivalent to not supplying this parameter. There should be
315 a better explanation of this, but until then, here's an example:
318 tie %hash, 'Tie::RefHash'; #this part is important
320 $cust_pkg => [ $svc_acct ],
323 $cust_main->insert( \%hash );
325 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
326 be set as the invoicing list (see L<"invoicing_list">). Errors return as
327 expected and rollback the entire transaction; it is not necessary to call
328 check_invoicing_list first. The invoicing_list is set after the records in the
329 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
330 invoicing_list destination to the newly-created svc_acct. Here's an example:
332 $cust_main->insert( {}, [ $email, 'POST' ] );
334 Currently available options are: I<depend_jobnum> and I<noexport>.
336 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
337 on the supplied jobnum (they will not run until the specific job completes).
338 This can be used to defer provisioning until some action completes (such
339 as running the customer's credit card successfully).
341 The I<noexport> option is deprecated. If I<noexport> is set true, no
342 provisioning jobs (exports) are scheduled. (You can schedule them later with
343 the B<reexport> method.)
349 my $cust_pkgs = @_ ? shift : {};
350 my $invoicing_list = @_ ? shift : '';
352 warn "$me insert called with options ".
353 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
356 local $SIG{HUP} = 'IGNORE';
357 local $SIG{INT} = 'IGNORE';
358 local $SIG{QUIT} = 'IGNORE';
359 local $SIG{TERM} = 'IGNORE';
360 local $SIG{TSTP} = 'IGNORE';
361 local $SIG{PIPE} = 'IGNORE';
363 my $oldAutoCommit = $FS::UID::AutoCommit;
364 local $FS::UID::AutoCommit = 0;
367 my $prepay_identifier = '';
368 my( $amount, $seconds ) = ( 0, 0 );
370 if ( $self->payby eq 'PREPAY' ) {
372 $self->payby('BILL');
373 $prepay_identifier = $self->payinfo;
376 warn " looking up prepaid card $prepay_identifier\n"
379 my $error = $self->get_prepay($prepay_identifier, \$amount, \$seconds);
381 $dbh->rollback if $oldAutoCommit;
382 #return "error applying prepaid card (transaction rolled back): $error";
386 $payby = 'PREP' if $amount;
388 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
391 $self->payby('BILL');
392 $amount = $self->paid;
396 warn " inserting $self\n"
399 my $error = $self->SUPER::insert;
401 $dbh->rollback if $oldAutoCommit;
402 #return "inserting cust_main record (transaction rolled back): $error";
406 warn " setting invoicing list\n"
409 if ( $invoicing_list ) {
410 $error = $self->check_invoicing_list( $invoicing_list );
412 $dbh->rollback if $oldAutoCommit;
413 return "checking invoicing_list (transaction rolled back): $error";
415 $self->invoicing_list( $invoicing_list );
418 warn " ordering packages\n"
421 $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
423 $dbh->rollback if $oldAutoCommit;
428 $dbh->rollback if $oldAutoCommit;
429 return "No svc_acct record to apply pre-paid time";
433 warn " inserting initial $payby payment of $amount\n"
435 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
437 $dbh->rollback if $oldAutoCommit;
438 return "inserting payment (transaction rolled back): $error";
442 unless ( $import || $skip_fuzzyfiles ) {
443 warn " queueing fuzzyfiles update\n"
445 $error = $self->queue_fuzzyfiles_update;
447 $dbh->rollback if $oldAutoCommit;
448 return "updating fuzzy search cache: $error";
452 warn " insert complete; committing transaction\n"
455 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
460 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
462 Like the insert method on an existing record, this method orders a package
463 and included services atomicaly. Pass a Tie::RefHash data structure to this
464 method containing FS::cust_pkg and FS::svc_I<tablename> objects. There should
465 be a better explanation of this, but until then, here's an example:
468 tie %hash, 'Tie::RefHash'; #this part is important
470 $cust_pkg => [ $svc_acct ],
473 $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
475 Services can be new, in which case they are inserted, or existing unaudited
476 services, in which case they are linked to the newly-created package.
478 Currently available options are: I<depend_jobnum> and I<noexport>.
480 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
481 on the supplied jobnum (they will not run until the specific job completes).
482 This can be used to defer provisioning until some action completes (such
483 as running the customer's credit card successfully).
485 The I<noexport> option is deprecated. If I<noexport> is set true, no
486 provisioning jobs (exports) are scheduled. (You can schedule them later with
487 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
488 on the cust_main object is not recommended, as existing services will also be
495 my $cust_pkgs = shift;
498 my %svc_options = ();
499 $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
500 if exists $options{'depend_jobnum'};
501 warn "$me order_pkgs called with options ".
502 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
505 local $SIG{HUP} = 'IGNORE';
506 local $SIG{INT} = 'IGNORE';
507 local $SIG{QUIT} = 'IGNORE';
508 local $SIG{TERM} = 'IGNORE';
509 local $SIG{TSTP} = 'IGNORE';
510 local $SIG{PIPE} = 'IGNORE';
512 my $oldAutoCommit = $FS::UID::AutoCommit;
513 local $FS::UID::AutoCommit = 0;
516 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
518 foreach my $cust_pkg ( keys %$cust_pkgs ) {
519 $cust_pkg->custnum( $self->custnum );
520 my $error = $cust_pkg->insert;
522 $dbh->rollback if $oldAutoCommit;
523 return "inserting cust_pkg (transaction rolled back): $error";
525 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
526 if ( $svc_something->svcnum ) {
527 my $old_cust_svc = $svc_something->cust_svc;
528 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
529 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
530 $error = $new_cust_svc->replace($old_cust_svc);
532 $svc_something->pkgnum( $cust_pkg->pkgnum );
533 if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
534 $svc_something->seconds( $svc_something->seconds + $$seconds );
537 $error = $svc_something->insert(%svc_options);
540 $dbh->rollback if $oldAutoCommit;
541 #return "inserting svc_ (transaction rolled back): $error";
547 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
551 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF ]
553 Recharges this (existing) customer with the specified prepaid card (see
554 L<FS::prepay_credit>), specified either by I<identifier> or as an
555 FS::prepay_credit object. If there is an error, returns the error, otherwise
558 Optionally, two scalar references can be passed as well. They will have their
559 values filled in with the amount and number of seconds applied by this prepaid
564 sub recharge_prepay {
565 my( $self, $prepay_credit, $amountref, $secondsref ) = @_;
567 local $SIG{HUP} = 'IGNORE';
568 local $SIG{INT} = 'IGNORE';
569 local $SIG{QUIT} = 'IGNORE';
570 local $SIG{TERM} = 'IGNORE';
571 local $SIG{TSTP} = 'IGNORE';
572 local $SIG{PIPE} = 'IGNORE';
574 my $oldAutoCommit = $FS::UID::AutoCommit;
575 local $FS::UID::AutoCommit = 0;
578 my( $amount, $seconds ) = ( 0, 0 );
580 my $error = $self->get_prepay($prepay_credit, \$amount, \$seconds)
581 || $self->increment_seconds($seconds)
582 || $self->insert_cust_pay_prepay( $amount,
584 ? $prepay_credit->identifier
589 $dbh->rollback if $oldAutoCommit;
593 if ( defined($amountref) ) { $$amountref = $amount; }
594 if ( defined($secondsref) ) { $$secondsref = $seconds; }
596 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
601 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
603 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
604 specified either by I<identifier> or as an FS::prepay_credit object.
606 References to I<amount> and I<seconds> scalars should be passed as arguments
607 and will be incremented by the values of the prepaid card.
609 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
610 check or set this customer's I<agentnum>.
612 If there is an error, returns the error, otherwise returns false.
618 my( $self, $prepay_credit, $amountref, $secondsref ) = @_;
620 local $SIG{HUP} = 'IGNORE';
621 local $SIG{INT} = 'IGNORE';
622 local $SIG{QUIT} = 'IGNORE';
623 local $SIG{TERM} = 'IGNORE';
624 local $SIG{TSTP} = 'IGNORE';
625 local $SIG{PIPE} = 'IGNORE';
627 my $oldAutoCommit = $FS::UID::AutoCommit;
628 local $FS::UID::AutoCommit = 0;
631 unless ( ref($prepay_credit) ) {
633 my $identifier = $prepay_credit;
635 $prepay_credit = qsearchs(
637 { 'identifier' => $prepay_credit },
642 unless ( $prepay_credit ) {
643 $dbh->rollback if $oldAutoCommit;
644 return "Invalid prepaid card: ". $identifier;
649 if ( $prepay_credit->agentnum ) {
650 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
651 $dbh->rollback if $oldAutoCommit;
652 return "prepaid card not valid for agent ". $self->agentnum;
654 $self->agentnum($prepay_credit->agentnum);
657 my $error = $prepay_credit->delete;
659 $dbh->rollback if $oldAutoCommit;
660 return "removing prepay_credit (transaction rolled back): $error";
663 $$amountref += $prepay_credit->amount;
664 $$secondsref += $prepay_credit->seconds;
666 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
671 =item increment_seconds SECONDS
673 Updates this customer's single or primary account (see L<FS::svc_acct>) by
674 the specified number of seconds. If there is an error, returns the error,
675 otherwise returns false.
679 sub increment_seconds {
680 my( $self, $seconds ) = @_;
681 warn "$me increment_seconds called: $seconds seconds\n"
684 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
685 $self->ncancelled_pkgs;
688 return 'No packages with primary or single services found'.
689 ' to apply pre-paid time';
690 } elsif ( scalar(@cust_pkg) > 1 ) {
691 #maybe have a way to specify the package/account?
692 return 'Multiple packages found to apply pre-paid time';
695 my $cust_pkg = $cust_pkg[0];
696 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
700 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
703 return 'No account found to apply pre-paid time';
704 } elsif ( scalar(@cust_svc) > 1 ) {
705 return 'Multiple accounts found to apply pre-paid time';
708 my $svc_acct = $cust_svc[0]->svc_x;
709 warn " found service svcnum ". $svc_acct->pkgnum.
710 ' ('. $svc_acct->email. ")\n"
713 $svc_acct->increment_seconds($seconds);
717 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
719 Inserts a prepayment in the specified amount for this customer. An optional
720 second argument can specify the prepayment identifier for tracking purposes.
721 If there is an error, returns the error, otherwise returns false.
725 sub insert_cust_pay_prepay {
726 shift->insert_cust_pay('PREP', @_);
729 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
731 Inserts a cash payment in the specified amount for this customer. An optional
732 second argument can specify the payment identifier for tracking purposes.
733 If there is an error, returns the error, otherwise returns false.
737 sub insert_cust_pay_cash {
738 shift->insert_cust_pay('CASH', @_);
741 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
743 Inserts a Western Union payment in the specified amount for this customer. An
744 optional second argument can specify the prepayment identifier for tracking
745 purposes. If there is an error, returns the error, otherwise returns false.
749 sub insert_cust_pay_west {
750 shift->insert_cust_pay('WEST', @_);
753 sub insert_cust_pay {
754 my( $self, $payby, $amount ) = splice(@_, 0, 3);
755 my $payinfo = scalar(@_) ? shift : '';
757 my $cust_pay = new FS::cust_pay {
758 'custnum' => $self->custnum,
759 'paid' => sprintf('%.2f', $amount),
760 #'_date' => #date the prepaid card was purchased???
762 'payinfo' => $payinfo,
770 This method is deprecated. See the I<depend_jobnum> option to the insert and
771 order_pkgs methods for a better way to defer provisioning.
773 Re-schedules all exports by calling the B<reexport> method of all associated
774 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
775 otherwise returns false.
782 carp "WARNING: FS::cust_main::reexport is deprectated; ".
783 "use the depend_jobnum option to insert or order_pkgs to delay export";
785 local $SIG{HUP} = 'IGNORE';
786 local $SIG{INT} = 'IGNORE';
787 local $SIG{QUIT} = 'IGNORE';
788 local $SIG{TERM} = 'IGNORE';
789 local $SIG{TSTP} = 'IGNORE';
790 local $SIG{PIPE} = 'IGNORE';
792 my $oldAutoCommit = $FS::UID::AutoCommit;
793 local $FS::UID::AutoCommit = 0;
796 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
797 my $error = $cust_pkg->reexport;
799 $dbh->rollback if $oldAutoCommit;
804 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
809 =item delete NEW_CUSTNUM
811 This deletes the customer. If there is an error, returns the error, otherwise
814 This will completely remove all traces of the customer record. This is not
815 what you want when a customer cancels service; for that, cancel all of the
816 customer's packages (see L</cancel>).
818 If the customer has any uncancelled packages, you need to pass a new (valid)
819 customer number for those packages to be transferred to. Cancelled packages
820 will be deleted. Did I mention that this is NOT what you want when a customer
821 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
823 You can't delete a customer with invoices (see L<FS::cust_bill>),
824 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
825 refunds (see L<FS::cust_refund>).
832 local $SIG{HUP} = 'IGNORE';
833 local $SIG{INT} = 'IGNORE';
834 local $SIG{QUIT} = 'IGNORE';
835 local $SIG{TERM} = 'IGNORE';
836 local $SIG{TSTP} = 'IGNORE';
837 local $SIG{PIPE} = 'IGNORE';
839 my $oldAutoCommit = $FS::UID::AutoCommit;
840 local $FS::UID::AutoCommit = 0;
843 if ( $self->cust_bill ) {
844 $dbh->rollback if $oldAutoCommit;
845 return "Can't delete a customer with invoices";
847 if ( $self->cust_credit ) {
848 $dbh->rollback if $oldAutoCommit;
849 return "Can't delete a customer with credits";
851 if ( $self->cust_pay ) {
852 $dbh->rollback if $oldAutoCommit;
853 return "Can't delete a customer with payments";
855 if ( $self->cust_refund ) {
856 $dbh->rollback if $oldAutoCommit;
857 return "Can't delete a customer with refunds";
860 my @cust_pkg = $self->ncancelled_pkgs;
862 my $new_custnum = shift;
863 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
864 $dbh->rollback if $oldAutoCommit;
865 return "Invalid new customer number: $new_custnum";
867 foreach my $cust_pkg ( @cust_pkg ) {
868 my %hash = $cust_pkg->hash;
869 $hash{'custnum'} = $new_custnum;
870 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
871 my $error = $new_cust_pkg->replace($cust_pkg);
873 $dbh->rollback if $oldAutoCommit;
878 my @cancelled_cust_pkg = $self->all_pkgs;
879 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
880 my $error = $cust_pkg->delete;
882 $dbh->rollback if $oldAutoCommit;
887 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
888 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
890 my $error = $cust_main_invoice->delete;
892 $dbh->rollback if $oldAutoCommit;
897 my $error = $self->SUPER::delete;
899 $dbh->rollback if $oldAutoCommit;
903 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
908 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
910 Replaces the OLD_RECORD with this one in the database. If there is an error,
911 returns the error, otherwise returns false.
913 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
914 be set as the invoicing list (see L<"invoicing_list">). Errors return as
915 expected and rollback the entire transaction; it is not necessary to call
916 check_invoicing_list first. Here's an example:
918 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
926 warn "$me replace called\n"
929 local $SIG{HUP} = 'IGNORE';
930 local $SIG{INT} = 'IGNORE';
931 local $SIG{QUIT} = 'IGNORE';
932 local $SIG{TERM} = 'IGNORE';
933 local $SIG{TSTP} = 'IGNORE';
934 local $SIG{PIPE} = 'IGNORE';
936 # If the mask is blank then try to set it - if we can...
937 if (!defined($self->getfield('paymask')) || $self->getfield('paymask') eq '') {
938 $self->paymask($self->payinfo);
941 # We absolutely have to have an old vs. new record to make this work.
942 if (!defined($old)) {
943 $old = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
946 if ( $self->payby eq 'COMP' && $self->payby ne $old->payby
947 && $conf->config('users-allow_comp') ) {
948 return "You are not permitted to create complimentary accounts."
949 unless grep { $_ eq getotaker } $conf->config('users-allow_comp');
952 local($ignore_expired_card) = 1
953 if $old->payby =~ /^(CARD|DCRD)$/
954 && $self->payby =~ /^(CARD|DCRD)$/
955 && $old->payinfo eq $self->payinfo;
957 my $oldAutoCommit = $FS::UID::AutoCommit;
958 local $FS::UID::AutoCommit = 0;
961 my $error = $self->SUPER::replace($old);
964 $dbh->rollback if $oldAutoCommit;
968 if ( @param ) { # INVOICING_LIST_ARYREF
969 my $invoicing_list = shift @param;
970 $error = $self->check_invoicing_list( $invoicing_list );
972 $dbh->rollback if $oldAutoCommit;
975 $self->invoicing_list( $invoicing_list );
978 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
979 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
980 # card/check/lec info has changed, want to retry realtime_ invoice events
981 my $error = $self->retry_realtime;
983 $dbh->rollback if $oldAutoCommit;
988 unless ( $import || $skip_fuzzyfiles ) {
989 $error = $self->queue_fuzzyfiles_update;
991 $dbh->rollback if $oldAutoCommit;
992 return "updating fuzzy search cache: $error";
996 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1001 =item queue_fuzzyfiles_update
1003 Used by insert & replace to update the fuzzy search cache
1007 sub queue_fuzzyfiles_update {
1010 local $SIG{HUP} = 'IGNORE';
1011 local $SIG{INT} = 'IGNORE';
1012 local $SIG{QUIT} = 'IGNORE';
1013 local $SIG{TERM} = 'IGNORE';
1014 local $SIG{TSTP} = 'IGNORE';
1015 local $SIG{PIPE} = 'IGNORE';
1017 my $oldAutoCommit = $FS::UID::AutoCommit;
1018 local $FS::UID::AutoCommit = 0;
1021 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1022 my $error = $queue->insert($self->getfield('last'), $self->company);
1024 $dbh->rollback if $oldAutoCommit;
1025 return "queueing job (transaction rolled back): $error";
1028 if ( defined $self->dbdef_table->column('ship_last') && $self->ship_last ) {
1029 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1030 $error = $queue->insert($self->getfield('ship_last'), $self->ship_company);
1032 $dbh->rollback if $oldAutoCommit;
1033 return "queueing job (transaction rolled back): $error";
1037 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1044 Checks all fields to make sure this is a valid customer record. If there is
1045 an error, returns the error, otherwise returns false. Called by the insert
1046 and replace methods.
1053 warn "$me check BEFORE: \n". $self->_dump
1057 $self->ut_numbern('custnum')
1058 || $self->ut_number('agentnum')
1059 || $self->ut_number('refnum')
1060 || $self->ut_name('last')
1061 || $self->ut_name('first')
1062 || $self->ut_textn('company')
1063 || $self->ut_text('address1')
1064 || $self->ut_textn('address2')
1065 || $self->ut_text('city')
1066 || $self->ut_textn('county')
1067 || $self->ut_textn('state')
1068 || $self->ut_country('country')
1069 || $self->ut_anything('comments')
1070 || $self->ut_numbern('referral_custnum')
1072 #barf. need message catalogs. i18n. etc.
1073 $error .= "Please select an advertising source."
1074 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1075 return $error if $error;
1077 return "Unknown agent"
1078 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1080 return "Unknown refnum"
1081 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1083 return "Unknown referring custnum: ". $self->referral_custnum
1084 unless ! $self->referral_custnum
1085 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1087 if ( $self->ss eq '' ) {
1092 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1093 or return "Illegal social security number: ". $self->ss;
1094 $self->ss("$1-$2-$3");
1098 # bad idea to disable, causes billing to fail because of no tax rates later
1099 # unless ( $import ) {
1100 unless ( qsearch('cust_main_county', {
1101 'country' => $self->country,
1104 return "Unknown state/county/country: ".
1105 $self->state. "/". $self->county. "/". $self->country
1106 unless qsearch('cust_main_county',{
1107 'state' => $self->state,
1108 'county' => $self->county,
1109 'country' => $self->country,
1115 $self->ut_phonen('daytime', $self->country)
1116 || $self->ut_phonen('night', $self->country)
1117 || $self->ut_phonen('fax', $self->country)
1118 || $self->ut_zip('zip', $self->country)
1120 return $error if $error;
1123 last first company address1 address2 city county state zip
1124 country daytime night fax
1127 if ( defined $self->dbdef_table->column('ship_last') ) {
1128 if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1130 && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
1134 $self->ut_name('ship_last')
1135 || $self->ut_name('ship_first')
1136 || $self->ut_textn('ship_company')
1137 || $self->ut_text('ship_address1')
1138 || $self->ut_textn('ship_address2')
1139 || $self->ut_text('ship_city')
1140 || $self->ut_textn('ship_county')
1141 || $self->ut_textn('ship_state')
1142 || $self->ut_country('ship_country')
1144 return $error if $error;
1146 #false laziness with above
1147 unless ( qsearchs('cust_main_county', {
1148 'country' => $self->ship_country,
1151 return "Unknown ship_state/ship_county/ship_country: ".
1152 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1153 unless qsearch('cust_main_county',{
1154 'state' => $self->ship_state,
1155 'county' => $self->ship_county,
1156 'country' => $self->ship_country,
1162 $self->ut_phonen('ship_daytime', $self->ship_country)
1163 || $self->ut_phonen('ship_night', $self->ship_country)
1164 || $self->ut_phonen('ship_fax', $self->ship_country)
1165 || $self->ut_zip('ship_zip', $self->ship_country)
1167 return $error if $error;
1169 } else { # ship_ info eq billing info, so don't store dup info in database
1170 $self->setfield("ship_$_", '')
1171 foreach qw( last first company address1 address2 city county state zip
1172 country daytime night fax );
1176 $self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1177 or return "Illegal payby: ". $self->payby;
1179 $error = $self->ut_numbern('paystart_month')
1180 || $self->ut_numbern('paystart_year')
1181 || $self->ut_numbern('payissue')
1183 return $error if $error;
1185 if ( $self->payip eq '' ) {
1188 $error = $self->ut_ip('payip');
1189 return $error if $error;
1192 # If it is encrypted and the private key is not availaible then we can't
1193 # check the credit card.
1195 my $check_payinfo = 1;
1197 if ($self->is_encrypted($self->payinfo)) {
1203 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1205 my $payinfo = $self->payinfo;
1206 $payinfo =~ s/\D//g;
1207 $payinfo =~ /^(\d{13,16})$/
1208 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1210 $self->payinfo($payinfo);
1212 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1214 return gettext('unknown_card_type')
1215 if cardtype($self->payinfo) eq "Unknown";
1217 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1219 return 'Banned credit card: banned on '.
1220 time2str('%a %h %o at %r', $ban->_date).
1221 ' by '. $ban->otaker.
1222 ' (ban# '. $ban->bannum. ')';
1225 if ( defined $self->dbdef_table->column('paycvv') ) {
1226 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1227 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1228 $self->paycvv =~ /^(\d{4})$/
1229 or return "CVV2 (CID) for American Express cards is four digits.";
1232 $self->paycvv =~ /^(\d{3})$/
1233 or return "CVV2 (CVC2/CID) is three digits.";
1241 my $cardtype = cardtype($payinfo);
1242 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1244 return "Start date or issue number is required for $cardtype cards"
1245 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1247 return "Start month must be between 1 and 12"
1248 if $self->paystart_month
1249 and $self->paystart_month < 1 || $self->paystart_month > 12;
1251 return "Start year must be 1990 or later"
1252 if $self->paystart_year
1253 and $self->paystart_year < 1990;
1255 return "Issue number must be beween 1 and 99"
1257 and $self->payissue < 1 || $self->payissue > 99;
1260 $self->paystart_month('');
1261 $self->paystart_year('');
1262 $self->payissue('');
1265 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1267 my $payinfo = $self->payinfo;
1268 $payinfo =~ s/[^\d\@]//g;
1269 if ( $conf->exists('echeck-nonus') ) {
1270 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1271 $payinfo = "$1\@$2";
1273 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1274 $payinfo = "$1\@$2";
1276 $self->payinfo($payinfo);
1277 $self->paycvv('') if $self->dbdef_table->column('paycvv');
1279 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1281 return 'Banned ACH account: banned on '.
1282 time2str('%a %h %o at %r', $ban->_date).
1283 ' by '. $ban->otaker.
1284 ' (ban# '. $ban->bannum. ')';
1287 } elsif ( $self->payby eq 'LECB' ) {
1289 my $payinfo = $self->payinfo;
1290 $payinfo =~ s/\D//g;
1291 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1293 $self->payinfo($payinfo);
1294 $self->paycvv('') if $self->dbdef_table->column('paycvv');
1296 } elsif ( $self->payby eq 'BILL' ) {
1298 $error = $self->ut_textn('payinfo');
1299 return "Illegal P.O. number: ". $self->payinfo if $error;
1300 $self->paycvv('') if $self->dbdef_table->column('paycvv');
1302 } elsif ( $self->payby eq 'COMP' ) {
1304 if ( !$self->custnum && $conf->config('users-allow_comp') ) {
1305 return "You are not permitted to create complimentary accounts."
1306 unless grep { $_ eq getotaker } $conf->config('users-allow_comp');
1309 $error = $self->ut_textn('payinfo');
1310 return "Illegal comp account issuer: ". $self->payinfo if $error;
1311 $self->paycvv('') if $self->dbdef_table->column('paycvv');
1313 } elsif ( $self->payby eq 'PREPAY' ) {
1315 my $payinfo = $self->payinfo;
1316 $payinfo =~ s/\W//g; #anything else would just confuse things
1317 $self->payinfo($payinfo);
1318 $error = $self->ut_alpha('payinfo');
1319 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1320 return "Unknown prepayment identifier"
1321 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1322 $self->paycvv('') if $self->dbdef_table->column('paycvv');
1326 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1327 return "Expiration date required"
1328 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1332 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1333 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1334 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1335 ( $m, $y ) = ( $3, "20$2" );
1337 return "Illegal expiration date: ". $self->paydate;
1339 $self->paydate("$y-$m-01");
1340 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1341 return gettext('expired_card')
1343 && !$ignore_expired_card
1344 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1347 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1348 ( ! $conf->exists('require_cardname')
1349 || $self->payby !~ /^(CARD|DCRD)$/ )
1351 $self->payname( $self->first. " ". $self->getfield('last') );
1353 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1354 or return gettext('illegal_name'). " payname: ". $self->payname;
1358 foreach my $flag (qw( tax spool_cdr )) {
1359 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1363 $self->otaker(getotaker) unless $self->otaker;
1365 warn "$me check AFTER: \n". $self->_dump
1368 $self->SUPER::check;
1373 Returns all packages (see L<FS::cust_pkg>) for this customer.
1379 if ( $self->{'_pkgnum'} ) {
1380 values %{ $self->{'_pkgnum'}->cache };
1382 qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1386 =item ncancelled_pkgs
1388 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1392 sub ncancelled_pkgs {
1394 if ( $self->{'_pkgnum'} ) {
1395 grep { ! $_->getfield('cancel') } values %{ $self->{'_pkgnum'}->cache };
1397 @{ [ # force list context
1398 qsearch( 'cust_pkg', {
1399 'custnum' => $self->custnum,
1402 qsearch( 'cust_pkg', {
1403 'custnum' => $self->custnum,
1410 =item suspended_pkgs
1412 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1416 sub suspended_pkgs {
1418 grep { $_->susp } $self->ncancelled_pkgs;
1421 =item unflagged_suspended_pkgs
1423 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1424 customer (thouse packages without the `manual_flag' set).
1428 sub unflagged_suspended_pkgs {
1430 return $self->suspended_pkgs
1431 unless dbdef->table('cust_pkg')->column('manual_flag');
1432 grep { ! $_->manual_flag } $self->suspended_pkgs;
1435 =item unsuspended_pkgs
1437 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1442 sub unsuspended_pkgs {
1444 grep { ! $_->susp } $self->ncancelled_pkgs;
1447 =item num_cancelled_pkgs
1449 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1454 sub num_cancelled_pkgs {
1456 $self->num_pkgs("cancel IS NOT NULL AND cust_pkg.cancel != 0");
1460 my( $self, $sql ) = @_;
1461 my $sth = dbh->prepare(
1462 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? AND $sql"
1463 ) or die dbh->errstr;
1464 $sth->execute($self->custnum) or die $sth->errstr;
1465 $sth->fetchrow_arrayref->[0];
1470 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1471 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1472 on success or a list of errors.
1478 grep { $_->unsuspend } $self->suspended_pkgs;
1483 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1485 Returns a list: an empty list on success or a list of errors.
1491 grep { $_->suspend } $self->unsuspended_pkgs;
1494 =item suspend_if_pkgpart PKGPART [ , PKGPART ... ]
1496 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1497 PKGPARTs (see L<FS::part_pkg>).
1499 Returns a list: an empty list on success or a list of errors.
1503 sub suspend_if_pkgpart {
1506 grep { $_->suspend }
1507 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1508 $self->unsuspended_pkgs;
1511 =item suspend_unless_pkgpart PKGPART [ , PKGPART ... ]
1513 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1514 listed PKGPARTs (see L<FS::part_pkg>).
1516 Returns a list: an empty list on success or a list of errors.
1520 sub suspend_unless_pkgpart {
1523 grep { $_->suspend }
1524 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1525 $self->unsuspended_pkgs;
1528 =item cancel [ OPTION => VALUE ... ]
1530 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1532 Available options are: I<quiet>, I<reasonnum>, and I<ban>
1534 I<quiet> can be set true to supress email cancellation notices.
1536 # I<reasonnum> can be set to a cancellation reason (see L<FS::cancel_reason>)
1538 I<ban> can be set true to ban this customer's credit card or ACH information,
1541 Always returns a list: an empty list on success or a list of errors.
1549 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1551 #should try decryption (we might have the private key)
1552 # and if not maybe queue a job for the server that does?
1553 return ( "Can't (yet) ban encrypted credit cards" )
1554 if $self->is_encrypted($self->payinfo);
1556 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1557 my $error = $ban->insert;
1558 return ( $error ) if $error;
1562 grep { $_ } map { $_->cancel(@_) } $self->ncancelled_pkgs;
1565 sub _banned_pay_hashref {
1576 'payby' => $payby2ban{$self->payby},
1577 'payinfo' => md5_base64($self->payinfo),
1584 Returns the agent (see L<FS::agent>) for this customer.
1590 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1595 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
1596 conjunction with the collect method.
1598 Options are passed as name-value pairs.
1600 Currently available options are:
1602 resetup - if set true, re-charges setup fees.
1604 time - bills the customer as if it were that time. Specified as a UNIX
1605 timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and
1606 L<Date::Parse> for conversion functions. For example:
1610 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1613 If there is an error, returns the error, otherwise returns false.
1618 my( $self, %options ) = @_;
1619 return '' if $self->payby eq 'COMP';
1620 warn "$me bill customer ". $self->custnum. "\n"
1623 my $time = $options{'time'} || time;
1628 local $SIG{HUP} = 'IGNORE';
1629 local $SIG{INT} = 'IGNORE';
1630 local $SIG{QUIT} = 'IGNORE';
1631 local $SIG{TERM} = 'IGNORE';
1632 local $SIG{TSTP} = 'IGNORE';
1633 local $SIG{PIPE} = 'IGNORE';
1635 my $oldAutoCommit = $FS::UID::AutoCommit;
1636 local $FS::UID::AutoCommit = 0;
1639 $self->select_for_update; #mutex
1641 #create a new invoice
1642 #(we'll remove it later if it doesn't actually need to be generated [contains
1643 # no line items] and we're inside a transaciton so nothing else will see it)
1644 my $cust_bill = new FS::cust_bill ( {
1645 'custnum' => $self->custnum,
1647 #'charged' => $charged,
1650 $error = $cust_bill->insert;
1652 $dbh->rollback if $oldAutoCommit;
1653 return "can't create invoice for customer #". $self->custnum. ": $error";
1655 my $invnum = $cust_bill->invnum;
1658 # find the packages which are due for billing, find out how much they are
1659 # & generate invoice database.
1662 my( $total_setup, $total_recur ) = ( 0, 0 );
1664 my @precommit_hooks = ();
1666 foreach my $cust_pkg (
1667 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
1670 #NO!! next if $cust_pkg->cancel;
1671 next if $cust_pkg->getfield('cancel');
1673 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
1675 #? to avoid use of uninitialized value errors... ?
1676 $cust_pkg->setfield('bill', '')
1677 unless defined($cust_pkg->bill);
1679 my $part_pkg = $cust_pkg->part_pkg;
1681 my %hash = $cust_pkg->hash;
1682 my $old_cust_pkg = new FS::cust_pkg \%hash;
1691 if ( !$cust_pkg->setup || $options{'resetup'} ) {
1693 warn " bill setup\n" if $DEBUG > 1;
1695 $setup = eval { $cust_pkg->calc_setup( $time ) };
1697 $dbh->rollback if $oldAutoCommit;
1698 return "$@ running calc_setup for $cust_pkg\n";
1701 $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
1705 # bill recurring fee
1710 if ( $part_pkg->getfield('freq') ne '0' &&
1711 ! $cust_pkg->getfield('susp') &&
1712 ( $cust_pkg->getfield('bill') || 0 ) <= $time
1715 warn " bill recur\n" if $DEBUG > 1;
1717 # XXX shared with $recur_prog
1718 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1720 #over two params! lets at least switch to a hashref for the rest...
1721 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
1723 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
1725 $dbh->rollback if $oldAutoCommit;
1726 return "$@ running calc_recur for $cust_pkg\n";
1729 #change this bit to use Date::Manip? CAREFUL with timezones (see
1730 # mailing list archive)
1731 my ($sec,$min,$hour,$mday,$mon,$year) =
1732 (localtime($sdate) )[0,1,2,3,4,5];
1734 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
1735 # only for figuring next bill date, nothing else, so, reset $sdate again
1737 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1738 $cust_pkg->last_bill($sdate)
1739 if $cust_pkg->dbdef_table->column('last_bill');
1741 if ( $part_pkg->freq =~ /^\d+$/ ) {
1742 $mon += $part_pkg->freq;
1743 until ( $mon < 12 ) { $mon -= 12; $year++; }
1744 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
1746 $mday += $weeks * 7;
1747 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
1750 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
1754 $dbh->rollback if $oldAutoCommit;
1755 return "unparsable frequency: ". $part_pkg->freq;
1757 $cust_pkg->setfield('bill',
1758 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
1761 warn "\$setup is undefined" unless defined($setup);
1762 warn "\$recur is undefined" unless defined($recur);
1763 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1766 # If $cust_pkg has been modified, update it and create cust_bill_pkg records
1769 if ( $cust_pkg->modified ) {
1771 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
1774 $error=$cust_pkg->replace($old_cust_pkg);
1775 if ( $error ) { #just in case
1776 $dbh->rollback if $oldAutoCommit;
1777 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
1780 $setup = sprintf( "%.2f", $setup );
1781 $recur = sprintf( "%.2f", $recur );
1782 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1783 $dbh->rollback if $oldAutoCommit;
1784 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1786 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1787 $dbh->rollback if $oldAutoCommit;
1788 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1791 if ( $setup != 0 || $recur != 0 ) {
1793 warn " charges (setup=$setup, recur=$recur); adding line items\n"
1795 my $cust_bill_pkg = new FS::cust_bill_pkg ({
1796 'invnum' => $invnum,
1797 'pkgnum' => $cust_pkg->pkgnum,
1801 'edate' => $cust_pkg->bill,
1802 'details' => \@details,
1804 $error = $cust_bill_pkg->insert;
1806 $dbh->rollback if $oldAutoCommit;
1807 return "can't create invoice line item for invoice #$invnum: $error";
1809 $total_setup += $setup;
1810 $total_recur += $recur;
1816 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
1819 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1822 my %taxhash = map { $_ => $self->get("$prefix$_") }
1823 qw( state county country );
1825 $taxhash{'taxclass'} = $part_pkg->taxclass;
1827 my @taxes = qsearch( 'cust_main_county', \%taxhash );
1830 $taxhash{'taxclass'} = '';
1831 @taxes = qsearch( 'cust_main_county', \%taxhash );
1834 #one more try at a whole-country tax rate
1836 $taxhash{$_} = '' foreach qw( state county );
1837 @taxes = qsearch( 'cust_main_county', \%taxhash );
1840 # maybe eliminate this entirely, along with all the 0% records
1842 $dbh->rollback if $oldAutoCommit;
1844 "fatal: can't find tax rate for state/county/country/taxclass ".
1845 join('/', ( map $self->get("$prefix$_"),
1846 qw(state county country)
1848 $part_pkg->taxclass ). "\n";
1851 foreach my $tax ( @taxes ) {
1853 my $taxable_charged = 0;
1854 $taxable_charged += $setup
1855 unless $part_pkg->setuptax =~ /^Y$/i
1856 || $tax->setuptax =~ /^Y$/i;
1857 $taxable_charged += $recur
1858 unless $part_pkg->recurtax =~ /^Y$/i
1859 || $tax->recurtax =~ /^Y$/i;
1860 next unless $taxable_charged;
1862 if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
1863 #my ($mon,$year) = (localtime($sdate) )[4,5];
1864 my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
1866 my $freq = $part_pkg->freq || 1;
1867 if ( $freq !~ /(\d+)$/ ) {
1868 $dbh->rollback if $oldAutoCommit;
1869 return "daily/weekly package definitions not (yet?)".
1870 " compatible with monthly tax exemptions";
1872 my $taxable_per_month =
1873 sprintf("%.2f", $taxable_charged / $freq );
1875 #call the whole thing off if this customer has any old
1876 #exemption records...
1877 my @cust_tax_exempt =
1878 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
1879 if ( @cust_tax_exempt ) {
1880 $dbh->rollback if $oldAutoCommit;
1882 'this customer still has old-style tax exemption records; '.
1883 'run bin/fs-migrate-cust_tax_exempt?';
1886 foreach my $which_month ( 1 .. $freq ) {
1888 #maintain the new exemption table now
1891 FROM cust_tax_exempt_pkg
1892 LEFT JOIN cust_bill_pkg USING ( billpkgnum )
1893 LEFT JOIN cust_bill USING ( invnum )
1899 my $sth = dbh->prepare($sql) or do {
1900 $dbh->rollback if $oldAutoCommit;
1901 return "fatal: can't lookup exising exemption: ". dbh->errstr;
1909 $dbh->rollback if $oldAutoCommit;
1910 return "fatal: can't lookup exising exemption: ". dbh->errstr;
1912 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
1914 my $remaining_exemption =
1915 $tax->exempt_amount - $existing_exemption;
1916 if ( $remaining_exemption > 0 ) {
1917 my $addl = $remaining_exemption > $taxable_per_month
1918 ? $taxable_per_month
1919 : $remaining_exemption;
1920 $taxable_charged -= $addl;
1922 my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
1923 'billpkgnum' => $cust_bill_pkg->billpkgnum,
1924 'taxnum' => $tax->taxnum,
1925 'year' => 1900+$year,
1927 'amount' => sprintf("%.2f", $addl ),
1929 $error = $cust_tax_exempt_pkg->insert;
1931 $dbh->rollback if $oldAutoCommit;
1932 return "fatal: can't insert cust_tax_exempt_pkg: $error";
1934 } # if $remaining_exemption > 0
1938 #until ( $mon < 12 ) { $mon -= 12; $year++; }
1939 until ( $mon < 13 ) { $mon -= 12; $year++; }
1941 } #foreach $which_month
1943 } #if $tax->exempt_amount
1945 $taxable_charged = sprintf( "%.2f", $taxable_charged);
1947 #$tax += $taxable_charged * $cust_main_county->tax / 100
1948 $tax{ $tax->taxname || 'Tax' } +=
1949 $taxable_charged * $tax->tax / 100
1951 } #foreach my $tax ( @taxes )
1953 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
1955 } #if $setup != 0 || $recur != 0
1957 } #if $cust_pkg->modified
1959 } #foreach my $cust_pkg
1961 unless ( $cust_bill->cust_bill_pkg ) {
1962 $cust_bill->delete; #don't create an invoice w/o line items
1963 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1967 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
1969 foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
1970 my $tax = sprintf("%.2f", $tax{$taxname} );
1971 $charged = sprintf( "%.2f", $charged+$tax );
1973 my $cust_bill_pkg = new FS::cust_bill_pkg ({
1974 'invnum' => $invnum,
1980 'itemdesc' => $taxname,
1982 $error = $cust_bill_pkg->insert;
1984 $dbh->rollback if $oldAutoCommit;
1985 return "can't create invoice line item for invoice #$invnum: $error";
1987 $total_setup += $tax;
1991 $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
1992 $error = $cust_bill->replace;
1994 $dbh->rollback if $oldAutoCommit;
1995 return "can't update charged for invoice #$invnum: $error";
1998 foreach my $hook ( @precommit_hooks ) {
2000 &{$hook}; #($self) ?
2003 $dbh->rollback if $oldAutoCommit;
2004 return "$@ running precommit hook $hook\n";
2008 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2012 =item collect OPTIONS
2014 (Attempt to) collect money for this customer's outstanding invoices (see
2015 L<FS::cust_bill>). Usually used after the bill method.
2017 Depending on the value of `payby', this may print or email an invoice (I<BILL>,
2018 I<DCRD>, or I<DCHK>), charge a credit card (I<CARD>), charge via electronic
2019 check/ACH (I<CHEK>), or just add any necessary (pseudo-)payment (I<COMP>).
2021 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
2022 and the invoice events web interface.
2024 If there is an error, returns the error, otherwise returns false.
2026 Options are passed as name-value pairs.
2028 Currently available options are:
2030 invoice_time - Use this time when deciding when to print invoices and
2031 late notices on those invoices. The default is now. It is specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse>
2032 for conversion functions.
2034 retry - Retry card/echeck/LEC transactions even when not scheduled by invoice
2037 quiet - set true to surpress email card/ACH decline notices.
2039 freq - "1d" for the traditional, daily events (the default), or "1m" for the
2045 my( $self, %options ) = @_;
2046 my $invoice_time = $options{'invoice_time'} || time;
2049 local $SIG{HUP} = 'IGNORE';
2050 local $SIG{INT} = 'IGNORE';
2051 local $SIG{QUIT} = 'IGNORE';
2052 local $SIG{TERM} = 'IGNORE';
2053 local $SIG{TSTP} = 'IGNORE';
2054 local $SIG{PIPE} = 'IGNORE';
2056 my $oldAutoCommit = $FS::UID::AutoCommit;
2057 local $FS::UID::AutoCommit = 0;
2060 $self->select_for_update; #mutex
2062 my $balance = $self->balance;
2063 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2065 unless ( $balance > 0 ) { #redundant?????
2066 $dbh->rollback if $oldAutoCommit; #hmm
2070 if ( exists($options{'retry_card'}) ) {
2071 carp 'retry_card option passed to collect is deprecated; use retry';
2072 $options{'retry'} ||= $options{'retry_card'};
2074 if ( exists($options{'retry'}) && $options{'retry'} ) {
2075 my $error = $self->retry_realtime;
2077 $dbh->rollback if $oldAutoCommit;
2083 if ( defined $options{'freq'} && $options{'freq'} eq '1m' ) {
2084 $extra_sql = " AND freq = '1m' ";
2086 $extra_sql = " AND ( freq = '1d' OR freq IS NULL OR freq = '' ) ";
2089 foreach my $cust_bill ( $self->open_cust_bill ) {
2091 # don't try to charge for the same invoice if it's already in a batch
2092 #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
2094 last if $self->balance <= 0;
2096 warn " invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ")\n"
2099 foreach my $part_bill_event (
2100 sort { $a->seconds <=> $b->seconds
2101 || $a->weight <=> $b->weight
2102 || $a->eventpart <=> $b->eventpart }
2103 grep { $_->seconds <= ( $invoice_time - $cust_bill->_date )
2104 && ! qsearch( 'cust_bill_event', {
2105 'invnum' => $cust_bill->invnum,
2106 'eventpart' => $_->eventpart,
2111 'table' => 'part_bill_event',
2112 'hashref' => { 'payby' => $self->payby,
2113 'disabled' => '', },
2114 'extra_sql' => $extra_sql,
2118 last if $cust_bill->owed <= 0 # don't run subsequent events if owed<=0
2119 || $self->balance <= 0; # or if balance<=0
2121 warn " calling invoice event (". $part_bill_event->eventcode. ")\n"
2123 my $cust_main = $self; #for callback
2127 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2128 local $SIG{__DIE__}; # don't want Mason __DIE__ handler active
2129 $error = eval $part_bill_event->eventcode;
2133 my $statustext = '';
2137 } elsif ( $error ) {
2139 $statustext = $error;
2144 #add cust_bill_event
2145 my $cust_bill_event = new FS::cust_bill_event {
2146 'invnum' => $cust_bill->invnum,
2147 'eventpart' => $part_bill_event->eventpart,
2148 #'_date' => $invoice_time,
2150 'status' => $status,
2151 'statustext' => $statustext,
2153 $error = $cust_bill_event->insert;
2155 #$dbh->rollback if $oldAutoCommit;
2156 #return "error: $error";
2158 # gah, even with transactions.
2159 $dbh->commit if $oldAutoCommit; #well.
2160 my $e = 'WARNING: Event run but database not updated - '.
2161 'error inserting cust_bill_event, invnum #'. $cust_bill->invnum.
2162 ', eventpart '. $part_bill_event->eventpart.
2173 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2178 =item retry_realtime
2180 Schedules realtime credit card / electronic check / LEC billing events for
2181 for retry. Useful if card information has changed or manual retry is desired.
2182 The 'collect' method must be called to actually retry the transaction.
2184 Implementation details: For each of this customer's open invoices, changes
2185 the status of the first "done" (with statustext error) realtime processing
2190 sub retry_realtime {
2193 local $SIG{HUP} = 'IGNORE';
2194 local $SIG{INT} = 'IGNORE';
2195 local $SIG{QUIT} = 'IGNORE';
2196 local $SIG{TERM} = 'IGNORE';
2197 local $SIG{TSTP} = 'IGNORE';
2198 local $SIG{PIPE} = 'IGNORE';
2200 my $oldAutoCommit = $FS::UID::AutoCommit;
2201 local $FS::UID::AutoCommit = 0;
2204 foreach my $cust_bill (
2205 grep { $_->cust_bill_event }
2206 $self->open_cust_bill
2208 my @cust_bill_event =
2209 sort { $a->part_bill_event->seconds <=> $b->part_bill_event->seconds }
2211 #$_->part_bill_event->plan eq 'realtime-card'
2212 $_->part_bill_event->eventcode =~
2213 /\$cust_bill\->realtime_(card|ach|lec)/
2214 && $_->status eq 'done'
2217 $cust_bill->cust_bill_event;
2218 next unless @cust_bill_event;
2219 my $error = $cust_bill_event[0]->retry;
2221 $dbh->rollback if $oldAutoCommit;
2222 return "error scheduling invoice event for retry: $error";
2227 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2232 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2234 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2235 via a Business::OnlinePayment realtime gateway. See
2236 L<http://420.am/business-onlinepayment> for supported gateways.
2238 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2240 Available options are: I<description>, I<invnum>, I<quiet>
2242 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2243 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2244 if set, will override the value from the customer record.
2246 I<description> is a free-text field passed to the gateway. It defaults to
2247 "Internet services".
2249 If an I<invnum> is specified, this payment (if successful) is applied to the
2250 specified invoice. If you don't specify an I<invnum> you might want to
2251 call the B<apply_payments> method.
2253 I<quiet> can be set true to surpress email decline notices.
2255 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2260 my( $self, $method, $amount, %options ) = @_;
2262 warn "$me realtime_bop: $method $amount\n";
2263 warn " $_ => $options{$_}\n" foreach keys %options;
2266 $options{'description'} ||= 'Internet services';
2268 eval "use Business::OnlinePayment";
2271 my $payinfo = exists($options{'payinfo'})
2272 ? $options{'payinfo'}
2280 if ( $options{'invnum'} ) {
2281 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2282 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2284 map { $_->part_pkg->taxclass }
2286 map { $_->cust_pkg }
2287 $cust_bill->cust_bill_pkg;
2288 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2289 #different taxclasses
2290 $taxclass = $taxclasses[0];
2294 #look for an agent gateway override first
2296 if ( $method eq 'CC' ) {
2297 $cardtype = cardtype($payinfo);
2298 } elsif ( $method eq 'ECHECK' ) {
2301 $cardtype = $method;
2305 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2306 cardtype => $cardtype,
2307 taxclass => $taxclass, } )
2308 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2310 taxclass => $taxclass, } )
2311 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2312 cardtype => $cardtype,
2314 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2316 taxclass => '', } );
2318 my $payment_gateway = '';
2319 my( $processor, $login, $password, $action, @bop_options );
2320 if ( $override ) { #use a payment gateway override
2322 $payment_gateway = $override->payment_gateway;
2324 $processor = $payment_gateway->gateway_module;
2325 $login = $payment_gateway->gateway_username;
2326 $password = $payment_gateway->gateway_password;
2327 $action = $payment_gateway->gateway_action;
2328 @bop_options = $payment_gateway->options;
2330 } else { #use the standard settings from the config
2332 ( $processor, $login, $password, $action, @bop_options ) =
2333 $self->default_payment_gateway($method);
2341 my $address = exists($options{'address1'})
2342 ? $options{'address1'}
2344 my $address2 = exists($options{'address2'})
2345 ? $options{'address2'}
2347 $address .= ", ". $address2 if length($address2);
2349 my $o_payname = exists($options{'payname'})
2350 ? $options{'payname'}
2352 my($payname, $payfirst, $paylast);
2353 if ( $o_payname && $method ne 'ECHECK' ) {
2354 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2355 or return "Illegal payname $payname";
2356 ($payfirst, $paylast) = ($1, $2);
2358 $payfirst = $self->getfield('first');
2359 $paylast = $self->getfield('last');
2360 $payname = "$payfirst $paylast";
2363 my @invoicing_list = grep { $_ ne 'POST' } $self->invoicing_list;
2364 if ( $conf->exists('emailinvoiceauto')
2365 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2366 push @invoicing_list, $self->all_emails;
2369 my $email = ($conf->exists('business-onlinepayment-email-override'))
2370 ? $conf->config('business-onlinepayment-email-override')
2371 : $invoicing_list[0];
2375 my $payip = exists($options{'payip'})
2378 $content{customer_ip} = $payip
2381 if ( $method eq 'CC' ) {
2383 $content{card_number} = $payinfo;
2384 my $paydate = exists($options{'paydate'})
2385 ? $options{'paydate'}
2387 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2388 $content{expiration} = "$2/$1";
2390 my $paycvv = exists($options{'paycvv'})
2391 ? $options{'paycvv'}
2393 $content{cvv2} = $self->paycvv
2396 my $paystart_month = exists($options{'paystart_month'})
2397 ? $options{'paystart_month'}
2398 : $self->paystart_month;
2400 my $paystart_year = exists($options{'paystart_year'})
2401 ? $options{'paystart_year'}
2402 : $self->paystart_year;
2404 $content{card_start} = "$paystart_month/$paystart_year"
2405 if $paystart_month && $paystart_year;
2407 my $payissue = exists($options{'payissue'})
2408 ? $options{'payissue'}
2410 $content{issue_number} = $payissue if $payissue;
2412 $content{recurring_billing} = 'YES'
2413 if qsearch('cust_pay', { 'custnum' => $self->custnum,
2415 'payinfo' => $payinfo,
2418 } elsif ( $method eq 'ECHECK' ) {
2419 ( $content{account_number}, $content{routing_code} ) =
2420 split('@', $payinfo);
2421 $content{bank_name} = $o_payname;
2422 $content{account_type} = 'CHECKING';
2423 $content{account_name} = $payname;
2424 $content{customer_org} = $self->company ? 'B' : 'I';
2425 $content{customer_ssn} = exists($options{'ss'})
2428 } elsif ( $method eq 'LEC' ) {
2429 $content{phone} = $payinfo;
2433 # run transaction(s)
2436 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
2438 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
2439 $transaction->content(
2442 'password' => $password,
2443 'action' => $action1,
2444 'description' => $options{'description'},
2445 'amount' => $amount,
2446 'invoice_number' => $options{'invnum'},
2447 'customer_id' => $self->custnum,
2448 'last_name' => $paylast,
2449 'first_name' => $payfirst,
2451 'address' => $address,
2452 'city' => ( exists($options{'city'})
2455 'state' => ( exists($options{'state'})
2458 'zip' => ( exists($options{'zip'})
2461 'country' => ( exists($options{'country'})
2462 ? $options{'country'}
2464 'referer' => 'http://cleanwhisker.420.am/',
2466 'phone' => $self->daytime || $self->night,
2469 $transaction->submit();
2471 if ( $transaction->is_success() && $action2 ) {
2472 my $auth = $transaction->authorization;
2473 my $ordernum = $transaction->can('order_number')
2474 ? $transaction->order_number
2478 new Business::OnlinePayment( $processor, @bop_options );
2485 password => $password,
2486 order_number => $ordernum,
2488 authorization => $auth,
2489 description => $options{'description'},
2492 foreach my $field (qw( authorization_source_code returned_ACI transaction_identifier validation_code
2493 transaction_sequence_num local_transaction_date
2494 local_transaction_time AVS_result_code )) {
2495 $capture{$field} = $transaction->$field() if $transaction->can($field);
2498 $capture->content( %capture );
2502 unless ( $capture->is_success ) {
2503 my $e = "Authorization successful but capture failed, custnum #".
2504 $self->custnum. ': '. $capture->result_code.
2505 ": ". $capture->error_message;
2513 # remove paycvv after initial transaction
2516 #false laziness w/misc/process/payment.cgi - check both to make sure working
2518 if ( defined $self->dbdef_table->column('paycvv')
2519 && length($self->paycvv)
2520 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
2522 my $error = $self->remove_cvv;
2524 warn "WARNING: error removing cvv: $error\n";
2532 if ( $transaction->is_success() ) {
2534 my %method2payby = (
2541 if ( $payment_gateway ) { # agent override
2542 $paybatch = $payment_gateway->gatewaynum. '-';
2545 $paybatch .= "$processor:". $transaction->authorization;
2547 $paybatch .= ':'. $transaction->order_number
2548 if $transaction->can('order_number')
2549 && length($transaction->order_number);
2551 my $cust_pay = new FS::cust_pay ( {
2552 'custnum' => $self->custnum,
2553 'invnum' => $options{'invnum'},
2556 'payby' => $method2payby{$method},
2557 'payinfo' => $payinfo,
2558 'paybatch' => $paybatch,
2560 my $error = $cust_pay->insert;
2562 $cust_pay->invnum(''); #try again with no specific invnum
2563 my $error2 = $cust_pay->insert;
2565 # gah, even with transactions.
2566 my $e = 'WARNING: Card/ACH debited but database not updated - '.
2567 "error inserting payment ($processor): $error2".
2568 " (previously tried insert with invnum #$options{'invnum'}" .
2574 return ''; #no error
2578 my $perror = "$processor error: ". $transaction->error_message;
2580 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
2581 && $conf->exists('emaildecline')
2582 && grep { $_ ne 'POST' } $self->invoicing_list
2583 && ! grep { $transaction->error_message =~ /$_/ }
2584 $conf->config('emaildecline-exclude')
2586 my @templ = $conf->config('declinetemplate');
2587 my $template = new Text::Template (
2589 SOURCE => [ map "$_\n", @templ ],
2590 ) or return "($perror) can't create template: $Text::Template::ERROR";
2591 $template->compile()
2592 or return "($perror) can't compile template: $Text::Template::ERROR";
2594 my $templ_hash = { error => $transaction->error_message };
2596 my $error = send_email(
2597 'from' => $conf->config('invoice_from'),
2598 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
2599 'subject' => 'Your payment could not be processed',
2600 'body' => [ $template->fill_in(HASH => $templ_hash) ],
2603 $perror .= " (also received error sending decline notification: $error)"
2613 =item default_payment_gateway
2617 sub default_payment_gateway {
2618 my( $self, $method ) = @_;
2620 die "Real-time processing not enabled\n"
2621 unless $conf->exists('business-onlinepayment');
2624 my $bop_config = 'business-onlinepayment';
2625 $bop_config .= '-ach'
2626 if $method eq 'ECHECK' && $conf->exists($bop_config. '-ach');
2627 my ( $processor, $login, $password, $action, @bop_options ) =
2628 $conf->config($bop_config);
2629 $action ||= 'normal authorization';
2630 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
2631 die "No real-time processor is enabled - ".
2632 "did you set the business-onlinepayment configuration value?\n"
2635 ( $processor, $login, $password, $action, @bop_options )
2640 Removes the I<paycvv> field from the database directly.
2642 If there is an error, returns the error, otherwise returns false.
2648 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2649 or return dbh->errstr;
2650 $sth->execute($self->custnum)
2651 or return $sth->errstr;
2656 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
2658 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
2659 via a Business::OnlinePayment realtime gateway. See
2660 L<http://420.am/business-onlinepayment> for supported gateways.
2662 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2664 Available options are: I<amount>, I<reason>, I<paynum>
2666 Most gateways require a reference to an original payment transaction to refund,
2667 so you probably need to specify a I<paynum>.
2669 I<amount> defaults to the original amount of the payment if not specified.
2671 I<reason> specifies a reason for the refund.
2673 Implementation note: If I<amount> is unspecified or equal to the amount of the
2674 orignal payment, first an attempt is made to "void" the transaction via
2675 the gateway (to cancel a not-yet settled transaction) and then if that fails,
2676 the normal attempt is made to "refund" ("credit") the transaction via the
2677 gateway is attempted.
2679 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2680 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2681 #if set, will override the value from the customer record.
2683 #If an I<invnum> is specified, this payment (if successful) is applied to the
2684 #specified invoice. If you don't specify an I<invnum> you might want to
2685 #call the B<apply_payments> method.
2689 #some false laziness w/realtime_bop, not enough to make it worth merging
2690 #but some useful small subs should be pulled out
2691 sub realtime_refund_bop {
2692 my( $self, $method, %options ) = @_;
2694 warn "$me realtime_refund_bop: $method refund\n";
2695 warn " $_ => $options{$_}\n" foreach keys %options;
2698 eval "use Business::OnlinePayment";
2702 # look up the original payment and optionally a gateway for that payment
2706 my $amount = $options{'amount'};
2708 my( $processor, $login, $password, @bop_options ) ;
2709 my( $auth, $order_number ) = ( '', '', '' );
2711 if ( $options{'paynum'} ) {
2713 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
2714 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
2715 or return "Unknown paynum $options{'paynum'}";
2716 $amount ||= $cust_pay->paid;
2718 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-]*)(:([\w\-]+))?$/
2719 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
2720 $cust_pay->paybatch;
2721 my $gatewaynum = '';
2722 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
2724 if ( $gatewaynum ) { #gateway for the payment to be refunded
2726 my $payment_gateway =
2727 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
2728 die "payment gateway $gatewaynum not found"
2729 unless $payment_gateway;
2731 $processor = $payment_gateway->gateway_module;
2732 $login = $payment_gateway->gateway_username;
2733 $password = $payment_gateway->gateway_password;
2734 @bop_options = $payment_gateway->options;
2736 } else { #try the default gateway
2738 my( $conf_processor, $unused_action );
2739 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
2740 $self->default_payment_gateway($method);
2742 return "processor of payment $options{'paynum'} $processor does not".
2743 " match default processor $conf_processor"
2744 unless $processor eq $conf_processor;
2749 } else { # didn't specify a paynum, so look for agent gateway overrides
2750 # like a normal transaction
2753 if ( $method eq 'CC' ) {
2754 $cardtype = cardtype($self->payinfo);
2755 } elsif ( $method eq 'ECHECK' ) {
2758 $cardtype = $method;
2761 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2762 cardtype => $cardtype,
2764 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2766 taxclass => '', } );
2768 if ( $override ) { #use a payment gateway override
2770 my $payment_gateway = $override->payment_gateway;
2772 $processor = $payment_gateway->gateway_module;
2773 $login = $payment_gateway->gateway_username;
2774 $password = $payment_gateway->gateway_password;
2775 #$action = $payment_gateway->gateway_action;
2776 @bop_options = $payment_gateway->options;
2778 } else { #use the standard settings from the config
2781 ( $processor, $login, $password, $unused_action, @bop_options ) =
2782 $self->default_payment_gateway($method);
2787 return "neither amount nor paynum specified" unless $amount;
2792 'password' => $password,
2793 'order_number' => $order_number,
2794 'amount' => $amount,
2795 'referer' => 'http://cleanwhisker.420.am/',
2797 $content{authorization} = $auth
2798 if length($auth); #echeck/ACH transactions have an order # but no auth
2799 #(at least with authorize.net)
2801 #first try void if applicable
2802 if ( $cust_pay && $cust_pay->paid == $amount ) { #and check dates?
2803 warn " attempting void\n" if $DEBUG > 1;
2804 my $void = new Business::OnlinePayment( $processor, @bop_options );
2805 $void->content( 'action' => 'void', %content );
2807 if ( $void->is_success ) {
2808 my $error = $cust_pay->void($options{'reason'});
2810 # gah, even with transactions.
2811 my $e = 'WARNING: Card/ACH voided but database not updated - '.
2812 "error voiding payment: $error";
2816 warn " void successful\n" if $DEBUG > 1;
2821 warn " void unsuccessful, trying refund\n"
2825 my $address = $self->address1;
2826 $address .= ", ". $self->address2 if $self->address2;
2828 my($payname, $payfirst, $paylast);
2829 if ( $self->payname && $method ne 'ECHECK' ) {
2830 $payname = $self->payname;
2831 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2832 or return "Illegal payname $payname";
2833 ($payfirst, $paylast) = ($1, $2);
2835 $payfirst = $self->getfield('first');
2836 $paylast = $self->getfield('last');
2837 $payname = "$payfirst $paylast";
2841 if ( $method eq 'CC' ) {
2844 $content{card_number} = $payinfo = $cust_pay->payinfo;
2845 #$self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2846 #$content{expiration} = "$2/$1";
2848 $content{card_number} = $payinfo = $self->payinfo;
2849 $self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2850 $content{expiration} = "$2/$1";
2853 } elsif ( $method eq 'ECHECK' ) {
2854 ( $content{account_number}, $content{routing_code} ) =
2855 split('@', $payinfo = $self->payinfo);
2856 $content{bank_name} = $self->payname;
2857 $content{account_type} = 'CHECKING';
2858 $content{account_name} = $payname;
2859 $content{customer_org} = $self->company ? 'B' : 'I';
2860 $content{customer_ssn} = $self->ss;
2861 } elsif ( $method eq 'LEC' ) {
2862 $content{phone} = $payinfo = $self->payinfo;
2866 my $refund = new Business::OnlinePayment( $processor, @bop_options );
2867 my %sub_content = $refund->content(
2868 'action' => 'credit',
2869 'customer_id' => $self->custnum,
2870 'last_name' => $paylast,
2871 'first_name' => $payfirst,
2873 'address' => $address,
2874 'city' => $self->city,
2875 'state' => $self->state,
2876 'zip' => $self->zip,
2877 'country' => $self->country,
2880 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
2884 return "$processor error: ". $refund->error_message
2885 unless $refund->is_success();
2887 my %method2payby = (
2893 my $paybatch = "$processor:". $refund->authorization;
2894 $paybatch .= ':'. $refund->order_number
2895 if $refund->can('order_number') && $refund->order_number;
2897 while ( $cust_pay && $cust_pay->unappled < $amount ) {
2898 my @cust_bill_pay = $cust_pay->cust_bill_pay;
2899 last unless @cust_bill_pay;
2900 my $cust_bill_pay = pop @cust_bill_pay;
2901 my $error = $cust_bill_pay->delete;
2905 my $cust_refund = new FS::cust_refund ( {
2906 'custnum' => $self->custnum,
2907 'paynum' => $options{'paynum'},
2908 'refund' => $amount,
2910 'payby' => $method2payby{$method},
2911 'payinfo' => $payinfo,
2912 'paybatch' => $paybatch,
2913 'reason' => $options{'reason'} || 'card or ACH refund',
2915 my $error = $cust_refund->insert;
2917 $cust_refund->paynum(''); #try again with no specific paynum
2918 my $error2 = $cust_refund->insert;
2920 # gah, even with transactions.
2921 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
2922 "error inserting refund ($processor): $error2".
2923 " (previously tried insert with paynum #$options{'paynum'}" .
2936 Returns the total owed for this customer on all invoices
2937 (see L<FS::cust_bill/owed>).
2943 $self->total_owed_date(2145859200); #12/31/2037
2946 =item total_owed_date TIME
2948 Returns the total owed for this customer on all invoices with date earlier than
2949 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
2950 see L<Time::Local> and L<Date::Parse> for conversion functions.
2954 sub total_owed_date {
2958 foreach my $cust_bill (
2959 grep { $_->_date <= $time }
2960 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2962 $total_bill += $cust_bill->owed;
2964 sprintf( "%.2f", $total_bill );
2967 =item apply_credits OPTION => VALUE ...
2969 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2970 to outstanding invoice balances in chronological order (or reverse
2971 chronological order if the I<order> option is set to B<newest>) and returns the
2972 value of any remaining unapplied credits available for refund (see
2973 L<FS::cust_refund>).
2981 return 0 unless $self->total_credited;
2983 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2984 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2986 my @invoices = $self->open_cust_bill;
2987 @invoices = sort { $b->_date <=> $a->_date } @invoices
2988 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2991 foreach my $cust_bill ( @invoices ) {
2994 if ( !defined($credit) || $credit->credited == 0) {
2995 $credit = pop @credits or last;
2998 if ($cust_bill->owed >= $credit->credited) {
2999 $amount=$credit->credited;
3001 $amount=$cust_bill->owed;
3004 my $cust_credit_bill = new FS::cust_credit_bill ( {
3005 'crednum' => $credit->crednum,
3006 'invnum' => $cust_bill->invnum,
3007 'amount' => $amount,
3009 my $error = $cust_credit_bill->insert;
3010 die $error if $error;
3012 redo if ($cust_bill->owed > 0);
3016 return $self->total_credited;
3019 =item apply_payments
3021 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3022 to outstanding invoice balances in chronological order.
3024 #and returns the value of any remaining unapplied payments.
3028 sub apply_payments {
3033 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3034 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3036 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3037 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3041 foreach my $cust_bill ( @invoices ) {
3044 if ( !defined($payment) || $payment->unapplied == 0 ) {
3045 $payment = pop @payments or last;
3048 if ( $cust_bill->owed >= $payment->unapplied ) {
3049 $amount = $payment->unapplied;
3051 $amount = $cust_bill->owed;
3054 my $cust_bill_pay = new FS::cust_bill_pay ( {
3055 'paynum' => $payment->paynum,
3056 'invnum' => $cust_bill->invnum,
3057 'amount' => $amount,
3059 my $error = $cust_bill_pay->insert;
3060 die $error if $error;
3062 redo if ( $cust_bill->owed > 0);
3066 return $self->total_unapplied_payments;
3069 =item total_credited
3071 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3072 customer. See L<FS::cust_credit/credited>.
3076 sub total_credited {
3078 my $total_credit = 0;
3079 foreach my $cust_credit ( qsearch('cust_credit', {
3080 'custnum' => $self->custnum,
3082 $total_credit += $cust_credit->credited;
3084 sprintf( "%.2f", $total_credit );
3087 =item total_unapplied_payments
3089 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3090 See L<FS::cust_pay/unapplied>.
3094 sub total_unapplied_payments {
3096 my $total_unapplied = 0;
3097 foreach my $cust_pay ( qsearch('cust_pay', {
3098 'custnum' => $self->custnum,
3100 $total_unapplied += $cust_pay->unapplied;
3102 sprintf( "%.2f", $total_unapplied );
3107 Returns the balance for this customer (total_owed minus total_credited
3108 minus total_unapplied_payments).
3115 $self->total_owed - $self->total_credited - $self->total_unapplied_payments
3119 =item balance_date TIME
3121 Returns the balance for this customer, only considering invoices with date
3122 earlier than TIME (total_owed_date minus total_credited minus
3123 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
3124 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
3133 $self->total_owed_date($time)
3134 - $self->total_credited
3135 - $self->total_unapplied_payments
3139 =item paydate_monthyear
3141 Returns a two-element list consisting of the month and year of this customer's
3142 paydate (credit card expiration date for CARD customers)
3146 sub paydate_monthyear {
3148 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3150 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3157 =item payinfo_masked
3159 Returns a "masked" payinfo field appropriate to the payment type. Masked characters are replaced by 'x'es. Use this to display publicly accessable account Information.
3161 Credit Cards - Mask all but the last four characters.
3162 Checks - Mask all but last 2 of account number and bank routing number.
3163 Others - Do nothing, return the unmasked string.
3167 sub payinfo_masked {
3169 return $self->paymask;
3172 =item invoicing_list [ ARRAYREF ]
3174 If an arguement is given, sets these email addresses as invoice recipients
3175 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
3176 (except as warnings), so use check_invoicing_list first.
3178 Returns a list of email addresses (with svcnum entries expanded).
3180 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
3181 check it without disturbing anything by passing nothing.
3183 This interface may change in the future.
3187 sub invoicing_list {
3188 my( $self, $arrayref ) = @_;
3190 my @cust_main_invoice;
3191 if ( $self->custnum ) {
3192 @cust_main_invoice =
3193 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3195 @cust_main_invoice = ();
3197 foreach my $cust_main_invoice ( @cust_main_invoice ) {
3198 #warn $cust_main_invoice->destnum;
3199 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3200 #warn $cust_main_invoice->destnum;
3201 my $error = $cust_main_invoice->delete;
3202 warn $error if $error;
3205 if ( $self->custnum ) {
3206 @cust_main_invoice =
3207 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3209 @cust_main_invoice = ();
3211 my %seen = map { $_->address => 1 } @cust_main_invoice;
3212 foreach my $address ( @{$arrayref} ) {
3213 next if exists $seen{$address} && $seen{$address};
3214 $seen{$address} = 1;
3215 my $cust_main_invoice = new FS::cust_main_invoice ( {
3216 'custnum' => $self->custnum,
3219 my $error = $cust_main_invoice->insert;
3220 warn $error if $error;
3223 if ( $self->custnum ) {
3225 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3231 =item check_invoicing_list ARRAYREF
3233 Checks these arguements as valid input for the invoicing_list method. If there
3234 is an error, returns the error, otherwise returns false.
3238 sub check_invoicing_list {
3239 my( $self, $arrayref ) = @_;
3240 foreach my $address ( @{$arrayref} ) {
3242 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3243 return 'Can\'t add FAX invoice destination with a blank FAX number.';
3246 my $cust_main_invoice = new FS::cust_main_invoice ( {
3247 'custnum' => $self->custnum,
3250 my $error = $self->custnum
3251 ? $cust_main_invoice->check
3252 : $cust_main_invoice->checkdest
3254 return $error if $error;
3259 =item set_default_invoicing_list
3261 Sets the invoicing list to all accounts associated with this customer,
3262 overwriting any previous invoicing list.
3266 sub set_default_invoicing_list {
3268 $self->invoicing_list($self->all_emails);
3273 Returns the email addresses of all accounts provisioned for this customer.
3280 foreach my $cust_pkg ( $self->all_pkgs ) {
3281 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3283 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3284 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3286 $list{$_}=1 foreach map { $_->email } @svc_acct;
3291 =item invoicing_list_addpost
3293 Adds postal invoicing to this customer. If this customer is already configured
3294 to receive postal invoices, does nothing.
3298 sub invoicing_list_addpost {
3300 return if grep { $_ eq 'POST' } $self->invoicing_list;
3301 my @invoicing_list = $self->invoicing_list;
3302 push @invoicing_list, 'POST';
3303 $self->invoicing_list(\@invoicing_list);
3306 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3308 Returns an array of customers referred by this customer (referral_custnum set
3309 to this custnum). If DEPTH is given, recurses up to the given depth, returning
3310 customers referred by customers referred by this customer and so on, inclusive.
3311 The default behavior is DEPTH 1 (no recursion).
3315 sub referral_cust_main {
3317 my $depth = @_ ? shift : 1;
3318 my $exclude = @_ ? shift : {};
3321 map { $exclude->{$_->custnum}++; $_; }
3322 grep { ! $exclude->{ $_->custnum } }
3323 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3327 map { $_->referral_cust_main($depth-1, $exclude) }
3334 =item referral_cust_main_ncancelled
3336 Same as referral_cust_main, except only returns customers with uncancelled
3341 sub referral_cust_main_ncancelled {
3343 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3346 =item referral_cust_pkg [ DEPTH ]
3348 Like referral_cust_main, except returns a flat list of all unsuspended (and
3349 uncancelled) packages for each customer. The number of items in this list may
3350 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3354 sub referral_cust_pkg {
3356 my $depth = @_ ? shift : 1;
3358 map { $_->unsuspended_pkgs }
3359 grep { $_->unsuspended_pkgs }
3360 $self->referral_cust_main($depth);
3363 =item referring_cust_main
3365 Returns the single cust_main record for the customer who referred this customer
3366 (referral_custnum), or false.
3370 sub referring_cust_main {
3372 return '' unless $self->referral_custnum;
3373 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3376 =item credit AMOUNT, REASON
3378 Applies a credit to this customer. If there is an error, returns the error,
3379 otherwise returns false.
3384 my( $self, $amount, $reason ) = @_;
3385 my $cust_credit = new FS::cust_credit {
3386 'custnum' => $self->custnum,
3387 'amount' => $amount,
3388 'reason' => $reason,
3390 $cust_credit->insert;
3393 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3395 Creates a one-time charge for this customer. If there is an error, returns
3396 the error, otherwise returns false.
3401 my ( $self, $amount ) = ( shift, shift );
3402 my $pkg = @_ ? shift : 'One-time charge';
3403 my $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
3404 my $taxclass = @_ ? shift : '';
3406 local $SIG{HUP} = 'IGNORE';
3407 local $SIG{INT} = 'IGNORE';
3408 local $SIG{QUIT} = 'IGNORE';
3409 local $SIG{TERM} = 'IGNORE';
3410 local $SIG{TSTP} = 'IGNORE';
3411 local $SIG{PIPE} = 'IGNORE';
3413 my $oldAutoCommit = $FS::UID::AutoCommit;
3414 local $FS::UID::AutoCommit = 0;
3417 my $part_pkg = new FS::part_pkg ( {
3419 'comment' => $comment,
3420 #'setup' => $amount,
3423 'plandata' => "setup_fee=$amount",
3426 'taxclass' => $taxclass,
3429 my $error = $part_pkg->insert;
3431 $dbh->rollback if $oldAutoCommit;
3435 my $pkgpart = $part_pkg->pkgpart;
3436 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3437 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3438 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3439 $error = $type_pkgs->insert;
3441 $dbh->rollback if $oldAutoCommit;
3446 my $cust_pkg = new FS::cust_pkg ( {
3447 'custnum' => $self->custnum,
3448 'pkgpart' => $pkgpart,
3451 $error = $cust_pkg->insert;
3453 $dbh->rollback if $oldAutoCommit;
3457 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3464 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3470 sort { $a->_date <=> $b->_date }
3471 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3474 =item open_cust_bill
3476 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3481 sub open_cust_bill {
3483 grep { $_->owed > 0 } $self->cust_bill;
3488 Returns all the credits (see L<FS::cust_credit>) for this customer.
3494 sort { $a->_date <=> $b->_date }
3495 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3500 Returns all the payments (see L<FS::cust_pay>) for this customer.
3506 sort { $a->_date <=> $b->_date }
3507 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3512 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3518 sort { $a->_date <=> $b->_date }
3519 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3525 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3531 sort { $a->_date <=> $b->_date }
3532 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3535 =item select_for_update
3537 Selects this record with the SQL "FOR UPDATE" command. This can be useful as
3542 sub select_for_update {
3544 qsearch('cust_main', { 'custnum' => $self->custnum }, '*', 'FOR UPDATE' );
3549 Returns a name string for this customer, either "Company (Last, First)" or
3556 my $name = $self->contact;
3557 $name = $self->company. " ($name)" if $self->company;
3563 Returns a name string for this (service/shipping) contact, either
3564 "Company (Last, First)" or "Last, First".
3570 if ( $self->get('ship_last') ) {
3571 my $name = $self->ship_contact;
3572 $name = $self->ship_company. " ($name)" if $self->ship_company;
3581 Returns this customer's full (billing) contact name only, "Last, First"
3587 $self->get('last'). ', '. $self->first;
3592 Returns this customer's full (shipping) contact name only, "Last, First"
3598 $self->get('ship_last')
3599 ? $self->get('ship_last'). ', '. $self->ship_first
3605 Returns a status string for this customer, currently:
3609 =item prospect - No packages have ever been ordered
3611 =item active - One or more recurring packages is active
3613 =item suspended - All non-cancelled recurring packages are suspended
3615 =item cancelled - All recurring packages are cancelled
3623 for my $status (qw( prospect active suspended cancelled )) {
3624 my $method = $status.'_sql';
3625 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3626 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3627 $sth->execute( ($self->custnum) x $numnum ) or die $sth->errstr;
3628 return $status if $sth->fetchrow_arrayref->[0];
3634 Returns a hex triplet color string for this customer's status.
3639 'prospect' => '000000',
3640 'active' => '00CC00',
3641 'suspended' => 'FF9900',
3642 'cancelled' => 'FF0000',
3646 $statuscolor{$self->status};
3651 =head1 CLASS METHODS
3657 Returns an SQL expression identifying prospective cust_main records (customers
3658 with no packages ever ordered)
3662 sub prospect_sql { "
3663 0 = ( SELECT COUNT(*) FROM cust_pkg
3664 WHERE cust_pkg.custnum = cust_main.custnum
3670 Returns an SQL expression identifying active cust_main records.
3675 0 < ( SELECT COUNT(*) FROM cust_pkg
3676 WHERE cust_pkg.custnum = cust_main.custnum
3677 AND ". FS::cust_pkg->active_sql. "
3684 Returns an SQL expression identifying suspended cust_main records.
3688 #my $recurring_sql = FS::cust_pkg->recurring_sql;
3689 my $recurring_sql = "
3690 '0' != ( select freq from part_pkg
3691 where cust_pkg.pkgpart = part_pkg.pkgpart )
3694 sub suspended_sql { susp_sql(@_); }
3696 0 < ( SELECT COUNT(*) FROM cust_pkg
3697 WHERE cust_pkg.custnum = cust_main.custnum
3699 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3701 AND 0 = ( SELECT COUNT(*) FROM cust_pkg
3702 WHERE cust_pkg.custnum = cust_main.custnum
3703 AND ". FS::cust_pkg->active_sql. "
3710 Returns an SQL expression identifying cancelled cust_main records.
3714 sub cancelled_sql { cancel_sql(@_); }
3716 0 < ( SELECT COUNT(*) FROM cust_pkg
3717 WHERE cust_pkg.custnum = cust_main.custnum
3719 AND 0 = ( SELECT COUNT(*) FROM cust_pkg
3720 WHERE cust_pkg.custnum = cust_main.custnum
3722 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3727 =item uncancelled_sql
3729 Returns an SQL expression identifying un-cancelled cust_main records.
3733 sub uncancelled_sql { uncancel_sql(@_); }
3734 sub uncancel_sql { "
3735 ( 0 < ( SELECT COUNT(*) FROM cust_pkg
3736 WHERE cust_pkg.custnum = cust_main.custnum
3737 AND ( cust_pkg.cancel IS NULL
3738 OR cust_pkg.cancel = 0
3741 OR 0 = ( SELECT COUNT(*) FROM cust_pkg
3742 WHERE cust_pkg.custnum = cust_main.custnum
3747 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
3749 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
3750 records. Currently, only I<last> or I<company> may be specified (the
3751 appropriate ship_ field is also searched if applicable).
3753 Additional options are the same as FS::Record::qsearch
3758 my( $self, $fuzzy, $hash, @opt) = @_;
3763 check_and_rebuild_fuzzyfiles();
3764 foreach my $field ( keys %$fuzzy ) {
3765 my $sub = \&{"all_$field"};
3767 $match{$_}=1 foreach ( amatch($fuzzy->{$field}, ['i'], @{ &$sub() } ) );
3769 foreach ( keys %match ) {
3770 push @cust_main, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
3771 push @cust_main, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt)
3772 if defined dbdef->table('cust_main')->column('ship_last');
3777 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
3789 =item smart_search OPTION => VALUE ...
3791 Accepts the following options: I<search>, the string to search for. The string
3792 will be searched for as a customer number, last name or company name, first
3793 searching for an exact match then fuzzy and substring matches.
3795 Any additional options treated as an additional qualifier on the search
3798 Returns a (possibly empty) array of FS::cust_main objects.
3804 my $search = delete $options{'search'};
3807 if ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
3809 push @cust_main, qsearch('cust_main', { 'custnum' => $1, %options } );
3811 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { #value search
3814 my $q_value = dbh->quote($value);
3817 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
3818 $sql .= " ( LOWER(last) = $q_value OR LOWER(company) = $q_value";
3819 $sql .= " OR LOWER(ship_last) = $q_value OR LOWER(ship_company) = $q_value"
3820 if defined dbdef->table('cust_main')->column('ship_last');
3823 push @cust_main, qsearch( 'cust_main', \%options, '', $sql );
3825 unless ( @cust_main ) { #no exact match, trying substring/fuzzy
3827 #still some false laziness w/ search/cust_main.cgi
3830 push @cust_main, qsearch( 'cust_main',
3831 { 'last' => { 'op' => 'ILIKE',
3832 'value' => "%$q_value%" },
3836 push @cust_main, qsearch( 'cust_main',
3837 { 'ship_last' => { 'op' => 'ILIKE',
3838 'value' => "%$q_value%" },
3843 if defined dbdef->table('cust_main')->column('ship_last');
3845 push @cust_main, qsearch( 'cust_main',
3846 { 'company' => { 'op' => 'ILIKE',
3847 'value' => "%$q_value%" },
3851 push @cust_main, qsearch( 'cust_main',
3852 { 'ship_company' => { 'op' => 'ILIKE',
3853 'value' => "%$q_value%" },
3857 if defined dbdef->table('cust_main')->column('ship_last');
3860 push @cust_main, FS::cust_main->fuzzy_search(
3861 { 'last' => $value },
3864 push @cust_main, FS::cust_main->fuzzy_search(
3865 { 'company' => $value },
3877 =item check_and_rebuild_fuzzyfiles
3881 sub check_and_rebuild_fuzzyfiles {
3882 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
3883 -e "$dir/cust_main.last" && -e "$dir/cust_main.company"
3884 or &rebuild_fuzzyfiles;
3887 =item rebuild_fuzzyfiles
3891 sub rebuild_fuzzyfiles {
3893 use Fcntl qw(:flock);
3895 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
3896 mkdir $dir, 0700 unless -d $dir;
3900 open(LASTLOCK,">>$dir/cust_main.last")
3901 or die "can't open $dir/cust_main.last: $!";
3902 flock(LASTLOCK,LOCK_EX)
3903 or die "can't lock $dir/cust_main.last: $!";
3905 my @all_last = map $_->getfield('last'), qsearch('cust_main', {});
3907 grep $_, map $_->getfield('ship_last'), qsearch('cust_main',{})
3908 if defined dbdef->table('cust_main')->column('ship_last');
3910 open (LASTCACHE,">$dir/cust_main.last.tmp")
3911 or die "can't open $dir/cust_main.last.tmp: $!";
3912 print LASTCACHE join("\n", @all_last), "\n";
3913 close LASTCACHE or die "can't close $dir/cust_main.last.tmp: $!";
3915 rename "$dir/cust_main.last.tmp", "$dir/cust_main.last";
3920 open(COMPANYLOCK,">>$dir/cust_main.company")
3921 or die "can't open $dir/cust_main.company: $!";
3922 flock(COMPANYLOCK,LOCK_EX)
3923 or die "can't lock $dir/cust_main.company: $!";
3925 my @all_company = grep $_ ne '', map $_->company, qsearch('cust_main',{});
3927 grep $_ ne '', map $_->ship_company, qsearch('cust_main', {})
3928 if defined dbdef->table('cust_main')->column('ship_last');
3930 open (COMPANYCACHE,">$dir/cust_main.company.tmp")
3931 or die "can't open $dir/cust_main.company.tmp: $!";
3932 print COMPANYCACHE join("\n", @all_company), "\n";
3933 close COMPANYCACHE or die "can't close $dir/cust_main.company.tmp: $!";
3935 rename "$dir/cust_main.company.tmp", "$dir/cust_main.company";
3945 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
3946 open(LASTCACHE,"<$dir/cust_main.last")
3947 or die "can't open $dir/cust_main.last: $!";
3948 my @array = map { chomp; $_; } <LASTCACHE>;
3958 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
3959 open(COMPANYCACHE,"<$dir/cust_main.company")
3960 or die "can't open $dir/cust_main.last: $!";
3961 my @array = map { chomp; $_; } <COMPANYCACHE>;
3966 =item append_fuzzyfiles LASTNAME COMPANY
3970 sub append_fuzzyfiles {
3971 my( $last, $company ) = @_;
3973 &check_and_rebuild_fuzzyfiles;
3975 use Fcntl qw(:flock);
3977 my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
3981 open(LAST,">>$dir/cust_main.last")
3982 or die "can't open $dir/cust_main.last: $!";
3984 or die "can't lock $dir/cust_main.last: $!";
3986 print LAST "$last\n";
3989 or die "can't unlock $dir/cust_main.last: $!";
3995 open(COMPANY,">>$dir/cust_main.company")
3996 or die "can't open $dir/cust_main.company: $!";
3997 flock(COMPANY,LOCK_EX)
3998 or die "can't lock $dir/cust_main.company: $!";
4000 print COMPANY "$company\n";
4002 flock(COMPANY,LOCK_UN)
4003 or die "can't unlock $dir/cust_main.company: $!";
4017 #warn join('-',keys %$param);
4018 my $fh = $param->{filehandle};
4019 my $agentnum = $param->{agentnum};
4020 my $refnum = $param->{refnum};
4021 my $pkgpart = $param->{pkgpart};
4022 my @fields = @{$param->{fields}};
4024 eval "use Text::CSV_XS;";
4027 my $csv = new Text::CSV_XS;
4034 local $SIG{HUP} = 'IGNORE';
4035 local $SIG{INT} = 'IGNORE';
4036 local $SIG{QUIT} = 'IGNORE';
4037 local $SIG{TERM} = 'IGNORE';
4038 local $SIG{TSTP} = 'IGNORE';
4039 local $SIG{PIPE} = 'IGNORE';
4041 my $oldAutoCommit = $FS::UID::AutoCommit;
4042 local $FS::UID::AutoCommit = 0;
4045 #while ( $columns = $csv->getline($fh) ) {
4047 while ( defined($line=<$fh>) ) {
4049 $csv->parse($line) or do {
4050 $dbh->rollback if $oldAutoCommit;
4051 return "can't parse: ". $csv->error_input();
4054 my @columns = $csv->fields();
4055 #warn join('-',@columns);
4058 agentnum => $agentnum,
4060 country => $conf->config('countrydefault') || 'US',
4061 payby => 'BILL', #default
4062 paydate => '12/2037', #default
4064 my $billtime = time;
4065 my %cust_pkg = ( pkgpart => $pkgpart );
4066 foreach my $field ( @fields ) {
4067 if ( $field =~ /^cust_pkg\.(setup|bill|susp|expire|cancel)$/ ) {
4068 #$cust_pkg{$1} = str2time( shift @$columns );
4069 if ( $1 eq 'setup' ) {
4070 $billtime = str2time(shift @columns);
4072 $cust_pkg{$1} = str2time( shift @columns );
4075 #$cust_main{$field} = shift @$columns;
4076 $cust_main{$field} = shift @columns;
4080 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg ) if $pkgpart;
4081 my $cust_main = new FS::cust_main ( \%cust_main );
4083 tie my %hash, 'Tie::RefHash'; #this part is important
4084 $hash{$cust_pkg} = [] if $pkgpart;
4085 my $error = $cust_main->insert( \%hash );
4088 $dbh->rollback if $oldAutoCommit;
4089 return "can't insert customer for $line: $error";
4092 #false laziness w/bill.cgi
4093 $error = $cust_main->bill( 'time' => $billtime );
4095 $dbh->rollback if $oldAutoCommit;
4096 return "can't bill customer for $line: $error";
4099 $cust_main->apply_payments;
4100 $cust_main->apply_credits;
4102 $error = $cust_main->collect();
4104 $dbh->rollback if $oldAutoCommit;
4105 return "can't collect customer for $line: $error";
4111 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4113 return "Empty file!" unless $imported;
4125 #warn join('-',keys %$param);
4126 my $fh = $param->{filehandle};
4127 my @fields = @{$param->{fields}};
4129 eval "use Text::CSV_XS;";
4132 my $csv = new Text::CSV_XS;
4139 local $SIG{HUP} = 'IGNORE';
4140 local $SIG{INT} = 'IGNORE';
4141 local $SIG{QUIT} = 'IGNORE';
4142 local $SIG{TERM} = 'IGNORE';
4143 local $SIG{TSTP} = 'IGNORE';
4144 local $SIG{PIPE} = 'IGNORE';
4146 my $oldAutoCommit = $FS::UID::AutoCommit;
4147 local $FS::UID::AutoCommit = 0;
4150 #while ( $columns = $csv->getline($fh) ) {
4152 while ( defined($line=<$fh>) ) {
4154 $csv->parse($line) or do {
4155 $dbh->rollback if $oldAutoCommit;
4156 return "can't parse: ". $csv->error_input();
4159 my @columns = $csv->fields();
4160 #warn join('-',@columns);
4163 foreach my $field ( @fields ) {
4164 $row{$field} = shift @columns;
4167 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
4168 unless ( $cust_main ) {
4169 $dbh->rollback if $oldAutoCommit;
4170 return "unknown custnum $row{'custnum'}";
4173 if ( $row{'amount'} > 0 ) {
4174 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4176 $dbh->rollback if $oldAutoCommit;
4180 } elsif ( $row{'amount'} < 0 ) {
4181 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4184 $dbh->rollback if $oldAutoCommit;
4194 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4196 return "Empty file!" unless $imported;
4208 The delete method should possibly take an FS::cust_main object reference
4209 instead of a scalar customer number.
4211 Bill and collect options should probably be passed as references instead of a
4214 There should probably be a configuration file with a list of allowed credit
4217 No multiple currency support (probably a larger project than just this module).
4219 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
4223 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
4224 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
4225 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.