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';
1443 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1445 $payinfo = "$1\@$2";
1446 $self->payinfo($payinfo);
1449 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1451 return 'Banned ACH account: banned on '.
1452 time2str('%a %h %o at %r', $ban->_date).
1453 ' by '. $ban->otaker.
1454 ' (ban# '. $ban->bannum. ')';
1457 } elsif ( $self->payby eq 'LECB' ) {
1459 my $payinfo = $self->payinfo;
1460 $payinfo =~ s/\D//g;
1461 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1463 $self->payinfo($payinfo);
1466 } elsif ( $self->payby eq 'BILL' ) {
1468 $error = $self->ut_textn('payinfo');
1469 return "Illegal P.O. number: ". $self->payinfo if $error;
1472 } elsif ( $self->payby eq 'COMP' ) {
1474 my $curuser = $FS::CurrentUser::CurrentUser;
1475 if ( ! $self->custnum
1476 && ! $curuser->access_right('Complimentary customer')
1479 return "You are not permitted to create complimentary accounts."
1482 $error = $self->ut_textn('payinfo');
1483 return "Illegal comp account issuer: ". $self->payinfo if $error;
1486 } elsif ( $self->payby eq 'PREPAY' ) {
1488 my $payinfo = $self->payinfo;
1489 $payinfo =~ s/\W//g; #anything else would just confuse things
1490 $self->payinfo($payinfo);
1491 $error = $self->ut_alpha('payinfo');
1492 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1493 return "Unknown prepayment identifier"
1494 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1499 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1500 return "Expiration date required"
1501 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1505 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1506 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1507 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1508 ( $m, $y ) = ( $3, "20$2" );
1510 return "Illegal expiration date: ". $self->paydate;
1512 $self->paydate("$y-$m-01");
1513 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1514 return gettext('expired_card')
1516 && !$ignore_expired_card
1517 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1520 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1521 ( ! $conf->exists('require_cardname')
1522 || $self->payby !~ /^(CARD|DCRD)$/ )
1524 $self->payname( $self->first. " ". $self->getfield('last') );
1526 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1527 or return gettext('illegal_name'). " payname: ". $self->payname;
1531 foreach my $flag (qw( tax spool_cdr )) {
1532 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1536 $self->otaker(getotaker) unless $self->otaker;
1538 warn "$me check AFTER: \n". $self->_dump
1541 $self->SUPER::check;
1546 Returns all packages (see L<FS::cust_pkg>) for this customer.
1553 return $self->num_pkgs unless wantarray;
1556 if ( $self->{'_pkgnum'} ) {
1557 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1559 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1562 sort sort_packages @cust_pkg;
1567 Synonym for B<all_pkgs>.
1572 shift->all_pkgs(@_);
1575 =item ncancelled_pkgs
1577 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1581 sub ncancelled_pkgs {
1584 return $self->num_ncancelled_pkgs unless wantarray;
1587 if ( $self->{'_pkgnum'} ) {
1589 warn "$me ncancelled_pkgs: returning cached objects"
1592 @cust_pkg = grep { ! $_->getfield('cancel') }
1593 values %{ $self->{'_pkgnum'}->cache };
1597 warn "$me ncancelled_pkgs: searching for packages for custnum ".
1602 qsearch( 'cust_pkg', {
1603 'custnum' => $self->custnum,
1607 qsearch( 'cust_pkg', {
1608 'custnum' => $self->custnum,
1613 sort sort_packages @cust_pkg;
1617 # This should be generalized to use config options to determine order.
1619 if ( $a->get('cancel') and $b->get('cancel') ) {
1620 $a->pkgnum <=> $b->pkgnum;
1621 } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1622 return -1 if $b->get('cancel');
1623 return 1 if $a->get('cancel');
1626 $a->pkgnum <=> $b->pkgnum;
1630 =item suspended_pkgs
1632 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1636 sub suspended_pkgs {
1638 grep { $_->susp } $self->ncancelled_pkgs;
1641 =item unflagged_suspended_pkgs
1643 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1644 customer (thouse packages without the `manual_flag' set).
1648 sub unflagged_suspended_pkgs {
1650 return $self->suspended_pkgs
1651 unless dbdef->table('cust_pkg')->column('manual_flag');
1652 grep { ! $_->manual_flag } $self->suspended_pkgs;
1655 =item unsuspended_pkgs
1657 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1662 sub unsuspended_pkgs {
1664 grep { ! $_->susp } $self->ncancelled_pkgs;
1667 =item num_cancelled_pkgs
1669 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1674 sub num_cancelled_pkgs {
1675 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1678 sub num_ncancelled_pkgs {
1679 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1683 my( $self, $sql ) = @_;
1684 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1685 my $sth = dbh->prepare(
1686 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1687 ) or die dbh->errstr;
1688 $sth->execute($self->custnum) or die $sth->errstr;
1689 $sth->fetchrow_arrayref->[0];
1694 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1695 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1696 on success or a list of errors.
1702 grep { $_->unsuspend } $self->suspended_pkgs;
1707 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1709 Returns a list: an empty list on success or a list of errors.
1715 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1718 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1720 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1721 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
1722 of a list of pkgparts; the hashref has the following keys:
1726 =item pkgparts - listref of pkgparts
1728 =item (other options are passed to the suspend method)
1733 Returns a list: an empty list on success or a list of errors.
1737 sub suspend_if_pkgpart {
1739 my (@pkgparts, %opt);
1740 if (ref($_[0]) eq 'HASH'){
1741 @pkgparts = @{$_[0]{pkgparts}};
1746 grep { $_->suspend(%opt) }
1747 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1748 $self->unsuspended_pkgs;
1751 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1753 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1754 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
1755 instead of a list of pkgparts; the hashref has the following keys:
1759 =item pkgparts - listref of pkgparts
1761 =item (other options are passed to the suspend method)
1765 Returns a list: an empty list on success or a list of errors.
1769 sub suspend_unless_pkgpart {
1771 my (@pkgparts, %opt);
1772 if (ref($_[0]) eq 'HASH'){
1773 @pkgparts = @{$_[0]{pkgparts}};
1778 grep { $_->suspend(%opt) }
1779 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1780 $self->unsuspended_pkgs;
1783 =item cancel [ OPTION => VALUE ... ]
1785 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1787 Available options are:
1791 =item quiet - can be set true to supress email cancellation notices.
1793 =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.
1795 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
1799 Always returns a list: an empty list on success or a list of errors.
1804 my( $self, %opt ) = @_;
1806 warn "$me cancel called on customer ". $self->custnum. " with options ".
1807 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
1810 return ( 'access denied' )
1811 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
1813 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1815 #should try decryption (we might have the private key)
1816 # and if not maybe queue a job for the server that does?
1817 return ( "Can't (yet) ban encrypted credit cards" )
1818 if $self->is_encrypted($self->payinfo);
1820 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1821 my $error = $ban->insert;
1822 return ( $error ) if $error;
1826 my @pkgs = $self->ncancelled_pkgs;
1828 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
1829 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
1832 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
1835 sub _banned_pay_hashref {
1846 'payby' => $payby2ban{$self->payby},
1847 'payinfo' => md5_base64($self->payinfo),
1848 #don't ever *search* on reason! #'reason' =>
1854 Returns all notes (see L<FS::cust_main_note>) for this customer.
1861 qsearch( 'cust_main_note',
1862 { 'custnum' => $self->custnum },
1864 'ORDER BY _DATE DESC'
1870 Returns the agent (see L<FS::agent>) for this customer.
1876 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1879 =item bill_and_collect
1881 Cancels and suspends any packages due, generates bills, applies payments and
1884 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
1886 Options are passed as name-value pairs. Currently available options are:
1890 =item time - 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:
1894 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1896 =item invoice_time - 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.
1898 =item check_freq - "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1900 =item resetup - if set true, re-charges setup fees.
1906 sub bill_and_collect {
1907 my( $self, %options ) = @_;
1913 #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1914 foreach my $cust_pkg (
1915 grep { $_->expire && $_->expire <= $^T } $self->ncancelled_pkgs
1917 my $error = $cust_pkg->cancel;
1918 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
1919 " for custnum ". $self->custnum. ": $error"
1927 #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1928 foreach my $cust_pkg (
1929 grep { ( $_->part_pkg->is_prepaid && $_->bill && $_->bill < $^T
1930 || $_->adjourn && $_->adjourn <= $^T
1934 $self->ncancelled_pkgs
1936 my $error = $cust_pkg->suspend;
1937 warn "Error suspending package ". $cust_pkg->pkgnum.
1938 " for custnum ". $self->custnum. ": $error"
1946 my $error = $self->bill( %options );
1947 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
1949 $self->apply_payments_and_credits;
1951 $error = $self->collect( %options );
1952 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
1958 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
1959 conjunction with the collect method by calling B<bill_and_collect>.
1961 If there is an error, returns the error, otherwise returns false.
1963 Options are passed as name-value pairs. Currently available options are:
1967 =item resetup - if set true, re-charges setup fees.
1969 =item time - 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:
1973 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1975 =item pkg_list - An array ref of specific packages (objects) to attempt billing, instead trying all of them.
1977 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
1979 =item invoice_time - 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.
1986 my( $self, %options ) = @_;
1987 return '' if $self->payby eq 'COMP';
1988 warn "$me bill customer ". $self->custnum. "\n"
1991 my $time = $options{'time'} || time;
1996 local $SIG{HUP} = 'IGNORE';
1997 local $SIG{INT} = 'IGNORE';
1998 local $SIG{QUIT} = 'IGNORE';
1999 local $SIG{TERM} = 'IGNORE';
2000 local $SIG{TSTP} = 'IGNORE';
2001 local $SIG{PIPE} = 'IGNORE';
2003 my $oldAutoCommit = $FS::UID::AutoCommit;
2004 local $FS::UID::AutoCommit = 0;
2007 $self->select_for_update; #mutex
2009 #create a new invoice
2010 #(we'll remove it later if it doesn't actually need to be generated [contains
2011 # no line items] and we're inside a transaciton so nothing else will see it)
2012 my $cust_bill = new FS::cust_bill ( {
2013 'custnum' => $self->custnum,
2014 '_date' => ( $options{'invoice_time'} || $time ),
2015 #'charged' => $charged,
2018 $error = $cust_bill->insert;
2020 $dbh->rollback if $oldAutoCommit;
2021 return "can't create invoice for customer #". $self->custnum. ": $error";
2023 my $invnum = $cust_bill->invnum;
2026 # find the packages which are due for billing, find out how much they are
2027 # & generate invoice database.
2030 my( $total_setup, $total_recur ) = ( 0, 0 );
2032 my @precommit_hooks = ();
2034 foreach my $cust_pkg (
2035 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
2038 #NO!! next if $cust_pkg->cancel;
2039 next if $cust_pkg->getfield('cancel');
2041 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2043 #? to avoid use of uninitialized value errors... ?
2044 $cust_pkg->setfield('bill', '')
2045 unless defined($cust_pkg->bill);
2047 my $part_pkg = $cust_pkg->part_pkg;
2049 my %hash = $cust_pkg->hash;
2050 my $old_cust_pkg = new FS::cust_pkg \%hash;
2059 if ( ! $cust_pkg->setup &&
2061 ( $conf->exists('disable_setup_suspended_pkgs') &&
2062 ! $cust_pkg->getfield('susp')
2063 ) || ! $conf->exists('disable_setup_suspended_pkgs')
2065 || $options{'resetup'}
2068 warn " bill setup\n" if $DEBUG > 1;
2070 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2072 $dbh->rollback if $oldAutoCommit;
2073 return "$@ running calc_setup for $cust_pkg\n";
2076 $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
2080 # bill recurring fee
2085 if ( $part_pkg->getfield('freq') ne '0' &&
2086 ! $cust_pkg->getfield('susp') &&
2087 ( $cust_pkg->getfield('bill') || 0 ) <= $time
2090 # XXX should this be a package event? probably. events are called
2091 # at collection time at the moment, though...
2092 if ( $part_pkg->can('reset_usage') ) {
2093 warn " resetting usage counters" if $DEBUG > 1;
2094 $part_pkg->reset_usage($cust_pkg);
2097 warn " bill recur\n" if $DEBUG > 1;
2099 # XXX shared with $recur_prog
2100 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2102 #over two params! lets at least switch to a hashref for the rest...
2103 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
2105 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2107 $dbh->rollback if $oldAutoCommit;
2108 return "$@ running calc_recur for $cust_pkg\n";
2111 #change this bit to use Date::Manip? CAREFUL with timezones (see
2112 # mailing list archive)
2113 my ($sec,$min,$hour,$mday,$mon,$year) =
2114 (localtime($sdate) )[0,1,2,3,4,5];
2116 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2117 # only for figuring next bill date, nothing else, so, reset $sdate again
2119 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2120 $cust_pkg->last_bill($sdate)
2121 if $cust_pkg->dbdef_table->column('last_bill');
2123 if ( $part_pkg->freq =~ /^\d+$/ ) {
2124 $mon += $part_pkg->freq;
2125 until ( $mon < 12 ) { $mon -= 12; $year++; }
2126 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2128 $mday += $weeks * 7;
2129 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2132 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2136 $dbh->rollback if $oldAutoCommit;
2137 return "unparsable frequency: ". $part_pkg->freq;
2139 $cust_pkg->setfield('bill',
2140 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2143 warn "\$setup is undefined" unless defined($setup);
2144 warn "\$recur is undefined" unless defined($recur);
2145 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2148 # If $cust_pkg has been modified, update it and create cust_bill_pkg records
2151 if ( $cust_pkg->modified ) { # hmmm.. and if the options are modified?
2153 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2156 $error=$cust_pkg->replace($old_cust_pkg,
2157 options => { $cust_pkg->options },
2159 if ( $error ) { #just in case
2160 $dbh->rollback if $oldAutoCommit;
2161 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2164 $setup = sprintf( "%.2f", $setup );
2165 $recur = sprintf( "%.2f", $recur );
2166 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2167 $dbh->rollback if $oldAutoCommit;
2168 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2170 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2171 $dbh->rollback if $oldAutoCommit;
2172 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2175 if ( $setup != 0 || $recur != 0 ) {
2177 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2179 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2180 'invnum' => $invnum,
2181 'pkgnum' => $cust_pkg->pkgnum,
2185 'edate' => $cust_pkg->bill,
2186 'details' => \@details,
2188 $error = $cust_bill_pkg->insert;
2190 $dbh->rollback if $oldAutoCommit;
2191 return "can't create invoice line item for invoice #$invnum: $error";
2193 $total_setup += $setup;
2194 $total_recur += $recur;
2200 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2203 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2206 my %taxhash = map { $_ => $self->get("$prefix$_") }
2207 qw( state county country );
2209 $taxhash{'taxclass'} = $part_pkg->taxclass;
2211 my @taxes = qsearch( 'cust_main_county', \%taxhash );
2214 $taxhash{'taxclass'} = '';
2215 @taxes = qsearch( 'cust_main_county', \%taxhash );
2218 #one more try at a whole-country tax rate
2220 $taxhash{$_} = '' foreach qw( state county );
2221 @taxes = qsearch( 'cust_main_county', \%taxhash );
2224 # maybe eliminate this entirely, along with all the 0% records
2226 $dbh->rollback if $oldAutoCommit;
2228 "fatal: can't find tax rate for state/county/country/taxclass ".
2229 join('/', ( map $self->get("$prefix$_"),
2230 qw(state county country)
2232 $part_pkg->taxclass ). "\n";
2235 foreach my $tax ( @taxes ) {
2237 my $taxable_charged = 0;
2238 $taxable_charged += $setup
2239 unless $part_pkg->setuptax =~ /^Y$/i
2240 || $tax->setuptax =~ /^Y$/i;
2241 $taxable_charged += $recur
2242 unless $part_pkg->recurtax =~ /^Y$/i
2243 || $tax->recurtax =~ /^Y$/i;
2244 next unless $taxable_charged;
2246 if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2247 #my ($mon,$year) = (localtime($sdate) )[4,5];
2248 my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2250 my $freq = $part_pkg->freq || 1;
2251 if ( $freq !~ /(\d+)$/ ) {
2252 $dbh->rollback if $oldAutoCommit;
2253 return "daily/weekly package definitions not (yet?)".
2254 " compatible with monthly tax exemptions";
2256 my $taxable_per_month =
2257 sprintf("%.2f", $taxable_charged / $freq );
2259 #call the whole thing off if this customer has any old
2260 #exemption records...
2261 my @cust_tax_exempt =
2262 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2263 if ( @cust_tax_exempt ) {
2264 $dbh->rollback if $oldAutoCommit;
2266 'this customer still has old-style tax exemption records; '.
2267 'run bin/fs-migrate-cust_tax_exempt?';
2270 foreach my $which_month ( 1 .. $freq ) {
2272 #maintain the new exemption table now
2275 FROM cust_tax_exempt_pkg
2276 LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2277 LEFT JOIN cust_bill USING ( invnum )
2283 my $sth = dbh->prepare($sql) or do {
2284 $dbh->rollback if $oldAutoCommit;
2285 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2293 $dbh->rollback if $oldAutoCommit;
2294 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2296 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2298 my $remaining_exemption =
2299 $tax->exempt_amount - $existing_exemption;
2300 if ( $remaining_exemption > 0 ) {
2301 my $addl = $remaining_exemption > $taxable_per_month
2302 ? $taxable_per_month
2303 : $remaining_exemption;
2304 $taxable_charged -= $addl;
2306 my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2307 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2308 'taxnum' => $tax->taxnum,
2309 'year' => 1900+$year,
2311 'amount' => sprintf("%.2f", $addl ),
2313 $error = $cust_tax_exempt_pkg->insert;
2315 $dbh->rollback if $oldAutoCommit;
2316 return "fatal: can't insert cust_tax_exempt_pkg: $error";
2318 } # if $remaining_exemption > 0
2322 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2323 until ( $mon < 13 ) { $mon -= 12; $year++; }
2325 } #foreach $which_month
2327 } #if $tax->exempt_amount
2329 $taxable_charged = sprintf( "%.2f", $taxable_charged);
2331 #$tax += $taxable_charged * $cust_main_county->tax / 100
2332 $tax{ $tax->taxname || 'Tax' } +=
2333 $taxable_charged * $tax->tax / 100
2335 } #foreach my $tax ( @taxes )
2337 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2339 } #if $setup != 0 || $recur != 0
2341 } #if $cust_pkg->modified
2343 } #foreach my $cust_pkg
2345 unless ( $cust_bill->cust_bill_pkg ) {
2346 $cust_bill->delete; #don't create an invoice w/o line items
2348 # XXX this seems to be broken
2349 #( DBD::Pg::st execute failed: ERROR: syntax error at or near "hcb" )
2350 # # get rid of our fake history too, waste of unecessary space
2351 # my $h_cleanup_query = q{
2352 # DELETE FROM h_cust_bill hcb
2353 # WHERE hcb.invnum = ?
2354 # AND NOT EXISTS ( SELECT 1 FROM cust_bill cb where cb.invnum = hcb.invnum )
2356 # my $h_sth = $dbh->prepare($h_cleanup_query);
2357 # $h_sth->execute($invnum);
2359 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2363 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2365 foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2366 my $tax = sprintf("%.2f", $tax{$taxname} );
2367 $charged = sprintf( "%.2f", $charged+$tax );
2369 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2370 'invnum' => $invnum,
2376 'itemdesc' => $taxname,
2378 $error = $cust_bill_pkg->insert;
2380 $dbh->rollback if $oldAutoCommit;
2381 return "can't create invoice line item for invoice #$invnum: $error";
2383 $total_setup += $tax;
2387 $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2388 $error = $cust_bill->replace;
2390 $dbh->rollback if $oldAutoCommit;
2391 return "can't update charged for invoice #$invnum: $error";
2394 foreach my $hook ( @precommit_hooks ) {
2396 &{$hook}; #($self) ?
2399 $dbh->rollback if $oldAutoCommit;
2400 return "$@ running precommit hook $hook\n";
2404 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2408 =item collect OPTIONS
2410 (Attempt to) collect money for this customer's outstanding invoices (see
2411 L<FS::cust_bill>). Usually used after the bill method.
2413 Actions are now triggered by billing events; see L<FS::part_event> and the
2414 billing events web interface. Old-style invoice events (see
2415 L<FS::part_bill_event>) have been deprecated.
2417 If there is an error, returns the error, otherwise returns false.
2419 Options are passed as name-value pairs.
2421 Currently available options are:
2425 =item invoice_time - 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.
2427 =item retry - Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2429 =item quiet - set true to surpress email card/ACH decline notices.
2431 =item check_freq - "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2433 =item payby - allows for one time override of normal customer billing method
2438 my( $self, %options ) = @_;
2439 my $invoice_time = $options{'invoice_time'} || time;
2442 local $SIG{HUP} = 'IGNORE';
2443 local $SIG{INT} = 'IGNORE';
2444 local $SIG{QUIT} = 'IGNORE';
2445 local $SIG{TERM} = 'IGNORE';
2446 local $SIG{TSTP} = 'IGNORE';
2447 local $SIG{PIPE} = 'IGNORE';
2449 my $oldAutoCommit = $FS::UID::AutoCommit;
2450 local $FS::UID::AutoCommit = 0;
2453 $self->select_for_update; #mutex
2456 my $balance = $self->balance;
2457 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2460 if ( exists($options{'retry_card'}) ) {
2461 carp 'retry_card option passed to collect is deprecated; use retry';
2462 $options{'retry'} ||= $options{'retry_card'};
2464 if ( exists($options{'retry'}) && $options{'retry'} ) {
2465 my $error = $self->retry_realtime;
2467 $dbh->rollback if $oldAutoCommit;
2472 # false laziness w/pay_batch::import_results
2474 my $due_cust_event = $self->due_cust_event(
2475 'time' => $invoice_time,
2476 'check_freq' => $options{'check_freq'},
2478 unless( ref($due_cust_event) ) {
2479 $dbh->rollback if $oldAutoCommit;
2480 return $due_cust_event;
2483 foreach my $cust_event ( @$due_cust_event ) {
2487 #re-eval event conditions (a previous event could have changed things)
2488 next unless $cust_event->test_conditions( 'time' => $invoice_time );
2491 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2492 warn " running cust_event ". $cust_event->eventnum. "\n"
2496 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2497 if ( my $error = $cust_event->do_event() ) {
2498 #XXX wtf is this? figure out a proper dealio with return value
2500 # gah, even with transactions.
2501 $dbh->commit if $oldAutoCommit; #well.
2508 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2513 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2515 Inserts database records for and returns an ordered listref of new events due
2516 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2517 events are due, an empty listref is returned. If there is an error, returns a
2518 scalar error message.
2520 To actually run the events, call each event's test_condition method, and if
2521 still true, call the event's do_event method.
2523 Options are passed as a hashref or as a list of name-value pairs. Available
2528 =item check_freq - 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.
2530 =item time - "Current time" for the events.
2532 =item debug - Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), or 3 (more information)
2534 =item eventtable - Only return events for the specified eventtable (by default, events of all eventtables are returned)
2536 =item objects - Explicitly pass the objects to be tested (typically used with eventtable).
2542 sub due_cust_event {
2544 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2547 #my $DEBUG = $opt{'debug'}
2548 local($DEBUG) = $opt{'debug'}
2549 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2551 warn "$me due_cust_event called with options ".
2552 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2555 $opt{'time'} ||= time;
2557 local $SIG{HUP} = 'IGNORE';
2558 local $SIG{INT} = 'IGNORE';
2559 local $SIG{QUIT} = 'IGNORE';
2560 local $SIG{TERM} = 'IGNORE';
2561 local $SIG{TSTP} = 'IGNORE';
2562 local $SIG{PIPE} = 'IGNORE';
2564 my $oldAutoCommit = $FS::UID::AutoCommit;
2565 local $FS::UID::AutoCommit = 0;
2568 $self->select_for_update; #mutex
2571 # 1: find possible events (initial search)
2574 my @cust_event = ();
2576 my @eventtable = $opt{'eventtable'}
2577 ? ( $opt{'eventtable'} )
2578 : FS::part_event->eventtables_runorder;
2580 foreach my $eventtable ( @eventtable ) {
2583 if ( $opt{'objects'} ) {
2585 @objects = @{ $opt{'objects'} };
2589 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2590 @objects = ( $eventtable eq 'cust_main' )
2592 : ( $self->$eventtable() );
2596 my @e_cust_event = ();
2598 my $cross = "CROSS JOIN $eventtable";
2599 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2600 unless $eventtable eq 'cust_main';
2602 foreach my $object ( @objects ) {
2604 #this first search uses the condition_sql magic for optimization.
2605 #the more possible events we can eliminate in this step the better
2607 my $cross_where = '';
2608 my $pkey = $object->primary_key;
2609 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2611 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2613 FS::part_event_condition->where_conditions_sql( $eventtable,
2614 'time'=>$opt{'time'}
2616 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2618 $extra_sql = "AND $extra_sql" if $extra_sql;
2620 #here is the agent virtualization
2621 $extra_sql .= " AND ( part_event.agentnum IS NULL
2622 OR part_event.agentnum = ". $self->agentnum. ' )';
2624 $extra_sql .= " $order";
2626 my @part_event = qsearch( {
2627 'select' => 'part_event.*',
2628 'table' => 'part_event',
2629 'addl_from' => "$cross $join",
2630 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2631 'eventtable' => $eventtable,
2634 'extra_sql' => "AND $cross_where $extra_sql",
2638 my $pkey = $object->primary_key;
2639 warn " ". scalar(@part_event).
2640 " possible events found for $eventtable ". $object->$pkey(). "\n";
2643 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2647 warn " ". scalar(@e_cust_event).
2648 " subtotal possible cust events found for $eventtable"
2651 push @cust_event, @e_cust_event;
2655 warn " ". scalar(@cust_event).
2656 " total possible cust events found in initial search\n"
2660 # 2: test conditions
2665 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
2666 'stats_hashref' => \%unsat ),
2669 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2672 warn " invalid conditions not eliminated with condition_sql:\n".
2673 join('', map " $_: ".$unsat{$_}."\n", keys %unsat );
2679 foreach my $cust_event ( @cust_event ) {
2681 my $error = $cust_event->insert();
2683 $dbh->rollback if $oldAutoCommit;
2689 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2695 warn " returning events: ". Dumper(@cust_event). "\n"
2702 =item retry_realtime
2704 Schedules realtime / batch credit card / electronic check / LEC billing
2705 events for for retry. Useful if card information has changed or manual
2706 retry is desired. The 'collect' method must be called to actually retry
2709 Implementation details: For either this customer, or for each of this
2710 customer's open invoices, changes the status of the first "done" (with
2711 statustext error) realtime processing event to "failed".
2715 sub retry_realtime {
2718 local $SIG{HUP} = 'IGNORE';
2719 local $SIG{INT} = 'IGNORE';
2720 local $SIG{QUIT} = 'IGNORE';
2721 local $SIG{TERM} = 'IGNORE';
2722 local $SIG{TSTP} = 'IGNORE';
2723 local $SIG{PIPE} = 'IGNORE';
2725 my $oldAutoCommit = $FS::UID::AutoCommit;
2726 local $FS::UID::AutoCommit = 0;
2729 #a little false laziness w/due_cust_event (not too bad, really)
2731 my $join = FS::part_event_condition->join_conditions_sql;
2732 my $order = FS::part_event_condition->order_conditions_sql;
2734 #here is the agent virtualization
2735 my $agent_virt = " ( part_event.agentnum IS NULL
2736 OR part_event.agentnum = ". $self->agentnum. ' )';
2738 #XXX this shouldn't be hardcoded, actions should declare it...
2739 my @realtime_events = qw(
2740 cust_bill_realtime_card
2741 cust_bill_realtime_check
2742 cust_bill_realtime_lec
2746 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
2751 my @cust_event = qsearchs({
2752 'table' => 'cust_event',
2753 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
2754 'hashref' => { 'status' => 'done' },
2755 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
2756 " AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
2759 my %seen_invnum = ();
2760 foreach my $cust_event (@cust_event) {
2762 #max one for the customer, one for each open invoice
2763 my $cust_X = $cust_event->cust_X;
2764 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
2768 or $cust_event->part_event->eventtable eq 'cust_bill'
2771 my $error = $cust_event->retry;
2773 $dbh->rollback if $oldAutoCommit;
2774 return "error scheduling event for retry: $error";
2779 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2784 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2786 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2787 via a Business::OnlinePayment realtime gateway. See
2788 L<http://420.am/business-onlinepayment> for supported gateways.
2790 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2792 Available options are: I<description>, I<invnum>, I<quiet>
2794 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2795 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2796 if set, will override the value from the customer record.
2798 I<description> is a free-text field passed to the gateway. It defaults to
2799 "Internet services".
2801 If an I<invnum> is specified, this payment (if successful) is applied to the
2802 specified invoice. If you don't specify an I<invnum> you might want to
2803 call the B<apply_payments> method.
2805 I<quiet> can be set true to surpress email decline notices.
2807 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2812 my( $self, $method, $amount, %options ) = @_;
2814 warn "$me realtime_bop: $method $amount\n";
2815 warn " $_ => $options{$_}\n" foreach keys %options;
2818 $options{'description'} ||= 'Internet services';
2820 eval "use Business::OnlinePayment";
2823 my $payinfo = exists($options{'payinfo'})
2824 ? $options{'payinfo'}
2827 my %method2payby = (
2834 # check for banned credit card/ACH
2837 my $ban = qsearchs('banned_pay', {
2838 'payby' => $method2payby{$method},
2839 'payinfo' => md5_base64($payinfo),
2841 return "Banned credit card" if $ban;
2848 if ( $options{'invnum'} ) {
2849 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2850 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2852 map { $_->part_pkg->taxclass }
2854 map { $_->cust_pkg }
2855 $cust_bill->cust_bill_pkg;
2856 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2857 #different taxclasses
2858 $taxclass = $taxclasses[0];
2862 #look for an agent gateway override first
2864 if ( $method eq 'CC' ) {
2865 $cardtype = cardtype($payinfo);
2866 } elsif ( $method eq 'ECHECK' ) {
2869 $cardtype = $method;
2873 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2874 cardtype => $cardtype,
2875 taxclass => $taxclass, } )
2876 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2878 taxclass => $taxclass, } )
2879 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2880 cardtype => $cardtype,
2882 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2884 taxclass => '', } );
2886 my $payment_gateway = '';
2887 my( $processor, $login, $password, $action, @bop_options );
2888 if ( $override ) { #use a payment gateway override
2890 $payment_gateway = $override->payment_gateway;
2892 $processor = $payment_gateway->gateway_module;
2893 $login = $payment_gateway->gateway_username;
2894 $password = $payment_gateway->gateway_password;
2895 $action = $payment_gateway->gateway_action;
2896 @bop_options = $payment_gateway->options;
2898 } else { #use the standard settings from the config
2900 ( $processor, $login, $password, $action, @bop_options ) =
2901 $self->default_payment_gateway($method);
2909 my $address = exists($options{'address1'})
2910 ? $options{'address1'}
2912 my $address2 = exists($options{'address2'})
2913 ? $options{'address2'}
2915 $address .= ", ". $address2 if length($address2);
2917 my $o_payname = exists($options{'payname'})
2918 ? $options{'payname'}
2920 my($payname, $payfirst, $paylast);
2921 if ( $o_payname && $method ne 'ECHECK' ) {
2922 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2923 or return "Illegal payname $payname";
2924 ($payfirst, $paylast) = ($1, $2);
2926 $payfirst = $self->getfield('first');
2927 $paylast = $self->getfield('last');
2928 $payname = "$payfirst $paylast";
2931 my @invoicing_list = $self->invoicing_list_emailonly;
2932 if ( $conf->exists('emailinvoiceautoalways')
2933 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
2934 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2935 push @invoicing_list, $self->all_emails;
2938 my $email = ($conf->exists('business-onlinepayment-email-override'))
2939 ? $conf->config('business-onlinepayment-email-override')
2940 : $invoicing_list[0];
2944 my $payip = exists($options{'payip'})
2947 $content{customer_ip} = $payip
2950 $content{invoice_number} = $options{'invnum'}
2951 if exists($options{'invnum'}) && length($options{'invnum'});
2954 if ( $method eq 'CC' ) {
2956 $content{card_number} = $payinfo;
2957 $paydate = exists($options{'paydate'})
2958 ? $options{'paydate'}
2960 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2961 $content{expiration} = "$2/$1";
2963 my $paycvv = exists($options{'paycvv'})
2964 ? $options{'paycvv'}
2966 $content{cvv2} = $self->paycvv
2969 my $paystart_month = exists($options{'paystart_month'})
2970 ? $options{'paystart_month'}
2971 : $self->paystart_month;
2973 my $paystart_year = exists($options{'paystart_year'})
2974 ? $options{'paystart_year'}
2975 : $self->paystart_year;
2977 $content{card_start} = "$paystart_month/$paystart_year"
2978 if $paystart_month && $paystart_year;
2980 my $payissue = exists($options{'payissue'})
2981 ? $options{'payissue'}
2983 $content{issue_number} = $payissue if $payissue;
2985 $content{recurring_billing} = 'YES'
2986 if qsearch('cust_pay', { 'custnum' => $self->custnum,
2988 'payinfo' => $payinfo,
2990 || qsearch('cust_pay', { 'custnum' => $self->custnum,
2992 'paymask' => $self->mask_payinfo('CARD', $payinfo),
2996 } elsif ( $method eq 'ECHECK' ) {
2997 ( $content{account_number}, $content{routing_code} ) =
2998 split('@', $payinfo);
2999 $content{bank_name} = $o_payname;
3000 $content{bank_state} = exists($options{'paystate'})
3001 ? $options{'paystate'}
3002 : $self->getfield('paystate');
3003 $content{account_type} = exists($options{'paytype'})
3004 ? uc($options{'paytype'}) || 'CHECKING'
3005 : uc($self->getfield('paytype')) || 'CHECKING';
3006 $content{account_name} = $payname;
3007 $content{customer_org} = $self->company ? 'B' : 'I';
3008 $content{state_id} = exists($options{'stateid'})
3009 ? $options{'stateid'}
3010 : $self->getfield('stateid');
3011 $content{state_id_state} = exists($options{'stateid_state'})
3012 ? $options{'stateid_state'}
3013 : $self->getfield('stateid_state');
3014 $content{customer_ssn} = exists($options{'ss'})
3017 } elsif ( $method eq 'LEC' ) {
3018 $content{phone} = $payinfo;
3022 # run transaction(s)
3025 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3027 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3028 $transaction->content(
3031 'password' => $password,
3032 'action' => $action1,
3033 'description' => $options{'description'},
3034 'amount' => $amount,
3035 #'invoice_number' => $options{'invnum'},
3036 'customer_id' => $self->custnum,
3037 'last_name' => $paylast,
3038 'first_name' => $payfirst,
3040 'address' => $address,
3041 'city' => ( exists($options{'city'})
3044 'state' => ( exists($options{'state'})
3047 'zip' => ( exists($options{'zip'})
3050 'country' => ( exists($options{'country'})
3051 ? $options{'country'}
3053 'referer' => 'http://cleanwhisker.420.am/',
3055 'phone' => $self->daytime || $self->night,
3058 $transaction->submit();
3060 if ( $transaction->is_success() && $action2 ) {
3061 my $auth = $transaction->authorization;
3062 my $ordernum = $transaction->can('order_number')
3063 ? $transaction->order_number
3067 new Business::OnlinePayment( $processor, @bop_options );
3074 password => $password,
3075 order_number => $ordernum,
3077 authorization => $auth,
3078 description => $options{'description'},
3081 foreach my $field (qw( authorization_source_code returned_ACI
3082 transaction_identifier validation_code
3083 transaction_sequence_num local_transaction_date
3084 local_transaction_time AVS_result_code )) {
3085 $capture{$field} = $transaction->$field() if $transaction->can($field);
3088 $capture->content( %capture );
3092 unless ( $capture->is_success ) {
3093 my $e = "Authorization successful but capture failed, custnum #".
3094 $self->custnum. ': '. $capture->result_code.
3095 ": ". $capture->error_message;
3103 # remove paycvv after initial transaction
3106 #false laziness w/misc/process/payment.cgi - check both to make sure working
3108 if ( defined $self->dbdef_table->column('paycvv')
3109 && length($self->paycvv)
3110 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3112 my $error = $self->remove_cvv;
3114 warn "WARNING: error removing cvv: $error\n";
3122 if ( $transaction->is_success() ) {
3124 my %method2payby = (
3131 if ( $payment_gateway ) { # agent override
3132 $paybatch = $payment_gateway->gatewaynum. '-';
3135 $paybatch .= "$processor:". $transaction->authorization;
3137 $paybatch .= ':'. $transaction->order_number
3138 if $transaction->can('order_number')
3139 && length($transaction->order_number);
3141 my $cust_pay = new FS::cust_pay ( {
3142 'custnum' => $self->custnum,
3143 'invnum' => $options{'invnum'},
3146 'payby' => $method2payby{$method},
3147 'payinfo' => $payinfo,
3148 'paybatch' => $paybatch,
3149 'paydate' => $paydate,
3151 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3153 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3156 $cust_pay->invnum(''); #try again with no specific invnum
3157 my $error2 = $cust_pay->insert( $options{'manual'} ?
3158 ( 'manual' => 1 ) : ()
3161 # gah, even with transactions.
3162 my $e = 'WARNING: Card/ACH debited but database not updated - '.
3163 "error inserting payment ($processor): $error2".
3164 " (previously tried insert with invnum #$options{'invnum'}" .
3170 return ''; #no error
3174 my $perror = "$processor error: ". $transaction->error_message;
3176 unless ( $transaction->error_message ) {
3179 if ( $transaction->can('response_page') ) {
3181 'page' => ( $transaction->can('response_page')
3182 ? $transaction->response_page
3185 'code' => ( $transaction->can('response_code')
3186 ? $transaction->response_code
3189 'headers' => ( $transaction->can('response_headers')
3190 ? $transaction->response_headers
3196 "No additional debugging information available for $processor";
3199 $perror .= "No error_message returned from $processor -- ".
3200 ( ref($t_response) ? Dumper($t_response) : $t_response );
3204 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3205 && $conf->exists('emaildecline')
3206 && grep { $_ ne 'POST' } $self->invoicing_list
3207 && ! grep { $transaction->error_message =~ /$_/ }
3208 $conf->config('emaildecline-exclude')
3210 my @templ = $conf->config('declinetemplate');
3211 my $template = new Text::Template (
3213 SOURCE => [ map "$_\n", @templ ],
3214 ) or return "($perror) can't create template: $Text::Template::ERROR";
3215 $template->compile()
3216 or return "($perror) can't compile template: $Text::Template::ERROR";
3218 my $templ_hash = { error => $transaction->error_message };
3220 my $error = send_email(
3221 'from' => $conf->config('invoice_from'),
3222 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3223 'subject' => 'Your payment could not be processed',
3224 'body' => [ $template->fill_in(HASH => $templ_hash) ],
3227 $perror .= " (also received error sending decline notification: $error)"
3237 =item default_payment_gateway
3241 sub default_payment_gateway {
3242 my( $self, $method ) = @_;
3244 die "Real-time processing not enabled\n"
3245 unless $conf->exists('business-onlinepayment');
3248 my $bop_config = 'business-onlinepayment';
3249 $bop_config .= '-ach'
3250 if $method eq 'ECHECK' && $conf->exists($bop_config. '-ach');
3251 my ( $processor, $login, $password, $action, @bop_options ) =
3252 $conf->config($bop_config);
3253 $action ||= 'normal authorization';
3254 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3255 die "No real-time processor is enabled - ".
3256 "did you set the business-onlinepayment configuration value?\n"
3259 ( $processor, $login, $password, $action, @bop_options )
3264 Removes the I<paycvv> field from the database directly.
3266 If there is an error, returns the error, otherwise returns false.
3272 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3273 or return dbh->errstr;
3274 $sth->execute($self->custnum)
3275 or return $sth->errstr;
3280 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3282 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3283 via a Business::OnlinePayment realtime gateway. See
3284 L<http://420.am/business-onlinepayment> for supported gateways.
3286 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3288 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3290 Most gateways require a reference to an original payment transaction to refund,
3291 so you probably need to specify a I<paynum>.
3293 I<amount> defaults to the original amount of the payment if not specified.
3295 I<reason> specifies a reason for the refund.
3297 I<paydate> specifies the expiration date for a credit card overriding the
3298 value from the customer record or the payment record. Specified as yyyy-mm-dd
3300 Implementation note: If I<amount> is unspecified or equal to the amount of the
3301 orignal payment, first an attempt is made to "void" the transaction via
3302 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3303 the normal attempt is made to "refund" ("credit") the transaction via the
3304 gateway is attempted.
3306 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3307 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3308 #if set, will override the value from the customer record.
3310 #If an I<invnum> is specified, this payment (if successful) is applied to the
3311 #specified invoice. If you don't specify an I<invnum> you might want to
3312 #call the B<apply_payments> method.
3316 #some false laziness w/realtime_bop, not enough to make it worth merging
3317 #but some useful small subs should be pulled out
3318 sub realtime_refund_bop {
3319 my( $self, $method, %options ) = @_;
3321 warn "$me realtime_refund_bop: $method refund\n";
3322 warn " $_ => $options{$_}\n" foreach keys %options;
3325 eval "use Business::OnlinePayment";
3329 # look up the original payment and optionally a gateway for that payment
3333 my $amount = $options{'amount'};
3335 my( $processor, $login, $password, @bop_options ) ;
3336 my( $auth, $order_number ) = ( '', '', '' );
3338 if ( $options{'paynum'} ) {
3340 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
3341 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3342 or return "Unknown paynum $options{'paynum'}";
3343 $amount ||= $cust_pay->paid;
3345 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3346 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3347 $cust_pay->paybatch;
3348 my $gatewaynum = '';
3349 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3351 if ( $gatewaynum ) { #gateway for the payment to be refunded
3353 my $payment_gateway =
3354 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3355 die "payment gateway $gatewaynum not found"
3356 unless $payment_gateway;
3358 $processor = $payment_gateway->gateway_module;
3359 $login = $payment_gateway->gateway_username;
3360 $password = $payment_gateway->gateway_password;
3361 @bop_options = $payment_gateway->options;
3363 } else { #try the default gateway
3365 my( $conf_processor, $unused_action );
3366 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3367 $self->default_payment_gateway($method);
3369 return "processor of payment $options{'paynum'} $processor does not".
3370 " match default processor $conf_processor"
3371 unless $processor eq $conf_processor;
3376 } else { # didn't specify a paynum, so look for agent gateway overrides
3377 # like a normal transaction
3380 if ( $method eq 'CC' ) {
3381 $cardtype = cardtype($self->payinfo);
3382 } elsif ( $method eq 'ECHECK' ) {
3385 $cardtype = $method;
3388 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3389 cardtype => $cardtype,
3391 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3393 taxclass => '', } );
3395 if ( $override ) { #use a payment gateway override
3397 my $payment_gateway = $override->payment_gateway;
3399 $processor = $payment_gateway->gateway_module;
3400 $login = $payment_gateway->gateway_username;
3401 $password = $payment_gateway->gateway_password;
3402 #$action = $payment_gateway->gateway_action;
3403 @bop_options = $payment_gateway->options;
3405 } else { #use the standard settings from the config
3408 ( $processor, $login, $password, $unused_action, @bop_options ) =
3409 $self->default_payment_gateway($method);
3414 return "neither amount nor paynum specified" unless $amount;
3419 'password' => $password,
3420 'order_number' => $order_number,
3421 'amount' => $amount,
3422 'referer' => 'http://cleanwhisker.420.am/',
3424 $content{authorization} = $auth
3425 if length($auth); #echeck/ACH transactions have an order # but no auth
3426 #(at least with authorize.net)
3428 my $disable_void_after;
3429 if ($conf->exists('disable_void_after')
3430 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3431 $disable_void_after = $1;
3434 #first try void if applicable
3435 if ( $cust_pay && $cust_pay->paid == $amount
3437 ( not defined($disable_void_after) )
3438 || ( time < ($cust_pay->_date + $disable_void_after ) )
3441 warn " attempting void\n" if $DEBUG > 1;
3442 my $void = new Business::OnlinePayment( $processor, @bop_options );
3443 $void->content( 'action' => 'void', %content );
3445 if ( $void->is_success ) {
3446 my $error = $cust_pay->void($options{'reason'});
3448 # gah, even with transactions.
3449 my $e = 'WARNING: Card/ACH voided but database not updated - '.
3450 "error voiding payment: $error";
3454 warn " void successful\n" if $DEBUG > 1;
3459 warn " void unsuccessful, trying refund\n"
3463 my $address = $self->address1;
3464 $address .= ", ". $self->address2 if $self->address2;
3466 my($payname, $payfirst, $paylast);
3467 if ( $self->payname && $method ne 'ECHECK' ) {
3468 $payname = $self->payname;
3469 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3470 or return "Illegal payname $payname";
3471 ($payfirst, $paylast) = ($1, $2);
3473 $payfirst = $self->getfield('first');
3474 $paylast = $self->getfield('last');
3475 $payname = "$payfirst $paylast";
3478 my @invoicing_list = $self->invoicing_list_emailonly;
3479 if ( $conf->exists('emailinvoiceautoalways')
3480 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3481 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3482 push @invoicing_list, $self->all_emails;
3485 my $email = ($conf->exists('business-onlinepayment-email-override'))
3486 ? $conf->config('business-onlinepayment-email-override')
3487 : $invoicing_list[0];
3489 my $payip = exists($options{'payip'})
3492 $content{customer_ip} = $payip
3496 if ( $method eq 'CC' ) {
3499 $content{card_number} = $payinfo = $cust_pay->payinfo;
3500 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3501 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3502 ($content{expiration} = "$2/$1"); # where available
3504 $content{card_number} = $payinfo = $self->payinfo;
3505 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3506 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3507 $content{expiration} = "$2/$1";
3510 } elsif ( $method eq 'ECHECK' ) {
3513 $payinfo = $cust_pay->payinfo;
3515 $payinfo = $self->payinfo;
3517 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3518 $content{bank_name} = $self->payname;
3519 $content{account_type} = 'CHECKING';
3520 $content{account_name} = $payname;
3521 $content{customer_org} = $self->company ? 'B' : 'I';
3522 $content{customer_ssn} = $self->ss;
3523 } elsif ( $method eq 'LEC' ) {
3524 $content{phone} = $payinfo = $self->payinfo;
3528 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3529 my %sub_content = $refund->content(
3530 'action' => 'credit',
3531 'customer_id' => $self->custnum,
3532 'last_name' => $paylast,
3533 'first_name' => $payfirst,
3535 'address' => $address,
3536 'city' => $self->city,
3537 'state' => $self->state,
3538 'zip' => $self->zip,
3539 'country' => $self->country,
3541 'phone' => $self->daytime || $self->night,
3544 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3548 return "$processor error: ". $refund->error_message
3549 unless $refund->is_success();
3551 my %method2payby = (
3557 my $paybatch = "$processor:". $refund->authorization;
3558 $paybatch .= ':'. $refund->order_number
3559 if $refund->can('order_number') && $refund->order_number;
3561 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3562 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3563 last unless @cust_bill_pay;
3564 my $cust_bill_pay = pop @cust_bill_pay;
3565 my $error = $cust_bill_pay->delete;
3569 my $cust_refund = new FS::cust_refund ( {
3570 'custnum' => $self->custnum,
3571 'paynum' => $options{'paynum'},
3572 'refund' => $amount,
3574 'payby' => $method2payby{$method},
3575 'payinfo' => $payinfo,
3576 'paybatch' => $paybatch,
3577 'reason' => $options{'reason'} || 'card or ACH refund',
3579 my $error = $cust_refund->insert;
3581 $cust_refund->paynum(''); #try again with no specific paynum
3582 my $error2 = $cust_refund->insert;
3584 # gah, even with transactions.
3585 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3586 "error inserting refund ($processor): $error2".
3587 " (previously tried insert with paynum #$options{'paynum'}" .
3598 =item batch_card OPTION => VALUE...
3600 Adds a payment for this invoice to the pending credit card batch (see
3601 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3602 runs the payment using a realtime gateway.
3607 my ($self, %options) = @_;
3610 if (exists($options{amount})) {
3611 $amount = $options{amount};
3613 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3615 return '' unless $amount > 0;
3617 my $invnum = delete $options{invnum};
3618 my $payby = $options{invnum} || $self->payby; #dubious
3620 if ($options{'realtime'}) {
3621 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3627 my $oldAutoCommit = $FS::UID::AutoCommit;
3628 local $FS::UID::AutoCommit = 0;
3631 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3632 or return "Cannot lock pay_batch: " . $dbh->errstr;
3636 'payby' => FS::payby->payby2payment($payby),
3639 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3641 unless ( $pay_batch ) {
3642 $pay_batch = new FS::pay_batch \%pay_batch;
3643 my $error = $pay_batch->insert;
3645 $dbh->rollback if $oldAutoCommit;
3646 die "error creating new batch: $error\n";
3650 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3651 'batchnum' => $pay_batch->batchnum,
3652 'custnum' => $self->custnum,
3655 foreach (qw( address1 address2 city state zip country payby payinfo paydate
3657 $options{$_} = '' unless exists($options{$_});
3660 my $cust_pay_batch = new FS::cust_pay_batch ( {
3661 'batchnum' => $pay_batch->batchnum,
3662 'invnum' => $invnum || 0, # is there a better value?
3663 # this field should be
3665 # cust_bill_pay_batch now
3666 'custnum' => $self->custnum,
3667 'last' => $self->getfield('last'),
3668 'first' => $self->getfield('first'),
3669 'address1' => $options{address1} || $self->address1,
3670 'address2' => $options{address2} || $self->address2,
3671 'city' => $options{city} || $self->city,
3672 'state' => $options{state} || $self->state,
3673 'zip' => $options{zip} || $self->zip,
3674 'country' => $options{country} || $self->country,
3675 'payby' => $options{payby} || $self->payby,
3676 'payinfo' => $options{payinfo} || $self->payinfo,
3677 'exp' => $options{paydate} || $self->paydate,
3678 'payname' => $options{payname} || $self->payname,
3679 'amount' => $amount, # consolidating
3682 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
3683 if $old_cust_pay_batch;
3686 if ($old_cust_pay_batch) {
3687 $error = $cust_pay_batch->replace($old_cust_pay_batch)
3689 $error = $cust_pay_batch->insert;
3693 $dbh->rollback if $oldAutoCommit;
3697 my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
3698 foreach my $cust_bill ($self->open_cust_bill) {
3699 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
3700 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
3701 'invnum' => $cust_bill->invnum,
3702 'paybatchnum' => $cust_pay_batch->paybatchnum,
3703 'amount' => $cust_bill->owed,
3706 if ($unapplied >= $cust_bill_pay_batch->amount){
3707 $unapplied -= $cust_bill_pay_batch->amount;
3710 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
3711 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
3713 $error = $cust_bill_pay_batch->insert;
3715 $dbh->rollback if $oldAutoCommit;
3720 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3726 Returns the total owed for this customer on all invoices
3727 (see L<FS::cust_bill/owed>).
3733 $self->total_owed_date(2145859200); #12/31/2037
3736 =item total_owed_date TIME
3738 Returns the total owed for this customer on all invoices with date earlier than
3739 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
3740 see L<Time::Local> and L<Date::Parse> for conversion functions.
3744 sub total_owed_date {
3748 foreach my $cust_bill (
3749 grep { $_->_date <= $time }
3750 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3752 $total_bill += $cust_bill->owed;
3754 sprintf( "%.2f", $total_bill );
3757 =item apply_payments_and_credits
3759 Applies unapplied payments and credits.
3761 In most cases, this new method should be used in place of sequential
3762 apply_payments and apply_credits methods.
3764 If there is an error, returns the error, otherwise returns false.
3768 sub apply_payments_and_credits {
3771 local $SIG{HUP} = 'IGNORE';
3772 local $SIG{INT} = 'IGNORE';
3773 local $SIG{QUIT} = 'IGNORE';
3774 local $SIG{TERM} = 'IGNORE';
3775 local $SIG{TSTP} = 'IGNORE';
3776 local $SIG{PIPE} = 'IGNORE';
3778 my $oldAutoCommit = $FS::UID::AutoCommit;
3779 local $FS::UID::AutoCommit = 0;
3782 $self->select_for_update; #mutex
3784 foreach my $cust_bill ( $self->open_cust_bill ) {
3785 my $error = $cust_bill->apply_payments_and_credits;
3787 $dbh->rollback if $oldAutoCommit;
3788 return "Error applying: $error";
3792 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3797 =item apply_credits OPTION => VALUE ...
3799 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3800 to outstanding invoice balances in chronological order (or reverse
3801 chronological order if the I<order> option is set to B<newest>) and returns the
3802 value of any remaining unapplied credits available for refund (see
3803 L<FS::cust_refund>).
3805 Dies if there is an error.
3813 local $SIG{HUP} = 'IGNORE';
3814 local $SIG{INT} = 'IGNORE';
3815 local $SIG{QUIT} = 'IGNORE';
3816 local $SIG{TERM} = 'IGNORE';
3817 local $SIG{TSTP} = 'IGNORE';
3818 local $SIG{PIPE} = 'IGNORE';
3820 my $oldAutoCommit = $FS::UID::AutoCommit;
3821 local $FS::UID::AutoCommit = 0;
3824 $self->select_for_update; #mutex
3826 unless ( $self->total_credited ) {
3827 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3831 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3832 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3834 my @invoices = $self->open_cust_bill;
3835 @invoices = sort { $b->_date <=> $a->_date } @invoices
3836 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3839 foreach my $cust_bill ( @invoices ) {
3842 if ( !defined($credit) || $credit->credited == 0) {
3843 $credit = pop @credits or last;
3846 if ($cust_bill->owed >= $credit->credited) {
3847 $amount=$credit->credited;
3849 $amount=$cust_bill->owed;
3852 my $cust_credit_bill = new FS::cust_credit_bill ( {
3853 'crednum' => $credit->crednum,
3854 'invnum' => $cust_bill->invnum,
3855 'amount' => $amount,
3857 my $error = $cust_credit_bill->insert;
3859 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3863 redo if ($cust_bill->owed > 0);
3867 my $total_credited = $self->total_credited;
3869 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3871 return $total_credited;
3874 =item apply_payments
3876 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3877 to outstanding invoice balances in chronological order.
3879 #and returns the value of any remaining unapplied payments.
3881 Dies if there is an error.
3885 sub apply_payments {
3888 local $SIG{HUP} = 'IGNORE';
3889 local $SIG{INT} = 'IGNORE';
3890 local $SIG{QUIT} = 'IGNORE';
3891 local $SIG{TERM} = 'IGNORE';
3892 local $SIG{TSTP} = 'IGNORE';
3893 local $SIG{PIPE} = 'IGNORE';
3895 my $oldAutoCommit = $FS::UID::AutoCommit;
3896 local $FS::UID::AutoCommit = 0;
3899 $self->select_for_update; #mutex
3903 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3904 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3906 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3907 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3911 foreach my $cust_bill ( @invoices ) {
3914 if ( !defined($payment) || $payment->unapplied == 0 ) {
3915 $payment = pop @payments or last;
3918 if ( $cust_bill->owed >= $payment->unapplied ) {
3919 $amount = $payment->unapplied;
3921 $amount = $cust_bill->owed;
3924 my $cust_bill_pay = new FS::cust_bill_pay ( {
3925 'paynum' => $payment->paynum,
3926 'invnum' => $cust_bill->invnum,
3927 'amount' => $amount,
3929 my $error = $cust_bill_pay->insert;
3931 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3935 redo if ( $cust_bill->owed > 0);
3939 my $total_unapplied_payments = $self->total_unapplied_payments;
3941 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3943 return $total_unapplied_payments;
3946 =item total_credited
3948 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3949 customer. See L<FS::cust_credit/credited>.
3953 sub total_credited {
3955 my $total_credit = 0;
3956 foreach my $cust_credit ( qsearch('cust_credit', {
3957 'custnum' => $self->custnum,
3959 $total_credit += $cust_credit->credited;
3961 sprintf( "%.2f", $total_credit );
3964 =item total_unapplied_payments
3966 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3967 See L<FS::cust_pay/unapplied>.
3971 sub total_unapplied_payments {
3973 my $total_unapplied = 0;
3974 foreach my $cust_pay ( qsearch('cust_pay', {
3975 'custnum' => $self->custnum,
3977 $total_unapplied += $cust_pay->unapplied;
3979 sprintf( "%.2f", $total_unapplied );
3982 =item total_unapplied_refunds
3984 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
3985 customer. See L<FS::cust_refund/unapplied>.
3989 sub total_unapplied_refunds {
3991 my $total_unapplied = 0;
3992 foreach my $cust_refund ( qsearch('cust_refund', {
3993 'custnum' => $self->custnum,
3995 $total_unapplied += $cust_refund->unapplied;
3997 sprintf( "%.2f", $total_unapplied );
4002 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4003 total_credited minus total_unapplied_payments).
4011 + $self->total_unapplied_refunds
4012 - $self->total_credited
4013 - $self->total_unapplied_payments
4017 =item balance_date TIME
4019 Returns the balance for this customer, only considering invoices with date
4020 earlier than TIME (total_owed_date minus total_credited minus
4021 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
4022 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
4031 $self->total_owed_date($time)
4032 + $self->total_unapplied_refunds
4033 - $self->total_credited
4034 - $self->total_unapplied_payments
4038 =item in_transit_payments
4040 Returns the total of requests for payments for this customer pending in
4041 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
4045 sub in_transit_payments {
4047 my $in_transit_payments = 0;
4048 foreach my $pay_batch ( qsearch('pay_batch', {
4051 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4052 'batchnum' => $pay_batch->batchnum,
4053 'custnum' => $self->custnum,
4055 $in_transit_payments += $cust_pay_batch->amount;
4058 sprintf( "%.2f", $in_transit_payments );
4061 =item paydate_monthyear
4063 Returns a two-element list consisting of the month and year of this customer's
4064 paydate (credit card expiration date for CARD customers)
4068 sub paydate_monthyear {
4070 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4072 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4079 =item invoicing_list [ ARRAYREF ]
4081 If an arguement is given, sets these email addresses as invoice recipients
4082 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
4083 (except as warnings), so use check_invoicing_list first.
4085 Returns a list of email addresses (with svcnum entries expanded).
4087 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
4088 check it without disturbing anything by passing nothing.
4090 This interface may change in the future.
4094 sub invoicing_list {
4095 my( $self, $arrayref ) = @_;
4098 my @cust_main_invoice;
4099 if ( $self->custnum ) {
4100 @cust_main_invoice =
4101 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4103 @cust_main_invoice = ();
4105 foreach my $cust_main_invoice ( @cust_main_invoice ) {
4106 #warn $cust_main_invoice->destnum;
4107 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4108 #warn $cust_main_invoice->destnum;
4109 my $error = $cust_main_invoice->delete;
4110 warn $error if $error;
4113 if ( $self->custnum ) {
4114 @cust_main_invoice =
4115 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4117 @cust_main_invoice = ();
4119 my %seen = map { $_->address => 1 } @cust_main_invoice;
4120 foreach my $address ( @{$arrayref} ) {
4121 next if exists $seen{$address} && $seen{$address};
4122 $seen{$address} = 1;
4123 my $cust_main_invoice = new FS::cust_main_invoice ( {
4124 'custnum' => $self->custnum,
4127 my $error = $cust_main_invoice->insert;
4128 warn $error if $error;
4132 if ( $self->custnum ) {
4134 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4141 =item check_invoicing_list ARRAYREF
4143 Checks these arguements as valid input for the invoicing_list method. If there
4144 is an error, returns the error, otherwise returns false.
4148 sub check_invoicing_list {
4149 my( $self, $arrayref ) = @_;
4151 foreach my $address ( @$arrayref ) {
4153 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4154 return 'Can\'t add FAX invoice destination with a blank FAX number.';
4157 my $cust_main_invoice = new FS::cust_main_invoice ( {
4158 'custnum' => $self->custnum,
4161 my $error = $self->custnum
4162 ? $cust_main_invoice->check
4163 : $cust_main_invoice->checkdest
4165 return $error if $error;
4169 return "Email address required"
4170 if $conf->exists('cust_main-require_invoicing_list_email')
4171 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4176 =item set_default_invoicing_list
4178 Sets the invoicing list to all accounts associated with this customer,
4179 overwriting any previous invoicing list.
4183 sub set_default_invoicing_list {
4185 $self->invoicing_list($self->all_emails);
4190 Returns the email addresses of all accounts provisioned for this customer.
4197 foreach my $cust_pkg ( $self->all_pkgs ) {
4198 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4200 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4201 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4203 $list{$_}=1 foreach map { $_->email } @svc_acct;
4208 =item invoicing_list_addpost
4210 Adds postal invoicing to this customer. If this customer is already configured
4211 to receive postal invoices, does nothing.
4215 sub invoicing_list_addpost {
4217 return if grep { $_ eq 'POST' } $self->invoicing_list;
4218 my @invoicing_list = $self->invoicing_list;
4219 push @invoicing_list, 'POST';
4220 $self->invoicing_list(\@invoicing_list);
4223 =item invoicing_list_emailonly
4225 Returns the list of email invoice recipients (invoicing_list without non-email
4226 destinations such as POST and FAX).
4230 sub invoicing_list_emailonly {
4232 warn "$me invoicing_list_emailonly called"
4234 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4237 =item invoicing_list_emailonly_scalar
4239 Returns the list of email invoice recipients (invoicing_list without non-email
4240 destinations such as POST and FAX) as a comma-separated scalar.
4244 sub invoicing_list_emailonly_scalar {
4246 warn "$me invoicing_list_emailonly_scalar called"
4248 join(', ', $self->invoicing_list_emailonly);
4251 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4253 Returns an array of customers referred by this customer (referral_custnum set
4254 to this custnum). If DEPTH is given, recurses up to the given depth, returning
4255 customers referred by customers referred by this customer and so on, inclusive.
4256 The default behavior is DEPTH 1 (no recursion).
4260 sub referral_cust_main {
4262 my $depth = @_ ? shift : 1;
4263 my $exclude = @_ ? shift : {};
4266 map { $exclude->{$_->custnum}++; $_; }
4267 grep { ! $exclude->{ $_->custnum } }
4268 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4272 map { $_->referral_cust_main($depth-1, $exclude) }
4279 =item referral_cust_main_ncancelled
4281 Same as referral_cust_main, except only returns customers with uncancelled
4286 sub referral_cust_main_ncancelled {
4288 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4291 =item referral_cust_pkg [ DEPTH ]
4293 Like referral_cust_main, except returns a flat list of all unsuspended (and
4294 uncancelled) packages for each customer. The number of items in this list may
4295 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4299 sub referral_cust_pkg {
4301 my $depth = @_ ? shift : 1;
4303 map { $_->unsuspended_pkgs }
4304 grep { $_->unsuspended_pkgs }
4305 $self->referral_cust_main($depth);
4308 =item referring_cust_main
4310 Returns the single cust_main record for the customer who referred this customer
4311 (referral_custnum), or false.
4315 sub referring_cust_main {
4317 return '' unless $self->referral_custnum;
4318 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4321 =item credit AMOUNT, REASON
4323 Applies a credit to this customer. If there is an error, returns the error,
4324 otherwise returns false.
4329 my( $self, $amount, $reason ) = @_;
4330 my $cust_credit = new FS::cust_credit {
4331 'custnum' => $self->custnum,
4332 'amount' => $amount,
4333 'reason' => $reason,
4335 $cust_credit->insert;
4338 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4340 Creates a one-time charge for this customer. If there is an error, returns
4341 the error, otherwise returns false.
4347 my ( $amount, $pkg, $comment, $taxclass, $additional );
4348 if ( ref( $_[0] ) ) {
4349 $amount = $_[0]->{amount};
4350 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4351 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
4352 : '$'. sprintf("%.2f",$amount);
4353 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4354 $additional = $_[0]->{additional};
4357 $pkg = @_ ? shift : 'One-time charge';
4358 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
4359 $taxclass = @_ ? shift : '';
4363 local $SIG{HUP} = 'IGNORE';
4364 local $SIG{INT} = 'IGNORE';
4365 local $SIG{QUIT} = 'IGNORE';
4366 local $SIG{TERM} = 'IGNORE';
4367 local $SIG{TSTP} = 'IGNORE';
4368 local $SIG{PIPE} = 'IGNORE';
4370 my $oldAutoCommit = $FS::UID::AutoCommit;
4371 local $FS::UID::AutoCommit = 0;
4374 my $part_pkg = new FS::part_pkg ( {
4376 'comment' => $comment,
4380 'taxclass' => $taxclass,
4383 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4384 ( 0 .. @$additional - 1 )
4386 'additional_count' => scalar(@$additional),
4387 'setup_fee' => $amount,
4390 my $error = $part_pkg->insert( options => \%options );
4392 $dbh->rollback if $oldAutoCommit;
4396 my $pkgpart = $part_pkg->pkgpart;
4397 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4398 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4399 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4400 $error = $type_pkgs->insert;
4402 $dbh->rollback if $oldAutoCommit;
4407 my $cust_pkg = new FS::cust_pkg ( {
4408 'custnum' => $self->custnum,
4409 'pkgpart' => $pkgpart,
4412 $error = $cust_pkg->insert;
4414 $dbh->rollback if $oldAutoCommit;
4418 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4425 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4431 sort { $a->_date <=> $b->_date }
4432 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4435 =item open_cust_bill
4437 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4442 sub open_cust_bill {
4444 grep { $_->owed > 0 } $self->cust_bill;
4449 Returns all the credits (see L<FS::cust_credit>) for this customer.
4455 sort { $a->_date <=> $b->_date }
4456 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4461 Returns all the payments (see L<FS::cust_pay>) for this customer.
4467 sort { $a->_date <=> $b->_date }
4468 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4473 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4479 sort { $a->_date <=> $b->_date }
4480 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4483 =item cust_pay_batch
4485 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
4489 sub cust_pay_batch {
4491 sort { $a->_date <=> $b->_date }
4492 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
4497 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4503 sort { $a->_date <=> $b->_date }
4504 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4509 Returns a name string for this customer, either "Company (Last, First)" or
4516 my $name = $self->contact;
4517 $name = $self->company. " ($name)" if $self->company;
4523 Returns a name string for this (service/shipping) contact, either
4524 "Company (Last, First)" or "Last, First".
4530 if ( $self->get('ship_last') ) {
4531 my $name = $self->ship_contact;
4532 $name = $self->ship_company. " ($name)" if $self->ship_company;
4541 Returns this customer's full (billing) contact name only, "Last, First"
4547 $self->get('last'). ', '. $self->first;
4552 Returns this customer's full (shipping) contact name only, "Last, First"
4558 $self->get('ship_last')
4559 ? $self->get('ship_last'). ', '. $self->ship_first
4565 Returns this customer's full country name
4571 code2country($self->country);
4578 Returns a status string for this customer, currently:
4582 =item prospect - No packages have ever been ordered
4584 =item active - One or more recurring packages is active
4586 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4588 =item suspended - All non-cancelled recurring packages are suspended
4590 =item cancelled - All recurring packages are cancelled
4596 sub status { shift->cust_status(@_); }
4600 for my $status (qw( prospect active inactive suspended cancelled )) {
4601 my $method = $status.'_sql';
4602 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4603 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4604 $sth->execute( ($self->custnum) x $numnum )
4605 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4606 return $status if $sth->fetchrow_arrayref->[0];
4610 =item ucfirst_cust_status
4612 =item ucfirst_status
4614 Returns the status with the first character capitalized.
4618 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4620 sub ucfirst_cust_status {
4622 ucfirst($self->cust_status);
4627 Returns a hex triplet color string for this customer's status.
4631 use vars qw(%statuscolor);
4632 tie my %statuscolor, 'Tie::IxHash',
4633 'prospect' => '7e0079', #'000000', #black? naw, purple
4634 'active' => '00CC00', #green
4635 'inactive' => '0000CC', #blue
4636 'suspended' => 'FF9900', #yellow
4637 'cancelled' => 'FF0000', #red
4640 sub statuscolor { shift->cust_statuscolor(@_); }
4642 sub cust_statuscolor {
4644 $statuscolor{$self->cust_status};
4649 Returns an array of hashes representing the customer's RT tickets.
4656 my $num = $conf->config('cust_main-max_tickets') || 10;
4659 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4661 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4665 foreach my $priority (
4666 $conf->config('ticket_system-custom_priority_field-values'), ''
4668 last if scalar(@tickets) >= $num;
4670 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4671 $num - scalar(@tickets),
4680 # Return services representing svc_accts in customer support packages
4681 sub support_services {
4683 my %packages = map { $_ => 1 } $conf->config('support_packages');
4685 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4686 grep { $_->part_svc->svcdb eq 'svc_acct' }
4687 map { $_->cust_svc }
4688 grep { exists $packages{ $_->pkgpart } }
4689 $self->ncancelled_pkgs;
4695 =head1 CLASS METHODS
4701 Class method that returns the list of possible status strings for customers
4702 (see L<the status method|/status>). For example:
4704 @statuses = FS::cust_main->statuses();
4709 #my $self = shift; #could be class...
4715 Returns an SQL expression identifying prospective cust_main records (customers
4716 with no packages ever ordered)
4720 use vars qw($select_count_pkgs);
4721 $select_count_pkgs =
4722 "SELECT COUNT(*) FROM cust_pkg
4723 WHERE cust_pkg.custnum = cust_main.custnum";
4725 sub select_count_pkgs_sql {
4729 sub prospect_sql { "
4730 0 = ( $select_count_pkgs )
4735 Returns an SQL expression identifying active cust_main records (customers with
4736 no active recurring packages, but otherwise unsuspended/uncancelled).
4741 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
4747 Returns an SQL expression identifying inactive cust_main records (customers with
4748 active recurring packages).
4752 sub inactive_sql { "
4753 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4755 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
4761 Returns an SQL expression identifying suspended cust_main records.
4766 sub suspended_sql { susp_sql(@_); }
4768 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
4770 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4776 Returns an SQL expression identifying cancelled cust_main records.
4780 sub cancelled_sql { cancel_sql(@_); }
4783 my $recurring_sql = FS::cust_pkg->recurring_sql;
4784 #my $recurring_sql = "
4785 # '0' != ( select freq from part_pkg
4786 # where cust_pkg.pkgpart = part_pkg.pkgpart )
4790 0 < ( $select_count_pkgs )
4791 AND 0 = ( $select_count_pkgs AND $recurring_sql
4792 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4798 =item uncancelled_sql
4800 Returns an SQL expression identifying un-cancelled cust_main records.
4804 sub uncancelled_sql { uncancel_sql(@_); }
4805 sub uncancel_sql { "
4806 ( 0 < ( $select_count_pkgs
4807 AND ( cust_pkg.cancel IS NULL
4808 OR cust_pkg.cancel = 0
4811 OR 0 = ( $select_count_pkgs )
4817 Returns an SQL fragment to retreive the balance.
4822 COALESCE( ( SELECT SUM(charged) FROM cust_bill
4823 WHERE cust_bill.custnum = cust_main.custnum ), 0)
4824 - COALESCE( ( SELECT SUM(paid) FROM cust_pay
4825 WHERE cust_pay.custnum = cust_main.custnum ), 0)
4826 - COALESCE( ( SELECT SUM(amount) FROM cust_credit
4827 WHERE cust_credit.custnum = cust_main.custnum ), 0)
4828 + COALESCE( ( SELECT SUM(refund) FROM cust_refund
4829 WHERE cust_refund.custnum = cust_main.custnum ), 0)
4832 =item balance_date_sql TIME
4834 Returns an SQL fragment to retreive the balance for this customer, only
4835 considering invoices with date earlier than TIME. (total_owed_date minus total_credited minus
4836 total_unapplied_payments). TIME is specified as an SQL fragment or a numeric
4837 UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and
4838 L<Date::Parse> for conversion functions.
4842 sub balance_date_sql {
4843 my( $class, $time ) = @_;
4845 my $owed_sql = FS::cust_bill->owed_sql;
4846 my $unapp_refund_sql = FS::cust_refund->unapplied_sql;
4847 #my $unapp_credit_sql = FS::cust_credit->unapplied_sql;
4848 my $unapp_credit_sql = FS::cust_credit->credited_sql;
4849 my $unapp_pay_sql = FS::cust_pay->unapplied_sql;
4852 COALESCE( ( SELECT SUM($owed_sql) FROM cust_bill
4853 WHERE cust_bill.custnum = cust_main.custnum
4854 AND cust_bill._date <= $time )
4857 + COALESCE( ( SELECT SUM($unapp_refund_sql) FROM cust_refund
4858 WHERE cust_refund.custnum = cust_main.custnum )
4861 - COALESCE( ( SELECT SUM($unapp_credit_sql) FROM cust_credit
4862 WHERE cust_credit.custnum = cust_main.custnum )
4865 - COALESCE( ( SELECT SUM($unapp_pay_sql) FROM cust_pay
4866 WHERE cust_pay.custnum = cust_main.custnum )
4874 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
4876 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
4877 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
4878 appropriate ship_ field is also searched).
4880 Additional options are the same as FS::Record::qsearch
4885 my( $self, $fuzzy, $hash, @opt) = @_;
4890 check_and_rebuild_fuzzyfiles();
4891 foreach my $field ( keys %$fuzzy ) {
4893 my $all = $self->all_X($field);
4894 next unless scalar(@$all);
4897 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
4900 foreach ( keys %match ) {
4901 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
4902 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
4905 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4908 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4910 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4918 Returns a masked version of the named field
4923 my ($self,$field) = @_;
4927 'x'x(length($self->getfield($field))-4).
4928 substr($self->getfield($field), (length($self->getfield($field))-4));
4938 =item smart_search OPTION => VALUE ...
4940 Accepts the following options: I<search>, the string to search for. The string
4941 will be searched for as a customer number, phone number, name or company name,
4942 as an exact, or, in some cases, a substring or fuzzy match (see the source code
4943 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
4944 skip fuzzy matching when an exact match is found.
4946 Any additional options are treated as an additional qualifier on the search
4949 Returns a (possibly empty) array of FS::cust_main objects.
4956 #here is the agent virtualization
4957 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
4961 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
4962 my $search = delete $options{'search'};
4963 ( my $alphanum_search = $search ) =~ s/\W//g;
4965 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
4967 #false laziness w/Record::ut_phone
4968 my $phonen = "$1-$2-$3";
4969 $phonen .= " x$4" if $4;
4971 push @cust_main, qsearch( {
4972 'table' => 'cust_main',
4973 'hashref' => { %options },
4974 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4976 join(' OR ', map "$_ = '$phonen'",
4977 qw( daytime night fax
4978 ship_daytime ship_night ship_fax )
4981 " AND $agentnums_sql", #agent virtualization
4984 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
4985 #try looking for matches with extensions unless one was specified
4987 push @cust_main, qsearch( {
4988 'table' => 'cust_main',
4989 'hashref' => { %options },
4990 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4992 join(' OR ', map "$_ LIKE '$phonen\%'",
4994 ship_daytime ship_night )
4997 " AND $agentnums_sql", #agent virtualization
5002 } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
5004 push @cust_main, qsearch( {
5005 'table' => 'cust_main',
5006 'hashref' => { 'custnum' => $1, %options },
5007 'extra_sql' => " AND $agentnums_sql", #agent virtualization
5010 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
5012 my($company, $last, $first) = ( $1, $2, $3 );
5014 # "Company (Last, First)"
5015 #this is probably something a browser remembered,
5016 #so just do an exact search
5018 foreach my $prefix ( '', 'ship_' ) {
5019 push @cust_main, qsearch( {
5020 'table' => 'cust_main',
5021 'hashref' => { $prefix.'first' => $first,
5022 $prefix.'last' => $last,
5023 $prefix.'company' => $company,
5026 'extra_sql' => " AND $agentnums_sql",
5030 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
5031 # try (ship_){last,company}
5035 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
5036 # # full strings the browser remembers won't work
5037 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
5039 use Lingua::EN::NameParse;
5040 my $NameParse = new Lingua::EN::NameParse(
5042 allow_reversed => 1,
5045 my($last, $first) = ( '', '' );
5046 #maybe disable this too and just rely on NameParse?
5047 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
5049 ($last, $first) = ( $1, $2 );
5051 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
5052 } elsif ( ! $NameParse->parse($value) ) {
5054 my %name = $NameParse->components;
5055 $first = $name{'given_name_1'};
5056 $last = $name{'surname_1'};
5060 if ( $first && $last ) {
5062 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
5065 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5067 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
5068 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
5071 push @cust_main, qsearch( {
5072 'table' => 'cust_main',
5073 'hashref' => \%options,
5074 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5077 # or it just be something that was typed in... (try that in a sec)
5081 my $q_value = dbh->quote($value);
5084 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5085 $sql .= " ( LOWER(last) = $q_value
5086 OR LOWER(company) = $q_value
5087 OR LOWER(ship_last) = $q_value
5088 OR LOWER(ship_company) = $q_value
5091 push @cust_main, qsearch( {
5092 'table' => 'cust_main',
5093 'hashref' => \%options,
5094 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5097 #no exact match, trying substring/fuzzy
5098 #always do substring & fuzzy (unless they're explicity config'ed off)
5099 #getting complaints searches are not returning enough
5100 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
5102 #still some false laziness w/ search/cust_main.cgi
5107 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
5108 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
5111 if ( $first && $last ) {
5114 { 'first' => { op=>'ILIKE', value=>"%$first%" },
5115 'last' => { op=>'ILIKE', value=>"%$last%" },
5117 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
5118 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
5125 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
5126 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
5130 foreach my $hashref ( @hashrefs ) {
5132 push @cust_main, qsearch( {
5133 'table' => 'cust_main',
5134 'hashref' => { %$hashref,
5137 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
5146 " AND $agentnums_sql", #extra_sql #agent virtualization
5149 if ( $first && $last ) {
5150 push @cust_main, FS::cust_main->fuzzy_search(
5151 { 'last' => $last, #fuzzy hashref
5152 'first' => $first }, #
5156 foreach my $field ( 'last', 'company' ) {
5158 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
5163 #eliminate duplicates
5165 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5173 =item check_and_rebuild_fuzzyfiles
5177 use vars qw(@fuzzyfields);
5178 @fuzzyfields = ( 'last', 'first', 'company' );
5180 sub check_and_rebuild_fuzzyfiles {
5181 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5182 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
5185 =item rebuild_fuzzyfiles
5189 sub rebuild_fuzzyfiles {
5191 use Fcntl qw(:flock);
5193 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5194 mkdir $dir, 0700 unless -d $dir;
5196 foreach my $fuzzy ( @fuzzyfields ) {
5198 open(LOCK,">>$dir/cust_main.$fuzzy")
5199 or die "can't open $dir/cust_main.$fuzzy: $!";
5201 or die "can't lock $dir/cust_main.$fuzzy: $!";
5203 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
5204 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
5206 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
5207 my $sth = dbh->prepare("SELECT $field FROM cust_main".
5208 " WHERE $field != '' AND $field IS NOT NULL");
5209 $sth->execute or die $sth->errstr;
5211 while ( my $row = $sth->fetchrow_arrayref ) {
5212 print CACHE $row->[0]. "\n";
5217 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
5219 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
5230 my( $self, $field ) = @_;
5231 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5232 open(CACHE,"<$dir/cust_main.$field")
5233 or die "can't open $dir/cust_main.$field: $!";
5234 my @array = map { chomp; $_; } <CACHE>;
5239 =item append_fuzzyfiles LASTNAME COMPANY
5243 sub append_fuzzyfiles {
5244 #my( $first, $last, $company ) = @_;
5246 &check_and_rebuild_fuzzyfiles;
5248 use Fcntl qw(:flock);
5250 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5252 foreach my $field (qw( first last company )) {
5257 open(CACHE,">>$dir/cust_main.$field")
5258 or die "can't open $dir/cust_main.$field: $!";
5259 flock(CACHE,LOCK_EX)
5260 or die "can't lock $dir/cust_main.$field: $!";
5262 print CACHE "$value\n";
5264 flock(CACHE,LOCK_UN)
5265 or die "can't unlock $dir/cust_main.$field: $!";
5280 #warn join('-',keys %$param);
5281 my $fh = $param->{filehandle};
5282 my $agentnum = $param->{agentnum};
5284 my $refnum = $param->{refnum};
5285 my $pkgpart = $param->{pkgpart};
5287 #my @fields = @{$param->{fields}};
5288 my $format = $param->{'format'};
5291 if ( $format eq 'simple' ) {
5292 @fields = qw( cust_pkg.setup dayphone first last
5293 address1 address2 city state zip comments );
5295 } elsif ( $format eq 'extended' ) {
5296 @fields = qw( agent_custid refnum
5297 last first address1 address2 city state zip country
5299 ship_last ship_first ship_address1 ship_address2
5300 ship_city ship_state ship_zip ship_country
5301 payinfo paycvv paydate
5304 svc_acct.username svc_acct._password
5308 die "unknown format $format";
5311 eval "use Text::CSV_XS;";
5314 my $csv = new Text::CSV_XS;
5321 local $SIG{HUP} = 'IGNORE';
5322 local $SIG{INT} = 'IGNORE';
5323 local $SIG{QUIT} = 'IGNORE';
5324 local $SIG{TERM} = 'IGNORE';
5325 local $SIG{TSTP} = 'IGNORE';
5326 local $SIG{PIPE} = 'IGNORE';
5328 my $oldAutoCommit = $FS::UID::AutoCommit;
5329 local $FS::UID::AutoCommit = 0;
5332 #while ( $columns = $csv->getline($fh) ) {
5334 while ( defined($line=<$fh>) ) {
5336 $csv->parse($line) or do {
5337 $dbh->rollback if $oldAutoCommit;
5338 return "can't parse: ". $csv->error_input();
5341 my @columns = $csv->fields();
5342 #warn join('-',@columns);
5345 agentnum => $agentnum,
5347 country => $conf->config('countrydefault') || 'US',
5348 payby => $payby, #default
5349 paydate => '12/2037', #default
5351 my $billtime = time;
5352 my %cust_pkg = ( pkgpart => $pkgpart );
5354 foreach my $field ( @fields ) {
5356 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
5358 #$cust_pkg{$1} = str2time( shift @$columns );
5359 if ( $1 eq 'pkgpart' ) {
5360 $cust_pkg{$1} = shift @columns;
5361 } elsif ( $1 eq 'setup' ) {
5362 $billtime = str2time(shift @columns);
5364 $cust_pkg{$1} = str2time( shift @columns );
5367 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
5369 $svc_acct{$1} = shift @columns;
5373 #refnum interception
5374 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
5376 my $referral = $columns[0];
5377 my %hash = ( 'referral' => $referral,
5378 'agentnum' => $agentnum,
5382 my $part_referral = qsearchs('part_referral', \%hash )
5383 || new FS::part_referral \%hash;
5385 unless ( $part_referral->refnum ) {
5386 my $error = $part_referral->insert;
5388 $dbh->rollback if $oldAutoCommit;
5389 return "can't auto-insert advertising source: $referral: $error";
5393 $columns[0] = $part_referral->refnum;
5396 #$cust_main{$field} = shift @$columns;
5397 $cust_main{$field} = shift @columns;
5401 $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
5403 my $invoicing_list = $cust_main{'invoicing_list'}
5404 ? [ delete $cust_main{'invoicing_list'} ]
5407 my $cust_main = new FS::cust_main ( \%cust_main );
5410 tie my %hash, 'Tie::RefHash'; #this part is important
5412 if ( $cust_pkg{'pkgpart'} ) {
5413 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
5416 if ( $svc_acct{'username'} ) {
5417 my $part_pkg = $cust_pkg->part_pkg;
5418 unless ( $part_pkg ) {
5419 $dbh->rollback if $oldAutoCommit;
5420 return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
5422 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
5423 push @svc_acct, new FS::svc_acct ( \%svc_acct )
5426 $hash{$cust_pkg} = \@svc_acct;
5429 my $error = $cust_main->insert( \%hash, $invoicing_list );
5432 $dbh->rollback if $oldAutoCommit;
5433 return "can't insert customer for $line: $error";
5436 if ( $format eq 'simple' ) {
5438 #false laziness w/bill.cgi
5439 $error = $cust_main->bill( 'time' => $billtime );
5441 $dbh->rollback if $oldAutoCommit;
5442 return "can't bill customer for $line: $error";
5445 $error = $cust_main->apply_payments_and_credits;
5447 $dbh->rollback if $oldAutoCommit;
5448 return "can't bill customer for $line: $error";
5451 $error = $cust_main->collect();
5453 $dbh->rollback if $oldAutoCommit;
5454 return "can't collect customer for $line: $error";
5462 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5464 return "Empty file!" unless $imported;
5476 #warn join('-',keys %$param);
5477 my $fh = $param->{filehandle};
5478 my @fields = @{$param->{fields}};
5480 eval "use Text::CSV_XS;";
5483 my $csv = new Text::CSV_XS;
5490 local $SIG{HUP} = 'IGNORE';
5491 local $SIG{INT} = 'IGNORE';
5492 local $SIG{QUIT} = 'IGNORE';
5493 local $SIG{TERM} = 'IGNORE';
5494 local $SIG{TSTP} = 'IGNORE';
5495 local $SIG{PIPE} = 'IGNORE';
5497 my $oldAutoCommit = $FS::UID::AutoCommit;
5498 local $FS::UID::AutoCommit = 0;
5501 #while ( $columns = $csv->getline($fh) ) {
5503 while ( defined($line=<$fh>) ) {
5505 $csv->parse($line) or do {
5506 $dbh->rollback if $oldAutoCommit;
5507 return "can't parse: ". $csv->error_input();
5510 my @columns = $csv->fields();
5511 #warn join('-',@columns);
5514 foreach my $field ( @fields ) {
5515 $row{$field} = shift @columns;
5518 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
5519 unless ( $cust_main ) {
5520 $dbh->rollback if $oldAutoCommit;
5521 return "unknown custnum $row{'custnum'}";
5524 if ( $row{'amount'} > 0 ) {
5525 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
5527 $dbh->rollback if $oldAutoCommit;
5531 } elsif ( $row{'amount'} < 0 ) {
5532 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
5535 $dbh->rollback if $oldAutoCommit;
5545 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5547 return "Empty file!" unless $imported;
5553 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5555 Sends a templated email notification to the customer (see L<Text::Template>).
5557 OPTIONS is a hash and may include
5559 I<from> - the email sender (default is invoice_from)
5561 I<to> - comma-separated scalar or arrayref of recipients
5562 (default is invoicing_list)
5564 I<subject> - The subject line of the sent email notification
5565 (default is "Notice from company_name")
5567 I<extra_fields> - a hashref of name/value pairs which will be substituted
5570 The following variables are vavailable in the template.
5572 I<$first> - the customer first name
5573 I<$last> - the customer last name
5574 I<$company> - the customer company
5575 I<$payby> - a description of the method of payment for the customer
5576 # would be nice to use FS::payby::shortname
5577 I<$payinfo> - the account information used to collect for this customer
5578 I<$expdate> - the expiration of the customer payment in seconds from epoch
5583 my ($customer, $template, %options) = @_;
5585 return unless $conf->exists($template);
5587 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
5588 $from = $options{from} if exists($options{from});
5590 my $to = join(',', $customer->invoicing_list_emailonly);
5591 $to = $options{to} if exists($options{to});
5593 my $subject = "Notice from " . $conf->config('company_name')
5594 if $conf->exists('company_name');
5595 $subject = $options{subject} if exists($options{subject});
5597 my $notify_template = new Text::Template (TYPE => 'ARRAY',
5598 SOURCE => [ map "$_\n",
5599 $conf->config($template)]
5601 or die "can't create new Text::Template object: Text::Template::ERROR";
5602 $notify_template->compile()
5603 or die "can't compile template: Text::Template::ERROR";
5605 my $paydate = $customer->paydate;
5606 $FS::notify_template::_template::first = $customer->first;
5607 $FS::notify_template::_template::last = $customer->last;
5608 $FS::notify_template::_template::company = $customer->company;
5609 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
5610 my $payby = $customer->payby;
5611 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5612 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5614 #credit cards expire at the end of the month/year of their exp date
5615 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5616 $FS::notify_template::_template::payby = 'credit card';
5617 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5618 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5620 }elsif ($payby eq 'COMP') {
5621 $FS::notify_template::_template::payby = 'complimentary account';
5623 $FS::notify_template::_template::payby = 'current method';
5625 $FS::notify_template::_template::expdate = $expire_time;
5627 for (keys %{$options{extra_fields}}){
5629 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5632 send_email(from => $from,
5634 subject => $subject,
5635 body => $notify_template->fill_in( PACKAGE =>
5636 'FS::notify_template::_template' ),
5641 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5643 Generates a templated notification to the customer (see L<Text::Template>).
5645 OPTIONS is a hash and may include
5647 I<extra_fields> - a hashref of name/value pairs which will be substituted
5648 into the template. These values may override values mentioned below
5649 and those from the customer record.
5651 The following variables are available in the template instead of or in addition
5652 to the fields of the customer record.
5654 I<$payby> - a description of the method of payment for the customer
5655 # would be nice to use FS::payby::shortname
5656 I<$payinfo> - the masked account information used to collect for this customer
5657 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5658 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress
5662 sub generate_letter {
5663 my ($self, $template, %options) = @_;
5665 return unless $conf->exists($template);
5667 my $letter_template = new Text::Template
5669 SOURCE => [ map "$_\n", $conf->config($template)],
5670 DELIMITERS => [ '[@--', '--@]' ],
5672 or die "can't create new Text::Template object: Text::Template::ERROR";
5674 $letter_template->compile()
5675 or die "can't compile template: Text::Template::ERROR";
5677 my %letter_data = map { $_ => $self->$_ } $self->fields;
5678 $letter_data{payinfo} = $self->mask_payinfo;
5680 #my $paydate = $self->paydate || '2037-12';
5681 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12';
5683 my $payby = $self->payby;
5684 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5685 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5687 #credit cards expire at the end of the month/year of their exp date
5688 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5689 $letter_data{payby} = 'credit card';
5690 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5691 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5693 }elsif ($payby eq 'COMP') {
5694 $letter_data{payby} = 'complimentary account';
5696 $letter_data{payby} = 'current method';
5698 $letter_data{expdate} = $expire_time;
5700 for (keys %{$options{extra_fields}}){
5701 $letter_data{$_} = $options{extra_fields}->{$_};
5704 unless(exists($letter_data{returnaddress})){
5705 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5706 $self->agent_template)
5709 $letter_data{returnaddress} = length($retadd) ? $retadd : '~';
5712 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5714 my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
5715 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5719 ) or die "can't open temp file: $!\n";
5721 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5723 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5727 =item print_ps TEMPLATE
5729 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5735 my $file = $self->generate_letter(@_);
5736 FS::Misc::generate_ps($file);
5739 =item print TEMPLATE
5741 Prints the filled in template.
5743 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5747 sub queueable_print {
5750 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5751 or die "invalid customer number: " . $opt{custvnum};
5753 my $error = $self->print( $opt{template} );
5754 die $error if $error;
5758 my ($self, $template) = (shift, shift);
5759 do_print [ $self->print_ps($template) ];
5762 sub agent_template {
5764 $self->_agent_plandata('agent_templatename');
5767 sub agent_invoice_from {
5769 $self->_agent_plandata('agent_invoice_from');
5772 sub _agent_plandata {
5773 my( $self, $option ) = @_;
5775 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5776 #agent-specific Conf
5778 my $agentnum = $self->agentnum;
5780 my $part_event_option =
5782 'table' => 'part_event_option',
5784 LEFT JOIN part_event USING ( eventpart )
5785 LEFT JOIN part_event_option AS peo_agentnum
5786 ON ( part_event.eventpart = peo_agentnum.eventpart
5787 AND peo_agentnum.optionname = 'agentnum'
5788 AND peo_agentnum.optionvalue ~ '(^|,)agentnum(,|$)'
5790 LEFT JOIN part_event_option AS peo_cust_bill_age
5791 ON ( part_event.eventpart = peo_cust_bill_age.eventpart
5792 AND peo_cust_bill_age.optionname = 'cust_bill_age'
5795 #'hashref' => { 'optionname' => $option },
5796 'hashref' => { 'part_event_option.optionname' => $option },
5797 'extra_sql' => " AND event = 'cust_bill_send_agent' ".
5798 " AND peo_agentnum.optionname = 'agentnum' ".
5799 " AND agentnum IS NULL OR agentnum = $agentnum ".
5801 CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
5803 ELSE EXTRACT( EPOCH FROM
5804 REPLACE( peo_cust_bill_age.optionvalue,
5810 , part_event.weight".
5814 unless ( $part_event_option ) {
5815 return $self->agent->invoice_template || ''
5816 if $option eq '$agent_templatename';
5820 $part_event_option->optionvalue;
5830 The delete method should possibly take an FS::cust_main object reference
5831 instead of a scalar customer number.
5833 Bill and collect options should probably be passed as references instead of a
5836 There should probably be a configuration file with a list of allowed credit
5839 No multiple currency support (probably a larger project than just this module).
5841 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5843 Birthdates rely on negative epoch values.
5845 The payby for card/check batches is broken. With mixed batching, bad
5848 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5852 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5853 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5854 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.