5 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf @encrypted_fields
6 $import $skip_fuzzyfiles $ignore_expired_card @paytypes);
7 use vars qw( $realtime_bop_decline_quiet ); #ugh
11 use Scalar::Util qw( blessed );
12 use Time::Local qw(timelocal_nocheck);
15 use Digest::MD5 qw(md5_base64);
19 use String::Approx qw(amatch);
20 use Business::CreditCard 0.28;
23 use FS::UID qw( getotaker dbh driver_name );
24 use FS::Record qw( qsearchs qsearch dbdef );
25 use FS::Misc qw( send_email generate_ps do_print );
26 use FS::Msgcat qw(gettext);
30 use FS::cust_bill_pkg;
32 use FS::cust_pay_pending;
33 use FS::cust_pay_void;
34 use FS::cust_pay_batch;
37 use FS::part_referral;
38 use FS::cust_main_county;
40 use FS::cust_main_invoice;
41 use FS::cust_credit_bill;
42 use FS::cust_bill_pay;
43 use FS::prepay_credit;
47 use FS::part_event_condition;
50 use FS::payment_gateway;
51 use FS::agent_payment_gateway;
53 use FS::payinfo_Mixin;
56 @ISA = qw( FS::Record FS::payinfo_Mixin );
58 @EXPORT_OK = qw( smart_search );
60 $realtime_bop_decline_quiet = 0;
62 # 1 is mostly method/subroutine entry and options
63 # 2 traces progress of some operations
64 # 3 is even more information including possibly sensitive data
66 $me = '[FS::cust_main]';
70 $ignore_expired_card = 0;
72 @encrypted_fields = ('payinfo', 'paycvv');
73 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
75 #ask FS::UID to run this stuff for us later
76 #$FS::UID::callback{'FS::cust_main'} = sub {
77 install_callback FS::UID sub {
79 #yes, need it for stuff below (prolly should be cached)
84 my ( $hashref, $cache ) = @_;
85 if ( exists $hashref->{'pkgnum'} ) {
86 #@{ $self->{'_pkgnum'} } = ();
87 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
88 $self->{'_pkgnum'} = $subcache;
89 #push @{ $self->{'_pkgnum'} },
90 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
96 FS::cust_main - Object methods for cust_main records
102 $record = new FS::cust_main \%hash;
103 $record = new FS::cust_main { 'column' => 'value' };
105 $error = $record->insert;
107 $error = $new_record->replace($old_record);
109 $error = $record->delete;
111 $error = $record->check;
113 @cust_pkg = $record->all_pkgs;
115 @cust_pkg = $record->ncancelled_pkgs;
117 @cust_pkg = $record->suspended_pkgs;
119 $error = $record->bill;
120 $error = $record->bill %options;
121 $error = $record->bill 'time' => $time;
123 $error = $record->collect;
124 $error = $record->collect %options;
125 $error = $record->collect 'invoice_time' => $time,
130 An FS::cust_main object represents a customer. FS::cust_main inherits from
131 FS::Record. The following fields are currently supported:
135 =item custnum - primary key (assigned automatically for new customers)
137 =item agentnum - agent (see L<FS::agent>)
139 =item refnum - Advertising source (see L<FS::part_referral>)
145 =item ss - social security number (optional)
147 =item company - (optional)
151 =item address2 - (optional)
155 =item county - (optional, see L<FS::cust_main_county>)
157 =item state - (see L<FS::cust_main_county>)
161 =item country - (see L<FS::cust_main_county>)
163 =item daytime - phone (optional)
165 =item night - phone (optional)
167 =item fax - phone (optional)
169 =item ship_first - name
171 =item ship_last - name
173 =item ship_company - (optional)
177 =item ship_address2 - (optional)
181 =item ship_county - (optional, see L<FS::cust_main_county>)
183 =item ship_state - (see L<FS::cust_main_county>)
187 =item ship_country - (see L<FS::cust_main_county>)
189 =item ship_daytime - phone (optional)
191 =item ship_night - phone (optional)
193 =item ship_fax - phone (optional)
195 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
197 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
199 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
203 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
205 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
207 =item paystart_month - start date month (maestro/solo cards only)
209 =item paystart_year - start date year (maestro/solo cards only)
211 =item payissue - issue number (maestro/solo cards only)
213 =item payname - name on card or billing name
215 =item payip - IP address from which payment information was received
217 =item tax - tax exempt, empty or `Y'
219 =item otaker - order taker (assigned automatically, see L<FS::UID>)
221 =item comments - comments (optional)
223 =item referral_custnum - referring customer number
225 =item spool_cdr - Enable individual CDR spooling, empty or `Y'
235 Creates a new customer. To add the customer to the database, see L<"insert">.
237 Note that this stores the hash reference, not a distinct copy of the hash it
238 points to. You can ask the object for a copy with the I<hash> method.
242 sub table { 'cust_main'; }
244 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
246 Adds this customer to the database. If there is an error, returns the error,
247 otherwise returns false.
249 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
250 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
251 are inserted atomicly, or the transaction is rolled back. Passing an empty
252 hash reference is equivalent to not supplying this parameter. There should be
253 a better explanation of this, but until then, here's an example:
256 tie %hash, 'Tie::RefHash'; #this part is important
258 $cust_pkg => [ $svc_acct ],
261 $cust_main->insert( \%hash );
263 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
264 be set as the invoicing list (see L<"invoicing_list">). Errors return as
265 expected and rollback the entire transaction; it is not necessary to call
266 check_invoicing_list first. The invoicing_list is set after the records in the
267 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
268 invoicing_list destination to the newly-created svc_acct. Here's an example:
270 $cust_main->insert( {}, [ $email, 'POST' ] );
272 Currently available options are: I<depend_jobnum> and I<noexport>.
274 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
275 on the supplied jobnum (they will not run until the specific job completes).
276 This can be used to defer provisioning until some action completes (such
277 as running the customer's credit card successfully).
279 The I<noexport> option is deprecated. If I<noexport> is set true, no
280 provisioning jobs (exports) are scheduled. (You can schedule them later with
281 the B<reexport> method.)
287 my $cust_pkgs = @_ ? shift : {};
288 my $invoicing_list = @_ ? shift : '';
290 warn "$me insert called with options ".
291 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
294 local $SIG{HUP} = 'IGNORE';
295 local $SIG{INT} = 'IGNORE';
296 local $SIG{QUIT} = 'IGNORE';
297 local $SIG{TERM} = 'IGNORE';
298 local $SIG{TSTP} = 'IGNORE';
299 local $SIG{PIPE} = 'IGNORE';
301 my $oldAutoCommit = $FS::UID::AutoCommit;
302 local $FS::UID::AutoCommit = 0;
305 my $prepay_identifier = '';
306 my( $amount, $seconds ) = ( 0, 0 );
308 if ( $self->payby eq 'PREPAY' ) {
310 $self->payby('BILL');
311 $prepay_identifier = $self->payinfo;
314 warn " looking up prepaid card $prepay_identifier\n"
317 my $error = $self->get_prepay($prepay_identifier, \$amount, \$seconds);
319 $dbh->rollback if $oldAutoCommit;
320 #return "error applying prepaid card (transaction rolled back): $error";
324 $payby = 'PREP' if $amount;
326 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
329 $self->payby('BILL');
330 $amount = $self->paid;
334 warn " inserting $self\n"
337 $self->signupdate(time) unless $self->signupdate;
339 my $error = $self->SUPER::insert;
341 $dbh->rollback if $oldAutoCommit;
342 #return "inserting cust_main record (transaction rolled back): $error";
346 warn " setting invoicing list\n"
349 if ( $invoicing_list ) {
350 $error = $self->check_invoicing_list( $invoicing_list );
352 $dbh->rollback if $oldAutoCommit;
353 #return "checking invoicing_list (transaction rolled back): $error";
356 $self->invoicing_list( $invoicing_list );
359 if ( $conf->config('cust_main-skeleton_tables')
360 && $conf->config('cust_main-skeleton_custnum') ) {
362 warn " inserting skeleton records\n"
365 my $error = $self->start_copy_skel;
367 $dbh->rollback if $oldAutoCommit;
373 warn " ordering packages\n"
376 $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
378 $dbh->rollback if $oldAutoCommit;
383 $dbh->rollback if $oldAutoCommit;
384 return "No svc_acct record to apply pre-paid time";
388 warn " inserting initial $payby payment of $amount\n"
390 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
392 $dbh->rollback if $oldAutoCommit;
393 return "inserting payment (transaction rolled back): $error";
397 unless ( $import || $skip_fuzzyfiles ) {
398 warn " queueing fuzzyfiles update\n"
400 $error = $self->queue_fuzzyfiles_update;
402 $dbh->rollback if $oldAutoCommit;
403 return "updating fuzzy search cache: $error";
407 warn " insert complete; committing transaction\n"
410 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
415 sub start_copy_skel {
418 #'mg_user_preference' => {},
419 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
420 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
421 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
422 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
423 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
426 _copy_skel( 'cust_main', #tablename
427 $conf->config('cust_main-skeleton_custnum'), #sourceid
428 $self->custnum, #destid
429 @tables, #child tables
433 #recursive subroutine, not a method
435 my( $table, $sourceid, $destid, %child_tables ) = @_;
438 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
439 ( $table, $primary_key ) = ( $1, $2 );
441 my $dbdef_table = dbdef->table($table);
442 $primary_key = $dbdef_table->primary_key
443 or return "$table has no primary key".
444 " (or do you need to run dbdef-create?)";
447 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
448 join (', ', keys %child_tables). "\n"
451 foreach my $child_table_def ( keys %child_tables ) {
455 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
456 ( $child_table, $child_pkey ) = ( $1, $2 );
458 $child_table = $child_table_def;
460 $child_pkey = dbdef->table($child_table)->primary_key;
461 # or return "$table has no primary key".
462 # " (or do you need to run dbdef-create?)\n";
466 if ( keys %{ $child_tables{$child_table_def} } ) {
468 return "$child_table has no primary key".
469 " (run dbdef-create or try specifying it?)\n"
472 #false laziness w/Record::insert and only works on Pg
473 #refactor the proper last-inserted-id stuff out of Record::insert if this
474 # ever gets use for anything besides a quick kludge for one customer
475 my $default = dbdef->table($child_table)->column($child_pkey)->default;
476 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
477 or return "can't parse $child_table.$child_pkey default value ".
478 " for sequence name: $default";
483 my @sel_columns = grep { $_ ne $primary_key }
484 dbdef->table($child_table)->columns;
485 my $sel_columns = join(', ', @sel_columns );
487 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
488 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
489 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
491 my $sel_st = "SELECT $sel_columns FROM $child_table".
492 " WHERE $primary_key = $sourceid";
495 my $sel_sth = dbh->prepare( $sel_st )
496 or return dbh->errstr;
498 $sel_sth->execute or return $sel_sth->errstr;
500 while ( my $row = $sel_sth->fetchrow_hashref ) {
502 warn " selected row: ".
503 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
507 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
508 my $ins_sth =dbh->prepare($statement)
509 or return dbh->errstr;
510 my @param = ( $destid, map $row->{$_}, @ins_columns );
511 warn " $statement: [ ". join(', ', @param). " ]\n"
513 $ins_sth->execute( @param )
514 or return $ins_sth->errstr;
516 #next unless keys %{ $child_tables{$child_table} };
517 next unless $sequence;
519 #another section of that laziness
520 my $seq_sql = "SELECT currval('$sequence')";
521 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
522 $seq_sth->execute or return $seq_sth->errstr;
523 my $insertid = $seq_sth->fetchrow_arrayref->[0];
525 # don't drink soap! recurse! recurse! okay!
527 _copy_skel( $child_table_def,
528 $row->{$child_pkey}, #sourceid
530 %{ $child_tables{$child_table_def} },
532 return $error if $error;
542 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
544 Like the insert method on an existing record, this method orders a package
545 and included services atomicaly. Pass a Tie::RefHash data structure to this
546 method containing FS::cust_pkg and FS::svc_I<tablename> objects. There should
547 be a better explanation of this, but until then, here's an example:
550 tie %hash, 'Tie::RefHash'; #this part is important
552 $cust_pkg => [ $svc_acct ],
555 $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
557 Services can be new, in which case they are inserted, or existing unaudited
558 services, in which case they are linked to the newly-created package.
560 Currently available options are: I<depend_jobnum> and I<noexport>.
562 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
563 on the supplied jobnum (they will not run until the specific job completes).
564 This can be used to defer provisioning until some action completes (such
565 as running the customer's credit card successfully).
567 The I<noexport> option is deprecated. If I<noexport> is set true, no
568 provisioning jobs (exports) are scheduled. (You can schedule them later with
569 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
570 on the cust_main object is not recommended, as existing services will also be
577 my $cust_pkgs = shift;
580 my %svc_options = ();
581 $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
582 if exists $options{'depend_jobnum'};
583 warn "$me order_pkgs called with options ".
584 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
587 local $SIG{HUP} = 'IGNORE';
588 local $SIG{INT} = 'IGNORE';
589 local $SIG{QUIT} = 'IGNORE';
590 local $SIG{TERM} = 'IGNORE';
591 local $SIG{TSTP} = 'IGNORE';
592 local $SIG{PIPE} = 'IGNORE';
594 my $oldAutoCommit = $FS::UID::AutoCommit;
595 local $FS::UID::AutoCommit = 0;
598 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
600 foreach my $cust_pkg ( keys %$cust_pkgs ) {
601 $cust_pkg->custnum( $self->custnum );
602 my $error = $cust_pkg->insert;
604 $dbh->rollback if $oldAutoCommit;
605 return "inserting cust_pkg (transaction rolled back): $error";
607 foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
608 if ( $svc_something->svcnum ) {
609 my $old_cust_svc = $svc_something->cust_svc;
610 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
611 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
612 $error = $new_cust_svc->replace($old_cust_svc);
614 $svc_something->pkgnum( $cust_pkg->pkgnum );
615 if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
616 $svc_something->seconds( $svc_something->seconds + $$seconds );
619 $error = $svc_something->insert(%svc_options);
622 $dbh->rollback if $oldAutoCommit;
623 #return "inserting svc_ (transaction rolled back): $error";
629 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
633 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
635 Recharges this (existing) customer with the specified prepaid card (see
636 L<FS::prepay_credit>), specified either by I<identifier> or as an
637 FS::prepay_credit object. If there is an error, returns the error, otherwise
640 Optionally, four scalar references can be passed as well. They will have their
641 values filled in with the amount, number of seconds, and number of upload and
642 download bytes applied by this prepaid
647 sub recharge_prepay {
648 my( $self, $prepay_credit, $amountref, $secondsref,
649 $upbytesref, $downbytesref, $totalbytesref ) = @_;
651 local $SIG{HUP} = 'IGNORE';
652 local $SIG{INT} = 'IGNORE';
653 local $SIG{QUIT} = 'IGNORE';
654 local $SIG{TERM} = 'IGNORE';
655 local $SIG{TSTP} = 'IGNORE';
656 local $SIG{PIPE} = 'IGNORE';
658 my $oldAutoCommit = $FS::UID::AutoCommit;
659 local $FS::UID::AutoCommit = 0;
662 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
664 my $error = $self->get_prepay($prepay_credit, \$amount,
665 \$seconds, \$upbytes, \$downbytes, \$totalbytes)
666 || $self->increment_seconds($seconds)
667 || $self->increment_upbytes($upbytes)
668 || $self->increment_downbytes($downbytes)
669 || $self->increment_totalbytes($totalbytes)
670 || $self->insert_cust_pay_prepay( $amount,
672 ? $prepay_credit->identifier
677 $dbh->rollback if $oldAutoCommit;
681 if ( defined($amountref) ) { $$amountref = $amount; }
682 if ( defined($secondsref) ) { $$secondsref = $seconds; }
683 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
684 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
685 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
687 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
692 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
694 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
695 specified either by I<identifier> or as an FS::prepay_credit object.
697 References to I<amount> and I<seconds> scalars should be passed as arguments
698 and will be incremented by the values of the prepaid card.
700 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
701 check or set this customer's I<agentnum>.
703 If there is an error, returns the error, otherwise returns false.
709 my( $self, $prepay_credit, $amountref, $secondsref,
710 $upref, $downref, $totalref) = @_;
712 local $SIG{HUP} = 'IGNORE';
713 local $SIG{INT} = 'IGNORE';
714 local $SIG{QUIT} = 'IGNORE';
715 local $SIG{TERM} = 'IGNORE';
716 local $SIG{TSTP} = 'IGNORE';
717 local $SIG{PIPE} = 'IGNORE';
719 my $oldAutoCommit = $FS::UID::AutoCommit;
720 local $FS::UID::AutoCommit = 0;
723 unless ( ref($prepay_credit) ) {
725 my $identifier = $prepay_credit;
727 $prepay_credit = qsearchs(
729 { 'identifier' => $prepay_credit },
734 unless ( $prepay_credit ) {
735 $dbh->rollback if $oldAutoCommit;
736 return "Invalid prepaid card: ". $identifier;
741 if ( $prepay_credit->agentnum ) {
742 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
743 $dbh->rollback if $oldAutoCommit;
744 return "prepaid card not valid for agent ". $self->agentnum;
746 $self->agentnum($prepay_credit->agentnum);
749 my $error = $prepay_credit->delete;
751 $dbh->rollback if $oldAutoCommit;
752 return "removing prepay_credit (transaction rolled back): $error";
755 $$amountref += $prepay_credit->amount;
756 $$secondsref += $prepay_credit->seconds;
757 $$upref += $prepay_credit->upbytes;
758 $$downref += $prepay_credit->downbytes;
759 $$totalref += $prepay_credit->totalbytes;
761 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
766 =item increment_upbytes SECONDS
768 Updates this customer's single or primary account (see L<FS::svc_acct>) by
769 the specified number of upbytes. If there is an error, returns the error,
770 otherwise returns false.
774 sub increment_upbytes {
775 _increment_column( shift, 'upbytes', @_);
778 =item increment_downbytes SECONDS
780 Updates this customer's single or primary account (see L<FS::svc_acct>) by
781 the specified number of downbytes. If there is an error, returns the error,
782 otherwise returns false.
786 sub increment_downbytes {
787 _increment_column( shift, 'downbytes', @_);
790 =item increment_totalbytes SECONDS
792 Updates this customer's single or primary account (see L<FS::svc_acct>) by
793 the specified number of totalbytes. If there is an error, returns the error,
794 otherwise returns false.
798 sub increment_totalbytes {
799 _increment_column( shift, 'totalbytes', @_);
802 =item increment_seconds SECONDS
804 Updates this customer's single or primary account (see L<FS::svc_acct>) by
805 the specified number of seconds. If there is an error, returns the error,
806 otherwise returns false.
810 sub increment_seconds {
811 _increment_column( shift, 'seconds', @_);
814 =item _increment_column AMOUNT
816 Updates this customer's single or primary account (see L<FS::svc_acct>) by
817 the specified number of seconds or bytes. If there is an error, returns
818 the error, otherwise returns false.
822 sub _increment_column {
823 my( $self, $column, $amount ) = @_;
824 warn "$me increment_column called: $column, $amount\n"
827 return '' unless $amount;
829 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
830 $self->ncancelled_pkgs;
833 return 'No packages with primary or single services found'.
834 ' to apply pre-paid time';
835 } elsif ( scalar(@cust_pkg) > 1 ) {
836 #maybe have a way to specify the package/account?
837 return 'Multiple packages found to apply pre-paid time';
840 my $cust_pkg = $cust_pkg[0];
841 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
845 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
848 return 'No account found to apply pre-paid time';
849 } elsif ( scalar(@cust_svc) > 1 ) {
850 return 'Multiple accounts found to apply pre-paid time';
853 my $svc_acct = $cust_svc[0]->svc_x;
854 warn " found service svcnum ". $svc_acct->pkgnum.
855 ' ('. $svc_acct->email. ")\n"
858 $column = "increment_$column";
859 $svc_acct->$column($amount);
863 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
865 Inserts a prepayment in the specified amount for this customer. An optional
866 second argument can specify the prepayment identifier for tracking purposes.
867 If there is an error, returns the error, otherwise returns false.
871 sub insert_cust_pay_prepay {
872 shift->insert_cust_pay('PREP', @_);
875 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
877 Inserts a cash payment in the specified amount for this customer. An optional
878 second argument can specify the payment identifier for tracking purposes.
879 If there is an error, returns the error, otherwise returns false.
883 sub insert_cust_pay_cash {
884 shift->insert_cust_pay('CASH', @_);
887 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
889 Inserts a Western Union payment in the specified amount for this customer. An
890 optional second argument can specify the prepayment identifier for tracking
891 purposes. If there is an error, returns the error, otherwise returns false.
895 sub insert_cust_pay_west {
896 shift->insert_cust_pay('WEST', @_);
899 sub insert_cust_pay {
900 my( $self, $payby, $amount ) = splice(@_, 0, 3);
901 my $payinfo = scalar(@_) ? shift : '';
903 my $cust_pay = new FS::cust_pay {
904 'custnum' => $self->custnum,
905 'paid' => sprintf('%.2f', $amount),
906 #'_date' => #date the prepaid card was purchased???
908 'payinfo' => $payinfo,
916 This method is deprecated. See the I<depend_jobnum> option to the insert and
917 order_pkgs methods for a better way to defer provisioning.
919 Re-schedules all exports by calling the B<reexport> method of all associated
920 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
921 otherwise returns false.
928 carp "WARNING: FS::cust_main::reexport is deprectated; ".
929 "use the depend_jobnum option to insert or order_pkgs to delay export";
931 local $SIG{HUP} = 'IGNORE';
932 local $SIG{INT} = 'IGNORE';
933 local $SIG{QUIT} = 'IGNORE';
934 local $SIG{TERM} = 'IGNORE';
935 local $SIG{TSTP} = 'IGNORE';
936 local $SIG{PIPE} = 'IGNORE';
938 my $oldAutoCommit = $FS::UID::AutoCommit;
939 local $FS::UID::AutoCommit = 0;
942 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
943 my $error = $cust_pkg->reexport;
945 $dbh->rollback if $oldAutoCommit;
950 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
955 =item delete NEW_CUSTNUM
957 This deletes the customer. If there is an error, returns the error, otherwise
960 This will completely remove all traces of the customer record. This is not
961 what you want when a customer cancels service; for that, cancel all of the
962 customer's packages (see L</cancel>).
964 If the customer has any uncancelled packages, you need to pass a new (valid)
965 customer number for those packages to be transferred to. Cancelled packages
966 will be deleted. Did I mention that this is NOT what you want when a customer
967 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
969 You can't delete a customer with invoices (see L<FS::cust_bill>),
970 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
971 refunds (see L<FS::cust_refund>).
978 local $SIG{HUP} = 'IGNORE';
979 local $SIG{INT} = 'IGNORE';
980 local $SIG{QUIT} = 'IGNORE';
981 local $SIG{TERM} = 'IGNORE';
982 local $SIG{TSTP} = 'IGNORE';
983 local $SIG{PIPE} = 'IGNORE';
985 my $oldAutoCommit = $FS::UID::AutoCommit;
986 local $FS::UID::AutoCommit = 0;
989 if ( $self->cust_bill ) {
990 $dbh->rollback if $oldAutoCommit;
991 return "Can't delete a customer with invoices";
993 if ( $self->cust_credit ) {
994 $dbh->rollback if $oldAutoCommit;
995 return "Can't delete a customer with credits";
997 if ( $self->cust_pay ) {
998 $dbh->rollback if $oldAutoCommit;
999 return "Can't delete a customer with payments";
1001 if ( $self->cust_refund ) {
1002 $dbh->rollback if $oldAutoCommit;
1003 return "Can't delete a customer with refunds";
1006 my @cust_pkg = $self->ncancelled_pkgs;
1008 my $new_custnum = shift;
1009 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1010 $dbh->rollback if $oldAutoCommit;
1011 return "Invalid new customer number: $new_custnum";
1013 foreach my $cust_pkg ( @cust_pkg ) {
1014 my %hash = $cust_pkg->hash;
1015 $hash{'custnum'} = $new_custnum;
1016 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1017 my $error = $new_cust_pkg->replace($cust_pkg,
1018 options => { $cust_pkg->options },
1021 $dbh->rollback if $oldAutoCommit;
1026 my @cancelled_cust_pkg = $self->all_pkgs;
1027 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1028 my $error = $cust_pkg->delete;
1030 $dbh->rollback if $oldAutoCommit;
1035 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1036 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1038 my $error = $cust_main_invoice->delete;
1040 $dbh->rollback if $oldAutoCommit;
1045 my $error = $self->SUPER::delete;
1047 $dbh->rollback if $oldAutoCommit;
1051 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1056 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ]
1058 Replaces the OLD_RECORD with this one in the database. If there is an error,
1059 returns the error, otherwise returns false.
1061 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1062 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1063 expected and rollback the entire transaction; it is not necessary to call
1064 check_invoicing_list first. Here's an example:
1066 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1073 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1075 : $self->replace_old;
1079 warn "$me replace called\n"
1082 my $curuser = $FS::CurrentUser::CurrentUser;
1083 if ( $self->payby eq 'COMP'
1084 && $self->payby ne $old->payby
1085 && ! $curuser->access_right('Complimentary customer')
1088 return "You are not permitted to create complimentary accounts.";
1091 local($ignore_expired_card) = 1
1092 if $old->payby =~ /^(CARD|DCRD)$/
1093 && $self->payby =~ /^(CARD|DCRD)$/
1094 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1096 local $SIG{HUP} = 'IGNORE';
1097 local $SIG{INT} = 'IGNORE';
1098 local $SIG{QUIT} = 'IGNORE';
1099 local $SIG{TERM} = 'IGNORE';
1100 local $SIG{TSTP} = 'IGNORE';
1101 local $SIG{PIPE} = 'IGNORE';
1103 my $oldAutoCommit = $FS::UID::AutoCommit;
1104 local $FS::UID::AutoCommit = 0;
1107 my $error = $self->SUPER::replace($old);
1110 $dbh->rollback if $oldAutoCommit;
1114 if ( @param ) { # INVOICING_LIST_ARYREF
1115 my $invoicing_list = shift @param;
1116 $error = $self->check_invoicing_list( $invoicing_list );
1118 $dbh->rollback if $oldAutoCommit;
1121 $self->invoicing_list( $invoicing_list );
1124 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1125 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1126 # card/check/lec info has changed, want to retry realtime_ invoice events
1127 my $error = $self->retry_realtime;
1129 $dbh->rollback if $oldAutoCommit;
1134 unless ( $import || $skip_fuzzyfiles ) {
1135 $error = $self->queue_fuzzyfiles_update;
1137 $dbh->rollback if $oldAutoCommit;
1138 return "updating fuzzy search cache: $error";
1142 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1147 =item queue_fuzzyfiles_update
1149 Used by insert & replace to update the fuzzy search cache
1153 sub queue_fuzzyfiles_update {
1156 local $SIG{HUP} = 'IGNORE';
1157 local $SIG{INT} = 'IGNORE';
1158 local $SIG{QUIT} = 'IGNORE';
1159 local $SIG{TERM} = 'IGNORE';
1160 local $SIG{TSTP} = 'IGNORE';
1161 local $SIG{PIPE} = 'IGNORE';
1163 my $oldAutoCommit = $FS::UID::AutoCommit;
1164 local $FS::UID::AutoCommit = 0;
1167 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1168 my $error = $queue->insert( map $self->getfield($_),
1169 qw(first last company)
1172 $dbh->rollback if $oldAutoCommit;
1173 return "queueing job (transaction rolled back): $error";
1176 if ( $self->ship_last ) {
1177 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1178 $error = $queue->insert( map $self->getfield("ship_$_"),
1179 qw(first last company)
1182 $dbh->rollback if $oldAutoCommit;
1183 return "queueing job (transaction rolled back): $error";
1187 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1194 Checks all fields to make sure this is a valid customer record. If there is
1195 an error, returns the error, otherwise returns false. Called by the insert
1196 and replace methods.
1203 warn "$me check BEFORE: \n". $self->_dump
1207 $self->ut_numbern('custnum')
1208 || $self->ut_number('agentnum')
1209 || $self->ut_textn('agent_custid')
1210 || $self->ut_number('refnum')
1211 || $self->ut_name('last')
1212 || $self->ut_name('first')
1213 || $self->ut_snumbern('birthdate')
1214 || $self->ut_snumbern('signupdate')
1215 || $self->ut_textn('company')
1216 || $self->ut_text('address1')
1217 || $self->ut_textn('address2')
1218 || $self->ut_text('city')
1219 || $self->ut_textn('county')
1220 || $self->ut_textn('state')
1221 || $self->ut_country('country')
1222 || $self->ut_anything('comments')
1223 || $self->ut_numbern('referral_custnum')
1224 || $self->ut_textn('stateid')
1225 || $self->ut_textn('stateid_state')
1226 || $self->ut_textn('invoice_terms')
1228 #barf. need message catalogs. i18n. etc.
1229 $error .= "Please select an advertising source."
1230 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1231 return $error if $error;
1233 return "Unknown agent"
1234 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1236 return "Unknown refnum"
1237 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1239 return "Unknown referring custnum: ". $self->referral_custnum
1240 unless ! $self->referral_custnum
1241 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1243 if ( $self->ss eq '' ) {
1248 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1249 or return "Illegal social security number: ". $self->ss;
1250 $self->ss("$1-$2-$3");
1254 # bad idea to disable, causes billing to fail because of no tax rates later
1255 # unless ( $import ) {
1256 unless ( qsearch('cust_main_county', {
1257 'country' => $self->country,
1260 return "Unknown state/county/country: ".
1261 $self->state. "/". $self->county. "/". $self->country
1262 unless qsearch('cust_main_county',{
1263 'state' => $self->state,
1264 'county' => $self->county,
1265 'country' => $self->country,
1271 $self->ut_phonen('daytime', $self->country)
1272 || $self->ut_phonen('night', $self->country)
1273 || $self->ut_phonen('fax', $self->country)
1274 || $self->ut_zip('zip', $self->country)
1276 return $error if $error;
1278 if ( $conf->exists('cust_main-require_phone')
1279 && ! length($self->daytime) && ! length($self->night)
1282 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1284 : FS::Msgcat::_gettext('daytime');
1285 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1287 : FS::Msgcat::_gettext('night');
1289 return "$daytime_label or $night_label is required"
1293 if ( $self->has_ship_address
1294 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1295 $self->addr_fields )
1299 $self->ut_name('ship_last')
1300 || $self->ut_name('ship_first')
1301 || $self->ut_textn('ship_company')
1302 || $self->ut_text('ship_address1')
1303 || $self->ut_textn('ship_address2')
1304 || $self->ut_text('ship_city')
1305 || $self->ut_textn('ship_county')
1306 || $self->ut_textn('ship_state')
1307 || $self->ut_country('ship_country')
1309 return $error if $error;
1311 #false laziness with above
1312 unless ( qsearchs('cust_main_county', {
1313 'country' => $self->ship_country,
1316 return "Unknown ship_state/ship_county/ship_country: ".
1317 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1318 unless qsearch('cust_main_county',{
1319 'state' => $self->ship_state,
1320 'county' => $self->ship_county,
1321 'country' => $self->ship_country,
1327 $self->ut_phonen('ship_daytime', $self->ship_country)
1328 || $self->ut_phonen('ship_night', $self->ship_country)
1329 || $self->ut_phonen('ship_fax', $self->ship_country)
1330 || $self->ut_zip('ship_zip', $self->ship_country)
1332 return $error if $error;
1334 return "Unit # is required."
1335 if $self->ship_address2 =~ /^\s*$/
1336 && $conf->exists('cust_main-require_address2');
1338 } else { # ship_ info eq billing info, so don't store dup info in database
1340 $self->setfield("ship_$_", '')
1341 foreach $self->addr_fields;
1343 return "Unit # is required."
1344 if $self->address2 =~ /^\s*$/
1345 && $conf->exists('cust_main-require_address2');
1349 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1350 # or return "Illegal payby: ". $self->payby;
1352 FS::payby->can_payby($self->table, $self->payby)
1353 or return "Illegal payby: ". $self->payby;
1355 $error = $self->ut_numbern('paystart_month')
1356 || $self->ut_numbern('paystart_year')
1357 || $self->ut_numbern('payissue')
1358 || $self->ut_textn('paytype')
1360 return $error if $error;
1362 if ( $self->payip eq '' ) {
1365 $error = $self->ut_ip('payip');
1366 return $error if $error;
1369 # If it is encrypted and the private key is not availaible then we can't
1370 # check the credit card.
1372 my $check_payinfo = 1;
1374 if ($self->is_encrypted($self->payinfo)) {
1378 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1380 my $payinfo = $self->payinfo;
1381 $payinfo =~ s/\D//g;
1382 $payinfo =~ /^(\d{13,16})$/
1383 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1385 $self->payinfo($payinfo);
1387 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1389 return gettext('unknown_card_type')
1390 if cardtype($self->payinfo) eq "Unknown";
1392 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1394 return 'Banned credit card: banned on '.
1395 time2str('%a %h %o at %r', $ban->_date).
1396 ' by '. $ban->otaker.
1397 ' (ban# '. $ban->bannum. ')';
1400 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1401 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1402 $self->paycvv =~ /^(\d{4})$/
1403 or return "CVV2 (CID) for American Express cards is four digits.";
1406 $self->paycvv =~ /^(\d{3})$/
1407 or return "CVV2 (CVC2/CID) is three digits.";
1414 my $cardtype = cardtype($payinfo);
1415 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1417 return "Start date or issue number is required for $cardtype cards"
1418 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1420 return "Start month must be between 1 and 12"
1421 if $self->paystart_month
1422 and $self->paystart_month < 1 || $self->paystart_month > 12;
1424 return "Start year must be 1990 or later"
1425 if $self->paystart_year
1426 and $self->paystart_year < 1990;
1428 return "Issue number must be beween 1 and 99"
1430 and $self->payissue < 1 || $self->payissue > 99;
1433 $self->paystart_month('');
1434 $self->paystart_year('');
1435 $self->payissue('');
1438 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1440 my $payinfo = $self->payinfo;
1441 $payinfo =~ s/[^\d\@]//g;
1442 if ( $conf->exists('echeck-nonus') ) {
1443 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1444 $payinfo = "$1\@$2";
1446 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1447 $payinfo = "$1\@$2";
1449 $self->payinfo($payinfo);
1452 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1454 return 'Banned ACH account: banned on '.
1455 time2str('%a %h %o at %r', $ban->_date).
1456 ' by '. $ban->otaker.
1457 ' (ban# '. $ban->bannum. ')';
1460 } elsif ( $self->payby eq 'LECB' ) {
1462 my $payinfo = $self->payinfo;
1463 $payinfo =~ s/\D//g;
1464 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1466 $self->payinfo($payinfo);
1469 } elsif ( $self->payby eq 'BILL' ) {
1471 $error = $self->ut_textn('payinfo');
1472 return "Illegal P.O. number: ". $self->payinfo if $error;
1475 } elsif ( $self->payby eq 'COMP' ) {
1477 my $curuser = $FS::CurrentUser::CurrentUser;
1478 if ( ! $self->custnum
1479 && ! $curuser->access_right('Complimentary customer')
1482 return "You are not permitted to create complimentary accounts."
1485 $error = $self->ut_textn('payinfo');
1486 return "Illegal comp account issuer: ". $self->payinfo if $error;
1489 } elsif ( $self->payby eq 'PREPAY' ) {
1491 my $payinfo = $self->payinfo;
1492 $payinfo =~ s/\W//g; #anything else would just confuse things
1493 $self->payinfo($payinfo);
1494 $error = $self->ut_alpha('payinfo');
1495 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1496 return "Unknown prepayment identifier"
1497 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1502 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1503 return "Expiration date required"
1504 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1508 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1509 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1510 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1511 ( $m, $y ) = ( $3, "20$2" );
1513 return "Illegal expiration date: ". $self->paydate;
1515 $self->paydate("$y-$m-01");
1516 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1517 return gettext('expired_card')
1519 && !$ignore_expired_card
1520 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1523 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1524 ( ! $conf->exists('require_cardname')
1525 || $self->payby !~ /^(CARD|DCRD)$/ )
1527 $self->payname( $self->first. " ". $self->getfield('last') );
1529 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1530 or return gettext('illegal_name'). " payname: ". $self->payname;
1534 foreach my $flag (qw( tax spool_cdr )) {
1535 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1539 $self->otaker(getotaker) unless $self->otaker;
1541 warn "$me check AFTER: \n". $self->_dump
1544 $self->SUPER::check;
1549 Returns a list of fields which have ship_ duplicates.
1554 qw( last first company
1555 address1 address2 city county state zip country
1560 =item has_ship_address
1562 Returns true if this customer record has a separate shipping address.
1566 sub has_ship_address {
1568 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1573 Returns all packages (see L<FS::cust_pkg>) for this customer.
1580 return $self->num_pkgs unless wantarray;
1583 if ( $self->{'_pkgnum'} ) {
1584 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1586 @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1589 sort sort_packages @cust_pkg;
1594 Synonym for B<all_pkgs>.
1599 shift->all_pkgs(@_);
1602 =item ncancelled_pkgs
1604 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1608 sub ncancelled_pkgs {
1611 return $self->num_ncancelled_pkgs unless wantarray;
1614 if ( $self->{'_pkgnum'} ) {
1616 warn "$me ncancelled_pkgs: returning cached objects"
1619 @cust_pkg = grep { ! $_->getfield('cancel') }
1620 values %{ $self->{'_pkgnum'}->cache };
1624 warn "$me ncancelled_pkgs: searching for packages with custnum ".
1625 $self->custnum. "\n"
1629 qsearch( 'cust_pkg', {
1630 'custnum' => $self->custnum,
1634 qsearch( 'cust_pkg', {
1635 'custnum' => $self->custnum,
1640 sort sort_packages @cust_pkg;
1644 # This should be generalized to use config options to determine order.
1646 if ( $a->get('cancel') and $b->get('cancel') ) {
1647 $a->pkgnum <=> $b->pkgnum;
1648 } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1649 return -1 if $b->get('cancel');
1650 return 1 if $a->get('cancel');
1653 $a->pkgnum <=> $b->pkgnum;
1657 =item suspended_pkgs
1659 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1663 sub suspended_pkgs {
1665 grep { $_->susp } $self->ncancelled_pkgs;
1668 =item unflagged_suspended_pkgs
1670 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1671 customer (thouse packages without the `manual_flag' set).
1675 sub unflagged_suspended_pkgs {
1677 return $self->suspended_pkgs
1678 unless dbdef->table('cust_pkg')->column('manual_flag');
1679 grep { ! $_->manual_flag } $self->suspended_pkgs;
1682 =item unsuspended_pkgs
1684 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1689 sub unsuspended_pkgs {
1691 grep { ! $_->susp } $self->ncancelled_pkgs;
1694 =item num_cancelled_pkgs
1696 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1701 sub num_cancelled_pkgs {
1702 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1705 sub num_ncancelled_pkgs {
1706 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1710 my( $self ) = shift;
1711 my $sql = scalar(@_) ? shift : '';
1712 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1713 my $sth = dbh->prepare(
1714 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1715 ) or die dbh->errstr;
1716 $sth->execute($self->custnum) or die $sth->errstr;
1717 $sth->fetchrow_arrayref->[0];
1722 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1723 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
1724 on success or a list of errors.
1730 grep { $_->unsuspend } $self->suspended_pkgs;
1735 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1737 Returns a list: an empty list on success or a list of errors.
1743 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1746 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1748 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1749 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
1750 of a list of pkgparts; the hashref has the following keys:
1754 =item pkgparts - listref of pkgparts
1756 =item (other options are passed to the suspend method)
1761 Returns a list: an empty list on success or a list of errors.
1765 sub suspend_if_pkgpart {
1767 my (@pkgparts, %opt);
1768 if (ref($_[0]) eq 'HASH'){
1769 @pkgparts = @{$_[0]{pkgparts}};
1774 grep { $_->suspend(%opt) }
1775 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1776 $self->unsuspended_pkgs;
1779 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1781 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1782 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
1783 instead of a list of pkgparts; the hashref has the following keys:
1787 =item pkgparts - listref of pkgparts
1789 =item (other options are passed to the suspend method)
1793 Returns a list: an empty list on success or a list of errors.
1797 sub suspend_unless_pkgpart {
1799 my (@pkgparts, %opt);
1800 if (ref($_[0]) eq 'HASH'){
1801 @pkgparts = @{$_[0]{pkgparts}};
1806 grep { $_->suspend(%opt) }
1807 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1808 $self->unsuspended_pkgs;
1811 =item cancel [ OPTION => VALUE ... ]
1813 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1815 Available options are:
1819 =item quiet - can be set true to supress email cancellation notices.
1821 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
1823 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
1827 Always returns a list: an empty list on success or a list of errors.
1832 my( $self, %opt ) = @_;
1834 warn "$me cancel called on customer ". $self->custnum. " with options ".
1835 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
1838 return ( 'access denied' )
1839 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
1841 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1843 #should try decryption (we might have the private key)
1844 # and if not maybe queue a job for the server that does?
1845 return ( "Can't (yet) ban encrypted credit cards" )
1846 if $self->is_encrypted($self->payinfo);
1848 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1849 my $error = $ban->insert;
1850 return ( $error ) if $error;
1854 my @pkgs = $self->ncancelled_pkgs;
1856 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
1857 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
1860 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
1863 sub _banned_pay_hashref {
1874 'payby' => $payby2ban{$self->payby},
1875 'payinfo' => md5_base64($self->payinfo),
1876 #don't ever *search* on reason! #'reason' =>
1882 Returns all notes (see L<FS::cust_main_note>) for this customer.
1889 qsearch( 'cust_main_note',
1890 { 'custnum' => $self->custnum },
1892 'ORDER BY _DATE DESC'
1898 Returns the agent (see L<FS::agent>) for this customer.
1904 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1907 =item bill_and_collect
1909 Cancels and suspends any packages due, generates bills, applies payments and
1912 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
1914 Options are passed as name-value pairs. Currently available options are:
1920 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
1924 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1928 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
1932 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1936 If set true, re-charges setup fees.
1940 Debugging level. Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
1946 sub bill_and_collect {
1947 my( $self, %options ) = @_;
1953 #$options{actual_time} not $options{time} because freeside-daily -d is for
1954 #pre-printing invoices
1955 my @cancel_pkgs = grep { $_->expire && $_->expire <= $options{actual_time} }
1956 $self->ncancelled_pkgs;
1958 foreach my $cust_pkg ( @cancel_pkgs ) {
1959 my $error = $cust_pkg->cancel;
1960 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
1961 " for custnum ". $self->custnum. ": $error"
1969 #$options{actual_time} not $options{time} because freeside-daily -d is for
1970 #pre-printing invoices
1973 && ( ( $_->part_pkg->is_prepaid
1975 && $_->bill < $options{actual_time}
1978 && $_->adjourn <= $options{actual_time}
1982 $self->ncancelled_pkgs;
1984 foreach my $cust_pkg ( @susp_pkgs ) {
1985 my $error = $cust_pkg->suspend;
1986 warn "Error suspending package ". $cust_pkg->pkgnum.
1987 " for custnum ". $self->custnum. ": $error"
1995 my $error = $self->bill( %options );
1996 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
1998 $self->apply_payments_and_credits;
2000 $error = $self->collect( %options );
2001 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
2007 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2008 conjunction with the collect method by calling B<bill_and_collect>.
2010 If there is an error, returns the error, otherwise returns false.
2012 Options are passed as name-value pairs. Currently available options are:
2018 If set true, re-charges setup fees.
2022 Bills the customer as if it were that time. Specified as a UNIX timestamp; see L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion functions. For example:
2026 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2030 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2032 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2036 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices. Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
2043 my( $self, %options ) = @_;
2044 return '' if $self->payby eq 'COMP';
2045 warn "$me bill customer ". $self->custnum. "\n"
2048 my $time = $options{'time'} || time;
2051 local $SIG{HUP} = 'IGNORE';
2052 local $SIG{INT} = 'IGNORE';
2053 local $SIG{QUIT} = 'IGNORE';
2054 local $SIG{TERM} = 'IGNORE';
2055 local $SIG{TSTP} = 'IGNORE';
2056 local $SIG{PIPE} = 'IGNORE';
2058 my $oldAutoCommit = $FS::UID::AutoCommit;
2059 local $FS::UID::AutoCommit = 0;
2062 $self->select_for_update; #mutex
2064 my @cust_bill_pkg = ();
2067 # find the packages which are due for billing, find out how much they are
2068 # & generate invoice database.
2071 my( $total_setup, $total_recur ) = ( 0, 0 );
2075 my @precommit_hooks = ();
2077 foreach my $cust_pkg (
2078 qsearch('cust_pkg', { 'custnum' => $self->custnum } )
2081 #NO!! next if $cust_pkg->cancel;
2082 next if $cust_pkg->getfield('cancel');
2084 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2086 #? to avoid use of uninitialized value errors... ?
2087 $cust_pkg->setfield('bill', '')
2088 unless defined($cust_pkg->bill);
2090 #my $part_pkg = $cust_pkg->part_pkg;
2092 my $real_pkgpart = $cust_pkg->pkgpart;
2093 my %hash = $cust_pkg->hash;
2094 my $old_cust_pkg = new FS::cust_pkg \%hash;
2096 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2098 $cust_pkg->pkgpart($part_pkg->pkgpart);
2099 $cust_pkg->set($_, $hash{$_}) foreach qw( setup last_bill bill );
2110 if ( ! $cust_pkg->setup &&
2112 ( $conf->exists('disable_setup_suspended_pkgs') &&
2113 ! $cust_pkg->getfield('susp')
2114 ) || ! $conf->exists('disable_setup_suspended_pkgs')
2116 || $options{'resetup'}
2119 warn " bill setup\n" if $DEBUG > 1;
2122 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2124 $dbh->rollback if $oldAutoCommit;
2125 return "$@ running calc_setup for $cust_pkg\n";
2128 $cust_pkg->setfield('setup', $time)
2129 unless $cust_pkg->setup;
2130 #do need it, but it won't get written to the db
2131 #|| $cust_pkg->pkgpart != $real_pkgpart;
2136 # bill recurring fee
2141 if ( $part_pkg->getfield('freq') ne '0' &&
2142 ! $cust_pkg->getfield('susp') &&
2143 ( $cust_pkg->getfield('bill') || 0 ) <= $time
2146 # XXX should this be a package event? probably. events are called
2147 # at collection time at the moment, though...
2148 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
2149 if $part_pkg->can('reset_usage');
2150 #don't want to reset usage just cause we want a line item??
2151 #&& $part_pkg->pkgpart == $real_pkgpart;
2153 warn " bill recur\n" if $DEBUG > 1;
2156 # XXX shared with $recur_prog
2157 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2159 #over two params! lets at least switch to a hashref for the rest...
2160 my %param = ( 'precommit_hooks' => \@precommit_hooks, );
2162 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2164 $dbh->rollback if $oldAutoCommit;
2165 return "$@ running calc_recur for $cust_pkg\n";
2169 #change this bit to use Date::Manip? CAREFUL with timezones (see
2170 # mailing list archive)
2171 my ($sec,$min,$hour,$mday,$mon,$year) =
2172 (localtime($sdate) )[0,1,2,3,4,5];
2174 #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2175 # only for figuring next bill date, nothing else, so, reset $sdate again
2177 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2178 $cust_pkg->last_bill($sdate);
2180 if ( $part_pkg->freq =~ /^\d+$/ ) {
2181 $mon += $part_pkg->freq;
2182 until ( $mon < 12 ) { $mon -= 12; $year++; }
2183 } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2185 $mday += $weeks * 7;
2186 } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2189 } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2193 $dbh->rollback if $oldAutoCommit;
2194 return "unparsable frequency: ". $part_pkg->freq;
2196 $cust_pkg->setfield('bill',
2197 timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2201 warn "\$setup is undefined" unless defined($setup);
2202 warn "\$recur is undefined" unless defined($recur);
2203 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2206 # If there's line items, create em cust_bill_pkg records
2207 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
2212 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
2213 # hmm.. and if just the options are modified in some weird price plan?
2215 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2218 my $error = $cust_pkg->replace( $old_cust_pkg,
2219 'options' => { $cust_pkg->options },
2221 if ( $error ) { #just in case
2222 $dbh->rollback if $oldAutoCommit;
2223 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2227 $setup = sprintf( "%.2f", $setup );
2228 $recur = sprintf( "%.2f", $recur );
2229 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2230 $dbh->rollback if $oldAutoCommit;
2231 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2233 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2234 $dbh->rollback if $oldAutoCommit;
2235 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2238 if ( $setup != 0 || $recur != 0 ) {
2240 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2242 my $cust_bill_pkg = new FS::cust_bill_pkg {
2243 'pkgnum' => $cust_pkg->pkgnum,
2247 'edate' => $cust_pkg->bill,
2248 'details' => \@details,
2250 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
2251 unless $part_pkg->pkgpart == $real_pkgpart;
2252 push @cust_bill_pkg, $cust_bill_pkg;
2254 $total_setup += $setup;
2255 $total_recur += $recur;
2261 unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2264 my @taxoverrides = $part_pkg->part_pkg_taxoverride;
2267 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2271 if ( $conf->exists('enable_taxproducts')
2272 && (scalar(@taxoverrides) || $part_pkg->taxproductnum )
2276 my @taxclassnums = ();
2277 my $geocode = $self->geocode('cch');
2279 if ( scalar( @taxoverrides ) ) {
2280 @taxclassnums = map { $_->taxclassnum } @taxoverrides;
2281 }elsif ( $part_pkg->taxproductnum ) {
2282 @taxclassnums = map { $_->taxclassnum }
2283 $part_pkg->part_pkg_taxrate('cch', $geocode);
2288 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
2290 @taxes = qsearch({ 'table' => 'tax_rate',
2291 'hashref' => { 'geocode' => $geocode, },
2292 'extra_sql' => $extra_sql,
2294 if scalar(@taxclassnums);
2299 my %taxhash = map { $_ => $self->get("$prefix$_") }
2300 qw( state county country );
2302 $taxhash{'taxclass'} = $part_pkg->taxclass;
2304 @taxes = qsearch( 'cust_main_county', \%taxhash );
2307 $taxhash{'taxclass'} = '';
2308 @taxes = qsearch( 'cust_main_county', \%taxhash );
2311 #one more try at a whole-country tax rate
2313 $taxhash{$_} = '' foreach qw( state county );
2314 @taxes = qsearch( 'cust_main_county', \%taxhash );
2317 } #if $conf->exists('enable_taxproducts')
2319 # maybe eliminate this entirely, along with all the 0% records
2321 $dbh->rollback if $oldAutoCommit;
2323 if ( $conf->exists('enable_taxproducts') ) {
2325 "fatal: can't find tax rate for zip/taxproduct/pkgpart ".
2326 join('/', ( map $self->get("$prefix$_"),
2329 $part_pkg->taxproduct_description,
2330 $part_pkg->pkgpart ). "\n";
2333 "fatal: can't find tax rate for state/county/country/taxclass ".
2334 join('/', ( map $self->get("$prefix$_"),
2335 qw(state county country)
2337 $part_pkg->taxclass ). "\n";
2342 foreach my $tax ( @taxes ) {
2343 my $taxname = ref( $tax ). ' '. $tax->taxnum;
2344 if ( exists( $taxlisthash{ $taxname } ) ) {
2345 push @{ $taxlisthash{ $taxname } }, $cust_bill_pkg;
2347 $taxlisthash{ $taxname } = [ $tax, $cust_bill_pkg ];
2352 } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2354 } #if $setup != 0 || $recur != 0
2356 } #if $cust_pkg->modified
2358 } #foreach my $part_pkg
2360 } #foreach my $cust_pkg
2362 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2363 #but do commit any package date cycling that happened
2364 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2368 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2369 foreach my $tax ( keys %taxlisthash ) {
2370 my $tax_object = shift @{ $taxlisthash{$tax} };
2371 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2372 my $listref_or_error = $tax_object->taxline( @{ $taxlisthash{$tax} } );
2373 unless (ref($listref_or_error)) {
2374 $dbh->rollback if $oldAutoCommit;
2375 return $listref_or_error;
2377 unshift @{ $taxlisthash{$tax} }, $tax_object;
2379 warn "adding ". $listref_or_error->[1].
2380 " as ". $listref_or_error->[0]. "\n"
2382 $tax{ $tax_object->taxname } += $listref_or_error->[1];
2383 if ( $taxname{ $listref_or_error->[0] } ) {
2384 push @{ $taxname{ $listref_or_error->[0] } }, $tax_object->taxname;
2386 $taxname{ $listref_or_error->[0] } = [ $tax_object->taxname ];
2391 #some taxes are taxed
2394 warn "finding taxed taxes...\n" if $DEBUG > 2;
2395 foreach my $tax ( keys %taxlisthash ) {
2396 my $tax_object = shift @{ $taxlisthash{$tax} };
2397 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
2399 next unless $tax_object->can('tax_on_tax');
2401 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
2402 my $totname = ref( $tot ). ' '. $tot->taxnum;
2404 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
2406 next unless exists( $taxlisthash{ $totname } ); # only increase
2408 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
2409 if ( exists( $totlisthash{ $totname } ) ) {
2410 push @{ $totlisthash{ $totname } }, $tax{ $tax_object->taxname };
2412 $totlisthash{ $totname } = [ $tot, $tax{ $tax_object->taxname } ];
2417 warn "having a look at taxed taxes...\n" if $DEBUG > 2;
2418 foreach my $tax ( keys %totlisthash ) {
2419 my $tax_object = shift @{ $totlisthash{$tax} };
2420 warn "found previously found taxed tax ". $tax_object->taxname. "\n"
2422 my $listref_or_error = $tax_object->taxline( @{ $totlisthash{$tax} } );
2423 unless (ref($listref_or_error)) {
2424 $dbh->rollback if $oldAutoCommit;
2425 return $listref_or_error;
2428 warn "adding taxed tax amount ". $listref_or_error->[1].
2429 " as ". $tax_object->taxname. "\n"
2431 $tax{ $tax_object->taxname } += $listref_or_error->[1];
2434 #consolidate and create tax line items
2435 warn "consolidating and generating...\n" if $DEBUG > 2;
2436 foreach my $taxname ( keys %taxname ) {
2439 warn "adding $taxname\n" if $DEBUG > 1;
2440 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2441 $tax += $tax{$taxitem} unless $seen{$taxitem};
2442 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2446 $tax = sprintf('%.2f', $tax );
2447 $total_setup = sprintf('%.2f', $total_setup+$tax );
2449 push @cust_bill_pkg, new FS::cust_bill_pkg {
2455 'itemdesc' => $taxname,
2460 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2462 #create the new invoice
2463 my $cust_bill = new FS::cust_bill ( {
2464 'custnum' => $self->custnum,
2465 '_date' => ( $options{'invoice_time'} || $time ),
2466 'charged' => $charged,
2468 my $error = $cust_bill->insert;
2470 $dbh->rollback if $oldAutoCommit;
2471 return "can't create invoice for customer #". $self->custnum. ": $error";
2474 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2475 $cust_bill_pkg->invnum($cust_bill->invnum);
2476 my $error = $cust_bill_pkg->insert;
2478 $dbh->rollback if $oldAutoCommit;
2479 return "can't create invoice line item: $error";
2484 foreach my $hook ( @precommit_hooks ) {
2486 &{$hook}; #($self) ?
2489 $dbh->rollback if $oldAutoCommit;
2490 return "$@ running precommit hook $hook\n";
2494 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2498 =item collect OPTIONS
2500 (Attempt to) collect money for this customer's outstanding invoices (see
2501 L<FS::cust_bill>). Usually used after the bill method.
2503 Actions are now triggered by billing events; see L<FS::part_event> and the
2504 billing events web interface. Old-style invoice events (see
2505 L<FS::part_bill_event>) have been deprecated.
2507 If there is an error, returns the error, otherwise returns false.
2509 Options are passed as name-value pairs.
2511 Currently available options are:
2517 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.
2521 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2525 set true to surpress email card/ACH decline notices.
2529 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2533 allows for one time override of normal customer billing method
2537 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)
2545 my( $self, %options ) = @_;
2546 my $invoice_time = $options{'invoice_time'} || time;
2549 local $SIG{HUP} = 'IGNORE';
2550 local $SIG{INT} = 'IGNORE';
2551 local $SIG{QUIT} = 'IGNORE';
2552 local $SIG{TERM} = 'IGNORE';
2553 local $SIG{TSTP} = 'IGNORE';
2554 local $SIG{PIPE} = 'IGNORE';
2556 my $oldAutoCommit = $FS::UID::AutoCommit;
2557 local $FS::UID::AutoCommit = 0;
2560 $self->select_for_update; #mutex
2563 my $balance = $self->balance;
2564 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2567 if ( exists($options{'retry_card'}) ) {
2568 carp 'retry_card option passed to collect is deprecated; use retry';
2569 $options{'retry'} ||= $options{'retry_card'};
2571 if ( exists($options{'retry'}) && $options{'retry'} ) {
2572 my $error = $self->retry_realtime;
2574 $dbh->rollback if $oldAutoCommit;
2579 # false laziness w/pay_batch::import_results
2581 my $due_cust_event = $self->due_cust_event(
2582 'debug' => ( $options{'debug'} || 0 ),
2583 'time' => $invoice_time,
2584 'check_freq' => $options{'check_freq'},
2586 unless( ref($due_cust_event) ) {
2587 $dbh->rollback if $oldAutoCommit;
2588 return $due_cust_event;
2591 foreach my $cust_event ( @$due_cust_event ) {
2595 #re-eval event conditions (a previous event could have changed things)
2596 unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
2597 #don't leave stray "new/locked" records around
2598 my $error = $cust_event->delete;
2600 #gah, even with transactions
2601 $dbh->commit if $oldAutoCommit; #well.
2608 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2609 warn " running cust_event ". $cust_event->eventnum. "\n"
2613 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2614 if ( my $error = $cust_event->do_event() ) {
2615 #XXX wtf is this? figure out a proper dealio with return value
2617 # gah, even with transactions.
2618 $dbh->commit if $oldAutoCommit; #well.
2625 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2630 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2632 Inserts database records for and returns an ordered listref of new events due
2633 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
2634 events are due, an empty listref is returned. If there is an error, returns a
2635 scalar error message.
2637 To actually run the events, call each event's test_condition method, and if
2638 still true, call the event's do_event method.
2640 Options are passed as a hashref or as a list of name-value pairs. Available
2647 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.
2651 "Current time" for the events.
2655 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)
2659 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2663 Explicitly pass the objects to be tested (typically used with eventtable).
2669 sub due_cust_event {
2671 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2674 #my $DEBUG = $opt{'debug'}
2675 local($DEBUG) = $opt{'debug'}
2676 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2678 warn "$me due_cust_event called with options ".
2679 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2682 $opt{'time'} ||= time;
2684 local $SIG{HUP} = 'IGNORE';
2685 local $SIG{INT} = 'IGNORE';
2686 local $SIG{QUIT} = 'IGNORE';
2687 local $SIG{TERM} = 'IGNORE';
2688 local $SIG{TSTP} = 'IGNORE';
2689 local $SIG{PIPE} = 'IGNORE';
2691 my $oldAutoCommit = $FS::UID::AutoCommit;
2692 local $FS::UID::AutoCommit = 0;
2695 $self->select_for_update; #mutex
2698 # 1: find possible events (initial search)
2701 my @cust_event = ();
2703 my @eventtable = $opt{'eventtable'}
2704 ? ( $opt{'eventtable'} )
2705 : FS::part_event->eventtables_runorder;
2707 foreach my $eventtable ( @eventtable ) {
2710 if ( $opt{'objects'} ) {
2712 @objects = @{ $opt{'objects'} };
2716 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2717 @objects = ( $eventtable eq 'cust_main' )
2719 : ( $self->$eventtable() );
2723 my @e_cust_event = ();
2725 my $cross = "CROSS JOIN $eventtable";
2726 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2727 unless $eventtable eq 'cust_main';
2729 foreach my $object ( @objects ) {
2731 #this first search uses the condition_sql magic for optimization.
2732 #the more possible events we can eliminate in this step the better
2734 my $cross_where = '';
2735 my $pkey = $object->primary_key;
2736 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2738 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2740 FS::part_event_condition->where_conditions_sql( $eventtable,
2741 'time'=>$opt{'time'}
2743 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2745 $extra_sql = "AND $extra_sql" if $extra_sql;
2747 #here is the agent virtualization
2748 $extra_sql .= " AND ( part_event.agentnum IS NULL
2749 OR part_event.agentnum = ". $self->agentnum. ' )';
2751 $extra_sql .= " $order";
2753 warn "searching for events for $eventtable ". $object->$pkey. "\n"
2754 if $opt{'debug'} > 2;
2755 my @part_event = qsearch( {
2756 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
2757 'select' => 'part_event.*',
2758 'table' => 'part_event',
2759 'addl_from' => "$cross $join",
2760 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2761 'eventtable' => $eventtable,
2764 'extra_sql' => "AND $cross_where $extra_sql",
2768 my $pkey = $object->primary_key;
2769 warn " ". scalar(@part_event).
2770 " possible events found for $eventtable ". $object->$pkey(). "\n";
2773 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2777 warn " ". scalar(@e_cust_event).
2778 " subtotal possible cust events found for $eventtable\n"
2781 push @cust_event, @e_cust_event;
2785 warn " ". scalar(@cust_event).
2786 " total possible cust events found in initial search\n"
2790 # 2: test conditions
2795 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
2796 'stats_hashref' => \%unsat ),
2799 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
2802 warn " invalid conditions not eliminated with condition_sql:\n".
2803 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
2810 foreach my $cust_event ( @cust_event ) {
2812 my $error = $cust_event->insert();
2814 $dbh->rollback if $oldAutoCommit;
2820 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2826 warn " returning events: ". Dumper(@cust_event). "\n"
2833 =item retry_realtime
2835 Schedules realtime / batch credit card / electronic check / LEC billing
2836 events for for retry. Useful if card information has changed or manual
2837 retry is desired. The 'collect' method must be called to actually retry
2840 Implementation details: For either this customer, or for each of this
2841 customer's open invoices, changes the status of the first "done" (with
2842 statustext error) realtime processing event to "failed".
2846 sub retry_realtime {
2849 local $SIG{HUP} = 'IGNORE';
2850 local $SIG{INT} = 'IGNORE';
2851 local $SIG{QUIT} = 'IGNORE';
2852 local $SIG{TERM} = 'IGNORE';
2853 local $SIG{TSTP} = 'IGNORE';
2854 local $SIG{PIPE} = 'IGNORE';
2856 my $oldAutoCommit = $FS::UID::AutoCommit;
2857 local $FS::UID::AutoCommit = 0;
2860 #a little false laziness w/due_cust_event (not too bad, really)
2862 my $join = FS::part_event_condition->join_conditions_sql;
2863 my $order = FS::part_event_condition->order_conditions_sql;
2866 . join ( ' OR ' , map {
2867 "( part_event.eventtable = " . dbh->quote($_)
2868 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
2869 } FS::part_event->eventtables)
2872 #here is the agent virtualization
2873 my $agent_virt = " ( part_event.agentnum IS NULL
2874 OR part_event.agentnum = ". $self->agentnum. ' )';
2876 #XXX this shouldn't be hardcoded, actions should declare it...
2877 my @realtime_events = qw(
2878 cust_bill_realtime_card
2879 cust_bill_realtime_check
2880 cust_bill_realtime_lec
2884 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
2889 my @cust_event = qsearchs({
2890 'table' => 'cust_event',
2891 'select' => 'cust_event.*',
2892 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
2893 'hashref' => { 'status' => 'done' },
2894 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
2895 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
2898 my %seen_invnum = ();
2899 foreach my $cust_event (@cust_event) {
2901 #max one for the customer, one for each open invoice
2902 my $cust_X = $cust_event->cust_X;
2903 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
2907 or $cust_event->part_event->eventtable eq 'cust_bill'
2910 my $error = $cust_event->retry;
2912 $dbh->rollback if $oldAutoCommit;
2913 return "error scheduling event for retry: $error";
2918 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2923 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2925 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2926 via a Business::OnlinePayment realtime gateway. See
2927 L<http://420.am/business-onlinepayment> for supported gateways.
2929 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2931 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
2933 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2934 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
2935 if set, will override the value from the customer record.
2937 I<description> is a free-text field passed to the gateway. It defaults to
2938 "Internet services".
2940 If an I<invnum> is specified, this payment (if successful) is applied to the
2941 specified invoice. If you don't specify an I<invnum> you might want to
2942 call the B<apply_payments> method.
2944 I<quiet> can be set true to surpress email decline notices.
2946 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
2947 resulting paynum, if any.
2949 I<payunique> is a unique identifier for this payment.
2951 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2956 my( $self, $method, $amount, %options ) = @_;
2958 warn "$me realtime_bop: $method $amount\n";
2959 warn " $_ => $options{$_}\n" foreach keys %options;
2962 $options{'description'} ||= 'Internet services';
2964 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
2966 eval "use Business::OnlinePayment";
2969 my $payinfo = exists($options{'payinfo'})
2970 ? $options{'payinfo'}
2973 my %method2payby = (
2980 # check for banned credit card/ACH
2983 my $ban = qsearchs('banned_pay', {
2984 'payby' => $method2payby{$method},
2985 'payinfo' => md5_base64($payinfo),
2987 return "Banned credit card" if $ban;
2994 if ( $options{'invnum'} ) {
2995 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2996 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2998 map { $_->part_pkg->taxclass }
3000 map { $_->cust_pkg }
3001 $cust_bill->cust_bill_pkg;
3002 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
3003 #different taxclasses
3004 $taxclass = $taxclasses[0];
3008 #look for an agent gateway override first
3010 if ( $method eq 'CC' ) {
3011 $cardtype = cardtype($payinfo);
3012 } elsif ( $method eq 'ECHECK' ) {
3015 $cardtype = $method;
3019 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3020 cardtype => $cardtype,
3021 taxclass => $taxclass, } )
3022 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3024 taxclass => $taxclass, } )
3025 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3026 cardtype => $cardtype,
3028 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3030 taxclass => '', } );
3032 my $payment_gateway = '';
3033 my( $processor, $login, $password, $action, @bop_options );
3034 if ( $override ) { #use a payment gateway override
3036 $payment_gateway = $override->payment_gateway;
3038 $processor = $payment_gateway->gateway_module;
3039 $login = $payment_gateway->gateway_username;
3040 $password = $payment_gateway->gateway_password;
3041 $action = $payment_gateway->gateway_action;
3042 @bop_options = $payment_gateway->options;
3044 } else { #use the standard settings from the config
3046 ( $processor, $login, $password, $action, @bop_options ) =
3047 $self->default_payment_gateway($method);
3055 my $address = exists($options{'address1'})
3056 ? $options{'address1'}
3058 my $address2 = exists($options{'address2'})
3059 ? $options{'address2'}
3061 $address .= ", ". $address2 if length($address2);
3063 my $o_payname = exists($options{'payname'})
3064 ? $options{'payname'}
3066 my($payname, $payfirst, $paylast);
3067 if ( $o_payname && $method ne 'ECHECK' ) {
3068 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3069 or return "Illegal payname $payname";
3070 ($payfirst, $paylast) = ($1, $2);
3072 $payfirst = $self->getfield('first');
3073 $paylast = $self->getfield('last');
3074 $payname = "$payfirst $paylast";
3077 my @invoicing_list = $self->invoicing_list_emailonly;
3078 if ( $conf->exists('emailinvoiceautoalways')
3079 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3080 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3081 push @invoicing_list, $self->all_emails;
3084 my $email = ($conf->exists('business-onlinepayment-email-override'))
3085 ? $conf->config('business-onlinepayment-email-override')
3086 : $invoicing_list[0];
3090 my $payip = exists($options{'payip'})
3093 $content{customer_ip} = $payip
3096 $content{invoice_number} = $options{'invnum'}
3097 if exists($options{'invnum'}) && length($options{'invnum'});
3099 $content{email_customer} =
3100 ( $conf->exists('business-onlinepayment-email_customer')
3101 || $conf->exists('business-onlinepayment-email-override') );
3104 if ( $method eq 'CC' ) {
3106 $content{card_number} = $payinfo;
3107 $paydate = exists($options{'paydate'})
3108 ? $options{'paydate'}
3110 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3111 $content{expiration} = "$2/$1";
3113 my $paycvv = exists($options{'paycvv'})
3114 ? $options{'paycvv'}
3116 $content{cvv2} = $paycvv
3119 my $paystart_month = exists($options{'paystart_month'})
3120 ? $options{'paystart_month'}
3121 : $self->paystart_month;
3123 my $paystart_year = exists($options{'paystart_year'})
3124 ? $options{'paystart_year'}
3125 : $self->paystart_year;
3127 $content{card_start} = "$paystart_month/$paystart_year"
3128 if $paystart_month && $paystart_year;
3130 my $payissue = exists($options{'payissue'})
3131 ? $options{'payissue'}
3133 $content{issue_number} = $payissue if $payissue;
3135 $content{recurring_billing} = 'YES'
3136 if qsearch('cust_pay', { 'custnum' => $self->custnum,
3138 'payinfo' => $payinfo,
3140 || qsearch('cust_pay', { 'custnum' => $self->custnum,
3142 'paymask' => $self->mask_payinfo('CARD', $payinfo),
3146 } elsif ( $method eq 'ECHECK' ) {
3147 ( $content{account_number}, $content{routing_code} ) =
3148 split('@', $payinfo);
3149 $content{bank_name} = $o_payname;
3150 $content{bank_state} = exists($options{'paystate'})
3151 ? $options{'paystate'}
3152 : $self->getfield('paystate');
3153 $content{account_type} = exists($options{'paytype'})
3154 ? uc($options{'paytype'}) || 'CHECKING'
3155 : uc($self->getfield('paytype')) || 'CHECKING';
3156 $content{account_name} = $payname;
3157 $content{customer_org} = $self->company ? 'B' : 'I';
3158 $content{state_id} = exists($options{'stateid'})
3159 ? $options{'stateid'}
3160 : $self->getfield('stateid');
3161 $content{state_id_state} = exists($options{'stateid_state'})
3162 ? $options{'stateid_state'}
3163 : $self->getfield('stateid_state');
3164 $content{customer_ssn} = exists($options{'ss'})
3167 } elsif ( $method eq 'LEC' ) {
3168 $content{phone} = $payinfo;
3172 # run transaction(s)
3175 my $balance = exists( $options{'balance'} )
3176 ? $options{'balance'}
3179 $self->select_for_update; #mutex ... just until we get our pending record in
3181 #the checks here are intended to catch concurrent payments
3182 #double-form-submission prevention is taken care of in cust_pay_pending::check
3185 return "The customer's balance has changed; $method transaction aborted."
3186 if $self->balance < $balance;
3187 #&& $self->balance < $amount; #might as well anyway?
3189 #also check and make sure there aren't *other* pending payments for this cust
3191 my @pending = qsearch('cust_pay_pending', {
3192 'custnum' => $self->custnum,
3193 'status' => { op=>'!=', value=>'done' }
3195 return "A payment is already being processed for this customer (".
3196 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
3197 "); $method transaction aborted."
3198 if scalar(@pending);
3200 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
3202 my $cust_pay_pending = new FS::cust_pay_pending {
3203 'custnum' => $self->custnum,
3204 #'invnum' => $options{'invnum'},
3207 'payby' => $method2payby{$method},
3208 'payinfo' => $payinfo,
3209 'paydate' => $paydate,
3211 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
3213 $cust_pay_pending->payunique( $options{payunique} )
3214 if defined($options{payunique}) && length($options{payunique});
3215 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
3216 return $cpp_new_err if $cpp_new_err;
3218 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3220 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3221 $transaction->content(
3224 'password' => $password,
3225 'action' => $action1,
3226 'description' => $options{'description'},
3227 'amount' => $amount,
3228 #'invoice_number' => $options{'invnum'},
3229 'customer_id' => $self->custnum,
3230 'last_name' => $paylast,
3231 'first_name' => $payfirst,
3233 'address' => $address,
3234 'city' => ( exists($options{'city'})
3237 'state' => ( exists($options{'state'})
3240 'zip' => ( exists($options{'zip'})
3243 'country' => ( exists($options{'country'})
3244 ? $options{'country'}
3246 'referer' => 'http://cleanwhisker.420.am/',
3248 'phone' => $self->daytime || $self->night,
3252 $cust_pay_pending->status('pending');
3253 my $cpp_pending_err = $cust_pay_pending->replace;
3254 return $cpp_pending_err if $cpp_pending_err;
3257 my $BOP_TESTING = 0;
3258 my $BOP_TESTING_SUCCESS = 1;
3260 unless ( $BOP_TESTING ) {
3261 $transaction->submit();
3263 if ( $BOP_TESTING_SUCCESS ) {
3264 $transaction->is_success(1);
3265 $transaction->authorization('fake auth');
3267 $transaction->is_success(0);
3268 $transaction->error_message('fake failure');
3272 if ( $transaction->is_success() && $action2 ) {
3274 $cust_pay_pending->status('authorized');
3275 my $cpp_authorized_err = $cust_pay_pending->replace;
3276 return $cpp_authorized_err if $cpp_authorized_err;
3278 my $auth = $transaction->authorization;
3279 my $ordernum = $transaction->can('order_number')
3280 ? $transaction->order_number
3284 new Business::OnlinePayment( $processor, @bop_options );
3291 password => $password,
3292 order_number => $ordernum,
3294 authorization => $auth,
3295 description => $options{'description'},
3298 foreach my $field (qw( authorization_source_code returned_ACI
3299 transaction_identifier validation_code
3300 transaction_sequence_num local_transaction_date
3301 local_transaction_time AVS_result_code )) {
3302 $capture{$field} = $transaction->$field() if $transaction->can($field);
3305 $capture->content( %capture );
3309 unless ( $capture->is_success ) {
3310 my $e = "Authorization successful but capture failed, custnum #".
3311 $self->custnum. ': '. $capture->result_code.
3312 ": ". $capture->error_message;
3319 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
3320 my $cpp_captured_err = $cust_pay_pending->replace;
3321 return $cpp_captured_err if $cpp_captured_err;
3324 # remove paycvv after initial transaction
3327 #false laziness w/misc/process/payment.cgi - check both to make sure working
3329 if ( defined $self->dbdef_table->column('paycvv')
3330 && length($self->paycvv)
3331 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3333 my $error = $self->remove_cvv;
3335 warn "WARNING: error removing cvv: $error\n";
3343 if ( $transaction->is_success() ) {
3346 if ( $payment_gateway ) { # agent override
3347 $paybatch = $payment_gateway->gatewaynum. '-';
3350 $paybatch .= "$processor:". $transaction->authorization;
3352 $paybatch .= ':'. $transaction->order_number
3353 if $transaction->can('order_number')
3354 && length($transaction->order_number);
3356 my $cust_pay = new FS::cust_pay ( {
3357 'custnum' => $self->custnum,
3358 'invnum' => $options{'invnum'},
3361 'payby' => $method2payby{$method},
3362 'payinfo' => $payinfo,
3363 'paybatch' => $paybatch,
3364 'paydate' => $paydate,
3366 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
3367 $cust_pay->payunique( $options{payunique} )
3368 if defined($options{payunique}) && length($options{payunique});
3370 my $oldAutoCommit = $FS::UID::AutoCommit;
3371 local $FS::UID::AutoCommit = 0;
3374 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
3376 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3379 $cust_pay->invnum(''); #try again with no specific invnum
3380 my $error2 = $cust_pay->insert( $options{'manual'} ?
3381 ( 'manual' => 1 ) : ()
3384 # gah. but at least we have a record of the state we had to abort in
3385 # from cust_pay_pending now.
3386 my $e = "WARNING: $method captured but payment not recorded - ".
3387 "error inserting payment ($processor): $error2".
3388 " (previously tried insert with invnum #$options{'invnum'}" .
3389 ": $error ) - pending payment saved as paypendingnum ".
3390 $cust_pay_pending->paypendingnum. "\n";
3396 if ( $options{'paynum_ref'} ) {
3397 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3400 $cust_pay_pending->status('done');
3401 $cust_pay_pending->statustext('captured');
3402 my $cpp_done_err = $cust_pay_pending->replace;
3404 if ( $cpp_done_err ) {
3406 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3407 my $e = "WARNING: $method captured but payment not recorded - ".
3408 "error updating status for paypendingnum ".
3409 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3415 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3416 return ''; #no error
3422 my $perror = "$processor error: ". $transaction->error_message;
3424 unless ( $transaction->error_message ) {
3427 if ( $transaction->can('response_page') ) {
3429 'page' => ( $transaction->can('response_page')
3430 ? $transaction->response_page
3433 'code' => ( $transaction->can('response_code')
3434 ? $transaction->response_code
3437 'headers' => ( $transaction->can('response_headers')
3438 ? $transaction->response_headers
3444 "No additional debugging information available for $processor";
3447 $perror .= "No error_message returned from $processor -- ".
3448 ( ref($t_response) ? Dumper($t_response) : $t_response );
3452 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3453 && $conf->exists('emaildecline')
3454 && grep { $_ ne 'POST' } $self->invoicing_list
3455 && ! grep { $transaction->error_message =~ /$_/ }
3456 $conf->config('emaildecline-exclude')
3458 my @templ = $conf->config('declinetemplate');
3459 my $template = new Text::Template (
3461 SOURCE => [ map "$_\n", @templ ],
3462 ) or return "($perror) can't create template: $Text::Template::ERROR";
3463 $template->compile()
3464 or return "($perror) can't compile template: $Text::Template::ERROR";
3466 my $templ_hash = { error => $transaction->error_message };
3468 my $error = send_email(
3469 'from' => $conf->config('invoice_from'),
3470 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3471 'subject' => 'Your payment could not be processed',
3472 'body' => [ $template->fill_in(HASH => $templ_hash) ],
3475 $perror .= " (also received error sending decline notification: $error)"
3480 $cust_pay_pending->status('done');
3481 $cust_pay_pending->statustext("declined: $perror");
3482 my $cpp_done_err = $cust_pay_pending->replace;
3483 if ( $cpp_done_err ) {
3484 my $e = "WARNING: $method declined but pending payment not resolved - ".
3485 "error updating status for paypendingnum ".
3486 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3488 $perror = "$e ($perror)";
3501 my( $self, $method, $amount, %options ) = @_;
3503 if ( $options{'fake_failure'} ) {
3504 return "Error: No error; test failure requested with fake_failure";
3507 my %method2payby = (
3514 #if ( $payment_gateway ) { # agent override
3515 # $paybatch = $payment_gateway->gatewaynum. '-';
3518 #$paybatch .= "$processor:". $transaction->authorization;
3520 #$paybatch .= ':'. $transaction->order_number
3521 # if $transaction->can('order_number')
3522 # && length($transaction->order_number);
3524 my $paybatch = 'FakeProcessor:54:32';
3526 my $cust_pay = new FS::cust_pay ( {
3527 'custnum' => $self->custnum,
3528 'invnum' => $options{'invnum'},
3531 'payby' => $method2payby{$method},
3532 #'payinfo' => $payinfo,
3533 'payinfo' => '4111111111111111',
3534 'paybatch' => $paybatch,
3535 #'paydate' => $paydate,
3536 'paydate' => '2012-05-01',
3538 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3540 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3543 $cust_pay->invnum(''); #try again with no specific invnum
3544 my $error2 = $cust_pay->insert( $options{'manual'} ?
3545 ( 'manual' => 1 ) : ()
3548 # gah, even with transactions.
3549 my $e = 'WARNING: Card/ACH debited but database not updated - '.
3550 "error inserting (fake!) payment: $error2".
3551 " (previously tried insert with invnum #$options{'invnum'}" .
3558 if ( $options{'paynum_ref'} ) {
3559 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3562 return ''; #no error
3566 =item default_payment_gateway
3570 sub default_payment_gateway {
3571 my( $self, $method ) = @_;
3573 die "Real-time processing not enabled\n"
3574 unless $conf->exists('business-onlinepayment');
3577 my $bop_config = 'business-onlinepayment';
3578 $bop_config .= '-ach'
3579 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
3580 my ( $processor, $login, $password, $action, @bop_options ) =
3581 $conf->config($bop_config);
3582 $action ||= 'normal authorization';
3583 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3584 die "No real-time processor is enabled - ".
3585 "did you set the business-onlinepayment configuration value?\n"
3588 ( $processor, $login, $password, $action, @bop_options )
3593 Removes the I<paycvv> field from the database directly.
3595 If there is an error, returns the error, otherwise returns false.
3601 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3602 or return dbh->errstr;
3603 $sth->execute($self->custnum)
3604 or return $sth->errstr;
3609 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3611 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3612 via a Business::OnlinePayment realtime gateway. See
3613 L<http://420.am/business-onlinepayment> for supported gateways.
3615 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3617 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3619 Most gateways require a reference to an original payment transaction to refund,
3620 so you probably need to specify a I<paynum>.
3622 I<amount> defaults to the original amount of the payment if not specified.
3624 I<reason> specifies a reason for the refund.
3626 I<paydate> specifies the expiration date for a credit card overriding the
3627 value from the customer record or the payment record. Specified as yyyy-mm-dd
3629 Implementation note: If I<amount> is unspecified or equal to the amount of the
3630 orignal payment, first an attempt is made to "void" the transaction via
3631 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3632 the normal attempt is made to "refund" ("credit") the transaction via the
3633 gateway is attempted.
3635 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3636 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3637 #if set, will override the value from the customer record.
3639 #If an I<invnum> is specified, this payment (if successful) is applied to the
3640 #specified invoice. If you don't specify an I<invnum> you might want to
3641 #call the B<apply_payments> method.
3645 #some false laziness w/realtime_bop, not enough to make it worth merging
3646 #but some useful small subs should be pulled out
3647 sub realtime_refund_bop {
3648 my( $self, $method, %options ) = @_;
3650 warn "$me realtime_refund_bop: $method refund\n";
3651 warn " $_ => $options{$_}\n" foreach keys %options;
3654 eval "use Business::OnlinePayment";
3658 # look up the original payment and optionally a gateway for that payment
3662 my $amount = $options{'amount'};
3664 my( $processor, $login, $password, @bop_options ) ;
3665 my( $auth, $order_number ) = ( '', '', '' );
3667 if ( $options{'paynum'} ) {
3669 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
3670 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3671 or return "Unknown paynum $options{'paynum'}";
3672 $amount ||= $cust_pay->paid;
3674 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3675 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3676 $cust_pay->paybatch;
3677 my $gatewaynum = '';
3678 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3680 if ( $gatewaynum ) { #gateway for the payment to be refunded
3682 my $payment_gateway =
3683 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3684 die "payment gateway $gatewaynum not found"
3685 unless $payment_gateway;
3687 $processor = $payment_gateway->gateway_module;
3688 $login = $payment_gateway->gateway_username;
3689 $password = $payment_gateway->gateway_password;
3690 @bop_options = $payment_gateway->options;
3692 } else { #try the default gateway
3694 my( $conf_processor, $unused_action );
3695 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3696 $self->default_payment_gateway($method);
3698 return "processor of payment $options{'paynum'} $processor does not".
3699 " match default processor $conf_processor"
3700 unless $processor eq $conf_processor;
3705 } else { # didn't specify a paynum, so look for agent gateway overrides
3706 # like a normal transaction
3709 if ( $method eq 'CC' ) {
3710 $cardtype = cardtype($self->payinfo);
3711 } elsif ( $method eq 'ECHECK' ) {
3714 $cardtype = $method;
3717 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3718 cardtype => $cardtype,
3720 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3722 taxclass => '', } );
3724 if ( $override ) { #use a payment gateway override
3726 my $payment_gateway = $override->payment_gateway;
3728 $processor = $payment_gateway->gateway_module;
3729 $login = $payment_gateway->gateway_username;
3730 $password = $payment_gateway->gateway_password;
3731 #$action = $payment_gateway->gateway_action;
3732 @bop_options = $payment_gateway->options;
3734 } else { #use the standard settings from the config
3737 ( $processor, $login, $password, $unused_action, @bop_options ) =
3738 $self->default_payment_gateway($method);
3743 return "neither amount nor paynum specified" unless $amount;
3748 'password' => $password,
3749 'order_number' => $order_number,
3750 'amount' => $amount,
3751 'referer' => 'http://cleanwhisker.420.am/',
3753 $content{authorization} = $auth
3754 if length($auth); #echeck/ACH transactions have an order # but no auth
3755 #(at least with authorize.net)
3757 my $disable_void_after;
3758 if ($conf->exists('disable_void_after')
3759 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3760 $disable_void_after = $1;
3763 #first try void if applicable
3764 if ( $cust_pay && $cust_pay->paid == $amount
3766 ( not defined($disable_void_after) )
3767 || ( time < ($cust_pay->_date + $disable_void_after ) )
3770 warn " attempting void\n" if $DEBUG > 1;
3771 my $void = new Business::OnlinePayment( $processor, @bop_options );
3772 $void->content( 'action' => 'void', %content );
3774 if ( $void->is_success ) {
3775 my $error = $cust_pay->void($options{'reason'});
3777 # gah, even with transactions.
3778 my $e = 'WARNING: Card/ACH voided but database not updated - '.
3779 "error voiding payment: $error";
3783 warn " void successful\n" if $DEBUG > 1;
3788 warn " void unsuccessful, trying refund\n"
3792 my $address = $self->address1;
3793 $address .= ", ". $self->address2 if $self->address2;
3795 my($payname, $payfirst, $paylast);
3796 if ( $self->payname && $method ne 'ECHECK' ) {
3797 $payname = $self->payname;
3798 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3799 or return "Illegal payname $payname";
3800 ($payfirst, $paylast) = ($1, $2);
3802 $payfirst = $self->getfield('first');
3803 $paylast = $self->getfield('last');
3804 $payname = "$payfirst $paylast";
3807 my @invoicing_list = $self->invoicing_list_emailonly;
3808 if ( $conf->exists('emailinvoiceautoalways')
3809 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3810 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3811 push @invoicing_list, $self->all_emails;
3814 my $email = ($conf->exists('business-onlinepayment-email-override'))
3815 ? $conf->config('business-onlinepayment-email-override')
3816 : $invoicing_list[0];
3818 my $payip = exists($options{'payip'})
3821 $content{customer_ip} = $payip
3825 if ( $method eq 'CC' ) {
3828 $content{card_number} = $payinfo = $cust_pay->payinfo;
3829 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3830 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3831 ($content{expiration} = "$2/$1"); # where available
3833 $content{card_number} = $payinfo = $self->payinfo;
3834 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3835 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3836 $content{expiration} = "$2/$1";
3839 } elsif ( $method eq 'ECHECK' ) {
3842 $payinfo = $cust_pay->payinfo;
3844 $payinfo = $self->payinfo;
3846 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3847 $content{bank_name} = $self->payname;
3848 $content{account_type} = 'CHECKING';
3849 $content{account_name} = $payname;
3850 $content{customer_org} = $self->company ? 'B' : 'I';
3851 $content{customer_ssn} = $self->ss;
3852 } elsif ( $method eq 'LEC' ) {
3853 $content{phone} = $payinfo = $self->payinfo;
3857 my $refund = new Business::OnlinePayment( $processor, @bop_options );
3858 my %sub_content = $refund->content(
3859 'action' => 'credit',
3860 'customer_id' => $self->custnum,
3861 'last_name' => $paylast,
3862 'first_name' => $payfirst,
3864 'address' => $address,
3865 'city' => $self->city,
3866 'state' => $self->state,
3867 'zip' => $self->zip,
3868 'country' => $self->country,
3870 'phone' => $self->daytime || $self->night,
3873 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
3877 return "$processor error: ". $refund->error_message
3878 unless $refund->is_success();
3880 my %method2payby = (
3886 my $paybatch = "$processor:". $refund->authorization;
3887 $paybatch .= ':'. $refund->order_number
3888 if $refund->can('order_number') && $refund->order_number;
3890 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3891 my @cust_bill_pay = $cust_pay->cust_bill_pay;
3892 last unless @cust_bill_pay;
3893 my $cust_bill_pay = pop @cust_bill_pay;
3894 my $error = $cust_bill_pay->delete;
3898 my $cust_refund = new FS::cust_refund ( {
3899 'custnum' => $self->custnum,
3900 'paynum' => $options{'paynum'},
3901 'refund' => $amount,
3903 'payby' => $method2payby{$method},
3904 'payinfo' => $payinfo,
3905 'paybatch' => $paybatch,
3906 'reason' => $options{'reason'} || 'card or ACH refund',
3908 my $error = $cust_refund->insert;
3910 $cust_refund->paynum(''); #try again with no specific paynum
3911 my $error2 = $cust_refund->insert;
3913 # gah, even with transactions.
3914 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3915 "error inserting refund ($processor): $error2".
3916 " (previously tried insert with paynum #$options{'paynum'}" .
3927 =item batch_card OPTION => VALUE...
3929 Adds a payment for this invoice to the pending credit card batch (see
3930 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3931 runs the payment using a realtime gateway.
3936 my ($self, %options) = @_;
3939 if (exists($options{amount})) {
3940 $amount = $options{amount};
3942 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3944 return '' unless $amount > 0;
3946 my $invnum = delete $options{invnum};
3947 my $payby = $options{invnum} || $self->payby; #dubious
3949 if ($options{'realtime'}) {
3950 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3956 my $oldAutoCommit = $FS::UID::AutoCommit;
3957 local $FS::UID::AutoCommit = 0;
3960 #this needs to handle mysql as well as Pg, like svc_acct.pm
3961 #(make it into a common function if folks need to do batching with mysql)
3962 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3963 or return "Cannot lock pay_batch: " . $dbh->errstr;
3967 'payby' => FS::payby->payby2payment($payby),
3970 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3972 unless ( $pay_batch ) {
3973 $pay_batch = new FS::pay_batch \%pay_batch;
3974 my $error = $pay_batch->insert;
3976 $dbh->rollback if $oldAutoCommit;
3977 die "error creating new batch: $error\n";
3981 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3982 'batchnum' => $pay_batch->batchnum,
3983 'custnum' => $self->custnum,
3986 foreach (qw( address1 address2 city state zip country payby payinfo paydate
3988 $options{$_} = '' unless exists($options{$_});
3991 my $cust_pay_batch = new FS::cust_pay_batch ( {
3992 'batchnum' => $pay_batch->batchnum,
3993 'invnum' => $invnum || 0, # is there a better value?
3994 # this field should be
3996 # cust_bill_pay_batch now
3997 'custnum' => $self->custnum,
3998 'last' => $self->getfield('last'),
3999 'first' => $self->getfield('first'),
4000 'address1' => $options{address1} || $self->address1,
4001 'address2' => $options{address2} || $self->address2,
4002 'city' => $options{city} || $self->city,
4003 'state' => $options{state} || $self->state,
4004 'zip' => $options{zip} || $self->zip,
4005 'country' => $options{country} || $self->country,
4006 'payby' => $options{payby} || $self->payby,
4007 'payinfo' => $options{payinfo} || $self->payinfo,
4008 'exp' => $options{paydate} || $self->paydate,
4009 'payname' => $options{payname} || $self->payname,
4010 'amount' => $amount, # consolidating
4013 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
4014 if $old_cust_pay_batch;
4017 if ($old_cust_pay_batch) {
4018 $error = $cust_pay_batch->replace($old_cust_pay_batch)
4020 $error = $cust_pay_batch->insert;
4024 $dbh->rollback if $oldAutoCommit;
4028 my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
4029 foreach my $cust_bill ($self->open_cust_bill) {
4030 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
4031 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
4032 'invnum' => $cust_bill->invnum,
4033 'paybatchnum' => $cust_pay_batch->paybatchnum,
4034 'amount' => $cust_bill->owed,
4037 if ($unapplied >= $cust_bill_pay_batch->amount){
4038 $unapplied -= $cust_bill_pay_batch->amount;
4041 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
4042 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
4044 $error = $cust_bill_pay_batch->insert;
4046 $dbh->rollback if $oldAutoCommit;
4051 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4057 Returns the total owed for this customer on all invoices
4058 (see L<FS::cust_bill/owed>).
4064 $self->total_owed_date(2145859200); #12/31/2037
4067 =item total_owed_date TIME
4069 Returns the total owed for this customer on all invoices with date earlier than
4070 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
4071 see L<Time::Local> and L<Date::Parse> for conversion functions.
4075 sub total_owed_date {
4079 foreach my $cust_bill (
4080 grep { $_->_date <= $time }
4081 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4083 $total_bill += $cust_bill->owed;
4085 sprintf( "%.2f", $total_bill );
4088 =item apply_payments_and_credits
4090 Applies unapplied payments and credits.
4092 In most cases, this new method should be used in place of sequential
4093 apply_payments and apply_credits methods.
4095 If there is an error, returns the error, otherwise returns false.
4099 sub apply_payments_and_credits {
4102 local $SIG{HUP} = 'IGNORE';
4103 local $SIG{INT} = 'IGNORE';
4104 local $SIG{QUIT} = 'IGNORE';
4105 local $SIG{TERM} = 'IGNORE';
4106 local $SIG{TSTP} = 'IGNORE';
4107 local $SIG{PIPE} = 'IGNORE';
4109 my $oldAutoCommit = $FS::UID::AutoCommit;
4110 local $FS::UID::AutoCommit = 0;
4113 $self->select_for_update; #mutex
4115 foreach my $cust_bill ( $self->open_cust_bill ) {
4116 my $error = $cust_bill->apply_payments_and_credits;
4118 $dbh->rollback if $oldAutoCommit;
4119 return "Error applying: $error";
4123 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4128 =item apply_credits OPTION => VALUE ...
4130 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
4131 to outstanding invoice balances in chronological order (or reverse
4132 chronological order if the I<order> option is set to B<newest>) and returns the
4133 value of any remaining unapplied credits available for refund (see
4134 L<FS::cust_refund>).
4136 Dies if there is an error.
4144 local $SIG{HUP} = 'IGNORE';
4145 local $SIG{INT} = 'IGNORE';
4146 local $SIG{QUIT} = 'IGNORE';
4147 local $SIG{TERM} = 'IGNORE';
4148 local $SIG{TSTP} = 'IGNORE';
4149 local $SIG{PIPE} = 'IGNORE';
4151 my $oldAutoCommit = $FS::UID::AutoCommit;
4152 local $FS::UID::AutoCommit = 0;
4155 $self->select_for_update; #mutex
4157 unless ( $self->total_credited ) {
4158 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4162 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
4163 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
4165 my @invoices = $self->open_cust_bill;
4166 @invoices = sort { $b->_date <=> $a->_date } @invoices
4167 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
4170 foreach my $cust_bill ( @invoices ) {
4173 if ( !defined($credit) || $credit->credited == 0) {
4174 $credit = pop @credits or last;
4177 if ($cust_bill->owed >= $credit->credited) {
4178 $amount=$credit->credited;
4180 $amount=$cust_bill->owed;
4183 my $cust_credit_bill = new FS::cust_credit_bill ( {
4184 'crednum' => $credit->crednum,
4185 'invnum' => $cust_bill->invnum,
4186 'amount' => $amount,
4188 my $error = $cust_credit_bill->insert;
4190 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4194 redo if ($cust_bill->owed > 0);
4198 my $total_credited = $self->total_credited;
4200 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4202 return $total_credited;
4205 =item apply_payments
4207 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
4208 to outstanding invoice balances in chronological order.
4210 #and returns the value of any remaining unapplied payments.
4212 Dies if there is an error.
4216 sub apply_payments {
4219 local $SIG{HUP} = 'IGNORE';
4220 local $SIG{INT} = 'IGNORE';
4221 local $SIG{QUIT} = 'IGNORE';
4222 local $SIG{TERM} = 'IGNORE';
4223 local $SIG{TSTP} = 'IGNORE';
4224 local $SIG{PIPE} = 'IGNORE';
4226 my $oldAutoCommit = $FS::UID::AutoCommit;
4227 local $FS::UID::AutoCommit = 0;
4230 $self->select_for_update; #mutex
4234 my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
4235 qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
4237 my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
4238 qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
4242 foreach my $cust_bill ( @invoices ) {
4245 if ( !defined($payment) || $payment->unapplied == 0 ) {
4246 $payment = pop @payments or last;
4249 if ( $cust_bill->owed >= $payment->unapplied ) {
4250 $amount = $payment->unapplied;
4252 $amount = $cust_bill->owed;
4255 my $cust_bill_pay = new FS::cust_bill_pay ( {
4256 'paynum' => $payment->paynum,
4257 'invnum' => $cust_bill->invnum,
4258 'amount' => $amount,
4260 my $error = $cust_bill_pay->insert;
4262 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4266 redo if ( $cust_bill->owed > 0);
4270 my $total_unapplied_payments = $self->total_unapplied_payments;
4272 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4274 return $total_unapplied_payments;
4277 =item total_credited
4279 Returns the total outstanding credit (see L<FS::cust_credit>) for this
4280 customer. See L<FS::cust_credit/credited>.
4284 sub total_credited {
4286 my $total_credit = 0;
4287 foreach my $cust_credit ( qsearch('cust_credit', {
4288 'custnum' => $self->custnum,
4290 $total_credit += $cust_credit->credited;
4292 sprintf( "%.2f", $total_credit );
4295 =item total_unapplied_payments
4297 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
4298 See L<FS::cust_pay/unapplied>.
4302 sub total_unapplied_payments {
4304 my $total_unapplied = 0;
4305 foreach my $cust_pay ( qsearch('cust_pay', {
4306 'custnum' => $self->custnum,
4308 $total_unapplied += $cust_pay->unapplied;
4310 sprintf( "%.2f", $total_unapplied );
4313 =item total_unapplied_refunds
4315 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
4316 customer. See L<FS::cust_refund/unapplied>.
4320 sub total_unapplied_refunds {
4322 my $total_unapplied = 0;
4323 foreach my $cust_refund ( qsearch('cust_refund', {
4324 'custnum' => $self->custnum,
4326 $total_unapplied += $cust_refund->unapplied;
4328 sprintf( "%.2f", $total_unapplied );
4333 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4334 total_credited minus total_unapplied_payments).
4342 + $self->total_unapplied_refunds
4343 - $self->total_credited
4344 - $self->total_unapplied_payments
4348 =item balance_date TIME
4350 Returns the balance for this customer, only considering invoices with date
4351 earlier than TIME (total_owed_date minus total_credited minus
4352 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
4353 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
4362 $self->total_owed_date($time)
4363 + $self->total_unapplied_refunds
4364 - $self->total_credited
4365 - $self->total_unapplied_payments
4369 =item in_transit_payments
4371 Returns the total of requests for payments for this customer pending in
4372 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
4376 sub in_transit_payments {
4378 my $in_transit_payments = 0;
4379 foreach my $pay_batch ( qsearch('pay_batch', {
4382 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4383 'batchnum' => $pay_batch->batchnum,
4384 'custnum' => $self->custnum,
4386 $in_transit_payments += $cust_pay_batch->amount;
4389 sprintf( "%.2f", $in_transit_payments );
4392 =item paydate_monthyear
4394 Returns a two-element list consisting of the month and year of this customer's
4395 paydate (credit card expiration date for CARD customers)
4399 sub paydate_monthyear {
4401 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4403 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4410 =item invoicing_list [ ARRAYREF ]
4412 If an arguement is given, sets these email addresses as invoice recipients
4413 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
4414 (except as warnings), so use check_invoicing_list first.
4416 Returns a list of email addresses (with svcnum entries expanded).
4418 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
4419 check it without disturbing anything by passing nothing.
4421 This interface may change in the future.
4425 sub invoicing_list {
4426 my( $self, $arrayref ) = @_;
4429 my @cust_main_invoice;
4430 if ( $self->custnum ) {
4431 @cust_main_invoice =
4432 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4434 @cust_main_invoice = ();
4436 foreach my $cust_main_invoice ( @cust_main_invoice ) {
4437 #warn $cust_main_invoice->destnum;
4438 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4439 #warn $cust_main_invoice->destnum;
4440 my $error = $cust_main_invoice->delete;
4441 warn $error if $error;
4444 if ( $self->custnum ) {
4445 @cust_main_invoice =
4446 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4448 @cust_main_invoice = ();
4450 my %seen = map { $_->address => 1 } @cust_main_invoice;
4451 foreach my $address ( @{$arrayref} ) {
4452 next if exists $seen{$address} && $seen{$address};
4453 $seen{$address} = 1;
4454 my $cust_main_invoice = new FS::cust_main_invoice ( {
4455 'custnum' => $self->custnum,
4458 my $error = $cust_main_invoice->insert;
4459 warn $error if $error;
4463 if ( $self->custnum ) {
4465 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4472 =item check_invoicing_list ARRAYREF
4474 Checks these arguements as valid input for the invoicing_list method. If there
4475 is an error, returns the error, otherwise returns false.
4479 sub check_invoicing_list {
4480 my( $self, $arrayref ) = @_;
4482 foreach my $address ( @$arrayref ) {
4484 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4485 return 'Can\'t add FAX invoice destination with a blank FAX number.';
4488 my $cust_main_invoice = new FS::cust_main_invoice ( {
4489 'custnum' => $self->custnum,
4492 my $error = $self->custnum
4493 ? $cust_main_invoice->check
4494 : $cust_main_invoice->checkdest
4496 return $error if $error;
4500 return "Email address required"
4501 if $conf->exists('cust_main-require_invoicing_list_email')
4502 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4507 =item set_default_invoicing_list
4509 Sets the invoicing list to all accounts associated with this customer,
4510 overwriting any previous invoicing list.
4514 sub set_default_invoicing_list {
4516 $self->invoicing_list($self->all_emails);
4521 Returns the email addresses of all accounts provisioned for this customer.
4528 foreach my $cust_pkg ( $self->all_pkgs ) {
4529 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4531 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4532 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4534 $list{$_}=1 foreach map { $_->email } @svc_acct;
4539 =item invoicing_list_addpost
4541 Adds postal invoicing to this customer. If this customer is already configured
4542 to receive postal invoices, does nothing.
4546 sub invoicing_list_addpost {
4548 return if grep { $_ eq 'POST' } $self->invoicing_list;
4549 my @invoicing_list = $self->invoicing_list;
4550 push @invoicing_list, 'POST';
4551 $self->invoicing_list(\@invoicing_list);
4554 =item invoicing_list_emailonly
4556 Returns the list of email invoice recipients (invoicing_list without non-email
4557 destinations such as POST and FAX).
4561 sub invoicing_list_emailonly {
4563 warn "$me invoicing_list_emailonly called"
4565 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4568 =item invoicing_list_emailonly_scalar
4570 Returns the list of email invoice recipients (invoicing_list without non-email
4571 destinations such as POST and FAX) as a comma-separated scalar.
4575 sub invoicing_list_emailonly_scalar {
4577 warn "$me invoicing_list_emailonly_scalar called"
4579 join(', ', $self->invoicing_list_emailonly);
4582 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4584 Returns an array of customers referred by this customer (referral_custnum set
4585 to this custnum). If DEPTH is given, recurses up to the given depth, returning
4586 customers referred by customers referred by this customer and so on, inclusive.
4587 The default behavior is DEPTH 1 (no recursion).
4591 sub referral_cust_main {
4593 my $depth = @_ ? shift : 1;
4594 my $exclude = @_ ? shift : {};
4597 map { $exclude->{$_->custnum}++; $_; }
4598 grep { ! $exclude->{ $_->custnum } }
4599 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4603 map { $_->referral_cust_main($depth-1, $exclude) }
4610 =item referral_cust_main_ncancelled
4612 Same as referral_cust_main, except only returns customers with uncancelled
4617 sub referral_cust_main_ncancelled {
4619 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4622 =item referral_cust_pkg [ DEPTH ]
4624 Like referral_cust_main, except returns a flat list of all unsuspended (and
4625 uncancelled) packages for each customer. The number of items in this list may
4626 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4630 sub referral_cust_pkg {
4632 my $depth = @_ ? shift : 1;
4634 map { $_->unsuspended_pkgs }
4635 grep { $_->unsuspended_pkgs }
4636 $self->referral_cust_main($depth);
4639 =item referring_cust_main
4641 Returns the single cust_main record for the customer who referred this customer
4642 (referral_custnum), or false.
4646 sub referring_cust_main {
4648 return '' unless $self->referral_custnum;
4649 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4652 =item credit AMOUNT, REASON
4654 Applies a credit to this customer. If there is an error, returns the error,
4655 otherwise returns false.
4660 my( $self, $amount, $reason, %options ) = @_;
4661 my $cust_credit = new FS::cust_credit {
4662 'custnum' => $self->custnum,
4663 'amount' => $amount,
4664 'reason' => $reason,
4666 $cust_credit->insert(%options);
4669 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4671 Creates a one-time charge for this customer. If there is an error, returns
4672 the error, otherwise returns false.
4678 my ( $amount, $pkg, $comment, $taxclass, $additional, $classnum );
4679 if ( ref( $_[0] ) ) {
4680 $amount = $_[0]->{amount};
4681 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4682 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
4683 : '$'. sprintf("%.2f",$amount);
4684 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4685 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
4686 $additional = $_[0]->{additional};
4689 $pkg = @_ ? shift : 'One-time charge';
4690 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
4691 $taxclass = @_ ? shift : '';
4695 local $SIG{HUP} = 'IGNORE';
4696 local $SIG{INT} = 'IGNORE';
4697 local $SIG{QUIT} = 'IGNORE';
4698 local $SIG{TERM} = 'IGNORE';
4699 local $SIG{TSTP} = 'IGNORE';
4700 local $SIG{PIPE} = 'IGNORE';
4702 my $oldAutoCommit = $FS::UID::AutoCommit;
4703 local $FS::UID::AutoCommit = 0;
4706 my $part_pkg = new FS::part_pkg ( {
4708 'comment' => $comment,
4712 'classnum' => $classnum ? $classnum : '',
4713 'taxclass' => $taxclass,
4716 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4717 ( 0 .. @$additional - 1 )
4719 'additional_count' => scalar(@$additional),
4720 'setup_fee' => $amount,
4723 my $error = $part_pkg->insert( options => \%options );
4725 $dbh->rollback if $oldAutoCommit;
4729 my $pkgpart = $part_pkg->pkgpart;
4730 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4731 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4732 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4733 $error = $type_pkgs->insert;
4735 $dbh->rollback if $oldAutoCommit;
4740 my $cust_pkg = new FS::cust_pkg ( {
4741 'custnum' => $self->custnum,
4742 'pkgpart' => $pkgpart,
4745 $error = $cust_pkg->insert;
4747 $dbh->rollback if $oldAutoCommit;
4751 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4758 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4764 sort { $a->_date <=> $b->_date }
4765 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4768 =item open_cust_bill
4770 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4775 sub open_cust_bill {
4777 grep { $_->owed > 0 } $self->cust_bill;
4782 Returns all the credits (see L<FS::cust_credit>) for this customer.
4788 sort { $a->_date <=> $b->_date }
4789 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4794 Returns all the payments (see L<FS::cust_pay>) for this customer.
4800 sort { $a->_date <=> $b->_date }
4801 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4806 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4812 sort { $a->_date <=> $b->_date }
4813 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4816 =item cust_pay_batch
4818 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
4822 sub cust_pay_batch {
4824 sort { $a->_date <=> $b->_date }
4825 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
4830 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4836 sort { $a->_date <=> $b->_date }
4837 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4842 Returns a name string for this customer, either "Company (Last, First)" or
4849 my $name = $self->contact;
4850 $name = $self->company. " ($name)" if $self->company;
4856 Returns a name string for this (service/shipping) contact, either
4857 "Company (Last, First)" or "Last, First".
4863 if ( $self->get('ship_last') ) {
4864 my $name = $self->ship_contact;
4865 $name = $self->ship_company. " ($name)" if $self->ship_company;
4874 Returns this customer's full (billing) contact name only, "Last, First"
4880 $self->get('last'). ', '. $self->first;
4885 Returns this customer's full (shipping) contact name only, "Last, First"
4891 $self->get('ship_last')
4892 ? $self->get('ship_last'). ', '. $self->ship_first
4898 Returns this customer's full country name
4904 code2country($self->country);
4907 =item geocode DATA_VENDOR
4909 Returns a value for the customer location as encoded by DATA_VENDOR.
4910 Currently this only makes sense for "CCH" as DATA_VENDOR.
4915 my ($self, $data_vendor) = (shift, shift); #always cch for now
4917 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
4921 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
4922 if $self->country eq 'US';
4924 #CCH specific location stuff
4925 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
4928 my $cust_tax_location =
4930 'table' => 'cust_tax_location',
4931 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
4932 'extra_sql' => $extra_sql,
4935 $geocode = $cust_tax_location->geocode
4936 if $cust_tax_location;
4945 Returns a status string for this customer, currently:
4949 =item prospect - No packages have ever been ordered
4951 =item active - One or more recurring packages is active
4953 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4955 =item suspended - All non-cancelled recurring packages are suspended
4957 =item cancelled - All recurring packages are cancelled
4963 sub status { shift->cust_status(@_); }
4967 for my $status (qw( prospect active inactive suspended cancelled )) {
4968 my $method = $status.'_sql';
4969 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4970 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4971 $sth->execute( ($self->custnum) x $numnum )
4972 or die "Error executing 'SELECT $sql': ". $sth->errstr;
4973 return $status if $sth->fetchrow_arrayref->[0];
4977 =item ucfirst_cust_status
4979 =item ucfirst_status
4981 Returns the status with the first character capitalized.
4985 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4987 sub ucfirst_cust_status {
4989 ucfirst($self->cust_status);
4994 Returns a hex triplet color string for this customer's status.
4998 use vars qw(%statuscolor);
4999 tie my %statuscolor, 'Tie::IxHash',
5000 'prospect' => '7e0079', #'000000', #black? naw, purple
5001 'active' => '00CC00', #green
5002 'inactive' => '0000CC', #blue
5003 'suspended' => 'FF9900', #yellow
5004 'cancelled' => 'FF0000', #red
5007 sub statuscolor { shift->cust_statuscolor(@_); }
5009 sub cust_statuscolor {
5011 $statuscolor{$self->cust_status};
5016 Returns an array of hashes representing the customer's RT tickets.
5023 my $num = $conf->config('cust_main-max_tickets') || 10;
5026 unless ( $conf->config('ticket_system-custom_priority_field') ) {
5028 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
5032 foreach my $priority (
5033 $conf->config('ticket_system-custom_priority_field-values'), ''
5035 last if scalar(@tickets) >= $num;
5037 @{ FS::TicketSystem->customer_tickets( $self->custnum,
5038 $num - scalar(@tickets),
5047 # Return services representing svc_accts in customer support packages
5048 sub support_services {
5050 my %packages = map { $_ => 1 } $conf->config('support_packages');
5052 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
5053 grep { $_->part_svc->svcdb eq 'svc_acct' }
5054 map { $_->cust_svc }
5055 grep { exists $packages{ $_->pkgpart } }
5056 $self->ncancelled_pkgs;
5062 =head1 CLASS METHODS
5068 Class method that returns the list of possible status strings for customers
5069 (see L<the status method|/status>). For example:
5071 @statuses = FS::cust_main->statuses();
5076 #my $self = shift; #could be class...
5082 Returns an SQL expression identifying prospective cust_main records (customers
5083 with no packages ever ordered)
5087 use vars qw($select_count_pkgs);
5088 $select_count_pkgs =
5089 "SELECT COUNT(*) FROM cust_pkg
5090 WHERE cust_pkg.custnum = cust_main.custnum";
5092 sub select_count_pkgs_sql {
5096 sub prospect_sql { "
5097 0 = ( $select_count_pkgs )
5102 Returns an SQL expression identifying active cust_main records (customers with
5103 no active recurring packages, but otherwise unsuspended/uncancelled).
5108 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
5114 Returns an SQL expression identifying inactive cust_main records (customers with
5115 active recurring packages).
5119 sub inactive_sql { "
5120 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5122 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
5128 Returns an SQL expression identifying suspended cust_main records.
5133 sub suspended_sql { susp_sql(@_); }
5135 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
5137 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5143 Returns an SQL expression identifying cancelled cust_main records.
5147 sub cancelled_sql { cancel_sql(@_); }
5150 my $recurring_sql = FS::cust_pkg->recurring_sql;
5151 #my $recurring_sql = "
5152 # '0' != ( select freq from part_pkg
5153 # where cust_pkg.pkgpart = part_pkg.pkgpart )
5157 0 < ( $select_count_pkgs )
5158 AND 0 = ( $select_count_pkgs AND $recurring_sql
5159 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5165 =item uncancelled_sql
5167 Returns an SQL expression identifying un-cancelled cust_main records.
5171 sub uncancelled_sql { uncancel_sql(@_); }
5172 sub uncancel_sql { "
5173 ( 0 < ( $select_count_pkgs
5174 AND ( cust_pkg.cancel IS NULL
5175 OR cust_pkg.cancel = 0
5178 OR 0 = ( $select_count_pkgs )
5184 Returns an SQL fragment to retreive the balance.
5189 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5190 WHERE cust_bill.custnum = cust_main.custnum )
5191 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
5192 WHERE cust_pay.custnum = cust_main.custnum )
5193 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
5194 WHERE cust_credit.custnum = cust_main.custnum )
5195 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
5196 WHERE cust_refund.custnum = cust_main.custnum )
5199 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5201 Returns an SQL fragment to retreive the balance for this customer, only
5202 considering invoices with date earlier than START_TIME, and optionally not
5203 later than END_TIME (total_owed_date minus total_credited minus
5204 total_unapplied_payments).
5206 Times are specified as SQL fragments or numeric
5207 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
5208 L<Date::Parse> for conversion functions. The empty string can be passed
5209 to disable that time constraint completely.
5211 Available options are:
5215 =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)
5217 =item total - set to true to remove all customer comparison clauses, for totals
5219 =item where - WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5221 =item join - JOIN clause (typically used with the total option)
5229 sub balance_date_sql {
5230 my( $class, $start, $end, %opt ) = @_;
5232 my $owed = FS::cust_bill->owed_sql;
5233 my $unapp_refund = FS::cust_refund->unapplied_sql;
5234 my $unapp_credit = FS::cust_credit->unapplied_sql;
5235 my $unapp_pay = FS::cust_pay->unapplied_sql;
5237 my $j = $opt{'join'} || '';
5239 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
5240 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5241 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5242 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
5244 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
5245 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5246 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5247 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
5252 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5254 Helper method for balance_date_sql; name (and usage) subject to change
5255 (suggestions welcome).
5257 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5258 cust_refund, cust_credit or cust_pay).
5260 If TABLE is "cust_bill" or the unapplied_date option is true, only
5261 considers records with date earlier than START_TIME, and optionally not
5262 later than END_TIME .
5266 sub _money_table_where {
5267 my( $class, $table, $start, $end, %opt ) = @_;
5270 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5271 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5272 push @where, "$table._date <= $start" if defined($start) && length($start);
5273 push @where, "$table._date > $end" if defined($end) && length($end);
5275 push @where, @{$opt{'where'}} if $opt{'where'};
5276 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5282 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
5284 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
5285 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
5286 appropriate ship_ field is also searched).
5288 Additional options are the same as FS::Record::qsearch
5293 my( $self, $fuzzy, $hash, @opt) = @_;
5298 check_and_rebuild_fuzzyfiles();
5299 foreach my $field ( keys %$fuzzy ) {
5301 my $all = $self->all_X($field);
5302 next unless scalar(@$all);
5305 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
5308 foreach ( keys %match ) {
5309 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
5310 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
5313 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
5316 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
5318 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
5326 Returns a masked version of the named field
5331 my ($self,$field) = @_;
5335 'x'x(length($self->getfield($field))-4).
5336 substr($self->getfield($field), (length($self->getfield($field))-4));
5346 =item smart_search OPTION => VALUE ...
5348 Accepts the following options: I<search>, the string to search for. The string
5349 will be searched for as a customer number, phone number, name or company name,
5350 as an exact, or, in some cases, a substring or fuzzy match (see the source code
5351 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
5352 skip fuzzy matching when an exact match is found.
5354 Any additional options are treated as an additional qualifier on the search
5357 Returns a (possibly empty) array of FS::cust_main objects.
5364 #here is the agent virtualization
5365 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5369 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
5370 my $search = delete $options{'search'};
5371 ( my $alphanum_search = $search ) =~ s/\W//g;
5373 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
5375 #false laziness w/Record::ut_phone
5376 my $phonen = "$1-$2-$3";
5377 $phonen .= " x$4" if $4;
5379 push @cust_main, qsearch( {
5380 'table' => 'cust_main',
5381 'hashref' => { %options },
5382 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5384 join(' OR ', map "$_ = '$phonen'",
5385 qw( daytime night fax
5386 ship_daytime ship_night ship_fax )
5389 " AND $agentnums_sql", #agent virtualization
5392 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
5393 #try looking for matches with extensions unless one was specified
5395 push @cust_main, qsearch( {
5396 'table' => 'cust_main',
5397 'hashref' => { %options },
5398 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5400 join(' OR ', map "$_ LIKE '$phonen\%'",
5402 ship_daytime ship_night )
5405 " AND $agentnums_sql", #agent virtualization
5410 # custnum search (also try agent_custid), with some tweaking options if your
5411 # legacy cust "numbers" have letters
5412 } elsif ( $search =~ /^\s*(\d+)\s*$/
5413 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
5414 && $search =~ /^\s*(\w\w?\d+)\s*$/
5419 push @cust_main, qsearch( {
5420 'table' => 'cust_main',
5421 'hashref' => { 'custnum' => $1, %options },
5422 'extra_sql' => " AND $agentnums_sql", #agent virtualization
5425 push @cust_main, qsearch( {
5426 'table' => 'cust_main',
5427 'hashref' => { 'agent_custid' => $1, %options },
5428 'extra_sql' => " AND $agentnums_sql", #agent virtualization
5431 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
5433 my($company, $last, $first) = ( $1, $2, $3 );
5435 # "Company (Last, First)"
5436 #this is probably something a browser remembered,
5437 #so just do an exact search
5439 foreach my $prefix ( '', 'ship_' ) {
5440 push @cust_main, qsearch( {
5441 'table' => 'cust_main',
5442 'hashref' => { $prefix.'first' => $first,
5443 $prefix.'last' => $last,
5444 $prefix.'company' => $company,
5447 'extra_sql' => " AND $agentnums_sql",
5451 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
5452 # try (ship_){last,company}
5456 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
5457 # # full strings the browser remembers won't work
5458 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
5460 use Lingua::EN::NameParse;
5461 my $NameParse = new Lingua::EN::NameParse(
5463 allow_reversed => 1,
5466 my($last, $first) = ( '', '' );
5467 #maybe disable this too and just rely on NameParse?
5468 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
5470 ($last, $first) = ( $1, $2 );
5472 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
5473 } elsif ( ! $NameParse->parse($value) ) {
5475 my %name = $NameParse->components;
5476 $first = $name{'given_name_1'};
5477 $last = $name{'surname_1'};
5481 if ( $first && $last ) {
5483 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
5486 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5488 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
5489 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
5492 push @cust_main, qsearch( {
5493 'table' => 'cust_main',
5494 'hashref' => \%options,
5495 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5498 # or it just be something that was typed in... (try that in a sec)
5502 my $q_value = dbh->quote($value);
5505 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5506 $sql .= " ( LOWER(last) = $q_value
5507 OR LOWER(company) = $q_value
5508 OR LOWER(ship_last) = $q_value
5509 OR LOWER(ship_company) = $q_value
5512 push @cust_main, qsearch( {
5513 'table' => 'cust_main',
5514 'hashref' => \%options,
5515 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5518 #no exact match, trying substring/fuzzy
5519 #always do substring & fuzzy (unless they're explicity config'ed off)
5520 #getting complaints searches are not returning enough
5521 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
5523 #still some false laziness w/ search/cust_main.cgi
5528 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
5529 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
5532 if ( $first && $last ) {
5535 { 'first' => { op=>'ILIKE', value=>"%$first%" },
5536 'last' => { op=>'ILIKE', value=>"%$last%" },
5538 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
5539 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
5546 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
5547 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
5551 foreach my $hashref ( @hashrefs ) {
5553 push @cust_main, qsearch( {
5554 'table' => 'cust_main',
5555 'hashref' => { %$hashref,
5558 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
5567 " AND $agentnums_sql", #extra_sql #agent virtualization
5570 if ( $first && $last ) {
5571 push @cust_main, FS::cust_main->fuzzy_search(
5572 { 'last' => $last, #fuzzy hashref
5573 'first' => $first }, #
5577 foreach my $field ( 'last', 'company' ) {
5579 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
5584 #eliminate duplicates
5586 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5596 Accepts the following options: I<email>, the email address to search for. The
5597 email address will be searched for as an email invoice destination and as an
5600 #Any additional options are treated as an additional qualifier on the search
5601 #(i.e. I<agentnum>).
5603 Returns a (possibly empty) array of FS::cust_main objects (but usually just
5613 my $email = delete $options{'email'};
5615 #we're only being used by RT at the moment... no agent virtualization yet
5616 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5620 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
5622 my ( $user, $domain ) = ( $1, $2 );
5624 warn "$me smart_search: searching for $user in domain $domain"
5630 'table' => 'cust_main_invoice',
5631 'hashref' => { 'dest' => $email },
5638 map $_->cust_svc->cust_pkg,
5640 'table' => 'svc_acct',
5641 'hashref' => { 'username' => $user, },
5643 'AND ( SELECT domain FROM svc_domain
5644 WHERE svc_acct.domsvc = svc_domain.svcnum
5645 ) = '. dbh->quote($domain),
5651 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5653 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
5660 =item check_and_rebuild_fuzzyfiles
5664 use vars qw(@fuzzyfields);
5665 @fuzzyfields = ( 'last', 'first', 'company' );
5667 sub check_and_rebuild_fuzzyfiles {
5668 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5669 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
5672 =item rebuild_fuzzyfiles
5676 sub rebuild_fuzzyfiles {
5678 use Fcntl qw(:flock);
5680 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5681 mkdir $dir, 0700 unless -d $dir;
5683 foreach my $fuzzy ( @fuzzyfields ) {
5685 open(LOCK,">>$dir/cust_main.$fuzzy")
5686 or die "can't open $dir/cust_main.$fuzzy: $!";
5688 or die "can't lock $dir/cust_main.$fuzzy: $!";
5690 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
5691 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
5693 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
5694 my $sth = dbh->prepare("SELECT $field FROM cust_main".
5695 " WHERE $field != '' AND $field IS NOT NULL");
5696 $sth->execute or die $sth->errstr;
5698 while ( my $row = $sth->fetchrow_arrayref ) {
5699 print CACHE $row->[0]. "\n";
5704 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
5706 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
5717 my( $self, $field ) = @_;
5718 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5719 open(CACHE,"<$dir/cust_main.$field")
5720 or die "can't open $dir/cust_main.$field: $!";
5721 my @array = map { chomp; $_; } <CACHE>;
5726 =item append_fuzzyfiles LASTNAME COMPANY
5730 sub append_fuzzyfiles {
5731 #my( $first, $last, $company ) = @_;
5733 &check_and_rebuild_fuzzyfiles;
5735 use Fcntl qw(:flock);
5737 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5739 foreach my $field (qw( first last company )) {
5744 open(CACHE,">>$dir/cust_main.$field")
5745 or die "can't open $dir/cust_main.$field: $!";
5746 flock(CACHE,LOCK_EX)
5747 or die "can't lock $dir/cust_main.$field: $!";
5749 print CACHE "$value\n";
5751 flock(CACHE,LOCK_UN)
5752 or die "can't unlock $dir/cust_main.$field: $!";
5767 #warn join('-',keys %$param);
5768 my $fh = $param->{filehandle};
5769 my $agentnum = $param->{agentnum};
5771 my $refnum = $param->{refnum};
5772 my $pkgpart = $param->{pkgpart};
5774 #my @fields = @{$param->{fields}};
5775 my $format = $param->{'format'};
5778 if ( $format eq 'simple' ) {
5779 @fields = qw( cust_pkg.setup dayphone first last
5780 address1 address2 city state zip comments );
5782 } elsif ( $format eq 'extended' ) {
5783 @fields = qw( agent_custid refnum
5784 last first address1 address2 city state zip country
5786 ship_last ship_first ship_address1 ship_address2
5787 ship_city ship_state ship_zip ship_country
5788 payinfo paycvv paydate
5791 svc_acct.username svc_acct._password
5794 } elsif ( $format eq 'extended-plus_company' ) {
5795 @fields = qw( agent_custid refnum
5796 last first company address1 address2 city state zip country
5798 ship_last ship_first ship_company ship_address1 ship_address2
5799 ship_city ship_state ship_zip ship_country
5800 payinfo paycvv paydate
5803 svc_acct.username svc_acct._password
5807 die "unknown format $format";
5810 eval "use Text::CSV_XS;";
5813 my $csv = new Text::CSV_XS;
5820 local $SIG{HUP} = 'IGNORE';
5821 local $SIG{INT} = 'IGNORE';
5822 local $SIG{QUIT} = 'IGNORE';
5823 local $SIG{TERM} = 'IGNORE';
5824 local $SIG{TSTP} = 'IGNORE';
5825 local $SIG{PIPE} = 'IGNORE';
5827 my $oldAutoCommit = $FS::UID::AutoCommit;
5828 local $FS::UID::AutoCommit = 0;
5831 #while ( $columns = $csv->getline($fh) ) {
5833 while ( defined($line=<$fh>) ) {
5835 $csv->parse($line) or do {
5836 $dbh->rollback if $oldAutoCommit;
5837 return "can't parse: ". $csv->error_input();
5840 my @columns = $csv->fields();
5841 #warn join('-',@columns);
5844 agentnum => $agentnum,
5846 country => $conf->config('countrydefault') || 'US',
5847 payby => $payby, #default
5848 paydate => '12/2037', #default
5850 my $billtime = time;
5851 my %cust_pkg = ( pkgpart => $pkgpart );
5853 foreach my $field ( @fields ) {
5855 if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
5857 #$cust_pkg{$1} = str2time( shift @$columns );
5858 if ( $1 eq 'pkgpart' ) {
5859 $cust_pkg{$1} = shift @columns;
5860 } elsif ( $1 eq 'setup' ) {
5861 $billtime = str2time(shift @columns);
5863 $cust_pkg{$1} = str2time( shift @columns );
5866 } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
5868 $svc_acct{$1} = shift @columns;
5872 #refnum interception
5873 if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
5875 my $referral = $columns[0];
5876 my %hash = ( 'referral' => $referral,
5877 'agentnum' => $agentnum,
5881 my $part_referral = qsearchs('part_referral', \%hash )
5882 || new FS::part_referral \%hash;
5884 unless ( $part_referral->refnum ) {
5885 my $error = $part_referral->insert;
5887 $dbh->rollback if $oldAutoCommit;
5888 return "can't auto-insert advertising source: $referral: $error";
5892 $columns[0] = $part_referral->refnum;
5895 #$cust_main{$field} = shift @$columns;
5896 $cust_main{$field} = shift @columns;
5900 $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
5902 my $invoicing_list = $cust_main{'invoicing_list'}
5903 ? [ delete $cust_main{'invoicing_list'} ]
5906 my $cust_main = new FS::cust_main ( \%cust_main );
5909 tie my %hash, 'Tie::RefHash'; #this part is important
5911 if ( $cust_pkg{'pkgpart'} ) {
5912 my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
5915 if ( $svc_acct{'username'} ) {
5916 my $part_pkg = $cust_pkg->part_pkg;
5917 unless ( $part_pkg ) {
5918 $dbh->rollback if $oldAutoCommit;
5919 return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
5921 $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
5922 push @svc_acct, new FS::svc_acct ( \%svc_acct )
5925 $hash{$cust_pkg} = \@svc_acct;
5928 my $error = $cust_main->insert( \%hash, $invoicing_list );
5931 $dbh->rollback if $oldAutoCommit;
5932 return "can't insert customer for $line: $error";
5935 if ( $format eq 'simple' ) {
5937 #false laziness w/bill.cgi
5938 $error = $cust_main->bill( 'time' => $billtime );
5940 $dbh->rollback if $oldAutoCommit;
5941 return "can't bill customer for $line: $error";
5944 $error = $cust_main->apply_payments_and_credits;
5946 $dbh->rollback if $oldAutoCommit;
5947 return "can't bill customer for $line: $error";
5950 $error = $cust_main->collect();
5952 $dbh->rollback if $oldAutoCommit;
5953 return "can't collect customer for $line: $error";
5961 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5963 return "Empty file!" unless $imported;
5975 #warn join('-',keys %$param);
5976 my $fh = $param->{filehandle};
5977 my @fields = @{$param->{fields}};
5979 eval "use Text::CSV_XS;";
5982 my $csv = new Text::CSV_XS;
5989 local $SIG{HUP} = 'IGNORE';
5990 local $SIG{INT} = 'IGNORE';
5991 local $SIG{QUIT} = 'IGNORE';
5992 local $SIG{TERM} = 'IGNORE';
5993 local $SIG{TSTP} = 'IGNORE';
5994 local $SIG{PIPE} = 'IGNORE';
5996 my $oldAutoCommit = $FS::UID::AutoCommit;
5997 local $FS::UID::AutoCommit = 0;
6000 #while ( $columns = $csv->getline($fh) ) {
6002 while ( defined($line=<$fh>) ) {
6004 $csv->parse($line) or do {
6005 $dbh->rollback if $oldAutoCommit;
6006 return "can't parse: ". $csv->error_input();
6009 my @columns = $csv->fields();
6010 #warn join('-',@columns);
6013 foreach my $field ( @fields ) {
6014 $row{$field} = shift @columns;
6017 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
6018 unless ( $cust_main ) {
6019 $dbh->rollback if $oldAutoCommit;
6020 return "unknown custnum $row{'custnum'}";
6023 if ( $row{'amount'} > 0 ) {
6024 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
6026 $dbh->rollback if $oldAutoCommit;
6030 } elsif ( $row{'amount'} < 0 ) {
6031 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
6034 $dbh->rollback if $oldAutoCommit;
6044 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6046 return "Empty file!" unless $imported;
6052 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6054 Sends a templated email notification to the customer (see L<Text::Template>).
6056 OPTIONS is a hash and may include
6058 I<from> - the email sender (default is invoice_from)
6060 I<to> - comma-separated scalar or arrayref of recipients
6061 (default is invoicing_list)
6063 I<subject> - The subject line of the sent email notification
6064 (default is "Notice from company_name")
6066 I<extra_fields> - a hashref of name/value pairs which will be substituted
6069 The following variables are vavailable in the template.
6071 I<$first> - the customer first name
6072 I<$last> - the customer last name
6073 I<$company> - the customer company
6074 I<$payby> - a description of the method of payment for the customer
6075 # would be nice to use FS::payby::shortname
6076 I<$payinfo> - the account information used to collect for this customer
6077 I<$expdate> - the expiration of the customer payment in seconds from epoch
6082 my ($customer, $template, %options) = @_;
6084 return unless $conf->exists($template);
6086 my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
6087 $from = $options{from} if exists($options{from});
6089 my $to = join(',', $customer->invoicing_list_emailonly);
6090 $to = $options{to} if exists($options{to});
6092 my $subject = "Notice from " . $conf->config('company_name')
6093 if $conf->exists('company_name');
6094 $subject = $options{subject} if exists($options{subject});
6096 my $notify_template = new Text::Template (TYPE => 'ARRAY',
6097 SOURCE => [ map "$_\n",
6098 $conf->config($template)]
6100 or die "can't create new Text::Template object: Text::Template::ERROR";
6101 $notify_template->compile()
6102 or die "can't compile template: Text::Template::ERROR";
6104 $FS::notify_template::_template::company_name = $conf->config('company_name');
6105 $FS::notify_template::_template::company_address =
6106 join("\n", $conf->config('company_address') ). "\n";
6108 my $paydate = $customer->paydate || '2037-12-31';
6109 $FS::notify_template::_template::first = $customer->first;
6110 $FS::notify_template::_template::last = $customer->last;
6111 $FS::notify_template::_template::company = $customer->company;
6112 $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
6113 my $payby = $customer->payby;
6114 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6115 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6117 #credit cards expire at the end of the month/year of their exp date
6118 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6119 $FS::notify_template::_template::payby = 'credit card';
6120 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6121 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6123 }elsif ($payby eq 'COMP') {
6124 $FS::notify_template::_template::payby = 'complimentary account';
6126 $FS::notify_template::_template::payby = 'current method';
6128 $FS::notify_template::_template::expdate = $expire_time;
6130 for (keys %{$options{extra_fields}}){
6132 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
6135 send_email(from => $from,
6137 subject => $subject,
6138 body => $notify_template->fill_in( PACKAGE =>
6139 'FS::notify_template::_template' ),
6144 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6146 Generates a templated notification to the customer (see L<Text::Template>).
6148 OPTIONS is a hash and may include
6150 I<extra_fields> - a hashref of name/value pairs which will be substituted
6151 into the template. These values may override values mentioned below
6152 and those from the customer record.
6154 The following variables are available in the template instead of or in addition
6155 to the fields of the customer record.
6157 I<$payby> - a description of the method of payment for the customer
6158 # would be nice to use FS::payby::shortname
6159 I<$payinfo> - the masked account information used to collect for this customer
6160 I<$expdate> - the expiration of the customer payment method in seconds from epoch
6161 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
6165 sub generate_letter {
6166 my ($self, $template, %options) = @_;
6168 return unless $conf->exists($template);
6170 my $letter_template = new Text::Template
6172 SOURCE => [ map "$_\n", $conf->config($template)],
6173 DELIMITERS => [ '[@--', '--@]' ],
6175 or die "can't create new Text::Template object: Text::Template::ERROR";
6177 $letter_template->compile()
6178 or die "can't compile template: Text::Template::ERROR";
6180 my %letter_data = map { $_ => $self->$_ } $self->fields;
6181 $letter_data{payinfo} = $self->mask_payinfo;
6183 #my $paydate = $self->paydate || '2037-12-31';
6184 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
6186 my $payby = $self->payby;
6187 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6188 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6190 #credit cards expire at the end of the month/year of their exp date
6191 if ($payby eq 'CARD' || $payby eq 'DCRD') {
6192 $letter_data{payby} = 'credit card';
6193 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6194 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6196 }elsif ($payby eq 'COMP') {
6197 $letter_data{payby} = 'complimentary account';
6199 $letter_data{payby} = 'current method';
6201 $letter_data{expdate} = $expire_time;
6203 for (keys %{$options{extra_fields}}){
6204 $letter_data{$_} = $options{extra_fields}->{$_};
6207 unless(exists($letter_data{returnaddress})){
6208 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
6209 $self->agent_template)
6211 if ( length($retadd) ) {
6212 $letter_data{returnaddress} = $retadd;
6213 } elsif ( grep /\S/, $conf->config('company_address') ) {
6214 $letter_data{returnaddress} =
6215 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
6216 $conf->config('company_address')
6219 $letter_data{returnaddress} = '~';
6223 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
6225 $letter_data{company_name} = $conf->config('company_name');
6227 my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
6228 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
6232 ) or die "can't open temp file: $!\n";
6234 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
6236 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
6240 =item print_ps TEMPLATE
6242 Returns an postscript letter filled in from TEMPLATE, as a scalar.
6248 my $file = $self->generate_letter(@_);
6249 FS::Misc::generate_ps($file);
6252 =item print TEMPLATE
6254 Prints the filled in template.
6256 TEMPLATE is the name of a L<Text::Template> to fill in and print.
6260 sub queueable_print {
6263 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
6264 or die "invalid customer number: " . $opt{custvnum};
6266 my $error = $self->print( $opt{template} );
6267 die $error if $error;
6271 my ($self, $template) = (shift, shift);
6272 do_print [ $self->print_ps($template) ];
6275 sub agent_template {
6277 $self->_agent_plandata('agent_templatename');
6280 sub agent_invoice_from {
6282 $self->_agent_plandata('agent_invoice_from');
6285 sub _agent_plandata {
6286 my( $self, $option ) = @_;
6288 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
6289 #agent-specific Conf
6291 use FS::part_event::Condition;
6293 my $agentnum = $self->agentnum;
6296 if ( driver_name =~ /^Pg/i ) {
6298 } elsif ( driver_name =~ /^mysql/i ) {
6301 die "don't know how to use regular expressions in ". driver_name. " databases";
6304 my $part_event_option =
6306 'select' => 'part_event_option.*',
6307 'table' => 'part_event_option',
6309 LEFT JOIN part_event USING ( eventpart )
6310 LEFT JOIN part_event_option AS peo_agentnum
6311 ON ( part_event.eventpart = peo_agentnum.eventpart
6312 AND peo_agentnum.optionname = 'agentnum'
6313 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
6315 LEFT JOIN part_event_option AS peo_cust_bill_age
6316 ON ( part_event.eventpart = peo_cust_bill_age.eventpart
6317 AND peo_cust_bill_age.optionname = 'cust_bill_age'
6320 #'hashref' => { 'optionname' => $option },
6321 #'hashref' => { 'part_event_option.optionname' => $option },
6323 " WHERE part_event_option.optionname = ". dbh->quote($option).
6324 " AND action = 'cust_bill_send_agent' ".
6325 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
6326 " AND peo_agentnum.optionname = 'agentnum' ".
6327 " AND agentnum IS NULL OR agentnum = $agentnum ".
6329 CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
6331 ELSE ". FS::part_event::Condition->age2seconds_sql('peo_cust_bill_age.optionvalue').
6333 , part_event.weight".
6337 unless ( $part_event_option ) {
6338 return $self->agent->invoice_template || ''
6339 if $option eq 'agent_templatename';
6343 $part_event_option->optionvalue;
6348 ## actual sub, not a method, designed to be called from the queue.
6349 ## sets up the customer, and calls the bill_and_collect
6350 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
6351 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
6352 $cust_main->bill_and_collect(
6363 The delete method should possibly take an FS::cust_main object reference
6364 instead of a scalar customer number.
6366 Bill and collect options should probably be passed as references instead of a
6369 There should probably be a configuration file with a list of allowed credit
6372 No multiple currency support (probably a larger project than just this module).
6374 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
6376 Birthdates rely on negative epoch values.
6378 The payby for card/check batches is broken. With mixed batching, bad
6381 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
6385 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
6386 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
6387 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.