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 Scalar::Util qw( blessed );
12 use Time::Local qw(timelocal_nocheck);
15 use Digest::MD5 qw(md5_base64);
19 use String::Approx qw(amatch);
20 use Business::CreditCard 0.28;
23 use FS::UID qw( getotaker dbh driver_name );
24 use FS::Record qw( qsearchs qsearch dbdef );
25 use FS::Misc qw( send_email generate_ps do_print );
26 use FS::Msgcat qw(gettext);
30 use FS::cust_bill_pkg;
32 use FS::cust_pay_pending;
33 use FS::cust_pay_void;
34 use FS::cust_pay_batch;
37 use FS::part_referral;
38 use FS::cust_main_county;
40 use FS::cust_main_invoice;
41 use FS::cust_credit_bill;
42 use FS::cust_bill_pay;
43 use FS::prepay_credit;
47 use FS::part_event_condition;
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' ] );
1073 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1075 : $self->replace_old;
1079 warn "$me replace called\n"
1082 my $curuser = $FS::CurrentUser::CurrentUser;
1083 if ( $self->payby eq 'COMP'
1084 && $self->payby ne $old->payby
1085 && ! $curuser->access_right('Complimentary customer')
1088 return "You are not permitted to create complimentary accounts.";
1091 local($ignore_expired_card) = 1
1092 if $old->payby =~ /^(CARD|DCRD)$/
1093 && $self->payby =~ /^(CARD|DCRD)$/
1094 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1096 local $SIG{HUP} = 'IGNORE';
1097 local $SIG{INT} = 'IGNORE';
1098 local $SIG{QUIT} = 'IGNORE';
1099 local $SIG{TERM} = 'IGNORE';
1100 local $SIG{TSTP} = 'IGNORE';
1101 local $SIG{PIPE} = 'IGNORE';
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"
1293 if ( $self->has_ship_address
1294 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1295 $self->addr_fields )
1299 $self->ut_name('ship_last')
1300 || $self->ut_name('ship_first')
1301 || $self->ut_textn('ship_company')
1302 || $self->ut_text('ship_address1')
1303 || $self->ut_textn('ship_address2')
1304 || $self->ut_text('ship_city')
1305 || $self->ut_textn('ship_county')
1306 || $self->ut_textn('ship_state')
1307 || $self->ut_country('ship_country')
1309 return $error if $error;
1311 #false laziness with above
1312 unless ( qsearchs('cust_main_county', {
1313 'country' => $self->ship_country,
1316 return "Unknown ship_state/ship_county/ship_country: ".
1317 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1318 unless qsearch('cust_main_county',{
1319 'state' => $self->ship_state,
1320 'county' => $self->ship_county,
1321 'country' => $self->ship_country,
1327 $self->ut_phonen('ship_daytime', $self->ship_country)
1328 || $self->ut_phonen('ship_night', $self->ship_country)
1329 || $self->ut_phonen('ship_fax', $self->ship_country)
1330 || $self->ut_zip('ship_zip', $self->ship_country)
1332 return $error if $error;
1334 return "Unit # is required."
1335 if $self->ship_address2 =~ /^\s*$/
1336 && $conf->exists('cust_main-require_address2');
1338 } else { # ship_ info eq billing info, so don't store dup info in database
1340 $self->setfield("ship_$_", '')
1341 foreach $self->addr_fields;
1343 return "Unit # is required."
1344 if $self->address2 =~ /^\s*$/
1345 && $conf->exists('cust_main-require_address2');
1349 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1350 # or return "Illegal payby: ". $self->payby;
1352 FS::payby->can_payby($self->table, $self->payby)
1353 or return "Illegal payby: ". $self->payby;
1355 $error = $self->ut_numbern('paystart_month')
1356 || $self->ut_numbern('paystart_year')
1357 || $self->ut_numbern('payissue')
1358 || $self->ut_textn('paytype')
1360 return $error if $error;
1362 if ( $self->payip eq '' ) {
1365 $error = $self->ut_ip('payip');
1366 return $error if $error;
1369 # If it is encrypted and the private key is not availaible then we can't
1370 # check the credit card.
1372 my $check_payinfo = 1;
1374 if ($self->is_encrypted($self->payinfo)) {
1378 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1380 my $payinfo = $self->payinfo;
1381 $payinfo =~ s/\D//g;
1382 $payinfo =~ /^(\d{13,16})$/
1383 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1385 $self->payinfo($payinfo);
1387 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1389 return gettext('unknown_card_type')
1390 if cardtype($self->payinfo) eq "Unknown";
1392 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1394 return 'Banned credit card: banned on '.
1395 time2str('%a %h %o at %r', $ban->_date).
1396 ' by '. $ban->otaker.
1397 ' (ban# '. $ban->bannum. ')';
1400 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1401 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1402 $self->paycvv =~ /^(\d{4})$/
1403 or return "CVV2 (CID) for American Express cards is four digits.";
1406 $self->paycvv =~ /^(\d{3})$/
1407 or return "CVV2 (CVC2/CID) is three digits.";
1414 my $cardtype = cardtype($payinfo);
1415 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1417 return "Start date or issue number is required for $cardtype cards"
1418 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1420 return "Start month must be between 1 and 12"
1421 if $self->paystart_month
1422 and $self->paystart_month < 1 || $self->paystart_month > 12;
1424 return "Start year must be 1990 or later"
1425 if $self->paystart_year
1426 and $self->paystart_year < 1990;
1428 return "Issue number must be beween 1 and 99"
1430 and $self->payissue < 1 || $self->payissue > 99;
1433 $self->paystart_month('');
1434 $self->paystart_year('');
1435 $self->payissue('');
1438 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1440 my $payinfo = $self->payinfo;
1441 $payinfo =~ s/[^\d\@]//g;
1442 if ( $conf->exists('echeck-nonus') ) {
1443 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1444 $payinfo = "$1\@$2";
1446 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1447 $payinfo = "$1\@$2";
1449 $self->payinfo($payinfo);
1452 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1454 return 'Banned ACH account: banned on '.
1455 time2str('%a %h %o at %r', $ban->_date).
1456 ' by '. $ban->otaker.
1457 ' (ban# '. $ban->bannum. ')';
1460 } elsif ( $self->payby eq 'LECB' ) {
1462 my $payinfo = $self->payinfo;
1463 $payinfo =~ s/\D//g;
1464 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1466 $self->payinfo($payinfo);
1469 } elsif ( $self->payby eq 'BILL' ) {
1471 $error = $self->ut_textn('payinfo');
1472 return "Illegal P.O. number: ". $self->payinfo if $error;
1475 } elsif ( $self->payby eq 'COMP' ) {
1477 my $curuser = $FS::CurrentUser::CurrentUser;
1478 if ( ! $self->custnum
1479 && ! $curuser->access_right('Complimentary customer')
1482 return "You are not permitted to create complimentary accounts."
1485 $error = $self->ut_textn('payinfo');
1486 return "Illegal comp account issuer: ". $self->payinfo if $error;
1489 } elsif ( $self->payby eq 'PREPAY' ) {
1491 my $payinfo = $self->payinfo;
1492 $payinfo =~ s/\W//g; #anything else would just confuse things
1493 $self->payinfo($payinfo);
1494 $error = $self->ut_alpha('payinfo');
1495 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1496 return "Unknown prepayment identifier"
1497 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1502 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1503 return "Expiration date required"
1504 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1508 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1509 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1510 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1511 ( $m, $y ) = ( $3, "20$2" );
1513 return "Illegal expiration date: ". $self->paydate;
1515 $self->paydate("$y-$m-01");
1516 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1517 return gettext('expired_card')
1519 && !$ignore_expired_card
1520 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1523 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1524 ( ! $conf->exists('require_cardname')
1525 || $self->payby !~ /^(CARD|DCRD)$/ )
1527 $self->payname( $self->first. " ". $self->getfield('last') );
1529 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1530 or return gettext('illegal_name'). " payname: ". $self->payname;
1534 foreach my $flag (qw( tax spool_cdr )) {
1535 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1539 $self->otaker(getotaker) unless $self->otaker;
1541 warn "$me check AFTER: \n". $self->_dump
1544 $self->SUPER::check;
1549 Returns a list of fields which have ship_ duplicates.
1554 qw( last first company
1555 address1 address2 city county state zip country
1560 =item has_ship_address
1562 Returns true if this customer record has a separate shipping address.
1566 sub has_ship_address {
1568 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1573 Returns all packages (see L<FS::cust_pkg>) for this customer.
1580 return $self->num_pkgs unless wantarray;
1583 if ( $self->{'_pkgnum'} ) {
1584 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1586 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1589 sort sort_packages @cust_pkg;
1594 Synonym for B<all_pkgs>.
1599 shift->all_pkgs(@_);
1602 =item ncancelled_pkgs
1604 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1608 sub ncancelled_pkgs {
1611 return $self->num_ncancelled_pkgs unless wantarray;
1614 if ( $self->{'_pkgnum'} ) {
1616 warn "$me ncancelled_pkgs: returning cached objects"
1619 @cust_pkg = grep { ! $_->getfield('cancel') }
1620 values %{ $self->{'_pkgnum'}->cache };
1624 warn "$me ncancelled_pkgs: searching for packages with custnum ".
1625 $self->custnum. "\n"
1629 qsearch( 'cust_pkg', {
1630 'custnum' => $self->custnum,
1634 qsearch( 'cust_pkg', {
1635 'custnum' => $self->custnum,
1640 sort sort_packages @cust_pkg;
1644 # This should be generalized to use config options to determine order.
1646 if ( $a->get('cancel') and $b->get('cancel') ) {
1647 $a->pkgnum <=> $b->pkgnum;
1648 } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1649 return -1 if $b->get('cancel');
1650 return 1 if $a->get('cancel');
1653 $a->pkgnum <=> $b->pkgnum;
1657 =item suspended_pkgs
1659 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1663 sub suspended_pkgs {
1665 grep { $_->susp } $self->ncancelled_pkgs;
1668 =item unflagged_suspended_pkgs
1670 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1671 customer (thouse packages without the `manual_flag' set).
1675 sub unflagged_suspended_pkgs {
1677 return $self->suspended_pkgs
1678 unless dbdef->table('cust_pkg')->column('manual_flag');
1679 grep { ! $_->manual_flag } $self->suspended_pkgs;
1682 =item unsuspended_pkgs
1684 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1689 sub unsuspended_pkgs {
1691 grep { ! $_->susp } $self->ncancelled_pkgs;
1694 =item num_cancelled_pkgs
1696 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1701 sub num_cancelled_pkgs {
1702 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1705 sub num_ncancelled_pkgs {
1706 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1710 my( $self ) = shift;
1711 my $sql = scalar(@_) ? shift : '';
1712 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1713 my $sth = dbh->prepare(
1714 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1715 ) or die dbh->errstr;
1716 $sth->execute($self->custnum) or die $sth->errstr;
1717 $sth->fetchrow_arrayref->[0];
1722 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1723 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1724 on success or a list of errors.
1730 grep { $_->unsuspend } $self->suspended_pkgs;
1735 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1737 Returns a list: an empty list on success or a list of errors.
1743 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1746 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1748 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1749 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
1750 of a list of pkgparts; the hashref has the following keys:
1754 =item pkgparts - listref of pkgparts
1756 =item (other options are passed to the suspend method)
1761 Returns a list: an empty list on success or a list of errors.
1765 sub suspend_if_pkgpart {
1767 my (@pkgparts, %opt);
1768 if (ref($_[0]) eq 'HASH'){
1769 @pkgparts = @{$_[0]{pkgparts}};
1774 grep { $_->suspend(%opt) }
1775 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1776 $self->unsuspended_pkgs;
1779 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1781 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1782 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
1783 instead of a list of pkgparts; the hashref has the following keys:
1787 =item pkgparts - listref of pkgparts
1789 =item (other options are passed to the suspend method)
1793 Returns a list: an empty list on success or a list of errors.
1797 sub suspend_unless_pkgpart {
1799 my (@pkgparts, %opt);
1800 if (ref($_[0]) eq 'HASH'){
1801 @pkgparts = @{$_[0]{pkgparts}};
1806 grep { $_->suspend(%opt) }
1807 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1808 $self->unsuspended_pkgs;
1811 =item cancel [ OPTION => VALUE ... ]
1813 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1815 Available options are:
1819 =item quiet - can be set true to supress email cancellation notices.
1821 =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.
1823 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
1827 Always returns a list: an empty list on success or a list of errors.
1832 my( $self, %opt ) = @_;
1834 warn "$me cancel called on customer ". $self->custnum. " with options ".
1835 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
1838 return ( 'access denied' )
1839 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
1841 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1843 #should try decryption (we might have the private key)
1844 # and if not maybe queue a job for the server that does?
1845 return ( "Can't (yet) ban encrypted credit cards" )
1846 if $self->is_encrypted($self->payinfo);
1848 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1849 my $error = $ban->insert;
1850 return ( $error ) if $error;
1854 my @pkgs = $self->ncancelled_pkgs;
1856 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
1857 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
1860 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
1863 sub _banned_pay_hashref {
1874 'payby' => $payby2ban{$self->payby},
1875 'payinfo' => md5_base64($self->payinfo),
1876 #don't ever *search* on reason! #'reason' =>
1882 Returns all notes (see L<FS::cust_main_note>) for this customer.
1889 qsearch( 'cust_main_note',
1890 { 'custnum' => $self->custnum },
1892 'ORDER BY _DATE DESC'
1898 Returns the agent (see L<FS::agent>) for this customer.
1904 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1907 =item bill_and_collect
1909 Cancels and suspends any packages due, generates bills, applies payments and
1912 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
1914 Options are passed as name-value pairs. Currently available options are:
1920 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:
1924 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1928 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.
1932 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1936 If set true, re-charges setup fees.
1940 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
1946 sub bill_and_collect {
1947 my( $self, %options ) = @_;
1953 #$options{actual_time} not $options{time} because freeside-daily -d is for
1954 #pre-printing invoices
1955 my @cancel_pkgs = grep { $_->expire && $_->expire <= $options{actual_time} }
1956 $self->ncancelled_pkgs;
1958 foreach my $cust_pkg ( @cancel_pkgs ) {
1959 my $error = $cust_pkg->cancel;
1960 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
1961 " for custnum ". $self->custnum. ": $error"
1969 #$options{actual_time} not $options{time} because freeside-daily -d is for
1970 #pre-printing invoices
1973 && ( ( $_->part_pkg->is_prepaid
1975 && $_->bill < $options{actual_time}
1978 && $_->adjourn <= $options{actual_time}
1982 $self->ncancelled_pkgs;
1984 foreach my $cust_pkg ( @susp_pkgs ) {
1985 my $error = $cust_pkg->suspend;
1986 warn "Error suspending package ". $cust_pkg->pkgnum.
1987 " for custnum ". $self->custnum. ": $error"
1995 my $error = $self->bill( %options );
1996 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
1998 $self->apply_payments_and_credits;
2000 $error = $self->collect( %options );
2001 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
2007 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2008 conjunction with the collect method by calling B<bill_and_collect>.
2010 If there is an error, returns the error, otherwise returns false.
2012 Options are passed as name-value pairs. Currently available options are:
2018 If set true, re-charges setup fees.
2022 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:
2026 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2030 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2032 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2036 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.
2043 my( $self, %options ) = @_;
2044 return '' if $self->payby eq 'COMP';
2045 warn "$me bill customer ". $self->custnum. "\n"
2048 my $time = $options{'time'} || time;
2051 local $SIG{HUP} = 'IGNORE';
2052 local $SIG{INT} = 'IGNORE';
2053 local $SIG{QUIT} = 'IGNORE';
2054 local $SIG{TERM} = 'IGNORE';
2055 local $SIG{TSTP} = 'IGNORE';
2056 local $SIG{PIPE} = 'IGNORE';
2058 my $oldAutoCommit = $FS::UID::AutoCommit;
2059 local $FS::UID::AutoCommit = 0;
2062 $self->select_for_update; #mutex
2064 my @cust_bill_pkg = ();
2067 # find the packages which are due for billing, find out how much they are
2068 # & generate invoice database.
2071 my( $total_setup, $total_recur ) = ( 0, 0 );
2074 my @precommit_hooks = ();
2076 foreach my $cust_pkg (
2077 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
2080 #NO!! next if $cust_pkg->cancel;
2081 next if $cust_pkg->getfield('cancel');
2083 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2085 #? to avoid use of uninitialized value errors... ?
2086 $cust_pkg->setfield('bill', '')
2087 unless defined($cust_pkg->bill);
2089 #my $part_pkg = $cust_pkg->part_pkg;
2091 my $real_pkgpart = $cust_pkg->pkgpart;
2092 my %hash = $cust_pkg->hash;
2093 my $old_cust_pkg = new FS::cust_pkg \%hash;
2095 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2097 $cust_pkg->pkgpart($part_pkg->pkgpart);
2098 $cust_pkg->set($_, $hash{$_}) foreach qw( setup last_bill bill );
2109 if ( ! $cust_pkg->setup &&
2111 ( $conf->exists('disable_setup_suspended_pkgs') &&
2112 ! $cust_pkg->getfield('susp')
2113 ) || ! $conf->exists('disable_setup_suspended_pkgs')
2115 || $options{'resetup'}
2118 warn " bill setup\n" if $DEBUG > 1;
2121 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2123 $dbh->rollback if $oldAutoCommit;
2124 return "$@ running calc_setup for $cust_pkg\n";
2127 $cust_pkg->setfield('setup', $time)
2128 unless $cust_pkg->setup;
2129 #do need it, but it won't get written to the db
2130 #|| $cust_pkg->pkgpart != $real_pkgpart;
2135 # bill recurring fee
2140 if ( $part_pkg->getfield('freq') ne '0' &&
2141 ! $cust_pkg->getfield('susp') &&
2142 ( $cust_pkg->getfield('bill') || 0 ) <= $time
2145 # XXX should this be a package event? probably. events are called
2146 # at collection time at the moment, though...
2147 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
2148 if $part_pkg->can('reset_usage');
2149 #don't want to reset usage just cause we want a line item??
2150 #&& $part_pkg->pkgpart == $real_pkgpart;
2152 warn " bill recur\n" if $DEBUG > 1;
2155 # XXX shared with $recur_prog
2156 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2158 #over two params! lets at least switch to a hashref for the rest...
2159 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
2161 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2163 $dbh->rollback if $oldAutoCommit;
2164 return "$@ running calc_recur for $cust_pkg\n";
2168 #change this bit to use Date::Manip? CAREFUL with timezones (see
2169 # mailing list archive)
2170 my ($sec,$min,$hour,$mday,$mon,$year) =
2171 (localtime($sdate) )[0,1,2,3,4,5];
2173 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2174 # only for figuring next bill date, nothing else, so, reset $sdate again
2176 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2177 $cust_pkg->last_bill($sdate);
2179 if ( $part_pkg->freq =~ /^\d+$/ ) {
2180 $mon += $part_pkg->freq;
2181 until ( $mon < 12 ) { $mon -= 12; $year++; }
2182 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2184 $mday += $weeks * 7;
2185 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2188 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2192 $dbh->rollback if $oldAutoCommit;
2193 return "unparsable frequency: ". $part_pkg->freq;
2195 $cust_pkg->setfield('bill',
2196 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2200 warn "\$setup is undefined" unless defined($setup);
2201 warn "\$recur is undefined" unless defined($recur);
2202 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2205 # If there's line items, create em cust_bill_pkg records
2206 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
2211 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
2212 # hmm.. and if just the options are modified in some weird price plan?
2214 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2217 my $error = $cust_pkg->replace( $old_cust_pkg,
2218 'options' => { $cust_pkg->options },
2220 if ( $error ) { #just in case
2221 $dbh->rollback if $oldAutoCommit;
2222 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2226 $setup = sprintf( "%.2f", $setup );
2227 $recur = sprintf( "%.2f", $recur );
2228 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2229 $dbh->rollback if $oldAutoCommit;
2230 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2232 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2233 $dbh->rollback if $oldAutoCommit;
2234 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2237 if ( $setup != 0 || $recur != 0 ) {
2239 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2241 my $cust_bill_pkg = new FS::cust_bill_pkg {
2242 'pkgnum' => $cust_pkg->pkgnum,
2246 'edate' => $cust_pkg->bill,
2247 'details' => \@details,
2249 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
2250 unless $part_pkg->pkgpart == $real_pkgpart;
2251 push @cust_bill_pkg, $cust_bill_pkg;
2253 $total_setup += $setup;
2254 $total_recur += $recur;
2260 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2263 my @taxoverrides = $part_pkg->part_pkg_taxoverride;
2266 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2270 if ( $conf->exists('enable_taxproducts')
2271 && (scalar(@taxoverrides) || $part_pkg->taxproductnum )
2275 my @taxclassnums = ();
2276 my $geocode = $self->geocode('cch');
2278 if ( scalar( @taxoverrides ) ) {
2279 @taxclassnums = map { $_->taxclassnum } @taxoverrides;
2280 }elsif ( $part_pkg->taxproductnum ) {
2281 @taxclassnums = map { $_->taxclassnum }
2282 $part_pkg->part_pkg_taxrate('cch', $geocode);
2287 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
2289 @taxes = qsearch({ 'table' => 'tax_rate',
2290 'hashref' => { 'geocode' => $geocode, },
2291 'extra_sql' => $extra_sql,
2293 if scalar(@taxclassnums);
2298 my %taxhash = map { $_ => $self->get("$prefix$_") }
2299 qw( state county country );
2301 $taxhash{'taxclass'} = $part_pkg->taxclass;
2303 @taxes = qsearch( 'cust_main_county', \%taxhash );
2306 $taxhash{'taxclass'} = '';
2307 @taxes = qsearch( 'cust_main_county', \%taxhash );
2310 #one more try at a whole-country tax rate
2312 $taxhash{$_} = '' foreach qw( state county );
2313 @taxes = qsearch( 'cust_main_county', \%taxhash );
2316 } #if $conf->exists('enable_taxproducts')
2318 # maybe eliminate this entirely, along with all the 0% records
2320 $dbh->rollback if $oldAutoCommit;
2322 if ( $conf->exists('enable_taxproducts') ) {
2324 "fatal: can't find tax rate for zip/taxproduct/pkgpart ".
2325 join('/', ( map $self->get("$prefix$_"),
2328 $part_pkg->taxproduct_description,
2329 $part_pkg->pkgpart ). "\n";
2332 "fatal: can't find tax rate for state/county/country/taxclass ".
2333 join('/', ( map $self->get("$prefix$_"),
2334 qw(state county country)
2336 $part_pkg->taxclass ). "\n";
2341 foreach my $tax ( @taxes ) {
2342 my $taxname = ref( $tax ). ' '. $tax->taxnum;
2343 if ( exists( $taxlisthash{ $taxname } ) ) {
2344 push @{ $taxlisthash{ $taxname } }, $cust_bill_pkg;
2346 $taxlisthash{ $taxname } = [ $tax, $cust_bill_pkg ];
2351 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2353 } #if $setup != 0 || $recur != 0
2355 } #if $cust_pkg->modified
2357 } #foreach my $part_pkg
2359 } #foreach my $cust_pkg
2361 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2362 #but do commit any package date cycling that happened
2363 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2367 foreach my $tax ( keys %taxlisthash ) {
2368 my $tax_object = shift @{ $taxlisthash{$tax} };
2369 my $listref_or_error = $tax_object->taxline( @{ $taxlisthash{$tax} } );
2370 unless (ref($listref_or_error)) {
2371 $dbh->rollback if $oldAutoCommit;
2372 return $listref_or_error;
2375 $tax{ $listref_or_error->[0] } += $listref_or_error->[1];
2379 foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2380 my $tax = sprintf('%.2f', $tax{$taxname} );
2381 $total_setup = sprintf('%.2f', $total_setup+$tax );
2383 push @cust_bill_pkg, new FS::cust_bill_pkg {
2389 'itemdesc' => $taxname,
2394 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2396 #create the new invoice
2397 my $cust_bill = new FS::cust_bill ( {
2398 'custnum' => $self->custnum,
2399 '_date' => ( $options{'invoice_time'} || $time ),
2400 'charged' => $charged,
2402 my $error = $cust_bill->insert;
2404 $dbh->rollback if $oldAutoCommit;
2405 return "can't create invoice for customer #". $self->custnum. ": $error";
2408 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2409 $cust_bill_pkg->invnum($cust_bill->invnum);
2410 my $error = $cust_bill_pkg->insert;
2412 $dbh->rollback if $oldAutoCommit;
2413 return "can't create invoice line item: $error";
2418 foreach my $hook ( @precommit_hooks ) {
2420 &{$hook}; #($self) ?
2423 $dbh->rollback if $oldAutoCommit;
2424 return "$@ running precommit hook $hook\n";
2428 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2432 =item collect OPTIONS
2434 (Attempt to) collect money for this customer's outstanding invoices (see
2435 L<FS::cust_bill>). Usually used after the bill method.
2437 Actions are now triggered by billing events; see L<FS::part_event> and the
2438 billing events web interface. Old-style invoice events (see
2439 L<FS::part_bill_event>) have been deprecated.
2441 If there is an error, returns the error, otherwise returns false.
2443 Options are passed as name-value pairs.
2445 Currently available options are:
2451 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.
2455 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2459 set true to surpress email card/ACH decline notices.
2463 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2467 allows for one time override of normal customer billing method
2471 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
2479 my( $self, %options ) = @_;
2480 my $invoice_time = $options{'invoice_time'} || time;
2483 local $SIG{HUP} = 'IGNORE';
2484 local $SIG{INT} = 'IGNORE';
2485 local $SIG{QUIT} = 'IGNORE';
2486 local $SIG{TERM} = 'IGNORE';
2487 local $SIG{TSTP} = 'IGNORE';
2488 local $SIG{PIPE} = 'IGNORE';
2490 my $oldAutoCommit = $FS::UID::AutoCommit;
2491 local $FS::UID::AutoCommit = 0;
2494 $self->select_for_update; #mutex
2497 my $balance = $self->balance;
2498 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2501 if ( exists($options{'retry_card'}) ) {
2502 carp 'retry_card option passed to collect is deprecated; use retry';
2503 $options{'retry'} ||= $options{'retry_card'};
2505 if ( exists($options{'retry'}) && $options{'retry'} ) {
2506 my $error = $self->retry_realtime;
2508 $dbh->rollback if $oldAutoCommit;
2513 # false laziness w/pay_batch::import_results
2515 my $due_cust_event = $self->due_cust_event(
2516 'debug' => ( $options{'debug'} || 0 ),
2517 'time' => $invoice_time,
2518 'check_freq' => $options{'check_freq'},
2520 unless( ref($due_cust_event) ) {
2521 $dbh->rollback if $oldAutoCommit;
2522 return $due_cust_event;
2525 foreach my $cust_event ( @$due_cust_event ) {
2529 #re-eval event conditions (a previous event could have changed things)
2530 unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
2531 #don't leave stray "new/locked" records around
2532 my $error = $cust_event->delete;
2534 #gah, even with transactions
2535 $dbh->commit if $oldAutoCommit; #well.
2542 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2543 warn " running cust_event ". $cust_event->eventnum. "\n"
2547 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2548 if ( my $error = $cust_event->do_event() ) {
2549 #XXX wtf is this? figure out a proper dealio with return value
2551 # gah, even with transactions.
2552 $dbh->commit if $oldAutoCommit; #well.
2559 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2564 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2566 Inserts database records for and returns an ordered listref of new events due
2567 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2568 events are due, an empty listref is returned. If there is an error, returns a
2569 scalar error message.
2571 To actually run the events, call each event's test_condition method, and if
2572 still true, call the event's do_event method.
2574 Options are passed as a hashref or as a list of name-value pairs. Available
2581 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.
2585 "Current time" for the events.
2589 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
2593 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2597 Explicitly pass the objects to be tested (typically used with eventtable).
2603 sub due_cust_event {
2605 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2608 #my $DEBUG = $opt{'debug'}
2609 local($DEBUG) = $opt{'debug'}
2610 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2612 warn "$me due_cust_event called with options ".
2613 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2616 $opt{'time'} ||= time;
2618 local $SIG{HUP} = 'IGNORE';
2619 local $SIG{INT} = 'IGNORE';
2620 local $SIG{QUIT} = 'IGNORE';
2621 local $SIG{TERM} = 'IGNORE';
2622 local $SIG{TSTP} = 'IGNORE';
2623 local $SIG{PIPE} = 'IGNORE';
2625 my $oldAutoCommit = $FS::UID::AutoCommit;
2626 local $FS::UID::AutoCommit = 0;
2629 $self->select_for_update; #mutex
2632 # 1: find possible events (initial search)
2635 my @cust_event = ();
2637 my @eventtable = $opt{'eventtable'}
2638 ? ( $opt{'eventtable'} )
2639 : FS::part_event->eventtables_runorder;
2641 foreach my $eventtable ( @eventtable ) {
2644 if ( $opt{'objects'} ) {
2646 @objects = @{ $opt{'objects'} };
2650 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2651 @objects = ( $eventtable eq 'cust_main' )
2653 : ( $self->$eventtable() );
2657 my @e_cust_event = ();
2659 my $cross = "CROSS JOIN $eventtable";
2660 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2661 unless $eventtable eq 'cust_main';
2663 foreach my $object ( @objects ) {
2665 #this first search uses the condition_sql magic for optimization.
2666 #the more possible events we can eliminate in this step the better
2668 my $cross_where = '';
2669 my $pkey = $object->primary_key;
2670 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2672 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2674 FS::part_event_condition->where_conditions_sql( $eventtable,
2675 'time'=>$opt{'time'}
2677 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2679 $extra_sql = "AND $extra_sql" if $extra_sql;
2681 #here is the agent virtualization
2682 $extra_sql .= " AND ( part_event.agentnum IS NULL
2683 OR part_event.agentnum = ". $self->agentnum. ' )';
2685 $extra_sql .= " $order";
2687 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2688 if $opt{'debug'} > 2;
2689 my @part_event = qsearch( {
2690 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2691 'select' => 'part_event.*',
2692 'table' => 'part_event',
2693 'addl_from' => "$cross $join",
2694 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2695 'eventtable' => $eventtable,
2698 'extra_sql' => "AND $cross_where $extra_sql",
2702 my $pkey = $object->primary_key;
2703 warn " ". scalar(@part_event).
2704 " possible events found for $eventtable ". $object->$pkey(). "\n";
2707 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2711 warn " ". scalar(@e_cust_event).
2712 " subtotal possible cust events found for $eventtable\n"
2715 push @cust_event, @e_cust_event;
2719 warn " ". scalar(@cust_event).
2720 " total possible cust events found in initial search\n"
2724 # 2: test conditions
2729 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
2730 'stats_hashref' => \%unsat ),
2733 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2736 warn " invalid conditions not eliminated with condition_sql:\n".
2737 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2744 foreach my $cust_event ( @cust_event ) {
2746 my $error = $cust_event->insert();
2748 $dbh->rollback if $oldAutoCommit;
2754 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2760 warn " returning events: ". Dumper(@cust_event). "\n"
2767 =item retry_realtime
2769 Schedules realtime / batch credit card / electronic check / LEC billing
2770 events for for retry. Useful if card information has changed or manual
2771 retry is desired. The 'collect' method must be called to actually retry
2774 Implementation details: For either this customer, or for each of this
2775 customer's open invoices, changes the status of the first "done" (with
2776 statustext error) realtime processing event to "failed".
2780 sub retry_realtime {
2783 local $SIG{HUP} = 'IGNORE';
2784 local $SIG{INT} = 'IGNORE';
2785 local $SIG{QUIT} = 'IGNORE';
2786 local $SIG{TERM} = 'IGNORE';
2787 local $SIG{TSTP} = 'IGNORE';
2788 local $SIG{PIPE} = 'IGNORE';
2790 my $oldAutoCommit = $FS::UID::AutoCommit;
2791 local $FS::UID::AutoCommit = 0;
2794 #a little false laziness w/due_cust_event (not too bad, really)
2796 my $join = FS::part_event_condition->join_conditions_sql;
2797 my $order = FS::part_event_condition->order_conditions_sql;
2800 . join ( ' OR ' , map {
2801 "( part_event.eventtable = " . dbh->quote($_)
2802 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
2803 } FS::part_event->eventtables)
2806 #here is the agent virtualization
2807 my $agent_virt = " ( part_event.agentnum IS NULL
2808 OR part_event.agentnum = ". $self->agentnum. ' )';
2810 #XXX this shouldn't be hardcoded, actions should declare it...
2811 my @realtime_events = qw(
2812 cust_bill_realtime_card
2813 cust_bill_realtime_check
2814 cust_bill_realtime_lec
2818 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
2823 my @cust_event = qsearchs({
2824 'table' => 'cust_event',
2825 'select' => 'cust_event.*',
2826 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
2827 'hashref' => { 'status' => 'done' },
2828 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
2829 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
2832 my %seen_invnum = ();
2833 foreach my $cust_event (@cust_event) {
2835 #max one for the customer, one for each open invoice
2836 my $cust_X = $cust_event->cust_X;
2837 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
2841 or $cust_event->part_event->eventtable eq 'cust_bill'
2844 my $error = $cust_event->retry;
2846 $dbh->rollback if $oldAutoCommit;
2847 return "error scheduling event for retry: $error";
2852 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2857 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2859 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2860 via a Business::OnlinePayment realtime gateway. See
2861 L<http://420.am/business-onlinepayment> for supported gateways.
2863 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2865 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
2867 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2868 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2869 if set, will override the value from the customer record.
2871 I<description> is a free-text field passed to the gateway. It defaults to
2872 "Internet services".
2874 If an I<invnum> is specified, this payment (if successful) is applied to the
2875 specified invoice. If you don't specify an I<invnum> you might want to
2876 call the B<apply_payments> method.
2878 I<quiet> can be set true to surpress email decline notices.
2880 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
2881 resulting paynum, if any.
2883 I<payunique> is a unique identifier for this payment.
2885 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2890 my( $self, $method, $amount, %options ) = @_;
2892 warn "$me realtime_bop: $method $amount\n";
2893 warn " $_ => $options{$_}\n" foreach keys %options;
2896 $options{'description'} ||= 'Internet services';
2898 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
2900 eval "use Business::OnlinePayment";
2903 my $payinfo = exists($options{'payinfo'})
2904 ? $options{'payinfo'}
2907 my %method2payby = (
2914 # check for banned credit card/ACH
2917 my $ban = qsearchs('banned_pay', {
2918 'payby' => $method2payby{$method},
2919 'payinfo' => md5_base64($payinfo),
2921 return "Banned credit card" if $ban;
2928 if ( $options{'invnum'} ) {
2929 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2930 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2932 map { $_->part_pkg->taxclass }
2934 map { $_->cust_pkg }
2935 $cust_bill->cust_bill_pkg;
2936 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2937 #different taxclasses
2938 $taxclass = $taxclasses[0];
2942 #look for an agent gateway override first
2944 if ( $method eq 'CC' ) {
2945 $cardtype = cardtype($payinfo);
2946 } elsif ( $method eq 'ECHECK' ) {
2949 $cardtype = $method;
2953 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2954 cardtype => $cardtype,
2955 taxclass => $taxclass, } )
2956 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2958 taxclass => $taxclass, } )
2959 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2960 cardtype => $cardtype,
2962 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2964 taxclass => '', } );
2966 my $payment_gateway = '';
2967 my( $processor, $login, $password, $action, @bop_options );
2968 if ( $override ) { #use a payment gateway override
2970 $payment_gateway = $override->payment_gateway;
2972 $processor = $payment_gateway->gateway_module;
2973 $login = $payment_gateway->gateway_username;
2974 $password = $payment_gateway->gateway_password;
2975 $action = $payment_gateway->gateway_action;
2976 @bop_options = $payment_gateway->options;
2978 } else { #use the standard settings from the config
2980 ( $processor, $login, $password, $action, @bop_options ) =
2981 $self->default_payment_gateway($method);
2989 my $address = exists($options{'address1'})
2990 ? $options{'address1'}
2992 my $address2 = exists($options{'address2'})
2993 ? $options{'address2'}
2995 $address .= ", ". $address2 if length($address2);
2997 my $o_payname = exists($options{'payname'})
2998 ? $options{'payname'}
3000 my($payname, $payfirst, $paylast);
3001 if ( $o_payname && $method ne 'ECHECK' ) {
3002 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3003 or return "Illegal payname $payname";
3004 ($payfirst, $paylast) = ($1, $2);
3006 $payfirst = $self->getfield('first');
3007 $paylast = $self->getfield('last');
3008 $payname = "$payfirst $paylast";
3011 my @invoicing_list = $self->invoicing_list_emailonly;
3012 if ( $conf->exists('emailinvoiceautoalways')
3013 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3014 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3015 push @invoicing_list, $self->all_emails;
3018 my $email = ($conf->exists('business-onlinepayment-email-override'))
3019 ? $conf->config('business-onlinepayment-email-override')
3020 : $invoicing_list[0];
3024 my $payip = exists($options{'payip'})
3027 $content{customer_ip} = $payip
3030 $content{invoice_number} = $options{'invnum'}
3031 if exists($options{'invnum'}) && length($options{'invnum'});
3033 $content{email_customer} =
3034 ( $conf->exists('business-onlinepayment-email_customer')
3035 || $conf->exists('business-onlinepayment-email-override') );
3038 if ( $method eq 'CC' ) {
3040 $content{card_number} = $payinfo;
3041 $paydate = exists($options{'paydate'})
3042 ? $options{'paydate'}
3044 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3045 $content{expiration} = "$2/$1";
3047 my $paycvv = exists($options{'paycvv'})
3048 ? $options{'paycvv'}
3050 $content{cvv2} = $paycvv
3053 my $paystart_month = exists($options{'paystart_month'})
3054 ? $options{'paystart_month'}
3055 : $self->paystart_month;
3057 my $paystart_year = exists($options{'paystart_year'})
3058 ? $options{'paystart_year'}
3059 : $self->paystart_year;
3061 $content{card_start} = "$paystart_month/$paystart_year"
3062 if $paystart_month && $paystart_year;
3064 my $payissue = exists($options{'payissue'})
3065 ? $options{'payissue'}
3067 $content{issue_number} = $payissue if $payissue;
3069 $content{recurring_billing} = 'YES'
3070 if qsearch('cust_pay', { 'custnum' => $self->custnum,
3072 'payinfo' => $payinfo,
3074 || qsearch('cust_pay', { 'custnum' => $self->custnum,
3076 'paymask' => $self->mask_payinfo('CARD', $payinfo),
3080 } elsif ( $method eq 'ECHECK' ) {
3081 ( $content{account_number}, $content{routing_code} ) =
3082 split('@', $payinfo);
3083 $content{bank_name} = $o_payname;
3084 $content{bank_state} = exists($options{'paystate'})
3085 ? $options{'paystate'}
3086 : $self->getfield('paystate');
3087 $content{account_type} = exists($options{'paytype'})
3088 ? uc($options{'paytype'}) || 'CHECKING'
3089 : uc($self->getfield('paytype')) || 'CHECKING';
3090 $content{account_name} = $payname;
3091 $content{customer_org} = $self->company ? 'B' : 'I';
3092 $content{state_id} = exists($options{'stateid'})
3093 ? $options{'stateid'}
3094 : $self->getfield('stateid');
3095 $content{state_id_state} = exists($options{'stateid_state'})
3096 ? $options{'stateid_state'}
3097 : $self->getfield('stateid_state');
3098 $content{customer_ssn} = exists($options{'ss'})
3101 } elsif ( $method eq 'LEC' ) {
3102 $content{phone} = $payinfo;
3106 # run transaction(s)
3109 my $balance = exists( $options{'balance'} )
3110 ? $options{'balance'}
3113 $self->select_for_update; #mutex ... just until we get our pending record in
3115 #the checks here are intended to catch concurrent payments
3116 #double-form-submission prevention is taken care of in cust_pay_pending::check
3119 return "The customer's balance has changed; $method transaction aborted."
3120 if $self->balance < $balance;
3121 #&& $self->balance < $amount; #might as well anyway?
3123 #also check and make sure there aren't *other* pending payments for this cust
3125 my @pending = qsearch('cust_pay_pending', {
3126 'custnum' => $self->custnum,
3127 'status' => { op=>'!=', value=>'done' }
3129 return "A payment is already being processed for this customer (".
3130 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
3131 "); $method transaction aborted."
3132 if scalar(@pending);
3134 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
3136 my $cust_pay_pending = new FS::cust_pay_pending {
3137 'custnum' => $self->custnum,
3138 #'invnum' => $options{'invnum'},
3141 'payby' => $method2payby{$method},
3142 'payinfo' => $payinfo,
3143 'paydate' => $paydate,
3145 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
3147 $cust_pay_pending->payunique( $options{payunique} )
3148 if defined($options{payunique}) && length($options{payunique});
3149 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
3150 return $cpp_new_err if $cpp_new_err;
3152 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3154 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3155 $transaction->content(
3158 'password' => $password,
3159 'action' => $action1,
3160 'description' => $options{'description'},
3161 'amount' => $amount,
3162 #'invoice_number' => $options{'invnum'},
3163 'customer_id' => $self->custnum,
3164 'last_name' => $paylast,
3165 'first_name' => $payfirst,
3167 'address' => $address,
3168 'city' => ( exists($options{'city'})
3171 'state' => ( exists($options{'state'})
3174 'zip' => ( exists($options{'zip'})
3177 'country' => ( exists($options{'country'})
3178 ? $options{'country'}
3180 'referer' => 'http://cleanwhisker.420.am/',
3182 'phone' => $self->daytime || $self->night,
3186 $cust_pay_pending->status('pending');
3187 my $cpp_pending_err = $cust_pay_pending->replace;
3188 return $cpp_pending_err if $cpp_pending_err;
3191 my $BOP_TESTING = 0;
3192 my $BOP_TESTING_SUCCESS = 1;
3194 unless ( $BOP_TESTING ) {
3195 $transaction->submit();
3197 if ( $BOP_TESTING_SUCCESS ) {
3198 $transaction->is_success(1);
3199 $transaction->authorization('fake auth');
3201 $transaction->is_success(0);
3202 $transaction->error_message('fake failure');
3206 if ( $transaction->is_success() && $action2 ) {
3208 $cust_pay_pending->status('authorized');
3209 my $cpp_authorized_err = $cust_pay_pending->replace;
3210 return $cpp_authorized_err if $cpp_authorized_err;
3212 my $auth = $transaction->authorization;
3213 my $ordernum = $transaction->can('order_number')
3214 ? $transaction->order_number
3218 new Business::OnlinePayment( $processor, @bop_options );
3225 password => $password,
3226 order_number => $ordernum,
3228 authorization => $auth,
3229 description => $options{'description'},
3232 foreach my $field (qw( authorization_source_code returned_ACI
3233 transaction_identifier validation_code
3234 transaction_sequence_num local_transaction_date
3235 local_transaction_time AVS_result_code )) {
3236 $capture{$field} = $transaction->$field() if $transaction->can($field);
3239 $capture->content( %capture );
3243 unless ( $capture->is_success ) {
3244 my $e = "Authorization successful but capture failed, custnum #".
3245 $self->custnum. ': '. $capture->result_code.
3246 ": ". $capture->error_message;
3253 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
3254 my $cpp_captured_err = $cust_pay_pending->replace;
3255 return $cpp_captured_err if $cpp_captured_err;
3258 # remove paycvv after initial transaction
3261 #false laziness w/misc/process/payment.cgi - check both to make sure working
3263 if ( defined $self->dbdef_table->column('paycvv')
3264 && length($self->paycvv)
3265 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3267 my $error = $self->remove_cvv;
3269 warn "WARNING: error removing cvv: $error\n";
3277 if ( $transaction->is_success() ) {
3280 if ( $payment_gateway ) { # agent override
3281 $paybatch = $payment_gateway->gatewaynum. '-';
3284 $paybatch .= "$processor:". $transaction->authorization;
3286 $paybatch .= ':'. $transaction->order_number
3287 if $transaction->can('order_number')
3288 && length($transaction->order_number);
3290 my $cust_pay = new FS::cust_pay ( {
3291 'custnum' => $self->custnum,
3292 'invnum' => $options{'invnum'},
3295 'payby' => $method2payby{$method},
3296 'payinfo' => $payinfo,
3297 'paybatch' => $paybatch,
3298 'paydate' => $paydate,
3300 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
3301 $cust_pay->payunique( $options{payunique} )
3302 if defined($options{payunique}) && length($options{payunique});
3304 my $oldAutoCommit = $FS::UID::AutoCommit;
3305 local $FS::UID::AutoCommit = 0;
3308 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
3310 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3313 $cust_pay->invnum(''); #try again with no specific invnum
3314 my $error2 = $cust_pay->insert( $options{'manual'} ?
3315 ( 'manual' => 1 ) : ()
3318 # gah. but at least we have a record of the state we had to abort in
3319 # from cust_pay_pending now.
3320 my $e = "WARNING: $method captured but payment not recorded - ".
3321 "error inserting payment ($processor): $error2".
3322 " (previously tried insert with invnum #$options{'invnum'}" .
3323 ": $error ) - pending payment saved as paypendingnum ".
3324 $cust_pay_pending->paypendingnum. "\n";
3330 if ( $options{'paynum_ref'} ) {
3331 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3334 $cust_pay_pending->status('done');
3335 $cust_pay_pending->statustext('captured');
3336 my $cpp_done_err = $cust_pay_pending->replace;
3338 if ( $cpp_done_err ) {
3340 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3341 my $e = "WARNING: $method captured but payment not recorded - ".
3342 "error updating status for paypendingnum ".
3343 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3349 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3350 return ''; #no error
3356 my $perror = "$processor error: ". $transaction->error_message;
3358 unless ( $transaction->error_message ) {
3361 if ( $transaction->can('response_page') ) {
3363 'page' => ( $transaction->can('response_page')
3364 ? $transaction->response_page
3367 'code' => ( $transaction->can('response_code')
3368 ? $transaction->response_code
3371 'headers' => ( $transaction->can('response_headers')
3372 ? $transaction->response_headers
3378 "No additional debugging information available for $processor";
3381 $perror .= "No error_message returned from $processor -- ".
3382 ( ref($t_response) ? Dumper($t_response) : $t_response );
3386 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3387 && $conf->exists('emaildecline')
3388 && grep { $_ ne 'POST' } $self->invoicing_list
3389 && ! grep { $transaction->error_message =~ /$_/ }
3390 $conf->config('emaildecline-exclude')
3392 my @templ = $conf->config('declinetemplate');
3393 my $template = new Text::Template (
3395 SOURCE => [ map "$_\n", @templ ],
3396 ) or return "($perror) can't create template: $Text::Template::ERROR";
3397 $template->compile()
3398 or return "($perror) can't compile template: $Text::Template::ERROR";
3400 my $templ_hash = { error => $transaction->error_message };
3402 my $error = send_email(
3403 'from' => $conf->config('invoice_from'),
3404 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3405 'subject' => 'Your payment could not be processed',
3406 'body' => [ $template->fill_in(HASH => $templ_hash) ],
3409 $perror .= " (also received error sending decline notification: $error)"
3414 $cust_pay_pending->status('done');
3415 $cust_pay_pending->statustext("declined: $perror");
3416 my $cpp_done_err = $cust_pay_pending->replace;
3417 if ( $cpp_done_err ) {
3418 my $e = "WARNING: $method declined but pending payment not resolved - ".
3419 "error updating status for paypendingnum ".
3420 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3422 $perror = "$e ($perror)";
3435 my( $self, $method, $amount, %options ) = @_;
3437 if ( $options{'fake_failure'} ) {
3438 return "Error: No error; test failure requested with fake_failure";
3441 my %method2payby = (
3448 #if ( $payment_gateway ) { # agent override
3449 # $paybatch = $payment_gateway->gatewaynum. '-';
3452 #$paybatch .= "$processor:". $transaction->authorization;
3454 #$paybatch .= ':'. $transaction->order_number
3455 # if $transaction->can('order_number')
3456 # && length($transaction->order_number);
3458 my $paybatch = 'FakeProcessor:54:32';
3460 my $cust_pay = new FS::cust_pay ( {
3461 'custnum' => $self->custnum,
3462 'invnum' => $options{'invnum'},
3465 'payby' => $method2payby{$method},
3466 #'payinfo' => $payinfo,
3467 'payinfo' => '4111111111111111',
3468 'paybatch' => $paybatch,
3469 #'paydate' => $paydate,
3470 'paydate' => '2012-05-01',
3472 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3474 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3477 $cust_pay->invnum(''); #try again with no specific invnum
3478 my $error2 = $cust_pay->insert( $options{'manual'} ?
3479 ( 'manual' => 1 ) : ()
3482 # gah, even with transactions.
3483 my $e = 'WARNING: Card/ACH debited but database not updated - '.
3484 "error inserting (fake!) payment: $error2".
3485 " (previously tried insert with invnum #$options{'invnum'}" .
3492 if ( $options{'paynum_ref'} ) {
3493 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3496 return ''; #no error
3500 =item default_payment_gateway
3504 sub default_payment_gateway {
3505 my( $self, $method ) = @_;
3507 die "Real-time processing not enabled\n"
3508 unless $conf->exists('business-onlinepayment');
3511 my $bop_config = 'business-onlinepayment';
3512 $bop_config .= '-ach'
3513 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
3514 my ( $processor, $login, $password, $action, @bop_options ) =
3515 $conf->config($bop_config);
3516 $action ||= 'normal authorization';
3517 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3518 die "No real-time processor is enabled - ".
3519 "did you set the business-onlinepayment configuration value?\n"
3522 ( $processor, $login, $password, $action, @bop_options )
3527 Removes the I<paycvv> field from the database directly.
3529 If there is an error, returns the error, otherwise returns false.
3535 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3536 or return dbh->errstr;
3537 $sth->execute($self->custnum)
3538 or return $sth->errstr;
3543 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3545 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3546 via a Business::OnlinePayment realtime gateway. See
3547 L<http://420.am/business-onlinepayment> for supported gateways.
3549 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3551 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3553 Most gateways require a reference to an original payment transaction to refund,
3554 so you probably need to specify a I<paynum>.
3556 I<amount> defaults to the original amount of the payment if not specified.
3558 I<reason> specifies a reason for the refund.
3560 I<paydate> specifies the expiration date for a credit card overriding the
3561 value from the customer record or the payment record. Specified as yyyy-mm-dd
3563 Implementation note: If I<amount> is unspecified or equal to the amount of the
3564 orignal payment, first an attempt is made to "void" the transaction via
3565 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3566 the normal attempt is made to "refund" ("credit") the transaction via the
3567 gateway is attempted.
3569 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3570 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3571 #if set, will override the value from the customer record.
3573 #If an I<invnum> is specified, this payment (if successful) is applied to the
3574 #specified invoice. If you don't specify an I<invnum> you might want to
3575 #call the B<apply_payments> method.
3579 #some false laziness w/realtime_bop, not enough to make it worth merging
3580 #but some useful small subs should be pulled out
3581 sub realtime_refund_bop {
3582 my( $self, $method, %options ) = @_;
3584 warn "$me realtime_refund_bop: $method refund\n";
3585 warn " $_ => $options{$_}\n" foreach keys %options;
3588 eval "use Business::OnlinePayment";
3592 # look up the original payment and optionally a gateway for that payment
3596 my $amount = $options{'amount'};
3598 my( $processor, $login, $password, @bop_options ) ;
3599 my( $auth, $order_number ) = ( '', '', '' );
3601 if ( $options{'paynum'} ) {
3603 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
3604 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3605 or return "Unknown paynum $options{'paynum'}";
3606 $amount ||= $cust_pay->paid;
3608 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3609 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3610 $cust_pay->paybatch;
3611 my $gatewaynum = '';
3612 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3614 if ( $gatewaynum ) { #gateway for the payment to be refunded
3616 my $payment_gateway =
3617 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3618 die "payment gateway $gatewaynum not found"
3619 unless $payment_gateway;
3621 $processor = $payment_gateway->gateway_module;
3622 $login = $payment_gateway->gateway_username;
3623 $password = $payment_gateway->gateway_password;
3624 @bop_options = $payment_gateway->options;
3626 } else { #try the default gateway
3628 my( $conf_processor, $unused_action );
3629 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3630 $self->default_payment_gateway($method);
3632 return "processor of payment $options{'paynum'} $processor does not".
3633 " match default processor $conf_processor"
3634 unless $processor eq $conf_processor;
3639 } else { # didn't specify a paynum, so look for agent gateway overrides
3640 # like a normal transaction
3643 if ( $method eq 'CC' ) {
3644 $cardtype = cardtype($self->payinfo);
3645 } elsif ( $method eq 'ECHECK' ) {
3648 $cardtype = $method;
3651 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3652 cardtype => $cardtype,
3654 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3656 taxclass => '', } );
3658 if ( $override ) { #use a payment gateway override
3660 my $payment_gateway = $override->payment_gateway;
3662 $processor = $payment_gateway->gateway_module;
3663 $login = $payment_gateway->gateway_username;
3664 $password = $payment_gateway->gateway_password;
3665 #$action = $payment_gateway->gateway_action;
3666 @bop_options = $payment_gateway->options;
3668 } else { #use the standard settings from the config
3671 ( $processor, $login, $password, $unused_action, @bop_options ) =
3672 $self->default_payment_gateway($method);
3677 return "neither amount nor paynum specified" unless $amount;
3682 'password' => $password,
3683 'order_number' => $order_number,
3684 'amount' => $amount,
3685 'referer' => 'http://cleanwhisker.420.am/',
3687 $content{authorization} = $auth
3688 if length($auth); #echeck/ACH transactions have an order # but no auth
3689 #(at least with authorize.net)
3691 my $disable_void_after;
3692 if ($conf->exists('disable_void_after')
3693 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3694 $disable_void_after = $1;
3697 #first try void if applicable
3698 if ( $cust_pay && $cust_pay->paid == $amount
3700 ( not defined($disable_void_after) )
3701 || ( time < ($cust_pay->_date + $disable_void_after ) )
3704 warn " attempting void\n" if $DEBUG > 1;
3705 my $void = new Business::OnlinePayment( $processor, @bop_options );
3706 $void->content( 'action' => 'void', %content );
3708 if ( $void->is_success ) {
3709 my $error = $cust_pay->void($options{'reason'});
3711 # gah, even with transactions.
3712 my $e = 'WARNING: Card/ACH voided but database not updated - '.
3713 "error voiding payment: $error";
3717 warn " void successful\n" if $DEBUG > 1;
3722 warn " void unsuccessful, trying refund\n"
3726 my $address = $self->address1;
3727 $address .= ", ". $self->address2 if $self->address2;
3729 my($payname, $payfirst, $paylast);
3730 if ( $self->payname && $method ne 'ECHECK' ) {
3731 $payname = $self->payname;
3732 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3733 or return "Illegal payname $payname";
3734 ($payfirst, $paylast) = ($1, $2);
3736 $payfirst = $self->getfield('first');
3737 $paylast = $self->getfield('last');
3738 $payname = "$payfirst $paylast";
3741 my @invoicing_list = $self->invoicing_list_emailonly;
3742 if ( $conf->exists('emailinvoiceautoalways')
3743 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3744 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3745 push @invoicing_list, $self->all_emails;
3748 my $email = ($conf->exists('business-onlinepayment-email-override'))
3749 ? $conf->config('business-onlinepayment-email-override')
3750 : $invoicing_list[0];
3752 my $payip = exists($options{'payip'})
3755 $content{customer_ip} = $payip
3759 if ( $method eq 'CC' ) {
3762 $content{card_number} = $payinfo = $cust_pay->payinfo;
3763 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3764 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3765 ($content{expiration} = "$2/$1"); # where available
3767 $content{card_number} = $payinfo = $self->payinfo;
3768 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3769 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3770 $content{expiration} = "$2/$1";
3773 } elsif ( $method eq 'ECHECK' ) {
3776 $payinfo = $cust_pay->payinfo;
3778 $payinfo = $self->payinfo;
3780 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3781 $content{bank_name} = $self->payname;
3782 $content{account_type} = 'CHECKING';
3783 $content{account_name} = $payname;
3784 $content{customer_org} = $self->company ? 'B' : 'I';
3785 $content{customer_ssn} = $self->ss;
3786 } elsif ( $method eq 'LEC' ) {
3787 $content{phone} = $payinfo = $self->payinfo;
3791 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3792 my %sub_content = $refund->content(
3793 'action' => 'credit',
3794 'customer_id' => $self->custnum,
3795 'last_name' => $paylast,
3796 'first_name' => $payfirst,
3798 'address' => $address,
3799 'city' => $self->city,
3800 'state' => $self->state,
3801 'zip' => $self->zip,
3802 'country' => $self->country,
3804 'phone' => $self->daytime || $self->night,
3807 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3811 return "$processor error: ". $refund->error_message
3812 unless $refund->is_success();
3814 my %method2payby = (
3820 my $paybatch = "$processor:". $refund->authorization;
3821 $paybatch .= ':'. $refund->order_number
3822 if $refund->can('order_number') && $refund->order_number;
3824 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3825 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3826 last unless @cust_bill_pay;
3827 my $cust_bill_pay = pop @cust_bill_pay;
3828 my $error = $cust_bill_pay->delete;
3832 my $cust_refund = new FS::cust_refund ( {
3833 'custnum' => $self->custnum,
3834 'paynum' => $options{'paynum'},
3835 'refund' => $amount,
3837 'payby' => $method2payby{$method},
3838 'payinfo' => $payinfo,
3839 'paybatch' => $paybatch,
3840 'reason' => $options{'reason'} || 'card or ACH refund',
3842 my $error = $cust_refund->insert;
3844 $cust_refund->paynum(''); #try again with no specific paynum
3845 my $error2 = $cust_refund->insert;
3847 # gah, even with transactions.
3848 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3849 "error inserting refund ($processor): $error2".
3850 " (previously tried insert with paynum #$options{'paynum'}" .
3861 =item batch_card OPTION => VALUE...
3863 Adds a payment for this invoice to the pending credit card batch (see
3864 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3865 runs the payment using a realtime gateway.
3870 my ($self, %options) = @_;
3873 if (exists($options{amount})) {
3874 $amount = $options{amount};
3876 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3878 return '' unless $amount > 0;
3880 my $invnum = delete $options{invnum};
3881 my $payby = $options{invnum} || $self->payby; #dubious
3883 if ($options{'realtime'}) {
3884 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3890 my $oldAutoCommit = $FS::UID::AutoCommit;
3891 local $FS::UID::AutoCommit = 0;
3894 #this needs to handle mysql as well as Pg, like svc_acct.pm
3895 #(make it into a common function if folks need to do batching with mysql)
3896 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3897 or return "Cannot lock pay_batch: " . $dbh->errstr;
3901 'payby' => FS::payby->payby2payment($payby),
3904 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3906 unless ( $pay_batch ) {
3907 $pay_batch = new FS::pay_batch \%pay_batch;
3908 my $error = $pay_batch->insert;
3910 $dbh->rollback if $oldAutoCommit;
3911 die "error creating new batch: $error\n";
3915 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3916 'batchnum' => $pay_batch->batchnum,
3917 'custnum' => $self->custnum,
3920 foreach (qw( address1 address2 city state zip country payby payinfo paydate
3922 $options{$_} = '' unless exists($options{$_});
3925 my $cust_pay_batch = new FS::cust_pay_batch ( {
3926 'batchnum' => $pay_batch->batchnum,
3927 'invnum' => $invnum || 0, # is there a better value?
3928 # this field should be
3930 # cust_bill_pay_batch now
3931 'custnum' => $self->custnum,
3932 'last' => $self->getfield('last'),
3933 'first' => $self->getfield('first'),
3934 'address1' => $options{address1} || $self->address1,
3935 'address2' => $options{address2} || $self->address2,
3936 'city' => $options{city} || $self->city,
3937 'state' => $options{state} || $self->state,
3938 'zip' => $options{zip} || $self->zip,
3939 'country' => $options{country} || $self->country,
3940 'payby' => $options{payby} || $self->payby,
3941 'payinfo' => $options{payinfo} || $self->payinfo,
3942 'exp' => $options{paydate} || $self->paydate,
3943 'payname' => $options{payname} || $self->payname,
3944 'amount' => $amount, # consolidating
3947 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
3948 if $old_cust_pay_batch;
3951 if ($old_cust_pay_batch) {
3952 $error = $cust_pay_batch->replace($old_cust_pay_batch)
3954 $error = $cust_pay_batch->insert;
3958 $dbh->rollback if $oldAutoCommit;
3962 my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
3963 foreach my $cust_bill ($self->open_cust_bill) {
3964 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
3965 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
3966 'invnum' => $cust_bill->invnum,
3967 'paybatchnum' => $cust_pay_batch->paybatchnum,
3968 'amount' => $cust_bill->owed,
3971 if ($unapplied >= $cust_bill_pay_batch->amount){
3972 $unapplied -= $cust_bill_pay_batch->amount;
3975 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
3976 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
3978 $error = $cust_bill_pay_batch->insert;
3980 $dbh->rollback if $oldAutoCommit;
3985 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3991 Returns the total owed for this customer on all invoices
3992 (see L<FS::cust_bill/owed>).
3998 $self->total_owed_date(2145859200); #12/31/2037
4001 =item total_owed_date TIME
4003 Returns the total owed for this customer on all invoices with date earlier than
4004 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
4005 see L<Time::Local> and L<Date::Parse> for conversion functions.
4009 sub total_owed_date {
4013 foreach my $cust_bill (
4014 grep { $_->_date <= $time }
4015 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4017 $total_bill += $cust_bill->owed;
4019 sprintf( "%.2f", $total_bill );
4022 =item apply_payments_and_credits
4024 Applies unapplied payments and credits.
4026 In most cases, this new method should be used in place of sequential
4027 apply_payments and apply_credits methods.
4029 If there is an error, returns the error, otherwise returns false.
4033 sub apply_payments_and_credits {
4036 local $SIG{HUP} = 'IGNORE';
4037 local $SIG{INT} = 'IGNORE';
4038 local $SIG{QUIT} = 'IGNORE';
4039 local $SIG{TERM} = 'IGNORE';
4040 local $SIG{TSTP} = 'IGNORE';
4041 local $SIG{PIPE} = 'IGNORE';
4043 my $oldAutoCommit = $FS::UID::AutoCommit;
4044 local $FS::UID::AutoCommit = 0;
4047 $self->select_for_update; #mutex
4049 foreach my $cust_bill ( $self->open_cust_bill ) {
4050 my $error = $cust_bill->apply_payments_and_credits;
4052 $dbh->rollback if $oldAutoCommit;
4053 return "Error applying: $error";
4057 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4062 =item apply_credits OPTION => VALUE ...
4064 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
4065 to outstanding invoice balances in chronological order (or reverse
4066 chronological order if the I<order> option is set to B<newest>) and returns the
4067 value of any remaining unapplied credits available for refund (see
4068 L<FS::cust_refund>).
4070 Dies if there is an error.
4078 local $SIG{HUP} = 'IGNORE';
4079 local $SIG{INT} = 'IGNORE';
4080 local $SIG{QUIT} = 'IGNORE';
4081 local $SIG{TERM} = 'IGNORE';
4082 local $SIG{TSTP} = 'IGNORE';
4083 local $SIG{PIPE} = 'IGNORE';
4085 my $oldAutoCommit = $FS::UID::AutoCommit;
4086 local $FS::UID::AutoCommit = 0;
4089 $self->select_for_update; #mutex
4091 unless ( $self->total_credited ) {
4092 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4096 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
4097 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
4099 my @invoices = $self->open_cust_bill;
4100 @invoices = sort { $b->_date <=> $a->_date } @invoices
4101 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
4104 foreach my $cust_bill ( @invoices ) {
4107 if ( !defined($credit) || $credit->credited == 0) {
4108 $credit = pop @credits or last;
4111 if ($cust_bill->owed >= $credit->credited) {
4112 $amount=$credit->credited;
4114 $amount=$cust_bill->owed;
4117 my $cust_credit_bill = new FS::cust_credit_bill ( {
4118 'crednum' => $credit->crednum,
4119 'invnum' => $cust_bill->invnum,
4120 'amount' => $amount,
4122 my $error = $cust_credit_bill->insert;
4124 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4128 redo if ($cust_bill->owed > 0);
4132 my $total_credited = $self->total_credited;
4134 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4136 return $total_credited;
4139 =item apply_payments
4141 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
4142 to outstanding invoice balances in chronological order.
4144 #and returns the value of any remaining unapplied payments.
4146 Dies if there is an error.
4150 sub apply_payments {
4153 local $SIG{HUP} = 'IGNORE';
4154 local $SIG{INT} = 'IGNORE';
4155 local $SIG{QUIT} = 'IGNORE';
4156 local $SIG{TERM} = 'IGNORE';
4157 local $SIG{TSTP} = 'IGNORE';
4158 local $SIG{PIPE} = 'IGNORE';
4160 my $oldAutoCommit = $FS::UID::AutoCommit;
4161 local $FS::UID::AutoCommit = 0;
4164 $self->select_for_update; #mutex
4168 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
4169 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
4171 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
4172 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
4176 foreach my $cust_bill ( @invoices ) {
4179 if ( !defined($payment) || $payment->unapplied == 0 ) {
4180 $payment = pop @payments or last;
4183 if ( $cust_bill->owed >= $payment->unapplied ) {
4184 $amount = $payment->unapplied;
4186 $amount = $cust_bill->owed;
4189 my $cust_bill_pay = new FS::cust_bill_pay ( {
4190 'paynum' => $payment->paynum,
4191 'invnum' => $cust_bill->invnum,
4192 'amount' => $amount,
4194 my $error = $cust_bill_pay->insert;
4196 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4200 redo if ( $cust_bill->owed > 0);
4204 my $total_unapplied_payments = $self->total_unapplied_payments;
4206 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4208 return $total_unapplied_payments;
4211 =item total_credited
4213 Returns the total outstanding credit (see L<FS::cust_credit>) for this
4214 customer. See L<FS::cust_credit/credited>.
4218 sub total_credited {
4220 my $total_credit = 0;
4221 foreach my $cust_credit ( qsearch('cust_credit', {
4222 'custnum' => $self->custnum,
4224 $total_credit += $cust_credit->credited;
4226 sprintf( "%.2f", $total_credit );
4229 =item total_unapplied_payments
4231 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
4232 See L<FS::cust_pay/unapplied>.
4236 sub total_unapplied_payments {
4238 my $total_unapplied = 0;
4239 foreach my $cust_pay ( qsearch('cust_pay', {
4240 'custnum' => $self->custnum,
4242 $total_unapplied += $cust_pay->unapplied;
4244 sprintf( "%.2f", $total_unapplied );
4247 =item total_unapplied_refunds
4249 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
4250 customer. See L<FS::cust_refund/unapplied>.
4254 sub total_unapplied_refunds {
4256 my $total_unapplied = 0;
4257 foreach my $cust_refund ( qsearch('cust_refund', {
4258 'custnum' => $self->custnum,
4260 $total_unapplied += $cust_refund->unapplied;
4262 sprintf( "%.2f", $total_unapplied );
4267 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4268 total_credited minus total_unapplied_payments).
4276 + $self->total_unapplied_refunds
4277 - $self->total_credited
4278 - $self->total_unapplied_payments
4282 =item balance_date TIME
4284 Returns the balance for this customer, only considering invoices with date
4285 earlier than TIME (total_owed_date minus total_credited minus
4286 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
4287 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
4296 $self->total_owed_date($time)
4297 + $self->total_unapplied_refunds
4298 - $self->total_credited
4299 - $self->total_unapplied_payments
4303 =item in_transit_payments
4305 Returns the total of requests for payments for this customer pending in
4306 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
4310 sub in_transit_payments {
4312 my $in_transit_payments = 0;
4313 foreach my $pay_batch ( qsearch('pay_batch', {
4316 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4317 'batchnum' => $pay_batch->batchnum,
4318 'custnum' => $self->custnum,
4320 $in_transit_payments += $cust_pay_batch->amount;
4323 sprintf( "%.2f", $in_transit_payments );
4326 =item paydate_monthyear
4328 Returns a two-element list consisting of the month and year of this customer's
4329 paydate (credit card expiration date for CARD customers)
4333 sub paydate_monthyear {
4335 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4337 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4344 =item invoicing_list [ ARRAYREF ]
4346 If an arguement is given, sets these email addresses as invoice recipients
4347 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
4348 (except as warnings), so use check_invoicing_list first.
4350 Returns a list of email addresses (with svcnum entries expanded).
4352 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
4353 check it without disturbing anything by passing nothing.
4355 This interface may change in the future.
4359 sub invoicing_list {
4360 my( $self, $arrayref ) = @_;
4363 my @cust_main_invoice;
4364 if ( $self->custnum ) {
4365 @cust_main_invoice =
4366 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4368 @cust_main_invoice = ();
4370 foreach my $cust_main_invoice ( @cust_main_invoice ) {
4371 #warn $cust_main_invoice->destnum;
4372 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4373 #warn $cust_main_invoice->destnum;
4374 my $error = $cust_main_invoice->delete;
4375 warn $error if $error;
4378 if ( $self->custnum ) {
4379 @cust_main_invoice =
4380 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4382 @cust_main_invoice = ();
4384 my %seen = map { $_->address => 1 } @cust_main_invoice;
4385 foreach my $address ( @{$arrayref} ) {
4386 next if exists $seen{$address} && $seen{$address};
4387 $seen{$address} = 1;
4388 my $cust_main_invoice = new FS::cust_main_invoice ( {
4389 'custnum' => $self->custnum,
4392 my $error = $cust_main_invoice->insert;
4393 warn $error if $error;
4397 if ( $self->custnum ) {
4399 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4406 =item check_invoicing_list ARRAYREF
4408 Checks these arguements as valid input for the invoicing_list method. If there
4409 is an error, returns the error, otherwise returns false.
4413 sub check_invoicing_list {
4414 my( $self, $arrayref ) = @_;
4416 foreach my $address ( @$arrayref ) {
4418 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4419 return 'Can\'t add FAX invoice destination with a blank FAX number.';
4422 my $cust_main_invoice = new FS::cust_main_invoice ( {
4423 'custnum' => $self->custnum,
4426 my $error = $self->custnum
4427 ? $cust_main_invoice->check
4428 : $cust_main_invoice->checkdest
4430 return $error if $error;
4434 return "Email address required"
4435 if $conf->exists('cust_main-require_invoicing_list_email')
4436 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4441 =item set_default_invoicing_list
4443 Sets the invoicing list to all accounts associated with this customer,
4444 overwriting any previous invoicing list.
4448 sub set_default_invoicing_list {
4450 $self->invoicing_list($self->all_emails);
4455 Returns the email addresses of all accounts provisioned for this customer.
4462 foreach my $cust_pkg ( $self->all_pkgs ) {
4463 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4465 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4466 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4468 $list{$_}=1 foreach map { $_->email } @svc_acct;
4473 =item invoicing_list_addpost
4475 Adds postal invoicing to this customer. If this customer is already configured
4476 to receive postal invoices, does nothing.
4480 sub invoicing_list_addpost {
4482 return if grep { $_ eq 'POST' } $self->invoicing_list;
4483 my @invoicing_list = $self->invoicing_list;
4484 push @invoicing_list, 'POST';
4485 $self->invoicing_list(\@invoicing_list);
4488 =item invoicing_list_emailonly
4490 Returns the list of email invoice recipients (invoicing_list without non-email
4491 destinations such as POST and FAX).
4495 sub invoicing_list_emailonly {
4497 warn "$me invoicing_list_emailonly called"
4499 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4502 =item invoicing_list_emailonly_scalar
4504 Returns the list of email invoice recipients (invoicing_list without non-email
4505 destinations such as POST and FAX) as a comma-separated scalar.
4509 sub invoicing_list_emailonly_scalar {
4511 warn "$me invoicing_list_emailonly_scalar called"
4513 join(', ', $self->invoicing_list_emailonly);
4516 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4518 Returns an array of customers referred by this customer (referral_custnum set
4519 to this custnum). If DEPTH is given, recurses up to the given depth, returning
4520 customers referred by customers referred by this customer and so on, inclusive.
4521 The default behavior is DEPTH 1 (no recursion).
4525 sub referral_cust_main {
4527 my $depth = @_ ? shift : 1;
4528 my $exclude = @_ ? shift : {};
4531 map { $exclude->{$_->custnum}++; $_; }
4532 grep { ! $exclude->{ $_->custnum } }
4533 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4537 map { $_->referral_cust_main($depth-1, $exclude) }
4544 =item referral_cust_main_ncancelled
4546 Same as referral_cust_main, except only returns customers with uncancelled
4551 sub referral_cust_main_ncancelled {
4553 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4556 =item referral_cust_pkg [ DEPTH ]
4558 Like referral_cust_main, except returns a flat list of all unsuspended (and
4559 uncancelled) packages for each customer. The number of items in this list may
4560 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4564 sub referral_cust_pkg {
4566 my $depth = @_ ? shift : 1;
4568 map { $_->unsuspended_pkgs }
4569 grep { $_->unsuspended_pkgs }
4570 $self->referral_cust_main($depth);
4573 =item referring_cust_main
4575 Returns the single cust_main record for the customer who referred this customer
4576 (referral_custnum), or false.
4580 sub referring_cust_main {
4582 return '' unless $self->referral_custnum;
4583 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4586 =item credit AMOUNT, REASON
4588 Applies a credit to this customer. If there is an error, returns the error,
4589 otherwise returns false.
4594 my( $self, $amount, $reason, %options ) = @_;
4595 my $cust_credit = new FS::cust_credit {
4596 'custnum' => $self->custnum,
4597 'amount' => $amount,
4598 'reason' => $reason,
4600 $cust_credit->insert(%options);
4603 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4605 Creates a one-time charge for this customer. If there is an error, returns
4606 the error, otherwise returns false.
4612 my ( $amount, $pkg, $comment, $taxclass, $additional, $classnum );
4613 if ( ref( $_[0] ) ) {
4614 $amount = $_[0]->{amount};
4615 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4616 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
4617 : '$'. sprintf("%.2f",$amount);
4618 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4619 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
4620 $additional = $_[0]->{additional};
4623 $pkg = @_ ? shift : 'One-time charge';
4624 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
4625 $taxclass = @_ ? shift : '';
4629 local $SIG{HUP} = 'IGNORE';
4630 local $SIG{INT} = 'IGNORE';
4631 local $SIG{QUIT} = 'IGNORE';
4632 local $SIG{TERM} = 'IGNORE';
4633 local $SIG{TSTP} = 'IGNORE';
4634 local $SIG{PIPE} = 'IGNORE';
4636 my $oldAutoCommit = $FS::UID::AutoCommit;
4637 local $FS::UID::AutoCommit = 0;
4640 my $part_pkg = new FS::part_pkg ( {
4642 'comment' => $comment,
4646 'classnum' => $classnum ? $classnum : '',
4647 'taxclass' => $taxclass,
4650 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4651 ( 0 .. @$additional - 1 )
4653 'additional_count' => scalar(@$additional),
4654 'setup_fee' => $amount,
4657 my $error = $part_pkg->insert( options => \%options );
4659 $dbh->rollback if $oldAutoCommit;
4663 my $pkgpart = $part_pkg->pkgpart;
4664 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4665 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4666 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4667 $error = $type_pkgs->insert;
4669 $dbh->rollback if $oldAutoCommit;
4674 my $cust_pkg = new FS::cust_pkg ( {
4675 'custnum' => $self->custnum,
4676 'pkgpart' => $pkgpart,
4679 $error = $cust_pkg->insert;
4681 $dbh->rollback if $oldAutoCommit;
4685 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4692 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4698 sort { $a->_date <=> $b->_date }
4699 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4702 =item open_cust_bill
4704 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4709 sub open_cust_bill {
4711 grep { $_->owed > 0 } $self->cust_bill;
4716 Returns all the credits (see L<FS::cust_credit>) for this customer.
4722 sort { $a->_date <=> $b->_date }
4723 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4728 Returns all the payments (see L<FS::cust_pay>) for this customer.
4734 sort { $a->_date <=> $b->_date }
4735 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4740 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4746 sort { $a->_date <=> $b->_date }
4747 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4750 =item cust_pay_batch
4752 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
4756 sub cust_pay_batch {
4758 sort { $a->_date <=> $b->_date }
4759 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
4764 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4770 sort { $a->_date <=> $b->_date }
4771 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4776 Returns a name string for this customer, either "Company (Last, First)" or
4783 my $name = $self->contact;
4784 $name = $self->company. " ($name)" if $self->company;
4790 Returns a name string for this (service/shipping) contact, either
4791 "Company (Last, First)" or "Last, First".
4797 if ( $self->get('ship_last') ) {
4798 my $name = $self->ship_contact;
4799 $name = $self->ship_company. " ($name)" if $self->ship_company;
4808 Returns this customer's full (billing) contact name only, "Last, First"
4814 $self->get('last'). ', '. $self->first;
4819 Returns this customer's full (shipping) contact name only, "Last, First"
4825 $self->get('ship_last')
4826 ? $self->get('ship_last'). ', '. $self->ship_first
4832 Returns this customer's full country name
4838 code2country($self->country);
4841 =item geocode DATA_VENDOR
4843 Returns a value for the customer location as encoded by DATA_VENDOR.
4844 Currently this only makes sense for "CCH" as DATA_VENDOR.
4849 my ($self, $data_vendor) = (shift, shift); #always cch for now
4851 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
4855 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
4856 if $self->country eq 'US';
4858 #CCH specific location stuff
4859 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
4862 my $cust_tax_location =
4864 'table' => 'cust_tax_location',
4865 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
4866 'extra_sql' => $extra_sql,
4869 $geocode = $cust_tax_location->geocode
4870 if $cust_tax_location;
4879 Returns a status string for this customer, currently:
4883 =item prospect - No packages have ever been ordered
4885 =item active - One or more recurring packages is active
4887 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4889 =item suspended - All non-cancelled recurring packages are suspended
4891 =item cancelled - All recurring packages are cancelled
4897 sub status { shift->cust_status(@_); }
4901 for my $status (qw( prospect active inactive suspended cancelled )) {
4902 my $method = $status.'_sql';
4903 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4904 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4905 $sth->execute( ($self->custnum) x $numnum )
4906 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4907 return $status if $sth->fetchrow_arrayref->[0];
4911 =item ucfirst_cust_status
4913 =item ucfirst_status
4915 Returns the status with the first character capitalized.
4919 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4921 sub ucfirst_cust_status {
4923 ucfirst($self->cust_status);
4928 Returns a hex triplet color string for this customer's status.
4932 use vars qw(%statuscolor);
4933 tie my %statuscolor, 'Tie::IxHash',
4934 'prospect' => '7e0079', #'000000', #black? naw, purple
4935 'active' => '00CC00', #green
4936 'inactive' => '0000CC', #blue
4937 'suspended' => 'FF9900', #yellow
4938 'cancelled' => 'FF0000', #red
4941 sub statuscolor { shift->cust_statuscolor(@_); }
4943 sub cust_statuscolor {
4945 $statuscolor{$self->cust_status};
4950 Returns an array of hashes representing the customer's RT tickets.
4957 my $num = $conf->config('cust_main-max_tickets') || 10;
4960 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4962 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4966 foreach my $priority (
4967 $conf->config('ticket_system-custom_priority_field-values'), ''
4969 last if scalar(@tickets) >= $num;
4971 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4972 $num - scalar(@tickets),
4981 # Return services representing svc_accts in customer support packages
4982 sub support_services {
4984 my %packages = map { $_ => 1 } $conf->config('support_packages');
4986 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4987 grep { $_->part_svc->svcdb eq 'svc_acct' }
4988 map { $_->cust_svc }
4989 grep { exists $packages{ $_->pkgpart } }
4990 $self->ncancelled_pkgs;
4996 =head1 CLASS METHODS
5002 Class method that returns the list of possible status strings for customers
5003 (see L<the status method|/status>). For example:
5005 @statuses = FS::cust_main->statuses();
5010 #my $self = shift; #could be class...
5016 Returns an SQL expression identifying prospective cust_main records (customers
5017 with no packages ever ordered)
5021 use vars qw($select_count_pkgs);
5022 $select_count_pkgs =
5023 "SELECT COUNT(*) FROM cust_pkg
5024 WHERE cust_pkg.custnum = cust_main.custnum";
5026 sub select_count_pkgs_sql {
5030 sub prospect_sql { "
5031 0 = ( $select_count_pkgs )
5036 Returns an SQL expression identifying active cust_main records (customers with
5037 no active recurring packages, but otherwise unsuspended/uncancelled).
5042 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
5048 Returns an SQL expression identifying inactive cust_main records (customers with
5049 active recurring packages).
5053 sub inactive_sql { "
5054 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5056 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
5062 Returns an SQL expression identifying suspended cust_main records.
5067 sub suspended_sql { susp_sql(@_); }
5069 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
5071 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5077 Returns an SQL expression identifying cancelled cust_main records.
5081 sub cancelled_sql { cancel_sql(@_); }
5084 my $recurring_sql = FS::cust_pkg->recurring_sql;
5085 #my $recurring_sql = "
5086 # '0' != ( select freq from part_pkg
5087 # where cust_pkg.pkgpart = part_pkg.pkgpart )
5091 0 < ( $select_count_pkgs )
5092 AND 0 = ( $select_count_pkgs AND $recurring_sql
5093 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5099 =item uncancelled_sql
5101 Returns an SQL expression identifying un-cancelled cust_main records.
5105 sub uncancelled_sql { uncancel_sql(@_); }
5106 sub uncancel_sql { "
5107 ( 0 < ( $select_count_pkgs
5108 AND ( cust_pkg.cancel IS NULL
5109 OR cust_pkg.cancel = 0
5112 OR 0 = ( $select_count_pkgs )
5118 Returns an SQL fragment to retreive the balance.
5123 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5124 WHERE cust_bill.custnum = cust_main.custnum )
5125 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5126 WHERE cust_pay.custnum = cust_main.custnum )
5127 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5128 WHERE cust_credit.custnum = cust_main.custnum )
5129 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5130 WHERE cust_refund.custnum = cust_main.custnum )
5133 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5135 Returns an SQL fragment to retreive the balance for this customer, only
5136 considering invoices with date earlier than START_TIME, and optionally not
5137 later than END_TIME (total_owed_date minus total_credited minus
5138 total_unapplied_payments).
5140 Times are specified as SQL fragments or numeric
5141 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5142 L<Date::Parse> for conversion functions. The empty string can be passed
5143 to disable that time constraint completely.
5145 Available options are:
5149 =item unapplied_date - set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
5151 =item total - set to true to remove all customer comparison clauses, for totals
5153 =item where - WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5155 =item join - JOIN clause (typically used with the total option)
5163 sub balance_date_sql {
5164 my( $class, $start, $end, %opt ) = @_;
5166 my $owed = FS::cust_bill->owed_sql;
5167 my $unapp_refund = FS::cust_refund->unapplied_sql;
5168 my $unapp_credit = FS::cust_credit->unapplied_sql;
5169 my $unapp_pay = FS::cust_pay->unapplied_sql;
5171 my $j = $opt{'join'} || '';
5173 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5174 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5175 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5176 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5178 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5179 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5180 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5181 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5186 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5188 Helper method for balance_date_sql; name (and usage) subject to change
5189 (suggestions welcome).
5191 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5192 cust_refund, cust_credit or cust_pay).
5194 If TABLE is "cust_bill" or the unapplied_date option is true, only
5195 considers records with date earlier than START_TIME, and optionally not
5196 later than END_TIME .
5200 sub _money_table_where {
5201 my( $class, $table, $start, $end, %opt ) = @_;
5204 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5205 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5206 push @where, "$table._date <= $start" if defined($start) && length($start);
5207 push @where, "$table._date > $end" if defined($end) && length($end);
5209 push @where, @{$opt{'where'}} if $opt{'where'};
5210 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5216 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
5218 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
5219 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
5220 appropriate ship_ field is also searched).
5222 Additional options are the same as FS::Record::qsearch
5227 my( $self, $fuzzy, $hash, @opt) = @_;
5232 check_and_rebuild_fuzzyfiles();
5233 foreach my $field ( keys %$fuzzy ) {
5235 my $all = $self->all_X($field);
5236 next unless scalar(@$all);
5239 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
5242 foreach ( keys %match ) {
5243 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
5244 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
5247 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
5250 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
5252 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
5260 Returns a masked version of the named field
5265 my ($self,$field) = @_;
5269 'x'x(length($self->getfield($field))-4).
5270 substr($self->getfield($field), (length($self->getfield($field))-4));
5280 =item smart_search OPTION => VALUE ...
5282 Accepts the following options: I<search>, the string to search for. The string
5283 will be searched for as a customer number, phone number, name or company name,
5284 as an exact, or, in some cases, a substring or fuzzy match (see the source code
5285 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
5286 skip fuzzy matching when an exact match is found.
5288 Any additional options are treated as an additional qualifier on the search
5291 Returns a (possibly empty) array of FS::cust_main objects.
5298 #here is the agent virtualization
5299 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5303 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
5304 my $search = delete $options{'search'};
5305 ( my $alphanum_search = $search ) =~ s/\W//g;
5307 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
5309 #false laziness w/Record::ut_phone
5310 my $phonen = "$1-$2-$3";
5311 $phonen .= " x$4" if $4;
5313 push @cust_main, qsearch( {
5314 'table' => 'cust_main',
5315 'hashref' => { %options },
5316 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5318 join(' OR ', map "$_ = '$phonen'",
5319 qw( daytime night fax
5320 ship_daytime ship_night ship_fax )
5323 " AND $agentnums_sql", #agent virtualization
5326 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
5327 #try looking for matches with extensions unless one was specified
5329 push @cust_main, qsearch( {
5330 'table' => 'cust_main',
5331 'hashref' => { %options },
5332 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5334 join(' OR ', map "$_ LIKE '$phonen\%'",
5336 ship_daytime ship_night )
5339 " AND $agentnums_sql", #agent virtualization
5344 # custnum search (also try agent_custid), with some tweaking options if your
5345 # legacy cust "numbers" have letters
5346 } elsif ( $search =~ /^\s*(\d+)\s*$/
5347 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
5348 && $search =~ /^\s*(\w\w?\d+)\s*$/
5353 push @cust_main, qsearch( {
5354 'table' => 'cust_main',
5355 'hashref' => { 'custnum' => $1, %options },
5356 'extra_sql' => " AND $agentnums_sql", #agent virtualization
5359 push @cust_main, qsearch( {
5360 'table' => 'cust_main',
5361 'hashref' => { 'agent_custid' => $1, %options },
5362 'extra_sql' => " AND $agentnums_sql", #agent virtualization
5365 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
5367 my($company, $last, $first) = ( $1, $2, $3 );
5369 # "Company (Last, First)"
5370 #this is probably something a browser remembered,
5371 #so just do an exact search
5373 foreach my $prefix ( '', 'ship_' ) {
5374 push @cust_main, qsearch( {
5375 'table' => 'cust_main',
5376 'hashref' => { $prefix.'first' => $first,
5377 $prefix.'last' => $last,
5378 $prefix.'company' => $company,
5381 'extra_sql' => " AND $agentnums_sql",
5385 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
5386 # try (ship_){last,company}
5390 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
5391 # # full strings the browser remembers won't work
5392 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
5394 use Lingua::EN::NameParse;
5395 my $NameParse = new Lingua::EN::NameParse(
5397 allow_reversed => 1,
5400 my($last, $first) = ( '', '' );
5401 #maybe disable this too and just rely on NameParse?
5402 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
5404 ($last, $first) = ( $1, $2 );
5406 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
5407 } elsif ( ! $NameParse->parse($value) ) {
5409 my %name = $NameParse->components;
5410 $first = $name{'given_name_1'};
5411 $last = $name{'surname_1'};
5415 if ( $first && $last ) {
5417 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
5420 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5422 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
5423 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
5426 push @cust_main, qsearch( {
5427 'table' => 'cust_main',
5428 'hashref' => \%options,
5429 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5432 # or it just be something that was typed in... (try that in a sec)
5436 my $q_value = dbh->quote($value);
5439 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5440 $sql .= " ( LOWER(last) = $q_value
5441 OR LOWER(company) = $q_value
5442 OR LOWER(ship_last) = $q_value
5443 OR LOWER(ship_company) = $q_value
5446 push @cust_main, qsearch( {
5447 'table' => 'cust_main',
5448 'hashref' => \%options,
5449 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5452 #no exact match, trying substring/fuzzy
5453 #always do substring & fuzzy (unless they're explicity config'ed off)
5454 #getting complaints searches are not returning enough
5455 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
5457 #still some false laziness w/ search/cust_main.cgi
5462 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
5463 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
5466 if ( $first && $last ) {
5469 { 'first' => { op=>'ILIKE', value=>"%$first%" },
5470 'last' => { op=>'ILIKE', value=>"%$last%" },
5472 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
5473 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
5480 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
5481 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
5485 foreach my $hashref ( @hashrefs ) {
5487 push @cust_main, qsearch( {
5488 'table' => 'cust_main',
5489 'hashref' => { %$hashref,
5492 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
5501 " AND $agentnums_sql", #extra_sql #agent virtualization
5504 if ( $first && $last ) {
5505 push @cust_main, FS::cust_main->fuzzy_search(
5506 { 'last' => $last, #fuzzy hashref
5507 'first' => $first }, #
5511 foreach my $field ( 'last', 'company' ) {
5513 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
5518 #eliminate duplicates
5520 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5530 Accepts the following options: I<email>, the email address to search for. The
5531 email address will be searched for as an email invoice destination and as an
5534 #Any additional options are treated as an additional qualifier on the search
5535 #(i.e. I<agentnum>).
5537 Returns a (possibly empty) array of FS::cust_main objects (but usually just
5547 my $email = delete $options{'email'};
5549 #we're only being used by RT at the moment... no agent virtualization yet
5550 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5554 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
5556 my ( $user, $domain ) = ( $1, $2 );
5558 warn "$me smart_search: searching for $user in domain $domain"
5564 'table' => 'cust_main_invoice',
5565 'hashref' => { 'dest' => $email },
5572 map $_->cust_svc->cust_pkg,
5574 'table' => 'svc_acct',
5575 'hashref' => { 'username' => $user, },
5577 'AND ( SELECT domain FROM svc_domain
5578 WHERE svc_acct.domsvc = svc_domain.svcnum
5579 ) = '. dbh->quote($domain),
5585 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5587 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
5594 =item check_and_rebuild_fuzzyfiles
5598 use vars qw(@fuzzyfields);
5599 @fuzzyfields = ( 'last', 'first', 'company' );
5601 sub check_and_rebuild_fuzzyfiles {
5602 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5603 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
5606 =item rebuild_fuzzyfiles
5610 sub rebuild_fuzzyfiles {
5612 use Fcntl qw(:flock);
5614 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5615 mkdir $dir, 0700 unless -d $dir;
5617 foreach my $fuzzy ( @fuzzyfields ) {
5619 open(LOCK,">>$dir/cust_main.$fuzzy")
5620 or die "can't open $dir/cust_main.$fuzzy: $!";
5622 or die "can't lock $dir/cust_main.$fuzzy: $!";
5624 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
5625 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
5627 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
5628 my $sth = dbh->prepare("SELECT $field FROM cust_main".
5629 " WHERE $field != '' AND $field IS NOT NULL");
5630 $sth->execute or die $sth->errstr;
5632 while ( my $row = $sth->fetchrow_arrayref ) {
5633 print CACHE $row->[0]. "\n";
5638 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
5640 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
5651 my( $self, $field ) = @_;
5652 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5653 open(CACHE,"<$dir/cust_main.$field")
5654 or die "can't open $dir/cust_main.$field: $!";
5655 my @array = map { chomp; $_; } <CACHE>;
5660 =item append_fuzzyfiles LASTNAME COMPANY
5664 sub append_fuzzyfiles {
5665 #my( $first, $last, $company ) = @_;
5667 &check_and_rebuild_fuzzyfiles;
5669 use Fcntl qw(:flock);
5671 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5673 foreach my $field (qw( first last company )) {
5678 open(CACHE,">>$dir/cust_main.$field")
5679 or die "can't open $dir/cust_main.$field: $!";
5680 flock(CACHE,LOCK_EX)
5681 or die "can't lock $dir/cust_main.$field: $!";
5683 print CACHE "$value\n";
5685 flock(CACHE,LOCK_UN)
5686 or die "can't unlock $dir/cust_main.$field: $!";
5701 #warn join('-',keys %$param);
5702 my $fh = $param->{filehandle};
5703 my $agentnum = $param->{agentnum};
5705 my $refnum = $param->{refnum};
5706 my $pkgpart = $param->{pkgpart};
5708 #my @fields = @{$param->{fields}};
5709 my $format = $param->{'format'};
5712 if ( $format eq 'simple' ) {
5713 @fields = qw( cust_pkg.setup dayphone first last
5714 address1 address2 city state zip comments );
5716 } elsif ( $format eq 'extended' ) {
5717 @fields = qw( agent_custid refnum
5718 last first address1 address2 city state zip country
5720 ship_last ship_first ship_address1 ship_address2
5721 ship_city ship_state ship_zip ship_country
5722 payinfo paycvv paydate
5725 svc_acct.username svc_acct._password
5728 } elsif ( $format eq 'extended-plus_company' ) {
5729 @fields = qw( agent_custid refnum
5730 last first company address1 address2 city state zip country
5732 ship_last ship_first ship_company ship_address1 ship_address2
5733 ship_city ship_state ship_zip ship_country
5734 payinfo paycvv paydate
5737 svc_acct.username svc_acct._password
5741 die "unknown format $format";
5744 eval "use Text::CSV_XS;";
5747 my $csv = new Text::CSV_XS;
5754 local $SIG{HUP} = 'IGNORE';
5755 local $SIG{INT} = 'IGNORE';
5756 local $SIG{QUIT} = 'IGNORE';
5757 local $SIG{TERM} = 'IGNORE';
5758 local $SIG{TSTP} = 'IGNORE';
5759 local $SIG{PIPE} = 'IGNORE';
5761 my $oldAutoCommit = $FS::UID::AutoCommit;
5762 local $FS::UID::AutoCommit = 0;
5765 #while ( $columns = $csv->getline($fh) ) {
5767 while ( defined($line=<$fh>) ) {
5769 $csv->parse($line) or do {
5770 $dbh->rollback if $oldAutoCommit;
5771 return "can't parse: ". $csv->error_input();
5774 my @columns = $csv->fields();
5775 #warn join('-',@columns);
5778 agentnum => $agentnum,
5780 country => $conf->config('countrydefault') || 'US',
5781 payby => $payby, #default
5782 paydate => '12/2037', #default
5784 my $billtime = time;
5785 my %cust_pkg = ( pkgpart => $pkgpart );
5787 foreach my $field ( @fields ) {
5789 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
5791 #$cust_pkg{$1} = str2time( shift @$columns );
5792 if ( $1 eq 'pkgpart' ) {
5793 $cust_pkg{$1} = shift @columns;
5794 } elsif ( $1 eq 'setup' ) {
5795 $billtime = str2time(shift @columns);
5797 $cust_pkg{$1} = str2time( shift @columns );
5800 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
5802 $svc_acct{$1} = shift @columns;
5806 #refnum interception
5807 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
5809 my $referral = $columns[0];
5810 my %hash = ( 'referral' => $referral,
5811 'agentnum' => $agentnum,
5815 my $part_referral = qsearchs('part_referral', \%hash )
5816 || new FS::part_referral \%hash;
5818 unless ( $part_referral->refnum ) {
5819 my $error = $part_referral->insert;
5821 $dbh->rollback if $oldAutoCommit;
5822 return "can't auto-insert advertising source: $referral: $error";
5826 $columns[0] = $part_referral->refnum;
5829 #$cust_main{$field} = shift @$columns;
5830 $cust_main{$field} = shift @columns;
5834 $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
5836 my $invoicing_list = $cust_main{'invoicing_list'}
5837 ? [ delete $cust_main{'invoicing_list'} ]
5840 my $cust_main = new FS::cust_main ( \%cust_main );
5843 tie my %hash, 'Tie::RefHash'; #this part is important
5845 if ( $cust_pkg{'pkgpart'} ) {
5846 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
5849 if ( $svc_acct{'username'} ) {
5850 my $part_pkg = $cust_pkg->part_pkg;
5851 unless ( $part_pkg ) {
5852 $dbh->rollback if $oldAutoCommit;
5853 return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
5855 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
5856 push @svc_acct, new FS::svc_acct ( \%svc_acct )
5859 $hash{$cust_pkg} = \@svc_acct;
5862 my $error = $cust_main->insert( \%hash, $invoicing_list );
5865 $dbh->rollback if $oldAutoCommit;
5866 return "can't insert customer for $line: $error";
5869 if ( $format eq 'simple' ) {
5871 #false laziness w/bill.cgi
5872 $error = $cust_main->bill( 'time' => $billtime );
5874 $dbh->rollback if $oldAutoCommit;
5875 return "can't bill customer for $line: $error";
5878 $error = $cust_main->apply_payments_and_credits;
5880 $dbh->rollback if $oldAutoCommit;
5881 return "can't bill customer for $line: $error";
5884 $error = $cust_main->collect();
5886 $dbh->rollback if $oldAutoCommit;
5887 return "can't collect customer for $line: $error";
5895 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5897 return "Empty file!" unless $imported;
5909 #warn join('-',keys %$param);
5910 my $fh = $param->{filehandle};
5911 my @fields = @{$param->{fields}};
5913 eval "use Text::CSV_XS;";
5916 my $csv = new Text::CSV_XS;
5923 local $SIG{HUP} = 'IGNORE';
5924 local $SIG{INT} = 'IGNORE';
5925 local $SIG{QUIT} = 'IGNORE';
5926 local $SIG{TERM} = 'IGNORE';
5927 local $SIG{TSTP} = 'IGNORE';
5928 local $SIG{PIPE} = 'IGNORE';
5930 my $oldAutoCommit = $FS::UID::AutoCommit;
5931 local $FS::UID::AutoCommit = 0;
5934 #while ( $columns = $csv->getline($fh) ) {
5936 while ( defined($line=<$fh>) ) {
5938 $csv->parse($line) or do {
5939 $dbh->rollback if $oldAutoCommit;
5940 return "can't parse: ". $csv->error_input();
5943 my @columns = $csv->fields();
5944 #warn join('-',@columns);
5947 foreach my $field ( @fields ) {
5948 $row{$field} = shift @columns;
5951 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
5952 unless ( $cust_main ) {
5953 $dbh->rollback if $oldAutoCommit;
5954 return "unknown custnum $row{'custnum'}";
5957 if ( $row{'amount'} > 0 ) {
5958 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
5960 $dbh->rollback if $oldAutoCommit;
5964 } elsif ( $row{'amount'} < 0 ) {
5965 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
5968 $dbh->rollback if $oldAutoCommit;
5978 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5980 return "Empty file!" unless $imported;
5986 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5988 Sends a templated email notification to the customer (see L<Text::Template>).
5990 OPTIONS is a hash and may include
5992 I<from> - the email sender (default is invoice_from)
5994 I<to> - comma-separated scalar or arrayref of recipients
5995 (default is invoicing_list)
5997 I<subject> - The subject line of the sent email notification
5998 (default is "Notice from company_name")
6000 I<extra_fields> - a hashref of name/value pairs which will be substituted
6003 The following variables are vavailable in the template.
6005 I<$first> - the customer first name
6006 I<$last> - the customer last name
6007 I<$company> - the customer company
6008 I<$payby> - a description of the method of payment for the customer
6009 # would be nice to use FS::payby::shortname
6010 I<$payinfo> - the account information used to collect for this customer
6011 I<$expdate> - the expiration of the customer payment in seconds from epoch
6016 my ($customer, $template, %options) = @_;
6018 return unless $conf->exists($template);
6020 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
6021 $from = $options{from} if exists($options{from});
6023 my $to = join(',', $customer->invoicing_list_emailonly);
6024 $to = $options{to} if exists($options{to});
6026 my $subject = "Notice from " . $conf->config('company_name')
6027 if $conf->exists('company_name');
6028 $subject = $options{subject} if exists($options{subject});
6030 my $notify_template = new Text::Template (TYPE => 'ARRAY',
6031 SOURCE => [ map "$_\n",
6032 $conf->config($template)]
6034 or die "can't create new Text::Template object: Text::Template::ERROR";
6035 $notify_template->compile()
6036 or die "can't compile template: Text::Template::ERROR";
6038 $FS::notify_template::_template::company_name = $conf->config('company_name');
6039 $FS::notify_template::_template::company_address =
6040 join("\n", $conf->config('company_address') ). "\n";
6042 my $paydate = $customer->paydate || '2037-12-31';
6043 $FS::notify_template::_template::first = $customer->first;
6044 $FS::notify_template::_template::last = $customer->last;
6045 $FS::notify_template::_template::company = $customer->company;
6046 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
6047 my $payby = $customer->payby;
6048 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6049 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6051 #credit cards expire at the end of the month/year of their exp date
6052 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6053 $FS::notify_template::_template::payby = 'credit card';
6054 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6055 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6057 }elsif ($payby eq 'COMP') {
6058 $FS::notify_template::_template::payby = 'complimentary account';
6060 $FS::notify_template::_template::payby = 'current method';
6062 $FS::notify_template::_template::expdate = $expire_time;
6064 for (keys %{$options{extra_fields}}){
6066 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
6069 send_email(from => $from,
6071 subject => $subject,
6072 body => $notify_template->fill_in( PACKAGE =>
6073 'FS::notify_template::_template' ),
6078 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6080 Generates a templated notification to the customer (see L<Text::Template>).
6082 OPTIONS is a hash and may include
6084 I<extra_fields> - a hashref of name/value pairs which will be substituted
6085 into the template. These values may override values mentioned below
6086 and those from the customer record.
6088 The following variables are available in the template instead of or in addition
6089 to the fields of the customer record.
6091 I<$payby> - a description of the method of payment for the customer
6092 # would be nice to use FS::payby::shortname
6093 I<$payinfo> - the masked account information used to collect for this customer
6094 I<$expdate> - the expiration of the customer payment method in seconds from epoch
6095 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
6099 sub generate_letter {
6100 my ($self, $template, %options) = @_;
6102 return unless $conf->exists($template);
6104 my $letter_template = new Text::Template
6106 SOURCE => [ map "$_\n", $conf->config($template)],
6107 DELIMITERS => [ '[@--', '--@]' ],
6109 or die "can't create new Text::Template object: Text::Template::ERROR";
6111 $letter_template->compile()
6112 or die "can't compile template: Text::Template::ERROR";
6114 my %letter_data = map { $_ => $self->$_ } $self->fields;
6115 $letter_data{payinfo} = $self->mask_payinfo;
6117 #my $paydate = $self->paydate || '2037-12-31';
6118 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
6120 my $payby = $self->payby;
6121 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6122 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6124 #credit cards expire at the end of the month/year of their exp date
6125 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6126 $letter_data{payby} = 'credit card';
6127 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6128 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6130 }elsif ($payby eq 'COMP') {
6131 $letter_data{payby} = 'complimentary account';
6133 $letter_data{payby} = 'current method';
6135 $letter_data{expdate} = $expire_time;
6137 for (keys %{$options{extra_fields}}){
6138 $letter_data{$_} = $options{extra_fields}->{$_};
6141 unless(exists($letter_data{returnaddress})){
6142 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
6143 $self->agent_template)
6145 if ( length($retadd) ) {
6146 $letter_data{returnaddress} = $retadd;
6147 } elsif ( grep /\S/, $conf->config('company_address') ) {
6148 $letter_data{returnaddress} =
6149 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
6150 $conf->config('company_address')
6153 $letter_data{returnaddress} = '~';
6157 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
6159 $letter_data{company_name} = $conf->config('company_name');
6161 my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
6162 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
6166 ) or die "can't open temp file: $!\n";
6168 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
6170 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
6174 =item print_ps TEMPLATE
6176 Returns an postscript letter filled in from TEMPLATE, as a scalar.
6182 my $file = $self->generate_letter(@_);
6183 FS::Misc::generate_ps($file);
6186 =item print TEMPLATE
6188 Prints the filled in template.
6190 TEMPLATE is the name of a L<Text::Template> to fill in and print.
6194 sub queueable_print {
6197 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
6198 or die "invalid customer number: " . $opt{custvnum};
6200 my $error = $self->print( $opt{template} );
6201 die $error if $error;
6205 my ($self, $template) = (shift, shift);
6206 do_print [ $self->print_ps($template) ];
6209 sub agent_template {
6211 $self->_agent_plandata('agent_templatename');
6214 sub agent_invoice_from {
6216 $self->_agent_plandata('agent_invoice_from');
6219 sub _agent_plandata {
6220 my( $self, $option ) = @_;
6222 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
6223 #agent-specific Conf
6225 use FS::part_event::Condition;
6227 my $agentnum = $self->agentnum;
6230 if ( driver_name =~ /^Pg/i ) {
6232 } elsif ( driver_name =~ /^mysql/i ) {
6235 die "don't know how to use regular expressions in ". driver_name. " databases";
6238 my $part_event_option =
6240 'select' => 'part_event_option.*',
6241 'table' => 'part_event_option',
6243 LEFT JOIN part_event USING ( eventpart )
6244 LEFT JOIN part_event_option AS peo_agentnum
6245 ON ( part_event.eventpart = peo_agentnum.eventpart
6246 AND peo_agentnum.optionname = 'agentnum'
6247 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
6249 LEFT JOIN part_event_option AS peo_cust_bill_age
6250 ON ( part_event.eventpart = peo_cust_bill_age.eventpart
6251 AND peo_cust_bill_age.optionname = 'cust_bill_age'
6254 #'hashref' => { 'optionname' => $option },
6255 #'hashref' => { 'part_event_option.optionname' => $option },
6257 " WHERE part_event_option.optionname = ". dbh->quote($option).
6258 " AND action = 'cust_bill_send_agent' ".
6259 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
6260 " AND peo_agentnum.optionname = 'agentnum' ".
6261 " AND agentnum IS NULL OR agentnum = $agentnum ".
6263 CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
6265 ELSE ". FS::part_event::Condition->age2seconds_sql('peo_cust_bill_age.optionvalue').
6267 , part_event.weight".
6271 unless ( $part_event_option ) {
6272 return $self->agent->invoice_template || ''
6273 if $option eq 'agent_templatename';
6277 $part_event_option->optionvalue;
6282 ## actual sub, not a method, designed to be called from the queue.
6283 ## sets up the customer, and calls the bill_and_collect
6284 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
6285 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
6286 $cust_main->bill_and_collect(
6297 The delete method should possibly take an FS::cust_main object reference
6298 instead of a scalar customer number.
6300 Bill and collect options should probably be passed as references instead of a
6303 There should probably be a configuration file with a list of allowed credit
6306 No multiple currency support (probably a larger project than just this module).
6308 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
6310 Birthdates rely on negative epoch values.
6312 The payby for card/check batches is broken. With mixed batching, bad
6315 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
6319 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
6320 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
6321 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.