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";
355 $self->invoicing_list( $invoicing_list );
358 if ( $conf->config('cust_main-skeleton_tables')
359 && $conf->config('cust_main-skeleton_custnum') ) {
361 warn " inserting skeleton records\n"
364 my $error = $self->start_copy_skel;
366 $dbh->rollback if $oldAutoCommit;
372 warn " ordering packages\n"
375 $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
377 $dbh->rollback if $oldAutoCommit;
382 $dbh->rollback if $oldAutoCommit;
383 return "No svc_acct record to apply pre-paid time";
387 warn " inserting initial $payby payment of $amount\n"
389 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
391 $dbh->rollback if $oldAutoCommit;
392 return "inserting payment (transaction rolled back): $error";
396 unless ( $import || $skip_fuzzyfiles ) {
397 warn " queueing fuzzyfiles update\n"
399 $error = $self->queue_fuzzyfiles_update;
401 $dbh->rollback if $oldAutoCommit;
402 return "updating fuzzy search cache: $error";
406 warn " insert complete; committing transaction\n"
409 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
414 sub start_copy_skel {
417 #'mg_user_preference' => {},
418 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
419 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
420 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
421 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
422 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
425 _copy_skel( 'cust_main', #tablename
426 $conf->config('cust_main-skeleton_custnum'), #sourceid
427 $self->custnum, #destid
428 @tables, #child tables
432 #recursive subroutine, not a method
434 my( $table, $sourceid, $destid, %child_tables ) = @_;
437 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
438 ( $table, $primary_key ) = ( $1, $2 );
440 my $dbdef_table = dbdef->table($table);
441 $primary_key = $dbdef_table->primary_key
442 or return "$table has no primary key".
443 " (or do you need to run dbdef-create?)";
446 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
447 join (', ', keys %child_tables). "\n"
450 foreach my $child_table_def ( keys %child_tables ) {
454 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
455 ( $child_table, $child_pkey ) = ( $1, $2 );
457 $child_table = $child_table_def;
459 $child_pkey = dbdef->table($child_table)->primary_key;
460 # or return "$table has no primary key".
461 # " (or do you need to run dbdef-create?)\n";
465 if ( keys %{ $child_tables{$child_table_def} } ) {
467 return "$child_table has no primary key".
468 " (run dbdef-create or try specifying it?)\n"
471 #false laziness w/Record::insert and only works on Pg
472 #refactor the proper last-inserted-id stuff out of Record::insert if this
473 # ever gets use for anything besides a quick kludge for one customer
474 my $default = dbdef->table($child_table)->column($child_pkey)->default;
475 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
476 or return "can't parse $child_table.$child_pkey default value ".
477 " for sequence name: $default";
482 my @sel_columns = grep { $_ ne $primary_key }
483 dbdef->table($child_table)->columns;
484 my $sel_columns = join(', ', @sel_columns );
486 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
487 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
488 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
490 my $sel_st = "SELECT $sel_columns FROM $child_table".
491 " WHERE $primary_key = $sourceid";
494 my $sel_sth = dbh->prepare( $sel_st )
495 or return dbh->errstr;
497 $sel_sth->execute or return $sel_sth->errstr;
499 while ( my $row = $sel_sth->fetchrow_hashref ) {
501 warn " selected row: ".
502 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
506 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
507 my $ins_sth =dbh->prepare($statement)
508 or return dbh->errstr;
509 my @param = ( $destid, map $row->{$_}, @ins_columns );
510 warn " $statement: [ ". join(', ', @param). " ]\n"
512 $ins_sth->execute( @param )
513 or return $ins_sth->errstr;
515 #next unless keys %{ $child_tables{$child_table} };
516 next unless $sequence;
518 #another section of that laziness
519 my $seq_sql = "SELECT currval('$sequence')";
520 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
521 $seq_sth->execute or return $seq_sth->errstr;
522 my $insertid = $seq_sth->fetchrow_arrayref->[0];
524 # don't drink soap! recurse! recurse! okay!
526 _copy_skel( $child_table_def,
527 $row->{$child_pkey}, #sourceid
529 %{ $child_tables{$child_table_def} },
531 return $error if $error;
541 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
543 Like the insert method on an existing record, this method orders a package
544 and included services atomicaly. Pass a Tie::RefHash data structure to this
545 method containing FS::cust_pkg and FS::svc_I<tablename> objects. There should
546 be a better explanation of this, but until then, here's an example:
549 tie %hash, 'Tie::RefHash'; #this part is important
551 $cust_pkg => [ $svc_acct ],
554 $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
556 Services can be new, in which case they are inserted, or existing unaudited
557 services, in which case they are linked to the newly-created package.
559 Currently available options are: I<depend_jobnum> and I<noexport>.
561 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
562 on the supplied jobnum (they will not run until the specific job completes).
563 This can be used to defer provisioning until some action completes (such
564 as running the customer's credit card successfully).
566 The I<noexport> option is deprecated. If I<noexport> is set true, no
567 provisioning jobs (exports) are scheduled. (You can schedule them later with
568 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
569 on the cust_main object is not recommended, as existing services will also be
576 my $cust_pkgs = shift;
579 my %svc_options = ();
580 $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
581 if exists $options{'depend_jobnum'};
582 warn "$me order_pkgs called with options ".
583 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
586 local $SIG{HUP} = 'IGNORE';
587 local $SIG{INT} = 'IGNORE';
588 local $SIG{QUIT} = 'IGNORE';
589 local $SIG{TERM} = 'IGNORE';
590 local $SIG{TSTP} = 'IGNORE';
591 local $SIG{PIPE} = 'IGNORE';
593 my $oldAutoCommit = $FS::UID::AutoCommit;
594 local $FS::UID::AutoCommit = 0;
597 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
599 foreach my $cust_pkg ( keys %$cust_pkgs ) {
600 $cust_pkg->custnum( $self->custnum );
601 my $error = $cust_pkg->insert;
603 $dbh->rollback if $oldAutoCommit;
604 return "inserting cust_pkg (transaction rolled back): $error";
606 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
607 if ( $svc_something->svcnum ) {
608 my $old_cust_svc = $svc_something->cust_svc;
609 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
610 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
611 $error = $new_cust_svc->replace($old_cust_svc);
613 $svc_something->pkgnum( $cust_pkg->pkgnum );
614 if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
615 $svc_something->seconds( $svc_something->seconds + $$seconds );
618 $error = $svc_something->insert(%svc_options);
621 $dbh->rollback if $oldAutoCommit;
622 #return "inserting svc_ (transaction rolled back): $error";
628 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
632 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
634 Recharges this (existing) customer with the specified prepaid card (see
635 L<FS::prepay_credit>), specified either by I<identifier> or as an
636 FS::prepay_credit object. If there is an error, returns the error, otherwise
639 Optionally, four scalar references can be passed as well. They will have their
640 values filled in with the amount, number of seconds, and number of upload and
641 download bytes applied by this prepaid
646 sub recharge_prepay {
647 my( $self, $prepay_credit, $amountref, $secondsref,
648 $upbytesref, $downbytesref, $totalbytesref ) = @_;
650 local $SIG{HUP} = 'IGNORE';
651 local $SIG{INT} = 'IGNORE';
652 local $SIG{QUIT} = 'IGNORE';
653 local $SIG{TERM} = 'IGNORE';
654 local $SIG{TSTP} = 'IGNORE';
655 local $SIG{PIPE} = 'IGNORE';
657 my $oldAutoCommit = $FS::UID::AutoCommit;
658 local $FS::UID::AutoCommit = 0;
661 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
663 my $error = $self->get_prepay($prepay_credit, \$amount,
664 \$seconds, \$upbytes, \$downbytes, \$totalbytes)
665 || $self->increment_seconds($seconds)
666 || $self->increment_upbytes($upbytes)
667 || $self->increment_downbytes($downbytes)
668 || $self->increment_totalbytes($totalbytes)
669 || $self->insert_cust_pay_prepay( $amount,
671 ? $prepay_credit->identifier
676 $dbh->rollback if $oldAutoCommit;
680 if ( defined($amountref) ) { $$amountref = $amount; }
681 if ( defined($secondsref) ) { $$secondsref = $seconds; }
682 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
683 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
684 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
686 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
691 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
693 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
694 specified either by I<identifier> or as an FS::prepay_credit object.
696 References to I<amount> and I<seconds> scalars should be passed as arguments
697 and will be incremented by the values of the prepaid card.
699 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
700 check or set this customer's I<agentnum>.
702 If there is an error, returns the error, otherwise returns false.
708 my( $self, $prepay_credit, $amountref, $secondsref,
709 $upref, $downref, $totalref) = @_;
711 local $SIG{HUP} = 'IGNORE';
712 local $SIG{INT} = 'IGNORE';
713 local $SIG{QUIT} = 'IGNORE';
714 local $SIG{TERM} = 'IGNORE';
715 local $SIG{TSTP} = 'IGNORE';
716 local $SIG{PIPE} = 'IGNORE';
718 my $oldAutoCommit = $FS::UID::AutoCommit;
719 local $FS::UID::AutoCommit = 0;
722 unless ( ref($prepay_credit) ) {
724 my $identifier = $prepay_credit;
726 $prepay_credit = qsearchs(
728 { 'identifier' => $prepay_credit },
733 unless ( $prepay_credit ) {
734 $dbh->rollback if $oldAutoCommit;
735 return "Invalid prepaid card: ". $identifier;
740 if ( $prepay_credit->agentnum ) {
741 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
742 $dbh->rollback if $oldAutoCommit;
743 return "prepaid card not valid for agent ". $self->agentnum;
745 $self->agentnum($prepay_credit->agentnum);
748 my $error = $prepay_credit->delete;
750 $dbh->rollback if $oldAutoCommit;
751 return "removing prepay_credit (transaction rolled back): $error";
754 $$amountref += $prepay_credit->amount;
755 $$secondsref += $prepay_credit->seconds;
756 $$upref += $prepay_credit->upbytes;
757 $$downref += $prepay_credit->downbytes;
758 $$totalref += $prepay_credit->totalbytes;
760 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
765 =item increment_upbytes SECONDS
767 Updates this customer's single or primary account (see L<FS::svc_acct>) by
768 the specified number of upbytes. If there is an error, returns the error,
769 otherwise returns false.
773 sub increment_upbytes {
774 _increment_column( shift, 'upbytes', @_);
777 =item increment_downbytes SECONDS
779 Updates this customer's single or primary account (see L<FS::svc_acct>) by
780 the specified number of downbytes. If there is an error, returns the error,
781 otherwise returns false.
785 sub increment_downbytes {
786 _increment_column( shift, 'downbytes', @_);
789 =item increment_totalbytes SECONDS
791 Updates this customer's single or primary account (see L<FS::svc_acct>) by
792 the specified number of totalbytes. If there is an error, returns the error,
793 otherwise returns false.
797 sub increment_totalbytes {
798 _increment_column( shift, 'totalbytes', @_);
801 =item increment_seconds SECONDS
803 Updates this customer's single or primary account (see L<FS::svc_acct>) by
804 the specified number of seconds. If there is an error, returns the error,
805 otherwise returns false.
809 sub increment_seconds {
810 _increment_column( shift, 'seconds', @_);
813 =item _increment_column AMOUNT
815 Updates this customer's single or primary account (see L<FS::svc_acct>) by
816 the specified number of seconds or bytes. If there is an error, returns
817 the error, otherwise returns false.
821 sub _increment_column {
822 my( $self, $column, $amount ) = @_;
823 warn "$me increment_column called: $column, $amount\n"
826 return '' unless $amount;
828 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
829 $self->ncancelled_pkgs;
832 return 'No packages with primary or single services found'.
833 ' to apply pre-paid time';
834 } elsif ( scalar(@cust_pkg) > 1 ) {
835 #maybe have a way to specify the package/account?
836 return 'Multiple packages found to apply pre-paid time';
839 my $cust_pkg = $cust_pkg[0];
840 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
844 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
847 return 'No account found to apply pre-paid time';
848 } elsif ( scalar(@cust_svc) > 1 ) {
849 return 'Multiple accounts found to apply pre-paid time';
852 my $svc_acct = $cust_svc[0]->svc_x;
853 warn " found service svcnum ". $svc_acct->pkgnum.
854 ' ('. $svc_acct->email. ")\n"
857 $column = "increment_$column";
858 $svc_acct->$column($amount);
862 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
864 Inserts a prepayment in the specified amount for this customer. An optional
865 second argument can specify the prepayment identifier for tracking purposes.
866 If there is an error, returns the error, otherwise returns false.
870 sub insert_cust_pay_prepay {
871 shift->insert_cust_pay('PREP', @_);
874 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
876 Inserts a cash payment in the specified amount for this customer. An optional
877 second argument can specify the payment identifier for tracking purposes.
878 If there is an error, returns the error, otherwise returns false.
882 sub insert_cust_pay_cash {
883 shift->insert_cust_pay('CASH', @_);
886 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
888 Inserts a Western Union payment in the specified amount for this customer. An
889 optional second argument can specify the prepayment identifier for tracking
890 purposes. If there is an error, returns the error, otherwise returns false.
894 sub insert_cust_pay_west {
895 shift->insert_cust_pay('WEST', @_);
898 sub insert_cust_pay {
899 my( $self, $payby, $amount ) = splice(@_, 0, 3);
900 my $payinfo = scalar(@_) ? shift : '';
902 my $cust_pay = new FS::cust_pay {
903 'custnum' => $self->custnum,
904 'paid' => sprintf('%.2f', $amount),
905 #'_date' => #date the prepaid card was purchased???
907 'payinfo' => $payinfo,
915 This method is deprecated. See the I<depend_jobnum> option to the insert and
916 order_pkgs methods for a better way to defer provisioning.
918 Re-schedules all exports by calling the B<reexport> method of all associated
919 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
920 otherwise returns false.
927 carp "WARNING: FS::cust_main::reexport is deprectated; ".
928 "use the depend_jobnum option to insert or order_pkgs to delay export";
930 local $SIG{HUP} = 'IGNORE';
931 local $SIG{INT} = 'IGNORE';
932 local $SIG{QUIT} = 'IGNORE';
933 local $SIG{TERM} = 'IGNORE';
934 local $SIG{TSTP} = 'IGNORE';
935 local $SIG{PIPE} = 'IGNORE';
937 my $oldAutoCommit = $FS::UID::AutoCommit;
938 local $FS::UID::AutoCommit = 0;
941 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
942 my $error = $cust_pkg->reexport;
944 $dbh->rollback if $oldAutoCommit;
949 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
954 =item delete NEW_CUSTNUM
956 This deletes the customer. If there is an error, returns the error, otherwise
959 This will completely remove all traces of the customer record. This is not
960 what you want when a customer cancels service; for that, cancel all of the
961 customer's packages (see L</cancel>).
963 If the customer has any uncancelled packages, you need to pass a new (valid)
964 customer number for those packages to be transferred to. Cancelled packages
965 will be deleted. Did I mention that this is NOT what you want when a customer
966 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
968 You can't delete a customer with invoices (see L<FS::cust_bill>),
969 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
970 refunds (see L<FS::cust_refund>).
977 local $SIG{HUP} = 'IGNORE';
978 local $SIG{INT} = 'IGNORE';
979 local $SIG{QUIT} = 'IGNORE';
980 local $SIG{TERM} = 'IGNORE';
981 local $SIG{TSTP} = 'IGNORE';
982 local $SIG{PIPE} = 'IGNORE';
984 my $oldAutoCommit = $FS::UID::AutoCommit;
985 local $FS::UID::AutoCommit = 0;
988 if ( $self->cust_bill ) {
989 $dbh->rollback if $oldAutoCommit;
990 return "Can't delete a customer with invoices";
992 if ( $self->cust_credit ) {
993 $dbh->rollback if $oldAutoCommit;
994 return "Can't delete a customer with credits";
996 if ( $self->cust_pay ) {
997 $dbh->rollback if $oldAutoCommit;
998 return "Can't delete a customer with payments";
1000 if ( $self->cust_refund ) {
1001 $dbh->rollback if $oldAutoCommit;
1002 return "Can't delete a customer with refunds";
1005 my @cust_pkg = $self->ncancelled_pkgs;
1007 my $new_custnum = shift;
1008 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1009 $dbh->rollback if $oldAutoCommit;
1010 return "Invalid new customer number: $new_custnum";
1012 foreach my $cust_pkg ( @cust_pkg ) {
1013 my %hash = $cust_pkg->hash;
1014 $hash{'custnum'} = $new_custnum;
1015 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1016 my $error = $new_cust_pkg->replace($cust_pkg,
1017 options => { $cust_pkg->options },
1020 $dbh->rollback if $oldAutoCommit;
1025 my @cancelled_cust_pkg = $self->all_pkgs;
1026 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1027 my $error = $cust_pkg->delete;
1029 $dbh->rollback if $oldAutoCommit;
1034 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1035 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1037 my $error = $cust_main_invoice->delete;
1039 $dbh->rollback if $oldAutoCommit;
1044 my $error = $self->SUPER::delete;
1046 $dbh->rollback if $oldAutoCommit;
1050 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1055 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
1057 Replaces the OLD_RECORD with this one in the database. If there is an error,
1058 returns the error, otherwise returns false.
1060 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1061 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1062 expected and rollback the entire transaction; it is not necessary to call
1063 check_invoicing_list first. Here's an example:
1065 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1073 warn "$me replace called\n"
1076 local $SIG{HUP} = 'IGNORE';
1077 local $SIG{INT} = 'IGNORE';
1078 local $SIG{QUIT} = 'IGNORE';
1079 local $SIG{TERM} = 'IGNORE';
1080 local $SIG{TSTP} = 'IGNORE';
1081 local $SIG{PIPE} = 'IGNORE';
1083 # We absolutely have to have an old vs. new record to make this work.
1084 if (!defined($old)) {
1085 $old = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
1088 my $curuser = $FS::CurrentUser::CurrentUser;
1089 if ( $self->payby eq 'COMP'
1090 && $self->payby ne $old->payby
1091 && ! $curuser->access_right('Complimentary customer')
1094 return "You are not permitted to create complimentary accounts.";
1097 local($ignore_expired_card) = 1
1098 if $old->payby =~ /^(CARD|DCRD)$/
1099 && $self->payby =~ /^(CARD|DCRD)$/
1100 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1102 my $oldAutoCommit = $FS::UID::AutoCommit;
1103 local $FS::UID::AutoCommit = 0;
1106 my $error = $self->SUPER::replace($old);
1109 $dbh->rollback if $oldAutoCommit;
1113 if ( @param ) { # INVOICING_LIST_ARYREF
1114 my $invoicing_list = shift @param;
1115 $error = $self->check_invoicing_list( $invoicing_list );
1117 $dbh->rollback if $oldAutoCommit;
1120 $self->invoicing_list( $invoicing_list );
1123 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1124 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1125 # card/check/lec info has changed, want to retry realtime_ invoice events
1126 my $error = $self->retry_realtime;
1128 $dbh->rollback if $oldAutoCommit;
1133 unless ( $import || $skip_fuzzyfiles ) {
1134 $error = $self->queue_fuzzyfiles_update;
1136 $dbh->rollback if $oldAutoCommit;
1137 return "updating fuzzy search cache: $error";
1141 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1146 =item queue_fuzzyfiles_update
1148 Used by insert & replace to update the fuzzy search cache
1152 sub queue_fuzzyfiles_update {
1155 local $SIG{HUP} = 'IGNORE';
1156 local $SIG{INT} = 'IGNORE';
1157 local $SIG{QUIT} = 'IGNORE';
1158 local $SIG{TERM} = 'IGNORE';
1159 local $SIG{TSTP} = 'IGNORE';
1160 local $SIG{PIPE} = 'IGNORE';
1162 my $oldAutoCommit = $FS::UID::AutoCommit;
1163 local $FS::UID::AutoCommit = 0;
1166 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1167 my $error = $queue->insert( map $self->getfield($_),
1168 qw(first last company)
1171 $dbh->rollback if $oldAutoCommit;
1172 return "queueing job (transaction rolled back): $error";
1175 if ( $self->ship_last ) {
1176 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1177 $error = $queue->insert( map $self->getfield("ship_$_"),
1178 qw(first last company)
1181 $dbh->rollback if $oldAutoCommit;
1182 return "queueing job (transaction rolled back): $error";
1186 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1193 Checks all fields to make sure this is a valid customer record. If there is
1194 an error, returns the error, otherwise returns false. Called by the insert
1195 and replace methods.
1202 warn "$me check BEFORE: \n". $self->_dump
1206 $self->ut_numbern('custnum')
1207 || $self->ut_number('agentnum')
1208 || $self->ut_textn('agent_custid')
1209 || $self->ut_number('refnum')
1210 || $self->ut_name('last')
1211 || $self->ut_name('first')
1212 || $self->ut_snumbern('birthdate')
1213 || $self->ut_snumbern('signupdate')
1214 || $self->ut_textn('company')
1215 || $self->ut_text('address1')
1216 || $self->ut_textn('address2')
1217 || $self->ut_text('city')
1218 || $self->ut_textn('county')
1219 || $self->ut_textn('state')
1220 || $self->ut_country('country')
1221 || $self->ut_anything('comments')
1222 || $self->ut_numbern('referral_custnum')
1223 || $self->ut_textn('stateid')
1224 || $self->ut_textn('stateid_state')
1225 || $self->ut_textn('invoice_terms')
1227 #barf. need message catalogs. i18n. etc.
1228 $error .= "Please select an advertising source."
1229 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1230 return $error if $error;
1232 return "Unknown agent"
1233 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1235 return "Unknown refnum"
1236 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1238 return "Unknown referring custnum: ". $self->referral_custnum
1239 unless ! $self->referral_custnum
1240 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1242 if ( $self->ss eq '' ) {
1247 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1248 or return "Illegal social security number: ". $self->ss;
1249 $self->ss("$1-$2-$3");
1253 # bad idea to disable, causes billing to fail because of no tax rates later
1254 # unless ( $import ) {
1255 unless ( qsearch('cust_main_county', {
1256 'country' => $self->country,
1259 return "Unknown state/county/country: ".
1260 $self->state. "/". $self->county. "/". $self->country
1261 unless qsearch('cust_main_county',{
1262 'state' => $self->state,
1263 'county' => $self->county,
1264 'country' => $self->country,
1270 $self->ut_phonen('daytime', $self->country)
1271 || $self->ut_phonen('night', $self->country)
1272 || $self->ut_phonen('fax', $self->country)
1273 || $self->ut_zip('zip', $self->country)
1275 return $error if $error;
1278 last first company address1 address2 city county state zip
1279 country daytime night fax
1282 if ( defined $self->dbdef_table->column('ship_last') ) {
1283 if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1285 && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
1289 $self->ut_name('ship_last')
1290 || $self->ut_name('ship_first')
1291 || $self->ut_textn('ship_company')
1292 || $self->ut_text('ship_address1')
1293 || $self->ut_textn('ship_address2')
1294 || $self->ut_text('ship_city')
1295 || $self->ut_textn('ship_county')
1296 || $self->ut_textn('ship_state')
1297 || $self->ut_country('ship_country')
1299 return $error if $error;
1301 #false laziness with above
1302 unless ( qsearchs('cust_main_county', {
1303 'country' => $self->ship_country,
1306 return "Unknown ship_state/ship_county/ship_country: ".
1307 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1308 unless qsearch('cust_main_county',{
1309 'state' => $self->ship_state,
1310 'county' => $self->ship_county,
1311 'country' => $self->ship_country,
1317 $self->ut_phonen('ship_daytime', $self->ship_country)
1318 || $self->ut_phonen('ship_night', $self->ship_country)
1319 || $self->ut_phonen('ship_fax', $self->ship_country)
1320 || $self->ut_zip('ship_zip', $self->ship_country)
1322 return $error if $error;
1324 } else { # ship_ info eq billing info, so don't store dup info in database
1325 $self->setfield("ship_$_", '')
1326 foreach qw( last first company address1 address2 city county state zip
1327 country daytime night fax );
1331 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1332 # or return "Illegal payby: ". $self->payby;
1334 FS::payby->can_payby($self->table, $self->payby)
1335 or return "Illegal payby: ". $self->payby;
1337 $error = $self->ut_numbern('paystart_month')
1338 || $self->ut_numbern('paystart_year')
1339 || $self->ut_numbern('payissue')
1340 || $self->ut_textn('paytype')
1342 return $error if $error;
1344 if ( $self->payip eq '' ) {
1347 $error = $self->ut_ip('payip');
1348 return $error if $error;
1351 # If it is encrypted and the private key is not availaible then we can't
1352 # check the credit card.
1354 my $check_payinfo = 1;
1356 if ($self->is_encrypted($self->payinfo)) {
1360 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1362 my $payinfo = $self->payinfo;
1363 $payinfo =~ s/\D//g;
1364 $payinfo =~ /^(\d{13,16})$/
1365 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1367 $self->payinfo($payinfo);
1369 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1371 return gettext('unknown_card_type')
1372 if cardtype($self->payinfo) eq "Unknown";
1374 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1376 return 'Banned credit card: banned on '.
1377 time2str('%a %h %o at %r', $ban->_date).
1378 ' by '. $ban->otaker.
1379 ' (ban# '. $ban->bannum. ')';
1382 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1383 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1384 $self->paycvv =~ /^(\d{4})$/
1385 or return "CVV2 (CID) for American Express cards is four digits.";
1388 $self->paycvv =~ /^(\d{3})$/
1389 or return "CVV2 (CVC2/CID) is three digits.";
1396 my $cardtype = cardtype($payinfo);
1397 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1399 return "Start date or issue number is required for $cardtype cards"
1400 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1402 return "Start month must be between 1 and 12"
1403 if $self->paystart_month
1404 and $self->paystart_month < 1 || $self->paystart_month > 12;
1406 return "Start year must be 1990 or later"
1407 if $self->paystart_year
1408 and $self->paystart_year < 1990;
1410 return "Issue number must be beween 1 and 99"
1412 and $self->payissue < 1 || $self->payissue > 99;
1415 $self->paystart_month('');
1416 $self->paystart_year('');
1417 $self->payissue('');
1420 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1422 my $payinfo = $self->payinfo;
1423 $payinfo =~ s/[^\d\@]//g;
1424 if ( $conf->exists('echeck-nonus') ) {
1425 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1427 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1429 $payinfo = "$1\@$2";
1430 $self->payinfo($payinfo);
1433 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1435 return 'Banned ACH account: banned on '.
1436 time2str('%a %h %o at %r', $ban->_date).
1437 ' by '. $ban->otaker.
1438 ' (ban# '. $ban->bannum. ')';
1441 } elsif ( $self->payby eq 'LECB' ) {
1443 my $payinfo = $self->payinfo;
1444 $payinfo =~ s/\D//g;
1445 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1447 $self->payinfo($payinfo);
1450 } elsif ( $self->payby eq 'BILL' ) {
1452 $error = $self->ut_textn('payinfo');
1453 return "Illegal P.O. number: ". $self->payinfo if $error;
1456 } elsif ( $self->payby eq 'COMP' ) {
1458 my $curuser = $FS::CurrentUser::CurrentUser;
1459 if ( ! $self->custnum
1460 && ! $curuser->access_right('Complimentary customer')
1463 return "You are not permitted to create complimentary accounts."
1466 $error = $self->ut_textn('payinfo');
1467 return "Illegal comp account issuer: ". $self->payinfo if $error;
1470 } elsif ( $self->payby eq 'PREPAY' ) {
1472 my $payinfo = $self->payinfo;
1473 $payinfo =~ s/\W//g; #anything else would just confuse things
1474 $self->payinfo($payinfo);
1475 $error = $self->ut_alpha('payinfo');
1476 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1477 return "Unknown prepayment identifier"
1478 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1483 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1484 return "Expiration date required"
1485 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1489 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1490 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1491 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1492 ( $m, $y ) = ( $3, "20$2" );
1494 return "Illegal expiration date: ". $self->paydate;
1496 $self->paydate("$y-$m-01");
1497 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1498 return gettext('expired_card')
1500 && !$ignore_expired_card
1501 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1504 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1505 ( ! $conf->exists('require_cardname')
1506 || $self->payby !~ /^(CARD|DCRD)$/ )
1508 $self->payname( $self->first. " ". $self->getfield('last') );
1510 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1511 or return gettext('illegal_name'). " payname: ". $self->payname;
1515 foreach my $flag (qw( tax spool_cdr )) {
1516 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1520 $self->otaker(getotaker) unless $self->otaker;
1522 warn "$me check AFTER: \n". $self->_dump
1525 $self->SUPER::check;
1530 Returns all packages (see L<FS::cust_pkg>) for this customer.
1537 return $self->num_pkgs unless wantarray;
1540 if ( $self->{'_pkgnum'} ) {
1541 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1543 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1546 sort sort_packages @cust_pkg;
1551 Synonym for B<all_pkgs>.
1556 shift->all_pkgs(@_);
1559 =item ncancelled_pkgs
1561 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1565 sub ncancelled_pkgs {
1568 return $self->num_ncancelled_pkgs unless wantarray;
1571 if ( $self->{'_pkgnum'} ) {
1573 warn "$me ncancelled_pkgs: returning cached objects"
1576 @cust_pkg = grep { ! $_->getfield('cancel') }
1577 values %{ $self->{'_pkgnum'}->cache };
1581 warn "$me ncancelled_pkgs: searching for packages for custnum ".
1586 qsearch( 'cust_pkg', {
1587 'custnum' => $self->custnum,
1591 qsearch( 'cust_pkg', {
1592 'custnum' => $self->custnum,
1597 sort sort_packages @cust_pkg;
1601 # This should be generalized to use config options to determine order.
1603 if ( $a->get('cancel') and $b->get('cancel') ) {
1604 $a->pkgnum <=> $b->pkgnum;
1605 } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1606 return -1 if $b->get('cancel');
1607 return 1 if $a->get('cancel');
1610 $a->pkgnum <=> $b->pkgnum;
1614 =item suspended_pkgs
1616 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1620 sub suspended_pkgs {
1622 grep { $_->susp } $self->ncancelled_pkgs;
1625 =item unflagged_suspended_pkgs
1627 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1628 customer (thouse packages without the `manual_flag' set).
1632 sub unflagged_suspended_pkgs {
1634 return $self->suspended_pkgs
1635 unless dbdef->table('cust_pkg')->column('manual_flag');
1636 grep { ! $_->manual_flag } $self->suspended_pkgs;
1639 =item unsuspended_pkgs
1641 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1646 sub unsuspended_pkgs {
1648 grep { ! $_->susp } $self->ncancelled_pkgs;
1651 =item num_cancelled_pkgs
1653 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1658 sub num_cancelled_pkgs {
1659 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1662 sub num_ncancelled_pkgs {
1663 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1667 my( $self, $sql ) = @_;
1668 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1669 my $sth = dbh->prepare(
1670 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1671 ) or die dbh->errstr;
1672 $sth->execute($self->custnum) or die $sth->errstr;
1673 $sth->fetchrow_arrayref->[0];
1678 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1679 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1680 on success or a list of errors.
1686 grep { $_->unsuspend } $self->suspended_pkgs;
1691 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1693 Returns a list: an empty list on success or a list of errors.
1699 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1702 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1704 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1705 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
1706 of a list of pkgparts; the hashref has the following keys:
1710 =item pkgparts - listref of pkgparts
1712 =item (other options are passed to the suspend method)
1717 Returns a list: an empty list on success or a list of errors.
1721 sub suspend_if_pkgpart {
1723 my (@pkgparts, %opt);
1724 if (ref($_[0]) eq 'HASH'){
1725 @pkgparts = @{$_[0]{pkgparts}};
1730 grep { $_->suspend(%opt) }
1731 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1732 $self->unsuspended_pkgs;
1735 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1737 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1738 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
1739 instead of a list of pkgparts; the hashref has the following keys:
1743 =item pkgparts - listref of pkgparts
1745 =item (other options are passed to the suspend method)
1749 Returns a list: an empty list on success or a list of errors.
1753 sub suspend_unless_pkgpart {
1755 my (@pkgparts, %opt);
1756 if (ref($_[0]) eq 'HASH'){
1757 @pkgparts = @{$_[0]{pkgparts}};
1762 grep { $_->suspend(%opt) }
1763 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1764 $self->unsuspended_pkgs;
1767 =item cancel [ OPTION => VALUE ... ]
1769 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1771 Available options are:
1775 =item quiet - can be set true to supress email cancellation notices.
1777 =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.
1779 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
1783 Always returns a list: an empty list on success or a list of errors.
1788 my( $self, %opt ) = @_;
1790 warn "$me cancel called on customer ". $self->custnum. " with options ".
1791 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
1794 return ( 'access denied' )
1795 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
1797 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1799 #should try decryption (we might have the private key)
1800 # and if not maybe queue a job for the server that does?
1801 return ( "Can't (yet) ban encrypted credit cards" )
1802 if $self->is_encrypted($self->payinfo);
1804 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1805 my $error = $ban->insert;
1806 return ( $error ) if $error;
1810 my @pkgs = $self->ncancelled_pkgs;
1812 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
1813 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
1816 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
1819 sub _banned_pay_hashref {
1830 'payby' => $payby2ban{$self->payby},
1831 'payinfo' => md5_base64($self->payinfo),
1832 #don't ever *search* on reason! #'reason' =>
1838 Returns all notes (see L<FS::cust_main_note>) for this customer.
1845 qsearch( 'cust_main_note',
1846 { 'custnum' => $self->custnum },
1848 'ORDER BY _DATE DESC'
1854 Returns the agent (see L<FS::agent>) for this customer.
1860 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1863 =item bill_and_collect
1865 Cancels and suspends any packages due, generates bills, applies payments and
1868 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
1870 Options are passed as name-value pairs. Currently available options are:
1874 =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:
1878 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1880 =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.
1882 =item check_freq - "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1884 =item resetup - if set true, re-charges setup fees.
1890 sub bill_and_collect {
1891 my( $self, %options ) = @_;
1897 #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1898 foreach my $cust_pkg (
1899 grep { $_->expire && $_->expire <= $^T } $self->ncancelled_pkgs
1901 my $error = $cust_pkg->cancel;
1902 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
1903 " for custnum ". $self->custnum. ": $error"
1911 #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1912 foreach my $cust_pkg (
1913 grep { ( $_->part_pkg->is_prepaid && $_->bill && $_->bill < $^T
1914 || $_->adjourn && $_->adjourn <= $^T
1918 $self->ncancelled_pkgs
1920 my $error = $cust_pkg->suspend;
1921 warn "Error suspending package ". $cust_pkg->pkgnum.
1922 " for custnum ". $self->custnum. ": $error"
1930 my $error = $self->bill( %options );
1931 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
1933 $self->apply_payments_and_credits;
1935 $error = $self->collect( %options );
1936 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
1942 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
1943 conjunction with the collect method by calling B<bill_and_collect>.
1945 If there is an error, returns the error, otherwise returns false.
1947 Options are passed as name-value pairs. Currently available options are:
1951 =item resetup - if set true, re-charges setup fees.
1953 =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:
1957 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1959 =item pkg_list - An array ref of specific packages (objects) to attempt billing, instead trying all of them.
1961 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
1963 =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.
1970 my( $self, %options ) = @_;
1971 return '' if $self->payby eq 'COMP';
1972 warn "$me bill customer ". $self->custnum. "\n"
1975 my $time = $options{'time'} || time;
1980 local $SIG{HUP} = 'IGNORE';
1981 local $SIG{INT} = 'IGNORE';
1982 local $SIG{QUIT} = 'IGNORE';
1983 local $SIG{TERM} = 'IGNORE';
1984 local $SIG{TSTP} = 'IGNORE';
1985 local $SIG{PIPE} = 'IGNORE';
1987 my $oldAutoCommit = $FS::UID::AutoCommit;
1988 local $FS::UID::AutoCommit = 0;
1991 $self->select_for_update; #mutex
1993 #create a new invoice
1994 #(we'll remove it later if it doesn't actually need to be generated [contains
1995 # no line items] and we're inside a transaciton so nothing else will see it)
1996 my $cust_bill = new FS::cust_bill ( {
1997 'custnum' => $self->custnum,
1998 '_date' => ( $options{'invoice_time'} || $time ),
1999 #'charged' => $charged,
2002 $error = $cust_bill->insert;
2004 $dbh->rollback if $oldAutoCommit;
2005 return "can't create invoice for customer #". $self->custnum. ": $error";
2007 my $invnum = $cust_bill->invnum;
2010 # find the packages which are due for billing, find out how much they are
2011 # & generate invoice database.
2014 my( $total_setup, $total_recur ) = ( 0, 0 );
2016 my @precommit_hooks = ();
2018 foreach my $cust_pkg (
2019 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
2022 #NO!! next if $cust_pkg->cancel;
2023 next if $cust_pkg->getfield('cancel');
2025 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2027 #? to avoid use of uninitialized value errors... ?
2028 $cust_pkg->setfield('bill', '')
2029 unless defined($cust_pkg->bill);
2031 my $part_pkg = $cust_pkg->part_pkg;
2033 my %hash = $cust_pkg->hash;
2034 my $old_cust_pkg = new FS::cust_pkg \%hash;
2043 if ( ! $cust_pkg->setup &&
2045 ( $conf->exists('disable_setup_suspended_pkgs') &&
2046 ! $cust_pkg->getfield('susp')
2047 ) || ! $conf->exists('disable_setup_suspended_pkgs')
2049 || $options{'resetup'}
2052 warn " bill setup\n" if $DEBUG > 1;
2054 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2056 $dbh->rollback if $oldAutoCommit;
2057 return "$@ running calc_setup for $cust_pkg\n";
2060 $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
2064 # bill recurring fee
2069 if ( $part_pkg->getfield('freq') ne '0' &&
2070 ! $cust_pkg->getfield('susp') &&
2071 ( $cust_pkg->getfield('bill') || 0 ) <= $time
2074 # XXX should this be a package event? probably. events are called
2075 # at collection time at the moment, though...
2076 if ( $part_pkg->can('reset_usage') ) {
2077 warn " resetting usage counters" if $DEBUG > 1;
2078 $part_pkg->reset_usage($cust_pkg);
2081 warn " bill recur\n" if $DEBUG > 1;
2083 # XXX shared with $recur_prog
2084 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2086 #over two params! lets at least switch to a hashref for the rest...
2087 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
2089 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2091 $dbh->rollback if $oldAutoCommit;
2092 return "$@ running calc_recur for $cust_pkg\n";
2095 #change this bit to use Date::Manip? CAREFUL with timezones (see
2096 # mailing list archive)
2097 my ($sec,$min,$hour,$mday,$mon,$year) =
2098 (localtime($sdate) )[0,1,2,3,4,5];
2100 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2101 # only for figuring next bill date, nothing else, so, reset $sdate again
2103 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2104 $cust_pkg->last_bill($sdate)
2105 if $cust_pkg->dbdef_table->column('last_bill');
2107 if ( $part_pkg->freq =~ /^\d+$/ ) {
2108 $mon += $part_pkg->freq;
2109 until ( $mon < 12 ) { $mon -= 12; $year++; }
2110 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2112 $mday += $weeks * 7;
2113 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2116 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2120 $dbh->rollback if $oldAutoCommit;
2121 return "unparsable frequency: ". $part_pkg->freq;
2123 $cust_pkg->setfield('bill',
2124 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2127 warn "\$setup is undefined" unless defined($setup);
2128 warn "\$recur is undefined" unless defined($recur);
2129 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2132 # If $cust_pkg has been modified, update it and create cust_bill_pkg records
2135 if ( $cust_pkg->modified ) { # hmmm.. and if the options are modified?
2137 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2140 $error=$cust_pkg->replace($old_cust_pkg,
2141 options => { $cust_pkg->options },
2143 if ( $error ) { #just in case
2144 $dbh->rollback if $oldAutoCommit;
2145 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2148 $setup = sprintf( "%.2f", $setup );
2149 $recur = sprintf( "%.2f", $recur );
2150 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2151 $dbh->rollback if $oldAutoCommit;
2152 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2154 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2155 $dbh->rollback if $oldAutoCommit;
2156 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2159 if ( $setup != 0 || $recur != 0 ) {
2161 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2163 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2164 'invnum' => $invnum,
2165 'pkgnum' => $cust_pkg->pkgnum,
2169 'edate' => $cust_pkg->bill,
2170 'details' => \@details,
2172 $error = $cust_bill_pkg->insert;
2174 $dbh->rollback if $oldAutoCommit;
2175 return "can't create invoice line item for invoice #$invnum: $error";
2177 $total_setup += $setup;
2178 $total_recur += $recur;
2184 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2187 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2190 my %taxhash = map { $_ => $self->get("$prefix$_") }
2191 qw( state county country );
2193 $taxhash{'taxclass'} = $part_pkg->taxclass;
2195 my @taxes = qsearch( 'cust_main_county', \%taxhash );
2198 $taxhash{'taxclass'} = '';
2199 @taxes = qsearch( 'cust_main_county', \%taxhash );
2202 #one more try at a whole-country tax rate
2204 $taxhash{$_} = '' foreach qw( state county );
2205 @taxes = qsearch( 'cust_main_county', \%taxhash );
2208 # maybe eliminate this entirely, along with all the 0% records
2210 $dbh->rollback if $oldAutoCommit;
2212 "fatal: can't find tax rate for state/county/country/taxclass ".
2213 join('/', ( map $self->get("$prefix$_"),
2214 qw(state county country)
2216 $part_pkg->taxclass ). "\n";
2219 foreach my $tax ( @taxes ) {
2221 my $taxable_charged = 0;
2222 $taxable_charged += $setup
2223 unless $part_pkg->setuptax =~ /^Y$/i
2224 || $tax->setuptax =~ /^Y$/i;
2225 $taxable_charged += $recur
2226 unless $part_pkg->recurtax =~ /^Y$/i
2227 || $tax->recurtax =~ /^Y$/i;
2228 next unless $taxable_charged;
2230 if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2231 #my ($mon,$year) = (localtime($sdate) )[4,5];
2232 my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2234 my $freq = $part_pkg->freq || 1;
2235 if ( $freq !~ /(\d+)$/ ) {
2236 $dbh->rollback if $oldAutoCommit;
2237 return "daily/weekly package definitions not (yet?)".
2238 " compatible with monthly tax exemptions";
2240 my $taxable_per_month =
2241 sprintf("%.2f", $taxable_charged / $freq );
2243 #call the whole thing off if this customer has any old
2244 #exemption records...
2245 my @cust_tax_exempt =
2246 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2247 if ( @cust_tax_exempt ) {
2248 $dbh->rollback if $oldAutoCommit;
2250 'this customer still has old-style tax exemption records; '.
2251 'run bin/fs-migrate-cust_tax_exempt?';
2254 foreach my $which_month ( 1 .. $freq ) {
2256 #maintain the new exemption table now
2259 FROM cust_tax_exempt_pkg
2260 LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2261 LEFT JOIN cust_bill USING ( invnum )
2267 my $sth = dbh->prepare($sql) or do {
2268 $dbh->rollback if $oldAutoCommit;
2269 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2277 $dbh->rollback if $oldAutoCommit;
2278 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2280 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2282 my $remaining_exemption =
2283 $tax->exempt_amount - $existing_exemption;
2284 if ( $remaining_exemption > 0 ) {
2285 my $addl = $remaining_exemption > $taxable_per_month
2286 ? $taxable_per_month
2287 : $remaining_exemption;
2288 $taxable_charged -= $addl;
2290 my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2291 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2292 'taxnum' => $tax->taxnum,
2293 'year' => 1900+$year,
2295 'amount' => sprintf("%.2f", $addl ),
2297 $error = $cust_tax_exempt_pkg->insert;
2299 $dbh->rollback if $oldAutoCommit;
2300 return "fatal: can't insert cust_tax_exempt_pkg: $error";
2302 } # if $remaining_exemption > 0
2306 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2307 until ( $mon < 13 ) { $mon -= 12; $year++; }
2309 } #foreach $which_month
2311 } #if $tax->exempt_amount
2313 $taxable_charged = sprintf( "%.2f", $taxable_charged);
2315 #$tax += $taxable_charged * $cust_main_county->tax / 100
2316 $tax{ $tax->taxname || 'Tax' } +=
2317 $taxable_charged * $tax->tax / 100
2319 } #foreach my $tax ( @taxes )
2321 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2323 } #if $setup != 0 || $recur != 0
2325 } #if $cust_pkg->modified
2327 } #foreach my $cust_pkg
2329 unless ( $cust_bill->cust_bill_pkg ) {
2330 $cust_bill->delete; #don't create an invoice w/o line items
2332 # XXX this seems to be broken
2333 #( DBD::Pg::st execute failed: ERROR: syntax error at or near "hcb" )
2334 # # get rid of our fake history too, waste of unecessary space
2335 # my $h_cleanup_query = q{
2336 # DELETE FROM h_cust_bill hcb
2337 # WHERE hcb.invnum = ?
2338 # AND NOT EXISTS ( SELECT 1 FROM cust_bill cb where cb.invnum = hcb.invnum )
2340 # my $h_sth = $dbh->prepare($h_cleanup_query);
2341 # $h_sth->execute($invnum);
2343 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2347 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2349 foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2350 my $tax = sprintf("%.2f", $tax{$taxname} );
2351 $charged = sprintf( "%.2f", $charged+$tax );
2353 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2354 'invnum' => $invnum,
2360 'itemdesc' => $taxname,
2362 $error = $cust_bill_pkg->insert;
2364 $dbh->rollback if $oldAutoCommit;
2365 return "can't create invoice line item for invoice #$invnum: $error";
2367 $total_setup += $tax;
2371 $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2372 $error = $cust_bill->replace;
2374 $dbh->rollback if $oldAutoCommit;
2375 return "can't update charged for invoice #$invnum: $error";
2378 foreach my $hook ( @precommit_hooks ) {
2380 &{$hook}; #($self) ?
2383 $dbh->rollback if $oldAutoCommit;
2384 return "$@ running precommit hook $hook\n";
2388 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2392 =item collect OPTIONS
2394 (Attempt to) collect money for this customer's outstanding invoices (see
2395 L<FS::cust_bill>). Usually used after the bill method.
2397 Actions are now triggered by billing events; see L<FS::part_event> and the
2398 billing events web interface. Old-style invoice events (see
2399 L<FS::part_bill_event>) have been deprecated.
2401 If there is an error, returns the error, otherwise returns false.
2403 Options are passed as name-value pairs.
2405 Currently available options are:
2409 =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.
2411 =item retry - Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2413 =item quiet - set true to surpress email card/ACH decline notices.
2415 =item check_freq - "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2417 =item payby - allows for one time override of normal customer billing method
2422 my( $self, %options ) = @_;
2423 my $invoice_time = $options{'invoice_time'} || time;
2426 local $SIG{HUP} = 'IGNORE';
2427 local $SIG{INT} = 'IGNORE';
2428 local $SIG{QUIT} = 'IGNORE';
2429 local $SIG{TERM} = 'IGNORE';
2430 local $SIG{TSTP} = 'IGNORE';
2431 local $SIG{PIPE} = 'IGNORE';
2433 my $oldAutoCommit = $FS::UID::AutoCommit;
2434 local $FS::UID::AutoCommit = 0;
2437 $self->select_for_update; #mutex
2440 my $balance = $self->balance;
2441 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2444 if ( exists($options{'retry_card'}) ) {
2445 carp 'retry_card option passed to collect is deprecated; use retry';
2446 $options{'retry'} ||= $options{'retry_card'};
2448 if ( exists($options{'retry'}) && $options{'retry'} ) {
2449 my $error = $self->retry_realtime;
2451 $dbh->rollback if $oldAutoCommit;
2456 # false laziness w/pay_batch::import_results
2458 my $due_cust_event = $self->due_cust_event(
2459 'time' => $invoice_time,
2460 'check_freq' => $options{'check_freq'},
2462 unless( ref($due_cust_event) ) {
2463 $dbh->rollback if $oldAutoCommit;
2464 return $due_cust_event;
2467 foreach my $cust_event ( @$due_cust_event ) {
2471 #re-eval event conditions (a previous event could have changed things)
2472 next unless $cust_event->test_conditions( 'time' => $invoice_time );
2475 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2476 warn " running cust_event ". $cust_event->eventnum. "\n"
2480 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2481 if ( my $error = $cust_event->do_event() ) {
2482 #XXX wtf is this? figure out a proper dealio with return value
2484 # gah, even with transactions.
2485 $dbh->commit if $oldAutoCommit; #well.
2492 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2497 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2499 Inserts database records for and returns an ordered listref of new events due
2500 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2501 events are due, an empty listref is returned. If there is an error, returns a
2502 scalar error message.
2504 To actually run the events, call each event's test_condition method, and if
2505 still true, call the event's do_event method.
2507 Options are passed as a hashref or as a list of name-value pairs. Available
2512 =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.
2514 =item time - "Current time" for the events.
2516 =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)
2518 =item eventtable - Only return events for the specified eventtable (by default, events of all eventtables are returned)
2520 =item objects - Explicitly pass the objects to be tested (typically used with eventtable).
2526 sub due_cust_event {
2528 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2531 #my $DEBUG = $opt{'debug'}
2532 local($DEBUG) = $opt{'debug'}
2533 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2535 warn "$me due_cust_event called with options ".
2536 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2539 $opt{'time'} ||= time;
2541 local $SIG{HUP} = 'IGNORE';
2542 local $SIG{INT} = 'IGNORE';
2543 local $SIG{QUIT} = 'IGNORE';
2544 local $SIG{TERM} = 'IGNORE';
2545 local $SIG{TSTP} = 'IGNORE';
2546 local $SIG{PIPE} = 'IGNORE';
2548 my $oldAutoCommit = $FS::UID::AutoCommit;
2549 local $FS::UID::AutoCommit = 0;
2552 $self->select_for_update; #mutex
2555 # 1: find possible events (initial search)
2558 my @cust_event = ();
2560 my @eventtable = $opt{'eventtable'}
2561 ? ( $opt{'eventtable'} )
2562 : FS::part_event->eventtables_runorder;
2564 foreach my $eventtable ( @eventtable ) {
2567 if ( $opt{'objects'} ) {
2569 @objects = @{ $opt{'objects'} };
2573 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2574 @objects = ( $eventtable eq 'cust_main' )
2576 : ( $self->$eventtable() );
2580 my @e_cust_event = ();
2582 my $cross = "CROSS JOIN $eventtable";
2583 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2584 unless $eventtable eq 'cust_main';
2586 foreach my $object ( @objects ) {
2588 #this first search uses the condition_sql magic for optimization.
2589 #the more possible events we can eliminate in this step the better
2591 my $cross_where = '';
2592 my $pkey = $object->primary_key;
2593 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2595 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2597 FS::part_event_condition->where_conditions_sql( $eventtable,
2598 'time'=>$opt{'time'}
2600 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2602 $extra_sql = "AND $extra_sql" if $extra_sql;
2604 #here is the agent virtualization
2605 $extra_sql .= " AND ( part_event.agentnum IS NULL
2606 OR part_event.agentnum = ". $self->agentnum. ' )';
2608 $extra_sql .= " $order";
2610 my @part_event = qsearch( {
2611 'select' => 'part_event.*',
2612 'table' => 'part_event',
2613 'addl_from' => "$cross $join",
2614 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2615 'eventtable' => $eventtable,
2618 'extra_sql' => "AND $cross_where $extra_sql",
2622 my $pkey = $object->primary_key;
2623 warn " ". scalar(@part_event).
2624 " possible events found for $eventtable ". $object->$pkey(). "\n";
2627 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2631 warn " ". scalar(@e_cust_event).
2632 " subtotal possible cust events found for $eventtable"
2635 push @cust_event, @e_cust_event;
2639 warn " ". scalar(@cust_event).
2640 " total possible cust events found in initial search\n"
2644 # 2: test conditions
2649 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
2650 'stats_hashref' => \%unsat ),
2653 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2656 warn " invalid conditions not eliminated with condition_sql:\n".
2657 join('', map " $_: ".$unsat{$_}."\n", keys %unsat );
2663 foreach my $cust_event ( @cust_event ) {
2665 my $error = $cust_event->insert();
2667 $dbh->rollback if $oldAutoCommit;
2673 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2679 warn " returning events: ". Dumper(@cust_event). "\n"
2686 =item retry_realtime
2688 Schedules realtime / batch credit card / electronic check / LEC billing
2689 events for for retry. Useful if card information has changed or manual
2690 retry is desired. The 'collect' method must be called to actually retry
2693 Implementation details: For either this customer, or for each of this
2694 customer's open invoices, changes the status of the first "done" (with
2695 statustext error) realtime processing event to "failed".
2699 sub retry_realtime {
2702 local $SIG{HUP} = 'IGNORE';
2703 local $SIG{INT} = 'IGNORE';
2704 local $SIG{QUIT} = 'IGNORE';
2705 local $SIG{TERM} = 'IGNORE';
2706 local $SIG{TSTP} = 'IGNORE';
2707 local $SIG{PIPE} = 'IGNORE';
2709 my $oldAutoCommit = $FS::UID::AutoCommit;
2710 local $FS::UID::AutoCommit = 0;
2713 #a little false laziness w/due_cust_event (not too bad, really)
2715 my $join = FS::part_event_condition->join_conditions_sql;
2716 my $order = FS::part_event_condition->order_conditions_sql;
2718 #here is the agent virtualization
2719 my $agent_virt = " ( part_event.agentnum IS NULL
2720 OR part_event.agentnum = ". $self->agentnum. ' )';
2722 #XXX this shouldn't be hardcoded, actions should declare it...
2723 my @realtime_events = qw(
2724 cust_bill_realtime_card
2725 cust_bill_realtime_check
2726 cust_bill_realtime_lec
2730 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
2735 my @cust_event = qsearchs({
2736 'table' => 'cust_event',
2737 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
2738 'hashref' => { 'status' => 'done' },
2739 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
2740 " AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
2743 my %seen_invnum = ();
2744 foreach my $cust_event (@cust_event) {
2746 #max one for the customer, one for each open invoice
2747 my $cust_X = $cust_event->cust_X;
2748 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
2752 or $cust_event->part_event->eventtable eq 'cust_bill'
2755 my $error = $cust_event->retry;
2757 $dbh->rollback if $oldAutoCommit;
2758 return "error scheduling event for retry: $error";
2763 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2768 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2770 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2771 via a Business::OnlinePayment realtime gateway. See
2772 L<http://420.am/business-onlinepayment> for supported gateways.
2774 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2776 Available options are: I<description>, I<invnum>, I<quiet>
2778 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2779 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2780 if set, will override the value from the customer record.
2782 I<description> is a free-text field passed to the gateway. It defaults to
2783 "Internet services".
2785 If an I<invnum> is specified, this payment (if successful) is applied to the
2786 specified invoice. If you don't specify an I<invnum> you might want to
2787 call the B<apply_payments> method.
2789 I<quiet> can be set true to surpress email decline notices.
2791 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2796 my( $self, $method, $amount, %options ) = @_;
2798 warn "$me realtime_bop: $method $amount\n";
2799 warn " $_ => $options{$_}\n" foreach keys %options;
2802 $options{'description'} ||= 'Internet services';
2804 eval "use Business::OnlinePayment";
2807 my $payinfo = exists($options{'payinfo'})
2808 ? $options{'payinfo'}
2811 my %method2payby = (
2818 # check for banned credit card/ACH
2821 my $ban = qsearchs('banned_pay', {
2822 'payby' => $method2payby{$method},
2823 'payinfo' => md5_base64($payinfo),
2825 return "Banned credit card" if $ban;
2832 if ( $options{'invnum'} ) {
2833 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2834 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2836 map { $_->part_pkg->taxclass }
2838 map { $_->cust_pkg }
2839 $cust_bill->cust_bill_pkg;
2840 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2841 #different taxclasses
2842 $taxclass = $taxclasses[0];
2846 #look for an agent gateway override first
2848 if ( $method eq 'CC' ) {
2849 $cardtype = cardtype($payinfo);
2850 } elsif ( $method eq 'ECHECK' ) {
2853 $cardtype = $method;
2857 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2858 cardtype => $cardtype,
2859 taxclass => $taxclass, } )
2860 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2862 taxclass => $taxclass, } )
2863 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2864 cardtype => $cardtype,
2866 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2868 taxclass => '', } );
2870 my $payment_gateway = '';
2871 my( $processor, $login, $password, $action, @bop_options );
2872 if ( $override ) { #use a payment gateway override
2874 $payment_gateway = $override->payment_gateway;
2876 $processor = $payment_gateway->gateway_module;
2877 $login = $payment_gateway->gateway_username;
2878 $password = $payment_gateway->gateway_password;
2879 $action = $payment_gateway->gateway_action;
2880 @bop_options = $payment_gateway->options;
2882 } else { #use the standard settings from the config
2884 ( $processor, $login, $password, $action, @bop_options ) =
2885 $self->default_payment_gateway($method);
2893 my $address = exists($options{'address1'})
2894 ? $options{'address1'}
2896 my $address2 = exists($options{'address2'})
2897 ? $options{'address2'}
2899 $address .= ", ". $address2 if length($address2);
2901 my $o_payname = exists($options{'payname'})
2902 ? $options{'payname'}
2904 my($payname, $payfirst, $paylast);
2905 if ( $o_payname && $method ne 'ECHECK' ) {
2906 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2907 or return "Illegal payname $payname";
2908 ($payfirst, $paylast) = ($1, $2);
2910 $payfirst = $self->getfield('first');
2911 $paylast = $self->getfield('last');
2912 $payname = "$payfirst $paylast";
2915 my @invoicing_list = $self->invoicing_list_emailonly;
2916 if ( $conf->exists('emailinvoiceautoalways')
2917 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
2918 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2919 push @invoicing_list, $self->all_emails;
2922 my $email = ($conf->exists('business-onlinepayment-email-override'))
2923 ? $conf->config('business-onlinepayment-email-override')
2924 : $invoicing_list[0];
2928 my $payip = exists($options{'payip'})
2931 $content{customer_ip} = $payip
2934 $content{invoice_number} = $options{'invnum'}
2935 if exists($options{'invnum'}) && length($options{'invnum'});
2938 if ( $method eq 'CC' ) {
2940 $content{card_number} = $payinfo;
2941 $paydate = exists($options{'paydate'})
2942 ? $options{'paydate'}
2944 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2945 $content{expiration} = "$2/$1";
2947 my $paycvv = exists($options{'paycvv'})
2948 ? $options{'paycvv'}
2950 $content{cvv2} = $self->paycvv
2953 my $paystart_month = exists($options{'paystart_month'})
2954 ? $options{'paystart_month'}
2955 : $self->paystart_month;
2957 my $paystart_year = exists($options{'paystart_year'})
2958 ? $options{'paystart_year'}
2959 : $self->paystart_year;
2961 $content{card_start} = "$paystart_month/$paystart_year"
2962 if $paystart_month && $paystart_year;
2964 my $payissue = exists($options{'payissue'})
2965 ? $options{'payissue'}
2967 $content{issue_number} = $payissue if $payissue;
2969 $content{recurring_billing} = 'YES'
2970 if qsearch('cust_pay', { 'custnum' => $self->custnum,
2972 'payinfo' => $payinfo,
2974 || qsearch('cust_pay', { 'custnum' => $self->custnum,
2976 'paymask' => $self->mask_payinfo('CARD', $payinfo),
2980 } elsif ( $method eq 'ECHECK' ) {
2981 ( $content{account_number}, $content{routing_code} ) =
2982 split('@', $payinfo);
2983 $content{bank_name} = $o_payname;
2984 $content{bank_state} = exists($options{'paystate'})
2985 ? $options{'paystate'}
2986 : $self->getfield('paystate');
2987 $content{account_type} = exists($options{'paytype'})
2988 ? uc($options{'paytype'}) || 'CHECKING'
2989 : uc($self->getfield('paytype')) || 'CHECKING';
2990 $content{account_name} = $payname;
2991 $content{customer_org} = $self->company ? 'B' : 'I';
2992 $content{state_id} = exists($options{'stateid'})
2993 ? $options{'stateid'}
2994 : $self->getfield('stateid');
2995 $content{state_id_state} = exists($options{'stateid_state'})
2996 ? $options{'stateid_state'}
2997 : $self->getfield('stateid_state');
2998 $content{customer_ssn} = exists($options{'ss'})
3001 } elsif ( $method eq 'LEC' ) {
3002 $content{phone} = $payinfo;
3006 # run transaction(s)
3009 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3011 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3012 $transaction->content(
3015 'password' => $password,
3016 'action' => $action1,
3017 'description' => $options{'description'},
3018 'amount' => $amount,
3019 #'invoice_number' => $options{'invnum'},
3020 'customer_id' => $self->custnum,
3021 'last_name' => $paylast,
3022 'first_name' => $payfirst,
3024 'address' => $address,
3025 'city' => ( exists($options{'city'})
3028 'state' => ( exists($options{'state'})
3031 'zip' => ( exists($options{'zip'})
3034 'country' => ( exists($options{'country'})
3035 ? $options{'country'}
3037 'referer' => 'http://cleanwhisker.420.am/',
3039 'phone' => $self->daytime || $self->night,
3042 $transaction->submit();
3044 if ( $transaction->is_success() && $action2 ) {
3045 my $auth = $transaction->authorization;
3046 my $ordernum = $transaction->can('order_number')
3047 ? $transaction->order_number
3051 new Business::OnlinePayment( $processor, @bop_options );
3058 password => $password,
3059 order_number => $ordernum,
3061 authorization => $auth,
3062 description => $options{'description'},
3065 foreach my $field (qw( authorization_source_code returned_ACI
3066 transaction_identifier validation_code
3067 transaction_sequence_num local_transaction_date
3068 local_transaction_time AVS_result_code )) {
3069 $capture{$field} = $transaction->$field() if $transaction->can($field);
3072 $capture->content( %capture );
3076 unless ( $capture->is_success ) {
3077 my $e = "Authorization successful but capture failed, custnum #".
3078 $self->custnum. ': '. $capture->result_code.
3079 ": ". $capture->error_message;
3087 # remove paycvv after initial transaction
3090 #false laziness w/misc/process/payment.cgi - check both to make sure working
3092 if ( defined $self->dbdef_table->column('paycvv')
3093 && length($self->paycvv)
3094 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3096 my $error = $self->remove_cvv;
3098 warn "WARNING: error removing cvv: $error\n";
3106 if ( $transaction->is_success() ) {
3108 my %method2payby = (
3115 if ( $payment_gateway ) { # agent override
3116 $paybatch = $payment_gateway->gatewaynum. '-';
3119 $paybatch .= "$processor:". $transaction->authorization;
3121 $paybatch .= ':'. $transaction->order_number
3122 if $transaction->can('order_number')
3123 && length($transaction->order_number);
3125 my $cust_pay = new FS::cust_pay ( {
3126 'custnum' => $self->custnum,
3127 'invnum' => $options{'invnum'},
3130 'payby' => $method2payby{$method},
3131 'payinfo' => $payinfo,
3132 'paybatch' => $paybatch,
3133 'paydate' => $paydate,
3135 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3137 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3140 $cust_pay->invnum(''); #try again with no specific invnum
3141 my $error2 = $cust_pay->insert( $options{'manual'} ?
3142 ( 'manual' => 1 ) : ()
3145 # gah, even with transactions.
3146 my $e = 'WARNING: Card/ACH debited but database not updated - '.
3147 "error inserting payment ($processor): $error2".
3148 " (previously tried insert with invnum #$options{'invnum'}" .
3154 return ''; #no error
3158 my $perror = "$processor error: ". $transaction->error_message;
3160 unless ( $transaction->error_message ) {
3163 if ( $transaction->can('response_page') ) {
3165 'page' => ( $transaction->can('response_page')
3166 ? $transaction->response_page
3169 'code' => ( $transaction->can('response_code')
3170 ? $transaction->response_code
3173 'headers' => ( $transaction->can('response_headers')
3174 ? $transaction->response_headers
3180 "No additional debugging information available for $processor";
3183 $perror .= "No error_message returned from $processor -- ".
3184 ( ref($t_response) ? Dumper($t_response) : $t_response );
3188 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3189 && $conf->exists('emaildecline')
3190 && grep { $_ ne 'POST' } $self->invoicing_list
3191 && ! grep { $transaction->error_message =~ /$_/ }
3192 $conf->config('emaildecline-exclude')
3194 my @templ = $conf->config('declinetemplate');
3195 my $template = new Text::Template (
3197 SOURCE => [ map "$_\n", @templ ],
3198 ) or return "($perror) can't create template: $Text::Template::ERROR";
3199 $template->compile()
3200 or return "($perror) can't compile template: $Text::Template::ERROR";
3202 my $templ_hash = { error => $transaction->error_message };
3204 my $error = send_email(
3205 'from' => $conf->config('invoice_from'),
3206 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3207 'subject' => 'Your payment could not be processed',
3208 'body' => [ $template->fill_in(HASH => $templ_hash) ],
3211 $perror .= " (also received error sending decline notification: $error)"
3221 =item default_payment_gateway
3225 sub default_payment_gateway {
3226 my( $self, $method ) = @_;
3228 die "Real-time processing not enabled\n"
3229 unless $conf->exists('business-onlinepayment');
3232 my $bop_config = 'business-onlinepayment';
3233 $bop_config .= '-ach'
3234 if $method eq 'ECHECK' && $conf->exists($bop_config. '-ach');
3235 my ( $processor, $login, $password, $action, @bop_options ) =
3236 $conf->config($bop_config);
3237 $action ||= 'normal authorization';
3238 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3239 die "No real-time processor is enabled - ".
3240 "did you set the business-onlinepayment configuration value?\n"
3243 ( $processor, $login, $password, $action, @bop_options )
3248 Removes the I<paycvv> field from the database directly.
3250 If there is an error, returns the error, otherwise returns false.
3256 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3257 or return dbh->errstr;
3258 $sth->execute($self->custnum)
3259 or return $sth->errstr;
3264 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3266 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3267 via a Business::OnlinePayment realtime gateway. See
3268 L<http://420.am/business-onlinepayment> for supported gateways.
3270 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3272 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3274 Most gateways require a reference to an original payment transaction to refund,
3275 so you probably need to specify a I<paynum>.
3277 I<amount> defaults to the original amount of the payment if not specified.
3279 I<reason> specifies a reason for the refund.
3281 I<paydate> specifies the expiration date for a credit card overriding the
3282 value from the customer record or the payment record. Specified as yyyy-mm-dd
3284 Implementation note: If I<amount> is unspecified or equal to the amount of the
3285 orignal payment, first an attempt is made to "void" the transaction via
3286 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3287 the normal attempt is made to "refund" ("credit") the transaction via the
3288 gateway is attempted.
3290 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3291 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3292 #if set, will override the value from the customer record.
3294 #If an I<invnum> is specified, this payment (if successful) is applied to the
3295 #specified invoice. If you don't specify an I<invnum> you might want to
3296 #call the B<apply_payments> method.
3300 #some false laziness w/realtime_bop, not enough to make it worth merging
3301 #but some useful small subs should be pulled out
3302 sub realtime_refund_bop {
3303 my( $self, $method, %options ) = @_;
3305 warn "$me realtime_refund_bop: $method refund\n";
3306 warn " $_ => $options{$_}\n" foreach keys %options;
3309 eval "use Business::OnlinePayment";
3313 # look up the original payment and optionally a gateway for that payment
3317 my $amount = $options{'amount'};
3319 my( $processor, $login, $password, @bop_options ) ;
3320 my( $auth, $order_number ) = ( '', '', '' );
3322 if ( $options{'paynum'} ) {
3324 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
3325 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3326 or return "Unknown paynum $options{'paynum'}";
3327 $amount ||= $cust_pay->paid;
3329 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3330 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3331 $cust_pay->paybatch;
3332 my $gatewaynum = '';
3333 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3335 if ( $gatewaynum ) { #gateway for the payment to be refunded
3337 my $payment_gateway =
3338 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3339 die "payment gateway $gatewaynum not found"
3340 unless $payment_gateway;
3342 $processor = $payment_gateway->gateway_module;
3343 $login = $payment_gateway->gateway_username;
3344 $password = $payment_gateway->gateway_password;
3345 @bop_options = $payment_gateway->options;
3347 } else { #try the default gateway
3349 my( $conf_processor, $unused_action );
3350 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3351 $self->default_payment_gateway($method);
3353 return "processor of payment $options{'paynum'} $processor does not".
3354 " match default processor $conf_processor"
3355 unless $processor eq $conf_processor;
3360 } else { # didn't specify a paynum, so look for agent gateway overrides
3361 # like a normal transaction
3364 if ( $method eq 'CC' ) {
3365 $cardtype = cardtype($self->payinfo);
3366 } elsif ( $method eq 'ECHECK' ) {
3369 $cardtype = $method;
3372 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3373 cardtype => $cardtype,
3375 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3377 taxclass => '', } );
3379 if ( $override ) { #use a payment gateway override
3381 my $payment_gateway = $override->payment_gateway;
3383 $processor = $payment_gateway->gateway_module;
3384 $login = $payment_gateway->gateway_username;
3385 $password = $payment_gateway->gateway_password;
3386 #$action = $payment_gateway->gateway_action;
3387 @bop_options = $payment_gateway->options;
3389 } else { #use the standard settings from the config
3392 ( $processor, $login, $password, $unused_action, @bop_options ) =
3393 $self->default_payment_gateway($method);
3398 return "neither amount nor paynum specified" unless $amount;
3403 'password' => $password,
3404 'order_number' => $order_number,
3405 'amount' => $amount,
3406 'referer' => 'http://cleanwhisker.420.am/',
3408 $content{authorization} = $auth
3409 if length($auth); #echeck/ACH transactions have an order # but no auth
3410 #(at least with authorize.net)
3412 my $disable_void_after;
3413 if ($conf->exists('disable_void_after')
3414 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3415 $disable_void_after = $1;
3418 #first try void if applicable
3419 if ( $cust_pay && $cust_pay->paid == $amount
3421 ( not defined($disable_void_after) )
3422 || ( time < ($cust_pay->_date + $disable_void_after ) )
3425 warn " attempting void\n" if $DEBUG > 1;
3426 my $void = new Business::OnlinePayment( $processor, @bop_options );
3427 $void->content( 'action' => 'void', %content );
3429 if ( $void->is_success ) {
3430 my $error = $cust_pay->void($options{'reason'});
3432 # gah, even with transactions.
3433 my $e = 'WARNING: Card/ACH voided but database not updated - '.
3434 "error voiding payment: $error";
3438 warn " void successful\n" if $DEBUG > 1;
3443 warn " void unsuccessful, trying refund\n"
3447 my $address = $self->address1;
3448 $address .= ", ". $self->address2 if $self->address2;
3450 my($payname, $payfirst, $paylast);
3451 if ( $self->payname && $method ne 'ECHECK' ) {
3452 $payname = $self->payname;
3453 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3454 or return "Illegal payname $payname";
3455 ($payfirst, $paylast) = ($1, $2);
3457 $payfirst = $self->getfield('first');
3458 $paylast = $self->getfield('last');
3459 $payname = "$payfirst $paylast";
3462 my @invoicing_list = $self->invoicing_list_emailonly;
3463 if ( $conf->exists('emailinvoiceautoalways')
3464 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3465 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3466 push @invoicing_list, $self->all_emails;
3469 my $email = ($conf->exists('business-onlinepayment-email-override'))
3470 ? $conf->config('business-onlinepayment-email-override')
3471 : $invoicing_list[0];
3473 my $payip = exists($options{'payip'})
3476 $content{customer_ip} = $payip
3480 if ( $method eq 'CC' ) {
3483 $content{card_number} = $payinfo = $cust_pay->payinfo;
3484 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3485 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3486 ($content{expiration} = "$2/$1"); # where available
3488 $content{card_number} = $payinfo = $self->payinfo;
3489 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3490 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3491 $content{expiration} = "$2/$1";
3494 } elsif ( $method eq 'ECHECK' ) {
3497 $payinfo = $cust_pay->payinfo;
3499 $payinfo = $self->payinfo;
3501 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3502 $content{bank_name} = $self->payname;
3503 $content{account_type} = 'CHECKING';
3504 $content{account_name} = $payname;
3505 $content{customer_org} = $self->company ? 'B' : 'I';
3506 $content{customer_ssn} = $self->ss;
3507 } elsif ( $method eq 'LEC' ) {
3508 $content{phone} = $payinfo = $self->payinfo;
3512 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3513 my %sub_content = $refund->content(
3514 'action' => 'credit',
3515 'customer_id' => $self->custnum,
3516 'last_name' => $paylast,
3517 'first_name' => $payfirst,
3519 'address' => $address,
3520 'city' => $self->city,
3521 'state' => $self->state,
3522 'zip' => $self->zip,
3523 'country' => $self->country,
3525 'phone' => $self->daytime || $self->night,
3528 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3532 return "$processor error: ". $refund->error_message
3533 unless $refund->is_success();
3535 my %method2payby = (
3541 my $paybatch = "$processor:". $refund->authorization;
3542 $paybatch .= ':'. $refund->order_number
3543 if $refund->can('order_number') && $refund->order_number;
3545 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3546 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3547 last unless @cust_bill_pay;
3548 my $cust_bill_pay = pop @cust_bill_pay;
3549 my $error = $cust_bill_pay->delete;
3553 my $cust_refund = new FS::cust_refund ( {
3554 'custnum' => $self->custnum,
3555 'paynum' => $options{'paynum'},
3556 'refund' => $amount,
3558 'payby' => $method2payby{$method},
3559 'payinfo' => $payinfo,
3560 'paybatch' => $paybatch,
3561 'reason' => $options{'reason'} || 'card or ACH refund',
3563 my $error = $cust_refund->insert;
3565 $cust_refund->paynum(''); #try again with no specific paynum
3566 my $error2 = $cust_refund->insert;
3568 # gah, even with transactions.
3569 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3570 "error inserting refund ($processor): $error2".
3571 " (previously tried insert with paynum #$options{'paynum'}" .
3582 =item batch_card OPTION => VALUE...
3584 Adds a payment for this invoice to the pending credit card batch (see
3585 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3586 runs the payment using a realtime gateway.
3591 my ($self, %options) = @_;
3594 if (exists($options{amount})) {
3595 $amount = $options{amount};
3597 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3599 return '' unless $amount > 0;
3601 my $invnum = delete $options{invnum};
3602 my $payby = $options{invnum} || $self->payby; #dubious
3604 if ($options{'realtime'}) {
3605 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3611 my $oldAutoCommit = $FS::UID::AutoCommit;
3612 local $FS::UID::AutoCommit = 0;
3615 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3616 or return "Cannot lock pay_batch: " . $dbh->errstr;
3620 'payby' => FS::payby->payby2payment($payby),
3623 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3625 unless ( $pay_batch ) {
3626 $pay_batch = new FS::pay_batch \%pay_batch;
3627 my $error = $pay_batch->insert;
3629 $dbh->rollback if $oldAutoCommit;
3630 die "error creating new batch: $error\n";
3634 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3635 'batchnum' => $pay_batch->batchnum,
3636 'custnum' => $self->custnum,
3639 foreach (qw( address1 address2 city state zip country payby payinfo paydate
3641 $options{$_} = '' unless exists($options{$_});
3644 my $cust_pay_batch = new FS::cust_pay_batch ( {
3645 'batchnum' => $pay_batch->batchnum,
3646 'invnum' => $invnum || 0, # is there a better value?
3647 # this field should be
3649 # cust_bill_pay_batch now
3650 'custnum' => $self->custnum,
3651 'last' => $self->getfield('last'),
3652 'first' => $self->getfield('first'),
3653 'address1' => $options{address1} || $self->address1,
3654 'address2' => $options{address2} || $self->address2,
3655 'city' => $options{city} || $self->city,
3656 'state' => $options{state} || $self->state,
3657 'zip' => $options{zip} || $self->zip,
3658 'country' => $options{country} || $self->country,
3659 'payby' => $options{payby} || $self->payby,
3660 'payinfo' => $options{payinfo} || $self->payinfo,
3661 'exp' => $options{paydate} || $self->paydate,
3662 'payname' => $options{payname} || $self->payname,
3663 'amount' => $amount, # consolidating
3666 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
3667 if $old_cust_pay_batch;
3670 if ($old_cust_pay_batch) {
3671 $error = $cust_pay_batch->replace($old_cust_pay_batch)
3673 $error = $cust_pay_batch->insert;
3677 $dbh->rollback if $oldAutoCommit;
3681 my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
3682 foreach my $cust_bill ($self->open_cust_bill) {
3683 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
3684 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
3685 'invnum' => $cust_bill->invnum,
3686 'paybatchnum' => $cust_pay_batch->paybatchnum,
3687 'amount' => $cust_bill->owed,
3690 if ($unapplied >= $cust_bill_pay_batch->amount){
3691 $unapplied -= $cust_bill_pay_batch->amount;
3694 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
3695 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
3697 $error = $cust_bill_pay_batch->insert;
3699 $dbh->rollback if $oldAutoCommit;
3704 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3710 Returns the total owed for this customer on all invoices
3711 (see L<FS::cust_bill/owed>).
3717 $self->total_owed_date(2145859200); #12/31/2037
3720 =item total_owed_date TIME
3722 Returns the total owed for this customer on all invoices with date earlier than
3723 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
3724 see L<Time::Local> and L<Date::Parse> for conversion functions.
3728 sub total_owed_date {
3732 foreach my $cust_bill (
3733 grep { $_->_date <= $time }
3734 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3736 $total_bill += $cust_bill->owed;
3738 sprintf( "%.2f", $total_bill );
3741 =item apply_payments_and_credits
3743 Applies unapplied payments and credits.
3745 In most cases, this new method should be used in place of sequential
3746 apply_payments and apply_credits methods.
3748 If there is an error, returns the error, otherwise returns false.
3752 sub apply_payments_and_credits {
3755 local $SIG{HUP} = 'IGNORE';
3756 local $SIG{INT} = 'IGNORE';
3757 local $SIG{QUIT} = 'IGNORE';
3758 local $SIG{TERM} = 'IGNORE';
3759 local $SIG{TSTP} = 'IGNORE';
3760 local $SIG{PIPE} = 'IGNORE';
3762 my $oldAutoCommit = $FS::UID::AutoCommit;
3763 local $FS::UID::AutoCommit = 0;
3766 $self->select_for_update; #mutex
3768 foreach my $cust_bill ( $self->open_cust_bill ) {
3769 my $error = $cust_bill->apply_payments_and_credits;
3771 $dbh->rollback if $oldAutoCommit;
3772 return "Error applying: $error";
3776 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3781 =item apply_credits OPTION => VALUE ...
3783 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3784 to outstanding invoice balances in chronological order (or reverse
3785 chronological order if the I<order> option is set to B<newest>) and returns the
3786 value of any remaining unapplied credits available for refund (see
3787 L<FS::cust_refund>).
3789 Dies if there is an error.
3797 local $SIG{HUP} = 'IGNORE';
3798 local $SIG{INT} = 'IGNORE';
3799 local $SIG{QUIT} = 'IGNORE';
3800 local $SIG{TERM} = 'IGNORE';
3801 local $SIG{TSTP} = 'IGNORE';
3802 local $SIG{PIPE} = 'IGNORE';
3804 my $oldAutoCommit = $FS::UID::AutoCommit;
3805 local $FS::UID::AutoCommit = 0;
3808 $self->select_for_update; #mutex
3810 unless ( $self->total_credited ) {
3811 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3815 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3816 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3818 my @invoices = $self->open_cust_bill;
3819 @invoices = sort { $b->_date <=> $a->_date } @invoices
3820 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3823 foreach my $cust_bill ( @invoices ) {
3826 if ( !defined($credit) || $credit->credited == 0) {
3827 $credit = pop @credits or last;
3830 if ($cust_bill->owed >= $credit->credited) {
3831 $amount=$credit->credited;
3833 $amount=$cust_bill->owed;
3836 my $cust_credit_bill = new FS::cust_credit_bill ( {
3837 'crednum' => $credit->crednum,
3838 'invnum' => $cust_bill->invnum,
3839 'amount' => $amount,
3841 my $error = $cust_credit_bill->insert;
3843 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3847 redo if ($cust_bill->owed > 0);
3851 my $total_credited = $self->total_credited;
3853 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3855 return $total_credited;
3858 =item apply_payments
3860 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3861 to outstanding invoice balances in chronological order.
3863 #and returns the value of any remaining unapplied payments.
3865 Dies if there is an error.
3869 sub apply_payments {
3872 local $SIG{HUP} = 'IGNORE';
3873 local $SIG{INT} = 'IGNORE';
3874 local $SIG{QUIT} = 'IGNORE';
3875 local $SIG{TERM} = 'IGNORE';
3876 local $SIG{TSTP} = 'IGNORE';
3877 local $SIG{PIPE} = 'IGNORE';
3879 my $oldAutoCommit = $FS::UID::AutoCommit;
3880 local $FS::UID::AutoCommit = 0;
3883 $self->select_for_update; #mutex
3887 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3888 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3890 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3891 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3895 foreach my $cust_bill ( @invoices ) {
3898 if ( !defined($payment) || $payment->unapplied == 0 ) {
3899 $payment = pop @payments or last;
3902 if ( $cust_bill->owed >= $payment->unapplied ) {
3903 $amount = $payment->unapplied;
3905 $amount = $cust_bill->owed;
3908 my $cust_bill_pay = new FS::cust_bill_pay ( {
3909 'paynum' => $payment->paynum,
3910 'invnum' => $cust_bill->invnum,
3911 'amount' => $amount,
3913 my $error = $cust_bill_pay->insert;
3915 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3919 redo if ( $cust_bill->owed > 0);
3923 my $total_unapplied_payments = $self->total_unapplied_payments;
3925 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3927 return $total_unapplied_payments;
3930 =item total_credited
3932 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3933 customer. See L<FS::cust_credit/credited>.
3937 sub total_credited {
3939 my $total_credit = 0;
3940 foreach my $cust_credit ( qsearch('cust_credit', {
3941 'custnum' => $self->custnum,
3943 $total_credit += $cust_credit->credited;
3945 sprintf( "%.2f", $total_credit );
3948 =item total_unapplied_payments
3950 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3951 See L<FS::cust_pay/unapplied>.
3955 sub total_unapplied_payments {
3957 my $total_unapplied = 0;
3958 foreach my $cust_pay ( qsearch('cust_pay', {
3959 'custnum' => $self->custnum,
3961 $total_unapplied += $cust_pay->unapplied;
3963 sprintf( "%.2f", $total_unapplied );
3966 =item total_unapplied_refunds
3968 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
3969 customer. See L<FS::cust_refund/unapplied>.
3973 sub total_unapplied_refunds {
3975 my $total_unapplied = 0;
3976 foreach my $cust_refund ( qsearch('cust_refund', {
3977 'custnum' => $self->custnum,
3979 $total_unapplied += $cust_refund->unapplied;
3981 sprintf( "%.2f", $total_unapplied );
3986 Returns the balance for this customer (total_owed plus total_unrefunded, minus
3987 total_credited minus total_unapplied_payments).
3995 + $self->total_unapplied_refunds
3996 - $self->total_credited
3997 - $self->total_unapplied_payments
4001 =item balance_date TIME
4003 Returns the balance for this customer, only considering invoices with date
4004 earlier than TIME (total_owed_date minus total_credited minus
4005 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
4006 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
4015 $self->total_owed_date($time)
4016 + $self->total_unapplied_refunds
4017 - $self->total_credited
4018 - $self->total_unapplied_payments
4022 =item in_transit_payments
4024 Returns the total of requests for payments for this customer pending in
4025 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
4029 sub in_transit_payments {
4031 my $in_transit_payments = 0;
4032 foreach my $pay_batch ( qsearch('pay_batch', {
4035 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4036 'batchnum' => $pay_batch->batchnum,
4037 'custnum' => $self->custnum,
4039 $in_transit_payments += $cust_pay_batch->amount;
4042 sprintf( "%.2f", $in_transit_payments );
4045 =item paydate_monthyear
4047 Returns a two-element list consisting of the month and year of this customer's
4048 paydate (credit card expiration date for CARD customers)
4052 sub paydate_monthyear {
4054 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4056 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4063 =item invoicing_list [ ARRAYREF ]
4065 If an arguement is given, sets these email addresses as invoice recipients
4066 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
4067 (except as warnings), so use check_invoicing_list first.
4069 Returns a list of email addresses (with svcnum entries expanded).
4071 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
4072 check it without disturbing anything by passing nothing.
4074 This interface may change in the future.
4078 sub invoicing_list {
4079 my( $self, $arrayref ) = @_;
4082 my @cust_main_invoice;
4083 if ( $self->custnum ) {
4084 @cust_main_invoice =
4085 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4087 @cust_main_invoice = ();
4089 foreach my $cust_main_invoice ( @cust_main_invoice ) {
4090 #warn $cust_main_invoice->destnum;
4091 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4092 #warn $cust_main_invoice->destnum;
4093 my $error = $cust_main_invoice->delete;
4094 warn $error if $error;
4097 if ( $self->custnum ) {
4098 @cust_main_invoice =
4099 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4101 @cust_main_invoice = ();
4103 my %seen = map { $_->address => 1 } @cust_main_invoice;
4104 foreach my $address ( @{$arrayref} ) {
4105 next if exists $seen{$address} && $seen{$address};
4106 $seen{$address} = 1;
4107 my $cust_main_invoice = new FS::cust_main_invoice ( {
4108 'custnum' => $self->custnum,
4111 my $error = $cust_main_invoice->insert;
4112 warn $error if $error;
4116 if ( $self->custnum ) {
4118 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4125 =item check_invoicing_list ARRAYREF
4127 Checks these arguements as valid input for the invoicing_list method. If there
4128 is an error, returns the error, otherwise returns false.
4132 sub check_invoicing_list {
4133 my( $self, $arrayref ) = @_;
4134 foreach my $address ( @{$arrayref} ) {
4136 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4137 return 'Can\'t add FAX invoice destination with a blank FAX number.';
4140 my $cust_main_invoice = new FS::cust_main_invoice ( {
4141 'custnum' => $self->custnum,
4144 my $error = $self->custnum
4145 ? $cust_main_invoice->check
4146 : $cust_main_invoice->checkdest
4148 return $error if $error;
4153 =item set_default_invoicing_list
4155 Sets the invoicing list to all accounts associated with this customer,
4156 overwriting any previous invoicing list.
4160 sub set_default_invoicing_list {
4162 $self->invoicing_list($self->all_emails);
4167 Returns the email addresses of all accounts provisioned for this customer.
4174 foreach my $cust_pkg ( $self->all_pkgs ) {
4175 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4177 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4178 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4180 $list{$_}=1 foreach map { $_->email } @svc_acct;
4185 =item invoicing_list_addpost
4187 Adds postal invoicing to this customer. If this customer is already configured
4188 to receive postal invoices, does nothing.
4192 sub invoicing_list_addpost {
4194 return if grep { $_ eq 'POST' } $self->invoicing_list;
4195 my @invoicing_list = $self->invoicing_list;
4196 push @invoicing_list, 'POST';
4197 $self->invoicing_list(\@invoicing_list);
4200 =item invoicing_list_emailonly
4202 Returns the list of email invoice recipients (invoicing_list without non-email
4203 destinations such as POST and FAX).
4207 sub invoicing_list_emailonly {
4209 warn "$me invoicing_list_emailonly called"
4211 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4214 =item invoicing_list_emailonly_scalar
4216 Returns the list of email invoice recipients (invoicing_list without non-email
4217 destinations such as POST and FAX) as a comma-separated scalar.
4221 sub invoicing_list_emailonly_scalar {
4223 warn "$me invoicing_list_emailonly_scalar called"
4225 join(', ', $self->invoicing_list_emailonly);
4228 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4230 Returns an array of customers referred by this customer (referral_custnum set
4231 to this custnum). If DEPTH is given, recurses up to the given depth, returning
4232 customers referred by customers referred by this customer and so on, inclusive.
4233 The default behavior is DEPTH 1 (no recursion).
4237 sub referral_cust_main {
4239 my $depth = @_ ? shift : 1;
4240 my $exclude = @_ ? shift : {};
4243 map { $exclude->{$_->custnum}++; $_; }
4244 grep { ! $exclude->{ $_->custnum } }
4245 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4249 map { $_->referral_cust_main($depth-1, $exclude) }
4256 =item referral_cust_main_ncancelled
4258 Same as referral_cust_main, except only returns customers with uncancelled
4263 sub referral_cust_main_ncancelled {
4265 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4268 =item referral_cust_pkg [ DEPTH ]
4270 Like referral_cust_main, except returns a flat list of all unsuspended (and
4271 uncancelled) packages for each customer. The number of items in this list may
4272 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4276 sub referral_cust_pkg {
4278 my $depth = @_ ? shift : 1;
4280 map { $_->unsuspended_pkgs }
4281 grep { $_->unsuspended_pkgs }
4282 $self->referral_cust_main($depth);
4285 =item referring_cust_main
4287 Returns the single cust_main record for the customer who referred this customer
4288 (referral_custnum), or false.
4292 sub referring_cust_main {
4294 return '' unless $self->referral_custnum;
4295 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4298 =item credit AMOUNT, REASON
4300 Applies a credit to this customer. If there is an error, returns the error,
4301 otherwise returns false.
4306 my( $self, $amount, $reason ) = @_;
4307 my $cust_credit = new FS::cust_credit {
4308 'custnum' => $self->custnum,
4309 'amount' => $amount,
4310 'reason' => $reason,
4312 $cust_credit->insert;
4315 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4317 Creates a one-time charge for this customer. If there is an error, returns
4318 the error, otherwise returns false.
4324 my ( $amount, $pkg, $comment, $taxclass, $additional );
4325 if ( ref( $_[0] ) ) {
4326 $amount = $_[0]->{amount};
4327 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4328 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
4329 : '$'. sprintf("%.2f",$amount);
4330 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4331 $additional = $_[0]->{additional};
4334 $pkg = @_ ? shift : 'One-time charge';
4335 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
4336 $taxclass = @_ ? shift : '';
4340 local $SIG{HUP} = 'IGNORE';
4341 local $SIG{INT} = 'IGNORE';
4342 local $SIG{QUIT} = 'IGNORE';
4343 local $SIG{TERM} = 'IGNORE';
4344 local $SIG{TSTP} = 'IGNORE';
4345 local $SIG{PIPE} = 'IGNORE';
4347 my $oldAutoCommit = $FS::UID::AutoCommit;
4348 local $FS::UID::AutoCommit = 0;
4351 my $part_pkg = new FS::part_pkg ( {
4353 'comment' => $comment,
4357 'taxclass' => $taxclass,
4360 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4361 ( 0 .. @$additional - 1 )
4363 'additional_count' => scalar(@$additional),
4364 'setup_fee' => $amount,
4367 my $error = $part_pkg->insert( options => \%options );
4369 $dbh->rollback if $oldAutoCommit;
4373 my $pkgpart = $part_pkg->pkgpart;
4374 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4375 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4376 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4377 $error = $type_pkgs->insert;
4379 $dbh->rollback if $oldAutoCommit;
4384 my $cust_pkg = new FS::cust_pkg ( {
4385 'custnum' => $self->custnum,
4386 'pkgpart' => $pkgpart,
4389 $error = $cust_pkg->insert;
4391 $dbh->rollback if $oldAutoCommit;
4395 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4402 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4408 sort { $a->_date <=> $b->_date }
4409 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4412 =item open_cust_bill
4414 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4419 sub open_cust_bill {
4421 grep { $_->owed > 0 } $self->cust_bill;
4426 Returns all the credits (see L<FS::cust_credit>) for this customer.
4432 sort { $a->_date <=> $b->_date }
4433 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4438 Returns all the payments (see L<FS::cust_pay>) for this customer.
4444 sort { $a->_date <=> $b->_date }
4445 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4450 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4456 sort { $a->_date <=> $b->_date }
4457 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4460 =item cust_pay_batch
4462 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
4466 sub cust_pay_batch {
4468 sort { $a->_date <=> $b->_date }
4469 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
4474 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4480 sort { $a->_date <=> $b->_date }
4481 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4486 Returns a name string for this customer, either "Company (Last, First)" or
4493 my $name = $self->contact;
4494 $name = $self->company. " ($name)" if $self->company;
4500 Returns a name string for this (service/shipping) contact, either
4501 "Company (Last, First)" or "Last, First".
4507 if ( $self->get('ship_last') ) {
4508 my $name = $self->ship_contact;
4509 $name = $self->ship_company. " ($name)" if $self->ship_company;
4518 Returns this customer's full (billing) contact name only, "Last, First"
4524 $self->get('last'). ', '. $self->first;
4529 Returns this customer's full (shipping) contact name only, "Last, First"
4535 $self->get('ship_last')
4536 ? $self->get('ship_last'). ', '. $self->ship_first
4542 Returns this customer's full country name
4548 code2country($self->country);
4555 Returns a status string for this customer, currently:
4559 =item prospect - No packages have ever been ordered
4561 =item active - One or more recurring packages is active
4563 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4565 =item suspended - All non-cancelled recurring packages are suspended
4567 =item cancelled - All recurring packages are cancelled
4573 sub status { shift->cust_status(@_); }
4577 for my $status (qw( prospect active inactive suspended cancelled )) {
4578 my $method = $status.'_sql';
4579 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4580 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4581 $sth->execute( ($self->custnum) x $numnum )
4582 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4583 return $status if $sth->fetchrow_arrayref->[0];
4587 =item ucfirst_cust_status
4589 =item ucfirst_status
4591 Returns the status with the first character capitalized.
4595 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4597 sub ucfirst_cust_status {
4599 ucfirst($self->cust_status);
4604 Returns a hex triplet color string for this customer's status.
4608 use vars qw(%statuscolor);
4609 tie my %statuscolor, 'Tie::IxHash',
4610 'prospect' => '7e0079', #'000000', #black? naw, purple
4611 'active' => '00CC00', #green
4612 'inactive' => '0000CC', #blue
4613 'suspended' => 'FF9900', #yellow
4614 'cancelled' => 'FF0000', #red
4617 sub statuscolor { shift->cust_statuscolor(@_); }
4619 sub cust_statuscolor {
4621 $statuscolor{$self->cust_status};
4626 Returns an array of hashes representing the customer's RT tickets.
4633 my $num = $conf->config('cust_main-max_tickets') || 10;
4636 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4638 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4642 foreach my $priority (
4643 $conf->config('ticket_system-custom_priority_field-values'), ''
4645 last if scalar(@tickets) >= $num;
4647 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4648 $num - scalar(@tickets),
4657 # Return services representing svc_accts in customer support packages
4658 sub support_services {
4660 my %packages = map { $_ => 1 } $conf->config('support_packages');
4662 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4663 grep { $_->part_svc->svcdb eq 'svc_acct' }
4664 map { $_->cust_svc }
4665 grep { exists $packages{ $_->pkgpart } }
4666 $self->ncancelled_pkgs;
4672 =head1 CLASS METHODS
4678 Class method that returns the list of possible status strings for customers
4679 (see L<the status method|/status>). For example:
4681 @statuses = FS::cust_main->statuses();
4686 #my $self = shift; #could be class...
4692 Returns an SQL expression identifying prospective cust_main records (customers
4693 with no packages ever ordered)
4697 use vars qw($select_count_pkgs);
4698 $select_count_pkgs =
4699 "SELECT COUNT(*) FROM cust_pkg
4700 WHERE cust_pkg.custnum = cust_main.custnum";
4702 sub select_count_pkgs_sql {
4706 sub prospect_sql { "
4707 0 = ( $select_count_pkgs )
4712 Returns an SQL expression identifying active cust_main records (customers with
4713 no active recurring packages, but otherwise unsuspended/uncancelled).
4718 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
4724 Returns an SQL expression identifying inactive cust_main records (customers with
4725 active recurring packages).
4729 sub inactive_sql { "
4730 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4732 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
4738 Returns an SQL expression identifying suspended cust_main records.
4743 sub suspended_sql { susp_sql(@_); }
4745 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
4747 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4753 Returns an SQL expression identifying cancelled cust_main records.
4757 sub cancelled_sql { cancel_sql(@_); }
4760 my $recurring_sql = FS::cust_pkg->recurring_sql;
4761 #my $recurring_sql = "
4762 # '0' != ( select freq from part_pkg
4763 # where cust_pkg.pkgpart = part_pkg.pkgpart )
4767 0 < ( $select_count_pkgs )
4768 AND 0 = ( $select_count_pkgs AND $recurring_sql
4769 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4775 =item uncancelled_sql
4777 Returns an SQL expression identifying un-cancelled cust_main records.
4781 sub uncancelled_sql { uncancel_sql(@_); }
4782 sub uncancel_sql { "
4783 ( 0 < ( $select_count_pkgs
4784 AND ( cust_pkg.cancel IS NULL
4785 OR cust_pkg.cancel = 0
4788 OR 0 = ( $select_count_pkgs )
4794 Returns an SQL fragment to retreive the balance.
4799 COALESCE( ( SELECT SUM(charged) FROM cust_bill
4800 WHERE cust_bill.custnum = cust_main.custnum ), 0)
4801 - COALESCE( ( SELECT SUM(paid) FROM cust_pay
4802 WHERE cust_pay.custnum = cust_main.custnum ), 0)
4803 - COALESCE( ( SELECT SUM(amount) FROM cust_credit
4804 WHERE cust_credit.custnum = cust_main.custnum ), 0)
4805 + COALESCE( ( SELECT SUM(refund) FROM cust_refund
4806 WHERE cust_refund.custnum = cust_main.custnum ), 0)
4809 =item balance_date_sql TIME
4811 Returns an SQL fragment to retreive the balance for this customer, only
4812 considering invoices with date earlier than TIME. (total_owed_date minus total_credited minus
4813 total_unapplied_payments). TIME is specified as an SQL fragment or a numeric
4814 UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and
4815 L<Date::Parse> for conversion functions.
4819 sub balance_date_sql {
4820 my( $class, $time ) = @_;
4822 my $owed_sql = FS::cust_bill->owed_sql;
4823 my $unapp_refund_sql = FS::cust_refund->unapplied_sql;
4824 #my $unapp_credit_sql = FS::cust_credit->unapplied_sql;
4825 my $unapp_credit_sql = FS::cust_credit->credited_sql;
4826 my $unapp_pay_sql = FS::cust_pay->unapplied_sql;
4829 COALESCE( ( SELECT SUM($owed_sql) FROM cust_bill
4830 WHERE cust_bill.custnum = cust_main.custnum
4831 AND cust_bill._date <= $time )
4834 + COALESCE( ( SELECT SUM($unapp_refund_sql) FROM cust_refund
4835 WHERE cust_refund.custnum = cust_main.custnum )
4838 - COALESCE( ( SELECT SUM($unapp_credit_sql) FROM cust_credit
4839 WHERE cust_credit.custnum = cust_main.custnum )
4842 - COALESCE( ( SELECT SUM($unapp_pay_sql) FROM cust_pay
4843 WHERE cust_pay.custnum = cust_main.custnum )
4851 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
4853 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
4854 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
4855 appropriate ship_ field is also searched).
4857 Additional options are the same as FS::Record::qsearch
4862 my( $self, $fuzzy, $hash, @opt) = @_;
4867 check_and_rebuild_fuzzyfiles();
4868 foreach my $field ( keys %$fuzzy ) {
4870 my $all = $self->all_X($field);
4871 next unless scalar(@$all);
4874 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
4877 foreach ( keys %match ) {
4878 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
4879 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
4882 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4885 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4887 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4895 Returns a masked version of the named field
4900 my ($self,$field) = @_;
4904 'x'x(length($self->getfield($field))-4).
4905 substr($self->getfield($field), (length($self->getfield($field))-4));
4915 =item smart_search OPTION => VALUE ...
4917 Accepts the following options: I<search>, the string to search for. The string
4918 will be searched for as a customer number, phone number, name or company name,
4919 as an exact, or, in some cases, a substring or fuzzy match (see the source code
4920 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
4921 skip fuzzy matching when an exact match is found.
4923 Any additional options are treated as an additional qualifier on the search
4926 Returns a (possibly empty) array of FS::cust_main objects.
4933 #here is the agent virtualization
4934 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
4938 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
4939 my $search = delete $options{'search'};
4940 ( my $alphanum_search = $search ) =~ s/\W//g;
4942 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
4944 #false laziness w/Record::ut_phone
4945 my $phonen = "$1-$2-$3";
4946 $phonen .= " x$4" if $4;
4948 push @cust_main, qsearch( {
4949 'table' => 'cust_main',
4950 'hashref' => { %options },
4951 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4953 join(' OR ', map "$_ = '$phonen'",
4954 qw( daytime night fax
4955 ship_daytime ship_night ship_fax )
4958 " AND $agentnums_sql", #agent virtualization
4961 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
4962 #try looking for matches with extensions unless one was specified
4964 push @cust_main, qsearch( {
4965 'table' => 'cust_main',
4966 'hashref' => { %options },
4967 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4969 join(' OR ', map "$_ LIKE '$phonen\%'",
4971 ship_daytime ship_night )
4974 " AND $agentnums_sql", #agent virtualization
4979 } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
4981 push @cust_main, qsearch( {
4982 'table' => 'cust_main',
4983 'hashref' => { 'custnum' => $1, %options },
4984 'extra_sql' => " AND $agentnums_sql", #agent virtualization
4987 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
4989 my($company, $last, $first) = ( $1, $2, $3 );
4991 # "Company (Last, First)"
4992 #this is probably something a browser remembered,
4993 #so just do an exact search
4995 foreach my $prefix ( '', 'ship_' ) {
4996 push @cust_main, qsearch( {
4997 'table' => 'cust_main',
4998 'hashref' => { $prefix.'first' => $first,
4999 $prefix.'last' => $last,
5000 $prefix.'company' => $company,
5003 'extra_sql' => " AND $agentnums_sql",
5007 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
5008 # try (ship_){last,company}
5012 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
5013 # # full strings the browser remembers won't work
5014 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
5016 use Lingua::EN::NameParse;
5017 my $NameParse = new Lingua::EN::NameParse(
5019 allow_reversed => 1,
5022 my($last, $first) = ( '', '' );
5023 #maybe disable this too and just rely on NameParse?
5024 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
5026 ($last, $first) = ( $1, $2 );
5028 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
5029 } elsif ( ! $NameParse->parse($value) ) {
5031 my %name = $NameParse->components;
5032 $first = $name{'given_name_1'};
5033 $last = $name{'surname_1'};
5037 if ( $first && $last ) {
5039 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
5042 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5044 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
5045 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
5048 push @cust_main, qsearch( {
5049 'table' => 'cust_main',
5050 'hashref' => \%options,
5051 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5054 # or it just be something that was typed in... (try that in a sec)
5058 my $q_value = dbh->quote($value);
5061 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5062 $sql .= " ( LOWER(last) = $q_value
5063 OR LOWER(company) = $q_value
5064 OR LOWER(ship_last) = $q_value
5065 OR LOWER(ship_company) = $q_value
5068 push @cust_main, qsearch( {
5069 'table' => 'cust_main',
5070 'hashref' => \%options,
5071 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5074 #no exact match, trying substring/fuzzy
5075 #always do substring & fuzzy (unless they're explicity config'ed off)
5076 #getting complaints searches are not returning enough
5077 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
5079 #still some false laziness w/ search/cust_main.cgi
5084 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
5085 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
5088 if ( $first && $last ) {
5091 { 'first' => { op=>'ILIKE', value=>"%$first%" },
5092 'last' => { op=>'ILIKE', value=>"%$last%" },
5094 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
5095 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
5102 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
5103 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
5107 foreach my $hashref ( @hashrefs ) {
5109 push @cust_main, qsearch( {
5110 'table' => 'cust_main',
5111 'hashref' => { %$hashref,
5114 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
5123 " AND $agentnums_sql", #extra_sql #agent virtualization
5126 if ( $first && $last ) {
5127 push @cust_main, FS::cust_main->fuzzy_search(
5128 { 'last' => $last, #fuzzy hashref
5129 'first' => $first }, #
5133 foreach my $field ( 'last', 'company' ) {
5135 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
5140 #eliminate duplicates
5142 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5150 =item check_and_rebuild_fuzzyfiles
5154 use vars qw(@fuzzyfields);
5155 @fuzzyfields = ( 'last', 'first', 'company' );
5157 sub check_and_rebuild_fuzzyfiles {
5158 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5159 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
5162 =item rebuild_fuzzyfiles
5166 sub rebuild_fuzzyfiles {
5168 use Fcntl qw(:flock);
5170 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5171 mkdir $dir, 0700 unless -d $dir;
5173 foreach my $fuzzy ( @fuzzyfields ) {
5175 open(LOCK,">>$dir/cust_main.$fuzzy")
5176 or die "can't open $dir/cust_main.$fuzzy: $!";
5178 or die "can't lock $dir/cust_main.$fuzzy: $!";
5180 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
5181 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
5183 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
5184 my $sth = dbh->prepare("SELECT $field FROM cust_main".
5185 " WHERE $field != '' AND $field IS NOT NULL");
5186 $sth->execute or die $sth->errstr;
5188 while ( my $row = $sth->fetchrow_arrayref ) {
5189 print CACHE $row->[0]. "\n";
5194 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
5196 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
5207 my( $self, $field ) = @_;
5208 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5209 open(CACHE,"<$dir/cust_main.$field")
5210 or die "can't open $dir/cust_main.$field: $!";
5211 my @array = map { chomp; $_; } <CACHE>;
5216 =item append_fuzzyfiles LASTNAME COMPANY
5220 sub append_fuzzyfiles {
5221 #my( $first, $last, $company ) = @_;
5223 &check_and_rebuild_fuzzyfiles;
5225 use Fcntl qw(:flock);
5227 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5229 foreach my $field (qw( first last company )) {
5234 open(CACHE,">>$dir/cust_main.$field")
5235 or die "can't open $dir/cust_main.$field: $!";
5236 flock(CACHE,LOCK_EX)
5237 or die "can't lock $dir/cust_main.$field: $!";
5239 print CACHE "$value\n";
5241 flock(CACHE,LOCK_UN)
5242 or die "can't unlock $dir/cust_main.$field: $!";
5257 #warn join('-',keys %$param);
5258 my $fh = $param->{filehandle};
5259 my $agentnum = $param->{agentnum};
5261 my $refnum = $param->{refnum};
5262 my $pkgpart = $param->{pkgpart};
5264 #my @fields = @{$param->{fields}};
5265 my $format = $param->{'format'};
5268 if ( $format eq 'simple' ) {
5269 @fields = qw( cust_pkg.setup dayphone first last
5270 address1 address2 city state zip comments );
5272 } elsif ( $format eq 'extended' ) {
5273 @fields = qw( agent_custid refnum
5274 last first address1 address2 city state zip country
5276 ship_last ship_first ship_address1 ship_address2
5277 ship_city ship_state ship_zip ship_country
5278 payinfo paycvv paydate
5281 svc_acct.username svc_acct._password
5285 die "unknown format $format";
5288 eval "use Text::CSV_XS;";
5291 my $csv = new Text::CSV_XS;
5298 local $SIG{HUP} = 'IGNORE';
5299 local $SIG{INT} = 'IGNORE';
5300 local $SIG{QUIT} = 'IGNORE';
5301 local $SIG{TERM} = 'IGNORE';
5302 local $SIG{TSTP} = 'IGNORE';
5303 local $SIG{PIPE} = 'IGNORE';
5305 my $oldAutoCommit = $FS::UID::AutoCommit;
5306 local $FS::UID::AutoCommit = 0;
5309 #while ( $columns = $csv->getline($fh) ) {
5311 while ( defined($line=<$fh>) ) {
5313 $csv->parse($line) or do {
5314 $dbh->rollback if $oldAutoCommit;
5315 return "can't parse: ". $csv->error_input();
5318 my @columns = $csv->fields();
5319 #warn join('-',@columns);
5322 agentnum => $agentnum,
5324 country => $conf->config('countrydefault') || 'US',
5325 payby => $payby, #default
5326 paydate => '12/2037', #default
5328 my $billtime = time;
5329 my %cust_pkg = ( pkgpart => $pkgpart );
5331 foreach my $field ( @fields ) {
5333 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
5335 #$cust_pkg{$1} = str2time( shift @$columns );
5336 if ( $1 eq 'pkgpart' ) {
5337 $cust_pkg{$1} = shift @columns;
5338 } elsif ( $1 eq 'setup' ) {
5339 $billtime = str2time(shift @columns);
5341 $cust_pkg{$1} = str2time( shift @columns );
5344 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
5346 $svc_acct{$1} = shift @columns;
5350 #refnum interception
5351 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
5353 my $referral = $columns[0];
5354 my %hash = ( 'referral' => $referral,
5355 'agentnum' => $agentnum,
5359 my $part_referral = qsearchs('part_referral', \%hash )
5360 || new FS::part_referral \%hash;
5362 unless ( $part_referral->refnum ) {
5363 my $error = $part_referral->insert;
5365 $dbh->rollback if $oldAutoCommit;
5366 return "can't auto-insert advertising source: $referral: $error";
5370 $columns[0] = $part_referral->refnum;
5373 #$cust_main{$field} = shift @$columns;
5374 $cust_main{$field} = shift @columns;
5378 $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
5380 my $invoicing_list = $cust_main{'invoicing_list'}
5381 ? [ delete $cust_main{'invoicing_list'} ]
5384 my $cust_main = new FS::cust_main ( \%cust_main );
5387 tie my %hash, 'Tie::RefHash'; #this part is important
5389 if ( $cust_pkg{'pkgpart'} ) {
5390 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
5393 if ( $svc_acct{'username'} ) {
5394 my $part_pkg = $cust_pkg->part_pkg;
5395 unless ( $part_pkg ) {
5396 $dbh->rollback if $oldAutoCommit;
5397 return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
5399 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
5400 push @svc_acct, new FS::svc_acct ( \%svc_acct )
5403 $hash{$cust_pkg} = \@svc_acct;
5406 my $error = $cust_main->insert( \%hash, $invoicing_list );
5409 $dbh->rollback if $oldAutoCommit;
5410 return "can't insert customer for $line: $error";
5413 if ( $format eq 'simple' ) {
5415 #false laziness w/bill.cgi
5416 $error = $cust_main->bill( 'time' => $billtime );
5418 $dbh->rollback if $oldAutoCommit;
5419 return "can't bill customer for $line: $error";
5422 $error = $cust_main->apply_payments_and_credits;
5424 $dbh->rollback if $oldAutoCommit;
5425 return "can't bill customer for $line: $error";
5428 $error = $cust_main->collect();
5430 $dbh->rollback if $oldAutoCommit;
5431 return "can't collect customer for $line: $error";
5439 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5441 return "Empty file!" unless $imported;
5453 #warn join('-',keys %$param);
5454 my $fh = $param->{filehandle};
5455 my @fields = @{$param->{fields}};
5457 eval "use Text::CSV_XS;";
5460 my $csv = new Text::CSV_XS;
5467 local $SIG{HUP} = 'IGNORE';
5468 local $SIG{INT} = 'IGNORE';
5469 local $SIG{QUIT} = 'IGNORE';
5470 local $SIG{TERM} = 'IGNORE';
5471 local $SIG{TSTP} = 'IGNORE';
5472 local $SIG{PIPE} = 'IGNORE';
5474 my $oldAutoCommit = $FS::UID::AutoCommit;
5475 local $FS::UID::AutoCommit = 0;
5478 #while ( $columns = $csv->getline($fh) ) {
5480 while ( defined($line=<$fh>) ) {
5482 $csv->parse($line) or do {
5483 $dbh->rollback if $oldAutoCommit;
5484 return "can't parse: ". $csv->error_input();
5487 my @columns = $csv->fields();
5488 #warn join('-',@columns);
5491 foreach my $field ( @fields ) {
5492 $row{$field} = shift @columns;
5495 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
5496 unless ( $cust_main ) {
5497 $dbh->rollback if $oldAutoCommit;
5498 return "unknown custnum $row{'custnum'}";
5501 if ( $row{'amount'} > 0 ) {
5502 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
5504 $dbh->rollback if $oldAutoCommit;
5508 } elsif ( $row{'amount'} < 0 ) {
5509 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
5512 $dbh->rollback if $oldAutoCommit;
5522 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5524 return "Empty file!" unless $imported;
5530 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5532 Sends a templated email notification to the customer (see L<Text::Template>).
5534 OPTIONS is a hash and may include
5536 I<from> - the email sender (default is invoice_from)
5538 I<to> - comma-separated scalar or arrayref of recipients
5539 (default is invoicing_list)
5541 I<subject> - The subject line of the sent email notification
5542 (default is "Notice from company_name")
5544 I<extra_fields> - a hashref of name/value pairs which will be substituted
5547 The following variables are vavailable in the template.
5549 I<$first> - the customer first name
5550 I<$last> - the customer last name
5551 I<$company> - the customer company
5552 I<$payby> - a description of the method of payment for the customer
5553 # would be nice to use FS::payby::shortname
5554 I<$payinfo> - the account information used to collect for this customer
5555 I<$expdate> - the expiration of the customer payment in seconds from epoch
5560 my ($customer, $template, %options) = @_;
5562 return unless $conf->exists($template);
5564 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
5565 $from = $options{from} if exists($options{from});
5567 my $to = join(',', $customer->invoicing_list_emailonly);
5568 $to = $options{to} if exists($options{to});
5570 my $subject = "Notice from " . $conf->config('company_name')
5571 if $conf->exists('company_name');
5572 $subject = $options{subject} if exists($options{subject});
5574 my $notify_template = new Text::Template (TYPE => 'ARRAY',
5575 SOURCE => [ map "$_\n",
5576 $conf->config($template)]
5578 or die "can't create new Text::Template object: Text::Template::ERROR";
5579 $notify_template->compile()
5580 or die "can't compile template: Text::Template::ERROR";
5582 my $paydate = $customer->paydate;
5583 $FS::notify_template::_template::first = $customer->first;
5584 $FS::notify_template::_template::last = $customer->last;
5585 $FS::notify_template::_template::company = $customer->company;
5586 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
5587 my $payby = $customer->payby;
5588 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5589 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5591 #credit cards expire at the end of the month/year of their exp date
5592 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5593 $FS::notify_template::_template::payby = 'credit card';
5594 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5595 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5597 }elsif ($payby eq 'COMP') {
5598 $FS::notify_template::_template::payby = 'complimentary account';
5600 $FS::notify_template::_template::payby = 'current method';
5602 $FS::notify_template::_template::expdate = $expire_time;
5604 for (keys %{$options{extra_fields}}){
5606 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5609 send_email(from => $from,
5611 subject => $subject,
5612 body => $notify_template->fill_in( PACKAGE =>
5613 'FS::notify_template::_template' ),
5618 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5620 Generates a templated notification to the customer (see L<Text::Template>).
5622 OPTIONS is a hash and may include
5624 I<extra_fields> - a hashref of name/value pairs which will be substituted
5625 into the template. These values may override values mentioned below
5626 and those from the customer record.
5628 The following variables are available in the template instead of or in addition
5629 to the fields of the customer record.
5631 I<$payby> - a description of the method of payment for the customer
5632 # would be nice to use FS::payby::shortname
5633 I<$payinfo> - the masked account information used to collect for this customer
5634 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5635 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress
5639 sub generate_letter {
5640 my ($self, $template, %options) = @_;
5642 return unless $conf->exists($template);
5644 my $letter_template = new Text::Template
5646 SOURCE => [ map "$_\n", $conf->config($template)],
5647 DELIMITERS => [ '[@--', '--@]' ],
5649 or die "can't create new Text::Template object: Text::Template::ERROR";
5651 $letter_template->compile()
5652 or die "can't compile template: Text::Template::ERROR";
5654 my %letter_data = map { $_ => $self->$_ } $self->fields;
5655 $letter_data{payinfo} = $self->mask_payinfo;
5657 #my $paydate = $self->paydate || '2037-12';
5658 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12';
5660 my $payby = $self->payby;
5661 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5662 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5664 #credit cards expire at the end of the month/year of their exp date
5665 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5666 $letter_data{payby} = 'credit card';
5667 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5668 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5670 }elsif ($payby eq 'COMP') {
5671 $letter_data{payby} = 'complimentary account';
5673 $letter_data{payby} = 'current method';
5675 $letter_data{expdate} = $expire_time;
5677 for (keys %{$options{extra_fields}}){
5678 $letter_data{$_} = $options{extra_fields}->{$_};
5681 unless(exists($letter_data{returnaddress})){
5682 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5683 $self->agent_template)
5686 $letter_data{returnaddress} = length($retadd) ? $retadd : '~';
5689 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5691 my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
5692 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5696 ) or die "can't open temp file: $!\n";
5698 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5700 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5704 =item print_ps TEMPLATE
5706 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5712 my $file = $self->generate_letter(@_);
5713 FS::Misc::generate_ps($file);
5716 =item print TEMPLATE
5718 Prints the filled in template.
5720 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5724 sub queueable_print {
5727 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5728 or die "invalid customer number: " . $opt{custvnum};
5730 my $error = $self->print( $opt{template} );
5731 die $error if $error;
5735 my ($self, $template) = (shift, shift);
5736 do_print [ $self->print_ps($template) ];
5739 sub agent_template {
5741 $self->_agent_plandata('agent_templatename');
5744 sub agent_invoice_from {
5746 $self->_agent_plandata('agent_invoice_from');
5749 sub _agent_plandata {
5750 my( $self, $option ) = @_;
5752 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5753 #agent-specific Conf
5755 my $agentnum = $self->agentnum;
5757 my $part_event_option =
5759 'table' => 'part_event_option',
5761 LEFT JOIN part_event USING ( eventpart )
5762 LEFT JOIN part_event_option AS peo_agentnum
5763 ON ( part_event.eventpart = peo_agentnum.eventpart
5764 AND peo_agentnum.optionname = 'agentnum'
5765 AND peo_agentnum.optionvalue ~ '(^|,)agentnum(,|$)'
5767 LEFT JOIN part_event_option AS peo_cust_bill_age
5768 ON ( part_event.eventpart = peo_cust_bill_age.eventpart
5769 AND peo_cust_bill_age.optionname = 'cust_bill_age'
5772 #'hashref' => { 'optionname' => $option },
5773 'hashref' => { 'part_event_option.optionname' => $option },
5774 'extra_sql' => " AND event = 'cust_bill_send_agent' ".
5775 " AND peo_agentnum.optionname = 'agentnum' ".
5776 " AND agentnum IS NULL OR agentnum = $agentnum ".
5778 CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
5780 ELSE EXTRACT( EPOCH FROM
5781 REPLACE( peo_cust_bill_age.optionvalue,
5787 , part_event.weight".
5791 unless ( $part_event_option ) {
5792 return $self->agent->invoice_template || ''
5793 if $option eq '$agent_templatename';
5797 $part_event_option->optionvalue;
5807 The delete method should possibly take an FS::cust_main object reference
5808 instead of a scalar customer number.
5810 Bill and collect options should probably be passed as references instead of a
5813 There should probably be a configuration file with a list of allowed credit
5816 No multiple currency support (probably a larger project than just this module).
5818 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5820 Birthdates rely on negative epoch values.
5822 The payby for card/check batches is broken. With mixed batching, bad
5825 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5829 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5830 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5831 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.