5 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf @encrypted_fields
6 $import $skip_fuzzyfiles $ignore_expired_card @paytypes);
7 use vars qw( $realtime_bop_decline_quiet ); #ugh
11 use Time::Local qw(timelocal_nocheck);
14 use Digest::MD5 qw(md5_base64);
18 use String::Approx qw(amatch);
19 use Business::CreditCard 0.28;
22 use FS::UID qw( getotaker dbh );
23 use FS::Record qw( qsearchs qsearch dbdef );
24 use FS::Misc qw( send_email generate_ps do_print );
25 use FS::Msgcat qw(gettext);
29 use FS::cust_bill_pkg;
31 use FS::cust_pay_void;
32 use FS::cust_pay_batch;
35 use FS::part_referral;
36 use FS::cust_main_county;
38 use FS::cust_main_invoice;
39 use FS::cust_credit_bill;
40 use FS::cust_bill_pay;
41 use FS::prepay_credit;
45 use FS::part_event_condition;
47 use FS::cust_tax_exempt;
48 use FS::cust_tax_exempt_pkg;
50 use FS::payment_gateway;
51 use FS::agent_payment_gateway;
53 use FS::payinfo_Mixin;
56 @ISA = qw( FS::Record FS::payinfo_Mixin );
58 @EXPORT_OK = qw( smart_search );
60 $realtime_bop_decline_quiet = 0;
62 # 1 is mostly method/subroutine entry and options
63 # 2 traces progress of some operations
64 # 3 is even more information including possibly sensitive data
66 $me = '[FS::cust_main]';
70 $ignore_expired_card = 0;
72 @encrypted_fields = ('payinfo', 'paycvv');
73 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
75 #ask FS::UID to run this stuff for us later
76 #$FS::UID::callback{'FS::cust_main'} = sub {
77 install_callback FS::UID sub {
79 #yes, need it for stuff below (prolly should be cached)
84 my ( $hashref, $cache ) = @_;
85 if ( exists $hashref->{'pkgnum'} ) {
86 #@{ $self->{'_pkgnum'} } = ();
87 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
88 $self->{'_pkgnum'} = $subcache;
89 #push @{ $self->{'_pkgnum'} },
90 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
96 FS::cust_main - Object methods for cust_main records
102 $record = new FS::cust_main \%hash;
103 $record = new FS::cust_main { 'column' => 'value' };
105 $error = $record->insert;
107 $error = $new_record->replace($old_record);
109 $error = $record->delete;
111 $error = $record->check;
113 @cust_pkg = $record->all_pkgs;
115 @cust_pkg = $record->ncancelled_pkgs;
117 @cust_pkg = $record->suspended_pkgs;
119 $error = $record->bill;
120 $error = $record->bill %options;
121 $error = $record->bill 'time' => $time;
123 $error = $record->collect;
124 $error = $record->collect %options;
125 $error = $record->collect 'invoice_time' => $time,
130 An FS::cust_main object represents a customer. FS::cust_main inherits from
131 FS::Record. The following fields are currently supported:
135 =item custnum - primary key (assigned automatically for new customers)
137 =item agentnum - agent (see L<FS::agent>)
139 =item refnum - Advertising source (see L<FS::part_referral>)
145 =item ss - social security number (optional)
147 =item company - (optional)
151 =item address2 - (optional)
155 =item county - (optional, see L<FS::cust_main_county>)
157 =item state - (see L<FS::cust_main_county>)
161 =item country - (see L<FS::cust_main_county>)
163 =item daytime - phone (optional)
165 =item night - phone (optional)
167 =item fax - phone (optional)
169 =item ship_first - name
171 =item ship_last - name
173 =item ship_company - (optional)
177 =item ship_address2 - (optional)
181 =item ship_county - (optional, see L<FS::cust_main_county>)
183 =item ship_state - (see L<FS::cust_main_county>)
187 =item ship_country - (see L<FS::cust_main_county>)
189 =item ship_daytime - phone (optional)
191 =item ship_night - phone (optional)
193 =item ship_fax - phone (optional)
195 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
197 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
199 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
203 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
205 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
207 =item paystart_month - start date month (maestro/solo cards only)
209 =item paystart_year - start date year (maestro/solo cards only)
211 =item payissue - issue number (maestro/solo cards only)
213 =item payname - name on card or billing name
215 =item payip - IP address from which payment information was received
217 =item tax - tax exempt, empty or `Y'
219 =item otaker - order taker (assigned automatically, see L<FS::UID>)
221 =item comments - comments (optional)
223 =item referral_custnum - referring customer number
225 =item spool_cdr - Enable individual CDR spooling, empty or `Y'
235 Creates a new customer. To add the customer to the database, see L<"insert">.
237 Note that this stores the hash reference, not a distinct copy of the hash it
238 points to. You can ask the object for a copy with the I<hash> method.
242 sub table { 'cust_main'; }
244 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
246 Adds this customer to the database. If there is an error, returns the error,
247 otherwise returns false.
249 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
250 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
251 are inserted atomicly, or the transaction is rolled back. Passing an empty
252 hash reference is equivalent to not supplying this parameter. There should be
253 a better explanation of this, but until then, here's an example:
256 tie %hash, 'Tie::RefHash'; #this part is important
258 $cust_pkg => [ $svc_acct ],
261 $cust_main->insert( \%hash );
263 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
264 be set as the invoicing list (see L<"invoicing_list">). Errors return as
265 expected and rollback the entire transaction; it is not necessary to call
266 check_invoicing_list first. The invoicing_list is set after the records in the
267 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
268 invoicing_list destination to the newly-created svc_acct. Here's an example:
270 $cust_main->insert( {}, [ $email, 'POST' ] );
272 Currently available options are: I<depend_jobnum> and I<noexport>.
274 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
275 on the supplied jobnum (they will not run until the specific job completes).
276 This can be used to defer provisioning until some action completes (such
277 as running the customer's credit card successfully).
279 The I<noexport> option is deprecated. If I<noexport> is set true, no
280 provisioning jobs (exports) are scheduled. (You can schedule them later with
281 the B<reexport> method.)
287 my $cust_pkgs = @_ ? shift : {};
288 my $invoicing_list = @_ ? shift : '';
290 warn "$me insert called with options ".
291 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
294 local $SIG{HUP} = 'IGNORE';
295 local $SIG{INT} = 'IGNORE';
296 local $SIG{QUIT} = 'IGNORE';
297 local $SIG{TERM} = 'IGNORE';
298 local $SIG{TSTP} = 'IGNORE';
299 local $SIG{PIPE} = 'IGNORE';
301 my $oldAutoCommit = $FS::UID::AutoCommit;
302 local $FS::UID::AutoCommit = 0;
305 my $prepay_identifier = '';
306 my( $amount, $seconds ) = ( 0, 0 );
308 if ( $self->payby eq 'PREPAY' ) {
310 $self->payby('BILL');
311 $prepay_identifier = $self->payinfo;
314 warn " looking up prepaid card $prepay_identifier\n"
317 my $error = $self->get_prepay($prepay_identifier, \$amount, \$seconds);
319 $dbh->rollback if $oldAutoCommit;
320 #return "error applying prepaid card (transaction rolled back): $error";
324 $payby = 'PREP' if $amount;
326 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
329 $self->payby('BILL');
330 $amount = $self->paid;
334 warn " inserting $self\n"
337 $self->signupdate(time) unless $self->signupdate;
339 my $error = $self->SUPER::insert;
341 $dbh->rollback if $oldAutoCommit;
342 #return "inserting cust_main record (transaction rolled back): $error";
346 warn " setting invoicing list\n"
349 if ( $invoicing_list ) {
350 $error = $self->check_invoicing_list( $invoicing_list );
352 $dbh->rollback if $oldAutoCommit;
353 #return "checking invoicing_list (transaction rolled back): $error";
356 $self->invoicing_list( $invoicing_list );
359 if ( $conf->config('cust_main-skeleton_tables')
360 && $conf->config('cust_main-skeleton_custnum') ) {
362 warn " inserting skeleton records\n"
365 my $error = $self->start_copy_skel;
367 $dbh->rollback if $oldAutoCommit;
373 warn " ordering packages\n"
376 $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
378 $dbh->rollback if $oldAutoCommit;
383 $dbh->rollback if $oldAutoCommit;
384 return "No svc_acct record to apply pre-paid time";
388 warn " inserting initial $payby payment of $amount\n"
390 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
392 $dbh->rollback if $oldAutoCommit;
393 return "inserting payment (transaction rolled back): $error";
397 unless ( $import || $skip_fuzzyfiles ) {
398 warn " queueing fuzzyfiles update\n"
400 $error = $self->queue_fuzzyfiles_update;
402 $dbh->rollback if $oldAutoCommit;
403 return "updating fuzzy search cache: $error";
407 warn " insert complete; committing transaction\n"
410 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
415 sub start_copy_skel {
418 #'mg_user_preference' => {},
419 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
420 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
421 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
422 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
423 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
426 _copy_skel( 'cust_main', #tablename
427 $conf->config('cust_main-skeleton_custnum'), #sourceid
428 $self->custnum, #destid
429 @tables, #child tables
433 #recursive subroutine, not a method
435 my( $table, $sourceid, $destid, %child_tables ) = @_;
438 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
439 ( $table, $primary_key ) = ( $1, $2 );
441 my $dbdef_table = dbdef->table($table);
442 $primary_key = $dbdef_table->primary_key
443 or return "$table has no primary key".
444 " (or do you need to run dbdef-create?)";
447 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
448 join (', ', keys %child_tables). "\n"
451 foreach my $child_table_def ( keys %child_tables ) {
455 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
456 ( $child_table, $child_pkey ) = ( $1, $2 );
458 $child_table = $child_table_def;
460 $child_pkey = dbdef->table($child_table)->primary_key;
461 # or return "$table has no primary key".
462 # " (or do you need to run dbdef-create?)\n";
466 if ( keys %{ $child_tables{$child_table_def} } ) {
468 return "$child_table has no primary key".
469 " (run dbdef-create or try specifying it?)\n"
472 #false laziness w/Record::insert and only works on Pg
473 #refactor the proper last-inserted-id stuff out of Record::insert if this
474 # ever gets use for anything besides a quick kludge for one customer
475 my $default = dbdef->table($child_table)->column($child_pkey)->default;
476 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
477 or return "can't parse $child_table.$child_pkey default value ".
478 " for sequence name: $default";
483 my @sel_columns = grep { $_ ne $primary_key }
484 dbdef->table($child_table)->columns;
485 my $sel_columns = join(', ', @sel_columns );
487 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
488 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
489 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
491 my $sel_st = "SELECT $sel_columns FROM $child_table".
492 " WHERE $primary_key = $sourceid";
495 my $sel_sth = dbh->prepare( $sel_st )
496 or return dbh->errstr;
498 $sel_sth->execute or return $sel_sth->errstr;
500 while ( my $row = $sel_sth->fetchrow_hashref ) {
502 warn " selected row: ".
503 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
507 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
508 my $ins_sth =dbh->prepare($statement)
509 or return dbh->errstr;
510 my @param = ( $destid, map $row->{$_}, @ins_columns );
511 warn " $statement: [ ". join(', ', @param). " ]\n"
513 $ins_sth->execute( @param )
514 or return $ins_sth->errstr;
516 #next unless keys %{ $child_tables{$child_table} };
517 next unless $sequence;
519 #another section of that laziness
520 my $seq_sql = "SELECT currval('$sequence')";
521 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
522 $seq_sth->execute or return $seq_sth->errstr;
523 my $insertid = $seq_sth->fetchrow_arrayref->[0];
525 # don't drink soap! recurse! recurse! okay!
527 _copy_skel( $child_table_def,
528 $row->{$child_pkey}, #sourceid
530 %{ $child_tables{$child_table_def} },
532 return $error if $error;
542 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
544 Like the insert method on an existing record, this method orders a package
545 and included services atomicaly. Pass a Tie::RefHash data structure to this
546 method containing FS::cust_pkg and FS::svc_I<tablename> objects. There should
547 be a better explanation of this, but until then, here's an example:
550 tie %hash, 'Tie::RefHash'; #this part is important
552 $cust_pkg => [ $svc_acct ],
555 $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
557 Services can be new, in which case they are inserted, or existing unaudited
558 services, in which case they are linked to the newly-created package.
560 Currently available options are: I<depend_jobnum> and I<noexport>.
562 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
563 on the supplied jobnum (they will not run until the specific job completes).
564 This can be used to defer provisioning until some action completes (such
565 as running the customer's credit card successfully).
567 The I<noexport> option is deprecated. If I<noexport> is set true, no
568 provisioning jobs (exports) are scheduled. (You can schedule them later with
569 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
570 on the cust_main object is not recommended, as existing services will also be
577 my $cust_pkgs = shift;
580 my %svc_options = ();
581 $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
582 if exists $options{'depend_jobnum'};
583 warn "$me order_pkgs called with options ".
584 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
587 local $SIG{HUP} = 'IGNORE';
588 local $SIG{INT} = 'IGNORE';
589 local $SIG{QUIT} = 'IGNORE';
590 local $SIG{TERM} = 'IGNORE';
591 local $SIG{TSTP} = 'IGNORE';
592 local $SIG{PIPE} = 'IGNORE';
594 my $oldAutoCommit = $FS::UID::AutoCommit;
595 local $FS::UID::AutoCommit = 0;
598 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
600 foreach my $cust_pkg ( keys %$cust_pkgs ) {
601 $cust_pkg->custnum( $self->custnum );
602 my $error = $cust_pkg->insert;
604 $dbh->rollback if $oldAutoCommit;
605 return "inserting cust_pkg (transaction rolled back): $error";
607 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
608 if ( $svc_something->svcnum ) {
609 my $old_cust_svc = $svc_something->cust_svc;
610 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
611 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
612 $error = $new_cust_svc->replace($old_cust_svc);
614 $svc_something->pkgnum( $cust_pkg->pkgnum );
615 if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
616 $svc_something->seconds( $svc_something->seconds + $$seconds );
619 $error = $svc_something->insert(%svc_options);
622 $dbh->rollback if $oldAutoCommit;
623 #return "inserting svc_ (transaction rolled back): $error";
629 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
633 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
635 Recharges this (existing) customer with the specified prepaid card (see
636 L<FS::prepay_credit>), specified either by I<identifier> or as an
637 FS::prepay_credit object. If there is an error, returns the error, otherwise
640 Optionally, four scalar references can be passed as well. They will have their
641 values filled in with the amount, number of seconds, and number of upload and
642 download bytes applied by this prepaid
647 sub recharge_prepay {
648 my( $self, $prepay_credit, $amountref, $secondsref,
649 $upbytesref, $downbytesref, $totalbytesref ) = @_;
651 local $SIG{HUP} = 'IGNORE';
652 local $SIG{INT} = 'IGNORE';
653 local $SIG{QUIT} = 'IGNORE';
654 local $SIG{TERM} = 'IGNORE';
655 local $SIG{TSTP} = 'IGNORE';
656 local $SIG{PIPE} = 'IGNORE';
658 my $oldAutoCommit = $FS::UID::AutoCommit;
659 local $FS::UID::AutoCommit = 0;
662 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
664 my $error = $self->get_prepay($prepay_credit, \$amount,
665 \$seconds, \$upbytes, \$downbytes, \$totalbytes)
666 || $self->increment_seconds($seconds)
667 || $self->increment_upbytes($upbytes)
668 || $self->increment_downbytes($downbytes)
669 || $self->increment_totalbytes($totalbytes)
670 || $self->insert_cust_pay_prepay( $amount,
672 ? $prepay_credit->identifier
677 $dbh->rollback if $oldAutoCommit;
681 if ( defined($amountref) ) { $$amountref = $amount; }
682 if ( defined($secondsref) ) { $$secondsref = $seconds; }
683 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
684 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
685 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
687 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
692 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
694 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
695 specified either by I<identifier> or as an FS::prepay_credit object.
697 References to I<amount> and I<seconds> scalars should be passed as arguments
698 and will be incremented by the values of the prepaid card.
700 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
701 check or set this customer's I<agentnum>.
703 If there is an error, returns the error, otherwise returns false.
709 my( $self, $prepay_credit, $amountref, $secondsref,
710 $upref, $downref, $totalref) = @_;
712 local $SIG{HUP} = 'IGNORE';
713 local $SIG{INT} = 'IGNORE';
714 local $SIG{QUIT} = 'IGNORE';
715 local $SIG{TERM} = 'IGNORE';
716 local $SIG{TSTP} = 'IGNORE';
717 local $SIG{PIPE} = 'IGNORE';
719 my $oldAutoCommit = $FS::UID::AutoCommit;
720 local $FS::UID::AutoCommit = 0;
723 unless ( ref($prepay_credit) ) {
725 my $identifier = $prepay_credit;
727 $prepay_credit = qsearchs(
729 { 'identifier' => $prepay_credit },
734 unless ( $prepay_credit ) {
735 $dbh->rollback if $oldAutoCommit;
736 return "Invalid prepaid card: ". $identifier;
741 if ( $prepay_credit->agentnum ) {
742 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
743 $dbh->rollback if $oldAutoCommit;
744 return "prepaid card not valid for agent ". $self->agentnum;
746 $self->agentnum($prepay_credit->agentnum);
749 my $error = $prepay_credit->delete;
751 $dbh->rollback if $oldAutoCommit;
752 return "removing prepay_credit (transaction rolled back): $error";
755 $$amountref += $prepay_credit->amount;
756 $$secondsref += $prepay_credit->seconds;
757 $$upref += $prepay_credit->upbytes;
758 $$downref += $prepay_credit->downbytes;
759 $$totalref += $prepay_credit->totalbytes;
761 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
766 =item increment_upbytes SECONDS
768 Updates this customer's single or primary account (see L<FS::svc_acct>) by
769 the specified number of upbytes. If there is an error, returns the error,
770 otherwise returns false.
774 sub increment_upbytes {
775 _increment_column( shift, 'upbytes', @_);
778 =item increment_downbytes SECONDS
780 Updates this customer's single or primary account (see L<FS::svc_acct>) by
781 the specified number of downbytes. If there is an error, returns the error,
782 otherwise returns false.
786 sub increment_downbytes {
787 _increment_column( shift, 'downbytes', @_);
790 =item increment_totalbytes SECONDS
792 Updates this customer's single or primary account (see L<FS::svc_acct>) by
793 the specified number of totalbytes. If there is an error, returns the error,
794 otherwise returns false.
798 sub increment_totalbytes {
799 _increment_column( shift, 'totalbytes', @_);
802 =item increment_seconds SECONDS
804 Updates this customer's single or primary account (see L<FS::svc_acct>) by
805 the specified number of seconds. If there is an error, returns the error,
806 otherwise returns false.
810 sub increment_seconds {
811 _increment_column( shift, 'seconds', @_);
814 =item _increment_column AMOUNT
816 Updates this customer's single or primary account (see L<FS::svc_acct>) by
817 the specified number of seconds or bytes. If there is an error, returns
818 the error, otherwise returns false.
822 sub _increment_column {
823 my( $self, $column, $amount ) = @_;
824 warn "$me increment_column called: $column, $amount\n"
827 return '' unless $amount;
829 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
830 $self->ncancelled_pkgs;
833 return 'No packages with primary or single services found'.
834 ' to apply pre-paid time';
835 } elsif ( scalar(@cust_pkg) > 1 ) {
836 #maybe have a way to specify the package/account?
837 return 'Multiple packages found to apply pre-paid time';
840 my $cust_pkg = $cust_pkg[0];
841 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
845 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
848 return 'No account found to apply pre-paid time';
849 } elsif ( scalar(@cust_svc) > 1 ) {
850 return 'Multiple accounts found to apply pre-paid time';
853 my $svc_acct = $cust_svc[0]->svc_x;
854 warn " found service svcnum ". $svc_acct->pkgnum.
855 ' ('. $svc_acct->email. ")\n"
858 $column = "increment_$column";
859 $svc_acct->$column($amount);
863 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
865 Inserts a prepayment in the specified amount for this customer. An optional
866 second argument can specify the prepayment identifier for tracking purposes.
867 If there is an error, returns the error, otherwise returns false.
871 sub insert_cust_pay_prepay {
872 shift->insert_cust_pay('PREP', @_);
875 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
877 Inserts a cash payment in the specified amount for this customer. An optional
878 second argument can specify the payment identifier for tracking purposes.
879 If there is an error, returns the error, otherwise returns false.
883 sub insert_cust_pay_cash {
884 shift->insert_cust_pay('CASH', @_);
887 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
889 Inserts a Western Union payment in the specified amount for this customer. An
890 optional second argument can specify the prepayment identifier for tracking
891 purposes. If there is an error, returns the error, otherwise returns false.
895 sub insert_cust_pay_west {
896 shift->insert_cust_pay('WEST', @_);
899 sub insert_cust_pay {
900 my( $self, $payby, $amount ) = splice(@_, 0, 3);
901 my $payinfo = scalar(@_) ? shift : '';
903 my $cust_pay = new FS::cust_pay {
904 'custnum' => $self->custnum,
905 'paid' => sprintf('%.2f', $amount),
906 #'_date' => #date the prepaid card was purchased???
908 'payinfo' => $payinfo,
916 This method is deprecated. See the I<depend_jobnum> option to the insert and
917 order_pkgs methods for a better way to defer provisioning.
919 Re-schedules all exports by calling the B<reexport> method of all associated
920 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
921 otherwise returns false.
928 carp "WARNING: FS::cust_main::reexport is deprectated; ".
929 "use the depend_jobnum option to insert or order_pkgs to delay export";
931 local $SIG{HUP} = 'IGNORE';
932 local $SIG{INT} = 'IGNORE';
933 local $SIG{QUIT} = 'IGNORE';
934 local $SIG{TERM} = 'IGNORE';
935 local $SIG{TSTP} = 'IGNORE';
936 local $SIG{PIPE} = 'IGNORE';
938 my $oldAutoCommit = $FS::UID::AutoCommit;
939 local $FS::UID::AutoCommit = 0;
942 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
943 my $error = $cust_pkg->reexport;
945 $dbh->rollback if $oldAutoCommit;
950 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
955 =item delete NEW_CUSTNUM
957 This deletes the customer. If there is an error, returns the error, otherwise
960 This will completely remove all traces of the customer record. This is not
961 what you want when a customer cancels service; for that, cancel all of the
962 customer's packages (see L</cancel>).
964 If the customer has any uncancelled packages, you need to pass a new (valid)
965 customer number for those packages to be transferred to. Cancelled packages
966 will be deleted. Did I mention that this is NOT what you want when a customer
967 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
969 You can't delete a customer with invoices (see L<FS::cust_bill>),
970 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
971 refunds (see L<FS::cust_refund>).
978 local $SIG{HUP} = 'IGNORE';
979 local $SIG{INT} = 'IGNORE';
980 local $SIG{QUIT} = 'IGNORE';
981 local $SIG{TERM} = 'IGNORE';
982 local $SIG{TSTP} = 'IGNORE';
983 local $SIG{PIPE} = 'IGNORE';
985 my $oldAutoCommit = $FS::UID::AutoCommit;
986 local $FS::UID::AutoCommit = 0;
989 if ( $self->cust_bill ) {
990 $dbh->rollback if $oldAutoCommit;
991 return "Can't delete a customer with invoices";
993 if ( $self->cust_credit ) {
994 $dbh->rollback if $oldAutoCommit;
995 return "Can't delete a customer with credits";
997 if ( $self->cust_pay ) {
998 $dbh->rollback if $oldAutoCommit;
999 return "Can't delete a customer with payments";
1001 if ( $self->cust_refund ) {
1002 $dbh->rollback if $oldAutoCommit;
1003 return "Can't delete a customer with refunds";
1006 my @cust_pkg = $self->ncancelled_pkgs;
1008 my $new_custnum = shift;
1009 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1010 $dbh->rollback if $oldAutoCommit;
1011 return "Invalid new customer number: $new_custnum";
1013 foreach my $cust_pkg ( @cust_pkg ) {
1014 my %hash = $cust_pkg->hash;
1015 $hash{'custnum'} = $new_custnum;
1016 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1017 my $error = $new_cust_pkg->replace($cust_pkg,
1018 options => { $cust_pkg->options },
1021 $dbh->rollback if $oldAutoCommit;
1026 my @cancelled_cust_pkg = $self->all_pkgs;
1027 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1028 my $error = $cust_pkg->delete;
1030 $dbh->rollback if $oldAutoCommit;
1035 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1036 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1038 my $error = $cust_main_invoice->delete;
1040 $dbh->rollback if $oldAutoCommit;
1045 my $error = $self->SUPER::delete;
1047 $dbh->rollback if $oldAutoCommit;
1051 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1056 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
1058 Replaces the OLD_RECORD with this one in the database. If there is an error,
1059 returns the error, otherwise returns false.
1061 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1062 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1063 expected and rollback the entire transaction; it is not necessary to call
1064 check_invoicing_list first. Here's an example:
1066 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1074 warn "$me replace called\n"
1077 local $SIG{HUP} = 'IGNORE';
1078 local $SIG{INT} = 'IGNORE';
1079 local $SIG{QUIT} = 'IGNORE';
1080 local $SIG{TERM} = 'IGNORE';
1081 local $SIG{TSTP} = 'IGNORE';
1082 local $SIG{PIPE} = 'IGNORE';
1084 # We absolutely have to have an old vs. new record to make this work.
1085 if (!defined($old)) {
1086 $old = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
1089 my $curuser = $FS::CurrentUser::CurrentUser;
1090 if ( $self->payby eq 'COMP'
1091 && $self->payby ne $old->payby
1092 && ! $curuser->access_right('Complimentary customer')
1095 return "You are not permitted to create complimentary accounts.";
1098 local($ignore_expired_card) = 1
1099 if $old->payby =~ /^(CARD|DCRD)$/
1100 && $self->payby =~ /^(CARD|DCRD)$/
1101 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1103 my $oldAutoCommit = $FS::UID::AutoCommit;
1104 local $FS::UID::AutoCommit = 0;
1107 my $error = $self->SUPER::replace($old);
1110 $dbh->rollback if $oldAutoCommit;
1114 if ( @param ) { # INVOICING_LIST_ARYREF
1115 my $invoicing_list = shift @param;
1116 $error = $self->check_invoicing_list( $invoicing_list );
1118 $dbh->rollback if $oldAutoCommit;
1121 $self->invoicing_list( $invoicing_list );
1124 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1125 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1126 # card/check/lec info has changed, want to retry realtime_ invoice events
1127 my $error = $self->retry_realtime;
1129 $dbh->rollback if $oldAutoCommit;
1134 unless ( $import || $skip_fuzzyfiles ) {
1135 $error = $self->queue_fuzzyfiles_update;
1137 $dbh->rollback if $oldAutoCommit;
1138 return "updating fuzzy search cache: $error";
1142 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1147 =item queue_fuzzyfiles_update
1149 Used by insert & replace to update the fuzzy search cache
1153 sub queue_fuzzyfiles_update {
1156 local $SIG{HUP} = 'IGNORE';
1157 local $SIG{INT} = 'IGNORE';
1158 local $SIG{QUIT} = 'IGNORE';
1159 local $SIG{TERM} = 'IGNORE';
1160 local $SIG{TSTP} = 'IGNORE';
1161 local $SIG{PIPE} = 'IGNORE';
1163 my $oldAutoCommit = $FS::UID::AutoCommit;
1164 local $FS::UID::AutoCommit = 0;
1167 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1168 my $error = $queue->insert( map $self->getfield($_),
1169 qw(first last company)
1172 $dbh->rollback if $oldAutoCommit;
1173 return "queueing job (transaction rolled back): $error";
1176 if ( $self->ship_last ) {
1177 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1178 $error = $queue->insert( map $self->getfield("ship_$_"),
1179 qw(first last company)
1182 $dbh->rollback if $oldAutoCommit;
1183 return "queueing job (transaction rolled back): $error";
1187 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1194 Checks all fields to make sure this is a valid customer record. If there is
1195 an error, returns the error, otherwise returns false. Called by the insert
1196 and replace methods.
1203 warn "$me check BEFORE: \n". $self->_dump
1207 $self->ut_numbern('custnum')
1208 || $self->ut_number('agentnum')
1209 || $self->ut_textn('agent_custid')
1210 || $self->ut_number('refnum')
1211 || $self->ut_name('last')
1212 || $self->ut_name('first')
1213 || $self->ut_snumbern('birthdate')
1214 || $self->ut_snumbern('signupdate')
1215 || $self->ut_textn('company')
1216 || $self->ut_text('address1')
1217 || $self->ut_textn('address2')
1218 || $self->ut_text('city')
1219 || $self->ut_textn('county')
1220 || $self->ut_textn('state')
1221 || $self->ut_country('country')
1222 || $self->ut_anything('comments')
1223 || $self->ut_numbern('referral_custnum')
1224 || $self->ut_textn('stateid')
1225 || $self->ut_textn('stateid_state')
1226 || $self->ut_textn('invoice_terms')
1228 #barf. need message catalogs. i18n. etc.
1229 $error .= "Please select an advertising source."
1230 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1231 return $error if $error;
1233 return "Unknown agent"
1234 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1236 return "Unknown refnum"
1237 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1239 return "Unknown referring custnum: ". $self->referral_custnum
1240 unless ! $self->referral_custnum
1241 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1243 if ( $self->ss eq '' ) {
1248 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1249 or return "Illegal social security number: ". $self->ss;
1250 $self->ss("$1-$2-$3");
1254 # bad idea to disable, causes billing to fail because of no tax rates later
1255 # unless ( $import ) {
1256 unless ( qsearch('cust_main_county', {
1257 'country' => $self->country,
1260 return "Unknown state/county/country: ".
1261 $self->state. "/". $self->county. "/". $self->country
1262 unless qsearch('cust_main_county',{
1263 'state' => $self->state,
1264 'county' => $self->county,
1265 'country' => $self->country,
1271 $self->ut_phonen('daytime', $self->country)
1272 || $self->ut_phonen('night', $self->country)
1273 || $self->ut_phonen('fax', $self->country)
1274 || $self->ut_zip('zip', $self->country)
1276 return $error if $error;
1278 if ( $conf->exists('cust_main-require_phone')
1279 && ! length($self->daytime) && ! length($self->night)
1282 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1284 : FS::Msgcat::_gettext('daytime');
1285 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1287 : FS::Msgcat::_gettext('night');
1289 return "$daytime_label or $night_label is required"
1294 last first company address1 address2 city county state zip
1295 country daytime night fax
1298 if ( defined $self->dbdef_table->column('ship_last') ) {
1299 if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1301 && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
1305 $self->ut_name('ship_last')
1306 || $self->ut_name('ship_first')
1307 || $self->ut_textn('ship_company')
1308 || $self->ut_text('ship_address1')
1309 || $self->ut_textn('ship_address2')
1310 || $self->ut_text('ship_city')
1311 || $self->ut_textn('ship_county')
1312 || $self->ut_textn('ship_state')
1313 || $self->ut_country('ship_country')
1315 return $error if $error;
1317 #false laziness with above
1318 unless ( qsearchs('cust_main_county', {
1319 'country' => $self->ship_country,
1322 return "Unknown ship_state/ship_county/ship_country: ".
1323 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1324 unless qsearch('cust_main_county',{
1325 'state' => $self->ship_state,
1326 'county' => $self->ship_county,
1327 'country' => $self->ship_country,
1333 $self->ut_phonen('ship_daytime', $self->ship_country)
1334 || $self->ut_phonen('ship_night', $self->ship_country)
1335 || $self->ut_phonen('ship_fax', $self->ship_country)
1336 || $self->ut_zip('ship_zip', $self->ship_country)
1338 return $error if $error;
1340 } else { # ship_ info eq billing info, so don't store dup info in database
1341 $self->setfield("ship_$_", '')
1342 foreach qw( last first company address1 address2 city county state zip
1343 country daytime night fax );
1347 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1348 # or return "Illegal payby: ". $self->payby;
1350 FS::payby->can_payby($self->table, $self->payby)
1351 or return "Illegal payby: ". $self->payby;
1353 $error = $self->ut_numbern('paystart_month')
1354 || $self->ut_numbern('paystart_year')
1355 || $self->ut_numbern('payissue')
1356 || $self->ut_textn('paytype')
1358 return $error if $error;
1360 if ( $self->payip eq '' ) {
1363 $error = $self->ut_ip('payip');
1364 return $error if $error;
1367 # If it is encrypted and the private key is not availaible then we can't
1368 # check the credit card.
1370 my $check_payinfo = 1;
1372 if ($self->is_encrypted($self->payinfo)) {
1376 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1378 my $payinfo = $self->payinfo;
1379 $payinfo =~ s/\D//g;
1380 $payinfo =~ /^(\d{13,16})$/
1381 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1383 $self->payinfo($payinfo);
1385 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1387 return gettext('unknown_card_type')
1388 if cardtype($self->payinfo) eq "Unknown";
1390 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1392 return 'Banned credit card: banned on '.
1393 time2str('%a %h %o at %r', $ban->_date).
1394 ' by '. $ban->otaker.
1395 ' (ban# '. $ban->bannum. ')';
1398 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1399 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1400 $self->paycvv =~ /^(\d{4})$/
1401 or return "CVV2 (CID) for American Express cards is four digits.";
1404 $self->paycvv =~ /^(\d{3})$/
1405 or return "CVV2 (CVC2/CID) is three digits.";
1412 my $cardtype = cardtype($payinfo);
1413 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1415 return "Start date or issue number is required for $cardtype cards"
1416 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1418 return "Start month must be between 1 and 12"
1419 if $self->paystart_month
1420 and $self->paystart_month < 1 || $self->paystart_month > 12;
1422 return "Start year must be 1990 or later"
1423 if $self->paystart_year
1424 and $self->paystart_year < 1990;
1426 return "Issue number must be beween 1 and 99"
1428 and $self->payissue < 1 || $self->payissue > 99;
1431 $self->paystart_month('');
1432 $self->paystart_year('');
1433 $self->payissue('');
1436 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1438 my $payinfo = $self->payinfo;
1439 $payinfo =~ s/[^\d\@]//g;
1440 if ( $conf->exists('echeck-nonus') ) {
1441 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1442 $payinfo = "$1\@$2";
1444 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1445 $payinfo = "$1\@$2";
1447 $self->payinfo($payinfo);
1450 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1452 return 'Banned ACH account: banned on '.
1453 time2str('%a %h %o at %r', $ban->_date).
1454 ' by '. $ban->otaker.
1455 ' (ban# '. $ban->bannum. ')';
1458 } elsif ( $self->payby eq 'LECB' ) {
1460 my $payinfo = $self->payinfo;
1461 $payinfo =~ s/\D//g;
1462 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1464 $self->payinfo($payinfo);
1467 } elsif ( $self->payby eq 'BILL' ) {
1469 $error = $self->ut_textn('payinfo');
1470 return "Illegal P.O. number: ". $self->payinfo if $error;
1473 } elsif ( $self->payby eq 'COMP' ) {
1475 my $curuser = $FS::CurrentUser::CurrentUser;
1476 if ( ! $self->custnum
1477 && ! $curuser->access_right('Complimentary customer')
1480 return "You are not permitted to create complimentary accounts."
1483 $error = $self->ut_textn('payinfo');
1484 return "Illegal comp account issuer: ". $self->payinfo if $error;
1487 } elsif ( $self->payby eq 'PREPAY' ) {
1489 my $payinfo = $self->payinfo;
1490 $payinfo =~ s/\W//g; #anything else would just confuse things
1491 $self->payinfo($payinfo);
1492 $error = $self->ut_alpha('payinfo');
1493 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1494 return "Unknown prepayment identifier"
1495 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1500 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1501 return "Expiration date required"
1502 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1506 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1507 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1508 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1509 ( $m, $y ) = ( $3, "20$2" );
1511 return "Illegal expiration date: ". $self->paydate;
1513 $self->paydate("$y-$m-01");
1514 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1515 return gettext('expired_card')
1517 && !$ignore_expired_card
1518 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1521 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1522 ( ! $conf->exists('require_cardname')
1523 || $self->payby !~ /^(CARD|DCRD)$/ )
1525 $self->payname( $self->first. " ". $self->getfield('last') );
1527 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1528 or return gettext('illegal_name'). " payname: ". $self->payname;
1532 foreach my $flag (qw( tax spool_cdr )) {
1533 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1537 $self->otaker(getotaker) unless $self->otaker;
1539 warn "$me check AFTER: \n". $self->_dump
1542 $self->SUPER::check;
1547 Returns all packages (see L<FS::cust_pkg>) for this customer.
1554 return $self->num_pkgs unless wantarray;
1557 if ( $self->{'_pkgnum'} ) {
1558 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1560 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1563 sort sort_packages @cust_pkg;
1568 Synonym for B<all_pkgs>.
1573 shift->all_pkgs(@_);
1576 =item ncancelled_pkgs
1578 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1582 sub ncancelled_pkgs {
1585 return $self->num_ncancelled_pkgs unless wantarray;
1588 if ( $self->{'_pkgnum'} ) {
1590 warn "$me ncancelled_pkgs: returning cached objects"
1593 @cust_pkg = grep { ! $_->getfield('cancel') }
1594 values %{ $self->{'_pkgnum'}->cache };
1598 warn "$me ncancelled_pkgs: searching for packages for custnum ".
1603 qsearch( 'cust_pkg', {
1604 'custnum' => $self->custnum,
1608 qsearch( 'cust_pkg', {
1609 'custnum' => $self->custnum,
1614 sort sort_packages @cust_pkg;
1618 # This should be generalized to use config options to determine order.
1620 if ( $a->get('cancel') and $b->get('cancel') ) {
1621 $a->pkgnum <=> $b->pkgnum;
1622 } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1623 return -1 if $b->get('cancel');
1624 return 1 if $a->get('cancel');
1627 $a->pkgnum <=> $b->pkgnum;
1631 =item suspended_pkgs
1633 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1637 sub suspended_pkgs {
1639 grep { $_->susp } $self->ncancelled_pkgs;
1642 =item unflagged_suspended_pkgs
1644 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1645 customer (thouse packages without the `manual_flag' set).
1649 sub unflagged_suspended_pkgs {
1651 return $self->suspended_pkgs
1652 unless dbdef->table('cust_pkg')->column('manual_flag');
1653 grep { ! $_->manual_flag } $self->suspended_pkgs;
1656 =item unsuspended_pkgs
1658 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1663 sub unsuspended_pkgs {
1665 grep { ! $_->susp } $self->ncancelled_pkgs;
1668 =item num_cancelled_pkgs
1670 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1675 sub num_cancelled_pkgs {
1676 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1679 sub num_ncancelled_pkgs {
1680 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1684 my( $self, $sql ) = @_;
1685 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1686 my $sth = dbh->prepare(
1687 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1688 ) or die dbh->errstr;
1689 $sth->execute($self->custnum) or die $sth->errstr;
1690 $sth->fetchrow_arrayref->[0];
1695 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1696 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1697 on success or a list of errors.
1703 grep { $_->unsuspend } $self->suspended_pkgs;
1708 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1710 Returns a list: an empty list on success or a list of errors.
1716 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1719 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1721 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1722 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
1723 of a list of pkgparts; the hashref has the following keys:
1727 =item pkgparts - listref of pkgparts
1729 =item (other options are passed to the suspend method)
1734 Returns a list: an empty list on success or a list of errors.
1738 sub suspend_if_pkgpart {
1740 my (@pkgparts, %opt);
1741 if (ref($_[0]) eq 'HASH'){
1742 @pkgparts = @{$_[0]{pkgparts}};
1747 grep { $_->suspend(%opt) }
1748 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1749 $self->unsuspended_pkgs;
1752 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1754 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1755 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
1756 instead of a list of pkgparts; the hashref has the following keys:
1760 =item pkgparts - listref of pkgparts
1762 =item (other options are passed to the suspend method)
1766 Returns a list: an empty list on success or a list of errors.
1770 sub suspend_unless_pkgpart {
1772 my (@pkgparts, %opt);
1773 if (ref($_[0]) eq 'HASH'){
1774 @pkgparts = @{$_[0]{pkgparts}};
1779 grep { $_->suspend(%opt) }
1780 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1781 $self->unsuspended_pkgs;
1784 =item cancel [ OPTION => VALUE ... ]
1786 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1788 Available options are:
1792 =item quiet - can be set true to supress email cancellation notices.
1794 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
1796 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
1800 Always returns a list: an empty list on success or a list of errors.
1805 my( $self, %opt ) = @_;
1807 warn "$me cancel called on customer ". $self->custnum. " with options ".
1808 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
1811 return ( 'access denied' )
1812 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
1814 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1816 #should try decryption (we might have the private key)
1817 # and if not maybe queue a job for the server that does?
1818 return ( "Can't (yet) ban encrypted credit cards" )
1819 if $self->is_encrypted($self->payinfo);
1821 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1822 my $error = $ban->insert;
1823 return ( $error ) if $error;
1827 my @pkgs = $self->ncancelled_pkgs;
1829 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
1830 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
1833 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
1836 sub _banned_pay_hashref {
1847 'payby' => $payby2ban{$self->payby},
1848 'payinfo' => md5_base64($self->payinfo),
1849 #don't ever *search* on reason! #'reason' =>
1855 Returns all notes (see L<FS::cust_main_note>) for this customer.
1862 qsearch( 'cust_main_note',
1863 { 'custnum' => $self->custnum },
1865 'ORDER BY _DATE DESC'
1871 Returns the agent (see L<FS::agent>) for this customer.
1877 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1880 =item bill_and_collect
1882 Cancels and suspends any packages due, generates bills, applies payments and
1885 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
1887 Options are passed as name-value pairs. Currently available options are:
1891 =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:
1895 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1897 =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.
1899 =item check_freq - "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1901 =item resetup - if set true, re-charges setup fees.
1907 sub bill_and_collect {
1908 my( $self, %options ) = @_;
1914 #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1915 foreach my $cust_pkg (
1916 grep { $_->expire && $_->expire <= $^T } $self->ncancelled_pkgs
1918 my $error = $cust_pkg->cancel;
1919 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
1920 " for custnum ". $self->custnum. ": $error"
1928 #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1929 foreach my $cust_pkg (
1930 grep { ( $_->part_pkg->is_prepaid && $_->bill && $_->bill < $^T
1931 || $_->adjourn && $_->adjourn <= $^T
1935 $self->ncancelled_pkgs
1937 my $error = $cust_pkg->suspend;
1938 warn "Error suspending package ". $cust_pkg->pkgnum.
1939 " for custnum ". $self->custnum. ": $error"
1947 my $error = $self->bill( %options );
1948 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
1950 $self->apply_payments_and_credits;
1952 $error = $self->collect( %options );
1953 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
1959 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
1960 conjunction with the collect method by calling B<bill_and_collect>.
1962 If there is an error, returns the error, otherwise returns false.
1964 Options are passed as name-value pairs. Currently available options are:
1968 =item resetup - if set true, re-charges setup fees.
1970 =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:
1974 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1976 =item pkg_list - An array ref of specific packages (objects) to attempt billing, instead trying all of them.
1978 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
1980 =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.
1987 my( $self, %options ) = @_;
1988 return '' if $self->payby eq 'COMP';
1989 warn "$me bill customer ". $self->custnum. "\n"
1992 my $time = $options{'time'} || time;
1997 local $SIG{HUP} = 'IGNORE';
1998 local $SIG{INT} = 'IGNORE';
1999 local $SIG{QUIT} = 'IGNORE';
2000 local $SIG{TERM} = 'IGNORE';
2001 local $SIG{TSTP} = 'IGNORE';
2002 local $SIG{PIPE} = 'IGNORE';
2004 my $oldAutoCommit = $FS::UID::AutoCommit;
2005 local $FS::UID::AutoCommit = 0;
2008 $self->select_for_update; #mutex
2010 #create a new invoice
2011 #(we'll remove it later if it doesn't actually need to be generated [contains
2012 # no line items] and we're inside a transaciton so nothing else will see it)
2013 my $cust_bill = new FS::cust_bill ( {
2014 'custnum' => $self->custnum,
2015 '_date' => ( $options{'invoice_time'} || $time ),
2016 #'charged' => $charged,
2019 $error = $cust_bill->insert;
2021 $dbh->rollback if $oldAutoCommit;
2022 return "can't create invoice for customer #". $self->custnum. ": $error";
2024 my $invnum = $cust_bill->invnum;
2027 # find the packages which are due for billing, find out how much they are
2028 # & generate invoice database.
2031 my( $total_setup, $total_recur ) = ( 0, 0 );
2033 my @precommit_hooks = ();
2035 foreach my $cust_pkg (
2036 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
2039 #NO!! next if $cust_pkg->cancel;
2040 next if $cust_pkg->getfield('cancel');
2042 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2044 #? to avoid use of uninitialized value errors... ?
2045 $cust_pkg->setfield('bill', '')
2046 unless defined($cust_pkg->bill);
2048 my $part_pkg = $cust_pkg->part_pkg;
2050 my %hash = $cust_pkg->hash;
2051 my $old_cust_pkg = new FS::cust_pkg \%hash;
2060 if ( ! $cust_pkg->setup &&
2062 ( $conf->exists('disable_setup_suspended_pkgs') &&
2063 ! $cust_pkg->getfield('susp')
2064 ) || ! $conf->exists('disable_setup_suspended_pkgs')
2066 || $options{'resetup'}
2069 warn " bill setup\n" if $DEBUG > 1;
2071 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2073 $dbh->rollback if $oldAutoCommit;
2074 return "$@ running calc_setup for $cust_pkg\n";
2077 $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
2081 # bill recurring fee
2086 if ( $part_pkg->getfield('freq') ne '0' &&
2087 ! $cust_pkg->getfield('susp') &&
2088 ( $cust_pkg->getfield('bill') || 0 ) <= $time
2091 # XXX should this be a package event? probably. events are called
2092 # at collection time at the moment, though...
2093 if ( $part_pkg->can('reset_usage') ) {
2094 warn " resetting usage counters" if $DEBUG > 1;
2095 $part_pkg->reset_usage($cust_pkg);
2098 warn " bill recur\n" if $DEBUG > 1;
2100 # XXX shared with $recur_prog
2101 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2103 #over two params! lets at least switch to a hashref for the rest...
2104 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
2106 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2108 $dbh->rollback if $oldAutoCommit;
2109 return "$@ running calc_recur for $cust_pkg\n";
2112 #change this bit to use Date::Manip? CAREFUL with timezones (see
2113 # mailing list archive)
2114 my ($sec,$min,$hour,$mday,$mon,$year) =
2115 (localtime($sdate) )[0,1,2,3,4,5];
2117 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2118 # only for figuring next bill date, nothing else, so, reset $sdate again
2120 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2121 $cust_pkg->last_bill($sdate)
2122 if $cust_pkg->dbdef_table->column('last_bill');
2124 if ( $part_pkg->freq =~ /^\d+$/ ) {
2125 $mon += $part_pkg->freq;
2126 until ( $mon < 12 ) { $mon -= 12; $year++; }
2127 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2129 $mday += $weeks * 7;
2130 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2133 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2137 $dbh->rollback if $oldAutoCommit;
2138 return "unparsable frequency: ". $part_pkg->freq;
2140 $cust_pkg->setfield('bill',
2141 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2144 warn "\$setup is undefined" unless defined($setup);
2145 warn "\$recur is undefined" unless defined($recur);
2146 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2149 # If $cust_pkg has been modified, update it and create cust_bill_pkg records
2152 if ( $cust_pkg->modified ) { # hmmm.. and if the options are modified?
2154 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2157 $error=$cust_pkg->replace($old_cust_pkg,
2158 options => { $cust_pkg->options },
2160 if ( $error ) { #just in case
2161 $dbh->rollback if $oldAutoCommit;
2162 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2165 $setup = sprintf( "%.2f", $setup );
2166 $recur = sprintf( "%.2f", $recur );
2167 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2168 $dbh->rollback if $oldAutoCommit;
2169 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2171 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2172 $dbh->rollback if $oldAutoCommit;
2173 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2176 if ( $setup != 0 || $recur != 0 ) {
2178 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2180 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2181 'invnum' => $invnum,
2182 'pkgnum' => $cust_pkg->pkgnum,
2186 'edate' => $cust_pkg->bill,
2187 'details' => \@details,
2189 $error = $cust_bill_pkg->insert;
2191 $dbh->rollback if $oldAutoCommit;
2192 return "can't create invoice line item for invoice #$invnum: $error";
2194 $total_setup += $setup;
2195 $total_recur += $recur;
2201 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2204 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2207 my %taxhash = map { $_ => $self->get("$prefix$_") }
2208 qw( state county country );
2210 $taxhash{'taxclass'} = $part_pkg->taxclass;
2212 my @taxes = qsearch( 'cust_main_county', \%taxhash );
2215 $taxhash{'taxclass'} = '';
2216 @taxes = qsearch( 'cust_main_county', \%taxhash );
2219 #one more try at a whole-country tax rate
2221 $taxhash{$_} = '' foreach qw( state county );
2222 @taxes = qsearch( 'cust_main_county', \%taxhash );
2225 # maybe eliminate this entirely, along with all the 0% records
2227 $dbh->rollback if $oldAutoCommit;
2229 "fatal: can't find tax rate for state/county/country/taxclass ".
2230 join('/', ( map $self->get("$prefix$_"),
2231 qw(state county country)
2233 $part_pkg->taxclass ). "\n";
2236 foreach my $tax ( @taxes ) {
2238 my $taxable_charged = 0;
2239 $taxable_charged += $setup
2240 unless $part_pkg->setuptax =~ /^Y$/i
2241 || $tax->setuptax =~ /^Y$/i;
2242 $taxable_charged += $recur
2243 unless $part_pkg->recurtax =~ /^Y$/i
2244 || $tax->recurtax =~ /^Y$/i;
2245 next unless $taxable_charged;
2247 if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2248 #my ($mon,$year) = (localtime($sdate) )[4,5];
2249 my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2251 my $freq = $part_pkg->freq || 1;
2252 if ( $freq !~ /(\d+)$/ ) {
2253 $dbh->rollback if $oldAutoCommit;
2254 return "daily/weekly package definitions not (yet?)".
2255 " compatible with monthly tax exemptions";
2257 my $taxable_per_month =
2258 sprintf("%.2f", $taxable_charged / $freq );
2260 #call the whole thing off if this customer has any old
2261 #exemption records...
2262 my @cust_tax_exempt =
2263 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2264 if ( @cust_tax_exempt ) {
2265 $dbh->rollback if $oldAutoCommit;
2267 'this customer still has old-style tax exemption records; '.
2268 'run bin/fs-migrate-cust_tax_exempt?';
2271 foreach my $which_month ( 1 .. $freq ) {
2273 #maintain the new exemption table now
2276 FROM cust_tax_exempt_pkg
2277 LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2278 LEFT JOIN cust_bill USING ( invnum )
2284 my $sth = dbh->prepare($sql) or do {
2285 $dbh->rollback if $oldAutoCommit;
2286 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2294 $dbh->rollback if $oldAutoCommit;
2295 return "fatal: can't lookup exising exemption: ". dbh->errstr;
2297 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2299 my $remaining_exemption =
2300 $tax->exempt_amount - $existing_exemption;
2301 if ( $remaining_exemption > 0 ) {
2302 my $addl = $remaining_exemption > $taxable_per_month
2303 ? $taxable_per_month
2304 : $remaining_exemption;
2305 $taxable_charged -= $addl;
2307 my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2308 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2309 'taxnum' => $tax->taxnum,
2310 'year' => 1900+$year,
2312 'amount' => sprintf("%.2f", $addl ),
2314 $error = $cust_tax_exempt_pkg->insert;
2316 $dbh->rollback if $oldAutoCommit;
2317 return "fatal: can't insert cust_tax_exempt_pkg: $error";
2319 } # if $remaining_exemption > 0
2323 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2324 until ( $mon < 13 ) { $mon -= 12; $year++; }
2326 } #foreach $which_month
2328 } #if $tax->exempt_amount
2330 $taxable_charged = sprintf( "%.2f", $taxable_charged);
2332 #$tax += $taxable_charged * $cust_main_county->tax / 100
2333 $tax{ $tax->taxname || 'Tax' } +=
2334 $taxable_charged * $tax->tax / 100
2336 } #foreach my $tax ( @taxes )
2338 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2340 } #if $setup != 0 || $recur != 0
2342 } #if $cust_pkg->modified
2344 } #foreach my $cust_pkg
2346 unless ( $cust_bill->cust_bill_pkg ) {
2347 $cust_bill->delete; #don't create an invoice w/o line items
2349 # XXX this seems to be broken
2350 #( DBD::Pg::st execute failed: ERROR: syntax error at or near "hcb" )
2351 # # get rid of our fake history too, waste of unecessary space
2352 # my $h_cleanup_query = q{
2353 # DELETE FROM h_cust_bill hcb
2354 # WHERE hcb.invnum = ?
2355 # AND NOT EXISTS ( SELECT 1 FROM cust_bill cb where cb.invnum = hcb.invnum )
2357 # my $h_sth = $dbh->prepare($h_cleanup_query);
2358 # $h_sth->execute($invnum);
2360 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2364 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2366 foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2367 my $tax = sprintf("%.2f", $tax{$taxname} );
2368 $charged = sprintf( "%.2f", $charged+$tax );
2370 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2371 'invnum' => $invnum,
2377 'itemdesc' => $taxname,
2379 $error = $cust_bill_pkg->insert;
2381 $dbh->rollback if $oldAutoCommit;
2382 return "can't create invoice line item for invoice #$invnum: $error";
2384 $total_setup += $tax;
2388 $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2389 $error = $cust_bill->replace;
2391 $dbh->rollback if $oldAutoCommit;
2392 return "can't update charged for invoice #$invnum: $error";
2395 foreach my $hook ( @precommit_hooks ) {
2397 &{$hook}; #($self) ?
2400 $dbh->rollback if $oldAutoCommit;
2401 return "$@ running precommit hook $hook\n";
2405 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2409 =item collect OPTIONS
2411 (Attempt to) collect money for this customer's outstanding invoices (see
2412 L<FS::cust_bill>). Usually used after the bill method.
2414 Actions are now triggered by billing events; see L<FS::part_event> and the
2415 billing events web interface. Old-style invoice events (see
2416 L<FS::part_bill_event>) have been deprecated.
2418 If there is an error, returns the error, otherwise returns false.
2420 Options are passed as name-value pairs.
2422 Currently available options are:
2426 =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.
2428 =item retry - Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2430 =item quiet - set true to surpress email card/ACH decline notices.
2432 =item check_freq - "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2434 =item payby - allows for one time override of normal customer billing method
2441 my( $self, %options ) = @_;
2442 my $invoice_time = $options{'invoice_time'} || time;
2445 local $SIG{HUP} = 'IGNORE';
2446 local $SIG{INT} = 'IGNORE';
2447 local $SIG{QUIT} = 'IGNORE';
2448 local $SIG{TERM} = 'IGNORE';
2449 local $SIG{TSTP} = 'IGNORE';
2450 local $SIG{PIPE} = 'IGNORE';
2452 my $oldAutoCommit = $FS::UID::AutoCommit;
2453 local $FS::UID::AutoCommit = 0;
2456 $self->select_for_update; #mutex
2459 my $balance = $self->balance;
2460 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2463 if ( exists($options{'retry_card'}) ) {
2464 carp 'retry_card option passed to collect is deprecated; use retry';
2465 $options{'retry'} ||= $options{'retry_card'};
2467 if ( exists($options{'retry'}) && $options{'retry'} ) {
2468 my $error = $self->retry_realtime;
2470 $dbh->rollback if $oldAutoCommit;
2475 # false laziness w/pay_batch::import_results
2477 my $due_cust_event = $self->due_cust_event(
2478 'time' => $invoice_time,
2479 'check_freq' => $options{'check_freq'},
2481 unless( ref($due_cust_event) ) {
2482 $dbh->rollback if $oldAutoCommit;
2483 return $due_cust_event;
2486 foreach my $cust_event ( @$due_cust_event ) {
2490 #re-eval event conditions (a previous event could have changed things)
2491 next unless $cust_event->test_conditions( 'time' => $invoice_time );
2494 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2495 warn " running cust_event ". $cust_event->eventnum. "\n"
2499 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2500 if ( my $error = $cust_event->do_event() ) {
2501 #XXX wtf is this? figure out a proper dealio with return value
2503 # gah, even with transactions.
2504 $dbh->commit if $oldAutoCommit; #well.
2511 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2516 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2518 Inserts database records for and returns an ordered listref of new events due
2519 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2520 events are due, an empty listref is returned. If there is an error, returns a
2521 scalar error message.
2523 To actually run the events, call each event's test_condition method, and if
2524 still true, call the event's do_event method.
2526 Options are passed as a hashref or as a list of name-value pairs. Available
2531 =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.
2533 =item time - "Current time" for the events.
2535 =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)
2537 =item eventtable - Only return events for the specified eventtable (by default, events of all eventtables are returned)
2539 =item objects - Explicitly pass the objects to be tested (typically used with eventtable).
2545 sub due_cust_event {
2547 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2550 #my $DEBUG = $opt{'debug'}
2551 local($DEBUG) = $opt{'debug'}
2552 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2554 warn "$me due_cust_event called with options ".
2555 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2558 $opt{'time'} ||= time;
2560 local $SIG{HUP} = 'IGNORE';
2561 local $SIG{INT} = 'IGNORE';
2562 local $SIG{QUIT} = 'IGNORE';
2563 local $SIG{TERM} = 'IGNORE';
2564 local $SIG{TSTP} = 'IGNORE';
2565 local $SIG{PIPE} = 'IGNORE';
2567 my $oldAutoCommit = $FS::UID::AutoCommit;
2568 local $FS::UID::AutoCommit = 0;
2571 $self->select_for_update; #mutex
2574 # 1: find possible events (initial search)
2577 my @cust_event = ();
2579 my @eventtable = $opt{'eventtable'}
2580 ? ( $opt{'eventtable'} )
2581 : FS::part_event->eventtables_runorder;
2583 foreach my $eventtable ( @eventtable ) {
2586 if ( $opt{'objects'} ) {
2588 @objects = @{ $opt{'objects'} };
2592 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2593 @objects = ( $eventtable eq 'cust_main' )
2595 : ( $self->$eventtable() );
2599 my @e_cust_event = ();
2601 my $cross = "CROSS JOIN $eventtable";
2602 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2603 unless $eventtable eq 'cust_main';
2605 foreach my $object ( @objects ) {
2607 #this first search uses the condition_sql magic for optimization.
2608 #the more possible events we can eliminate in this step the better
2610 my $cross_where = '';
2611 my $pkey = $object->primary_key;
2612 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2614 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2616 FS::part_event_condition->where_conditions_sql( $eventtable,
2617 'time'=>$opt{'time'}
2619 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2621 $extra_sql = "AND $extra_sql" if $extra_sql;
2623 #here is the agent virtualization
2624 $extra_sql .= " AND ( part_event.agentnum IS NULL
2625 OR part_event.agentnum = ". $self->agentnum. ' )';
2627 $extra_sql .= " $order";
2629 my @part_event = qsearch( {
2630 'select' => 'part_event.*',
2631 'table' => 'part_event',
2632 'addl_from' => "$cross $join",
2633 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2634 'eventtable' => $eventtable,
2637 'extra_sql' => "AND $cross_where $extra_sql",
2641 my $pkey = $object->primary_key;
2642 warn " ". scalar(@part_event).
2643 " possible events found for $eventtable ". $object->$pkey(). "\n";
2646 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2650 warn " ". scalar(@e_cust_event).
2651 " subtotal possible cust events found for $eventtable"
2654 push @cust_event, @e_cust_event;
2658 warn " ". scalar(@cust_event).
2659 " total possible cust events found in initial search\n"
2663 # 2: test conditions
2668 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
2669 'stats_hashref' => \%unsat ),
2672 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2675 warn " invalid conditions not eliminated with condition_sql:\n".
2676 join('', map " $_: ".$unsat{$_}."\n", keys %unsat );
2682 foreach my $cust_event ( @cust_event ) {
2684 my $error = $cust_event->insert();
2686 $dbh->rollback if $oldAutoCommit;
2692 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2698 warn " returning events: ". Dumper(@cust_event). "\n"
2705 =item retry_realtime
2707 Schedules realtime / batch credit card / electronic check / LEC billing
2708 events for for retry. Useful if card information has changed or manual
2709 retry is desired. The 'collect' method must be called to actually retry
2712 Implementation details: For either this customer, or for each of this
2713 customer's open invoices, changes the status of the first "done" (with
2714 statustext error) realtime processing event to "failed".
2718 sub retry_realtime {
2721 local $SIG{HUP} = 'IGNORE';
2722 local $SIG{INT} = 'IGNORE';
2723 local $SIG{QUIT} = 'IGNORE';
2724 local $SIG{TERM} = 'IGNORE';
2725 local $SIG{TSTP} = 'IGNORE';
2726 local $SIG{PIPE} = 'IGNORE';
2728 my $oldAutoCommit = $FS::UID::AutoCommit;
2729 local $FS::UID::AutoCommit = 0;
2732 #a little false laziness w/due_cust_event (not too bad, really)
2734 my $join = FS::part_event_condition->join_conditions_sql;
2735 my $order = FS::part_event_condition->order_conditions_sql;
2738 . join ( ' OR ' , map {
2739 "( part_event.eventtable = " . dbh->quote($_)
2740 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
2741 } FS::part_event->eventtables)
2744 #here is the agent virtualization
2745 my $agent_virt = " ( part_event.agentnum IS NULL
2746 OR part_event.agentnum = ". $self->agentnum. ' )';
2748 #XXX this shouldn't be hardcoded, actions should declare it...
2749 my @realtime_events = qw(
2750 cust_bill_realtime_card
2751 cust_bill_realtime_check
2752 cust_bill_realtime_lec
2756 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
2761 my @cust_event = qsearchs({
2762 'table' => 'cust_event',
2763 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
2764 'hashref' => { 'status' => 'done' },
2765 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
2766 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
2769 my %seen_invnum = ();
2770 foreach my $cust_event (@cust_event) {
2772 #max one for the customer, one for each open invoice
2773 my $cust_X = $cust_event->cust_X;
2774 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
2778 or $cust_event->part_event->eventtable eq 'cust_bill'
2781 my $error = $cust_event->retry;
2783 $dbh->rollback if $oldAutoCommit;
2784 return "error scheduling event for retry: $error";
2789 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2794 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2796 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2797 via a Business::OnlinePayment realtime gateway. See
2798 L<http://420.am/business-onlinepayment> for supported gateways.
2800 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2802 Available options are: I<description>, I<invnum>, I<quiet>
2804 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2805 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2806 if set, will override the value from the customer record.
2808 I<description> is a free-text field passed to the gateway. It defaults to
2809 "Internet services".
2811 If an I<invnum> is specified, this payment (if successful) is applied to the
2812 specified invoice. If you don't specify an I<invnum> you might want to
2813 call the B<apply_payments> method.
2815 I<quiet> can be set true to surpress email decline notices.
2817 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2822 my( $self, $method, $amount, %options ) = @_;
2824 warn "$me realtime_bop: $method $amount\n";
2825 warn " $_ => $options{$_}\n" foreach keys %options;
2828 $options{'description'} ||= 'Internet services';
2830 eval "use Business::OnlinePayment";
2833 my $payinfo = exists($options{'payinfo'})
2834 ? $options{'payinfo'}
2837 my %method2payby = (
2844 # check for banned credit card/ACH
2847 my $ban = qsearchs('banned_pay', {
2848 'payby' => $method2payby{$method},
2849 'payinfo' => md5_base64($payinfo),
2851 return "Banned credit card" if $ban;
2858 if ( $options{'invnum'} ) {
2859 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2860 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2862 map { $_->part_pkg->taxclass }
2864 map { $_->cust_pkg }
2865 $cust_bill->cust_bill_pkg;
2866 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2867 #different taxclasses
2868 $taxclass = $taxclasses[0];
2872 #look for an agent gateway override first
2874 if ( $method eq 'CC' ) {
2875 $cardtype = cardtype($payinfo);
2876 } elsif ( $method eq 'ECHECK' ) {
2879 $cardtype = $method;
2883 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2884 cardtype => $cardtype,
2885 taxclass => $taxclass, } )
2886 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2888 taxclass => $taxclass, } )
2889 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2890 cardtype => $cardtype,
2892 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2894 taxclass => '', } );
2896 my $payment_gateway = '';
2897 my( $processor, $login, $password, $action, @bop_options );
2898 if ( $override ) { #use a payment gateway override
2900 $payment_gateway = $override->payment_gateway;
2902 $processor = $payment_gateway->gateway_module;
2903 $login = $payment_gateway->gateway_username;
2904 $password = $payment_gateway->gateway_password;
2905 $action = $payment_gateway->gateway_action;
2906 @bop_options = $payment_gateway->options;
2908 } else { #use the standard settings from the config
2910 ( $processor, $login, $password, $action, @bop_options ) =
2911 $self->default_payment_gateway($method);
2919 my $address = exists($options{'address1'})
2920 ? $options{'address1'}
2922 my $address2 = exists($options{'address2'})
2923 ? $options{'address2'}
2925 $address .= ", ". $address2 if length($address2);
2927 my $o_payname = exists($options{'payname'})
2928 ? $options{'payname'}
2930 my($payname, $payfirst, $paylast);
2931 if ( $o_payname && $method ne 'ECHECK' ) {
2932 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2933 or return "Illegal payname $payname";
2934 ($payfirst, $paylast) = ($1, $2);
2936 $payfirst = $self->getfield('first');
2937 $paylast = $self->getfield('last');
2938 $payname = "$payfirst $paylast";
2941 my @invoicing_list = $self->invoicing_list_emailonly;
2942 if ( $conf->exists('emailinvoiceautoalways')
2943 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
2944 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2945 push @invoicing_list, $self->all_emails;
2948 my $email = ($conf->exists('business-onlinepayment-email-override'))
2949 ? $conf->config('business-onlinepayment-email-override')
2950 : $invoicing_list[0];
2954 my $payip = exists($options{'payip'})
2957 $content{customer_ip} = $payip
2960 $content{invoice_number} = $options{'invnum'}
2961 if exists($options{'invnum'}) && length($options{'invnum'});
2964 if ( $method eq 'CC' ) {
2966 $content{card_number} = $payinfo;
2967 $paydate = exists($options{'paydate'})
2968 ? $options{'paydate'}
2970 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2971 $content{expiration} = "$2/$1";
2973 my $paycvv = exists($options{'paycvv'})
2974 ? $options{'paycvv'}
2976 $content{cvv2} = $self->paycvv
2979 my $paystart_month = exists($options{'paystart_month'})
2980 ? $options{'paystart_month'}
2981 : $self->paystart_month;
2983 my $paystart_year = exists($options{'paystart_year'})
2984 ? $options{'paystart_year'}
2985 : $self->paystart_year;
2987 $content{card_start} = "$paystart_month/$paystart_year"
2988 if $paystart_month && $paystart_year;
2990 my $payissue = exists($options{'payissue'})
2991 ? $options{'payissue'}
2993 $content{issue_number} = $payissue if $payissue;
2995 $content{recurring_billing} = 'YES'
2996 if qsearch('cust_pay', { 'custnum' => $self->custnum,
2998 'payinfo' => $payinfo,
3000 || qsearch('cust_pay', { 'custnum' => $self->custnum,
3002 'paymask' => $self->mask_payinfo('CARD', $payinfo),
3006 } elsif ( $method eq 'ECHECK' ) {
3007 ( $content{account_number}, $content{routing_code} ) =
3008 split('@', $payinfo);
3009 $content{bank_name} = $o_payname;
3010 $content{bank_state} = exists($options{'paystate'})
3011 ? $options{'paystate'}
3012 : $self->getfield('paystate');
3013 $content{account_type} = exists($options{'paytype'})
3014 ? uc($options{'paytype'}) || 'CHECKING'
3015 : uc($self->getfield('paytype')) || 'CHECKING';
3016 $content{account_name} = $payname;
3017 $content{customer_org} = $self->company ? 'B' : 'I';
3018 $content{state_id} = exists($options{'stateid'})
3019 ? $options{'stateid'}
3020 : $self->getfield('stateid');
3021 $content{state_id_state} = exists($options{'stateid_state'})
3022 ? $options{'stateid_state'}
3023 : $self->getfield('stateid_state');
3024 $content{customer_ssn} = exists($options{'ss'})
3027 } elsif ( $method eq 'LEC' ) {
3028 $content{phone} = $payinfo;
3032 # run transaction(s)
3035 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3037 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3038 $transaction->content(
3041 'password' => $password,
3042 'action' => $action1,
3043 'description' => $options{'description'},
3044 'amount' => $amount,
3045 #'invoice_number' => $options{'invnum'},
3046 'customer_id' => $self->custnum,
3047 'last_name' => $paylast,
3048 'first_name' => $payfirst,
3050 'address' => $address,
3051 'city' => ( exists($options{'city'})
3054 'state' => ( exists($options{'state'})
3057 'zip' => ( exists($options{'zip'})
3060 'country' => ( exists($options{'country'})
3061 ? $options{'country'}
3063 'referer' => 'http://cleanwhisker.420.am/',
3065 'phone' => $self->daytime || $self->night,
3068 $transaction->submit();
3070 if ( $transaction->is_success() && $action2 ) {
3071 my $auth = $transaction->authorization;
3072 my $ordernum = $transaction->can('order_number')
3073 ? $transaction->order_number
3077 new Business::OnlinePayment( $processor, @bop_options );
3084 password => $password,
3085 order_number => $ordernum,
3087 authorization => $auth,
3088 description => $options{'description'},
3091 foreach my $field (qw( authorization_source_code returned_ACI
3092 transaction_identifier validation_code
3093 transaction_sequence_num local_transaction_date
3094 local_transaction_time AVS_result_code )) {
3095 $capture{$field} = $transaction->$field() if $transaction->can($field);
3098 $capture->content( %capture );
3102 unless ( $capture->is_success ) {
3103 my $e = "Authorization successful but capture failed, custnum #".
3104 $self->custnum. ': '. $capture->result_code.
3105 ": ". $capture->error_message;
3113 # remove paycvv after initial transaction
3116 #false laziness w/misc/process/payment.cgi - check both to make sure working
3118 if ( defined $self->dbdef_table->column('paycvv')
3119 && length($self->paycvv)
3120 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3122 my $error = $self->remove_cvv;
3124 warn "WARNING: error removing cvv: $error\n";
3132 if ( $transaction->is_success() ) {
3134 my %method2payby = (
3141 if ( $payment_gateway ) { # agent override
3142 $paybatch = $payment_gateway->gatewaynum. '-';
3145 $paybatch .= "$processor:". $transaction->authorization;
3147 $paybatch .= ':'. $transaction->order_number
3148 if $transaction->can('order_number')
3149 && length($transaction->order_number);
3151 my $cust_pay = new FS::cust_pay ( {
3152 'custnum' => $self->custnum,
3153 'invnum' => $options{'invnum'},
3156 'payby' => $method2payby{$method},
3157 'payinfo' => $payinfo,
3158 'paybatch' => $paybatch,
3159 'paydate' => $paydate,
3161 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3163 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3166 $cust_pay->invnum(''); #try again with no specific invnum
3167 my $error2 = $cust_pay->insert( $options{'manual'} ?
3168 ( 'manual' => 1 ) : ()
3171 # gah, even with transactions.
3172 my $e = 'WARNING: Card/ACH debited but database not updated - '.
3173 "error inserting payment ($processor): $error2".
3174 " (previously tried insert with invnum #$options{'invnum'}" .
3180 return ''; #no error
3184 my $perror = "$processor error: ". $transaction->error_message;
3186 unless ( $transaction->error_message ) {
3189 if ( $transaction->can('response_page') ) {
3191 'page' => ( $transaction->can('response_page')
3192 ? $transaction->response_page
3195 'code' => ( $transaction->can('response_code')
3196 ? $transaction->response_code
3199 'headers' => ( $transaction->can('response_headers')
3200 ? $transaction->response_headers
3206 "No additional debugging information available for $processor";
3209 $perror .= "No error_message returned from $processor -- ".
3210 ( ref($t_response) ? Dumper($t_response) : $t_response );
3214 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3215 && $conf->exists('emaildecline')
3216 && grep { $_ ne 'POST' } $self->invoicing_list
3217 && ! grep { $transaction->error_message =~ /$_/ }
3218 $conf->config('emaildecline-exclude')
3220 my @templ = $conf->config('declinetemplate');
3221 my $template = new Text::Template (
3223 SOURCE => [ map "$_\n", @templ ],
3224 ) or return "($perror) can't create template: $Text::Template::ERROR";
3225 $template->compile()
3226 or return "($perror) can't compile template: $Text::Template::ERROR";
3228 my $templ_hash = { error => $transaction->error_message };
3230 my $error = send_email(
3231 'from' => $conf->config('invoice_from'),
3232 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3233 'subject' => 'Your payment could not be processed',
3234 'body' => [ $template->fill_in(HASH => $templ_hash) ],
3237 $perror .= " (also received error sending decline notification: $error)"
3247 =item default_payment_gateway
3251 sub default_payment_gateway {
3252 my( $self, $method ) = @_;
3254 die "Real-time processing not enabled\n"
3255 unless $conf->exists('business-onlinepayment');
3258 my $bop_config = 'business-onlinepayment';
3259 $bop_config .= '-ach'
3260 if $method eq 'ECHECK' && $conf->exists($bop_config. '-ach');
3261 my ( $processor, $login, $password, $action, @bop_options ) =
3262 $conf->config($bop_config);
3263 $action ||= 'normal authorization';
3264 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3265 die "No real-time processor is enabled - ".
3266 "did you set the business-onlinepayment configuration value?\n"
3269 ( $processor, $login, $password, $action, @bop_options )
3274 Removes the I<paycvv> field from the database directly.
3276 If there is an error, returns the error, otherwise returns false.
3282 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3283 or return dbh->errstr;
3284 $sth->execute($self->custnum)
3285 or return $sth->errstr;
3290 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3292 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3293 via a Business::OnlinePayment realtime gateway. See
3294 L<http://420.am/business-onlinepayment> for supported gateways.
3296 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3298 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3300 Most gateways require a reference to an original payment transaction to refund,
3301 so you probably need to specify a I<paynum>.
3303 I<amount> defaults to the original amount of the payment if not specified.
3305 I<reason> specifies a reason for the refund.
3307 I<paydate> specifies the expiration date for a credit card overriding the
3308 value from the customer record or the payment record. Specified as yyyy-mm-dd
3310 Implementation note: If I<amount> is unspecified or equal to the amount of the
3311 orignal payment, first an attempt is made to "void" the transaction via
3312 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3313 the normal attempt is made to "refund" ("credit") the transaction via the
3314 gateway is attempted.
3316 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3317 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3318 #if set, will override the value from the customer record.
3320 #If an I<invnum> is specified, this payment (if successful) is applied to the
3321 #specified invoice. If you don't specify an I<invnum> you might want to
3322 #call the B<apply_payments> method.
3326 #some false laziness w/realtime_bop, not enough to make it worth merging
3327 #but some useful small subs should be pulled out
3328 sub realtime_refund_bop {
3329 my( $self, $method, %options ) = @_;
3331 warn "$me realtime_refund_bop: $method refund\n";
3332 warn " $_ => $options{$_}\n" foreach keys %options;
3335 eval "use Business::OnlinePayment";
3339 # look up the original payment and optionally a gateway for that payment
3343 my $amount = $options{'amount'};
3345 my( $processor, $login, $password, @bop_options ) ;
3346 my( $auth, $order_number ) = ( '', '', '' );
3348 if ( $options{'paynum'} ) {
3350 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
3351 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3352 or return "Unknown paynum $options{'paynum'}";
3353 $amount ||= $cust_pay->paid;
3355 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3356 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3357 $cust_pay->paybatch;
3358 my $gatewaynum = '';
3359 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3361 if ( $gatewaynum ) { #gateway for the payment to be refunded
3363 my $payment_gateway =
3364 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3365 die "payment gateway $gatewaynum not found"
3366 unless $payment_gateway;
3368 $processor = $payment_gateway->gateway_module;
3369 $login = $payment_gateway->gateway_username;
3370 $password = $payment_gateway->gateway_password;
3371 @bop_options = $payment_gateway->options;
3373 } else { #try the default gateway
3375 my( $conf_processor, $unused_action );
3376 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3377 $self->default_payment_gateway($method);
3379 return "processor of payment $options{'paynum'} $processor does not".
3380 " match default processor $conf_processor"
3381 unless $processor eq $conf_processor;
3386 } else { # didn't specify a paynum, so look for agent gateway overrides
3387 # like a normal transaction
3390 if ( $method eq 'CC' ) {
3391 $cardtype = cardtype($self->payinfo);
3392 } elsif ( $method eq 'ECHECK' ) {
3395 $cardtype = $method;
3398 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3399 cardtype => $cardtype,
3401 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3403 taxclass => '', } );
3405 if ( $override ) { #use a payment gateway override
3407 my $payment_gateway = $override->payment_gateway;
3409 $processor = $payment_gateway->gateway_module;
3410 $login = $payment_gateway->gateway_username;
3411 $password = $payment_gateway->gateway_password;
3412 #$action = $payment_gateway->gateway_action;
3413 @bop_options = $payment_gateway->options;
3415 } else { #use the standard settings from the config
3418 ( $processor, $login, $password, $unused_action, @bop_options ) =
3419 $self->default_payment_gateway($method);
3424 return "neither amount nor paynum specified" unless $amount;
3429 'password' => $password,
3430 'order_number' => $order_number,
3431 'amount' => $amount,
3432 'referer' => 'http://cleanwhisker.420.am/',
3434 $content{authorization} = $auth
3435 if length($auth); #echeck/ACH transactions have an order # but no auth
3436 #(at least with authorize.net)
3438 my $disable_void_after;
3439 if ($conf->exists('disable_void_after')
3440 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3441 $disable_void_after = $1;
3444 #first try void if applicable
3445 if ( $cust_pay && $cust_pay->paid == $amount
3447 ( not defined($disable_void_after) )
3448 || ( time < ($cust_pay->_date + $disable_void_after ) )
3451 warn " attempting void\n" if $DEBUG > 1;
3452 my $void = new Business::OnlinePayment( $processor, @bop_options );
3453 $void->content( 'action' => 'void', %content );
3455 if ( $void->is_success ) {
3456 my $error = $cust_pay->void($options{'reason'});
3458 # gah, even with transactions.
3459 my $e = 'WARNING: Card/ACH voided but database not updated - '.
3460 "error voiding payment: $error";
3464 warn " void successful\n" if $DEBUG > 1;
3469 warn " void unsuccessful, trying refund\n"
3473 my $address = $self->address1;
3474 $address .= ", ". $self->address2 if $self->address2;
3476 my($payname, $payfirst, $paylast);
3477 if ( $self->payname && $method ne 'ECHECK' ) {
3478 $payname = $self->payname;
3479 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3480 or return "Illegal payname $payname";
3481 ($payfirst, $paylast) = ($1, $2);
3483 $payfirst = $self->getfield('first');
3484 $paylast = $self->getfield('last');
3485 $payname = "$payfirst $paylast";
3488 my @invoicing_list = $self->invoicing_list_emailonly;
3489 if ( $conf->exists('emailinvoiceautoalways')
3490 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3491 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3492 push @invoicing_list, $self->all_emails;
3495 my $email = ($conf->exists('business-onlinepayment-email-override'))
3496 ? $conf->config('business-onlinepayment-email-override')
3497 : $invoicing_list[0];
3499 my $payip = exists($options{'payip'})
3502 $content{customer_ip} = $payip
3506 if ( $method eq 'CC' ) {
3509 $content{card_number} = $payinfo = $cust_pay->payinfo;
3510 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3511 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3512 ($content{expiration} = "$2/$1"); # where available
3514 $content{card_number} = $payinfo = $self->payinfo;
3515 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3516 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3517 $content{expiration} = "$2/$1";
3520 } elsif ( $method eq 'ECHECK' ) {
3523 $payinfo = $cust_pay->payinfo;
3525 $payinfo = $self->payinfo;
3527 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3528 $content{bank_name} = $self->payname;
3529 $content{account_type} = 'CHECKING';
3530 $content{account_name} = $payname;
3531 $content{customer_org} = $self->company ? 'B' : 'I';
3532 $content{customer_ssn} = $self->ss;
3533 } elsif ( $method eq 'LEC' ) {
3534 $content{phone} = $payinfo = $self->payinfo;
3538 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3539 my %sub_content = $refund->content(
3540 'action' => 'credit',
3541 'customer_id' => $self->custnum,
3542 'last_name' => $paylast,
3543 'first_name' => $payfirst,
3545 'address' => $address,
3546 'city' => $self->city,
3547 'state' => $self->state,
3548 'zip' => $self->zip,
3549 'country' => $self->country,
3551 'phone' => $self->daytime || $self->night,
3554 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3558 return "$processor error: ". $refund->error_message
3559 unless $refund->is_success();
3561 my %method2payby = (
3567 my $paybatch = "$processor:". $refund->authorization;
3568 $paybatch .= ':'. $refund->order_number
3569 if $refund->can('order_number') && $refund->order_number;
3571 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3572 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3573 last unless @cust_bill_pay;
3574 my $cust_bill_pay = pop @cust_bill_pay;
3575 my $error = $cust_bill_pay->delete;
3579 my $cust_refund = new FS::cust_refund ( {
3580 'custnum' => $self->custnum,
3581 'paynum' => $options{'paynum'},
3582 'refund' => $amount,
3584 'payby' => $method2payby{$method},
3585 'payinfo' => $payinfo,
3586 'paybatch' => $paybatch,
3587 'reason' => $options{'reason'} || 'card or ACH refund',
3589 my $error = $cust_refund->insert;
3591 $cust_refund->paynum(''); #try again with no specific paynum
3592 my $error2 = $cust_refund->insert;
3594 # gah, even with transactions.
3595 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3596 "error inserting refund ($processor): $error2".
3597 " (previously tried insert with paynum #$options{'paynum'}" .
3608 =item batch_card OPTION => VALUE...
3610 Adds a payment for this invoice to the pending credit card batch (see
3611 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3612 runs the payment using a realtime gateway.
3617 my ($self, %options) = @_;
3620 if (exists($options{amount})) {
3621 $amount = $options{amount};
3623 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3625 return '' unless $amount > 0;
3627 my $invnum = delete $options{invnum};
3628 my $payby = $options{invnum} || $self->payby; #dubious
3630 if ($options{'realtime'}) {
3631 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3637 my $oldAutoCommit = $FS::UID::AutoCommit;
3638 local $FS::UID::AutoCommit = 0;
3641 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3642 or return "Cannot lock pay_batch: " . $dbh->errstr;
3646 'payby' => FS::payby->payby2payment($payby),
3649 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3651 unless ( $pay_batch ) {
3652 $pay_batch = new FS::pay_batch \%pay_batch;
3653 my $error = $pay_batch->insert;
3655 $dbh->rollback if $oldAutoCommit;
3656 die "error creating new batch: $error\n";
3660 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3661 'batchnum' => $pay_batch->batchnum,
3662 'custnum' => $self->custnum,
3665 foreach (qw( address1 address2 city state zip country payby payinfo paydate
3667 $options{$_} = '' unless exists($options{$_});
3670 my $cust_pay_batch = new FS::cust_pay_batch ( {
3671 'batchnum' => $pay_batch->batchnum,
3672 'invnum' => $invnum || 0, # is there a better value?
3673 # this field should be
3675 # cust_bill_pay_batch now
3676 'custnum' => $self->custnum,
3677 'last' => $self->getfield('last'),
3678 'first' => $self->getfield('first'),
3679 'address1' => $options{address1} || $self->address1,
3680 'address2' => $options{address2} || $self->address2,
3681 'city' => $options{city} || $self->city,
3682 'state' => $options{state} || $self->state,
3683 'zip' => $options{zip} || $self->zip,
3684 'country' => $options{country} || $self->country,
3685 'payby' => $options{payby} || $self->payby,
3686 'payinfo' => $options{payinfo} || $self->payinfo,
3687 'exp' => $options{paydate} || $self->paydate,
3688 'payname' => $options{payname} || $self->payname,
3689 'amount' => $amount, # consolidating
3692 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
3693 if $old_cust_pay_batch;
3696 if ($old_cust_pay_batch) {
3697 $error = $cust_pay_batch->replace($old_cust_pay_batch)
3699 $error = $cust_pay_batch->insert;
3703 $dbh->rollback if $oldAutoCommit;
3707 my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
3708 foreach my $cust_bill ($self->open_cust_bill) {
3709 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
3710 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
3711 'invnum' => $cust_bill->invnum,
3712 'paybatchnum' => $cust_pay_batch->paybatchnum,
3713 'amount' => $cust_bill->owed,
3716 if ($unapplied >= $cust_bill_pay_batch->amount){
3717 $unapplied -= $cust_bill_pay_batch->amount;
3720 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
3721 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
3723 $error = $cust_bill_pay_batch->insert;
3725 $dbh->rollback if $oldAutoCommit;
3730 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3736 Returns the total owed for this customer on all invoices
3737 (see L<FS::cust_bill/owed>).
3743 $self->total_owed_date(2145859200); #12/31/2037
3746 =item total_owed_date TIME
3748 Returns the total owed for this customer on all invoices with date earlier than
3749 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
3750 see L<Time::Local> and L<Date::Parse> for conversion functions.
3754 sub total_owed_date {
3758 foreach my $cust_bill (
3759 grep { $_->_date <= $time }
3760 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3762 $total_bill += $cust_bill->owed;
3764 sprintf( "%.2f", $total_bill );
3767 =item apply_payments_and_credits
3769 Applies unapplied payments and credits.
3771 In most cases, this new method should be used in place of sequential
3772 apply_payments and apply_credits methods.
3774 If there is an error, returns the error, otherwise returns false.
3778 sub apply_payments_and_credits {
3781 local $SIG{HUP} = 'IGNORE';
3782 local $SIG{INT} = 'IGNORE';
3783 local $SIG{QUIT} = 'IGNORE';
3784 local $SIG{TERM} = 'IGNORE';
3785 local $SIG{TSTP} = 'IGNORE';
3786 local $SIG{PIPE} = 'IGNORE';
3788 my $oldAutoCommit = $FS::UID::AutoCommit;
3789 local $FS::UID::AutoCommit = 0;
3792 $self->select_for_update; #mutex
3794 foreach my $cust_bill ( $self->open_cust_bill ) {
3795 my $error = $cust_bill->apply_payments_and_credits;
3797 $dbh->rollback if $oldAutoCommit;
3798 return "Error applying: $error";
3802 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3807 =item apply_credits OPTION => VALUE ...
3809 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3810 to outstanding invoice balances in chronological order (or reverse
3811 chronological order if the I<order> option is set to B<newest>) and returns the
3812 value of any remaining unapplied credits available for refund (see
3813 L<FS::cust_refund>).
3815 Dies if there is an error.
3823 local $SIG{HUP} = 'IGNORE';
3824 local $SIG{INT} = 'IGNORE';
3825 local $SIG{QUIT} = 'IGNORE';
3826 local $SIG{TERM} = 'IGNORE';
3827 local $SIG{TSTP} = 'IGNORE';
3828 local $SIG{PIPE} = 'IGNORE';
3830 my $oldAutoCommit = $FS::UID::AutoCommit;
3831 local $FS::UID::AutoCommit = 0;
3834 $self->select_for_update; #mutex
3836 unless ( $self->total_credited ) {
3837 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3841 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3842 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3844 my @invoices = $self->open_cust_bill;
3845 @invoices = sort { $b->_date <=> $a->_date } @invoices
3846 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3849 foreach my $cust_bill ( @invoices ) {
3852 if ( !defined($credit) || $credit->credited == 0) {
3853 $credit = pop @credits or last;
3856 if ($cust_bill->owed >= $credit->credited) {
3857 $amount=$credit->credited;
3859 $amount=$cust_bill->owed;
3862 my $cust_credit_bill = new FS::cust_credit_bill ( {
3863 'crednum' => $credit->crednum,
3864 'invnum' => $cust_bill->invnum,
3865 'amount' => $amount,
3867 my $error = $cust_credit_bill->insert;
3869 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3873 redo if ($cust_bill->owed > 0);
3877 my $total_credited = $self->total_credited;
3879 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3881 return $total_credited;
3884 =item apply_payments
3886 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3887 to outstanding invoice balances in chronological order.
3889 #and returns the value of any remaining unapplied payments.
3891 Dies if there is an error.
3895 sub apply_payments {
3898 local $SIG{HUP} = 'IGNORE';
3899 local $SIG{INT} = 'IGNORE';
3900 local $SIG{QUIT} = 'IGNORE';
3901 local $SIG{TERM} = 'IGNORE';
3902 local $SIG{TSTP} = 'IGNORE';
3903 local $SIG{PIPE} = 'IGNORE';
3905 my $oldAutoCommit = $FS::UID::AutoCommit;
3906 local $FS::UID::AutoCommit = 0;
3909 $self->select_for_update; #mutex
3913 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3914 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3916 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3917 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3921 foreach my $cust_bill ( @invoices ) {
3924 if ( !defined($payment) || $payment->unapplied == 0 ) {
3925 $payment = pop @payments or last;
3928 if ( $cust_bill->owed >= $payment->unapplied ) {
3929 $amount = $payment->unapplied;
3931 $amount = $cust_bill->owed;
3934 my $cust_bill_pay = new FS::cust_bill_pay ( {
3935 'paynum' => $payment->paynum,
3936 'invnum' => $cust_bill->invnum,
3937 'amount' => $amount,
3939 my $error = $cust_bill_pay->insert;
3941 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3945 redo if ( $cust_bill->owed > 0);
3949 my $total_unapplied_payments = $self->total_unapplied_payments;
3951 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3953 return $total_unapplied_payments;
3956 =item total_credited
3958 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3959 customer. See L<FS::cust_credit/credited>.
3963 sub total_credited {
3965 my $total_credit = 0;
3966 foreach my $cust_credit ( qsearch('cust_credit', {
3967 'custnum' => $self->custnum,
3969 $total_credit += $cust_credit->credited;
3971 sprintf( "%.2f", $total_credit );
3974 =item total_unapplied_payments
3976 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3977 See L<FS::cust_pay/unapplied>.
3981 sub total_unapplied_payments {
3983 my $total_unapplied = 0;
3984 foreach my $cust_pay ( qsearch('cust_pay', {
3985 'custnum' => $self->custnum,
3987 $total_unapplied += $cust_pay->unapplied;
3989 sprintf( "%.2f", $total_unapplied );
3992 =item total_unapplied_refunds
3994 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
3995 customer. See L<FS::cust_refund/unapplied>.
3999 sub total_unapplied_refunds {
4001 my $total_unapplied = 0;
4002 foreach my $cust_refund ( qsearch('cust_refund', {
4003 'custnum' => $self->custnum,
4005 $total_unapplied += $cust_refund->unapplied;
4007 sprintf( "%.2f", $total_unapplied );
4012 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4013 total_credited minus total_unapplied_payments).
4021 + $self->total_unapplied_refunds
4022 - $self->total_credited
4023 - $self->total_unapplied_payments
4027 =item balance_date TIME
4029 Returns the balance for this customer, only considering invoices with date
4030 earlier than TIME (total_owed_date minus total_credited minus
4031 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
4032 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
4041 $self->total_owed_date($time)
4042 + $self->total_unapplied_refunds
4043 - $self->total_credited
4044 - $self->total_unapplied_payments
4048 =item in_transit_payments
4050 Returns the total of requests for payments for this customer pending in
4051 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
4055 sub in_transit_payments {
4057 my $in_transit_payments = 0;
4058 foreach my $pay_batch ( qsearch('pay_batch', {
4061 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4062 'batchnum' => $pay_batch->batchnum,
4063 'custnum' => $self->custnum,
4065 $in_transit_payments += $cust_pay_batch->amount;
4068 sprintf( "%.2f", $in_transit_payments );
4071 =item paydate_monthyear
4073 Returns a two-element list consisting of the month and year of this customer's
4074 paydate (credit card expiration date for CARD customers)
4078 sub paydate_monthyear {
4080 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4082 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4089 =item invoicing_list [ ARRAYREF ]
4091 If an arguement is given, sets these email addresses as invoice recipients
4092 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
4093 (except as warnings), so use check_invoicing_list first.
4095 Returns a list of email addresses (with svcnum entries expanded).
4097 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
4098 check it without disturbing anything by passing nothing.
4100 This interface may change in the future.
4104 sub invoicing_list {
4105 my( $self, $arrayref ) = @_;
4108 my @cust_main_invoice;
4109 if ( $self->custnum ) {
4110 @cust_main_invoice =
4111 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4113 @cust_main_invoice = ();
4115 foreach my $cust_main_invoice ( @cust_main_invoice ) {
4116 #warn $cust_main_invoice->destnum;
4117 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4118 #warn $cust_main_invoice->destnum;
4119 my $error = $cust_main_invoice->delete;
4120 warn $error if $error;
4123 if ( $self->custnum ) {
4124 @cust_main_invoice =
4125 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4127 @cust_main_invoice = ();
4129 my %seen = map { $_->address => 1 } @cust_main_invoice;
4130 foreach my $address ( @{$arrayref} ) {
4131 next if exists $seen{$address} && $seen{$address};
4132 $seen{$address} = 1;
4133 my $cust_main_invoice = new FS::cust_main_invoice ( {
4134 'custnum' => $self->custnum,
4137 my $error = $cust_main_invoice->insert;
4138 warn $error if $error;
4142 if ( $self->custnum ) {
4144 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4151 =item check_invoicing_list ARRAYREF
4153 Checks these arguements as valid input for the invoicing_list method. If there
4154 is an error, returns the error, otherwise returns false.
4158 sub check_invoicing_list {
4159 my( $self, $arrayref ) = @_;
4161 foreach my $address ( @$arrayref ) {
4163 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4164 return 'Can\'t add FAX invoice destination with a blank FAX number.';
4167 my $cust_main_invoice = new FS::cust_main_invoice ( {
4168 'custnum' => $self->custnum,
4171 my $error = $self->custnum
4172 ? $cust_main_invoice->check
4173 : $cust_main_invoice->checkdest
4175 return $error if $error;
4179 return "Email address required"
4180 if $conf->exists('cust_main-require_invoicing_list_email')
4181 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4186 =item set_default_invoicing_list
4188 Sets the invoicing list to all accounts associated with this customer,
4189 overwriting any previous invoicing list.
4193 sub set_default_invoicing_list {
4195 $self->invoicing_list($self->all_emails);
4200 Returns the email addresses of all accounts provisioned for this customer.
4207 foreach my $cust_pkg ( $self->all_pkgs ) {
4208 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4210 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4211 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4213 $list{$_}=1 foreach map { $_->email } @svc_acct;
4218 =item invoicing_list_addpost
4220 Adds postal invoicing to this customer. If this customer is already configured
4221 to receive postal invoices, does nothing.
4225 sub invoicing_list_addpost {
4227 return if grep { $_ eq 'POST' } $self->invoicing_list;
4228 my @invoicing_list = $self->invoicing_list;
4229 push @invoicing_list, 'POST';
4230 $self->invoicing_list(\@invoicing_list);
4233 =item invoicing_list_emailonly
4235 Returns the list of email invoice recipients (invoicing_list without non-email
4236 destinations such as POST and FAX).
4240 sub invoicing_list_emailonly {
4242 warn "$me invoicing_list_emailonly called"
4244 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4247 =item invoicing_list_emailonly_scalar
4249 Returns the list of email invoice recipients (invoicing_list without non-email
4250 destinations such as POST and FAX) as a comma-separated scalar.
4254 sub invoicing_list_emailonly_scalar {
4256 warn "$me invoicing_list_emailonly_scalar called"
4258 join(', ', $self->invoicing_list_emailonly);
4261 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4263 Returns an array of customers referred by this customer (referral_custnum set
4264 to this custnum). If DEPTH is given, recurses up to the given depth, returning
4265 customers referred by customers referred by this customer and so on, inclusive.
4266 The default behavior is DEPTH 1 (no recursion).
4270 sub referral_cust_main {
4272 my $depth = @_ ? shift : 1;
4273 my $exclude = @_ ? shift : {};
4276 map { $exclude->{$_->custnum}++; $_; }
4277 grep { ! $exclude->{ $_->custnum } }
4278 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4282 map { $_->referral_cust_main($depth-1, $exclude) }
4289 =item referral_cust_main_ncancelled
4291 Same as referral_cust_main, except only returns customers with uncancelled
4296 sub referral_cust_main_ncancelled {
4298 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4301 =item referral_cust_pkg [ DEPTH ]
4303 Like referral_cust_main, except returns a flat list of all unsuspended (and
4304 uncancelled) packages for each customer. The number of items in this list may
4305 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4309 sub referral_cust_pkg {
4311 my $depth = @_ ? shift : 1;
4313 map { $_->unsuspended_pkgs }
4314 grep { $_->unsuspended_pkgs }
4315 $self->referral_cust_main($depth);
4318 =item referring_cust_main
4320 Returns the single cust_main record for the customer who referred this customer
4321 (referral_custnum), or false.
4325 sub referring_cust_main {
4327 return '' unless $self->referral_custnum;
4328 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4331 =item credit AMOUNT, REASON
4333 Applies a credit to this customer. If there is an error, returns the error,
4334 otherwise returns false.
4339 my( $self, $amount, $reason ) = @_;
4340 my $cust_credit = new FS::cust_credit {
4341 'custnum' => $self->custnum,
4342 'amount' => $amount,
4343 'reason' => $reason,
4345 $cust_credit->insert;
4348 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4350 Creates a one-time charge for this customer. If there is an error, returns
4351 the error, otherwise returns false.
4357 my ( $amount, $pkg, $comment, $taxclass, $additional );
4358 if ( ref( $_[0] ) ) {
4359 $amount = $_[0]->{amount};
4360 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4361 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
4362 : '$'. sprintf("%.2f",$amount);
4363 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4364 $additional = $_[0]->{additional};
4367 $pkg = @_ ? shift : 'One-time charge';
4368 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
4369 $taxclass = @_ ? shift : '';
4373 local $SIG{HUP} = 'IGNORE';
4374 local $SIG{INT} = 'IGNORE';
4375 local $SIG{QUIT} = 'IGNORE';
4376 local $SIG{TERM} = 'IGNORE';
4377 local $SIG{TSTP} = 'IGNORE';
4378 local $SIG{PIPE} = 'IGNORE';
4380 my $oldAutoCommit = $FS::UID::AutoCommit;
4381 local $FS::UID::AutoCommit = 0;
4384 my $part_pkg = new FS::part_pkg ( {
4386 'comment' => $comment,
4390 'taxclass' => $taxclass,
4393 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4394 ( 0 .. @$additional - 1 )
4396 'additional_count' => scalar(@$additional),
4397 'setup_fee' => $amount,
4400 my $error = $part_pkg->insert( options => \%options );
4402 $dbh->rollback if $oldAutoCommit;
4406 my $pkgpart = $part_pkg->pkgpart;
4407 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4408 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4409 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4410 $error = $type_pkgs->insert;
4412 $dbh->rollback if $oldAutoCommit;
4417 my $cust_pkg = new FS::cust_pkg ( {
4418 'custnum' => $self->custnum,
4419 'pkgpart' => $pkgpart,
4422 $error = $cust_pkg->insert;
4424 $dbh->rollback if $oldAutoCommit;
4428 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4435 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4441 sort { $a->_date <=> $b->_date }
4442 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4445 =item open_cust_bill
4447 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4452 sub open_cust_bill {
4454 grep { $_->owed > 0 } $self->cust_bill;
4459 Returns all the credits (see L<FS::cust_credit>) for this customer.
4465 sort { $a->_date <=> $b->_date }
4466 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4471 Returns all the payments (see L<FS::cust_pay>) for this customer.
4477 sort { $a->_date <=> $b->_date }
4478 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4483 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4489 sort { $a->_date <=> $b->_date }
4490 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4493 =item cust_pay_batch
4495 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
4499 sub cust_pay_batch {
4501 sort { $a->_date <=> $b->_date }
4502 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
4507 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4513 sort { $a->_date <=> $b->_date }
4514 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4519 Returns a name string for this customer, either "Company (Last, First)" or
4526 my $name = $self->contact;
4527 $name = $self->company. " ($name)" if $self->company;
4533 Returns a name string for this (service/shipping) contact, either
4534 "Company (Last, First)" or "Last, First".
4540 if ( $self->get('ship_last') ) {
4541 my $name = $self->ship_contact;
4542 $name = $self->ship_company. " ($name)" if $self->ship_company;
4551 Returns this customer's full (billing) contact name only, "Last, First"
4557 $self->get('last'). ', '. $self->first;
4562 Returns this customer's full (shipping) contact name only, "Last, First"
4568 $self->get('ship_last')
4569 ? $self->get('ship_last'). ', '. $self->ship_first
4575 Returns this customer's full country name
4581 code2country($self->country);
4588 Returns a status string for this customer, currently:
4592 =item prospect - No packages have ever been ordered
4594 =item active - One or more recurring packages is active
4596 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4598 =item suspended - All non-cancelled recurring packages are suspended
4600 =item cancelled - All recurring packages are cancelled
4606 sub status { shift->cust_status(@_); }
4610 for my $status (qw( prospect active inactive suspended cancelled )) {
4611 my $method = $status.'_sql';
4612 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4613 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4614 $sth->execute( ($self->custnum) x $numnum )
4615 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4616 return $status if $sth->fetchrow_arrayref->[0];
4620 =item ucfirst_cust_status
4622 =item ucfirst_status
4624 Returns the status with the first character capitalized.
4628 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4630 sub ucfirst_cust_status {
4632 ucfirst($self->cust_status);
4637 Returns a hex triplet color string for this customer's status.
4641 use vars qw(%statuscolor);
4642 tie my %statuscolor, 'Tie::IxHash',
4643 'prospect' => '7e0079', #'000000', #black? naw, purple
4644 'active' => '00CC00', #green
4645 'inactive' => '0000CC', #blue
4646 'suspended' => 'FF9900', #yellow
4647 'cancelled' => 'FF0000', #red
4650 sub statuscolor { shift->cust_statuscolor(@_); }
4652 sub cust_statuscolor {
4654 $statuscolor{$self->cust_status};
4659 Returns an array of hashes representing the customer's RT tickets.
4666 my $num = $conf->config('cust_main-max_tickets') || 10;
4669 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4671 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4675 foreach my $priority (
4676 $conf->config('ticket_system-custom_priority_field-values'), ''
4678 last if scalar(@tickets) >= $num;
4680 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4681 $num - scalar(@tickets),
4690 # Return services representing svc_accts in customer support packages
4691 sub support_services {
4693 my %packages = map { $_ => 1 } $conf->config('support_packages');
4695 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4696 grep { $_->part_svc->svcdb eq 'svc_acct' }
4697 map { $_->cust_svc }
4698 grep { exists $packages{ $_->pkgpart } }
4699 $self->ncancelled_pkgs;
4705 =head1 CLASS METHODS
4711 Class method that returns the list of possible status strings for customers
4712 (see L<the status method|/status>). For example:
4714 @statuses = FS::cust_main->statuses();
4719 #my $self = shift; #could be class...
4725 Returns an SQL expression identifying prospective cust_main records (customers
4726 with no packages ever ordered)
4730 use vars qw($select_count_pkgs);
4731 $select_count_pkgs =
4732 "SELECT COUNT(*) FROM cust_pkg
4733 WHERE cust_pkg.custnum = cust_main.custnum";
4735 sub select_count_pkgs_sql {
4739 sub prospect_sql { "
4740 0 = ( $select_count_pkgs )
4745 Returns an SQL expression identifying active cust_main records (customers with
4746 no active recurring packages, but otherwise unsuspended/uncancelled).
4751 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
4757 Returns an SQL expression identifying inactive cust_main records (customers with
4758 active recurring packages).
4762 sub inactive_sql { "
4763 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4765 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
4771 Returns an SQL expression identifying suspended cust_main records.
4776 sub suspended_sql { susp_sql(@_); }
4778 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
4780 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4786 Returns an SQL expression identifying cancelled cust_main records.
4790 sub cancelled_sql { cancel_sql(@_); }
4793 my $recurring_sql = FS::cust_pkg->recurring_sql;
4794 #my $recurring_sql = "
4795 # '0' != ( select freq from part_pkg
4796 # where cust_pkg.pkgpart = part_pkg.pkgpart )
4800 0 < ( $select_count_pkgs )
4801 AND 0 = ( $select_count_pkgs AND $recurring_sql
4802 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4808 =item uncancelled_sql
4810 Returns an SQL expression identifying un-cancelled cust_main records.
4814 sub uncancelled_sql { uncancel_sql(@_); }
4815 sub uncancel_sql { "
4816 ( 0 < ( $select_count_pkgs
4817 AND ( cust_pkg.cancel IS NULL
4818 OR cust_pkg.cancel = 0
4821 OR 0 = ( $select_count_pkgs )
4827 Returns an SQL fragment to retreive the balance.
4832 COALESCE( ( SELECT SUM(charged) FROM cust_bill
4833 WHERE cust_bill.custnum = cust_main.custnum ), 0)
4834 - COALESCE( ( SELECT SUM(paid) FROM cust_pay
4835 WHERE cust_pay.custnum = cust_main.custnum ), 0)
4836 - COALESCE( ( SELECT SUM(amount) FROM cust_credit
4837 WHERE cust_credit.custnum = cust_main.custnum ), 0)
4838 + COALESCE( ( SELECT SUM(refund) FROM cust_refund
4839 WHERE cust_refund.custnum = cust_main.custnum ), 0)
4842 =item balance_date_sql TIME
4844 Returns an SQL fragment to retreive the balance for this customer, only
4845 considering invoices with date earlier than TIME. (total_owed_date minus total_credited minus
4846 total_unapplied_payments). TIME is specified as an SQL fragment or a numeric
4847 UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and
4848 L<Date::Parse> for conversion functions.
4852 sub balance_date_sql {
4853 my( $class, $time ) = @_;
4855 my $owed_sql = FS::cust_bill->owed_sql;
4856 my $unapp_refund_sql = FS::cust_refund->unapplied_sql;
4857 #my $unapp_credit_sql = FS::cust_credit->unapplied_sql;
4858 my $unapp_credit_sql = FS::cust_credit->credited_sql;
4859 my $unapp_pay_sql = FS::cust_pay->unapplied_sql;
4862 COALESCE( ( SELECT SUM($owed_sql) FROM cust_bill
4863 WHERE cust_bill.custnum = cust_main.custnum
4864 AND cust_bill._date <= $time )
4867 + COALESCE( ( SELECT SUM($unapp_refund_sql) FROM cust_refund
4868 WHERE cust_refund.custnum = cust_main.custnum )
4871 - COALESCE( ( SELECT SUM($unapp_credit_sql) FROM cust_credit
4872 WHERE cust_credit.custnum = cust_main.custnum )
4875 - COALESCE( ( SELECT SUM($unapp_pay_sql) FROM cust_pay
4876 WHERE cust_pay.custnum = cust_main.custnum )
4884 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
4886 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
4887 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
4888 appropriate ship_ field is also searched).
4890 Additional options are the same as FS::Record::qsearch
4895 my( $self, $fuzzy, $hash, @opt) = @_;
4900 check_and_rebuild_fuzzyfiles();
4901 foreach my $field ( keys %$fuzzy ) {
4903 my $all = $self->all_X($field);
4904 next unless scalar(@$all);
4907 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
4910 foreach ( keys %match ) {
4911 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
4912 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
4915 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4918 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4920 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4928 Returns a masked version of the named field
4933 my ($self,$field) = @_;
4937 'x'x(length($self->getfield($field))-4).
4938 substr($self->getfield($field), (length($self->getfield($field))-4));
4948 =item smart_search OPTION => VALUE ...
4950 Accepts the following options: I<search>, the string to search for. The string
4951 will be searched for as a customer number, phone number, name or company name,
4952 as an exact, or, in some cases, a substring or fuzzy match (see the source code
4953 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
4954 skip fuzzy matching when an exact match is found.
4956 Any additional options are treated as an additional qualifier on the search
4959 Returns a (possibly empty) array of FS::cust_main objects.
4966 #here is the agent virtualization
4967 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
4971 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
4972 my $search = delete $options{'search'};
4973 ( my $alphanum_search = $search ) =~ s/\W//g;
4975 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
4977 #false laziness w/Record::ut_phone
4978 my $phonen = "$1-$2-$3";
4979 $phonen .= " x$4" if $4;
4981 push @cust_main, qsearch( {
4982 'table' => 'cust_main',
4983 'hashref' => { %options },
4984 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4986 join(' OR ', map "$_ = '$phonen'",
4987 qw( daytime night fax
4988 ship_daytime ship_night ship_fax )
4991 " AND $agentnums_sql", #agent virtualization
4994 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
4995 #try looking for matches with extensions unless one was specified
4997 push @cust_main, qsearch( {
4998 'table' => 'cust_main',
4999 'hashref' => { %options },
5000 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5002 join(' OR ', map "$_ LIKE '$phonen\%'",
5004 ship_daytime ship_night )
5007 " AND $agentnums_sql", #agent virtualization
5012 } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
5014 push @cust_main, qsearch( {
5015 'table' => 'cust_main',
5016 'hashref' => { 'custnum' => $1, %options },
5017 'extra_sql' => " AND $agentnums_sql", #agent virtualization
5020 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
5022 my($company, $last, $first) = ( $1, $2, $3 );
5024 # "Company (Last, First)"
5025 #this is probably something a browser remembered,
5026 #so just do an exact search
5028 foreach my $prefix ( '', 'ship_' ) {
5029 push @cust_main, qsearch( {
5030 'table' => 'cust_main',
5031 'hashref' => { $prefix.'first' => $first,
5032 $prefix.'last' => $last,
5033 $prefix.'company' => $company,
5036 'extra_sql' => " AND $agentnums_sql",
5040 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
5041 # try (ship_){last,company}
5045 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
5046 # # full strings the browser remembers won't work
5047 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
5049 use Lingua::EN::NameParse;
5050 my $NameParse = new Lingua::EN::NameParse(
5052 allow_reversed => 1,
5055 my($last, $first) = ( '', '' );
5056 #maybe disable this too and just rely on NameParse?
5057 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
5059 ($last, $first) = ( $1, $2 );
5061 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
5062 } elsif ( ! $NameParse->parse($value) ) {
5064 my %name = $NameParse->components;
5065 $first = $name{'given_name_1'};
5066 $last = $name{'surname_1'};
5070 if ( $first && $last ) {
5072 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
5075 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5077 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
5078 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
5081 push @cust_main, qsearch( {
5082 'table' => 'cust_main',
5083 'hashref' => \%options,
5084 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5087 # or it just be something that was typed in... (try that in a sec)
5091 my $q_value = dbh->quote($value);
5094 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5095 $sql .= " ( LOWER(last) = $q_value
5096 OR LOWER(company) = $q_value
5097 OR LOWER(ship_last) = $q_value
5098 OR LOWER(ship_company) = $q_value
5101 push @cust_main, qsearch( {
5102 'table' => 'cust_main',
5103 'hashref' => \%options,
5104 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5107 #no exact match, trying substring/fuzzy
5108 #always do substring & fuzzy (unless they're explicity config'ed off)
5109 #getting complaints searches are not returning enough
5110 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
5112 #still some false laziness w/ search/cust_main.cgi
5117 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
5118 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
5121 if ( $first && $last ) {
5124 { 'first' => { op=>'ILIKE', value=>"%$first%" },
5125 'last' => { op=>'ILIKE', value=>"%$last%" },
5127 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
5128 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
5135 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
5136 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
5140 foreach my $hashref ( @hashrefs ) {
5142 push @cust_main, qsearch( {
5143 'table' => 'cust_main',
5144 'hashref' => { %$hashref,
5147 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
5156 " AND $agentnums_sql", #extra_sql #agent virtualization
5159 if ( $first && $last ) {
5160 push @cust_main, FS::cust_main->fuzzy_search(
5161 { 'last' => $last, #fuzzy hashref
5162 'first' => $first }, #
5166 foreach my $field ( 'last', 'company' ) {
5168 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
5173 #eliminate duplicates
5175 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5183 =item check_and_rebuild_fuzzyfiles
5187 use vars qw(@fuzzyfields);
5188 @fuzzyfields = ( 'last', 'first', 'company' );
5190 sub check_and_rebuild_fuzzyfiles {
5191 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5192 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
5195 =item rebuild_fuzzyfiles
5199 sub rebuild_fuzzyfiles {
5201 use Fcntl qw(:flock);
5203 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5204 mkdir $dir, 0700 unless -d $dir;
5206 foreach my $fuzzy ( @fuzzyfields ) {
5208 open(LOCK,">>$dir/cust_main.$fuzzy")
5209 or die "can't open $dir/cust_main.$fuzzy: $!";
5211 or die "can't lock $dir/cust_main.$fuzzy: $!";
5213 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
5214 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
5216 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
5217 my $sth = dbh->prepare("SELECT $field FROM cust_main".
5218 " WHERE $field != '' AND $field IS NOT NULL");
5219 $sth->execute or die $sth->errstr;
5221 while ( my $row = $sth->fetchrow_arrayref ) {
5222 print CACHE $row->[0]. "\n";
5227 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
5229 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
5240 my( $self, $field ) = @_;
5241 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5242 open(CACHE,"<$dir/cust_main.$field")
5243 or die "can't open $dir/cust_main.$field: $!";
5244 my @array = map { chomp; $_; } <CACHE>;
5249 =item append_fuzzyfiles LASTNAME COMPANY
5253 sub append_fuzzyfiles {
5254 #my( $first, $last, $company ) = @_;
5256 &check_and_rebuild_fuzzyfiles;
5258 use Fcntl qw(:flock);
5260 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5262 foreach my $field (qw( first last company )) {
5267 open(CACHE,">>$dir/cust_main.$field")
5268 or die "can't open $dir/cust_main.$field: $!";
5269 flock(CACHE,LOCK_EX)
5270 or die "can't lock $dir/cust_main.$field: $!";
5272 print CACHE "$value\n";
5274 flock(CACHE,LOCK_UN)
5275 or die "can't unlock $dir/cust_main.$field: $!";
5290 #warn join('-',keys %$param);
5291 my $fh = $param->{filehandle};
5292 my $agentnum = $param->{agentnum};
5294 my $refnum = $param->{refnum};
5295 my $pkgpart = $param->{pkgpart};
5297 #my @fields = @{$param->{fields}};
5298 my $format = $param->{'format'};
5301 if ( $format eq 'simple' ) {
5302 @fields = qw( cust_pkg.setup dayphone first last
5303 address1 address2 city state zip comments );
5305 } elsif ( $format eq 'extended' ) {
5306 @fields = qw( agent_custid refnum
5307 last first address1 address2 city state zip country
5309 ship_last ship_first ship_address1 ship_address2
5310 ship_city ship_state ship_zip ship_country
5311 payinfo paycvv paydate
5314 svc_acct.username svc_acct._password
5318 die "unknown format $format";
5321 eval "use Text::CSV_XS;";
5324 my $csv = new Text::CSV_XS;
5331 local $SIG{HUP} = 'IGNORE';
5332 local $SIG{INT} = 'IGNORE';
5333 local $SIG{QUIT} = 'IGNORE';
5334 local $SIG{TERM} = 'IGNORE';
5335 local $SIG{TSTP} = 'IGNORE';
5336 local $SIG{PIPE} = 'IGNORE';
5338 my $oldAutoCommit = $FS::UID::AutoCommit;
5339 local $FS::UID::AutoCommit = 0;
5342 #while ( $columns = $csv->getline($fh) ) {
5344 while ( defined($line=<$fh>) ) {
5346 $csv->parse($line) or do {
5347 $dbh->rollback if $oldAutoCommit;
5348 return "can't parse: ". $csv->error_input();
5351 my @columns = $csv->fields();
5352 #warn join('-',@columns);
5355 agentnum => $agentnum,
5357 country => $conf->config('countrydefault') || 'US',
5358 payby => $payby, #default
5359 paydate => '12/2037', #default
5361 my $billtime = time;
5362 my %cust_pkg = ( pkgpart => $pkgpart );
5364 foreach my $field ( @fields ) {
5366 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
5368 #$cust_pkg{$1} = str2time( shift @$columns );
5369 if ( $1 eq 'pkgpart' ) {
5370 $cust_pkg{$1} = shift @columns;
5371 } elsif ( $1 eq 'setup' ) {
5372 $billtime = str2time(shift @columns);
5374 $cust_pkg{$1} = str2time( shift @columns );
5377 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
5379 $svc_acct{$1} = shift @columns;
5383 #refnum interception
5384 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
5386 my $referral = $columns[0];
5387 my %hash = ( 'referral' => $referral,
5388 'agentnum' => $agentnum,
5392 my $part_referral = qsearchs('part_referral', \%hash )
5393 || new FS::part_referral \%hash;
5395 unless ( $part_referral->refnum ) {
5396 my $error = $part_referral->insert;
5398 $dbh->rollback if $oldAutoCommit;
5399 return "can't auto-insert advertising source: $referral: $error";
5403 $columns[0] = $part_referral->refnum;
5406 #$cust_main{$field} = shift @$columns;
5407 $cust_main{$field} = shift @columns;
5411 $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
5413 my $invoicing_list = $cust_main{'invoicing_list'}
5414 ? [ delete $cust_main{'invoicing_list'} ]
5417 my $cust_main = new FS::cust_main ( \%cust_main );
5420 tie my %hash, 'Tie::RefHash'; #this part is important
5422 if ( $cust_pkg{'pkgpart'} ) {
5423 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
5426 if ( $svc_acct{'username'} ) {
5427 my $part_pkg = $cust_pkg->part_pkg;
5428 unless ( $part_pkg ) {
5429 $dbh->rollback if $oldAutoCommit;
5430 return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
5432 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
5433 push @svc_acct, new FS::svc_acct ( \%svc_acct )
5436 $hash{$cust_pkg} = \@svc_acct;
5439 my $error = $cust_main->insert( \%hash, $invoicing_list );
5442 $dbh->rollback if $oldAutoCommit;
5443 return "can't insert customer for $line: $error";
5446 if ( $format eq 'simple' ) {
5448 #false laziness w/bill.cgi
5449 $error = $cust_main->bill( 'time' => $billtime );
5451 $dbh->rollback if $oldAutoCommit;
5452 return "can't bill customer for $line: $error";
5455 $error = $cust_main->apply_payments_and_credits;
5457 $dbh->rollback if $oldAutoCommit;
5458 return "can't bill customer for $line: $error";
5461 $error = $cust_main->collect();
5463 $dbh->rollback if $oldAutoCommit;
5464 return "can't collect customer for $line: $error";
5472 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5474 return "Empty file!" unless $imported;
5486 #warn join('-',keys %$param);
5487 my $fh = $param->{filehandle};
5488 my @fields = @{$param->{fields}};
5490 eval "use Text::CSV_XS;";
5493 my $csv = new Text::CSV_XS;
5500 local $SIG{HUP} = 'IGNORE';
5501 local $SIG{INT} = 'IGNORE';
5502 local $SIG{QUIT} = 'IGNORE';
5503 local $SIG{TERM} = 'IGNORE';
5504 local $SIG{TSTP} = 'IGNORE';
5505 local $SIG{PIPE} = 'IGNORE';
5507 my $oldAutoCommit = $FS::UID::AutoCommit;
5508 local $FS::UID::AutoCommit = 0;
5511 #while ( $columns = $csv->getline($fh) ) {
5513 while ( defined($line=<$fh>) ) {
5515 $csv->parse($line) or do {
5516 $dbh->rollback if $oldAutoCommit;
5517 return "can't parse: ". $csv->error_input();
5520 my @columns = $csv->fields();
5521 #warn join('-',@columns);
5524 foreach my $field ( @fields ) {
5525 $row{$field} = shift @columns;
5528 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
5529 unless ( $cust_main ) {
5530 $dbh->rollback if $oldAutoCommit;
5531 return "unknown custnum $row{'custnum'}";
5534 if ( $row{'amount'} > 0 ) {
5535 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
5537 $dbh->rollback if $oldAutoCommit;
5541 } elsif ( $row{'amount'} < 0 ) {
5542 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
5545 $dbh->rollback if $oldAutoCommit;
5555 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5557 return "Empty file!" unless $imported;
5563 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5565 Sends a templated email notification to the customer (see L<Text::Template>).
5567 OPTIONS is a hash and may include
5569 I<from> - the email sender (default is invoice_from)
5571 I<to> - comma-separated scalar or arrayref of recipients
5572 (default is invoicing_list)
5574 I<subject> - The subject line of the sent email notification
5575 (default is "Notice from company_name")
5577 I<extra_fields> - a hashref of name/value pairs which will be substituted
5580 The following variables are vavailable in the template.
5582 I<$first> - the customer first name
5583 I<$last> - the customer last name
5584 I<$company> - the customer company
5585 I<$payby> - a description of the method of payment for the customer
5586 # would be nice to use FS::payby::shortname
5587 I<$payinfo> - the account information used to collect for this customer
5588 I<$expdate> - the expiration of the customer payment in seconds from epoch
5593 my ($customer, $template, %options) = @_;
5595 return unless $conf->exists($template);
5597 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
5598 $from = $options{from} if exists($options{from});
5600 my $to = join(',', $customer->invoicing_list_emailonly);
5601 $to = $options{to} if exists($options{to});
5603 my $subject = "Notice from " . $conf->config('company_name')
5604 if $conf->exists('company_name');
5605 $subject = $options{subject} if exists($options{subject});
5607 my $notify_template = new Text::Template (TYPE => 'ARRAY',
5608 SOURCE => [ map "$_\n",
5609 $conf->config($template)]
5611 or die "can't create new Text::Template object: Text::Template::ERROR";
5612 $notify_template->compile()
5613 or die "can't compile template: Text::Template::ERROR";
5615 my $paydate = $customer->paydate;
5616 $FS::notify_template::_template::first = $customer->first;
5617 $FS::notify_template::_template::last = $customer->last;
5618 $FS::notify_template::_template::company = $customer->company;
5619 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
5620 my $payby = $customer->payby;
5621 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5622 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5624 #credit cards expire at the end of the month/year of their exp date
5625 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5626 $FS::notify_template::_template::payby = 'credit card';
5627 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5628 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5630 }elsif ($payby eq 'COMP') {
5631 $FS::notify_template::_template::payby = 'complimentary account';
5633 $FS::notify_template::_template::payby = 'current method';
5635 $FS::notify_template::_template::expdate = $expire_time;
5637 for (keys %{$options{extra_fields}}){
5639 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5642 send_email(from => $from,
5644 subject => $subject,
5645 body => $notify_template->fill_in( PACKAGE =>
5646 'FS::notify_template::_template' ),
5651 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5653 Generates a templated notification to the customer (see L<Text::Template>).
5655 OPTIONS is a hash and may include
5657 I<extra_fields> - a hashref of name/value pairs which will be substituted
5658 into the template. These values may override values mentioned below
5659 and those from the customer record.
5661 The following variables are available in the template instead of or in addition
5662 to the fields of the customer record.
5664 I<$payby> - a description of the method of payment for the customer
5665 # would be nice to use FS::payby::shortname
5666 I<$payinfo> - the masked account information used to collect for this customer
5667 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5668 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress
5672 sub generate_letter {
5673 my ($self, $template, %options) = @_;
5675 return unless $conf->exists($template);
5677 my $letter_template = new Text::Template
5679 SOURCE => [ map "$_\n", $conf->config($template)],
5680 DELIMITERS => [ '[@--', '--@]' ],
5682 or die "can't create new Text::Template object: Text::Template::ERROR";
5684 $letter_template->compile()
5685 or die "can't compile template: Text::Template::ERROR";
5687 my %letter_data = map { $_ => $self->$_ } $self->fields;
5688 $letter_data{payinfo} = $self->mask_payinfo;
5690 #my $paydate = $self->paydate || '2037-12';
5691 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12';
5693 my $payby = $self->payby;
5694 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5695 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5697 #credit cards expire at the end of the month/year of their exp date
5698 if ($payby eq 'CARD' || $payby eq 'DCRD') {
5699 $letter_data{payby} = 'credit card';
5700 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5701 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5703 }elsif ($payby eq 'COMP') {
5704 $letter_data{payby} = 'complimentary account';
5706 $letter_data{payby} = 'current method';
5708 $letter_data{expdate} = $expire_time;
5710 for (keys %{$options{extra_fields}}){
5711 $letter_data{$_} = $options{extra_fields}->{$_};
5714 unless(exists($letter_data{returnaddress})){
5715 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5716 $self->agent_template)
5719 $letter_data{returnaddress} = length($retadd) ? $retadd : '~';
5722 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5724 my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
5725 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5729 ) or die "can't open temp file: $!\n";
5731 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5733 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5737 =item print_ps TEMPLATE
5739 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5745 my $file = $self->generate_letter(@_);
5746 FS::Misc::generate_ps($file);
5749 =item print TEMPLATE
5751 Prints the filled in template.
5753 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5757 sub queueable_print {
5760 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5761 or die "invalid customer number: " . $opt{custvnum};
5763 my $error = $self->print( $opt{template} );
5764 die $error if $error;
5768 my ($self, $template) = (shift, shift);
5769 do_print [ $self->print_ps($template) ];
5772 sub agent_template {
5774 $self->_agent_plandata('agent_templatename');
5777 sub agent_invoice_from {
5779 $self->_agent_plandata('agent_invoice_from');
5782 sub _agent_plandata {
5783 my( $self, $option ) = @_;
5785 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
5786 #agent-specific Conf
5788 my $agentnum = $self->agentnum;
5790 my $part_event_option =
5792 'table' => 'part_event_option',
5794 LEFT JOIN part_event USING ( eventpart )
5795 LEFT JOIN part_event_option AS peo_agentnum
5796 ON ( part_event.eventpart = peo_agentnum.eventpart
5797 AND peo_agentnum.optionname = 'agentnum'
5798 AND peo_agentnum.optionvalue ~ '(^|,)}. $agentnum. q{(,|$)'
5800 LEFT JOIN part_event_option AS peo_cust_bill_age
5801 ON ( part_event.eventpart = peo_cust_bill_age.eventpart
5802 AND peo_cust_bill_age.optionname = 'cust_bill_age'
5805 #'hashref' => { 'optionname' => $option },
5806 'hashref' => { 'part_event_option.optionname' => $option },
5807 'extra_sql' => " AND event = 'cust_bill_send_agent' ".
5808 " AND disabled != 'Y' ".
5809 " AND peo_agentnum.optionname = 'agentnum' ".
5810 " AND agentnum IS NULL OR agentnum = $agentnum ".
5812 CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
5814 ELSE EXTRACT( EPOCH FROM
5815 REPLACE( peo_cust_bill_age.optionvalue,
5821 , part_event.weight".
5825 unless ( $part_event_option ) {
5826 return $self->agent->invoice_template || ''
5827 if $option eq '$agent_templatename';
5831 $part_event_option->optionvalue;
5836 ## actual sub, not a method, designed to be called from the queue.
5837 ## sets up the customer, and calls the bill_and_collect
5838 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5839 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5840 $cust_main->bill_and_collect(
5851 The delete method should possibly take an FS::cust_main object reference
5852 instead of a scalar customer number.
5854 Bill and collect options should probably be passed as references instead of a
5857 There should probably be a configuration file with a list of allowed credit
5860 No multiple currency support (probably a larger project than just this module).
5862 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5864 Birthdates rely on negative epoch values.
5866 The payby for card/check batches is broken. With mixed batching, bad
5869 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5873 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5874 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5875 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.