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 #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1954 foreach my $cust_pkg (
1955 grep { $_->expire && $_->expire <= $^T } $self->ncancelled_pkgs
1957 my $error = $cust_pkg->cancel;
1958 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
1959 " for custnum ". $self->custnum. ": $error"
1967 #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1968 foreach my $cust_pkg (
1969 grep { ( $_->part_pkg->is_prepaid && $_->bill && $_->bill < $^T
1970 || $_->adjourn && $_->adjourn <= $^T
1974 $self->ncancelled_pkgs
1976 my $error = $cust_pkg->suspend;
1977 warn "Error suspending package ". $cust_pkg->pkgnum.
1978 " for custnum ". $self->custnum. ": $error"
1986 my $error = $self->bill( %options );
1987 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
1989 $self->apply_payments_and_credits;
1991 $error = $self->collect( %options );
1992 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
1998 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
1999 conjunction with the collect method by calling B<bill_and_collect>.
2001 If there is an error, returns the error, otherwise returns false.
2003 Options are passed as name-value pairs. Currently available options are:
2009 If set true, re-charges setup fees.
2013 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:
2017 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2021 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2023 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2027 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.
2034 my( $self, %options ) = @_;
2035 return '' if $self->payby eq 'COMP';
2036 warn "$me bill customer ". $self->custnum. "\n"
2039 my $time = $options{'time'} || time;
2044 local $SIG{HUP} = 'IGNORE';
2045 local $SIG{INT} = 'IGNORE';
2046 local $SIG{QUIT} = 'IGNORE';
2047 local $SIG{TERM} = 'IGNORE';
2048 local $SIG{TSTP} = 'IGNORE';
2049 local $SIG{PIPE} = 'IGNORE';
2051 my $oldAutoCommit = $FS::UID::AutoCommit;
2052 local $FS::UID::AutoCommit = 0;
2055 $self->select_for_update; #mutex
2057 #create a new invoice
2058 #(we'll remove it later if it doesn't actually need to be generated [contains
2059 # no line items] and we're inside a transaciton so nothing else will see it)
2060 my $cust_bill = new FS::cust_bill ( {
2061 'custnum' => $self->custnum,
2062 '_date' => ( $options{'invoice_time'} || $time ),
2063 #'charged' => $charged,
2066 $error = $cust_bill->insert;
2068 $dbh->rollback if $oldAutoCommit;
2069 return "can't create invoice for customer #". $self->custnum. ": $error";
2071 my $invnum = $cust_bill->invnum;
2074 # find the packages which are due for billing, find out how much they are
2075 # & generate invoice database.
2078 my( $total_setup, $total_recur ) = ( 0, 0 );
2081 my @precommit_hooks = ();
2083 foreach my $cust_pkg (
2084 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
2087 #NO!! next if $cust_pkg->cancel;
2088 next if $cust_pkg->getfield('cancel');
2090 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2092 #? to avoid use of uninitialized value errors... ?
2093 $cust_pkg->setfield('bill', '')
2094 unless defined($cust_pkg->bill);
2096 my $part_pkg = $cust_pkg->part_pkg;
2098 my %hash = $cust_pkg->hash;
2099 my $old_cust_pkg = new FS::cust_pkg \%hash;
2108 if ( ! $cust_pkg->setup &&
2110 ( $conf->exists('disable_setup_suspended_pkgs') &&
2111 ! $cust_pkg->getfield('susp')
2112 ) || ! $conf->exists('disable_setup_suspended_pkgs')
2114 || $options{'resetup'}
2117 warn " bill setup\n" if $DEBUG > 1;
2119 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2121 $dbh->rollback if $oldAutoCommit;
2122 return "$@ running calc_setup for $cust_pkg\n";
2125 $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
2129 # bill recurring fee
2134 if ( $part_pkg->getfield('freq') ne '0' &&
2135 ! $cust_pkg->getfield('susp') &&
2136 ( $cust_pkg->getfield('bill') || 0 ) <= $time
2139 # XXX should this be a package event? probably. events are called
2140 # at collection time at the moment, though...
2141 if ( $part_pkg->can('reset_usage') ) {
2142 warn " resetting usage counters" if $DEBUG > 1;
2143 $part_pkg->reset_usage($cust_pkg);
2146 warn " bill recur\n" if $DEBUG > 1;
2148 # XXX shared with $recur_prog
2149 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2151 #over two params! lets at least switch to a hashref for the rest...
2152 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
2154 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2156 $dbh->rollback if $oldAutoCommit;
2157 return "$@ running calc_recur for $cust_pkg\n";
2160 #change this bit to use Date::Manip? CAREFUL with timezones (see
2161 # mailing list archive)
2162 my ($sec,$min,$hour,$mday,$mon,$year) =
2163 (localtime($sdate) )[0,1,2,3,4,5];
2165 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2166 # only for figuring next bill date, nothing else, so, reset $sdate again
2168 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2169 $cust_pkg->last_bill($sdate);
2171 if ( $part_pkg->freq =~ /^\d+$/ ) {
2172 $mon += $part_pkg->freq;
2173 until ( $mon < 12 ) { $mon -= 12; $year++; }
2174 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2176 $mday += $weeks * 7;
2177 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2180 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2184 $dbh->rollback if $oldAutoCommit;
2185 return "unparsable frequency: ". $part_pkg->freq;
2187 $cust_pkg->setfield('bill',
2188 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2191 warn "\$setup is undefined" unless defined($setup);
2192 warn "\$recur is undefined" unless defined($recur);
2193 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2196 # If $cust_pkg has been modified, update it and create cust_bill_pkg records
2199 if ( $cust_pkg->modified ) { # hmmm.. and if the options are modified?
2201 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2204 $error=$cust_pkg->replace($old_cust_pkg,
2205 options => { $cust_pkg->options },
2207 if ( $error ) { #just in case
2208 $dbh->rollback if $oldAutoCommit;
2209 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2212 $setup = sprintf( "%.2f", $setup );
2213 $recur = sprintf( "%.2f", $recur );
2214 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2215 $dbh->rollback if $oldAutoCommit;
2216 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2218 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2219 $dbh->rollback if $oldAutoCommit;
2220 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2223 if ( $setup != 0 || $recur != 0 ) {
2225 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2227 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2228 'invnum' => $invnum,
2229 'pkgnum' => $cust_pkg->pkgnum,
2233 'edate' => $cust_pkg->bill,
2234 'details' => \@details,
2236 $error = $cust_bill_pkg->insert;
2238 $dbh->rollback if $oldAutoCommit;
2239 return "can't create invoice line item for invoice #$invnum: $error";
2241 $total_setup += $setup;
2242 $total_recur += $recur;
2248 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2251 my @taxoverrides = $part_pkg->part_pkg_taxoverride;
2254 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2258 if ( $conf->exists('enable_taxproducts')
2259 && (scalar(@taxoverrides) || $part_pkg->taxproductnum )
2263 my @taxclassnums = ();
2264 my $geocode = $self->geocode('cch');
2266 if ( scalar( @taxoverrides ) ) {
2267 @taxclassnums = map { $_->taxclassnum } @taxoverrides;
2268 }elsif ( $part_pkg->taxproductnum ) {
2269 @taxclassnums = map { $_->taxclassnum }
2270 $part_pkg->part_pkg_taxrate('cch', $geocode);
2275 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
2277 @taxes = qsearch({ 'table' => 'tax_rate',
2278 'hashref' => { 'geocode' => $geocode, },
2279 'extra_sql' => $extra_sql,
2281 if scalar(@taxclassnums);
2286 my %taxhash = map { $_ => $self->get("$prefix$_") }
2287 qw( state county country );
2289 $taxhash{'taxclass'} = $part_pkg->taxclass;
2291 @taxes = qsearch( 'cust_main_county', \%taxhash );
2294 $taxhash{'taxclass'} = '';
2295 @taxes = qsearch( 'cust_main_county', \%taxhash );
2298 #one more try at a whole-country tax rate
2300 $taxhash{$_} = '' foreach qw( state county );
2301 @taxes = qsearch( 'cust_main_county', \%taxhash );
2304 } #if $conf->exists('enable_taxproducts')
2306 # maybe eliminate this entirely, along with all the 0% records
2308 $dbh->rollback if $oldAutoCommit;
2310 if ( $conf->exists('enable_taxproducts') ) {
2312 "fatal: can't find tax rate for zip/taxproduct/pkgpart ".
2313 join('/', ( map $self->get("$prefix$_"),
2316 $part_pkg->taxproduct_description,
2317 $part_pkg->pkgpart ). "\n";
2320 "fatal: can't find tax rate for state/county/country/taxclass ".
2321 join('/', ( map $self->get("$prefix$_"),
2322 qw(state county country)
2324 $part_pkg->taxclass ). "\n";
2329 foreach my $tax ( @taxes ) {
2330 my $taxname = ref( $tax ). ' '. $tax->taxnum;
2331 if ( exists( $taxlisthash{ $taxname } ) ) {
2332 push @{ $taxlisthash{ $taxname } }, $cust_bill_pkg;
2334 $taxlisthash{ $taxname } = [ $tax, $cust_bill_pkg ];
2339 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2341 } #if $setup != 0 || $recur != 0
2343 } #if $cust_pkg->modified
2345 } #foreach my $cust_pkg
2347 unless ( $cust_bill->cust_bill_pkg ) {
2348 $cust_bill->delete; #don't create an invoice w/o line items
2350 # XXX this seems to be broken
2351 #( DBD::Pg::st execute failed: ERROR: syntax error at or near "hcb" )
2352 # # get rid of our fake history too, waste of unecessary space
2353 # my $h_cleanup_query = q{
2354 # DELETE FROM h_cust_bill hcb
2355 # WHERE hcb.invnum = ?
2356 # AND NOT EXISTS ( SELECT 1 FROM cust_bill cb where cb.invnum = hcb.invnum )
2358 # my $h_sth = $dbh->prepare($h_cleanup_query);
2359 # $h_sth->execute($invnum);
2361 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2365 my $charged = sprintf( "%.2f", $total_setup + $total_recur );
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 $charged = sprintf( "%.2f", $charged+$tax );
2383 my $cust_bill_pkg = new FS::cust_bill_pkg ({
2384 'invnum' => $invnum,
2390 'itemdesc' => $taxname,
2392 $error = $cust_bill_pkg->insert;
2394 $dbh->rollback if $oldAutoCommit;
2395 return "can't create invoice line item for invoice #$invnum: $error";
2397 $total_setup += $tax;
2401 $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2402 $error = $cust_bill->replace;
2404 $dbh->rollback if $oldAutoCommit;
2405 return "can't update charged for invoice #$invnum: $error";
2408 foreach my $hook ( @precommit_hooks ) {
2410 &{$hook}; #($self) ?
2413 $dbh->rollback if $oldAutoCommit;
2414 return "$@ running precommit hook $hook\n";
2418 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2422 =item collect OPTIONS
2424 (Attempt to) collect money for this customer's outstanding invoices (see
2425 L<FS::cust_bill>). Usually used after the bill method.
2427 Actions are now triggered by billing events; see L<FS::part_event> and the
2428 billing events web interface. Old-style invoice events (see
2429 L<FS::part_bill_event>) have been deprecated.
2431 If there is an error, returns the error, otherwise returns false.
2433 Options are passed as name-value pairs.
2435 Currently available options are:
2441 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.
2445 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2449 set true to surpress email card/ACH decline notices.
2453 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2457 allows for one time override of normal customer billing method
2461 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)
2469 my( $self, %options ) = @_;
2470 my $invoice_time = $options{'invoice_time'} || time;
2473 local $SIG{HUP} = 'IGNORE';
2474 local $SIG{INT} = 'IGNORE';
2475 local $SIG{QUIT} = 'IGNORE';
2476 local $SIG{TERM} = 'IGNORE';
2477 local $SIG{TSTP} = 'IGNORE';
2478 local $SIG{PIPE} = 'IGNORE';
2480 my $oldAutoCommit = $FS::UID::AutoCommit;
2481 local $FS::UID::AutoCommit = 0;
2484 $self->select_for_update; #mutex
2487 my $balance = $self->balance;
2488 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2491 if ( exists($options{'retry_card'}) ) {
2492 carp 'retry_card option passed to collect is deprecated; use retry';
2493 $options{'retry'} ||= $options{'retry_card'};
2495 if ( exists($options{'retry'}) && $options{'retry'} ) {
2496 my $error = $self->retry_realtime;
2498 $dbh->rollback if $oldAutoCommit;
2503 # false laziness w/pay_batch::import_results
2505 my $due_cust_event = $self->due_cust_event(
2506 'debug' => ( $options{'debug'} || 0 ),
2507 'time' => $invoice_time,
2508 'check_freq' => $options{'check_freq'},
2510 unless( ref($due_cust_event) ) {
2511 $dbh->rollback if $oldAutoCommit;
2512 return $due_cust_event;
2515 foreach my $cust_event ( @$due_cust_event ) {
2519 #re-eval event conditions (a previous event could have changed things)
2520 unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
2521 #don't leave stray "new/locked" records around
2522 my $error = $cust_event->delete;
2524 #gah, even with transactions
2525 $dbh->commit if $oldAutoCommit; #well.
2532 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2533 warn " running cust_event ". $cust_event->eventnum. "\n"
2537 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2538 if ( my $error = $cust_event->do_event() ) {
2539 #XXX wtf is this? figure out a proper dealio with return value
2541 # gah, even with transactions.
2542 $dbh->commit if $oldAutoCommit; #well.
2549 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2554 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2556 Inserts database records for and returns an ordered listref of new events due
2557 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2558 events are due, an empty listref is returned. If there is an error, returns a
2559 scalar error message.
2561 To actually run the events, call each event's test_condition method, and if
2562 still true, call the event's do_event method.
2564 Options are passed as a hashref or as a list of name-value pairs. Available
2571 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.
2575 "Current time" for the events.
2579 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)
2583 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2587 Explicitly pass the objects to be tested (typically used with eventtable).
2593 sub due_cust_event {
2595 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2598 #my $DEBUG = $opt{'debug'}
2599 local($DEBUG) = $opt{'debug'}
2600 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2602 warn "$me due_cust_event called with options ".
2603 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2606 $opt{'time'} ||= time;
2608 local $SIG{HUP} = 'IGNORE';
2609 local $SIG{INT} = 'IGNORE';
2610 local $SIG{QUIT} = 'IGNORE';
2611 local $SIG{TERM} = 'IGNORE';
2612 local $SIG{TSTP} = 'IGNORE';
2613 local $SIG{PIPE} = 'IGNORE';
2615 my $oldAutoCommit = $FS::UID::AutoCommit;
2616 local $FS::UID::AutoCommit = 0;
2619 $self->select_for_update; #mutex
2622 # 1: find possible events (initial search)
2625 my @cust_event = ();
2627 my @eventtable = $opt{'eventtable'}
2628 ? ( $opt{'eventtable'} )
2629 : FS::part_event->eventtables_runorder;
2631 foreach my $eventtable ( @eventtable ) {
2634 if ( $opt{'objects'} ) {
2636 @objects = @{ $opt{'objects'} };
2640 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2641 @objects = ( $eventtable eq 'cust_main' )
2643 : ( $self->$eventtable() );
2647 my @e_cust_event = ();
2649 my $cross = "CROSS JOIN $eventtable";
2650 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2651 unless $eventtable eq 'cust_main';
2653 foreach my $object ( @objects ) {
2655 #this first search uses the condition_sql magic for optimization.
2656 #the more possible events we can eliminate in this step the better
2658 my $cross_where = '';
2659 my $pkey = $object->primary_key;
2660 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2662 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2664 FS::part_event_condition->where_conditions_sql( $eventtable,
2665 'time'=>$opt{'time'}
2667 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2669 $extra_sql = "AND $extra_sql" if $extra_sql;
2671 #here is the agent virtualization
2672 $extra_sql .= " AND ( part_event.agentnum IS NULL
2673 OR part_event.agentnum = ". $self->agentnum. ' )';
2675 $extra_sql .= " $order";
2677 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2678 if $opt{'debug'} > 2;
2679 my @part_event = qsearch( {
2680 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2681 'select' => 'part_event.*',
2682 'table' => 'part_event',
2683 'addl_from' => "$cross $join",
2684 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2685 'eventtable' => $eventtable,
2688 'extra_sql' => "AND $cross_where $extra_sql",
2692 my $pkey = $object->primary_key;
2693 warn " ". scalar(@part_event).
2694 " possible events found for $eventtable ". $object->$pkey(). "\n";
2697 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2701 warn " ". scalar(@e_cust_event).
2702 " subtotal possible cust events found for $eventtable\n"
2705 push @cust_event, @e_cust_event;
2709 warn " ". scalar(@cust_event).
2710 " total possible cust events found in initial search\n"
2714 # 2: test conditions
2719 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
2720 'stats_hashref' => \%unsat ),
2723 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2726 warn " invalid conditions not eliminated with condition_sql:\n".
2727 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2734 foreach my $cust_event ( @cust_event ) {
2736 my $error = $cust_event->insert();
2738 $dbh->rollback if $oldAutoCommit;
2744 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2750 warn " returning events: ". Dumper(@cust_event). "\n"
2757 =item retry_realtime
2759 Schedules realtime / batch credit card / electronic check / LEC billing
2760 events for for retry. Useful if card information has changed or manual
2761 retry is desired. The 'collect' method must be called to actually retry
2764 Implementation details: For either this customer, or for each of this
2765 customer's open invoices, changes the status of the first "done" (with
2766 statustext error) realtime processing event to "failed".
2770 sub retry_realtime {
2773 local $SIG{HUP} = 'IGNORE';
2774 local $SIG{INT} = 'IGNORE';
2775 local $SIG{QUIT} = 'IGNORE';
2776 local $SIG{TERM} = 'IGNORE';
2777 local $SIG{TSTP} = 'IGNORE';
2778 local $SIG{PIPE} = 'IGNORE';
2780 my $oldAutoCommit = $FS::UID::AutoCommit;
2781 local $FS::UID::AutoCommit = 0;
2784 #a little false laziness w/due_cust_event (not too bad, really)
2786 my $join = FS::part_event_condition->join_conditions_sql;
2787 my $order = FS::part_event_condition->order_conditions_sql;
2790 . join ( ' OR ' , map {
2791 "( part_event.eventtable = " . dbh->quote($_)
2792 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
2793 } FS::part_event->eventtables)
2796 #here is the agent virtualization
2797 my $agent_virt = " ( part_event.agentnum IS NULL
2798 OR part_event.agentnum = ". $self->agentnum. ' )';
2800 #XXX this shouldn't be hardcoded, actions should declare it...
2801 my @realtime_events = qw(
2802 cust_bill_realtime_card
2803 cust_bill_realtime_check
2804 cust_bill_realtime_lec
2808 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
2813 my @cust_event = qsearchs({
2814 'table' => 'cust_event',
2815 'select' => 'cust_event.*',
2816 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
2817 'hashref' => { 'status' => 'done' },
2818 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
2819 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
2822 my %seen_invnum = ();
2823 foreach my $cust_event (@cust_event) {
2825 #max one for the customer, one for each open invoice
2826 my $cust_X = $cust_event->cust_X;
2827 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
2831 or $cust_event->part_event->eventtable eq 'cust_bill'
2834 my $error = $cust_event->retry;
2836 $dbh->rollback if $oldAutoCommit;
2837 return "error scheduling event for retry: $error";
2842 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2847 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2849 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2850 via a Business::OnlinePayment realtime gateway. See
2851 L<http://420.am/business-onlinepayment> for supported gateways.
2853 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2855 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
2857 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2858 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2859 if set, will override the value from the customer record.
2861 I<description> is a free-text field passed to the gateway. It defaults to
2862 "Internet services".
2864 If an I<invnum> is specified, this payment (if successful) is applied to the
2865 specified invoice. If you don't specify an I<invnum> you might want to
2866 call the B<apply_payments> method.
2868 I<quiet> can be set true to surpress email decline notices.
2870 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
2871 resulting paynum, if any.
2873 I<payunique> is a unique identifier for this payment.
2875 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2880 my( $self, $method, $amount, %options ) = @_;
2882 warn "$me realtime_bop: $method $amount\n";
2883 warn " $_ => $options{$_}\n" foreach keys %options;
2886 $options{'description'} ||= 'Internet services';
2888 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
2890 eval "use Business::OnlinePayment";
2893 my $payinfo = exists($options{'payinfo'})
2894 ? $options{'payinfo'}
2897 my %method2payby = (
2904 # check for banned credit card/ACH
2907 my $ban = qsearchs('banned_pay', {
2908 'payby' => $method2payby{$method},
2909 'payinfo' => md5_base64($payinfo),
2911 return "Banned credit card" if $ban;
2918 if ( $options{'invnum'} ) {
2919 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2920 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2922 map { $_->part_pkg->taxclass }
2924 map { $_->cust_pkg }
2925 $cust_bill->cust_bill_pkg;
2926 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2927 #different taxclasses
2928 $taxclass = $taxclasses[0];
2932 #look for an agent gateway override first
2934 if ( $method eq 'CC' ) {
2935 $cardtype = cardtype($payinfo);
2936 } elsif ( $method eq 'ECHECK' ) {
2939 $cardtype = $method;
2943 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2944 cardtype => $cardtype,
2945 taxclass => $taxclass, } )
2946 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2948 taxclass => $taxclass, } )
2949 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2950 cardtype => $cardtype,
2952 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2954 taxclass => '', } );
2956 my $payment_gateway = '';
2957 my( $processor, $login, $password, $action, @bop_options );
2958 if ( $override ) { #use a payment gateway override
2960 $payment_gateway = $override->payment_gateway;
2962 $processor = $payment_gateway->gateway_module;
2963 $login = $payment_gateway->gateway_username;
2964 $password = $payment_gateway->gateway_password;
2965 $action = $payment_gateway->gateway_action;
2966 @bop_options = $payment_gateway->options;
2968 } else { #use the standard settings from the config
2970 ( $processor, $login, $password, $action, @bop_options ) =
2971 $self->default_payment_gateway($method);
2979 my $address = exists($options{'address1'})
2980 ? $options{'address1'}
2982 my $address2 = exists($options{'address2'})
2983 ? $options{'address2'}
2985 $address .= ", ". $address2 if length($address2);
2987 my $o_payname = exists($options{'payname'})
2988 ? $options{'payname'}
2990 my($payname, $payfirst, $paylast);
2991 if ( $o_payname && $method ne 'ECHECK' ) {
2992 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2993 or return "Illegal payname $payname";
2994 ($payfirst, $paylast) = ($1, $2);
2996 $payfirst = $self->getfield('first');
2997 $paylast = $self->getfield('last');
2998 $payname = "$payfirst $paylast";
3001 my @invoicing_list = $self->invoicing_list_emailonly;
3002 if ( $conf->exists('emailinvoiceautoalways')
3003 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3004 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3005 push @invoicing_list, $self->all_emails;
3008 my $email = ($conf->exists('business-onlinepayment-email-override'))
3009 ? $conf->config('business-onlinepayment-email-override')
3010 : $invoicing_list[0];
3014 my $payip = exists($options{'payip'})
3017 $content{customer_ip} = $payip
3020 $content{invoice_number} = $options{'invnum'}
3021 if exists($options{'invnum'}) && length($options{'invnum'});
3023 $content{email_customer} =
3024 ( $conf->exists('business-onlinepayment-email_customer')
3025 || $conf->exists('business-onlinepayment-email-override') );
3028 if ( $method eq 'CC' ) {
3030 $content{card_number} = $payinfo;
3031 $paydate = exists($options{'paydate'})
3032 ? $options{'paydate'}
3034 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3035 $content{expiration} = "$2/$1";
3037 my $paycvv = exists($options{'paycvv'})
3038 ? $options{'paycvv'}
3040 $content{cvv2} = $paycvv
3043 my $paystart_month = exists($options{'paystart_month'})
3044 ? $options{'paystart_month'}
3045 : $self->paystart_month;
3047 my $paystart_year = exists($options{'paystart_year'})
3048 ? $options{'paystart_year'}
3049 : $self->paystart_year;
3051 $content{card_start} = "$paystart_month/$paystart_year"
3052 if $paystart_month && $paystart_year;
3054 my $payissue = exists($options{'payissue'})
3055 ? $options{'payissue'}
3057 $content{issue_number} = $payissue if $payissue;
3059 $content{recurring_billing} = 'YES'
3060 if qsearch('cust_pay', { 'custnum' => $self->custnum,
3062 'payinfo' => $payinfo,
3064 || qsearch('cust_pay', { 'custnum' => $self->custnum,
3066 'paymask' => $self->mask_payinfo('CARD', $payinfo),
3070 } elsif ( $method eq 'ECHECK' ) {
3071 ( $content{account_number}, $content{routing_code} ) =
3072 split('@', $payinfo);
3073 $content{bank_name} = $o_payname;
3074 $content{bank_state} = exists($options{'paystate'})
3075 ? $options{'paystate'}
3076 : $self->getfield('paystate');
3077 $content{account_type} = exists($options{'paytype'})
3078 ? uc($options{'paytype'}) || 'CHECKING'
3079 : uc($self->getfield('paytype')) || 'CHECKING';
3080 $content{account_name} = $payname;
3081 $content{customer_org} = $self->company ? 'B' : 'I';
3082 $content{state_id} = exists($options{'stateid'})
3083 ? $options{'stateid'}
3084 : $self->getfield('stateid');
3085 $content{state_id_state} = exists($options{'stateid_state'})
3086 ? $options{'stateid_state'}
3087 : $self->getfield('stateid_state');
3088 $content{customer_ssn} = exists($options{'ss'})
3091 } elsif ( $method eq 'LEC' ) {
3092 $content{phone} = $payinfo;
3096 # run transaction(s)
3099 my $balance = exists( $options{'balance'} )
3100 ? $options{'balance'}
3103 $self->select_for_update; #mutex ... just until we get our pending record in
3105 #the checks here are intended to catch concurrent payments
3106 #double-form-submission prevention is taken care of in cust_pay_pending::check
3109 return "The customer's balance has changed; $method transaction aborted."
3110 if $self->balance < $balance;
3111 #&& $self->balance < $amount; #might as well anyway?
3113 #also check and make sure there aren't *other* pending payments for this cust
3115 my @pending = qsearch('cust_pay_pending', {
3116 'custnum' => $self->custnum,
3117 'status' => { op=>'!=', value=>'done' }
3119 return "A payment is already being processed for this customer (".
3120 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
3121 "); $method transaction aborted."
3122 if scalar(@pending);
3124 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
3126 my $cust_pay_pending = new FS::cust_pay_pending {
3127 'custnum' => $self->custnum,
3128 #'invnum' => $options{'invnum'},
3131 'payby' => $method2payby{$method},
3132 'payinfo' => $payinfo,
3133 'paydate' => $paydate,
3135 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
3137 $cust_pay_pending->payunique( $options{payunique} )
3138 if defined($options{payunique}) && length($options{payunique});
3139 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
3140 return $cpp_new_err if $cpp_new_err;
3142 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3144 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3145 $transaction->content(
3148 'password' => $password,
3149 'action' => $action1,
3150 'description' => $options{'description'},
3151 'amount' => $amount,
3152 #'invoice_number' => $options{'invnum'},
3153 'customer_id' => $self->custnum,
3154 'last_name' => $paylast,
3155 'first_name' => $payfirst,
3157 'address' => $address,
3158 'city' => ( exists($options{'city'})
3161 'state' => ( exists($options{'state'})
3164 'zip' => ( exists($options{'zip'})
3167 'country' => ( exists($options{'country'})
3168 ? $options{'country'}
3170 'referer' => 'http://cleanwhisker.420.am/',
3172 'phone' => $self->daytime || $self->night,
3176 $cust_pay_pending->status('pending');
3177 my $cpp_pending_err = $cust_pay_pending->replace;
3178 return $cpp_pending_err if $cpp_pending_err;
3181 my $BOP_TESTING = 0;
3182 my $BOP_TESTING_SUCCESS = 1;
3184 unless ( $BOP_TESTING ) {
3185 $transaction->submit();
3187 if ( $BOP_TESTING_SUCCESS ) {
3188 $transaction->is_success(1);
3189 $transaction->authorization('fake auth');
3191 $transaction->is_success(0);
3192 $transaction->error_message('fake failure');
3196 if ( $transaction->is_success() && $action2 ) {
3198 $cust_pay_pending->status('authorized');
3199 my $cpp_authorized_err = $cust_pay_pending->replace;
3200 return $cpp_authorized_err if $cpp_authorized_err;
3202 my $auth = $transaction->authorization;
3203 my $ordernum = $transaction->can('order_number')
3204 ? $transaction->order_number
3208 new Business::OnlinePayment( $processor, @bop_options );
3215 password => $password,
3216 order_number => $ordernum,
3218 authorization => $auth,
3219 description => $options{'description'},
3222 foreach my $field (qw( authorization_source_code returned_ACI
3223 transaction_identifier validation_code
3224 transaction_sequence_num local_transaction_date
3225 local_transaction_time AVS_result_code )) {
3226 $capture{$field} = $transaction->$field() if $transaction->can($field);
3229 $capture->content( %capture );
3233 unless ( $capture->is_success ) {
3234 my $e = "Authorization successful but capture failed, custnum #".
3235 $self->custnum. ': '. $capture->result_code.
3236 ": ". $capture->error_message;
3243 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
3244 my $cpp_captured_err = $cust_pay_pending->replace;
3245 return $cpp_captured_err if $cpp_captured_err;
3248 # remove paycvv after initial transaction
3251 #false laziness w/misc/process/payment.cgi - check both to make sure working
3253 if ( defined $self->dbdef_table->column('paycvv')
3254 && length($self->paycvv)
3255 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3257 my $error = $self->remove_cvv;
3259 warn "WARNING: error removing cvv: $error\n";
3267 if ( $transaction->is_success() ) {
3270 if ( $payment_gateway ) { # agent override
3271 $paybatch = $payment_gateway->gatewaynum. '-';
3274 $paybatch .= "$processor:". $transaction->authorization;
3276 $paybatch .= ':'. $transaction->order_number
3277 if $transaction->can('order_number')
3278 && length($transaction->order_number);
3280 my $cust_pay = new FS::cust_pay ( {
3281 'custnum' => $self->custnum,
3282 'invnum' => $options{'invnum'},
3285 'payby' => $method2payby{$method},
3286 'payinfo' => $payinfo,
3287 'paybatch' => $paybatch,
3288 'paydate' => $paydate,
3290 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
3291 $cust_pay->payunique( $options{payunique} )
3292 if defined($options{payunique}) && length($options{payunique});
3294 my $oldAutoCommit = $FS::UID::AutoCommit;
3295 local $FS::UID::AutoCommit = 0;
3298 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
3300 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3303 $cust_pay->invnum(''); #try again with no specific invnum
3304 my $error2 = $cust_pay->insert( $options{'manual'} ?
3305 ( 'manual' => 1 ) : ()
3308 # gah. but at least we have a record of the state we had to abort in
3309 # from cust_pay_pending now.
3310 my $e = "WARNING: $method captured but payment not recorded - ".
3311 "error inserting payment ($processor): $error2".
3312 " (previously tried insert with invnum #$options{'invnum'}" .
3313 ": $error ) - pending payment saved as paypendingnum ".
3314 $cust_pay_pending->paypendingnum. "\n";
3320 if ( $options{'paynum_ref'} ) {
3321 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3324 $cust_pay_pending->status('done');
3325 $cust_pay_pending->statustext('captured');
3326 my $cpp_done_err = $cust_pay_pending->replace;
3328 if ( $cpp_done_err ) {
3330 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3331 my $e = "WARNING: $method captured but payment not recorded - ".
3332 "error updating status for paypendingnum ".
3333 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3339 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3340 return ''; #no error
3346 my $perror = "$processor error: ". $transaction->error_message;
3348 unless ( $transaction->error_message ) {
3351 if ( $transaction->can('response_page') ) {
3353 'page' => ( $transaction->can('response_page')
3354 ? $transaction->response_page
3357 'code' => ( $transaction->can('response_code')
3358 ? $transaction->response_code
3361 'headers' => ( $transaction->can('response_headers')
3362 ? $transaction->response_headers
3368 "No additional debugging information available for $processor";
3371 $perror .= "No error_message returned from $processor -- ".
3372 ( ref($t_response) ? Dumper($t_response) : $t_response );
3376 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3377 && $conf->exists('emaildecline')
3378 && grep { $_ ne 'POST' } $self->invoicing_list
3379 && ! grep { $transaction->error_message =~ /$_/ }
3380 $conf->config('emaildecline-exclude')
3382 my @templ = $conf->config('declinetemplate');
3383 my $template = new Text::Template (
3385 SOURCE => [ map "$_\n", @templ ],
3386 ) or return "($perror) can't create template: $Text::Template::ERROR";
3387 $template->compile()
3388 or return "($perror) can't compile template: $Text::Template::ERROR";
3390 my $templ_hash = { error => $transaction->error_message };
3392 my $error = send_email(
3393 'from' => $conf->config('invoice_from'),
3394 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3395 'subject' => 'Your payment could not be processed',
3396 'body' => [ $template->fill_in(HASH => $templ_hash) ],
3399 $perror .= " (also received error sending decline notification: $error)"
3404 $cust_pay_pending->status('done');
3405 $cust_pay_pending->statustext("declined: $perror");
3406 my $cpp_done_err = $cust_pay_pending->replace;
3407 if ( $cpp_done_err ) {
3408 my $e = "WARNING: $method declined but pending payment not resolved - ".
3409 "error updating status for paypendingnum ".
3410 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3412 $perror = "$e ($perror)";
3425 my( $self, $method, $amount, %options ) = @_;
3427 if ( $options{'fake_failure'} ) {
3428 return "Error: No error; test failure requested with fake_failure";
3431 my %method2payby = (
3438 #if ( $payment_gateway ) { # agent override
3439 # $paybatch = $payment_gateway->gatewaynum. '-';
3442 #$paybatch .= "$processor:". $transaction->authorization;
3444 #$paybatch .= ':'. $transaction->order_number
3445 # if $transaction->can('order_number')
3446 # && length($transaction->order_number);
3448 my $paybatch = 'FakeProcessor:54:32';
3450 my $cust_pay = new FS::cust_pay ( {
3451 'custnum' => $self->custnum,
3452 'invnum' => $options{'invnum'},
3455 'payby' => $method2payby{$method},
3456 #'payinfo' => $payinfo,
3457 'payinfo' => '4111111111111111',
3458 'paybatch' => $paybatch,
3459 #'paydate' => $paydate,
3460 'paydate' => '2012-05-01',
3462 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3464 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3467 $cust_pay->invnum(''); #try again with no specific invnum
3468 my $error2 = $cust_pay->insert( $options{'manual'} ?
3469 ( 'manual' => 1 ) : ()
3472 # gah, even with transactions.
3473 my $e = 'WARNING: Card/ACH debited but database not updated - '.
3474 "error inserting (fake!) payment: $error2".
3475 " (previously tried insert with invnum #$options{'invnum'}" .
3482 if ( $options{'paynum_ref'} ) {
3483 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3486 return ''; #no error
3490 =item default_payment_gateway
3494 sub default_payment_gateway {
3495 my( $self, $method ) = @_;
3497 die "Real-time processing not enabled\n"
3498 unless $conf->exists('business-onlinepayment');
3501 my $bop_config = 'business-onlinepayment';
3502 $bop_config .= '-ach'
3503 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
3504 my ( $processor, $login, $password, $action, @bop_options ) =
3505 $conf->config($bop_config);
3506 $action ||= 'normal authorization';
3507 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3508 die "No real-time processor is enabled - ".
3509 "did you set the business-onlinepayment configuration value?\n"
3512 ( $processor, $login, $password, $action, @bop_options )
3517 Removes the I<paycvv> field from the database directly.
3519 If there is an error, returns the error, otherwise returns false.
3525 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3526 or return dbh->errstr;
3527 $sth->execute($self->custnum)
3528 or return $sth->errstr;
3533 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3535 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3536 via a Business::OnlinePayment realtime gateway. See
3537 L<http://420.am/business-onlinepayment> for supported gateways.
3539 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3541 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3543 Most gateways require a reference to an original payment transaction to refund,
3544 so you probably need to specify a I<paynum>.
3546 I<amount> defaults to the original amount of the payment if not specified.
3548 I<reason> specifies a reason for the refund.
3550 I<paydate> specifies the expiration date for a credit card overriding the
3551 value from the customer record or the payment record. Specified as yyyy-mm-dd
3553 Implementation note: If I<amount> is unspecified or equal to the amount of the
3554 orignal payment, first an attempt is made to "void" the transaction via
3555 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3556 the normal attempt is made to "refund" ("credit") the transaction via the
3557 gateway is attempted.
3559 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3560 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3561 #if set, will override the value from the customer record.
3563 #If an I<invnum> is specified, this payment (if successful) is applied to the
3564 #specified invoice. If you don't specify an I<invnum> you might want to
3565 #call the B<apply_payments> method.
3569 #some false laziness w/realtime_bop, not enough to make it worth merging
3570 #but some useful small subs should be pulled out
3571 sub realtime_refund_bop {
3572 my( $self, $method, %options ) = @_;
3574 warn "$me realtime_refund_bop: $method refund\n";
3575 warn " $_ => $options{$_}\n" foreach keys %options;
3578 eval "use Business::OnlinePayment";
3582 # look up the original payment and optionally a gateway for that payment
3586 my $amount = $options{'amount'};
3588 my( $processor, $login, $password, @bop_options ) ;
3589 my( $auth, $order_number ) = ( '', '', '' );
3591 if ( $options{'paynum'} ) {
3593 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
3594 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3595 or return "Unknown paynum $options{'paynum'}";
3596 $amount ||= $cust_pay->paid;
3598 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3599 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3600 $cust_pay->paybatch;
3601 my $gatewaynum = '';
3602 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3604 if ( $gatewaynum ) { #gateway for the payment to be refunded
3606 my $payment_gateway =
3607 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3608 die "payment gateway $gatewaynum not found"
3609 unless $payment_gateway;
3611 $processor = $payment_gateway->gateway_module;
3612 $login = $payment_gateway->gateway_username;
3613 $password = $payment_gateway->gateway_password;
3614 @bop_options = $payment_gateway->options;
3616 } else { #try the default gateway
3618 my( $conf_processor, $unused_action );
3619 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3620 $self->default_payment_gateway($method);
3622 return "processor of payment $options{'paynum'} $processor does not".
3623 " match default processor $conf_processor"
3624 unless $processor eq $conf_processor;
3629 } else { # didn't specify a paynum, so look for agent gateway overrides
3630 # like a normal transaction
3633 if ( $method eq 'CC' ) {
3634 $cardtype = cardtype($self->payinfo);
3635 } elsif ( $method eq 'ECHECK' ) {
3638 $cardtype = $method;
3641 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3642 cardtype => $cardtype,
3644 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3646 taxclass => '', } );
3648 if ( $override ) { #use a payment gateway override
3650 my $payment_gateway = $override->payment_gateway;
3652 $processor = $payment_gateway->gateway_module;
3653 $login = $payment_gateway->gateway_username;
3654 $password = $payment_gateway->gateway_password;
3655 #$action = $payment_gateway->gateway_action;
3656 @bop_options = $payment_gateway->options;
3658 } else { #use the standard settings from the config
3661 ( $processor, $login, $password, $unused_action, @bop_options ) =
3662 $self->default_payment_gateway($method);
3667 return "neither amount nor paynum specified" unless $amount;
3672 'password' => $password,
3673 'order_number' => $order_number,
3674 'amount' => $amount,
3675 'referer' => 'http://cleanwhisker.420.am/',
3677 $content{authorization} = $auth
3678 if length($auth); #echeck/ACH transactions have an order # but no auth
3679 #(at least with authorize.net)
3681 my $disable_void_after;
3682 if ($conf->exists('disable_void_after')
3683 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3684 $disable_void_after = $1;
3687 #first try void if applicable
3688 if ( $cust_pay && $cust_pay->paid == $amount
3690 ( not defined($disable_void_after) )
3691 || ( time < ($cust_pay->_date + $disable_void_after ) )
3694 warn " attempting void\n" if $DEBUG > 1;
3695 my $void = new Business::OnlinePayment( $processor, @bop_options );
3696 $void->content( 'action' => 'void', %content );
3698 if ( $void->is_success ) {
3699 my $error = $cust_pay->void($options{'reason'});
3701 # gah, even with transactions.
3702 my $e = 'WARNING: Card/ACH voided but database not updated - '.
3703 "error voiding payment: $error";
3707 warn " void successful\n" if $DEBUG > 1;
3712 warn " void unsuccessful, trying refund\n"
3716 my $address = $self->address1;
3717 $address .= ", ". $self->address2 if $self->address2;
3719 my($payname, $payfirst, $paylast);
3720 if ( $self->payname && $method ne 'ECHECK' ) {
3721 $payname = $self->payname;
3722 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3723 or return "Illegal payname $payname";
3724 ($payfirst, $paylast) = ($1, $2);
3726 $payfirst = $self->getfield('first');
3727 $paylast = $self->getfield('last');
3728 $payname = "$payfirst $paylast";
3731 my @invoicing_list = $self->invoicing_list_emailonly;
3732 if ( $conf->exists('emailinvoiceautoalways')
3733 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3734 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3735 push @invoicing_list, $self->all_emails;
3738 my $email = ($conf->exists('business-onlinepayment-email-override'))
3739 ? $conf->config('business-onlinepayment-email-override')
3740 : $invoicing_list[0];
3742 my $payip = exists($options{'payip'})
3745 $content{customer_ip} = $payip
3749 if ( $method eq 'CC' ) {
3752 $content{card_number} = $payinfo = $cust_pay->payinfo;
3753 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3754 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3755 ($content{expiration} = "$2/$1"); # where available
3757 $content{card_number} = $payinfo = $self->payinfo;
3758 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3759 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3760 $content{expiration} = "$2/$1";
3763 } elsif ( $method eq 'ECHECK' ) {
3766 $payinfo = $cust_pay->payinfo;
3768 $payinfo = $self->payinfo;
3770 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3771 $content{bank_name} = $self->payname;
3772 $content{account_type} = 'CHECKING';
3773 $content{account_name} = $payname;
3774 $content{customer_org} = $self->company ? 'B' : 'I';
3775 $content{customer_ssn} = $self->ss;
3776 } elsif ( $method eq 'LEC' ) {
3777 $content{phone} = $payinfo = $self->payinfo;
3781 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3782 my %sub_content = $refund->content(
3783 'action' => 'credit',
3784 'customer_id' => $self->custnum,
3785 'last_name' => $paylast,
3786 'first_name' => $payfirst,
3788 'address' => $address,
3789 'city' => $self->city,
3790 'state' => $self->state,
3791 'zip' => $self->zip,
3792 'country' => $self->country,
3794 'phone' => $self->daytime || $self->night,
3797 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3801 return "$processor error: ". $refund->error_message
3802 unless $refund->is_success();
3804 my %method2payby = (
3810 my $paybatch = "$processor:". $refund->authorization;
3811 $paybatch .= ':'. $refund->order_number
3812 if $refund->can('order_number') && $refund->order_number;
3814 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3815 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3816 last unless @cust_bill_pay;
3817 my $cust_bill_pay = pop @cust_bill_pay;
3818 my $error = $cust_bill_pay->delete;
3822 my $cust_refund = new FS::cust_refund ( {
3823 'custnum' => $self->custnum,
3824 'paynum' => $options{'paynum'},
3825 'refund' => $amount,
3827 'payby' => $method2payby{$method},
3828 'payinfo' => $payinfo,
3829 'paybatch' => $paybatch,
3830 'reason' => $options{'reason'} || 'card or ACH refund',
3832 my $error = $cust_refund->insert;
3834 $cust_refund->paynum(''); #try again with no specific paynum
3835 my $error2 = $cust_refund->insert;
3837 # gah, even with transactions.
3838 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3839 "error inserting refund ($processor): $error2".
3840 " (previously tried insert with paynum #$options{'paynum'}" .
3851 =item batch_card OPTION => VALUE...
3853 Adds a payment for this invoice to the pending credit card batch (see
3854 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3855 runs the payment using a realtime gateway.
3860 my ($self, %options) = @_;
3863 if (exists($options{amount})) {
3864 $amount = $options{amount};
3866 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3868 return '' unless $amount > 0;
3870 my $invnum = delete $options{invnum};
3871 my $payby = $options{invnum} || $self->payby; #dubious
3873 if ($options{'realtime'}) {
3874 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3880 my $oldAutoCommit = $FS::UID::AutoCommit;
3881 local $FS::UID::AutoCommit = 0;
3884 #this needs to handle mysql as well as Pg, like svc_acct.pm
3885 #(make it into a common function if folks need to do batching with mysql)
3886 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3887 or return "Cannot lock pay_batch: " . $dbh->errstr;
3891 'payby' => FS::payby->payby2payment($payby),
3894 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3896 unless ( $pay_batch ) {
3897 $pay_batch = new FS::pay_batch \%pay_batch;
3898 my $error = $pay_batch->insert;
3900 $dbh->rollback if $oldAutoCommit;
3901 die "error creating new batch: $error\n";
3905 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3906 'batchnum' => $pay_batch->batchnum,
3907 'custnum' => $self->custnum,
3910 foreach (qw( address1 address2 city state zip country payby payinfo paydate
3912 $options{$_} = '' unless exists($options{$_});
3915 my $cust_pay_batch = new FS::cust_pay_batch ( {
3916 'batchnum' => $pay_batch->batchnum,
3917 'invnum' => $invnum || 0, # is there a better value?
3918 # this field should be
3920 # cust_bill_pay_batch now
3921 'custnum' => $self->custnum,
3922 'last' => $self->getfield('last'),
3923 'first' => $self->getfield('first'),
3924 'address1' => $options{address1} || $self->address1,
3925 'address2' => $options{address2} || $self->address2,
3926 'city' => $options{city} || $self->city,
3927 'state' => $options{state} || $self->state,
3928 'zip' => $options{zip} || $self->zip,
3929 'country' => $options{country} || $self->country,
3930 'payby' => $options{payby} || $self->payby,
3931 'payinfo' => $options{payinfo} || $self->payinfo,
3932 'exp' => $options{paydate} || $self->paydate,
3933 'payname' => $options{payname} || $self->payname,
3934 'amount' => $amount, # consolidating
3937 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
3938 if $old_cust_pay_batch;
3941 if ($old_cust_pay_batch) {
3942 $error = $cust_pay_batch->replace($old_cust_pay_batch)
3944 $error = $cust_pay_batch->insert;
3948 $dbh->rollback if $oldAutoCommit;
3952 my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
3953 foreach my $cust_bill ($self->open_cust_bill) {
3954 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
3955 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
3956 'invnum' => $cust_bill->invnum,
3957 'paybatchnum' => $cust_pay_batch->paybatchnum,
3958 'amount' => $cust_bill->owed,
3961 if ($unapplied >= $cust_bill_pay_batch->amount){
3962 $unapplied -= $cust_bill_pay_batch->amount;
3965 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
3966 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
3968 $error = $cust_bill_pay_batch->insert;
3970 $dbh->rollback if $oldAutoCommit;
3975 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3981 Returns the total owed for this customer on all invoices
3982 (see L<FS::cust_bill/owed>).
3988 $self->total_owed_date(2145859200); #12/31/2037
3991 =item total_owed_date TIME
3993 Returns the total owed for this customer on all invoices with date earlier than
3994 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
3995 see L<Time::Local> and L<Date::Parse> for conversion functions.
3999 sub total_owed_date {
4003 foreach my $cust_bill (
4004 grep { $_->_date <= $time }
4005 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4007 $total_bill += $cust_bill->owed;
4009 sprintf( "%.2f", $total_bill );
4012 =item apply_payments_and_credits
4014 Applies unapplied payments and credits.
4016 In most cases, this new method should be used in place of sequential
4017 apply_payments and apply_credits methods.
4019 If there is an error, returns the error, otherwise returns false.
4023 sub apply_payments_and_credits {
4026 local $SIG{HUP} = 'IGNORE';
4027 local $SIG{INT} = 'IGNORE';
4028 local $SIG{QUIT} = 'IGNORE';
4029 local $SIG{TERM} = 'IGNORE';
4030 local $SIG{TSTP} = 'IGNORE';
4031 local $SIG{PIPE} = 'IGNORE';
4033 my $oldAutoCommit = $FS::UID::AutoCommit;
4034 local $FS::UID::AutoCommit = 0;
4037 $self->select_for_update; #mutex
4039 foreach my $cust_bill ( $self->open_cust_bill ) {
4040 my $error = $cust_bill->apply_payments_and_credits;
4042 $dbh->rollback if $oldAutoCommit;
4043 return "Error applying: $error";
4047 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4052 =item apply_credits OPTION => VALUE ...
4054 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
4055 to outstanding invoice balances in chronological order (or reverse
4056 chronological order if the I<order> option is set to B<newest>) and returns the
4057 value of any remaining unapplied credits available for refund (see
4058 L<FS::cust_refund>).
4060 Dies if there is an error.
4068 local $SIG{HUP} = 'IGNORE';
4069 local $SIG{INT} = 'IGNORE';
4070 local $SIG{QUIT} = 'IGNORE';
4071 local $SIG{TERM} = 'IGNORE';
4072 local $SIG{TSTP} = 'IGNORE';
4073 local $SIG{PIPE} = 'IGNORE';
4075 my $oldAutoCommit = $FS::UID::AutoCommit;
4076 local $FS::UID::AutoCommit = 0;
4079 $self->select_for_update; #mutex
4081 unless ( $self->total_credited ) {
4082 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4086 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
4087 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
4089 my @invoices = $self->open_cust_bill;
4090 @invoices = sort { $b->_date <=> $a->_date } @invoices
4091 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
4094 foreach my $cust_bill ( @invoices ) {
4097 if ( !defined($credit) || $credit->credited == 0) {
4098 $credit = pop @credits or last;
4101 if ($cust_bill->owed >= $credit->credited) {
4102 $amount=$credit->credited;
4104 $amount=$cust_bill->owed;
4107 my $cust_credit_bill = new FS::cust_credit_bill ( {
4108 'crednum' => $credit->crednum,
4109 'invnum' => $cust_bill->invnum,
4110 'amount' => $amount,
4112 my $error = $cust_credit_bill->insert;
4114 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4118 redo if ($cust_bill->owed > 0);
4122 my $total_credited = $self->total_credited;
4124 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4126 return $total_credited;
4129 =item apply_payments
4131 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
4132 to outstanding invoice balances in chronological order.
4134 #and returns the value of any remaining unapplied payments.
4136 Dies if there is an error.
4140 sub apply_payments {
4143 local $SIG{HUP} = 'IGNORE';
4144 local $SIG{INT} = 'IGNORE';
4145 local $SIG{QUIT} = 'IGNORE';
4146 local $SIG{TERM} = 'IGNORE';
4147 local $SIG{TSTP} = 'IGNORE';
4148 local $SIG{PIPE} = 'IGNORE';
4150 my $oldAutoCommit = $FS::UID::AutoCommit;
4151 local $FS::UID::AutoCommit = 0;
4154 $self->select_for_update; #mutex
4158 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
4159 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
4161 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
4162 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
4166 foreach my $cust_bill ( @invoices ) {
4169 if ( !defined($payment) || $payment->unapplied == 0 ) {
4170 $payment = pop @payments or last;
4173 if ( $cust_bill->owed >= $payment->unapplied ) {
4174 $amount = $payment->unapplied;
4176 $amount = $cust_bill->owed;
4179 my $cust_bill_pay = new FS::cust_bill_pay ( {
4180 'paynum' => $payment->paynum,
4181 'invnum' => $cust_bill->invnum,
4182 'amount' => $amount,
4184 my $error = $cust_bill_pay->insert;
4186 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4190 redo if ( $cust_bill->owed > 0);
4194 my $total_unapplied_payments = $self->total_unapplied_payments;
4196 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4198 return $total_unapplied_payments;
4201 =item total_credited
4203 Returns the total outstanding credit (see L<FS::cust_credit>) for this
4204 customer. See L<FS::cust_credit/credited>.
4208 sub total_credited {
4210 my $total_credit = 0;
4211 foreach my $cust_credit ( qsearch('cust_credit', {
4212 'custnum' => $self->custnum,
4214 $total_credit += $cust_credit->credited;
4216 sprintf( "%.2f", $total_credit );
4219 =item total_unapplied_payments
4221 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
4222 See L<FS::cust_pay/unapplied>.
4226 sub total_unapplied_payments {
4228 my $total_unapplied = 0;
4229 foreach my $cust_pay ( qsearch('cust_pay', {
4230 'custnum' => $self->custnum,
4232 $total_unapplied += $cust_pay->unapplied;
4234 sprintf( "%.2f", $total_unapplied );
4237 =item total_unapplied_refunds
4239 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
4240 customer. See L<FS::cust_refund/unapplied>.
4244 sub total_unapplied_refunds {
4246 my $total_unapplied = 0;
4247 foreach my $cust_refund ( qsearch('cust_refund', {
4248 'custnum' => $self->custnum,
4250 $total_unapplied += $cust_refund->unapplied;
4252 sprintf( "%.2f", $total_unapplied );
4257 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4258 total_credited minus total_unapplied_payments).
4266 + $self->total_unapplied_refunds
4267 - $self->total_credited
4268 - $self->total_unapplied_payments
4272 =item balance_date TIME
4274 Returns the balance for this customer, only considering invoices with date
4275 earlier than TIME (total_owed_date minus total_credited minus
4276 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
4277 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
4286 $self->total_owed_date($time)
4287 + $self->total_unapplied_refunds
4288 - $self->total_credited
4289 - $self->total_unapplied_payments
4293 =item in_transit_payments
4295 Returns the total of requests for payments for this customer pending in
4296 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
4300 sub in_transit_payments {
4302 my $in_transit_payments = 0;
4303 foreach my $pay_batch ( qsearch('pay_batch', {
4306 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4307 'batchnum' => $pay_batch->batchnum,
4308 'custnum' => $self->custnum,
4310 $in_transit_payments += $cust_pay_batch->amount;
4313 sprintf( "%.2f", $in_transit_payments );
4316 =item paydate_monthyear
4318 Returns a two-element list consisting of the month and year of this customer's
4319 paydate (credit card expiration date for CARD customers)
4323 sub paydate_monthyear {
4325 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4327 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4334 =item invoicing_list [ ARRAYREF ]
4336 If an arguement is given, sets these email addresses as invoice recipients
4337 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
4338 (except as warnings), so use check_invoicing_list first.
4340 Returns a list of email addresses (with svcnum entries expanded).
4342 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
4343 check it without disturbing anything by passing nothing.
4345 This interface may change in the future.
4349 sub invoicing_list {
4350 my( $self, $arrayref ) = @_;
4353 my @cust_main_invoice;
4354 if ( $self->custnum ) {
4355 @cust_main_invoice =
4356 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4358 @cust_main_invoice = ();
4360 foreach my $cust_main_invoice ( @cust_main_invoice ) {
4361 #warn $cust_main_invoice->destnum;
4362 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4363 #warn $cust_main_invoice->destnum;
4364 my $error = $cust_main_invoice->delete;
4365 warn $error if $error;
4368 if ( $self->custnum ) {
4369 @cust_main_invoice =
4370 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4372 @cust_main_invoice = ();
4374 my %seen = map { $_->address => 1 } @cust_main_invoice;
4375 foreach my $address ( @{$arrayref} ) {
4376 next if exists $seen{$address} && $seen{$address};
4377 $seen{$address} = 1;
4378 my $cust_main_invoice = new FS::cust_main_invoice ( {
4379 'custnum' => $self->custnum,
4382 my $error = $cust_main_invoice->insert;
4383 warn $error if $error;
4387 if ( $self->custnum ) {
4389 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4396 =item check_invoicing_list ARRAYREF
4398 Checks these arguements as valid input for the invoicing_list method. If there
4399 is an error, returns the error, otherwise returns false.
4403 sub check_invoicing_list {
4404 my( $self, $arrayref ) = @_;
4406 foreach my $address ( @$arrayref ) {
4408 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4409 return 'Can\'t add FAX invoice destination with a blank FAX number.';
4412 my $cust_main_invoice = new FS::cust_main_invoice ( {
4413 'custnum' => $self->custnum,
4416 my $error = $self->custnum
4417 ? $cust_main_invoice->check
4418 : $cust_main_invoice->checkdest
4420 return $error if $error;
4424 return "Email address required"
4425 if $conf->exists('cust_main-require_invoicing_list_email')
4426 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4431 =item set_default_invoicing_list
4433 Sets the invoicing list to all accounts associated with this customer,
4434 overwriting any previous invoicing list.
4438 sub set_default_invoicing_list {
4440 $self->invoicing_list($self->all_emails);
4445 Returns the email addresses of all accounts provisioned for this customer.
4452 foreach my $cust_pkg ( $self->all_pkgs ) {
4453 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4455 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4456 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4458 $list{$_}=1 foreach map { $_->email } @svc_acct;
4463 =item invoicing_list_addpost
4465 Adds postal invoicing to this customer. If this customer is already configured
4466 to receive postal invoices, does nothing.
4470 sub invoicing_list_addpost {
4472 return if grep { $_ eq 'POST' } $self->invoicing_list;
4473 my @invoicing_list = $self->invoicing_list;
4474 push @invoicing_list, 'POST';
4475 $self->invoicing_list(\@invoicing_list);
4478 =item invoicing_list_emailonly
4480 Returns the list of email invoice recipients (invoicing_list without non-email
4481 destinations such as POST and FAX).
4485 sub invoicing_list_emailonly {
4487 warn "$me invoicing_list_emailonly called"
4489 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4492 =item invoicing_list_emailonly_scalar
4494 Returns the list of email invoice recipients (invoicing_list without non-email
4495 destinations such as POST and FAX) as a comma-separated scalar.
4499 sub invoicing_list_emailonly_scalar {
4501 warn "$me invoicing_list_emailonly_scalar called"
4503 join(', ', $self->invoicing_list_emailonly);
4506 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4508 Returns an array of customers referred by this customer (referral_custnum set
4509 to this custnum). If DEPTH is given, recurses up to the given depth, returning
4510 customers referred by customers referred by this customer and so on, inclusive.
4511 The default behavior is DEPTH 1 (no recursion).
4515 sub referral_cust_main {
4517 my $depth = @_ ? shift : 1;
4518 my $exclude = @_ ? shift : {};
4521 map { $exclude->{$_->custnum}++; $_; }
4522 grep { ! $exclude->{ $_->custnum } }
4523 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4527 map { $_->referral_cust_main($depth-1, $exclude) }
4534 =item referral_cust_main_ncancelled
4536 Same as referral_cust_main, except only returns customers with uncancelled
4541 sub referral_cust_main_ncancelled {
4543 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4546 =item referral_cust_pkg [ DEPTH ]
4548 Like referral_cust_main, except returns a flat list of all unsuspended (and
4549 uncancelled) packages for each customer. The number of items in this list may
4550 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4554 sub referral_cust_pkg {
4556 my $depth = @_ ? shift : 1;
4558 map { $_->unsuspended_pkgs }
4559 grep { $_->unsuspended_pkgs }
4560 $self->referral_cust_main($depth);
4563 =item referring_cust_main
4565 Returns the single cust_main record for the customer who referred this customer
4566 (referral_custnum), or false.
4570 sub referring_cust_main {
4572 return '' unless $self->referral_custnum;
4573 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4576 =item credit AMOUNT, REASON
4578 Applies a credit to this customer. If there is an error, returns the error,
4579 otherwise returns false.
4584 my( $self, $amount, $reason, %options ) = @_;
4585 my $cust_credit = new FS::cust_credit {
4586 'custnum' => $self->custnum,
4587 'amount' => $amount,
4588 'reason' => $reason,
4590 $cust_credit->insert(%options);
4593 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4595 Creates a one-time charge for this customer. If there is an error, returns
4596 the error, otherwise returns false.
4602 my ( $amount, $pkg, $comment, $taxclass, $additional, $classnum );
4603 if ( ref( $_[0] ) ) {
4604 $amount = $_[0]->{amount};
4605 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4606 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
4607 : '$'. sprintf("%.2f",$amount);
4608 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4609 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
4610 $additional = $_[0]->{additional};
4613 $pkg = @_ ? shift : 'One-time charge';
4614 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
4615 $taxclass = @_ ? shift : '';
4619 local $SIG{HUP} = 'IGNORE';
4620 local $SIG{INT} = 'IGNORE';
4621 local $SIG{QUIT} = 'IGNORE';
4622 local $SIG{TERM} = 'IGNORE';
4623 local $SIG{TSTP} = 'IGNORE';
4624 local $SIG{PIPE} = 'IGNORE';
4626 my $oldAutoCommit = $FS::UID::AutoCommit;
4627 local $FS::UID::AutoCommit = 0;
4630 my $part_pkg = new FS::part_pkg ( {
4632 'comment' => $comment,
4636 'classnum' => $classnum ? $classnum : '',
4637 'taxclass' => $taxclass,
4640 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4641 ( 0 .. @$additional - 1 )
4643 'additional_count' => scalar(@$additional),
4644 'setup_fee' => $amount,
4647 my $error = $part_pkg->insert( options => \%options );
4649 $dbh->rollback if $oldAutoCommit;
4653 my $pkgpart = $part_pkg->pkgpart;
4654 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4655 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4656 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4657 $error = $type_pkgs->insert;
4659 $dbh->rollback if $oldAutoCommit;
4664 my $cust_pkg = new FS::cust_pkg ( {
4665 'custnum' => $self->custnum,
4666 'pkgpart' => $pkgpart,
4669 $error = $cust_pkg->insert;
4671 $dbh->rollback if $oldAutoCommit;
4675 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4682 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4688 sort { $a->_date <=> $b->_date }
4689 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4692 =item open_cust_bill
4694 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4699 sub open_cust_bill {
4701 grep { $_->owed > 0 } $self->cust_bill;
4706 Returns all the credits (see L<FS::cust_credit>) for this customer.
4712 sort { $a->_date <=> $b->_date }
4713 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4718 Returns all the payments (see L<FS::cust_pay>) for this customer.
4724 sort { $a->_date <=> $b->_date }
4725 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4730 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4736 sort { $a->_date <=> $b->_date }
4737 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4740 =item cust_pay_batch
4742 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
4746 sub cust_pay_batch {
4748 sort { $a->_date <=> $b->_date }
4749 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
4754 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4760 sort { $a->_date <=> $b->_date }
4761 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4766 Returns a name string for this customer, either "Company (Last, First)" or
4773 my $name = $self->contact;
4774 $name = $self->company. " ($name)" if $self->company;
4780 Returns a name string for this (service/shipping) contact, either
4781 "Company (Last, First)" or "Last, First".
4787 if ( $self->get('ship_last') ) {
4788 my $name = $self->ship_contact;
4789 $name = $self->ship_company. " ($name)" if $self->ship_company;
4798 Returns this customer's full (billing) contact name only, "Last, First"
4804 $self->get('last'). ', '. $self->first;
4809 Returns this customer's full (shipping) contact name only, "Last, First"
4815 $self->get('ship_last')
4816 ? $self->get('ship_last'). ', '. $self->ship_first
4822 Returns this customer's full country name
4828 code2country($self->country);
4831 =item geocode DATA_VENDOR
4833 Returns a value for the customer location as encoded by DATA_VENDOR.
4834 Currently this only makes sense for "CCH" as DATA_VENDOR.
4839 my ($self, $data_vendor) = (shift, shift); #always cch for now
4841 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
4845 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
4846 if $self->country eq 'US';
4848 #CCH specific location stuff
4849 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
4852 my $cust_tax_location =
4854 'table' => 'cust_tax_location',
4855 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
4856 'extra_sql' => $extra_sql,
4859 $geocode = $cust_tax_location->geocode
4860 if $cust_tax_location;
4869 Returns a status string for this customer, currently:
4873 =item prospect - No packages have ever been ordered
4875 =item active - One or more recurring packages is active
4877 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4879 =item suspended - All non-cancelled recurring packages are suspended
4881 =item cancelled - All recurring packages are cancelled
4887 sub status { shift->cust_status(@_); }
4891 for my $status (qw( prospect active inactive suspended cancelled )) {
4892 my $method = $status.'_sql';
4893 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4894 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4895 $sth->execute( ($self->custnum) x $numnum )
4896 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4897 return $status if $sth->fetchrow_arrayref->[0];
4901 =item ucfirst_cust_status
4903 =item ucfirst_status
4905 Returns the status with the first character capitalized.
4909 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4911 sub ucfirst_cust_status {
4913 ucfirst($self->cust_status);
4918 Returns a hex triplet color string for this customer's status.
4922 use vars qw(%statuscolor);
4923 tie my %statuscolor, 'Tie::IxHash',
4924 'prospect' => '7e0079', #'000000', #black? naw, purple
4925 'active' => '00CC00', #green
4926 'inactive' => '0000CC', #blue
4927 'suspended' => 'FF9900', #yellow
4928 'cancelled' => 'FF0000', #red
4931 sub statuscolor { shift->cust_statuscolor(@_); }
4933 sub cust_statuscolor {
4935 $statuscolor{$self->cust_status};
4940 Returns an array of hashes representing the customer's RT tickets.
4947 my $num = $conf->config('cust_main-max_tickets') || 10;
4950 unless ( $conf->config('ticket_system-custom_priority_field') ) {
4952 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4956 foreach my $priority (
4957 $conf->config('ticket_system-custom_priority_field-values'), ''
4959 last if scalar(@tickets) >= $num;
4961 @{ FS::TicketSystem->customer_tickets( $self->custnum,
4962 $num - scalar(@tickets),
4971 # Return services representing svc_accts in customer support packages
4972 sub support_services {
4974 my %packages = map { $_ => 1 } $conf->config('support_packages');
4976 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4977 grep { $_->part_svc->svcdb eq 'svc_acct' }
4978 map { $_->cust_svc }
4979 grep { exists $packages{ $_->pkgpart } }
4980 $self->ncancelled_pkgs;
4986 =head1 CLASS METHODS
4992 Class method that returns the list of possible status strings for customers
4993 (see L<the status method|/status>). For example:
4995 @statuses = FS::cust_main->statuses();
5000 #my $self = shift; #could be class...
5006 Returns an SQL expression identifying prospective cust_main records (customers
5007 with no packages ever ordered)
5011 use vars qw($select_count_pkgs);
5012 $select_count_pkgs =
5013 "SELECT COUNT(*) FROM cust_pkg
5014 WHERE cust_pkg.custnum = cust_main.custnum";
5016 sub select_count_pkgs_sql {
5020 sub prospect_sql { "
5021 0 = ( $select_count_pkgs )
5026 Returns an SQL expression identifying active cust_main records (customers with
5027 no active recurring packages, but otherwise unsuspended/uncancelled).
5032 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
5038 Returns an SQL expression identifying inactive cust_main records (customers with
5039 active recurring packages).
5043 sub inactive_sql { "
5044 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5046 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
5052 Returns an SQL expression identifying suspended cust_main records.
5057 sub suspended_sql { susp_sql(@_); }
5059 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
5061 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5067 Returns an SQL expression identifying cancelled cust_main records.
5071 sub cancelled_sql { cancel_sql(@_); }
5074 my $recurring_sql = FS::cust_pkg->recurring_sql;
5075 #my $recurring_sql = "
5076 # '0' != ( select freq from part_pkg
5077 # where cust_pkg.pkgpart = part_pkg.pkgpart )
5081 0 < ( $select_count_pkgs )
5082 AND 0 = ( $select_count_pkgs AND $recurring_sql
5083 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5089 =item uncancelled_sql
5091 Returns an SQL expression identifying un-cancelled cust_main records.
5095 sub uncancelled_sql { uncancel_sql(@_); }
5096 sub uncancel_sql { "
5097 ( 0 < ( $select_count_pkgs
5098 AND ( cust_pkg.cancel IS NULL
5099 OR cust_pkg.cancel = 0
5102 OR 0 = ( $select_count_pkgs )
5108 Returns an SQL fragment to retreive the balance.
5113 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5114 WHERE cust_bill.custnum = cust_main.custnum )
5115 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5116 WHERE cust_pay.custnum = cust_main.custnum )
5117 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5118 WHERE cust_credit.custnum = cust_main.custnum )
5119 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5120 WHERE cust_refund.custnum = cust_main.custnum )
5123 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5125 Returns an SQL fragment to retreive the balance for this customer, only
5126 considering invoices with date earlier than START_TIME, and optionally not
5127 later than END_TIME (total_owed_date minus total_credited minus
5128 total_unapplied_payments).
5130 Times are specified as SQL fragments or numeric
5131 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5132 L<Date::Parse> for conversion functions. The empty string can be passed
5133 to disable that time constraint completely.
5135 Available options are:
5139 =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)
5141 =item total - set to true to remove all customer comparison clauses, for totals
5143 =item where - WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5145 =item join - JOIN clause (typically used with the total option)
5153 sub balance_date_sql {
5154 my( $class, $start, $end, %opt ) = @_;
5156 my $owed = FS::cust_bill->owed_sql;
5157 my $unapp_refund = FS::cust_refund->unapplied_sql;
5158 my $unapp_credit = FS::cust_credit->unapplied_sql;
5159 my $unapp_pay = FS::cust_pay->unapplied_sql;
5161 my $j = $opt{'join'} || '';
5163 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5164 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5165 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5166 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5168 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5169 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5170 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5171 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5176 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5178 Helper method for balance_date_sql; name (and usage) subject to change
5179 (suggestions welcome).
5181 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5182 cust_refund, cust_credit or cust_pay).
5184 If TABLE is "cust_bill" or the unapplied_date option is true, only
5185 considers records with date earlier than START_TIME, and optionally not
5186 later than END_TIME .
5190 sub _money_table_where {
5191 my( $class, $table, $start, $end, %opt ) = @_;
5194 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5195 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5196 push @where, "$table._date <= $start" if defined($start) && length($start);
5197 push @where, "$table._date > $end" if defined($end) && length($end);
5199 push @where, @{$opt{'where'}} if $opt{'where'};
5200 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5206 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
5208 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
5209 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
5210 appropriate ship_ field is also searched).
5212 Additional options are the same as FS::Record::qsearch
5217 my( $self, $fuzzy, $hash, @opt) = @_;
5222 check_and_rebuild_fuzzyfiles();
5223 foreach my $field ( keys %$fuzzy ) {
5225 my $all = $self->all_X($field);
5226 next unless scalar(@$all);
5229 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
5232 foreach ( keys %match ) {
5233 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
5234 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
5237 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
5240 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
5242 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
5250 Returns a masked version of the named field
5255 my ($self,$field) = @_;
5259 'x'x(length($self->getfield($field))-4).
5260 substr($self->getfield($field), (length($self->getfield($field))-4));
5270 =item smart_search OPTION => VALUE ...
5272 Accepts the following options: I<search>, the string to search for. The string
5273 will be searched for as a customer number, phone number, name or company name,
5274 as an exact, or, in some cases, a substring or fuzzy match (see the source code
5275 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
5276 skip fuzzy matching when an exact match is found.
5278 Any additional options are treated as an additional qualifier on the search
5281 Returns a (possibly empty) array of FS::cust_main objects.
5288 #here is the agent virtualization
5289 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5293 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
5294 my $search = delete $options{'search'};
5295 ( my $alphanum_search = $search ) =~ s/\W//g;
5297 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
5299 #false laziness w/Record::ut_phone
5300 my $phonen = "$1-$2-$3";
5301 $phonen .= " x$4" if $4;
5303 push @cust_main, qsearch( {
5304 'table' => 'cust_main',
5305 'hashref' => { %options },
5306 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5308 join(' OR ', map "$_ = '$phonen'",
5309 qw( daytime night fax
5310 ship_daytime ship_night ship_fax )
5313 " AND $agentnums_sql", #agent virtualization
5316 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
5317 #try looking for matches with extensions unless one was specified
5319 push @cust_main, qsearch( {
5320 'table' => 'cust_main',
5321 'hashref' => { %options },
5322 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5324 join(' OR ', map "$_ LIKE '$phonen\%'",
5326 ship_daytime ship_night )
5329 " AND $agentnums_sql", #agent virtualization
5334 # custnum search (also try agent_custid), with some tweaking options if your
5335 # legacy cust "numbers" have letters
5336 } elsif ( $search =~ /^\s*(\d+)\s*$/
5337 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
5338 && $search =~ /^\s*(\w\w?\d+)\s*$/
5343 push @cust_main, qsearch( {
5344 'table' => 'cust_main',
5345 'hashref' => { 'custnum' => $1, %options },
5346 'extra_sql' => " AND $agentnums_sql", #agent virtualization
5349 push @cust_main, qsearch( {
5350 'table' => 'cust_main',
5351 'hashref' => { 'agent_custid' => $1, %options },
5352 'extra_sql' => " AND $agentnums_sql", #agent virtualization
5355 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
5357 my($company, $last, $first) = ( $1, $2, $3 );
5359 # "Company (Last, First)"
5360 #this is probably something a browser remembered,
5361 #so just do an exact search
5363 foreach my $prefix ( '', 'ship_' ) {
5364 push @cust_main, qsearch( {
5365 'table' => 'cust_main',
5366 'hashref' => { $prefix.'first' => $first,
5367 $prefix.'last' => $last,
5368 $prefix.'company' => $company,
5371 'extra_sql' => " AND $agentnums_sql",
5375 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
5376 # try (ship_){last,company}
5380 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
5381 # # full strings the browser remembers won't work
5382 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
5384 use Lingua::EN::NameParse;
5385 my $NameParse = new Lingua::EN::NameParse(
5387 allow_reversed => 1,
5390 my($last, $first) = ( '', '' );
5391 #maybe disable this too and just rely on NameParse?
5392 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
5394 ($last, $first) = ( $1, $2 );
5396 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
5397 } elsif ( ! $NameParse->parse($value) ) {
5399 my %name = $NameParse->components;
5400 $first = $name{'given_name_1'};
5401 $last = $name{'surname_1'};
5405 if ( $first && $last ) {
5407 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
5410 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5412 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
5413 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
5416 push @cust_main, qsearch( {
5417 'table' => 'cust_main',
5418 'hashref' => \%options,
5419 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5422 # or it just be something that was typed in... (try that in a sec)
5426 my $q_value = dbh->quote($value);
5429 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5430 $sql .= " ( LOWER(last) = $q_value
5431 OR LOWER(company) = $q_value
5432 OR LOWER(ship_last) = $q_value
5433 OR LOWER(ship_company) = $q_value
5436 push @cust_main, qsearch( {
5437 'table' => 'cust_main',
5438 'hashref' => \%options,
5439 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5442 #no exact match, trying substring/fuzzy
5443 #always do substring & fuzzy (unless they're explicity config'ed off)
5444 #getting complaints searches are not returning enough
5445 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
5447 #still some false laziness w/ search/cust_main.cgi
5452 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
5453 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
5456 if ( $first && $last ) {
5459 { 'first' => { op=>'ILIKE', value=>"%$first%" },
5460 'last' => { op=>'ILIKE', value=>"%$last%" },
5462 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
5463 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
5470 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
5471 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
5475 foreach my $hashref ( @hashrefs ) {
5477 push @cust_main, qsearch( {
5478 'table' => 'cust_main',
5479 'hashref' => { %$hashref,
5482 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
5491 " AND $agentnums_sql", #extra_sql #agent virtualization
5494 if ( $first && $last ) {
5495 push @cust_main, FS::cust_main->fuzzy_search(
5496 { 'last' => $last, #fuzzy hashref
5497 'first' => $first }, #
5501 foreach my $field ( 'last', 'company' ) {
5503 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
5508 #eliminate duplicates
5510 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5520 Accepts the following options: I<email>, the email address to search for. The
5521 email address will be searched for as an email invoice destination and as an
5524 #Any additional options are treated as an additional qualifier on the search
5525 #(i.e. I<agentnum>).
5527 Returns a (possibly empty) array of FS::cust_main objects (but usually just
5537 my $email = delete $options{'email'};
5539 #we're only being used by RT at the moment... no agent virtualization yet
5540 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5544 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
5546 my ( $user, $domain ) = ( $1, $2 );
5548 warn "$me smart_search: searching for $user in domain $domain"
5554 'table' => 'cust_main_invoice',
5555 'hashref' => { 'dest' => $email },
5562 map $_->cust_svc->cust_pkg,
5564 'table' => 'svc_acct',
5565 'hashref' => { 'username' => $user, },
5567 'AND ( SELECT domain FROM svc_domain
5568 WHERE svc_acct.domsvc = svc_domain.svcnum
5569 ) = '. dbh->quote($domain),
5575 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5577 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
5584 =item check_and_rebuild_fuzzyfiles
5588 use vars qw(@fuzzyfields);
5589 @fuzzyfields = ( 'last', 'first', 'company' );
5591 sub check_and_rebuild_fuzzyfiles {
5592 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5593 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
5596 =item rebuild_fuzzyfiles
5600 sub rebuild_fuzzyfiles {
5602 use Fcntl qw(:flock);
5604 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5605 mkdir $dir, 0700 unless -d $dir;
5607 foreach my $fuzzy ( @fuzzyfields ) {
5609 open(LOCK,">>$dir/cust_main.$fuzzy")
5610 or die "can't open $dir/cust_main.$fuzzy: $!";
5612 or die "can't lock $dir/cust_main.$fuzzy: $!";
5614 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
5615 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
5617 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
5618 my $sth = dbh->prepare("SELECT $field FROM cust_main".
5619 " WHERE $field != '' AND $field IS NOT NULL");
5620 $sth->execute or die $sth->errstr;
5622 while ( my $row = $sth->fetchrow_arrayref ) {
5623 print CACHE $row->[0]. "\n";
5628 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
5630 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
5641 my( $self, $field ) = @_;
5642 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5643 open(CACHE,"<$dir/cust_main.$field")
5644 or die "can't open $dir/cust_main.$field: $!";
5645 my @array = map { chomp; $_; } <CACHE>;
5650 =item append_fuzzyfiles LASTNAME COMPANY
5654 sub append_fuzzyfiles {
5655 #my( $first, $last, $company ) = @_;
5657 &check_and_rebuild_fuzzyfiles;
5659 use Fcntl qw(:flock);
5661 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5663 foreach my $field (qw( first last company )) {
5668 open(CACHE,">>$dir/cust_main.$field")
5669 or die "can't open $dir/cust_main.$field: $!";
5670 flock(CACHE,LOCK_EX)
5671 or die "can't lock $dir/cust_main.$field: $!";
5673 print CACHE "$value\n";
5675 flock(CACHE,LOCK_UN)
5676 or die "can't unlock $dir/cust_main.$field: $!";
5691 #warn join('-',keys %$param);
5692 my $fh = $param->{filehandle};
5693 my $agentnum = $param->{agentnum};
5695 my $refnum = $param->{refnum};
5696 my $pkgpart = $param->{pkgpart};
5698 #my @fields = @{$param->{fields}};
5699 my $format = $param->{'format'};
5702 if ( $format eq 'simple' ) {
5703 @fields = qw( cust_pkg.setup dayphone first last
5704 address1 address2 city state zip comments );
5706 } elsif ( $format eq 'extended' ) {
5707 @fields = qw( agent_custid refnum
5708 last first address1 address2 city state zip country
5710 ship_last ship_first ship_address1 ship_address2
5711 ship_city ship_state ship_zip ship_country
5712 payinfo paycvv paydate
5715 svc_acct.username svc_acct._password
5718 } elsif ( $format eq 'extended-plus_company' ) {
5719 @fields = qw( agent_custid refnum
5720 last first company address1 address2 city state zip country
5722 ship_last ship_first ship_company ship_address1 ship_address2
5723 ship_city ship_state ship_zip ship_country
5724 payinfo paycvv paydate
5727 svc_acct.username svc_acct._password
5731 die "unknown format $format";
5734 eval "use Text::CSV_XS;";
5737 my $csv = new Text::CSV_XS;
5744 local $SIG{HUP} = 'IGNORE';
5745 local $SIG{INT} = 'IGNORE';
5746 local $SIG{QUIT} = 'IGNORE';
5747 local $SIG{TERM} = 'IGNORE';
5748 local $SIG{TSTP} = 'IGNORE';
5749 local $SIG{PIPE} = 'IGNORE';
5751 my $oldAutoCommit = $FS::UID::AutoCommit;
5752 local $FS::UID::AutoCommit = 0;
5755 #while ( $columns = $csv->getline($fh) ) {
5757 while ( defined($line=<$fh>) ) {
5759 $csv->parse($line) or do {
5760 $dbh->rollback if $oldAutoCommit;
5761 return "can't parse: ". $csv->error_input();
5764 my @columns = $csv->fields();
5765 #warn join('-',@columns);
5768 agentnum => $agentnum,
5770 country => $conf->config('countrydefault') || 'US',
5771 payby => $payby, #default
5772 paydate => '12/2037', #default
5774 my $billtime = time;
5775 my %cust_pkg = ( pkgpart => $pkgpart );
5777 foreach my $field ( @fields ) {
5779 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
5781 #$cust_pkg{$1} = str2time( shift @$columns );
5782 if ( $1 eq 'pkgpart' ) {
5783 $cust_pkg{$1} = shift @columns;
5784 } elsif ( $1 eq 'setup' ) {
5785 $billtime = str2time(shift @columns);
5787 $cust_pkg{$1} = str2time( shift @columns );
5790 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
5792 $svc_acct{$1} = shift @columns;
5796 #refnum interception
5797 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
5799 my $referral = $columns[0];
5800 my %hash = ( 'referral' => $referral,
5801 'agentnum' => $agentnum,
5805 my $part_referral = qsearchs('part_referral', \%hash )
5806 || new FS::part_referral \%hash;
5808 unless ( $part_referral->refnum ) {
5809 my $error = $part_referral->insert;
5811 $dbh->rollback if $oldAutoCommit;
5812 return "can't auto-insert advertising source: $referral: $error";
5816 $columns[0] = $part_referral->refnum;
5819 #$cust_main{$field} = shift @$columns;
5820 $cust_main{$field} = shift @columns;
5824 $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
5826 my $invoicing_list = $cust_main{'invoicing_list'}
5827 ? [ delete $cust_main{'invoicing_list'} ]
5830 my $cust_main = new FS::cust_main ( \%cust_main );
5833 tie my %hash, 'Tie::RefHash'; #this part is important
5835 if ( $cust_pkg{'pkgpart'} ) {
5836 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
5839 if ( $svc_acct{'username'} ) {
5840 my $part_pkg = $cust_pkg->part_pkg;
5841 unless ( $part_pkg ) {
5842 $dbh->rollback if $oldAutoCommit;
5843 return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
5845 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
5846 push @svc_acct, new FS::svc_acct ( \%svc_acct )
5849 $hash{$cust_pkg} = \@svc_acct;
5852 my $error = $cust_main->insert( \%hash, $invoicing_list );
5855 $dbh->rollback if $oldAutoCommit;
5856 return "can't insert customer for $line: $error";
5859 if ( $format eq 'simple' ) {
5861 #false laziness w/bill.cgi
5862 $error = $cust_main->bill( 'time' => $billtime );
5864 $dbh->rollback if $oldAutoCommit;
5865 return "can't bill customer for $line: $error";
5868 $error = $cust_main->apply_payments_and_credits;
5870 $dbh->rollback if $oldAutoCommit;
5871 return "can't bill customer for $line: $error";
5874 $error = $cust_main->collect();
5876 $dbh->rollback if $oldAutoCommit;
5877 return "can't collect customer for $line: $error";
5885 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5887 return "Empty file!" unless $imported;
5899 #warn join('-',keys %$param);
5900 my $fh = $param->{filehandle};
5901 my @fields = @{$param->{fields}};
5903 eval "use Text::CSV_XS;";
5906 my $csv = new Text::CSV_XS;
5913 local $SIG{HUP} = 'IGNORE';
5914 local $SIG{INT} = 'IGNORE';
5915 local $SIG{QUIT} = 'IGNORE';
5916 local $SIG{TERM} = 'IGNORE';
5917 local $SIG{TSTP} = 'IGNORE';
5918 local $SIG{PIPE} = 'IGNORE';
5920 my $oldAutoCommit = $FS::UID::AutoCommit;
5921 local $FS::UID::AutoCommit = 0;
5924 #while ( $columns = $csv->getline($fh) ) {
5926 while ( defined($line=<$fh>) ) {
5928 $csv->parse($line) or do {
5929 $dbh->rollback if $oldAutoCommit;
5930 return "can't parse: ". $csv->error_input();
5933 my @columns = $csv->fields();
5934 #warn join('-',@columns);
5937 foreach my $field ( @fields ) {
5938 $row{$field} = shift @columns;
5941 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
5942 unless ( $cust_main ) {
5943 $dbh->rollback if $oldAutoCommit;
5944 return "unknown custnum $row{'custnum'}";
5947 if ( $row{'amount'} > 0 ) {
5948 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
5950 $dbh->rollback if $oldAutoCommit;
5954 } elsif ( $row{'amount'} < 0 ) {
5955 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
5958 $dbh->rollback if $oldAutoCommit;
5968 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5970 return "Empty file!" unless $imported;
5976 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5978 Sends a templated email notification to the customer (see L<Text::Template>).
5980 OPTIONS is a hash and may include
5982 I<from> - the email sender (default is invoice_from)
5984 I<to> - comma-separated scalar or arrayref of recipients
5985 (default is invoicing_list)
5987 I<subject> - The subject line of the sent email notification
5988 (default is "Notice from company_name")
5990 I<extra_fields> - a hashref of name/value pairs which will be substituted
5993 The following variables are vavailable in the template.
5995 I<$first> - the customer first name
5996 I<$last> - the customer last name
5997 I<$company> - the customer company
5998 I<$payby> - a description of the method of payment for the customer
5999 # would be nice to use FS::payby::shortname
6000 I<$payinfo> - the account information used to collect for this customer
6001 I<$expdate> - the expiration of the customer payment in seconds from epoch
6006 my ($customer, $template, %options) = @_;
6008 return unless $conf->exists($template);
6010 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
6011 $from = $options{from} if exists($options{from});
6013 my $to = join(',', $customer->invoicing_list_emailonly);
6014 $to = $options{to} if exists($options{to});
6016 my $subject = "Notice from " . $conf->config('company_name')
6017 if $conf->exists('company_name');
6018 $subject = $options{subject} if exists($options{subject});
6020 my $notify_template = new Text::Template (TYPE => 'ARRAY',
6021 SOURCE => [ map "$_\n",
6022 $conf->config($template)]
6024 or die "can't create new Text::Template object: Text::Template::ERROR";
6025 $notify_template->compile()
6026 or die "can't compile template: Text::Template::ERROR";
6028 $FS::notify_template::_template::company_name = $conf->config('company_name');
6029 $FS::notify_template::_template::company_address =
6030 join("\n", $conf->config('company_address') ). "\n";
6032 my $paydate = $customer->paydate || '2037-12-31';
6033 $FS::notify_template::_template::first = $customer->first;
6034 $FS::notify_template::_template::last = $customer->last;
6035 $FS::notify_template::_template::company = $customer->company;
6036 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
6037 my $payby = $customer->payby;
6038 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6039 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6041 #credit cards expire at the end of the month/year of their exp date
6042 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6043 $FS::notify_template::_template::payby = 'credit card';
6044 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6045 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6047 }elsif ($payby eq 'COMP') {
6048 $FS::notify_template::_template::payby = 'complimentary account';
6050 $FS::notify_template::_template::payby = 'current method';
6052 $FS::notify_template::_template::expdate = $expire_time;
6054 for (keys %{$options{extra_fields}}){
6056 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
6059 send_email(from => $from,
6061 subject => $subject,
6062 body => $notify_template->fill_in( PACKAGE =>
6063 'FS::notify_template::_template' ),
6068 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6070 Generates a templated notification to the customer (see L<Text::Template>).
6072 OPTIONS is a hash and may include
6074 I<extra_fields> - a hashref of name/value pairs which will be substituted
6075 into the template. These values may override values mentioned below
6076 and those from the customer record.
6078 The following variables are available in the template instead of or in addition
6079 to the fields of the customer record.
6081 I<$payby> - a description of the method of payment for the customer
6082 # would be nice to use FS::payby::shortname
6083 I<$payinfo> - the masked account information used to collect for this customer
6084 I<$expdate> - the expiration of the customer payment method in seconds from epoch
6085 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
6089 sub generate_letter {
6090 my ($self, $template, %options) = @_;
6092 return unless $conf->exists($template);
6094 my $letter_template = new Text::Template
6096 SOURCE => [ map "$_\n", $conf->config($template)],
6097 DELIMITERS => [ '[@--', '--@]' ],
6099 or die "can't create new Text::Template object: Text::Template::ERROR";
6101 $letter_template->compile()
6102 or die "can't compile template: Text::Template::ERROR";
6104 my %letter_data = map { $_ => $self->$_ } $self->fields;
6105 $letter_data{payinfo} = $self->mask_payinfo;
6107 #my $paydate = $self->paydate || '2037-12-31';
6108 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
6110 my $payby = $self->payby;
6111 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6112 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6114 #credit cards expire at the end of the month/year of their exp date
6115 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6116 $letter_data{payby} = 'credit card';
6117 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6118 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6120 }elsif ($payby eq 'COMP') {
6121 $letter_data{payby} = 'complimentary account';
6123 $letter_data{payby} = 'current method';
6125 $letter_data{expdate} = $expire_time;
6127 for (keys %{$options{extra_fields}}){
6128 $letter_data{$_} = $options{extra_fields}->{$_};
6131 unless(exists($letter_data{returnaddress})){
6132 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
6133 $self->agent_template)
6135 if ( length($retadd) ) {
6136 $letter_data{returnaddress} = $retadd;
6137 } elsif ( grep /\S/, $conf->config('company_address') ) {
6138 $letter_data{returnaddress} =
6139 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
6140 $conf->config('company_address')
6143 $letter_data{returnaddress} = '~';
6147 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
6149 $letter_data{company_name} = $conf->config('company_name');
6151 my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
6152 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
6156 ) or die "can't open temp file: $!\n";
6158 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
6160 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
6164 =item print_ps TEMPLATE
6166 Returns an postscript letter filled in from TEMPLATE, as a scalar.
6172 my $file = $self->generate_letter(@_);
6173 FS::Misc::generate_ps($file);
6176 =item print TEMPLATE
6178 Prints the filled in template.
6180 TEMPLATE is the name of a L<Text::Template> to fill in and print.
6184 sub queueable_print {
6187 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
6188 or die "invalid customer number: " . $opt{custvnum};
6190 my $error = $self->print( $opt{template} );
6191 die $error if $error;
6195 my ($self, $template) = (shift, shift);
6196 do_print [ $self->print_ps($template) ];
6199 sub agent_template {
6201 $self->_agent_plandata('agent_templatename');
6204 sub agent_invoice_from {
6206 $self->_agent_plandata('agent_invoice_from');
6209 sub _agent_plandata {
6210 my( $self, $option ) = @_;
6212 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
6213 #agent-specific Conf
6215 use FS::part_event::Condition;
6217 my $agentnum = $self->agentnum;
6220 if ( driver_name =~ /^Pg/i ) {
6222 } elsif ( driver_name =~ /^mysql/i ) {
6225 die "don't know how to use regular expressions in ". driver_name. " databases";
6228 my $part_event_option =
6230 'select' => 'part_event_option.*',
6231 'table' => 'part_event_option',
6233 LEFT JOIN part_event USING ( eventpart )
6234 LEFT JOIN part_event_option AS peo_agentnum
6235 ON ( part_event.eventpart = peo_agentnum.eventpart
6236 AND peo_agentnum.optionname = 'agentnum'
6237 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
6239 LEFT JOIN part_event_option AS peo_cust_bill_age
6240 ON ( part_event.eventpart = peo_cust_bill_age.eventpart
6241 AND peo_cust_bill_age.optionname = 'cust_bill_age'
6244 #'hashref' => { 'optionname' => $option },
6245 #'hashref' => { 'part_event_option.optionname' => $option },
6247 " WHERE part_event_option.optionname = ". dbh->quote($option).
6248 " AND action = 'cust_bill_send_agent' ".
6249 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
6250 " AND peo_agentnum.optionname = 'agentnum' ".
6251 " AND agentnum IS NULL OR agentnum = $agentnum ".
6253 CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
6255 ELSE ". FS::part_event::Condition->age2seconds_sql('peo_cust_bill_age.optionvalue').
6257 , part_event.weight".
6261 unless ( $part_event_option ) {
6262 return $self->agent->invoice_template || ''
6263 if $option eq 'agent_templatename';
6267 $part_event_option->optionvalue;
6272 ## actual sub, not a method, designed to be called from the queue.
6273 ## sets up the customer, and calls the bill_and_collect
6274 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
6275 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
6276 $cust_main->bill_and_collect(
6287 The delete method should possibly take an FS::cust_main object reference
6288 instead of a scalar customer number.
6290 Bill and collect options should probably be passed as references instead of a
6293 There should probably be a configuration file with a list of allowed credit
6296 No multiple currency support (probably a larger project than just this module).
6298 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
6300 Birthdates rely on negative epoch values.
6302 The payby for card/check batches is broken. With mixed batching, bad
6305 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
6309 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
6310 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
6311 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.