5 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf @encrypted_fields
6 $import $skip_fuzzyfiles $ignore_expired_card @paytypes);
7 use vars qw( $realtime_bop_decline_quiet ); #ugh
11 use Time::Local qw(timelocal_nocheck);
14 use Digest::MD5 qw(md5_base64);
18 use String::Approx qw(amatch);
19 use Business::CreditCard 0.28;
22 use FS::UID qw( getotaker dbh );
23 use FS::Record qw( qsearchs qsearch dbdef );
24 use FS::Misc qw( send_email generate_ps do_print );
25 use FS::Msgcat qw(gettext);
29 use FS::cust_bill_pkg;
31 use FS::cust_pay_void;
32 use FS::cust_pay_batch;
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;
45 use FS::part_event_condition;
47 use FS::cust_tax_exempt;
48 use FS::cust_tax_exempt_pkg;
50 use FS::payment_gateway;
51 use FS::agent_payment_gateway;
53 use FS::payinfo_Mixin;
56 @ISA = qw( FS::Record FS::payinfo_Mixin );
58 @EXPORT_OK = qw( smart_search );
60 $realtime_bop_decline_quiet = 0;
62 # 1 is mostly method/subroutine entry and options
63 # 2 traces progress of some operations
64 # 3 is even more information including possibly sensitive data
66 $me = '[FS::cust_main]';
70 $ignore_expired_card = 0;
72 @encrypted_fields = ('payinfo', 'paycvv');
73 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
75 #ask FS::UID to run this stuff for us later
76 #$FS::UID::callback{'FS::cust_main'} = sub {
77 install_callback FS::UID sub {
79 #yes, need it for stuff below (prolly should be cached)
84 my ( $hashref, $cache ) = @_;
85 if ( exists $hashref->{'pkgnum'} ) {
86 #@{ $self->{'_pkgnum'} } = ();
87 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
88 $self->{'_pkgnum'} = $subcache;
89 #push @{ $self->{'_pkgnum'} },
90 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
96 FS::cust_main - Object methods for cust_main records
102 $record = new FS::cust_main \%hash;
103 $record = new FS::cust_main { 'column' => 'value' };
105 $error = $record->insert;
107 $error = $new_record->replace($old_record);
109 $error = $record->delete;
111 $error = $record->check;
113 @cust_pkg = $record->all_pkgs;
115 @cust_pkg = $record->ncancelled_pkgs;
117 @cust_pkg = $record->suspended_pkgs;
119 $error = $record->bill;
120 $error = $record->bill %options;
121 $error = $record->bill 'time' => $time;
123 $error = $record->collect;
124 $error = $record->collect %options;
125 $error = $record->collect 'invoice_time' => $time,
130 An FS::cust_main object represents a customer. FS::cust_main inherits from
131 FS::Record. The following fields are currently supported:
135 =item custnum - primary key (assigned automatically for new customers)
137 =item agentnum - agent (see L<FS::agent>)
139 =item refnum - Advertising source (see L<FS::part_referral>)
145 =item ss - social security number (optional)
147 =item company - (optional)
151 =item address2 - (optional)
155 =item county - (optional, see L<FS::cust_main_county>)
157 =item state - (see L<FS::cust_main_county>)
161 =item country - (see L<FS::cust_main_county>)
163 =item daytime - phone (optional)
165 =item night - phone (optional)
167 =item fax - phone (optional)
169 =item ship_first - name
171 =item ship_last - name
173 =item ship_company - (optional)
177 =item ship_address2 - (optional)
181 =item ship_county - (optional, see L<FS::cust_main_county>)
183 =item ship_state - (see L<FS::cust_main_county>)
187 =item ship_country - (see L<FS::cust_main_county>)
189 =item ship_daytime - phone (optional)
191 =item ship_night - phone (optional)
193 =item ship_fax - phone (optional)
195 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
197 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
199 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
203 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
205 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
207 =item paystart_month - start date month (maestro/solo cards only)
209 =item paystart_year - start date year (maestro/solo cards only)
211 =item payissue - issue number (maestro/solo cards only)
213 =item payname - name on card or billing name
215 =item payip - IP address from which payment information was received
217 =item tax - tax exempt, empty or `Y'
219 =item otaker - order taker (assigned automatically, see L<FS::UID>)
221 =item comments - comments (optional)
223 =item referral_custnum - referring customer number
225 =item spool_cdr - Enable individual CDR spooling, empty or `Y'
235 Creates a new customer. To add the customer to the database, see L<"insert">.
237 Note that this stores the hash reference, not a distinct copy of the hash it
238 points to. You can ask the object for a copy with the I<hash> method.
242 sub table { 'cust_main'; }
244 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
246 Adds this customer to the database. If there is an error, returns the error,
247 otherwise returns false.
249 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
250 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
251 are inserted atomicly, or the transaction is rolled back. Passing an empty
252 hash reference is equivalent to not supplying this parameter. There should be
253 a better explanation of this, but until then, here's an example:
256 tie %hash, 'Tie::RefHash'; #this part is important
258 $cust_pkg => [ $svc_acct ],
261 $cust_main->insert( \%hash );
263 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
264 be set as the invoicing list (see L<"invoicing_list">). Errors return as
265 expected and rollback the entire transaction; it is not necessary to call
266 check_invoicing_list first. The invoicing_list is set after the records in the
267 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
268 invoicing_list destination to the newly-created svc_acct. Here's an example:
270 $cust_main->insert( {}, [ $email, 'POST' ] );
272 Currently available options are: I<depend_jobnum> and I<noexport>.
274 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
275 on the supplied jobnum (they will not run until the specific job completes).
276 This can be used to defer provisioning until some action completes (such
277 as running the customer's credit card successfully).
279 The I<noexport> option is deprecated. If I<noexport> is set true, no
280 provisioning jobs (exports) are scheduled. (You can schedule them later with
281 the B<reexport> method.)
287 my $cust_pkgs = @_ ? shift : {};
288 my $invoicing_list = @_ ? shift : '';
290 warn "$me insert called with options ".
291 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
294 local $SIG{HUP} = 'IGNORE';
295 local $SIG{INT} = 'IGNORE';
296 local $SIG{QUIT} = 'IGNORE';
297 local $SIG{TERM} = 'IGNORE';
298 local $SIG{TSTP} = 'IGNORE';
299 local $SIG{PIPE} = 'IGNORE';
301 my $oldAutoCommit = $FS::UID::AutoCommit;
302 local $FS::UID::AutoCommit = 0;
305 my $prepay_identifier = '';
306 my( $amount, $seconds ) = ( 0, 0 );
308 if ( $self->payby eq 'PREPAY' ) {
310 $self->payby('BILL');
311 $prepay_identifier = $self->payinfo;
314 warn " looking up prepaid card $prepay_identifier\n"
317 my $error = $self->get_prepay($prepay_identifier, \$amount, \$seconds);
319 $dbh->rollback if $oldAutoCommit;
320 #return "error applying prepaid card (transaction rolled back): $error";
324 $payby = 'PREP' if $amount;
326 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
329 $self->payby('BILL');
330 $amount = $self->paid;
334 warn " inserting $self\n"
337 $self->signupdate(time) unless $self->signupdate;
339 my $error = $self->SUPER::insert;
341 $dbh->rollback if $oldAutoCommit;
342 #return "inserting cust_main record (transaction rolled back): $error";
346 warn " setting invoicing list\n"
349 if ( $invoicing_list ) {
350 $error = $self->check_invoicing_list( $invoicing_list );
352 $dbh->rollback if $oldAutoCommit;
353 #return "checking invoicing_list (transaction rolled back): $error";
356 $self->invoicing_list( $invoicing_list );
359 if ( $conf->config('cust_main-skeleton_tables')
360 && $conf->config('cust_main-skeleton_custnum') ) {
362 warn " inserting skeleton records\n"
365 my $error = $self->start_copy_skel;
367 $dbh->rollback if $oldAutoCommit;
373 warn " ordering packages\n"
376 $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
378 $dbh->rollback if $oldAutoCommit;
383 $dbh->rollback if $oldAutoCommit;
384 return "No svc_acct record to apply pre-paid time";
388 warn " inserting initial $payby payment of $amount\n"
390 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
392 $dbh->rollback if $oldAutoCommit;
393 return "inserting payment (transaction rolled back): $error";
397 unless ( $import || $skip_fuzzyfiles ) {
398 warn " queueing fuzzyfiles update\n"
400 $error = $self->queue_fuzzyfiles_update;
402 $dbh->rollback if $oldAutoCommit;
403 return "updating fuzzy search cache: $error";
407 warn " insert complete; committing transaction\n"
410 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
415 sub start_copy_skel {
418 #'mg_user_preference' => {},
419 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
420 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
421 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
422 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
423 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
426 _copy_skel( 'cust_main', #tablename
427 $conf->config('cust_main-skeleton_custnum'), #sourceid
428 $self->custnum, #destid
429 @tables, #child tables
433 #recursive subroutine, not a method
435 my( $table, $sourceid, $destid, %child_tables ) = @_;
438 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
439 ( $table, $primary_key ) = ( $1, $2 );
441 my $dbdef_table = dbdef->table($table);
442 $primary_key = $dbdef_table->primary_key
443 or return "$table has no primary key".
444 " (or do you need to run dbdef-create?)";
447 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
448 join (', ', keys %child_tables). "\n"
451 foreach my $child_table_def ( keys %child_tables ) {
455 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
456 ( $child_table, $child_pkey ) = ( $1, $2 );
458 $child_table = $child_table_def;
460 $child_pkey = dbdef->table($child_table)->primary_key;
461 # or return "$table has no primary key".
462 # " (or do you need to run dbdef-create?)\n";
466 if ( keys %{ $child_tables{$child_table_def} } ) {
468 return "$child_table has no primary key".
469 " (run dbdef-create or try specifying it?)\n"
472 #false laziness w/Record::insert and only works on Pg
473 #refactor the proper last-inserted-id stuff out of Record::insert if this
474 # ever gets use for anything besides a quick kludge for one customer
475 my $default = dbdef->table($child_table)->column($child_pkey)->default;
476 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
477 or return "can't parse $child_table.$child_pkey default value ".
478 " for sequence name: $default";
483 my @sel_columns = grep { $_ ne $primary_key }
484 dbdef->table($child_table)->columns;
485 my $sel_columns = join(', ', @sel_columns );
487 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
488 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
489 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
491 my $sel_st = "SELECT $sel_columns FROM $child_table".
492 " WHERE $primary_key = $sourceid";
495 my $sel_sth = dbh->prepare( $sel_st )
496 or return dbh->errstr;
498 $sel_sth->execute or return $sel_sth->errstr;
500 while ( my $row = $sel_sth->fetchrow_hashref ) {
502 warn " selected row: ".
503 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
507 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
508 my $ins_sth =dbh->prepare($statement)
509 or return dbh->errstr;
510 my @param = ( $destid, map $row->{$_}, @ins_columns );
511 warn " $statement: [ ". join(', ', @param). " ]\n"
513 $ins_sth->execute( @param )
514 or return $ins_sth->errstr;
516 #next unless keys %{ $child_tables{$child_table} };
517 next unless $sequence;
519 #another section of that laziness
520 my $seq_sql = "SELECT currval('$sequence')";
521 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
522 $seq_sth->execute or return $seq_sth->errstr;
523 my $insertid = $seq_sth->fetchrow_arrayref->[0];
525 # don't drink soap! recurse! recurse! okay!
527 _copy_skel( $child_table_def,
528 $row->{$child_pkey}, #sourceid
530 %{ $child_tables{$child_table_def} },
532 return $error if $error;
542 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
544 Like the insert method on an existing record, this method orders a package
545 and included services atomicaly. Pass a Tie::RefHash data structure to this
546 method containing FS::cust_pkg and FS::svc_I<tablename> objects. There should
547 be a better explanation of this, but until then, here's an example:
550 tie %hash, 'Tie::RefHash'; #this part is important
552 $cust_pkg => [ $svc_acct ],
555 $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
557 Services can be new, in which case they are inserted, or existing unaudited
558 services, in which case they are linked to the newly-created package.
560 Currently available options are: I<depend_jobnum> and I<noexport>.
562 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
563 on the supplied jobnum (they will not run until the specific job completes).
564 This can be used to defer provisioning until some action completes (such
565 as running the customer's credit card successfully).
567 The I<noexport> option is deprecated. If I<noexport> is set true, no
568 provisioning jobs (exports) are scheduled. (You can schedule them later with
569 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
570 on the cust_main object is not recommended, as existing services will also be
577 my $cust_pkgs = shift;
580 my %svc_options = ();
581 $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
582 if exists $options{'depend_jobnum'};
583 warn "$me order_pkgs called with options ".
584 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
587 local $SIG{HUP} = 'IGNORE';
588 local $SIG{INT} = 'IGNORE';
589 local $SIG{QUIT} = 'IGNORE';
590 local $SIG{TERM} = 'IGNORE';
591 local $SIG{TSTP} = 'IGNORE';
592 local $SIG{PIPE} = 'IGNORE';
594 my $oldAutoCommit = $FS::UID::AutoCommit;
595 local $FS::UID::AutoCommit = 0;
598 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
600 foreach my $cust_pkg ( keys %$cust_pkgs ) {
601 $cust_pkg->custnum( $self->custnum );
602 my $error = $cust_pkg->insert;
604 $dbh->rollback if $oldAutoCommit;
605 return "inserting cust_pkg (transaction rolled back): $error";
607 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
608 if ( $svc_something->svcnum ) {
609 my $old_cust_svc = $svc_something->cust_svc;
610 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
611 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
612 $error = $new_cust_svc->replace($old_cust_svc);
614 $svc_something->pkgnum( $cust_pkg->pkgnum );
615 if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
616 $svc_something->seconds( $svc_something->seconds + $$seconds );
619 $error = $svc_something->insert(%svc_options);
622 $dbh->rollback if $oldAutoCommit;
623 #return "inserting svc_ (transaction rolled back): $error";
629 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
633 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
635 Recharges this (existing) customer with the specified prepaid card (see
636 L<FS::prepay_credit>), specified either by I<identifier> or as an
637 FS::prepay_credit object. If there is an error, returns the error, otherwise
640 Optionally, four scalar references can be passed as well. They will have their
641 values filled in with the amount, number of seconds, and number of upload and
642 download bytes applied by this prepaid
647 sub recharge_prepay {
648 my( $self, $prepay_credit, $amountref, $secondsref,
649 $upbytesref, $downbytesref, $totalbytesref ) = @_;
651 local $SIG{HUP} = 'IGNORE';
652 local $SIG{INT} = 'IGNORE';
653 local $SIG{QUIT} = 'IGNORE';
654 local $SIG{TERM} = 'IGNORE';
655 local $SIG{TSTP} = 'IGNORE';
656 local $SIG{PIPE} = 'IGNORE';
658 my $oldAutoCommit = $FS::UID::AutoCommit;
659 local $FS::UID::AutoCommit = 0;
662 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
664 my $error = $self->get_prepay($prepay_credit, \$amount,
665 \$seconds, \$upbytes, \$downbytes, \$totalbytes)
666 || $self->increment_seconds($seconds)
667 || $self->increment_upbytes($upbytes)
668 || $self->increment_downbytes($downbytes)
669 || $self->increment_totalbytes($totalbytes)
670 || $self->insert_cust_pay_prepay( $amount,
672 ? $prepay_credit->identifier
677 $dbh->rollback if $oldAutoCommit;
681 if ( defined($amountref) ) { $$amountref = $amount; }
682 if ( defined($secondsref) ) { $$secondsref = $seconds; }
683 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
684 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
685 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
687 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
692 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
694 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
695 specified either by I<identifier> or as an FS::prepay_credit object.
697 References to I<amount> and I<seconds> scalars should be passed as arguments
698 and will be incremented by the values of the prepaid card.
700 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
701 check or set this customer's I<agentnum>.
703 If there is an error, returns the error, otherwise returns false.
709 my( $self, $prepay_credit, $amountref, $secondsref,
710 $upref, $downref, $totalref) = @_;
712 local $SIG{HUP} = 'IGNORE';
713 local $SIG{INT} = 'IGNORE';
714 local $SIG{QUIT} = 'IGNORE';
715 local $SIG{TERM} = 'IGNORE';
716 local $SIG{TSTP} = 'IGNORE';
717 local $SIG{PIPE} = 'IGNORE';
719 my $oldAutoCommit = $FS::UID::AutoCommit;
720 local $FS::UID::AutoCommit = 0;
723 unless ( ref($prepay_credit) ) {
725 my $identifier = $prepay_credit;
727 $prepay_credit = qsearchs(
729 { 'identifier' => $prepay_credit },
734 unless ( $prepay_credit ) {
735 $dbh->rollback if $oldAutoCommit;
736 return "Invalid prepaid card: ". $identifier;
741 if ( $prepay_credit->agentnum ) {
742 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
743 $dbh->rollback if $oldAutoCommit;
744 return "prepaid card not valid for agent ". $self->agentnum;
746 $self->agentnum($prepay_credit->agentnum);
749 my $error = $prepay_credit->delete;
751 $dbh->rollback if $oldAutoCommit;
752 return "removing prepay_credit (transaction rolled back): $error";
755 $$amountref += $prepay_credit->amount;
756 $$secondsref += $prepay_credit->seconds;
757 $$upref += $prepay_credit->upbytes;
758 $$downref += $prepay_credit->downbytes;
759 $$totalref += $prepay_credit->totalbytes;
761 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
766 =item increment_upbytes SECONDS
768 Updates this customer's single or primary account (see L<FS::svc_acct>) by
769 the specified number of upbytes. If there is an error, returns the error,
770 otherwise returns false.
774 sub increment_upbytes {
775 _increment_column( shift, 'upbytes', @_);
778 =item increment_downbytes SECONDS
780 Updates this customer's single or primary account (see L<FS::svc_acct>) by
781 the specified number of downbytes. If there is an error, returns the error,
782 otherwise returns false.
786 sub increment_downbytes {
787 _increment_column( shift, 'downbytes', @_);
790 =item increment_totalbytes SECONDS
792 Updates this customer's single or primary account (see L<FS::svc_acct>) by
793 the specified number of totalbytes. If there is an error, returns the error,
794 otherwise returns false.
798 sub increment_totalbytes {
799 _increment_column( shift, 'totalbytes', @_);
802 =item increment_seconds SECONDS
804 Updates this customer's single or primary account (see L<FS::svc_acct>) by
805 the specified number of seconds. If there is an error, returns the error,
806 otherwise returns false.
810 sub increment_seconds {
811 _increment_column( shift, 'seconds', @_);
814 =item _increment_column AMOUNT
816 Updates this customer's single or primary account (see L<FS::svc_acct>) by
817 the specified number of seconds or bytes. If there is an error, returns
818 the error, otherwise returns false.
822 sub _increment_column {
823 my( $self, $column, $amount ) = @_;
824 warn "$me increment_column called: $column, $amount\n"
827 return '' unless $amount;
829 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
830 $self->ncancelled_pkgs;
833 return 'No packages with primary or single services found'.
834 ' to apply pre-paid time';
835 } elsif ( scalar(@cust_pkg) > 1 ) {
836 #maybe have a way to specify the package/account?
837 return 'Multiple packages found to apply pre-paid time';
840 my $cust_pkg = $cust_pkg[0];
841 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
845 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
848 return 'No account found to apply pre-paid time';
849 } elsif ( scalar(@cust_svc) > 1 ) {
850 return 'Multiple accounts found to apply pre-paid time';
853 my $svc_acct = $cust_svc[0]->svc_x;
854 warn " found service svcnum ". $svc_acct->pkgnum.
855 ' ('. $svc_acct->email. ")\n"
858 $column = "increment_$column";
859 $svc_acct->$column($amount);
863 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
865 Inserts a prepayment in the specified amount for this customer. An optional
866 second argument can specify the prepayment identifier for tracking purposes.
867 If there is an error, returns the error, otherwise returns false.
871 sub insert_cust_pay_prepay {
872 shift->insert_cust_pay('PREP', @_);
875 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
877 Inserts a cash payment in the specified amount for this customer. An optional
878 second argument can specify the payment identifier for tracking purposes.
879 If there is an error, returns the error, otherwise returns false.
883 sub insert_cust_pay_cash {
884 shift->insert_cust_pay('CASH', @_);
887 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
889 Inserts a Western Union payment in the specified amount for this customer. An
890 optional second argument can specify the prepayment identifier for tracking
891 purposes. If there is an error, returns the error, otherwise returns false.
895 sub insert_cust_pay_west {
896 shift->insert_cust_pay('WEST', @_);
899 sub insert_cust_pay {
900 my( $self, $payby, $amount ) = splice(@_, 0, 3);
901 my $payinfo = scalar(@_) ? shift : '';
903 my $cust_pay = new FS::cust_pay {
904 'custnum' => $self->custnum,
905 'paid' => sprintf('%.2f', $amount),
906 #'_date' => #date the prepaid card was purchased???
908 'payinfo' => $payinfo,
916 This method is deprecated. See the I<depend_jobnum> option to the insert and
917 order_pkgs methods for a better way to defer provisioning.
919 Re-schedules all exports by calling the B<reexport> method of all associated
920 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
921 otherwise returns false.
928 carp "WARNING: FS::cust_main::reexport is deprectated; ".
929 "use the depend_jobnum option to insert or order_pkgs to delay export";
931 local $SIG{HUP} = 'IGNORE';
932 local $SIG{INT} = 'IGNORE';
933 local $SIG{QUIT} = 'IGNORE';
934 local $SIG{TERM} = 'IGNORE';
935 local $SIG{TSTP} = 'IGNORE';
936 local $SIG{PIPE} = 'IGNORE';
938 my $oldAutoCommit = $FS::UID::AutoCommit;
939 local $FS::UID::AutoCommit = 0;
942 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
943 my $error = $cust_pkg->reexport;
945 $dbh->rollback if $oldAutoCommit;
950 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
955 =item delete NEW_CUSTNUM
957 This deletes the customer. If there is an error, returns the error, otherwise
960 This will completely remove all traces of the customer record. This is not
961 what you want when a customer cancels service; for that, cancel all of the
962 customer's packages (see L</cancel>).
964 If the customer has any uncancelled packages, you need to pass a new (valid)
965 customer number for those packages to be transferred to. Cancelled packages
966 will be deleted. Did I mention that this is NOT what you want when a customer
967 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
969 You can't delete a customer with invoices (see L<FS::cust_bill>),
970 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
971 refunds (see L<FS::cust_refund>).
978 local $SIG{HUP} = 'IGNORE';
979 local $SIG{INT} = 'IGNORE';
980 local $SIG{QUIT} = 'IGNORE';
981 local $SIG{TERM} = 'IGNORE';
982 local $SIG{TSTP} = 'IGNORE';
983 local $SIG{PIPE} = 'IGNORE';
985 my $oldAutoCommit = $FS::UID::AutoCommit;
986 local $FS::UID::AutoCommit = 0;
989 if ( $self->cust_bill ) {
990 $dbh->rollback if $oldAutoCommit;
991 return "Can't delete a customer with invoices";
993 if ( $self->cust_credit ) {
994 $dbh->rollback if $oldAutoCommit;
995 return "Can't delete a customer with credits";
997 if ( $self->cust_pay ) {
998 $dbh->rollback if $oldAutoCommit;
999 return "Can't delete a customer with payments";
1001 if ( $self->cust_refund ) {
1002 $dbh->rollback if $oldAutoCommit;
1003 return "Can't delete a customer with refunds";
1006 my @cust_pkg = $self->ncancelled_pkgs;
1008 my $new_custnum = shift;
1009 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1010 $dbh->rollback if $oldAutoCommit;
1011 return "Invalid new customer number: $new_custnum";
1013 foreach my $cust_pkg ( @cust_pkg ) {
1014 my %hash = $cust_pkg->hash;
1015 $hash{'custnum'} = $new_custnum;
1016 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1017 my $error = $new_cust_pkg->replace($cust_pkg,
1018 options => { $cust_pkg->options },
1021 $dbh->rollback if $oldAutoCommit;
1026 my @cancelled_cust_pkg = $self->all_pkgs;
1027 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1028 my $error = $cust_pkg->delete;
1030 $dbh->rollback if $oldAutoCommit;
1035 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1036 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1038 my $error = $cust_main_invoice->delete;
1040 $dbh->rollback if $oldAutoCommit;
1045 my $error = $self->SUPER::delete;
1047 $dbh->rollback if $oldAutoCommit;
1051 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1056 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
1058 Replaces the OLD_RECORD with this one in the database. If there is an error,
1059 returns the error, otherwise returns false.
1061 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1062 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1063 expected and rollback the entire transaction; it is not necessary to call
1064 check_invoicing_list first. Here's an example:
1066 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1074 warn "$me replace called\n"
1077 local $SIG{HUP} = 'IGNORE';
1078 local $SIG{INT} = 'IGNORE';
1079 local $SIG{QUIT} = 'IGNORE';
1080 local $SIG{TERM} = 'IGNORE';
1081 local $SIG{TSTP} = 'IGNORE';
1082 local $SIG{PIPE} = 'IGNORE';
1084 # We absolutely have to have an old vs. new record to make this work.
1085 if (!defined($old)) {
1086 $old = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
1089 my $curuser = $FS::CurrentUser::CurrentUser;
1090 if ( $self->payby eq 'COMP'
1091 && $self->payby ne $old->payby
1092 && ! $curuser->access_right('Complimentary customer')
1095 return "You are not permitted to create complimentary accounts.";
1098 local($ignore_expired_card) = 1
1099 if $old->payby =~ /^(CARD|DCRD)$/
1100 && $self->payby =~ /^(CARD|DCRD)$/
1101 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1103 my $oldAutoCommit = $FS::UID::AutoCommit;
1104 local $FS::UID::AutoCommit = 0;
1107 my $error = $self->SUPER::replace($old);
1110 $dbh->rollback if $oldAutoCommit;
1114 if ( @param ) { # INVOICING_LIST_ARYREF
1115 my $invoicing_list = shift @param;
1116 $error = $self->check_invoicing_list( $invoicing_list );
1118 $dbh->rollback if $oldAutoCommit;
1121 $self->invoicing_list( $invoicing_list );
1124 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1125 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1126 # card/check/lec info has changed, want to retry realtime_ invoice events
1127 my $error = $self->retry_realtime;
1129 $dbh->rollback if $oldAutoCommit;
1134 unless ( $import || $skip_fuzzyfiles ) {
1135 $error = $self->queue_fuzzyfiles_update;
1137 $dbh->rollback if $oldAutoCommit;
1138 return "updating fuzzy search cache: $error";
1142 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1147 =item queue_fuzzyfiles_update
1149 Used by insert & replace to update the fuzzy search cache
1153 sub queue_fuzzyfiles_update {
1156 local $SIG{HUP} = 'IGNORE';
1157 local $SIG{INT} = 'IGNORE';
1158 local $SIG{QUIT} = 'IGNORE';
1159 local $SIG{TERM} = 'IGNORE';
1160 local $SIG{TSTP} = 'IGNORE';
1161 local $SIG{PIPE} = 'IGNORE';
1163 my $oldAutoCommit = $FS::UID::AutoCommit;
1164 local $FS::UID::AutoCommit = 0;
1167 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1168 my $error = $queue->insert( map $self->getfield($_),
1169 qw(first last company)
1172 $dbh->rollback if $oldAutoCommit;
1173 return "queueing job (transaction rolled back): $error";
1176 if ( $self->ship_last ) {
1177 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1178 $error = $queue->insert( map $self->getfield("ship_$_"),
1179 qw(first last company)
1182 $dbh->rollback if $oldAutoCommit;
1183 return "queueing job (transaction rolled back): $error";
1187 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1194 Checks all fields to make sure this is a valid customer record. If there is
1195 an error, returns the error, otherwise returns false. Called by the insert
1196 and replace methods.
1203 warn "$me check BEFORE: \n". $self->_dump
1207 $self->ut_numbern('custnum')
1208 || $self->ut_number('agentnum')
1209 || $self->ut_textn('agent_custid')
1210 || $self->ut_number('refnum')
1211 || $self->ut_name('last')
1212 || $self->ut_name('first')
1213 || $self->ut_snumbern('birthdate')
1214 || $self->ut_snumbern('signupdate')
1215 || $self->ut_textn('company')
1216 || $self->ut_text('address1')
1217 || $self->ut_textn('address2')
1218 || $self->ut_text('city')
1219 || $self->ut_textn('county')
1220 || $self->ut_textn('state')
1221 || $self->ut_country('country')
1222 || $self->ut_anything('comments')
1223 || $self->ut_numbern('referral_custnum')
1224 || $self->ut_textn('stateid')
1225 || $self->ut_textn('stateid_state')
1226 || $self->ut_textn('invoice_terms')
1228 #barf. need message catalogs. i18n. etc.
1229 $error .= "Please select an advertising source."
1230 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1231 return $error if $error;
1233 return "Unknown agent"
1234 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1236 return "Unknown refnum"
1237 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1239 return "Unknown referring custnum: ". $self->referral_custnum
1240 unless ! $self->referral_custnum
1241 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1243 if ( $self->ss eq '' ) {
1248 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1249 or return "Illegal social security number: ". $self->ss;
1250 $self->ss("$1-$2-$3");
1254 # bad idea to disable, causes billing to fail because of no tax rates later
1255 # unless ( $import ) {
1256 unless ( qsearch('cust_main_county', {
1257 'country' => $self->country,
1260 return "Unknown state/county/country: ".
1261 $self->state. "/". $self->county. "/". $self->country
1262 unless qsearch('cust_main_county',{
1263 'state' => $self->state,
1264 'county' => $self->county,
1265 'country' => $self->country,
1271 $self->ut_phonen('daytime', $self->country)
1272 || $self->ut_phonen('night', $self->country)
1273 || $self->ut_phonen('fax', $self->country)
1274 || $self->ut_zip('zip', $self->country)
1276 return $error if $error;
1278 if ( $conf->exists('cust_main-require_phone')
1279 && ! length($self->daytime) && ! length($self->night)
1282 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1284 : FS::Msgcat::_gettext('daytime');
1285 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1287 : FS::Msgcat::_gettext('night');
1289 return "$daytime_label or $night_label is required"
1294 last first company address1 address2 city county state zip
1295 country daytime night fax
1298 if ( defined $self->dbdef_table->column('ship_last') ) {
1299 if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1301 && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
1305 $self->ut_name('ship_last')
1306 || $self->ut_name('ship_first')
1307 || $self->ut_textn('ship_company')
1308 || $self->ut_text('ship_address1')
1309 || $self->ut_textn('ship_address2')
1310 || $self->ut_text('ship_city')
1311 || $self->ut_textn('ship_county')
1312 || $self->ut_textn('ship_state')
1313 || $self->ut_country('ship_country')
1315 return $error if $error;
1317 #false laziness with above
1318 unless ( qsearchs('cust_main_county', {
1319 'country' => $self->ship_country,
1322 return "Unknown ship_state/ship_county/ship_country: ".
1323 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1324 unless qsearch('cust_main_county',{
1325 'state' => $self->ship_state,
1326 'county' => $self->ship_county,
1327 'country' => $self->ship_country,
1333 $self->ut_phonen('ship_daytime', $self->ship_country)
1334 || $self->ut_phonen('ship_night', $self->ship_country)
1335 || $self->ut_phonen('ship_fax', $self->ship_country)
1336 || $self->ut_zip('ship_zip', $self->ship_country)
1338 return $error if $error;
1340 } else { # ship_ info eq billing info, so don't store dup info in database
1341 $self->setfield("ship_$_", '')
1342 foreach qw( last first company address1 address2 city county state zip
1343 country daytime night fax );
1347 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1348 # or return "Illegal payby: ". $self->payby;
1350 FS::payby->can_payby($self->table, $self->payby)
1351 or return "Illegal payby: ". $self->payby;
1353 $error = $self->ut_numbern('paystart_month')
1354 || $self->ut_numbern('paystart_year')
1355 || $self->ut_numbern('payissue')
1356 || $self->ut_textn('paytype')
1358 return $error if $error;
1360 if ( $self->payip eq '' ) {
1363 $error = $self->ut_ip('payip');
1364 return $error if $error;
1367 # If it is encrypted and the private key is not availaible then we can't
1368 # check the credit card.
1370 my $check_payinfo = 1;
1372 if ($self->is_encrypted($self->payinfo)) {
1376 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1378 my $payinfo = $self->payinfo;
1379 $payinfo =~ s/\D//g;
1380 $payinfo =~ /^(\d{13,16})$/
1381 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1383 $self->payinfo($payinfo);
1385 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1387 return gettext('unknown_card_type')
1388 if cardtype($self->payinfo) eq "Unknown";
1390 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1392 return 'Banned credit card: banned on '.
1393 time2str('%a %h %o at %r', $ban->_date).
1394 ' by '. $ban->otaker.
1395 ' (ban# '. $ban->bannum. ')';
1398 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1399 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1400 $self->paycvv =~ /^(\d{4})$/
1401 or return "CVV2 (CID) for American Express cards is four digits.";
1404 $self->paycvv =~ /^(\d{3})$/
1405 or return "CVV2 (CVC2/CID) is three digits.";
1412 my $cardtype = cardtype($payinfo);
1413 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1415 return "Start date or issue number is required for $cardtype cards"
1416 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1418 return "Start month must be between 1 and 12"
1419 if $self->paystart_month
1420 and $self->paystart_month < 1 || $self->paystart_month > 12;
1422 return "Start year must be 1990 or later"
1423 if $self->paystart_year
1424 and $self->paystart_year < 1990;
1426 return "Issue number must be beween 1 and 99"
1428 and $self->payissue < 1 || $self->payissue > 99;
1431 $self->paystart_month('');
1432 $self->paystart_year('');
1433 $self->payissue('');
1436 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1438 my $payinfo = $self->payinfo;
1439 $payinfo =~ s/[^\d\@]//g;
1440 if ( $conf->exists('echeck-nonus') ) {
1441 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1442 $payinfo = "$1\@$2";
1444 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1445 $payinfo = "$1\@$2";
1447 $self->payinfo($payinfo);
1450 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1452 return 'Banned ACH account: banned on '.
1453 time2str('%a %h %o at %r', $ban->_date).
1454 ' by '. $ban->otaker.
1455 ' (ban# '. $ban->bannum. ')';
1458 } elsif ( $self->payby eq 'LECB' ) {
1460 my $payinfo = $self->payinfo;
1461 $payinfo =~ s/\D//g;
1462 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1464 $self->payinfo($payinfo);
1467 } elsif ( $self->payby eq 'BILL' ) {
1469 $error = $self->ut_textn('payinfo');
1470 return "Illegal P.O. number: ". $self->payinfo if $error;
1473 } elsif ( $self->payby eq 'COMP' ) {
1475 my $curuser = $FS::CurrentUser::CurrentUser;
1476 if ( ! $self->custnum
1477 && ! $curuser->access_right('Complimentary customer')
1480 return "You are not permitted to create complimentary accounts."
1483 $error = $self->ut_textn('payinfo');
1484 return "Illegal comp account issuer: ". $self->payinfo if $error;
1487 } elsif ( $self->payby eq 'PREPAY' ) {
1489 my $payinfo = $self->payinfo;
1490 $payinfo =~ s/\W//g; #anything else would just confuse things
1491 $self->payinfo($payinfo);
1492 $error = $self->ut_alpha('payinfo');
1493 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1494 return "Unknown prepayment identifier"
1495 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1500 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1501 return "Expiration date required"
1502 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1506 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1507 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1508 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1509 ( $m, $y ) = ( $3, "20$2" );
1511 return "Illegal expiration date: ". $self->paydate;
1513 $self->paydate("$y-$m-01");
1514 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1515 return gettext('expired_card')
1517 && !$ignore_expired_card
1518 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1521 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1522 ( ! $conf->exists('require_cardname')
1523 || $self->payby !~ /^(CARD|DCRD)$/ )
1525 $self->payname( $self->first. " ". $self->getfield('last') );
1527 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1528 or return gettext('illegal_name'). " payname: ". $self->payname;
1532 foreach my $flag (qw( tax spool_cdr )) {
1533 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1537 $self->otaker(getotaker) unless $self->otaker;
1539 warn "$me check AFTER: \n". $self->_dump
1542 $self->SUPER::check;
1547 Returns all packages (see L<FS::cust_pkg>) for this customer.
1554 return $self->num_pkgs unless wantarray;
1557 if ( $self->{'_pkgnum'} ) {
1558 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1560 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1563 sort sort_packages @cust_pkg;
1568 Synonym for B<all_pkgs>.
1573 shift->all_pkgs(@_);
1576 =item ncancelled_pkgs
1578 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1582 sub ncancelled_pkgs {
1585 return $self->num_ncancelled_pkgs unless wantarray;
1588 if ( $self->{'_pkgnum'} ) {
1590 warn "$me ncancelled_pkgs: returning cached objects"
1593 @cust_pkg = grep { ! $_->getfield('cancel') }
1594 values %{ $self->{'_pkgnum'}->cache };
1598 warn "$me ncancelled_pkgs: searching for packages with custnum ".
1599 $self->custnum. "\n"
1603 qsearch( 'cust_pkg', {
1604 'custnum' => $self->custnum,
1608 qsearch( 'cust_pkg', {
1609 'custnum' => $self->custnum,
1614 sort sort_packages @cust_pkg;
1618 # This should be generalized to use config options to determine order.
1620 if ( $a->get('cancel') and $b->get('cancel') ) {
1621 $a->pkgnum <=> $b->pkgnum;
1622 } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1623 return -1 if $b->get('cancel');
1624 return 1 if $a->get('cancel');
1627 $a->pkgnum <=> $b->pkgnum;
1631 =item suspended_pkgs
1633 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1637 sub suspended_pkgs {
1639 grep { $_->susp } $self->ncancelled_pkgs;
1642 =item unflagged_suspended_pkgs
1644 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1645 customer (thouse packages without the `manual_flag' set).
1649 sub unflagged_suspended_pkgs {
1651 return $self->suspended_pkgs
1652 unless dbdef->table('cust_pkg')->column('manual_flag');
1653 grep { ! $_->manual_flag } $self->suspended_pkgs;
1656 =item unsuspended_pkgs
1658 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1663 sub unsuspended_pkgs {
1665 grep { ! $_->susp } $self->ncancelled_pkgs;
1668 =item num_cancelled_pkgs
1670 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1675 sub num_cancelled_pkgs {
1676 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1679 sub num_ncancelled_pkgs {
1680 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1684 my( $self, $sql ) = @_;
1685 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1686 my $sth = dbh->prepare(
1687 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1688 ) or die dbh->errstr;
1689 $sth->execute($self->custnum) or die $sth->errstr;
1690 $sth->fetchrow_arrayref->[0];
1695 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1696 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1697 on success or a list of errors.
1703 grep { $_->unsuspend } $self->suspended_pkgs;
1708 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1710 Returns a list: an empty list on success or a list of errors.
1716 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1719 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1721 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1722 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
1723 of a list of pkgparts; the hashref has the following keys:
1727 =item pkgparts - listref of pkgparts
1729 =item (other options are passed to the suspend method)
1734 Returns a list: an empty list on success or a list of errors.
1738 sub suspend_if_pkgpart {
1740 my (@pkgparts, %opt);
1741 if (ref($_[0]) eq 'HASH'){
1742 @pkgparts = @{$_[0]{pkgparts}};
1747 grep { $_->suspend(%opt) }
1748 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1749 $self->unsuspended_pkgs;
1752 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1754 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1755 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
1756 instead of a list of pkgparts; the hashref has the following keys:
1760 =item pkgparts - listref of pkgparts
1762 =item (other options are passed to the suspend method)
1766 Returns a list: an empty list on success or a list of errors.
1770 sub suspend_unless_pkgpart {
1772 my (@pkgparts, %opt);
1773 if (ref($_[0]) eq 'HASH'){
1774 @pkgparts = @{$_[0]{pkgparts}};
1779 grep { $_->suspend(%opt) }
1780 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1781 $self->unsuspended_pkgs;
1784 =item cancel [ OPTION => VALUE ... ]
1786 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1788 Available options are:
1792 =item quiet - can be set true to supress email cancellation notices.
1794 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
1796 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
1800 Always returns a list: an empty list on success or a list of errors.
1805 my( $self, %opt ) = @_;
1807 warn "$me cancel called on customer ". $self->custnum. " with options ".
1808 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
1811 return ( 'access denied' )
1812 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
1814 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1816 #should try decryption (we might have the private key)
1817 # and if not maybe queue a job for the server that does?
1818 return ( "Can't (yet) ban encrypted credit cards" )
1819 if $self->is_encrypted($self->payinfo);
1821 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1822 my $error = $ban->insert;
1823 return ( $error ) if $error;
1827 my @pkgs = $self->ncancelled_pkgs;
1829 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
1830 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
1833 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
1836 sub _banned_pay_hashref {
1847 'payby' => $payby2ban{$self->payby},
1848 'payinfo' => md5_base64($self->payinfo),
1849 #don't ever *search* on reason! #'reason' =>
1855 Returns all notes (see L<FS::cust_main_note>) for this customer.
1862 qsearch( 'cust_main_note',
1863 { 'custnum' => $self->custnum },
1865 'ORDER BY _DATE DESC'
1871 Returns the agent (see L<FS::agent>) for this customer.
1877 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1880 =item bill_and_collect
1882 Cancels and suspends any packages due, generates bills, applies payments and
1885 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
1887 Options are passed as name-value pairs. Currently available options are:
1893 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
1897 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1901 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
1905 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1909 If set true, re-charges setup fees.
1913 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
1919 sub bill_and_collect {
1920 my( $self, %options ) = @_;
1926 #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1927 foreach my $cust_pkg (
1928 grep { $_->expire && $_->expire <= $^T } $self->ncancelled_pkgs
1930 my $error = $cust_pkg->cancel;
1931 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
1932 " for custnum ". $self->custnum. ": $error"
1940 #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1941 foreach my $cust_pkg (
1942 grep { ( $_->part_pkg->is_prepaid && $_->bill && $_->bill < $^T
1943 || $_->adjourn && $_->adjourn <= $^T
1947 $self->ncancelled_pkgs
1949 my $error = $cust_pkg->suspend;
1950 warn "Error suspending package ". $cust_pkg->pkgnum.
1951 " for custnum ". $self->custnum. ": $error"
1959 my $error = $self->bill( %options );
1960 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
1962 $self->apply_payments_and_credits;
1964 $error = $self->collect( %options );
1965 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
1971 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
1972 conjunction with the collect method by calling B<bill_and_collect>.
1974 If there is an error, returns the error, otherwise returns false.
1976 Options are passed as name-value pairs. Currently available options are:
1982 If set true, re-charges setup fees.
1986 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
1990 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1994 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
1996 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2000 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
2007 my( $self, %options ) = @_;
2008 return '' if $self->payby eq 'COMP';
2009 warn "$me bill customer ". $self->custnum. "\n"
2012 my $time = $options{'time'} || time;
2017 local $SIG{HUP} = 'IGNORE';
2018 local $SIG{INT} = 'IGNORE';
2019 local $SIG{QUIT} = 'IGNORE';
2020 local $SIG{TERM} = 'IGNORE';
2021 local $SIG{TSTP} = 'IGNORE';
2022 local $SIG{PIPE} = 'IGNORE';
2024 my $oldAutoCommit = $FS::UID::AutoCommit;
2025 local $FS::UID::AutoCommit = 0;
2028 $self->select_for_update; #mutex
2030 #create a new invoice
2031 #(we'll remove it later if it doesn't actually need to be generated [contains
2032 # no line items] and we're inside a transaciton so nothing else will see it)
2033 my $cust_bill = new FS::cust_bill ( {
2034 'custnum' => $self->custnum,
2035 '_date' => ( $options{'invoice_time'} || $time ),
2036 #'charged' => $charged,
2039 $error = $cust_bill->insert;
2041 $dbh->rollback if $oldAutoCommit;
2042 return "can't create invoice for customer #". $self->custnum. ": $error";
2044 my $invnum = $cust_bill->invnum;
2047 # find the packages which are due for billing, find out how much they are
2048 # & generate invoice database.
2051 my( $total_setup, $total_recur ) = ( 0, 0 );
2053 my @precommit_hooks = ();
2055 foreach my $cust_pkg (
2056 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
2059 #NO!! next if $cust_pkg->cancel;
2060 next if $cust_pkg->getfield('cancel');
2062 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2064 #? to avoid use of uninitialized value errors... ?
2065 $cust_pkg->setfield('bill', '')
2066 unless defined($cust_pkg->bill);
2068 my $part_pkg = $cust_pkg->part_pkg;
2070 my %hash = $cust_pkg->hash;
2071 my $old_cust_pkg = new FS::cust_pkg \%hash;
2080 if ( ! $cust_pkg->setup &&
2082 ( $conf->exists('disable_setup_suspended_pkgs') &&
2083 ! $cust_pkg->getfield('susp')
2084 ) || ! $conf->exists('disable_setup_suspended_pkgs')
2086 || $options{'resetup'}
2089 warn " bill setup\n" if $DEBUG > 1;
2091 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2093 $dbh->rollback if $oldAutoCommit;
2094 return "$@ running calc_setup for $cust_pkg\n";
2097 $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
2101 # bill recurring fee
2106 if ( $part_pkg->getfield('freq') ne '0' &&
2107 ! $cust_pkg->getfield('susp') &&
2108 ( $cust_pkg->getfield('bill') || 0 ) <= $time
2111 # XXX should this be a package event? probably. events are called
2112 # at collection time at the moment, though...
2113 if ( $part_pkg->can('reset_usage') ) {
2114 warn " resetting usage counters" if $DEBUG > 1;
2115 $part_pkg->reset_usage($cust_pkg);
2118 warn " bill recur\n" if $DEBUG > 1;
2120 # XXX shared with $recur_prog
2121 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2123 #over two params! lets at least switch to a hashref for the rest...
2124 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
2126 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2128 $dbh->rollback if $oldAutoCommit;
2129 return "$@ running calc_recur for $cust_pkg\n";
2132 #change this bit to use Date::Manip? CAREFUL with timezones (see
2133 # mailing list archive)
2134 my ($sec,$min,$hour,$mday,$mon,$year) =
2135 (localtime($sdate) )[0,1,2,3,4,5];
2137 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2138 # only for figuring next bill date, nothing else, so, reset $sdate again
2140 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2141 $cust_pkg->last_bill($sdate)
2142 if $cust_pkg->dbdef_table->column('last_bill');
2144 if ( $part_pkg->freq =~ /^\d+$/ ) {
2145 $mon += $part_pkg->freq;
2146 until ( $mon < 12 ) { $mon -= 12; $year++; }
2147 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2149 $mday += $weeks * 7;
2150 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2153 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2157 $dbh->rollback if $oldAutoCommit;
2158 return "unparsable frequency: ". $part_pkg->freq;
2160 $cust_pkg->setfield('bill',
2161 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2164 warn "\$setup is undefined" unless defined($setup);
2165 warn "\$recur is undefined" unless defined($recur);
2166 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2169 # If $cust_pkg has been modified, update it and create cust_bill_pkg records
2172 if ( $cust_pkg->modified ) { # hmmm.. and if the options are modified?
2174 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2177 $error=$cust_pkg->replace($old_cust_pkg,
2178 options => { $cust_pkg->options },
2180 if ( $error ) { #just in case
2181 $dbh->rollback if $oldAutoCommit;
2182 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2185 $setup = sprintf( "%.2f", $setup );
2186 $recur = sprintf( "%.2f", $recur );
2187 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2188 $dbh->rollback if $oldAutoCommit;
2189 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2191 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2192 $dbh->rollback if $oldAutoCommit;
2193 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2196 if ( $setup != 0 || $recur != 0 ) {
2198 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2200 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2201 'invnum' => $invnum,
2202 'pkgnum' => $cust_pkg->pkgnum,
2206 'edate' => $cust_pkg->bill,
2207 'details' => \@details,
2209 $error = $cust_bill_pkg->insert;
2211 $dbh->rollback if $oldAutoCommit;
2212 return "can't create invoice line item for invoice #$invnum: $error";
2214 $total_setup += $setup;
2215 $total_recur += $recur;
2221 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2224 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2227 my %taxhash = map { $_ => $self->get("$prefix$_") }
2228 qw( state county country );
2230 $taxhash{'taxclass'} = $part_pkg->taxclass;
2232 my @taxes = qsearch( 'cust_main_county', \%taxhash );
2235 $taxhash{'taxclass'} = '';
2236 @taxes = qsearch( 'cust_main_county', \%taxhash );
2239 #one more try at a whole-country tax rate
2241 $taxhash{$_} = '' foreach qw( state county );
2242 @taxes = qsearch( 'cust_main_county', \%taxhash );
2245 # maybe eliminate this entirely, along with all the 0% records
2247 $dbh->rollback if $oldAutoCommit;
2249 "fatal: can't find tax rate for state/county/country/taxclass ".
2250 join('/', ( map $self->get("$prefix$_"),
2251 qw(state county country)
2253 $part_pkg->taxclass ). "\n";
2256 foreach my $tax ( @taxes ) {
2258 my $taxable_charged = 0;
2259 $taxable_charged += $setup
2260 unless $part_pkg->setuptax =~ /^Y$/i
2261 || $tax->setuptax =~ /^Y$/i;
2262 $taxable_charged += $recur
2263 unless $part_pkg->recurtax =~ /^Y$/i
2264 || $tax->recurtax =~ /^Y$/i;
2265 next unless $taxable_charged;
2267 if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2268 #my ($mon,$year) = (localtime($sdate) )[4,5];
2269 my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2271 my $freq = $part_pkg->freq || 1;
2272 if ( $freq !~ /(\d+)$/ ) {
2273 $dbh->rollback if $oldAutoCommit;
2274 return "daily/weekly package definitions not (yet?)".
2275 " compatible with monthly tax exemptions";
2277 my $taxable_per_month =
2278 sprintf("%.2f", $taxable_charged / $freq );
2280 #call the whole thing off if this customer has any old
2281 #exemption records...
2282 my @cust_tax_exempt =
2283 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2284 if ( @cust_tax_exempt ) {
2285 $dbh->rollback if $oldAutoCommit;
2287 'this customer still has old-style tax exemption records; '.
2288 'run bin/fs-migrate-cust_tax_exempt?';
2291 foreach my $which_month ( 1 .. $freq ) {
2293 #maintain the new exemption table now
2296 FROM cust_tax_exempt_pkg
2297 LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2298 LEFT JOIN cust_bill USING ( invnum )
2304 my $sth = dbh->prepare($sql) or do {
2305 $dbh->rollback if $oldAutoCommit;
2306 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2314 $dbh->rollback if $oldAutoCommit;
2315 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2317 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2319 my $remaining_exemption =
2320 $tax->exempt_amount - $existing_exemption;
2321 if ( $remaining_exemption > 0 ) {
2322 my $addl = $remaining_exemption > $taxable_per_month
2323 ? $taxable_per_month
2324 : $remaining_exemption;
2325 $taxable_charged -= $addl;
2327 my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2328 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2329 'taxnum' => $tax->taxnum,
2330 'year' => 1900+$year,
2332 'amount' => sprintf("%.2f", $addl ),
2334 $error = $cust_tax_exempt_pkg->insert;
2336 $dbh->rollback if $oldAutoCommit;
2337 return "fatal: can't insert cust_tax_exempt_pkg: $error";
2339 } # if $remaining_exemption > 0
2343 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2344 until ( $mon < 13 ) { $mon -= 12; $year++; }
2346 } #foreach $which_month
2348 } #if $tax->exempt_amount
2350 $taxable_charged = sprintf( "%.2f", $taxable_charged);
2352 #$tax += $taxable_charged * $cust_main_county->tax / 100
2353 $tax{ $tax->taxname || 'Tax' } +=
2354 $taxable_charged * $tax->tax / 100
2356 } #foreach my $tax ( @taxes )
2358 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2360 } #if $setup != 0 || $recur != 0
2362 } #if $cust_pkg->modified
2364 } #foreach my $cust_pkg
2366 unless ( $cust_bill->cust_bill_pkg ) {
2367 $cust_bill->delete; #don't create an invoice w/o line items
2369 # XXX this seems to be broken
2370 #( DBD::Pg::st execute failed: ERROR: syntax error at or near "hcb" )
2371 # # get rid of our fake history too, waste of unecessary space
2372 # my $h_cleanup_query = q{
2373 # DELETE FROM h_cust_bill hcb
2374 # WHERE hcb.invnum = ?
2375 # AND NOT EXISTS ( SELECT 1 FROM cust_bill cb where cb.invnum = hcb.invnum )
2377 # my $h_sth = $dbh->prepare($h_cleanup_query);
2378 # $h_sth->execute($invnum);
2380 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2384 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2386 foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2387 my $tax = sprintf("%.2f", $tax{$taxname} );
2388 $charged = sprintf( "%.2f", $charged+$tax );
2390 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2391 'invnum' => $invnum,
2397 'itemdesc' => $taxname,
2399 $error = $cust_bill_pkg->insert;
2401 $dbh->rollback if $oldAutoCommit;
2402 return "can't create invoice line item for invoice #$invnum: $error";
2404 $total_setup += $tax;
2408 $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2409 $error = $cust_bill->replace;
2411 $dbh->rollback if $oldAutoCommit;
2412 return "can't update charged for invoice #$invnum: $error";
2415 foreach my $hook ( @precommit_hooks ) {
2417 &{$hook}; #($self) ?
2420 $dbh->rollback if $oldAutoCommit;
2421 return "$@ running precommit hook $hook\n";
2425 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2429 =item collect OPTIONS
2431 (Attempt to) collect money for this customer's outstanding invoices (see
2432 L<FS::cust_bill>). Usually used after the bill method.
2434 Actions are now triggered by billing events; see L<FS::part_event> and the
2435 billing events web interface. Old-style invoice events (see
2436 L<FS::part_bill_event>) have been deprecated.
2438 If there is an error, returns the error, otherwise returns false.
2440 Options are passed as name-value pairs.
2442 Currently available options are:
2448 Use this time when deciding when to print invoices and 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> for conversion functions.
2452 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2456 set true to surpress email card/ACH decline notices.
2460 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2464 allows for one time override of normal customer billing method
2468 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
2476 my( $self, %options ) = @_;
2477 my $invoice_time = $options{'invoice_time'} || time;
2480 local $SIG{HUP} = 'IGNORE';
2481 local $SIG{INT} = 'IGNORE';
2482 local $SIG{QUIT} = 'IGNORE';
2483 local $SIG{TERM} = 'IGNORE';
2484 local $SIG{TSTP} = 'IGNORE';
2485 local $SIG{PIPE} = 'IGNORE';
2487 my $oldAutoCommit = $FS::UID::AutoCommit;
2488 local $FS::UID::AutoCommit = 0;
2491 $self->select_for_update; #mutex
2494 my $balance = $self->balance;
2495 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2498 if ( exists($options{'retry_card'}) ) {
2499 carp 'retry_card option passed to collect is deprecated; use retry';
2500 $options{'retry'} ||= $options{'retry_card'};
2502 if ( exists($options{'retry'}) && $options{'retry'} ) {
2503 my $error = $self->retry_realtime;
2505 $dbh->rollback if $oldAutoCommit;
2510 # false laziness w/pay_batch::import_results
2512 my $due_cust_event = $self->due_cust_event(
2513 'debug' => ( $options{'debug'} || 0 ),
2514 'time' => $invoice_time,
2515 'check_freq' => $options{'check_freq'},
2517 unless( ref($due_cust_event) ) {
2518 $dbh->rollback if $oldAutoCommit;
2519 return $due_cust_event;
2522 foreach my $cust_event ( @$due_cust_event ) {
2526 #re-eval event conditions (a previous event could have changed things)
2527 unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
2528 #don't leave stray "new/locked" records around
2529 my $error = $cust_event->delete;
2531 #gah, even with transactions
2532 $dbh->commit if $oldAutoCommit; #well.
2539 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2540 warn " running cust_event ". $cust_event->eventnum. "\n"
2544 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2545 if ( my $error = $cust_event->do_event() ) {
2546 #XXX wtf is this? figure out a proper dealio with return value
2548 # gah, even with transactions.
2549 $dbh->commit if $oldAutoCommit; #well.
2556 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2561 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2563 Inserts database records for and returns an ordered listref of new events due
2564 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2565 events are due, an empty listref is returned. If there is an error, returns a
2566 scalar error message.
2568 To actually run the events, call each event's test_condition method, and if
2569 still true, call the event's do_event method.
2571 Options are passed as a hashref or as a list of name-value pairs. Available
2578 Search only for events of this check frequency (how often events of this type are checked); currently "1d" (daily, the default) and "1m" (monthly) are recognized.
2582 "Current time" for the events.
2586 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
2590 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2594 Explicitly pass the objects to be tested (typically used with eventtable).
2600 sub due_cust_event {
2602 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2605 #my $DEBUG = $opt{'debug'}
2606 local($DEBUG) = $opt{'debug'}
2607 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2609 warn "$me due_cust_event called with options ".
2610 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2613 $opt{'time'} ||= time;
2615 local $SIG{HUP} = 'IGNORE';
2616 local $SIG{INT} = 'IGNORE';
2617 local $SIG{QUIT} = 'IGNORE';
2618 local $SIG{TERM} = 'IGNORE';
2619 local $SIG{TSTP} = 'IGNORE';
2620 local $SIG{PIPE} = 'IGNORE';
2622 my $oldAutoCommit = $FS::UID::AutoCommit;
2623 local $FS::UID::AutoCommit = 0;
2626 $self->select_for_update; #mutex
2629 # 1: find possible events (initial search)
2632 my @cust_event = ();
2634 my @eventtable = $opt{'eventtable'}
2635 ? ( $opt{'eventtable'} )
2636 : FS::part_event->eventtables_runorder;
2638 foreach my $eventtable ( @eventtable ) {
2641 if ( $opt{'objects'} ) {
2643 @objects = @{ $opt{'objects'} };
2647 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2648 @objects = ( $eventtable eq 'cust_main' )
2650 : ( $self->$eventtable() );
2654 my @e_cust_event = ();
2656 my $cross = "CROSS JOIN $eventtable";
2657 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2658 unless $eventtable eq 'cust_main';
2660 foreach my $object ( @objects ) {
2662 #this first search uses the condition_sql magic for optimization.
2663 #the more possible events we can eliminate in this step the better
2665 my $cross_where = '';
2666 my $pkey = $object->primary_key;
2667 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2669 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2671 FS::part_event_condition->where_conditions_sql( $eventtable,
2672 'time'=>$opt{'time'}
2674 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2676 $extra_sql = "AND $extra_sql" if $extra_sql;
2678 #here is the agent virtualization
2679 $extra_sql .= " AND ( part_event.agentnum IS NULL
2680 OR part_event.agentnum = ". $self->agentnum. ' )';
2682 $extra_sql .= " $order";
2684 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2685 if $opt{'debug'} > 2;
2686 my @part_event = qsearch( {
2687 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2688 'select' => 'part_event.*',
2689 'table' => 'part_event',
2690 'addl_from' => "$cross $join",
2691 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2692 'eventtable' => $eventtable,
2695 'extra_sql' => "AND $cross_where $extra_sql",
2699 my $pkey = $object->primary_key;
2700 warn " ". scalar(@part_event).
2701 " possible events found for $eventtable ". $object->$pkey(). "\n";
2704 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2708 warn " ". scalar(@e_cust_event).
2709 " subtotal possible cust events found for $eventtable\n"
2712 push @cust_event, @e_cust_event;
2716 warn " ". scalar(@cust_event).
2717 " total possible cust events found in initial search\n"
2721 # 2: test conditions
2726 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
2727 'stats_hashref' => \%unsat ),
2730 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2733 warn " invalid conditions not eliminated with condition_sql:\n".
2734 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2741 foreach my $cust_event ( @cust_event ) {
2743 my $error = $cust_event->insert();
2745 $dbh->rollback if $oldAutoCommit;
2751 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2757 warn " returning events: ". Dumper(@cust_event). "\n"
2764 =item retry_realtime
2766 Schedules realtime / batch credit card / electronic check / LEC billing
2767 events for for retry. Useful if card information has changed or manual
2768 retry is desired. The 'collect' method must be called to actually retry
2771 Implementation details: For either this customer, or for each of this
2772 customer's open invoices, changes the status of the first "done" (with
2773 statustext error) realtime processing event to "failed".
2777 sub retry_realtime {
2780 local $SIG{HUP} = 'IGNORE';
2781 local $SIG{INT} = 'IGNORE';
2782 local $SIG{QUIT} = 'IGNORE';
2783 local $SIG{TERM} = 'IGNORE';
2784 local $SIG{TSTP} = 'IGNORE';
2785 local $SIG{PIPE} = 'IGNORE';
2787 my $oldAutoCommit = $FS::UID::AutoCommit;
2788 local $FS::UID::AutoCommit = 0;
2791 #a little false laziness w/due_cust_event (not too bad, really)
2793 my $join = FS::part_event_condition->join_conditions_sql;
2794 my $order = FS::part_event_condition->order_conditions_sql;
2797 . join ( ' OR ' , map {
2798 "( part_event.eventtable = " . dbh->quote($_)
2799 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
2800 } FS::part_event->eventtables)
2803 #here is the agent virtualization
2804 my $agent_virt = " ( part_event.agentnum IS NULL
2805 OR part_event.agentnum = ". $self->agentnum. ' )';
2807 #XXX this shouldn't be hardcoded, actions should declare it...
2808 my @realtime_events = qw(
2809 cust_bill_realtime_card
2810 cust_bill_realtime_check
2811 cust_bill_realtime_lec
2815 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
2820 my @cust_event = qsearchs({
2821 'table' => 'cust_event',
2822 'select' => 'cust_event.*',
2823 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
2824 'hashref' => { 'status' => 'done' },
2825 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
2826 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
2829 my %seen_invnum = ();
2830 foreach my $cust_event (@cust_event) {
2832 #max one for the customer, one for each open invoice
2833 my $cust_X = $cust_event->cust_X;
2834 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
2838 or $cust_event->part_event->eventtable eq 'cust_bill'
2841 my $error = $cust_event->retry;
2843 $dbh->rollback if $oldAutoCommit;
2844 return "error scheduling event for retry: $error";
2849 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2854 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2856 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2857 via a Business::OnlinePayment realtime gateway. See
2858 L<http://420.am/business-onlinepayment> for supported gateways.
2860 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2862 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>
2864 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2865 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2866 if set, will override the value from the customer record.
2868 I<description> is a free-text field passed to the gateway. It defaults to
2869 "Internet services".
2871 If an I<invnum> is specified, this payment (if successful) is applied to the
2872 specified invoice. If you don't specify an I<invnum> you might want to
2873 call the B<apply_payments> method.
2875 I<quiet> can be set true to surpress email decline notices.
2877 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
2878 resulting paynum, if any.
2880 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2885 my( $self, $method, $amount, %options ) = @_;
2887 warn "$me realtime_bop: $method $amount\n";
2888 warn " $_ => $options{$_}\n" foreach keys %options;
2891 $options{'description'} ||= 'Internet services';
2893 eval "use Business::OnlinePayment";
2896 my $payinfo = exists($options{'payinfo'})
2897 ? $options{'payinfo'}
2900 my %method2payby = (
2907 # check for banned credit card/ACH
2910 my $ban = qsearchs('banned_pay', {
2911 'payby' => $method2payby{$method},
2912 'payinfo' => md5_base64($payinfo),
2914 return "Banned credit card" if $ban;
2921 if ( $options{'invnum'} ) {
2922 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2923 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2925 map { $_->part_pkg->taxclass }
2927 map { $_->cust_pkg }
2928 $cust_bill->cust_bill_pkg;
2929 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2930 #different taxclasses
2931 $taxclass = $taxclasses[0];
2935 #look for an agent gateway override first
2937 if ( $method eq 'CC' ) {
2938 $cardtype = cardtype($payinfo);
2939 } elsif ( $method eq 'ECHECK' ) {
2942 $cardtype = $method;
2946 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2947 cardtype => $cardtype,
2948 taxclass => $taxclass, } )
2949 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2951 taxclass => $taxclass, } )
2952 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2953 cardtype => $cardtype,
2955 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2957 taxclass => '', } );
2959 my $payment_gateway = '';
2960 my( $processor, $login, $password, $action, @bop_options );
2961 if ( $override ) { #use a payment gateway override
2963 $payment_gateway = $override->payment_gateway;
2965 $processor = $payment_gateway->gateway_module;
2966 $login = $payment_gateway->gateway_username;
2967 $password = $payment_gateway->gateway_password;
2968 $action = $payment_gateway->gateway_action;
2969 @bop_options = $payment_gateway->options;
2971 } else { #use the standard settings from the config
2973 ( $processor, $login, $password, $action, @bop_options ) =
2974 $self->default_payment_gateway($method);
2982 my $address = exists($options{'address1'})
2983 ? $options{'address1'}
2985 my $address2 = exists($options{'address2'})
2986 ? $options{'address2'}
2988 $address .= ", ". $address2 if length($address2);
2990 my $o_payname = exists($options{'payname'})
2991 ? $options{'payname'}
2993 my($payname, $payfirst, $paylast);
2994 if ( $o_payname && $method ne 'ECHECK' ) {
2995 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2996 or return "Illegal payname $payname";
2997 ($payfirst, $paylast) = ($1, $2);
2999 $payfirst = $self->getfield('first');
3000 $paylast = $self->getfield('last');
3001 $payname = "$payfirst $paylast";
3004 my @invoicing_list = $self->invoicing_list_emailonly;
3005 if ( $conf->exists('emailinvoiceautoalways')
3006 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3007 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3008 push @invoicing_list, $self->all_emails;
3011 my $email = ($conf->exists('business-onlinepayment-email-override'))
3012 ? $conf->config('business-onlinepayment-email-override')
3013 : $invoicing_list[0];
3017 my $payip = exists($options{'payip'})
3020 $content{customer_ip} = $payip
3023 $content{invoice_number} = $options{'invnum'}
3024 if exists($options{'invnum'}) && length($options{'invnum'});
3027 if ( $method eq 'CC' ) {
3029 $content{card_number} = $payinfo;
3030 $paydate = exists($options{'paydate'})
3031 ? $options{'paydate'}
3033 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3034 $content{expiration} = "$2/$1";
3036 my $paycvv = exists($options{'paycvv'})
3037 ? $options{'paycvv'}
3039 $content{cvv2} = $self->paycvv
3042 my $paystart_month = exists($options{'paystart_month'})
3043 ? $options{'paystart_month'}
3044 : $self->paystart_month;
3046 my $paystart_year = exists($options{'paystart_year'})
3047 ? $options{'paystart_year'}
3048 : $self->paystart_year;
3050 $content{card_start} = "$paystart_month/$paystart_year"
3051 if $paystart_month && $paystart_year;
3053 my $payissue = exists($options{'payissue'})
3054 ? $options{'payissue'}
3056 $content{issue_number} = $payissue if $payissue;
3058 $content{recurring_billing} = 'YES'
3059 if qsearch('cust_pay', { 'custnum' => $self->custnum,
3061 'payinfo' => $payinfo,
3063 || qsearch('cust_pay', { 'custnum' => $self->custnum,
3065 'paymask' => $self->mask_payinfo('CARD', $payinfo),
3069 } elsif ( $method eq 'ECHECK' ) {
3070 ( $content{account_number}, $content{routing_code} ) =
3071 split('@', $payinfo);
3072 $content{bank_name} = $o_payname;
3073 $content{bank_state} = exists($options{'paystate'})
3074 ? $options{'paystate'}
3075 : $self->getfield('paystate');
3076 $content{account_type} = exists($options{'paytype'})
3077 ? uc($options{'paytype'}) || 'CHECKING'
3078 : uc($self->getfield('paytype')) || 'CHECKING';
3079 $content{account_name} = $payname;
3080 $content{customer_org} = $self->company ? 'B' : 'I';
3081 $content{state_id} = exists($options{'stateid'})
3082 ? $options{'stateid'}
3083 : $self->getfield('stateid');
3084 $content{state_id_state} = exists($options{'stateid_state'})
3085 ? $options{'stateid_state'}
3086 : $self->getfield('stateid_state');
3087 $content{customer_ssn} = exists($options{'ss'})
3090 } elsif ( $method eq 'LEC' ) {
3091 $content{phone} = $payinfo;
3095 # run transaction(s)
3098 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3100 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3101 $transaction->content(
3104 'password' => $password,
3105 'action' => $action1,
3106 'description' => $options{'description'},
3107 'amount' => $amount,
3108 #'invoice_number' => $options{'invnum'},
3109 'customer_id' => $self->custnum,
3110 'last_name' => $paylast,
3111 'first_name' => $payfirst,
3113 'address' => $address,
3114 'city' => ( exists($options{'city'})
3117 'state' => ( exists($options{'state'})
3120 'zip' => ( exists($options{'zip'})
3123 'country' => ( exists($options{'country'})
3124 ? $options{'country'}
3126 'referer' => 'http://cleanwhisker.420.am/',
3128 'phone' => $self->daytime || $self->night,
3131 $transaction->submit();
3133 if ( $transaction->is_success() && $action2 ) {
3134 my $auth = $transaction->authorization;
3135 my $ordernum = $transaction->can('order_number')
3136 ? $transaction->order_number
3140 new Business::OnlinePayment( $processor, @bop_options );
3147 password => $password,
3148 order_number => $ordernum,
3150 authorization => $auth,
3151 description => $options{'description'},
3154 foreach my $field (qw( authorization_source_code returned_ACI
3155 transaction_identifier validation_code
3156 transaction_sequence_num local_transaction_date
3157 local_transaction_time AVS_result_code )) {
3158 $capture{$field} = $transaction->$field() if $transaction->can($field);
3161 $capture->content( %capture );
3165 unless ( $capture->is_success ) {
3166 my $e = "Authorization successful but capture failed, custnum #".
3167 $self->custnum. ': '. $capture->result_code.
3168 ": ". $capture->error_message;
3176 # remove paycvv after initial transaction
3179 #false laziness w/misc/process/payment.cgi - check both to make sure working
3181 if ( defined $self->dbdef_table->column('paycvv')
3182 && length($self->paycvv)
3183 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3185 my $error = $self->remove_cvv;
3187 warn "WARNING: error removing cvv: $error\n";
3195 if ( $transaction->is_success() ) {
3197 my %method2payby = (
3204 if ( $payment_gateway ) { # agent override
3205 $paybatch = $payment_gateway->gatewaynum. '-';
3208 $paybatch .= "$processor:". $transaction->authorization;
3210 $paybatch .= ':'. $transaction->order_number
3211 if $transaction->can('order_number')
3212 && length($transaction->order_number);
3214 my $cust_pay = new FS::cust_pay ( {
3215 'custnum' => $self->custnum,
3216 'invnum' => $options{'invnum'},
3219 'payby' => $method2payby{$method},
3220 'payinfo' => $payinfo,
3221 'paybatch' => $paybatch,
3222 'paydate' => $paydate,
3224 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3226 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3229 $cust_pay->invnum(''); #try again with no specific invnum
3230 my $error2 = $cust_pay->insert( $options{'manual'} ?
3231 ( 'manual' => 1 ) : ()
3234 # gah, even with transactions.
3235 my $e = 'WARNING: Card/ACH debited but database not updated - '.
3236 "error inserting payment ($processor): $error2".
3237 " (previously tried insert with invnum #$options{'invnum'}" .
3244 if ( $options{'paynum_ref'} ) {
3245 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3248 return ''; #no error
3252 my $perror = "$processor error: ". $transaction->error_message;
3254 unless ( $transaction->error_message ) {
3257 if ( $transaction->can('response_page') ) {
3259 'page' => ( $transaction->can('response_page')
3260 ? $transaction->response_page
3263 'code' => ( $transaction->can('response_code')
3264 ? $transaction->response_code
3267 'headers' => ( $transaction->can('response_headers')
3268 ? $transaction->response_headers
3274 "No additional debugging information available for $processor";
3277 $perror .= "No error_message returned from $processor -- ".
3278 ( ref($t_response) ? Dumper($t_response) : $t_response );
3282 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3283 && $conf->exists('emaildecline')
3284 && grep { $_ ne 'POST' } $self->invoicing_list
3285 && ! grep { $transaction->error_message =~ /$_/ }
3286 $conf->config('emaildecline-exclude')
3288 my @templ = $conf->config('declinetemplate');
3289 my $template = new Text::Template (
3291 SOURCE => [ map "$_\n", @templ ],
3292 ) or return "($perror) can't create template: $Text::Template::ERROR";
3293 $template->compile()
3294 or return "($perror) can't compile template: $Text::Template::ERROR";
3296 my $templ_hash = { error => $transaction->error_message };
3298 my $error = send_email(
3299 'from' => $conf->config('invoice_from'),
3300 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3301 'subject' => 'Your payment could not be processed',
3302 'body' => [ $template->fill_in(HASH => $templ_hash) ],
3305 $perror .= " (also received error sending decline notification: $error)"
3315 =item default_payment_gateway
3319 sub default_payment_gateway {
3320 my( $self, $method ) = @_;
3322 die "Real-time processing not enabled\n"
3323 unless $conf->exists('business-onlinepayment');
3326 my $bop_config = 'business-onlinepayment';
3327 $bop_config .= '-ach'
3328 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
3329 my ( $processor, $login, $password, $action, @bop_options ) =
3330 $conf->config($bop_config);
3331 $action ||= 'normal authorization';
3332 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3333 die "No real-time processor is enabled - ".
3334 "did you set the business-onlinepayment configuration value?\n"
3337 ( $processor, $login, $password, $action, @bop_options )
3342 Removes the I<paycvv> field from the database directly.
3344 If there is an error, returns the error, otherwise returns false.
3350 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3351 or return dbh->errstr;
3352 $sth->execute($self->custnum)
3353 or return $sth->errstr;
3358 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3360 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3361 via a Business::OnlinePayment realtime gateway. See
3362 L<http://420.am/business-onlinepayment> for supported gateways.
3364 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3366 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3368 Most gateways require a reference to an original payment transaction to refund,
3369 so you probably need to specify a I<paynum>.
3371 I<amount> defaults to the original amount of the payment if not specified.
3373 I<reason> specifies a reason for the refund.
3375 I<paydate> specifies the expiration date for a credit card overriding the
3376 value from the customer record or the payment record. Specified as yyyy-mm-dd
3378 Implementation note: If I<amount> is unspecified or equal to the amount of the
3379 orignal payment, first an attempt is made to "void" the transaction via
3380 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3381 the normal attempt is made to "refund" ("credit") the transaction via the
3382 gateway is attempted.
3384 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3385 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3386 #if set, will override the value from the customer record.
3388 #If an I<invnum> is specified, this payment (if successful) is applied to the
3389 #specified invoice. If you don't specify an I<invnum> you might want to
3390 #call the B<apply_payments> method.
3394 #some false laziness w/realtime_bop, not enough to make it worth merging
3395 #but some useful small subs should be pulled out
3396 sub realtime_refund_bop {
3397 my( $self, $method, %options ) = @_;
3399 warn "$me realtime_refund_bop: $method refund\n";
3400 warn " $_ => $options{$_}\n" foreach keys %options;
3403 eval "use Business::OnlinePayment";
3407 # look up the original payment and optionally a gateway for that payment
3411 my $amount = $options{'amount'};
3413 my( $processor, $login, $password, @bop_options ) ;
3414 my( $auth, $order_number ) = ( '', '', '' );
3416 if ( $options{'paynum'} ) {
3418 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
3419 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3420 or return "Unknown paynum $options{'paynum'}";
3421 $amount ||= $cust_pay->paid;
3423 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3424 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3425 $cust_pay->paybatch;
3426 my $gatewaynum = '';
3427 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3429 if ( $gatewaynum ) { #gateway for the payment to be refunded
3431 my $payment_gateway =
3432 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3433 die "payment gateway $gatewaynum not found"
3434 unless $payment_gateway;
3436 $processor = $payment_gateway->gateway_module;
3437 $login = $payment_gateway->gateway_username;
3438 $password = $payment_gateway->gateway_password;
3439 @bop_options = $payment_gateway->options;
3441 } else { #try the default gateway
3443 my( $conf_processor, $unused_action );
3444 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3445 $self->default_payment_gateway($method);
3447 return "processor of payment $options{'paynum'} $processor does not".
3448 " match default processor $conf_processor"
3449 unless $processor eq $conf_processor;
3454 } else { # didn't specify a paynum, so look for agent gateway overrides
3455 # like a normal transaction
3458 if ( $method eq 'CC' ) {
3459 $cardtype = cardtype($self->payinfo);
3460 } elsif ( $method eq 'ECHECK' ) {
3463 $cardtype = $method;
3466 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3467 cardtype => $cardtype,
3469 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3471 taxclass => '', } );
3473 if ( $override ) { #use a payment gateway override
3475 my $payment_gateway = $override->payment_gateway;
3477 $processor = $payment_gateway->gateway_module;
3478 $login = $payment_gateway->gateway_username;
3479 $password = $payment_gateway->gateway_password;
3480 #$action = $payment_gateway->gateway_action;
3481 @bop_options = $payment_gateway->options;
3483 } else { #use the standard settings from the config
3486 ( $processor, $login, $password, $unused_action, @bop_options ) =
3487 $self->default_payment_gateway($method);
3492 return "neither amount nor paynum specified" unless $amount;
3497 'password' => $password,
3498 'order_number' => $order_number,
3499 'amount' => $amount,
3500 'referer' => 'http://cleanwhisker.420.am/',
3502 $content{authorization} = $auth
3503 if length($auth); #echeck/ACH transactions have an order # but no auth
3504 #(at least with authorize.net)
3506 my $disable_void_after;
3507 if ($conf->exists('disable_void_after')
3508 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3509 $disable_void_after = $1;
3512 #first try void if applicable
3513 if ( $cust_pay && $cust_pay->paid == $amount
3515 ( not defined($disable_void_after) )
3516 || ( time < ($cust_pay->_date + $disable_void_after ) )
3519 warn " attempting void\n" if $DEBUG > 1;
3520 my $void = new Business::OnlinePayment( $processor, @bop_options );
3521 $void->content( 'action' => 'void', %content );
3523 if ( $void->is_success ) {
3524 my $error = $cust_pay->void($options{'reason'});
3526 # gah, even with transactions.
3527 my $e = 'WARNING: Card/ACH voided but database not updated - '.
3528 "error voiding payment: $error";
3532 warn " void successful\n" if $DEBUG > 1;
3537 warn " void unsuccessful, trying refund\n"
3541 my $address = $self->address1;
3542 $address .= ", ". $self->address2 if $self->address2;
3544 my($payname, $payfirst, $paylast);
3545 if ( $self->payname && $method ne 'ECHECK' ) {
3546 $payname = $self->payname;
3547 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3548 or return "Illegal payname $payname";
3549 ($payfirst, $paylast) = ($1, $2);
3551 $payfirst = $self->getfield('first');
3552 $paylast = $self->getfield('last');
3553 $payname = "$payfirst $paylast";
3556 my @invoicing_list = $self->invoicing_list_emailonly;
3557 if ( $conf->exists('emailinvoiceautoalways')
3558 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3559 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3560 push @invoicing_list, $self->all_emails;
3563 my $email = ($conf->exists('business-onlinepayment-email-override'))
3564 ? $conf->config('business-onlinepayment-email-override')
3565 : $invoicing_list[0];
3567 my $payip = exists($options{'payip'})
3570 $content{customer_ip} = $payip
3574 if ( $method eq 'CC' ) {
3577 $content{card_number} = $payinfo = $cust_pay->payinfo;
3578 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3579 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3580 ($content{expiration} = "$2/$1"); # where available
3582 $content{card_number} = $payinfo = $self->payinfo;
3583 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3584 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3585 $content{expiration} = "$2/$1";
3588 } elsif ( $method eq 'ECHECK' ) {
3591 $payinfo = $cust_pay->payinfo;
3593 $payinfo = $self->payinfo;
3595 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3596 $content{bank_name} = $self->payname;
3597 $content{account_type} = 'CHECKING';
3598 $content{account_name} = $payname;
3599 $content{customer_org} = $self->company ? 'B' : 'I';
3600 $content{customer_ssn} = $self->ss;
3601 } elsif ( $method eq 'LEC' ) {
3602 $content{phone} = $payinfo = $self->payinfo;
3606 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3607 my %sub_content = $refund->content(
3608 'action' => 'credit',
3609 'customer_id' => $self->custnum,
3610 'last_name' => $paylast,
3611 'first_name' => $payfirst,
3613 'address' => $address,
3614 'city' => $self->city,
3615 'state' => $self->state,
3616 'zip' => $self->zip,
3617 'country' => $self->country,
3619 'phone' => $self->daytime || $self->night,
3622 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3626 return "$processor error: ". $refund->error_message
3627 unless $refund->is_success();
3629 my %method2payby = (
3635 my $paybatch = "$processor:". $refund->authorization;
3636 $paybatch .= ':'. $refund->order_number
3637 if $refund->can('order_number') && $refund->order_number;
3639 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3640 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3641 last unless @cust_bill_pay;
3642 my $cust_bill_pay = pop @cust_bill_pay;
3643 my $error = $cust_bill_pay->delete;
3647 my $cust_refund = new FS::cust_refund ( {
3648 'custnum' => $self->custnum,
3649 'paynum' => $options{'paynum'},
3650 'refund' => $amount,
3652 'payby' => $method2payby{$method},
3653 'payinfo' => $payinfo,
3654 'paybatch' => $paybatch,
3655 'reason' => $options{'reason'} || 'card or ACH refund',
3657 my $error = $cust_refund->insert;
3659 $cust_refund->paynum(''); #try again with no specific paynum
3660 my $error2 = $cust_refund->insert;
3662 # gah, even with transactions.
3663 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3664 "error inserting refund ($processor): $error2".
3665 " (previously tried insert with paynum #$options{'paynum'}" .
3676 =item batch_card OPTION => VALUE...
3678 Adds a payment for this invoice to the pending credit card batch (see
3679 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3680 runs the payment using a realtime gateway.
3685 my ($self, %options) = @_;
3688 if (exists($options{amount})) {
3689 $amount = $options{amount};
3691 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3693 return '' unless $amount > 0;
3695 my $invnum = delete $options{invnum};
3696 my $payby = $options{invnum} || $self->payby; #dubious
3698 if ($options{'realtime'}) {
3699 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3705 my $oldAutoCommit = $FS::UID::AutoCommit;
3706 local $FS::UID::AutoCommit = 0;
3709 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3710 or return "Cannot lock pay_batch: " . $dbh->errstr;
3714 'payby' => FS::payby->payby2payment($payby),
3717 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3719 unless ( $pay_batch ) {
3720 $pay_batch = new FS::pay_batch \%pay_batch;
3721 my $error = $pay_batch->insert;
3723 $dbh->rollback if $oldAutoCommit;
3724 die "error creating new batch: $error\n";
3728 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3729 'batchnum' => $pay_batch->batchnum,
3730 'custnum' => $self->custnum,
3733 foreach (qw( address1 address2 city state zip country payby payinfo paydate
3735 $options{$_} = '' unless exists($options{$_});
3738 my $cust_pay_batch = new FS::cust_pay_batch ( {
3739 'batchnum' => $pay_batch->batchnum,
3740 'invnum' => $invnum || 0, # is there a better value?
3741 # this field should be
3743 # cust_bill_pay_batch now
3744 'custnum' => $self->custnum,
3745 'last' => $self->getfield('last'),
3746 'first' => $self->getfield('first'),
3747 'address1' => $options{address1} || $self->address1,
3748 'address2' => $options{address2} || $self->address2,
3749 'city' => $options{city} || $self->city,
3750 'state' => $options{state} || $self->state,
3751 'zip' => $options{zip} || $self->zip,
3752 'country' => $options{country} || $self->country,
3753 'payby' => $options{payby} || $self->payby,
3754 'payinfo' => $options{payinfo} || $self->payinfo,
3755 'exp' => $options{paydate} || $self->paydate,
3756 'payname' => $options{payname} || $self->payname,
3757 'amount' => $amount, # consolidating
3760 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
3761 if $old_cust_pay_batch;
3764 if ($old_cust_pay_batch) {
3765 $error = $cust_pay_batch->replace($old_cust_pay_batch)
3767 $error = $cust_pay_batch->insert;
3771 $dbh->rollback if $oldAutoCommit;
3775 my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
3776 foreach my $cust_bill ($self->open_cust_bill) {
3777 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
3778 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
3779 'invnum' => $cust_bill->invnum,
3780 'paybatchnum' => $cust_pay_batch->paybatchnum,
3781 'amount' => $cust_bill->owed,
3784 if ($unapplied >= $cust_bill_pay_batch->amount){
3785 $unapplied -= $cust_bill_pay_batch->amount;
3788 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
3789 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
3791 $error = $cust_bill_pay_batch->insert;
3793 $dbh->rollback if $oldAutoCommit;
3798 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3804 Returns the total owed for this customer on all invoices
3805 (see L<FS::cust_bill/owed>).
3811 $self->total_owed_date(2145859200); #12/31/2037
3814 =item total_owed_date TIME
3816 Returns the total owed for this customer on all invoices with date earlier than
3817 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
3818 see L<Time::Local> and L<Date::Parse> for conversion functions.
3822 sub total_owed_date {
3826 foreach my $cust_bill (
3827 grep { $_->_date <= $time }
3828 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3830 $total_bill += $cust_bill->owed;
3832 sprintf( "%.2f", $total_bill );
3835 =item apply_payments_and_credits
3837 Applies unapplied payments and credits.
3839 In most cases, this new method should be used in place of sequential
3840 apply_payments and apply_credits methods.
3842 If there is an error, returns the error, otherwise returns false.
3846 sub apply_payments_and_credits {
3849 local $SIG{HUP} = 'IGNORE';
3850 local $SIG{INT} = 'IGNORE';
3851 local $SIG{QUIT} = 'IGNORE';
3852 local $SIG{TERM} = 'IGNORE';
3853 local $SIG{TSTP} = 'IGNORE';
3854 local $SIG{PIPE} = 'IGNORE';
3856 my $oldAutoCommit = $FS::UID::AutoCommit;
3857 local $FS::UID::AutoCommit = 0;
3860 $self->select_for_update; #mutex
3862 foreach my $cust_bill ( $self->open_cust_bill ) {
3863 my $error = $cust_bill->apply_payments_and_credits;
3865 $dbh->rollback if $oldAutoCommit;
3866 return "Error applying: $error";
3870 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3875 =item apply_credits OPTION => VALUE ...
3877 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3878 to outstanding invoice balances in chronological order (or reverse
3879 chronological order if the I<order> option is set to B<newest>) and returns the
3880 value of any remaining unapplied credits available for refund (see
3881 L<FS::cust_refund>).
3883 Dies if there is an error.
3891 local $SIG{HUP} = 'IGNORE';
3892 local $SIG{INT} = 'IGNORE';
3893 local $SIG{QUIT} = 'IGNORE';
3894 local $SIG{TERM} = 'IGNORE';
3895 local $SIG{TSTP} = 'IGNORE';
3896 local $SIG{PIPE} = 'IGNORE';
3898 my $oldAutoCommit = $FS::UID::AutoCommit;
3899 local $FS::UID::AutoCommit = 0;
3902 $self->select_for_update; #mutex
3904 unless ( $self->total_credited ) {
3905 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3909 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3910 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3912 my @invoices = $self->open_cust_bill;
3913 @invoices = sort { $b->_date <=> $a->_date } @invoices
3914 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3917 foreach my $cust_bill ( @invoices ) {
3920 if ( !defined($credit) || $credit->credited == 0) {
3921 $credit = pop @credits or last;
3924 if ($cust_bill->owed >= $credit->credited) {
3925 $amount=$credit->credited;
3927 $amount=$cust_bill->owed;
3930 my $cust_credit_bill = new FS::cust_credit_bill ( {
3931 'crednum' => $credit->crednum,
3932 'invnum' => $cust_bill->invnum,
3933 'amount' => $amount,
3935 my $error = $cust_credit_bill->insert;
3937 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3941 redo if ($cust_bill->owed > 0);
3945 my $total_credited = $self->total_credited;
3947 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3949 return $total_credited;
3952 =item apply_payments
3954 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3955 to outstanding invoice balances in chronological order.
3957 #and returns the value of any remaining unapplied payments.
3959 Dies if there is an error.
3963 sub apply_payments {
3966 local $SIG{HUP} = 'IGNORE';
3967 local $SIG{INT} = 'IGNORE';
3968 local $SIG{QUIT} = 'IGNORE';
3969 local $SIG{TERM} = 'IGNORE';
3970 local $SIG{TSTP} = 'IGNORE';
3971 local $SIG{PIPE} = 'IGNORE';
3973 my $oldAutoCommit = $FS::UID::AutoCommit;
3974 local $FS::UID::AutoCommit = 0;
3977 $self->select_for_update; #mutex
3981 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3982 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3984 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3985 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3989 foreach my $cust_bill ( @invoices ) {
3992 if ( !defined($payment) || $payment->unapplied == 0 ) {
3993 $payment = pop @payments or last;
3996 if ( $cust_bill->owed >= $payment->unapplied ) {
3997 $amount = $payment->unapplied;
3999 $amount = $cust_bill->owed;
4002 my $cust_bill_pay = new FS::cust_bill_pay ( {
4003 'paynum' => $payment->paynum,
4004 'invnum' => $cust_bill->invnum,
4005 'amount' => $amount,
4007 my $error = $cust_bill_pay->insert;
4009 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4013 redo if ( $cust_bill->owed > 0);
4017 my $total_unapplied_payments = $self->total_unapplied_payments;
4019 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4021 return $total_unapplied_payments;
4024 =item total_credited
4026 Returns the total outstanding credit (see L<FS::cust_credit>) for this
4027 customer. See L<FS::cust_credit/credited>.
4031 sub total_credited {
4033 my $total_credit = 0;
4034 foreach my $cust_credit ( qsearch('cust_credit', {
4035 'custnum' => $self->custnum,
4037 $total_credit += $cust_credit->credited;
4039 sprintf( "%.2f", $total_credit );
4042 =item total_unapplied_payments
4044 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
4045 See L<FS::cust_pay/unapplied>.
4049 sub total_unapplied_payments {
4051 my $total_unapplied = 0;
4052 foreach my $cust_pay ( qsearch('cust_pay', {
4053 'custnum' => $self->custnum,
4055 $total_unapplied += $cust_pay->unapplied;
4057 sprintf( "%.2f", $total_unapplied );
4060 =item total_unapplied_refunds
4062 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
4063 customer. See L<FS::cust_refund/unapplied>.
4067 sub total_unapplied_refunds {
4069 my $total_unapplied = 0;
4070 foreach my $cust_refund ( qsearch('cust_refund', {
4071 'custnum' => $self->custnum,
4073 $total_unapplied += $cust_refund->unapplied;
4075 sprintf( "%.2f", $total_unapplied );
4080 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4081 total_credited minus total_unapplied_payments).
4089 + $self->total_unapplied_refunds
4090 - $self->total_credited
4091 - $self->total_unapplied_payments
4095 =item balance_date TIME
4097 Returns the balance for this customer, only considering invoices with date
4098 earlier than TIME (total_owed_date minus total_credited minus
4099 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
4100 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
4109 $self->total_owed_date($time)
4110 + $self->total_unapplied_refunds
4111 - $self->total_credited
4112 - $self->total_unapplied_payments
4116 =item in_transit_payments
4118 Returns the total of requests for payments for this customer pending in
4119 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
4123 sub in_transit_payments {
4125 my $in_transit_payments = 0;
4126 foreach my $pay_batch ( qsearch('pay_batch', {
4129 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4130 'batchnum' => $pay_batch->batchnum,
4131 'custnum' => $self->custnum,
4133 $in_transit_payments += $cust_pay_batch->amount;
4136 sprintf( "%.2f", $in_transit_payments );
4139 =item paydate_monthyear
4141 Returns a two-element list consisting of the month and year of this customer's
4142 paydate (credit card expiration date for CARD customers)
4146 sub paydate_monthyear {
4148 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4150 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4157 =item invoicing_list [ ARRAYREF ]
4159 If an arguement is given, sets these email addresses as invoice recipients
4160 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
4161 (except as warnings), so use check_invoicing_list first.
4163 Returns a list of email addresses (with svcnum entries expanded).
4165 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
4166 check it without disturbing anything by passing nothing.
4168 This interface may change in the future.
4172 sub invoicing_list {
4173 my( $self, $arrayref ) = @_;
4176 my @cust_main_invoice;
4177 if ( $self->custnum ) {
4178 @cust_main_invoice =
4179 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4181 @cust_main_invoice = ();
4183 foreach my $cust_main_invoice ( @cust_main_invoice ) {
4184 #warn $cust_main_invoice->destnum;
4185 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4186 #warn $cust_main_invoice->destnum;
4187 my $error = $cust_main_invoice->delete;
4188 warn $error if $error;
4191 if ( $self->custnum ) {
4192 @cust_main_invoice =
4193 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4195 @cust_main_invoice = ();
4197 my %seen = map { $_->address => 1 } @cust_main_invoice;
4198 foreach my $address ( @{$arrayref} ) {
4199 next if exists $seen{$address} && $seen{$address};
4200 $seen{$address} = 1;
4201 my $cust_main_invoice = new FS::cust_main_invoice ( {
4202 'custnum' => $self->custnum,
4205 my $error = $cust_main_invoice->insert;
4206 warn $error if $error;
4210 if ( $self->custnum ) {
4212 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4219 =item check_invoicing_list ARRAYREF
4221 Checks these arguements as valid input for the invoicing_list method. If there
4222 is an error, returns the error, otherwise returns false.
4226 sub check_invoicing_list {
4227 my( $self, $arrayref ) = @_;
4229 foreach my $address ( @$arrayref ) {
4231 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4232 return 'Can\'t add FAX invoice destination with a blank FAX number.';
4235 my $cust_main_invoice = new FS::cust_main_invoice ( {
4236 'custnum' => $self->custnum,
4239 my $error = $self->custnum
4240 ? $cust_main_invoice->check
4241 : $cust_main_invoice->checkdest
4243 return $error if $error;
4247 return "Email address required"
4248 if $conf->exists('cust_main-require_invoicing_list_email')
4249 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4254 =item set_default_invoicing_list
4256 Sets the invoicing list to all accounts associated with this customer,
4257 overwriting any previous invoicing list.
4261 sub set_default_invoicing_list {
4263 $self->invoicing_list($self->all_emails);
4268 Returns the email addresses of all accounts provisioned for this customer.
4275 foreach my $cust_pkg ( $self->all_pkgs ) {
4276 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4278 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4279 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4281 $list{$_}=1 foreach map { $_->email } @svc_acct;
4286 =item invoicing_list_addpost
4288 Adds postal invoicing to this customer. If this customer is already configured
4289 to receive postal invoices, does nothing.
4293 sub invoicing_list_addpost {
4295 return if grep { $_ eq 'POST' } $self->invoicing_list;
4296 my @invoicing_list = $self->invoicing_list;
4297 push @invoicing_list, 'POST';
4298 $self->invoicing_list(\@invoicing_list);
4301 =item invoicing_list_emailonly
4303 Returns the list of email invoice recipients (invoicing_list without non-email
4304 destinations such as POST and FAX).
4308 sub invoicing_list_emailonly {
4310 warn "$me invoicing_list_emailonly called"
4312 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4315 =item invoicing_list_emailonly_scalar
4317 Returns the list of email invoice recipients (invoicing_list without non-email
4318 destinations such as POST and FAX) as a comma-separated scalar.
4322 sub invoicing_list_emailonly_scalar {
4324 warn "$me invoicing_list_emailonly_scalar called"
4326 join(', ', $self->invoicing_list_emailonly);
4329 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4331 Returns an array of customers referred by this customer (referral_custnum set
4332 to this custnum). If DEPTH is given, recurses up to the given depth, returning
4333 customers referred by customers referred by this customer and so on, inclusive.
4334 The default behavior is DEPTH 1 (no recursion).
4338 sub referral_cust_main {
4340 my $depth = @_ ? shift : 1;
4341 my $exclude = @_ ? shift : {};
4344 map { $exclude->{$_->custnum}++; $_; }
4345 grep { ! $exclude->{ $_->custnum } }
4346 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4350 map { $_->referral_cust_main($depth-1, $exclude) }
4357 =item referral_cust_main_ncancelled
4359 Same as referral_cust_main, except only returns customers with uncancelled
4364 sub referral_cust_main_ncancelled {
4366 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4369 =item referral_cust_pkg [ DEPTH ]
4371 Like referral_cust_main, except returns a flat list of all unsuspended (and
4372 uncancelled) packages for each customer. The number of items in this list may
4373 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4377 sub referral_cust_pkg {
4379 my $depth = @_ ? shift : 1;
4381 map { $_->unsuspended_pkgs }
4382 grep { $_->unsuspended_pkgs }
4383 $self->referral_cust_main($depth);
4386 =item referring_cust_main
4388 Returns the single cust_main record for the customer who referred this customer
4389 (referral_custnum), or false.
4393 sub referring_cust_main {
4395 return '' unless $self->referral_custnum;
4396 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4399 =item credit AMOUNT, REASON
4401 Applies a credit to this customer. If there is an error, returns the error,
4402 otherwise returns false.
4407 my( $self, $amount, $reason ) = @_;
4408 my $cust_credit = new FS::cust_credit {
4409 'custnum' => $self->custnum,
4410 'amount' => $amount,
4411 'reason' => $reason,
4413 $cust_credit->insert;
4416 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4418 Creates a one-time charge for this customer. If there is an error, returns
4419 the error, otherwise returns false.
4425 my ( $amount, $pkg, $comment, $taxclass, $additional );
4426 if ( ref( $_[0] ) ) {
4427 $amount = $_[0]->{amount};
4428 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4429 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
4430 : '$'. sprintf("%.2f",$amount);
4431 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4432 $additional = $_[0]->{additional};
4435 $pkg = @_ ? shift : 'One-time charge';
4436 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
4437 $taxclass = @_ ? shift : '';
4441 local $SIG{HUP} = 'IGNORE';
4442 local $SIG{INT} = 'IGNORE';
4443 local $SIG{QUIT} = 'IGNORE';
4444 local $SIG{TERM} = 'IGNORE';
4445 local $SIG{TSTP} = 'IGNORE';
4446 local $SIG{PIPE} = 'IGNORE';
4448 my $oldAutoCommit = $FS::UID::AutoCommit;
4449 local $FS::UID::AutoCommit = 0;
4452 my $part_pkg = new FS::part_pkg ( {
4454 'comment' => $comment,
4458 'taxclass' => $taxclass,
4461 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4462 ( 0 .. @$additional - 1 )
4464 'additional_count' => scalar(@$additional),
4465 'setup_fee' => $amount,
4468 my $error = $part_pkg->insert( options => \%options );
4470 $dbh->rollback if $oldAutoCommit;
4474 my $pkgpart = $part_pkg->pkgpart;
4475 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4476 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4477 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4478 $error = $type_pkgs->insert;
4480 $dbh->rollback if $oldAutoCommit;
4485 my $cust_pkg = new FS::cust_pkg ( {
4486 'custnum' => $self->custnum,
4487 'pkgpart' => $pkgpart,
4490 $error = $cust_pkg->insert;
4492 $dbh->rollback if $oldAutoCommit;
4496 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4503 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4509 sort { $a->_date <=> $b->_date }
4510 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4513 =item open_cust_bill
4515 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4520 sub open_cust_bill {
4522 grep { $_->owed > 0 } $self->cust_bill;
4527 Returns all the credits (see L<FS::cust_credit>) for this customer.
4533 sort { $a->_date <=> $b->_date }
4534 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4539 Returns all the payments (see L<FS::cust_pay>) for this customer.
4545 sort { $a->_date <=> $b->_date }
4546 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4551 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4557 sort { $a->_date <=> $b->_date }
4558 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4561 =item cust_pay_batch
4563 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
4567 sub cust_pay_batch {
4569 sort { $a->_date <=> $b->_date }
4570 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
4575 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4581 sort { $a->_date <=> $b->_date }
4582 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4587 Returns a name string for this customer, either "Company (Last, First)" or
4594 my $name = $self->contact;
4595 $name = $self->company. " ($name)" if $self->company;
4601 Returns a name string for this (service/shipping) contact, either
4602 "Company (Last, First)" or "Last, First".
4608 if ( $self->get('ship_last') ) {
4609 my $name = $self->ship_contact;
4610 $name = $self->ship_company. " ($name)" if $self->ship_company;
4619 Returns this customer's full (billing) contact name only, "Last, First"
4625 $self->get('last'). ', '. $self->first;
4630 Returns this customer's full (shipping) contact name only, "Last, First"
4636 $self->get('ship_last')
4637 ? $self->get('ship_last'). ', '. $self->ship_first
4643 Returns this customer's full country name
4649 code2country($self->country);
4656 Returns a status string for this customer, currently:
4660 =item prospect - No packages have ever been ordered
4662 =item active - One or more recurring packages is active
4664 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4666 =item suspended - All non-cancelled recurring packages are suspended
4668 =item cancelled - All recurring packages are cancelled
4674 sub status { shift->cust_status(@_); }
4678 for my $status (qw( prospect active inactive suspended cancelled )) {
4679 my $method = $status.'_sql';
4680 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4681 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4682 $sth->execute( ($self->custnum) x $numnum )
4683 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4684 return $status if $sth->fetchrow_arrayref->[0];
4688 =item ucfirst_cust_status
4690 =item ucfirst_status
4692 Returns the status with the first character capitalized.
4696 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4698 sub ucfirst_cust_status {
4700 ucfirst($self->cust_status);
4705 Returns a hex triplet color string for this customer's status.
4709 use vars qw(%statuscolor);
4710 tie my %statuscolor, 'Tie::IxHash',
4711 'prospect' => '7e0079', #'000000', #black? naw, purple
4712 'active' => '00CC00', #green
4713 'inactive' => '0000CC', #blue
4714 'suspended' => 'FF9900', #yellow
4715 'cancelled' => 'FF0000', #red
4718 sub statuscolor { shift->cust_statuscolor(@_); }
4720 sub cust_statuscolor {
4722 $statuscolor{$self->cust_status};
4727 Returns an array of hashes representing the customer's RT tickets.
4734 my $num = $conf->config('cust_main-max_tickets') || 10;
4737 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4739 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4743 foreach my $priority (
4744 $conf->config('ticket_system-custom_priority_field-values'), ''
4746 last if scalar(@tickets) >= $num;
4748 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4749 $num - scalar(@tickets),
4758 # Return services representing svc_accts in customer support packages
4759 sub support_services {
4761 my %packages = map { $_ => 1 } $conf->config('support_packages');
4763 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4764 grep { $_->part_svc->svcdb eq 'svc_acct' }
4765 map { $_->cust_svc }
4766 grep { exists $packages{ $_->pkgpart } }
4767 $self->ncancelled_pkgs;
4773 =head1 CLASS METHODS
4779 Class method that returns the list of possible status strings for customers
4780 (see L<the status method|/status>). For example:
4782 @statuses = FS::cust_main->statuses();
4787 #my $self = shift; #could be class...
4793 Returns an SQL expression identifying prospective cust_main records (customers
4794 with no packages ever ordered)
4798 use vars qw($select_count_pkgs);
4799 $select_count_pkgs =
4800 "SELECT COUNT(*) FROM cust_pkg
4801 WHERE cust_pkg.custnum = cust_main.custnum";
4803 sub select_count_pkgs_sql {
4807 sub prospect_sql { "
4808 0 = ( $select_count_pkgs )
4813 Returns an SQL expression identifying active cust_main records (customers with
4814 no active recurring packages, but otherwise unsuspended/uncancelled).
4819 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
4825 Returns an SQL expression identifying inactive cust_main records (customers with
4826 active recurring packages).
4830 sub inactive_sql { "
4831 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4833 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
4839 Returns an SQL expression identifying suspended cust_main records.
4844 sub suspended_sql { susp_sql(@_); }
4846 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
4848 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4854 Returns an SQL expression identifying cancelled cust_main records.
4858 sub cancelled_sql { cancel_sql(@_); }
4861 my $recurring_sql = FS::cust_pkg->recurring_sql;
4862 #my $recurring_sql = "
4863 # '0' != ( select freq from part_pkg
4864 # where cust_pkg.pkgpart = part_pkg.pkgpart )
4868 0 < ( $select_count_pkgs )
4869 AND 0 = ( $select_count_pkgs AND $recurring_sql
4870 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4876 =item uncancelled_sql
4878 Returns an SQL expression identifying un-cancelled cust_main records.
4882 sub uncancelled_sql { uncancel_sql(@_); }
4883 sub uncancel_sql { "
4884 ( 0 < ( $select_count_pkgs
4885 AND ( cust_pkg.cancel IS NULL
4886 OR cust_pkg.cancel = 0
4889 OR 0 = ( $select_count_pkgs )
4895 Returns an SQL fragment to retreive the balance.
4900 COALESCE( ( SELECT SUM(charged) FROM cust_bill
4901 WHERE cust_bill.custnum = cust_main.custnum ), 0)
4902 - COALESCE( ( SELECT SUM(paid) FROM cust_pay
4903 WHERE cust_pay.custnum = cust_main.custnum ), 0)
4904 - COALESCE( ( SELECT SUM(amount) FROM cust_credit
4905 WHERE cust_credit.custnum = cust_main.custnum ), 0)
4906 + COALESCE( ( SELECT SUM(refund) FROM cust_refund
4907 WHERE cust_refund.custnum = cust_main.custnum ), 0)
4910 =item balance_date_sql TIME
4912 Returns an SQL fragment to retreive the balance for this customer, only
4913 considering invoices with date earlier than TIME. (total_owed_date minus total_credited minus
4914 total_unapplied_payments). TIME is specified as an SQL fragment or a numeric
4915 UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and
4916 L<Date::Parse> for conversion functions.
4920 sub balance_date_sql {
4921 my( $class, $time ) = @_;
4923 my $owed_sql = FS::cust_bill->owed_sql;
4924 my $unapp_refund_sql = FS::cust_refund->unapplied_sql;
4925 #my $unapp_credit_sql = FS::cust_credit->unapplied_sql;
4926 my $unapp_credit_sql = FS::cust_credit->credited_sql;
4927 my $unapp_pay_sql = FS::cust_pay->unapplied_sql;
4930 COALESCE( ( SELECT SUM($owed_sql) FROM cust_bill
4931 WHERE cust_bill.custnum = cust_main.custnum
4932 AND cust_bill._date <= $time )
4935 + COALESCE( ( SELECT SUM($unapp_refund_sql) FROM cust_refund
4936 WHERE cust_refund.custnum = cust_main.custnum )
4939 - COALESCE( ( SELECT SUM($unapp_credit_sql) FROM cust_credit
4940 WHERE cust_credit.custnum = cust_main.custnum )
4943 - COALESCE( ( SELECT SUM($unapp_pay_sql) FROM cust_pay
4944 WHERE cust_pay.custnum = cust_main.custnum )
4952 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
4954 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
4955 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
4956 appropriate ship_ field is also searched).
4958 Additional options are the same as FS::Record::qsearch
4963 my( $self, $fuzzy, $hash, @opt) = @_;
4968 check_and_rebuild_fuzzyfiles();
4969 foreach my $field ( keys %$fuzzy ) {
4971 my $all = $self->all_X($field);
4972 next unless scalar(@$all);
4975 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
4978 foreach ( keys %match ) {
4979 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
4980 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
4983 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4986 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4988 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4996 Returns a masked version of the named field
5001 my ($self,$field) = @_;
5005 'x'x(length($self->getfield($field))-4).
5006 substr($self->getfield($field), (length($self->getfield($field))-4));
5016 =item smart_search OPTION => VALUE ...
5018 Accepts the following options: I<search>, the string to search for. The string
5019 will be searched for as a customer number, phone number, name or company name,
5020 as an exact, or, in some cases, a substring or fuzzy match (see the source code
5021 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
5022 skip fuzzy matching when an exact match is found.
5024 Any additional options are treated as an additional qualifier on the search
5027 Returns a (possibly empty) array of FS::cust_main objects.
5034 #here is the agent virtualization
5035 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5039 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
5040 my $search = delete $options{'search'};
5041 ( my $alphanum_search = $search ) =~ s/\W//g;
5043 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
5045 #false laziness w/Record::ut_phone
5046 my $phonen = "$1-$2-$3";
5047 $phonen .= " x$4" if $4;
5049 push @cust_main, qsearch( {
5050 'table' => 'cust_main',
5051 'hashref' => { %options },
5052 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5054 join(' OR ', map "$_ = '$phonen'",
5055 qw( daytime night fax
5056 ship_daytime ship_night ship_fax )
5059 " AND $agentnums_sql", #agent virtualization
5062 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
5063 #try looking for matches with extensions unless one was specified
5065 push @cust_main, qsearch( {
5066 'table' => 'cust_main',
5067 'hashref' => { %options },
5068 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5070 join(' OR ', map "$_ LIKE '$phonen\%'",
5072 ship_daytime ship_night )
5075 " AND $agentnums_sql", #agent virtualization
5080 } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
5082 push @cust_main, qsearch( {
5083 'table' => 'cust_main',
5084 'hashref' => { 'custnum' => $1, %options },
5085 'extra_sql' => " AND $agentnums_sql", #agent virtualization
5088 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
5090 my($company, $last, $first) = ( $1, $2, $3 );
5092 # "Company (Last, First)"
5093 #this is probably something a browser remembered,
5094 #so just do an exact search
5096 foreach my $prefix ( '', 'ship_' ) {
5097 push @cust_main, qsearch( {
5098 'table' => 'cust_main',
5099 'hashref' => { $prefix.'first' => $first,
5100 $prefix.'last' => $last,
5101 $prefix.'company' => $company,
5104 'extra_sql' => " AND $agentnums_sql",
5108 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
5109 # try (ship_){last,company}
5113 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
5114 # # full strings the browser remembers won't work
5115 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
5117 use Lingua::EN::NameParse;
5118 my $NameParse = new Lingua::EN::NameParse(
5120 allow_reversed => 1,
5123 my($last, $first) = ( '', '' );
5124 #maybe disable this too and just rely on NameParse?
5125 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
5127 ($last, $first) = ( $1, $2 );
5129 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
5130 } elsif ( ! $NameParse->parse($value) ) {
5132 my %name = $NameParse->components;
5133 $first = $name{'given_name_1'};
5134 $last = $name{'surname_1'};
5138 if ( $first && $last ) {
5140 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
5143 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5145 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
5146 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
5149 push @cust_main, qsearch( {
5150 'table' => 'cust_main',
5151 'hashref' => \%options,
5152 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5155 # or it just be something that was typed in... (try that in a sec)
5159 my $q_value = dbh->quote($value);
5162 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5163 $sql .= " ( LOWER(last) = $q_value
5164 OR LOWER(company) = $q_value
5165 OR LOWER(ship_last) = $q_value
5166 OR LOWER(ship_company) = $q_value
5169 push @cust_main, qsearch( {
5170 'table' => 'cust_main',
5171 'hashref' => \%options,
5172 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5175 #no exact match, trying substring/fuzzy
5176 #always do substring & fuzzy (unless they're explicity config'ed off)
5177 #getting complaints searches are not returning enough
5178 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
5180 #still some false laziness w/ search/cust_main.cgi
5185 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
5186 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
5189 if ( $first && $last ) {
5192 { 'first' => { op=>'ILIKE', value=>"%$first%" },
5193 'last' => { op=>'ILIKE', value=>"%$last%" },
5195 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
5196 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
5203 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
5204 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
5208 foreach my $hashref ( @hashrefs ) {
5210 push @cust_main, qsearch( {
5211 'table' => 'cust_main',
5212 'hashref' => { %$hashref,
5215 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
5224 " AND $agentnums_sql", #extra_sql #agent virtualization
5227 if ( $first && $last ) {
5228 push @cust_main, FS::cust_main->fuzzy_search(
5229 { 'last' => $last, #fuzzy hashref
5230 'first' => $first }, #
5234 foreach my $field ( 'last', 'company' ) {
5236 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
5241 #eliminate duplicates
5243 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5251 =item check_and_rebuild_fuzzyfiles
5255 use vars qw(@fuzzyfields);
5256 @fuzzyfields = ( 'last', 'first', 'company' );
5258 sub check_and_rebuild_fuzzyfiles {
5259 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5260 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
5263 =item rebuild_fuzzyfiles
5267 sub rebuild_fuzzyfiles {
5269 use Fcntl qw(:flock);
5271 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5272 mkdir $dir, 0700 unless -d $dir;
5274 foreach my $fuzzy ( @fuzzyfields ) {
5276 open(LOCK,">>$dir/cust_main.$fuzzy")
5277 or die "can't open $dir/cust_main.$fuzzy: $!";
5279 or die "can't lock $dir/cust_main.$fuzzy: $!";
5281 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
5282 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
5284 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
5285 my $sth = dbh->prepare("SELECT $field FROM cust_main".
5286 " WHERE $field != '' AND $field IS NOT NULL");
5287 $sth->execute or die $sth->errstr;
5289 while ( my $row = $sth->fetchrow_arrayref ) {
5290 print CACHE $row->[0]. "\n";
5295 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
5297 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
5308 my( $self, $field ) = @_;
5309 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5310 open(CACHE,"<$dir/cust_main.$field")
5311 or die "can't open $dir/cust_main.$field: $!";
5312 my @array = map { chomp; $_; } <CACHE>;
5317 =item append_fuzzyfiles LASTNAME COMPANY
5321 sub append_fuzzyfiles {
5322 #my( $first, $last, $company ) = @_;
5324 &check_and_rebuild_fuzzyfiles;
5326 use Fcntl qw(:flock);
5328 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5330 foreach my $field (qw( first last company )) {
5335 open(CACHE,">>$dir/cust_main.$field")
5336 or die "can't open $dir/cust_main.$field: $!";
5337 flock(CACHE,LOCK_EX)
5338 or die "can't lock $dir/cust_main.$field: $!";
5340 print CACHE "$value\n";
5342 flock(CACHE,LOCK_UN)
5343 or die "can't unlock $dir/cust_main.$field: $!";
5358 #warn join('-',keys %$param);
5359 my $fh = $param->{filehandle};
5360 my $agentnum = $param->{agentnum};
5362 my $refnum = $param->{refnum};
5363 my $pkgpart = $param->{pkgpart};
5365 #my @fields = @{$param->{fields}};
5366 my $format = $param->{'format'};
5369 if ( $format eq 'simple' ) {
5370 @fields = qw( cust_pkg.setup dayphone first last
5371 address1 address2 city state zip comments );
5373 } elsif ( $format eq 'extended' ) {
5374 @fields = qw( agent_custid refnum
5375 last first address1 address2 city state zip country
5377 ship_last ship_first ship_address1 ship_address2
5378 ship_city ship_state ship_zip ship_country
5379 payinfo paycvv paydate
5382 svc_acct.username svc_acct._password
5386 die "unknown format $format";
5389 eval "use Text::CSV_XS;";
5392 my $csv = new Text::CSV_XS;
5399 local $SIG{HUP} = 'IGNORE';
5400 local $SIG{INT} = 'IGNORE';
5401 local $SIG{QUIT} = 'IGNORE';
5402 local $SIG{TERM} = 'IGNORE';
5403 local $SIG{TSTP} = 'IGNORE';
5404 local $SIG{PIPE} = 'IGNORE';
5406 my $oldAutoCommit = $FS::UID::AutoCommit;
5407 local $FS::UID::AutoCommit = 0;
5410 #while ( $columns = $csv->getline($fh) ) {
5412 while ( defined($line=<$fh>) ) {
5414 $csv->parse($line) or do {
5415 $dbh->rollback if $oldAutoCommit;
5416 return "can't parse: ". $csv->error_input();
5419 my @columns = $csv->fields();
5420 #warn join('-',@columns);
5423 agentnum => $agentnum,
5425 country => $conf->config('countrydefault') || 'US',
5426 payby => $payby, #default
5427 paydate => '12/2037', #default
5429 my $billtime = time;
5430 my %cust_pkg = ( pkgpart => $pkgpart );
5432 foreach my $field ( @fields ) {
5434 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
5436 #$cust_pkg{$1} = str2time( shift @$columns );
5437 if ( $1 eq 'pkgpart' ) {
5438 $cust_pkg{$1} = shift @columns;
5439 } elsif ( $1 eq 'setup' ) {
5440 $billtime = str2time(shift @columns);
5442 $cust_pkg{$1} = str2time( shift @columns );
5445 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
5447 $svc_acct{$1} = shift @columns;
5451 #refnum interception
5452 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
5454 my $referral = $columns[0];
5455 my %hash = ( 'referral' => $referral,
5456 'agentnum' => $agentnum,
5460 my $part_referral = qsearchs('part_referral', \%hash )
5461 || new FS::part_referral \%hash;
5463 unless ( $part_referral->refnum ) {
5464 my $error = $part_referral->insert;
5466 $dbh->rollback if $oldAutoCommit;
5467 return "can't auto-insert advertising source: $referral: $error";
5471 $columns[0] = $part_referral->refnum;
5474 #$cust_main{$field} = shift @$columns;
5475 $cust_main{$field} = shift @columns;
5479 $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
5481 my $invoicing_list = $cust_main{'invoicing_list'}
5482 ? [ delete $cust_main{'invoicing_list'} ]
5485 my $cust_main = new FS::cust_main ( \%cust_main );
5488 tie my %hash, 'Tie::RefHash'; #this part is important
5490 if ( $cust_pkg{'pkgpart'} ) {
5491 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
5494 if ( $svc_acct{'username'} ) {
5495 my $part_pkg = $cust_pkg->part_pkg;
5496 unless ( $part_pkg ) {
5497 $dbh->rollback if $oldAutoCommit;
5498 return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
5500 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
5501 push @svc_acct, new FS::svc_acct ( \%svc_acct )
5504 $hash{$cust_pkg} = \@svc_acct;
5507 my $error = $cust_main->insert( \%hash, $invoicing_list );
5510 $dbh->rollback if $oldAutoCommit;
5511 return "can't insert customer for $line: $error";
5514 if ( $format eq 'simple' ) {
5516 #false laziness w/bill.cgi
5517 $error = $cust_main->bill( 'time' => $billtime );
5519 $dbh->rollback if $oldAutoCommit;
5520 return "can't bill customer for $line: $error";
5523 $error = $cust_main->apply_payments_and_credits;
5525 $dbh->rollback if $oldAutoCommit;
5526 return "can't bill customer for $line: $error";
5529 $error = $cust_main->collect();
5531 $dbh->rollback if $oldAutoCommit;
5532 return "can't collect customer for $line: $error";
5540 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5542 return "Empty file!" unless $imported;
5554 #warn join('-',keys %$param);
5555 my $fh = $param->{filehandle};
5556 my @fields = @{$param->{fields}};
5558 eval "use Text::CSV_XS;";
5561 my $csv = new Text::CSV_XS;
5568 local $SIG{HUP} = 'IGNORE';
5569 local $SIG{INT} = 'IGNORE';
5570 local $SIG{QUIT} = 'IGNORE';
5571 local $SIG{TERM} = 'IGNORE';
5572 local $SIG{TSTP} = 'IGNORE';
5573 local $SIG{PIPE} = 'IGNORE';
5575 my $oldAutoCommit = $FS::UID::AutoCommit;
5576 local $FS::UID::AutoCommit = 0;
5579 #while ( $columns = $csv->getline($fh) ) {
5581 while ( defined($line=<$fh>) ) {
5583 $csv->parse($line) or do {
5584 $dbh->rollback if $oldAutoCommit;
5585 return "can't parse: ". $csv->error_input();
5588 my @columns = $csv->fields();
5589 #warn join('-',@columns);
5592 foreach my $field ( @fields ) {
5593 $row{$field} = shift @columns;
5596 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
5597 unless ( $cust_main ) {
5598 $dbh->rollback if $oldAutoCommit;
5599 return "unknown custnum $row{'custnum'}";
5602 if ( $row{'amount'} > 0 ) {
5603 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
5605 $dbh->rollback if $oldAutoCommit;
5609 } elsif ( $row{'amount'} < 0 ) {
5610 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
5613 $dbh->rollback if $oldAutoCommit;
5623 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5625 return "Empty file!" unless $imported;
5631 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5633 Sends a templated email notification to the customer (see L<Text::Template>).
5635 OPTIONS is a hash and may include
5637 I<from> - the email sender (default is invoice_from)
5639 I<to> - comma-separated scalar or arrayref of recipients
5640 (default is invoicing_list)
5642 I<subject> - The subject line of the sent email notification
5643 (default is "Notice from company_name")
5645 I<extra_fields> - a hashref of name/value pairs which will be substituted
5648 The following variables are vavailable in the template.
5650 I<$first> - the customer first name
5651 I<$last> - the customer last name
5652 I<$company> - the customer company
5653 I<$payby> - a description of the method of payment for the customer
5654 # would be nice to use FS::payby::shortname
5655 I<$payinfo> - the account information used to collect for this customer
5656 I<$expdate> - the expiration of the customer payment in seconds from epoch
5661 my ($customer, $template, %options) = @_;
5663 return unless $conf->exists($template);
5665 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
5666 $from = $options{from} if exists($options{from});
5668 my $to = join(',', $customer->invoicing_list_emailonly);
5669 $to = $options{to} if exists($options{to});
5671 my $subject = "Notice from " . $conf->config('company_name')
5672 if $conf->exists('company_name');
5673 $subject = $options{subject} if exists($options{subject});
5675 my $notify_template = new Text::Template (TYPE => 'ARRAY',
5676 SOURCE => [ map "$_\n",
5677 $conf->config($template)]
5679 or die "can't create new Text::Template object: Text::Template::ERROR";
5680 $notify_template->compile()
5681 or die "can't compile template: Text::Template::ERROR";
5683 my $paydate = $customer->paydate;
5684 $FS::notify_template::_template::first = $customer->first;
5685 $FS::notify_template::_template::last = $customer->last;
5686 $FS::notify_template::_template::company = $customer->company;
5687 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
5688 my $payby = $customer->payby;
5689 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5690 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5692 #credit cards expire at the end of the month/year of their exp date
5693 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5694 $FS::notify_template::_template::payby = 'credit card';
5695 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5696 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5698 }elsif ($payby eq 'COMP') {
5699 $FS::notify_template::_template::payby = 'complimentary account';
5701 $FS::notify_template::_template::payby = 'current method';
5703 $FS::notify_template::_template::expdate = $expire_time;
5705 for (keys %{$options{extra_fields}}){
5707 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5710 send_email(from => $from,
5712 subject => $subject,
5713 body => $notify_template->fill_in( PACKAGE =>
5714 'FS::notify_template::_template' ),
5719 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5721 Generates a templated notification to the customer (see L<Text::Template>).
5723 OPTIONS is a hash and may include
5725 I<extra_fields> - a hashref of name/value pairs which will be substituted
5726 into the template. These values may override values mentioned below
5727 and those from the customer record.
5729 The following variables are available in the template instead of or in addition
5730 to the fields of the customer record.
5732 I<$payby> - a description of the method of payment for the customer
5733 # would be nice to use FS::payby::shortname
5734 I<$payinfo> - the masked account information used to collect for this customer
5735 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5736 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress
5740 sub generate_letter {
5741 my ($self, $template, %options) = @_;
5743 return unless $conf->exists($template);
5745 my $letter_template = new Text::Template
5747 SOURCE => [ map "$_\n", $conf->config($template)],
5748 DELIMITERS => [ '[@--', '--@]' ],
5750 or die "can't create new Text::Template object: Text::Template::ERROR";
5752 $letter_template->compile()
5753 or die "can't compile template: Text::Template::ERROR";
5755 my %letter_data = map { $_ => $self->$_ } $self->fields;
5756 $letter_data{payinfo} = $self->mask_payinfo;
5758 #my $paydate = $self->paydate || '2037-12';
5759 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12';
5761 my $payby = $self->payby;
5762 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5763 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5765 #credit cards expire at the end of the month/year of their exp date
5766 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5767 $letter_data{payby} = 'credit card';
5768 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5769 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5771 }elsif ($payby eq 'COMP') {
5772 $letter_data{payby} = 'complimentary account';
5774 $letter_data{payby} = 'current method';
5776 $letter_data{expdate} = $expire_time;
5778 for (keys %{$options{extra_fields}}){
5779 $letter_data{$_} = $options{extra_fields}->{$_};
5782 unless(exists($letter_data{returnaddress})){
5783 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5784 $self->agent_template)
5787 $letter_data{returnaddress} = length($retadd) ? $retadd : '~';
5790 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5792 my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
5793 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5797 ) or die "can't open temp file: $!\n";
5799 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5801 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5805 =item print_ps TEMPLATE
5807 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5813 my $file = $self->generate_letter(@_);
5814 FS::Misc::generate_ps($file);
5817 =item print TEMPLATE
5819 Prints the filled in template.
5821 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5825 sub queueable_print {
5828 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5829 or die "invalid customer number: " . $opt{custvnum};
5831 my $error = $self->print( $opt{template} );
5832 die $error if $error;
5836 my ($self, $template) = (shift, shift);
5837 do_print [ $self->print_ps($template) ];
5840 sub agent_template {
5842 $self->_agent_plandata('agent_templatename');
5845 sub agent_invoice_from {
5847 $self->_agent_plandata('agent_invoice_from');
5850 sub _agent_plandata {
5851 my( $self, $option ) = @_;
5853 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5854 #agent-specific Conf
5856 my $agentnum = $self->agentnum;
5858 my $part_event_option =
5860 'select' => 'part_event_option.*',
5861 'table' => 'part_event_option',
5863 LEFT JOIN part_event USING ( eventpart )
5864 LEFT JOIN part_event_option AS peo_agentnum
5865 ON ( part_event.eventpart = peo_agentnum.eventpart
5866 AND peo_agentnum.optionname = 'agentnum'
5867 AND peo_agentnum.optionvalue ~ '(^|,)}. $agentnum. q{(,|$)'
5869 LEFT JOIN part_event_option AS peo_cust_bill_age
5870 ON ( part_event.eventpart = peo_cust_bill_age.eventpart
5871 AND peo_cust_bill_age.optionname = 'cust_bill_age'
5874 #'hashref' => { 'optionname' => $option },
5875 #'hashref' => { 'part_event_option.optionname' => $option },
5877 " WHERE part_event_option.optionname = ". dbh->quote($option).
5878 " AND action = 'cust_bill_send_agent' ".
5879 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5880 " AND peo_agentnum.optionname = 'agentnum' ".
5881 " AND agentnum IS NULL OR agentnum = $agentnum ".
5883 CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
5885 ELSE EXTRACT( EPOCH FROM
5886 REPLACE( peo_cust_bill_age.optionvalue,
5892 , part_event.weight".
5896 unless ( $part_event_option ) {
5897 return $self->agent->invoice_template || ''
5898 if $option eq 'agent_templatename';
5902 $part_event_option->optionvalue;
5907 ## actual sub, not a method, designed to be called from the queue.
5908 ## sets up the customer, and calls the bill_and_collect
5909 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5910 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5911 $cust_main->bill_and_collect(
5922 The delete method should possibly take an FS::cust_main object reference
5923 instead of a scalar customer number.
5925 Bill and collect options should probably be passed as references instead of a
5928 There should probably be a configuration file with a list of allowed credit
5931 No multiple currency support (probably a larger project than just this module).
5933 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5935 Birthdates rely on negative epoch values.
5937 The payby for card/check batches is broken. With mixed batching, bad
5940 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5944 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5945 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5946 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.