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);
15 use Digest::MD5 qw(md5_base64);
18 use File::Temp qw( tempfile );
19 use String::Approx qw(amatch);
20 use Business::CreditCard 0.28;
22 use FS::UID qw( getotaker dbh driver_name );
23 use FS::Record qw( qsearchs qsearch dbdef );
24 use FS::Misc qw( generate_email send_email generate_ps do_print );
25 use FS::Msgcat qw(gettext);
30 use FS::cust_bill_pkg;
31 use FS::cust_bill_pkg_display;
32 use FS::cust_bill_pkg_tax_location;
34 use FS::cust_pay_pending;
35 use FS::cust_pay_void;
36 use FS::cust_pay_batch;
39 use FS::part_referral;
40 use FS::cust_main_county;
41 use FS::cust_location;
43 use FS::cust_tax_location;
44 use FS::part_pkg_taxrate;
46 use FS::cust_main_invoice;
47 use FS::cust_credit_bill;
48 use FS::cust_bill_pay;
49 use FS::prepay_credit;
53 use FS::part_event_condition;
56 use FS::payment_gateway;
57 use FS::agent_payment_gateway;
59 use FS::payinfo_Mixin;
62 @ISA = qw( FS::payinfo_Mixin FS::Record );
64 @EXPORT_OK = qw( smart_search );
66 $realtime_bop_decline_quiet = 0;
68 # 1 is mostly method/subroutine entry and options
69 # 2 traces progress of some operations
70 # 3 is even more information including possibly sensitive data
72 $me = '[FS::cust_main]';
76 $ignore_expired_card = 0;
78 @encrypted_fields = ('payinfo', 'paycvv');
79 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
81 #ask FS::UID to run this stuff for us later
82 #$FS::UID::callback{'FS::cust_main'} = sub {
83 install_callback FS::UID sub {
85 #yes, need it for stuff below (prolly should be cached)
90 my ( $hashref, $cache ) = @_;
91 if ( exists $hashref->{'pkgnum'} ) {
92 #@{ $self->{'_pkgnum'} } = ();
93 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
94 $self->{'_pkgnum'} = $subcache;
95 #push @{ $self->{'_pkgnum'} },
96 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
102 FS::cust_main - Object methods for cust_main records
108 $record = new FS::cust_main \%hash;
109 $record = new FS::cust_main { 'column' => 'value' };
111 $error = $record->insert;
113 $error = $new_record->replace($old_record);
115 $error = $record->delete;
117 $error = $record->check;
119 @cust_pkg = $record->all_pkgs;
121 @cust_pkg = $record->ncancelled_pkgs;
123 @cust_pkg = $record->suspended_pkgs;
125 $error = $record->bill;
126 $error = $record->bill %options;
127 $error = $record->bill 'time' => $time;
129 $error = $record->collect;
130 $error = $record->collect %options;
131 $error = $record->collect 'invoice_time' => $time,
136 An FS::cust_main object represents a customer. FS::cust_main inherits from
137 FS::Record. The following fields are currently supported:
143 Primary key (assigned automatically for new customers)
147 Agent (see L<FS::agent>)
151 Advertising source (see L<FS::part_referral>)
163 Cocial security number (optional)
179 (optional, see L<FS::cust_main_county>)
183 (see L<FS::cust_main_county>)
189 (see L<FS::cust_main_county>)
225 (optional, see L<FS::cust_main_county>)
229 (see L<FS::cust_main_county>)
235 (see L<FS::cust_main_county>)
251 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
255 Payment Information (See L<FS::payinfo_Mixin> for data format)
259 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
263 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
267 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
271 Start date month (maestro/solo cards only)
275 Start date year (maestro/solo cards only)
279 Issue number (maestro/solo cards only)
283 Name on card or billing name
287 IP address from which payment information was received
291 Tax exempt, empty or `Y'
295 Order taker (assigned automatically, see L<FS::UID>)
301 =item referral_custnum
303 Referring customer number
307 Enable individual CDR spooling, empty or `Y'
311 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
315 Discourage individual CDR printing, empty or `Y'
325 Creates a new customer. To add the customer to the database, see L<"insert">.
327 Note that this stores the hash reference, not a distinct copy of the hash it
328 points to. You can ask the object for a copy with the I<hash> method.
332 sub table { 'cust_main'; }
334 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
336 Adds this customer to the database. If there is an error, returns the error,
337 otherwise returns false.
339 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
340 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
341 are inserted atomicly, or the transaction is rolled back. Passing an empty
342 hash reference is equivalent to not supplying this parameter. There should be
343 a better explanation of this, but until then, here's an example:
346 tie %hash, 'Tie::RefHash'; #this part is important
348 $cust_pkg => [ $svc_acct ],
351 $cust_main->insert( \%hash );
353 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
354 be set as the invoicing list (see L<"invoicing_list">). Errors return as
355 expected and rollback the entire transaction; it is not necessary to call
356 check_invoicing_list first. The invoicing_list is set after the records in the
357 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
358 invoicing_list destination to the newly-created svc_acct. Here's an example:
360 $cust_main->insert( {}, [ $email, 'POST' ] );
362 Currently available options are: I<depend_jobnum> and I<noexport>.
364 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
365 on the supplied jobnum (they will not run until the specific job completes).
366 This can be used to defer provisioning until some action completes (such
367 as running the customer's credit card successfully).
369 The I<noexport> option is deprecated. If I<noexport> is set true, no
370 provisioning jobs (exports) are scheduled. (You can schedule them later with
371 the B<reexport> method.)
377 my $cust_pkgs = @_ ? shift : {};
378 my $invoicing_list = @_ ? shift : '';
380 warn "$me insert called with options ".
381 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
384 local $SIG{HUP} = 'IGNORE';
385 local $SIG{INT} = 'IGNORE';
386 local $SIG{QUIT} = 'IGNORE';
387 local $SIG{TERM} = 'IGNORE';
388 local $SIG{TSTP} = 'IGNORE';
389 local $SIG{PIPE} = 'IGNORE';
391 my $oldAutoCommit = $FS::UID::AutoCommit;
392 local $FS::UID::AutoCommit = 0;
395 my $prepay_identifier = '';
396 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
398 if ( $self->payby eq 'PREPAY' ) {
400 $self->payby('BILL');
401 $prepay_identifier = $self->payinfo;
404 warn " looking up prepaid card $prepay_identifier\n"
407 my $error = $self->get_prepay( $prepay_identifier,
408 'amount_ref' => \$amount,
409 'seconds_ref' => \$seconds,
410 'upbytes_ref' => \$upbytes,
411 'downbytes_ref' => \$downbytes,
412 'totalbytes_ref' => \$totalbytes,
415 $dbh->rollback if $oldAutoCommit;
416 #return "error applying prepaid card (transaction rolled back): $error";
420 $payby = 'PREP' if $amount;
422 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
425 $self->payby('BILL');
426 $amount = $self->paid;
430 warn " inserting $self\n"
433 $self->signupdate(time) unless $self->signupdate;
435 $self->auto_agent_custid()
436 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
438 my $error = $self->SUPER::insert;
440 $dbh->rollback if $oldAutoCommit;
441 #return "inserting cust_main record (transaction rolled back): $error";
445 warn " setting invoicing list\n"
448 if ( $invoicing_list ) {
449 $error = $self->check_invoicing_list( $invoicing_list );
451 $dbh->rollback if $oldAutoCommit;
452 #return "checking invoicing_list (transaction rolled back): $error";
455 $self->invoicing_list( $invoicing_list );
458 if ( $conf->config('cust_main-skeleton_tables')
459 && $conf->config('cust_main-skeleton_custnum') ) {
461 warn " inserting skeleton records\n"
464 my $error = $self->start_copy_skel;
466 $dbh->rollback if $oldAutoCommit;
472 warn " ordering packages\n"
475 $error = $self->order_pkgs( $cust_pkgs,
477 'seconds_ref' => \$seconds,
478 'upbytes_ref' => \$upbytes,
479 'downbytes_ref' => \$downbytes,
480 'totalbytes_ref' => \$totalbytes,
483 $dbh->rollback if $oldAutoCommit;
488 $dbh->rollback if $oldAutoCommit;
489 return "No svc_acct record to apply pre-paid time";
491 if ( $upbytes || $downbytes || $totalbytes ) {
492 $dbh->rollback if $oldAutoCommit;
493 return "No svc_acct record to apply pre-paid data";
497 warn " inserting initial $payby payment of $amount\n"
499 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
501 $dbh->rollback if $oldAutoCommit;
502 return "inserting payment (transaction rolled back): $error";
506 unless ( $import || $skip_fuzzyfiles ) {
507 warn " queueing fuzzyfiles update\n"
509 $error = $self->queue_fuzzyfiles_update;
511 $dbh->rollback if $oldAutoCommit;
512 return "updating fuzzy search cache: $error";
516 warn " insert complete; committing transaction\n"
519 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
524 use File::CounterFile;
525 sub auto_agent_custid {
528 my $format = $conf->config('cust_main-auto_agent_custid');
530 if ( $format eq '1YMMXXXXXXXX' ) {
532 my $counter = new File::CounterFile 'cust_main.agent_custid';
535 my $ym = 100000000000 + time2str('%y%m00000000', time);
536 if ( $ym > $counter->value ) {
537 $counter->{'value'} = $agent_custid = $ym;
538 $counter->{'updated'} = 1;
540 $agent_custid = $counter->inc;
546 die "Unknown cust_main-auto_agent_custid format: $format";
549 $self->agent_custid($agent_custid);
553 sub start_copy_skel {
556 #'mg_user_preference' => {},
557 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
558 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
559 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
560 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
561 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
564 _copy_skel( 'cust_main', #tablename
565 $conf->config('cust_main-skeleton_custnum'), #sourceid
566 $self->custnum, #destid
567 @tables, #child tables
571 #recursive subroutine, not a method
573 my( $table, $sourceid, $destid, %child_tables ) = @_;
576 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
577 ( $table, $primary_key ) = ( $1, $2 );
579 my $dbdef_table = dbdef->table($table);
580 $primary_key = $dbdef_table->primary_key
581 or return "$table has no primary key".
582 " (or do you need to run dbdef-create?)";
585 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
586 join (', ', keys %child_tables). "\n"
589 foreach my $child_table_def ( keys %child_tables ) {
593 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
594 ( $child_table, $child_pkey ) = ( $1, $2 );
596 $child_table = $child_table_def;
598 $child_pkey = dbdef->table($child_table)->primary_key;
599 # or return "$table has no primary key".
600 # " (or do you need to run dbdef-create?)\n";
604 if ( keys %{ $child_tables{$child_table_def} } ) {
606 return "$child_table has no primary key".
607 " (run dbdef-create or try specifying it?)\n"
610 #false laziness w/Record::insert and only works on Pg
611 #refactor the proper last-inserted-id stuff out of Record::insert if this
612 # ever gets use for anything besides a quick kludge for one customer
613 my $default = dbdef->table($child_table)->column($child_pkey)->default;
614 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
615 or return "can't parse $child_table.$child_pkey default value ".
616 " for sequence name: $default";
621 my @sel_columns = grep { $_ ne $primary_key }
622 dbdef->table($child_table)->columns;
623 my $sel_columns = join(', ', @sel_columns );
625 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
626 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
627 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
629 my $sel_st = "SELECT $sel_columns FROM $child_table".
630 " WHERE $primary_key = $sourceid";
633 my $sel_sth = dbh->prepare( $sel_st )
634 or return dbh->errstr;
636 $sel_sth->execute or return $sel_sth->errstr;
638 while ( my $row = $sel_sth->fetchrow_hashref ) {
640 warn " selected row: ".
641 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
645 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
646 my $ins_sth =dbh->prepare($statement)
647 or return dbh->errstr;
648 my @param = ( $destid, map $row->{$_}, @ins_columns );
649 warn " $statement: [ ". join(', ', @param). " ]\n"
651 $ins_sth->execute( @param )
652 or return $ins_sth->errstr;
654 #next unless keys %{ $child_tables{$child_table} };
655 next unless $sequence;
657 #another section of that laziness
658 my $seq_sql = "SELECT currval('$sequence')";
659 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
660 $seq_sth->execute or return $seq_sth->errstr;
661 my $insertid = $seq_sth->fetchrow_arrayref->[0];
663 # don't drink soap! recurse! recurse! okay!
665 _copy_skel( $child_table_def,
666 $row->{$child_pkey}, #sourceid
668 %{ $child_tables{$child_table_def} },
670 return $error if $error;
680 =item order_pkg HASHREF | OPTION => VALUE ...
682 Orders a single package.
684 Options may be passed as a list of key/value pairs or as a hash reference.
695 Optional FS::cust_location object
699 Optional arryaref of FS::svc_* service objects.
703 If this option is set to a job queue jobnum (see L<FS::queue>), all provisioning
704 jobs will have a dependancy on the supplied job (they will not run until the
705 specific job completes). This can be used to defer provisioning until some
706 action completes (such as running the customer's credit card successfully).
714 my $opt = ref($_[0]) ? shift : { @_ };
716 warn "$me order_pkg called with options ".
717 join(', ', map { "$_: $opt->{$_}" } keys %$opt ). "\n"
720 my $cust_pkg = $opt->{'cust_pkg'};
721 my $svcs = $opt->{'svcs'} || [];
723 my %svc_options = ();
724 $svc_options{'depend_jobnum'} = $opt->{'depend_jobnum'}
725 if exists($opt->{'depend_jobnum'}) && $opt->{'depend_jobnum'};
727 local $SIG{HUP} = 'IGNORE';
728 local $SIG{INT} = 'IGNORE';
729 local $SIG{QUIT} = 'IGNORE';
730 local $SIG{TERM} = 'IGNORE';
731 local $SIG{TSTP} = 'IGNORE';
732 local $SIG{PIPE} = 'IGNORE';
734 my $oldAutoCommit = $FS::UID::AutoCommit;
735 local $FS::UID::AutoCommit = 0;
738 if ( $opt->{'cust_location'} &&
739 ( ! $cust_pkg->locationnum || $cust_pkg->locationnum == -1 ) ) {
740 my $error = $opt->{'cust_location'}->insert;
742 $dbh->rollback if $oldAutoCommit;
743 return "inserting cust_location (transaction rolled back): $error";
745 $cust_pkg->locationnum($opt->{'cust_location'}->locationnum);
748 $cust_pkg->custnum( $self->custnum );
750 my $error = $cust_pkg->insert;
752 $dbh->rollback if $oldAutoCommit;
753 return "inserting cust_pkg (transaction rolled back): $error";
756 foreach my $svc_something ( @{ $opt->{'svcs'} } ) {
757 if ( $svc_something->svcnum ) {
758 my $old_cust_svc = $svc_something->cust_svc;
759 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
760 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
761 $error = $new_cust_svc->replace($old_cust_svc);
763 $svc_something->pkgnum( $cust_pkg->pkgnum );
764 if ( $svc_something->isa('FS::svc_acct') ) {
765 foreach ( grep { $opt->{$_.'_ref'} && ${ $opt->{$_.'_ref'} } }
766 qw( seconds upbytes downbytes totalbytes ) ) {
767 $svc_something->$_( $svc_something->$_() + ${ $opt->{$_.'_ref'} } );
768 ${ $opt->{$_.'_ref'} } = 0;
771 $error = $svc_something->insert(%svc_options);
774 $dbh->rollback if $oldAutoCommit;
775 return "inserting svc_ (transaction rolled back): $error";
779 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
784 #deprecated #=item order_pkgs HASHREF [ , SECONDSREF ] [ , OPTION => VALUE ... ]
785 =item order_pkgs HASHREF [ , OPTION => VALUE ... ]
787 Like the insert method on an existing record, this method orders multiple
788 packages and included services atomicaly. Pass a Tie::RefHash data structure
789 to this method containing FS::cust_pkg and FS::svc_I<tablename> objects.
790 There should be a better explanation of this, but until then, here's an
794 tie %hash, 'Tie::RefHash'; #this part is important
796 $cust_pkg => [ $svc_acct ],
799 $cust_main->order_pkgs( \%hash, 'noexport'=>1 );
801 Services can be new, in which case they are inserted, or existing unaudited
802 services, in which case they are linked to the newly-created package.
804 Currently available options are: I<depend_jobnum>, I<noexport>, I<seconds_ref>,
805 I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>.
807 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
808 on the supplied jobnum (they will not run until the specific job completes).
809 This can be used to defer provisioning until some action completes (such
810 as running the customer's credit card successfully).
812 The I<noexport> option is deprecated. If I<noexport> is set true, no
813 provisioning jobs (exports) are scheduled. (You can schedule them later with
814 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
815 on the cust_main object is not recommended, as existing services will also be
818 If I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, or I<totalbytes_ref> is
819 provided, the scalars (provided by references) will be incremented by the
820 values of the prepaid card.`
826 my $cust_pkgs = shift;
827 my $seconds_ref = ref($_[0]) ? shift : ''; #deprecated
829 $seconds_ref ||= $options{'seconds_ref'};
831 warn "$me order_pkgs called with options ".
832 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
835 local $SIG{HUP} = 'IGNORE';
836 local $SIG{INT} = 'IGNORE';
837 local $SIG{QUIT} = 'IGNORE';
838 local $SIG{TERM} = 'IGNORE';
839 local $SIG{TSTP} = 'IGNORE';
840 local $SIG{PIPE} = 'IGNORE';
842 my $oldAutoCommit = $FS::UID::AutoCommit;
843 local $FS::UID::AutoCommit = 0;
846 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
848 foreach my $cust_pkg ( keys %$cust_pkgs ) {
850 my $error = $self->order_pkg(
851 'cust_pkg' => $cust_pkg,
852 'svcs' => $cust_pkgs->{$cust_pkg},
853 'seconds_ref' => $seconds_ref,
854 map { $_ => $options{$_} } qw( upbytes_ref downbytes_ref totalbytes_ref
859 $dbh->rollback if $oldAutoCommit;
865 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
869 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
871 Recharges this (existing) customer with the specified prepaid card (see
872 L<FS::prepay_credit>), specified either by I<identifier> or as an
873 FS::prepay_credit object. If there is an error, returns the error, otherwise
876 Optionally, five scalar references can be passed as well. They will have their
877 values filled in with the amount, number of seconds, and number of upload,
878 download, and total bytes applied by this prepaid card.
882 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
883 #the only place that uses these args
884 sub recharge_prepay {
885 my( $self, $prepay_credit, $amountref, $secondsref,
886 $upbytesref, $downbytesref, $totalbytesref ) = @_;
888 local $SIG{HUP} = 'IGNORE';
889 local $SIG{INT} = 'IGNORE';
890 local $SIG{QUIT} = 'IGNORE';
891 local $SIG{TERM} = 'IGNORE';
892 local $SIG{TSTP} = 'IGNORE';
893 local $SIG{PIPE} = 'IGNORE';
895 my $oldAutoCommit = $FS::UID::AutoCommit;
896 local $FS::UID::AutoCommit = 0;
899 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
901 my $error = $self->get_prepay( $prepay_credit,
902 'amount_ref' => \$amount,
903 'seconds_ref' => \$seconds,
904 'upbytes_ref' => \$upbytes,
905 'downbytes_ref' => \$downbytes,
906 'totalbytes_ref' => \$totalbytes,
908 || $self->increment_seconds($seconds)
909 || $self->increment_upbytes($upbytes)
910 || $self->increment_downbytes($downbytes)
911 || $self->increment_totalbytes($totalbytes)
912 || $self->insert_cust_pay_prepay( $amount,
914 ? $prepay_credit->identifier
919 $dbh->rollback if $oldAutoCommit;
923 if ( defined($amountref) ) { $$amountref = $amount; }
924 if ( defined($secondsref) ) { $$secondsref = $seconds; }
925 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
926 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
927 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
929 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
934 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
936 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
937 specified either by I<identifier> or as an FS::prepay_credit object.
939 Available options are: I<amount_ref>, I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>. The scalars (provided by references) will be
940 incremented by the values of the prepaid card.
942 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
943 check or set this customer's I<agentnum>.
945 If there is an error, returns the error, otherwise returns false.
951 my( $self, $prepay_credit, %opt ) = @_;
953 local $SIG{HUP} = 'IGNORE';
954 local $SIG{INT} = 'IGNORE';
955 local $SIG{QUIT} = 'IGNORE';
956 local $SIG{TERM} = 'IGNORE';
957 local $SIG{TSTP} = 'IGNORE';
958 local $SIG{PIPE} = 'IGNORE';
960 my $oldAutoCommit = $FS::UID::AutoCommit;
961 local $FS::UID::AutoCommit = 0;
964 unless ( ref($prepay_credit) ) {
966 my $identifier = $prepay_credit;
968 $prepay_credit = qsearchs(
970 { 'identifier' => $prepay_credit },
975 unless ( $prepay_credit ) {
976 $dbh->rollback if $oldAutoCommit;
977 return "Invalid prepaid card: ". $identifier;
982 if ( $prepay_credit->agentnum ) {
983 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
984 $dbh->rollback if $oldAutoCommit;
985 return "prepaid card not valid for agent ". $self->agentnum;
987 $self->agentnum($prepay_credit->agentnum);
990 my $error = $prepay_credit->delete;
992 $dbh->rollback if $oldAutoCommit;
993 return "removing prepay_credit (transaction rolled back): $error";
996 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
997 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
999 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1004 =item increment_upbytes SECONDS
1006 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1007 the specified number of upbytes. If there is an error, returns the error,
1008 otherwise returns false.
1012 sub increment_upbytes {
1013 _increment_column( shift, 'upbytes', @_);
1016 =item increment_downbytes SECONDS
1018 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1019 the specified number of downbytes. If there is an error, returns the error,
1020 otherwise returns false.
1024 sub increment_downbytes {
1025 _increment_column( shift, 'downbytes', @_);
1028 =item increment_totalbytes SECONDS
1030 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1031 the specified number of totalbytes. If there is an error, returns the error,
1032 otherwise returns false.
1036 sub increment_totalbytes {
1037 _increment_column( shift, 'totalbytes', @_);
1040 =item increment_seconds SECONDS
1042 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1043 the specified number of seconds. If there is an error, returns the error,
1044 otherwise returns false.
1048 sub increment_seconds {
1049 _increment_column( shift, 'seconds', @_);
1052 =item _increment_column AMOUNT
1054 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1055 the specified number of seconds or bytes. If there is an error, returns
1056 the error, otherwise returns false.
1060 sub _increment_column {
1061 my( $self, $column, $amount ) = @_;
1062 warn "$me increment_column called: $column, $amount\n"
1065 return '' unless $amount;
1067 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1068 $self->ncancelled_pkgs;
1070 if ( ! @cust_pkg ) {
1071 return 'No packages with primary or single services found'.
1072 ' to apply pre-paid time';
1073 } elsif ( scalar(@cust_pkg) > 1 ) {
1074 #maybe have a way to specify the package/account?
1075 return 'Multiple packages found to apply pre-paid time';
1078 my $cust_pkg = $cust_pkg[0];
1079 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1083 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1085 if ( ! @cust_svc ) {
1086 return 'No account found to apply pre-paid time';
1087 } elsif ( scalar(@cust_svc) > 1 ) {
1088 return 'Multiple accounts found to apply pre-paid time';
1091 my $svc_acct = $cust_svc[0]->svc_x;
1092 warn " found service svcnum ". $svc_acct->pkgnum.
1093 ' ('. $svc_acct->email. ")\n"
1096 $column = "increment_$column";
1097 $svc_acct->$column($amount);
1101 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1103 Inserts a prepayment in the specified amount for this customer. An optional
1104 second argument can specify the prepayment identifier for tracking purposes.
1105 If there is an error, returns the error, otherwise returns false.
1109 sub insert_cust_pay_prepay {
1110 shift->insert_cust_pay('PREP', @_);
1113 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1115 Inserts a cash payment in the specified amount for this customer. An optional
1116 second argument can specify the payment identifier for tracking purposes.
1117 If there is an error, returns the error, otherwise returns false.
1121 sub insert_cust_pay_cash {
1122 shift->insert_cust_pay('CASH', @_);
1125 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1127 Inserts a Western Union payment in the specified amount for this customer. An
1128 optional second argument can specify the prepayment identifier for tracking
1129 purposes. If there is an error, returns the error, otherwise returns false.
1133 sub insert_cust_pay_west {
1134 shift->insert_cust_pay('WEST', @_);
1137 sub insert_cust_pay {
1138 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1139 my $payinfo = scalar(@_) ? shift : '';
1141 my $cust_pay = new FS::cust_pay {
1142 'custnum' => $self->custnum,
1143 'paid' => sprintf('%.2f', $amount),
1144 #'_date' => #date the prepaid card was purchased???
1146 'payinfo' => $payinfo,
1154 This method is deprecated. See the I<depend_jobnum> option to the insert and
1155 order_pkgs methods for a better way to defer provisioning.
1157 Re-schedules all exports by calling the B<reexport> method of all associated
1158 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
1159 otherwise returns false.
1166 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1167 "use the depend_jobnum option to insert or order_pkgs to delay export";
1169 local $SIG{HUP} = 'IGNORE';
1170 local $SIG{INT} = 'IGNORE';
1171 local $SIG{QUIT} = 'IGNORE';
1172 local $SIG{TERM} = 'IGNORE';
1173 local $SIG{TSTP} = 'IGNORE';
1174 local $SIG{PIPE} = 'IGNORE';
1176 my $oldAutoCommit = $FS::UID::AutoCommit;
1177 local $FS::UID::AutoCommit = 0;
1180 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1181 my $error = $cust_pkg->reexport;
1183 $dbh->rollback if $oldAutoCommit;
1188 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1193 =item delete NEW_CUSTNUM
1195 This deletes the customer. If there is an error, returns the error, otherwise
1198 This will completely remove all traces of the customer record. This is not
1199 what you want when a customer cancels service; for that, cancel all of the
1200 customer's packages (see L</cancel>).
1202 If the customer has any uncancelled packages, you need to pass a new (valid)
1203 customer number for those packages to be transferred to. Cancelled packages
1204 will be deleted. Did I mention that this is NOT what you want when a customer
1205 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
1207 You can't delete a customer with invoices (see L<FS::cust_bill>),
1208 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
1209 refunds (see L<FS::cust_refund>).
1216 local $SIG{HUP} = 'IGNORE';
1217 local $SIG{INT} = 'IGNORE';
1218 local $SIG{QUIT} = 'IGNORE';
1219 local $SIG{TERM} = 'IGNORE';
1220 local $SIG{TSTP} = 'IGNORE';
1221 local $SIG{PIPE} = 'IGNORE';
1223 my $oldAutoCommit = $FS::UID::AutoCommit;
1224 local $FS::UID::AutoCommit = 0;
1227 if ( $self->cust_bill ) {
1228 $dbh->rollback if $oldAutoCommit;
1229 return "Can't delete a customer with invoices";
1231 if ( $self->cust_credit ) {
1232 $dbh->rollback if $oldAutoCommit;
1233 return "Can't delete a customer with credits";
1235 if ( $self->cust_pay ) {
1236 $dbh->rollback if $oldAutoCommit;
1237 return "Can't delete a customer with payments";
1239 if ( $self->cust_refund ) {
1240 $dbh->rollback if $oldAutoCommit;
1241 return "Can't delete a customer with refunds";
1244 my @cust_pkg = $self->ncancelled_pkgs;
1246 my $new_custnum = shift;
1247 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1248 $dbh->rollback if $oldAutoCommit;
1249 return "Invalid new customer number: $new_custnum";
1251 foreach my $cust_pkg ( @cust_pkg ) {
1252 my %hash = $cust_pkg->hash;
1253 $hash{'custnum'} = $new_custnum;
1254 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1255 my $error = $new_cust_pkg->replace($cust_pkg,
1256 options => { $cust_pkg->options },
1259 $dbh->rollback if $oldAutoCommit;
1264 my @cancelled_cust_pkg = $self->all_pkgs;
1265 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1266 my $error = $cust_pkg->delete;
1268 $dbh->rollback if $oldAutoCommit;
1273 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1274 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1276 my $error = $cust_main_invoice->delete;
1278 $dbh->rollback if $oldAutoCommit;
1283 my $error = $self->SUPER::delete;
1285 $dbh->rollback if $oldAutoCommit;
1289 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1294 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ]
1296 Replaces the OLD_RECORD with this one in the database. If there is an error,
1297 returns the error, otherwise returns false.
1299 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1300 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1301 expected and rollback the entire transaction; it is not necessary to call
1302 check_invoicing_list first. Here's an example:
1304 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1311 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1313 : $self->replace_old;
1317 warn "$me replace called\n"
1320 my $curuser = $FS::CurrentUser::CurrentUser;
1321 if ( $self->payby eq 'COMP'
1322 && $self->payby ne $old->payby
1323 && ! $curuser->access_right('Complimentary customer')
1326 return "You are not permitted to create complimentary accounts.";
1329 local($ignore_expired_card) = 1
1330 if $old->payby =~ /^(CARD|DCRD)$/
1331 && $self->payby =~ /^(CARD|DCRD)$/
1332 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1334 local $SIG{HUP} = 'IGNORE';
1335 local $SIG{INT} = 'IGNORE';
1336 local $SIG{QUIT} = 'IGNORE';
1337 local $SIG{TERM} = 'IGNORE';
1338 local $SIG{TSTP} = 'IGNORE';
1339 local $SIG{PIPE} = 'IGNORE';
1341 my $oldAutoCommit = $FS::UID::AutoCommit;
1342 local $FS::UID::AutoCommit = 0;
1345 my $error = $self->SUPER::replace($old);
1348 $dbh->rollback if $oldAutoCommit;
1352 if ( @param ) { # INVOICING_LIST_ARYREF
1353 my $invoicing_list = shift @param;
1354 $error = $self->check_invoicing_list( $invoicing_list );
1356 $dbh->rollback if $oldAutoCommit;
1359 $self->invoicing_list( $invoicing_list );
1362 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1363 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1364 # card/check/lec info has changed, want to retry realtime_ invoice events
1365 my $error = $self->retry_realtime;
1367 $dbh->rollback if $oldAutoCommit;
1372 unless ( $import || $skip_fuzzyfiles ) {
1373 $error = $self->queue_fuzzyfiles_update;
1375 $dbh->rollback if $oldAutoCommit;
1376 return "updating fuzzy search cache: $error";
1380 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1385 =item queue_fuzzyfiles_update
1387 Used by insert & replace to update the fuzzy search cache
1391 sub queue_fuzzyfiles_update {
1394 local $SIG{HUP} = 'IGNORE';
1395 local $SIG{INT} = 'IGNORE';
1396 local $SIG{QUIT} = 'IGNORE';
1397 local $SIG{TERM} = 'IGNORE';
1398 local $SIG{TSTP} = 'IGNORE';
1399 local $SIG{PIPE} = 'IGNORE';
1401 my $oldAutoCommit = $FS::UID::AutoCommit;
1402 local $FS::UID::AutoCommit = 0;
1405 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1406 my $error = $queue->insert( map $self->getfield($_),
1407 qw(first last company)
1410 $dbh->rollback if $oldAutoCommit;
1411 return "queueing job (transaction rolled back): $error";
1414 if ( $self->ship_last ) {
1415 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1416 $error = $queue->insert( map $self->getfield("ship_$_"),
1417 qw(first last company)
1420 $dbh->rollback if $oldAutoCommit;
1421 return "queueing job (transaction rolled back): $error";
1425 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1432 Checks all fields to make sure this is a valid customer record. If there is
1433 an error, returns the error, otherwise returns false. Called by the insert
1434 and replace methods.
1441 warn "$me check BEFORE: \n". $self->_dump
1445 $self->ut_numbern('custnum')
1446 || $self->ut_number('agentnum')
1447 || $self->ut_textn('agent_custid')
1448 || $self->ut_number('refnum')
1449 || $self->ut_textn('custbatch')
1450 || $self->ut_name('last')
1451 || $self->ut_name('first')
1452 || $self->ut_snumbern('birthdate')
1453 || $self->ut_snumbern('signupdate')
1454 || $self->ut_textn('company')
1455 || $self->ut_text('address1')
1456 || $self->ut_textn('address2')
1457 || $self->ut_text('city')
1458 || $self->ut_textn('county')
1459 || $self->ut_textn('state')
1460 || $self->ut_country('country')
1461 || $self->ut_anything('comments')
1462 || $self->ut_numbern('referral_custnum')
1463 || $self->ut_textn('stateid')
1464 || $self->ut_textn('stateid_state')
1465 || $self->ut_textn('invoice_terms')
1466 || $self->ut_alphan('geocode')
1469 #barf. need message catalogs. i18n. etc.
1470 $error .= "Please select an advertising source."
1471 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1472 return $error if $error;
1474 return "Unknown agent"
1475 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1477 return "Unknown refnum"
1478 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1480 return "Unknown referring custnum: ". $self->referral_custnum
1481 unless ! $self->referral_custnum
1482 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1484 if ( $self->ss eq '' ) {
1489 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1490 or return "Illegal social security number: ". $self->ss;
1491 $self->ss("$1-$2-$3");
1495 # bad idea to disable, causes billing to fail because of no tax rates later
1496 # unless ( $import ) {
1497 unless ( qsearch('cust_main_county', {
1498 'country' => $self->country,
1501 return "Unknown state/county/country: ".
1502 $self->state. "/". $self->county. "/". $self->country
1503 unless qsearch('cust_main_county',{
1504 'state' => $self->state,
1505 'county' => $self->county,
1506 'country' => $self->country,
1512 $self->ut_phonen('daytime', $self->country)
1513 || $self->ut_phonen('night', $self->country)
1514 || $self->ut_phonen('fax', $self->country)
1515 || $self->ut_zip('zip', $self->country)
1517 return $error if $error;
1519 if ( $conf->exists('cust_main-require_phone')
1520 && ! length($self->daytime) && ! length($self->night)
1523 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1525 : FS::Msgcat::_gettext('daytime');
1526 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1528 : FS::Msgcat::_gettext('night');
1530 return "$daytime_label or $night_label is required"
1534 if ( $self->has_ship_address
1535 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1536 $self->addr_fields )
1540 $self->ut_name('ship_last')
1541 || $self->ut_name('ship_first')
1542 || $self->ut_textn('ship_company')
1543 || $self->ut_text('ship_address1')
1544 || $self->ut_textn('ship_address2')
1545 || $self->ut_text('ship_city')
1546 || $self->ut_textn('ship_county')
1547 || $self->ut_textn('ship_state')
1548 || $self->ut_country('ship_country')
1550 return $error if $error;
1552 #false laziness with above
1553 unless ( qsearchs('cust_main_county', {
1554 'country' => $self->ship_country,
1557 return "Unknown ship_state/ship_county/ship_country: ".
1558 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1559 unless qsearch('cust_main_county',{
1560 'state' => $self->ship_state,
1561 'county' => $self->ship_county,
1562 'country' => $self->ship_country,
1568 $self->ut_phonen('ship_daytime', $self->ship_country)
1569 || $self->ut_phonen('ship_night', $self->ship_country)
1570 || $self->ut_phonen('ship_fax', $self->ship_country)
1571 || $self->ut_zip('ship_zip', $self->ship_country)
1573 return $error if $error;
1575 return "Unit # is required."
1576 if $self->ship_address2 =~ /^\s*$/
1577 && $conf->exists('cust_main-require_address2');
1579 } else { # ship_ info eq billing info, so don't store dup info in database
1581 $self->setfield("ship_$_", '')
1582 foreach $self->addr_fields;
1584 return "Unit # is required."
1585 if $self->address2 =~ /^\s*$/
1586 && $conf->exists('cust_main-require_address2');
1590 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1591 # or return "Illegal payby: ". $self->payby;
1593 FS::payby->can_payby($self->table, $self->payby)
1594 or return "Illegal payby: ". $self->payby;
1596 $error = $self->ut_numbern('paystart_month')
1597 || $self->ut_numbern('paystart_year')
1598 || $self->ut_numbern('payissue')
1599 || $self->ut_textn('paytype')
1601 return $error if $error;
1603 if ( $self->payip eq '' ) {
1606 $error = $self->ut_ip('payip');
1607 return $error if $error;
1610 # If it is encrypted and the private key is not availaible then we can't
1611 # check the credit card.
1613 my $check_payinfo = 1;
1615 if ($self->is_encrypted($self->payinfo)) {
1619 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1621 my $payinfo = $self->payinfo;
1622 $payinfo =~ s/\D//g;
1623 $payinfo =~ /^(\d{13,16})$/
1624 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1626 $self->payinfo($payinfo);
1628 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1630 return gettext('unknown_card_type')
1631 if cardtype($self->payinfo) eq "Unknown";
1633 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1635 return 'Banned credit card: banned on '.
1636 time2str('%a %h %o at %r', $ban->_date).
1637 ' by '. $ban->otaker.
1638 ' (ban# '. $ban->bannum. ')';
1641 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1642 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1643 $self->paycvv =~ /^(\d{4})$/
1644 or return "CVV2 (CID) for American Express cards is four digits.";
1647 $self->paycvv =~ /^(\d{3})$/
1648 or return "CVV2 (CVC2/CID) is three digits.";
1655 my $cardtype = cardtype($payinfo);
1656 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1658 return "Start date or issue number is required for $cardtype cards"
1659 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1661 return "Start month must be between 1 and 12"
1662 if $self->paystart_month
1663 and $self->paystart_month < 1 || $self->paystart_month > 12;
1665 return "Start year must be 1990 or later"
1666 if $self->paystart_year
1667 and $self->paystart_year < 1990;
1669 return "Issue number must be beween 1 and 99"
1671 and $self->payissue < 1 || $self->payissue > 99;
1674 $self->paystart_month('');
1675 $self->paystart_year('');
1676 $self->payissue('');
1679 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1681 my $payinfo = $self->payinfo;
1682 $payinfo =~ s/[^\d\@]//g;
1683 if ( $conf->exists('echeck-nonus') ) {
1684 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1685 $payinfo = "$1\@$2";
1687 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1688 $payinfo = "$1\@$2";
1690 $self->payinfo($payinfo);
1693 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1695 return 'Banned ACH account: banned on '.
1696 time2str('%a %h %o at %r', $ban->_date).
1697 ' by '. $ban->otaker.
1698 ' (ban# '. $ban->bannum. ')';
1701 } elsif ( $self->payby eq 'LECB' ) {
1703 my $payinfo = $self->payinfo;
1704 $payinfo =~ s/\D//g;
1705 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1707 $self->payinfo($payinfo);
1710 } elsif ( $self->payby eq 'BILL' ) {
1712 $error = $self->ut_textn('payinfo');
1713 return "Illegal P.O. number: ". $self->payinfo if $error;
1716 } elsif ( $self->payby eq 'COMP' ) {
1718 my $curuser = $FS::CurrentUser::CurrentUser;
1719 if ( ! $self->custnum
1720 && ! $curuser->access_right('Complimentary customer')
1723 return "You are not permitted to create complimentary accounts."
1726 $error = $self->ut_textn('payinfo');
1727 return "Illegal comp account issuer: ". $self->payinfo if $error;
1730 } elsif ( $self->payby eq 'PREPAY' ) {
1732 my $payinfo = $self->payinfo;
1733 $payinfo =~ s/\W//g; #anything else would just confuse things
1734 $self->payinfo($payinfo);
1735 $error = $self->ut_alpha('payinfo');
1736 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1737 return "Unknown prepayment identifier"
1738 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1743 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1744 return "Expiration date required"
1745 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1749 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1750 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1751 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1752 ( $m, $y ) = ( $3, "20$2" );
1754 return "Illegal expiration date: ". $self->paydate;
1756 $self->paydate("$y-$m-01");
1757 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1758 return gettext('expired_card')
1760 && !$ignore_expired_card
1761 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1764 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1765 ( ! $conf->exists('require_cardname')
1766 || $self->payby !~ /^(CARD|DCRD)$/ )
1768 $self->payname( $self->first. " ". $self->getfield('last') );
1770 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1771 or return gettext('illegal_name'). " payname: ". $self->payname;
1775 foreach my $flag (qw( tax spool_cdr squelch_cdr )) {
1776 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1780 $self->otaker(getotaker) unless $self->otaker;
1782 warn "$me check AFTER: \n". $self->_dump
1785 $self->SUPER::check;
1790 Returns a list of fields which have ship_ duplicates.
1795 qw( last first company
1796 address1 address2 city county state zip country
1801 =item has_ship_address
1803 Returns true if this customer record has a separate shipping address.
1807 sub has_ship_address {
1809 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1812 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1814 Returns all packages (see L<FS::cust_pkg>) for this customer.
1820 my $extra_qsearch = ref($_[0]) ? shift : {};
1822 return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
1825 if ( $self->{'_pkgnum'} ) {
1826 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1828 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1831 sort sort_packages @cust_pkg;
1836 Synonym for B<all_pkgs>.
1841 shift->all_pkgs(@_);
1846 Returns all locations (see L<FS::cust_location>) for this customer.
1852 qsearch('cust_location', { 'custnum' => $self->custnum } );
1855 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1857 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1861 sub ncancelled_pkgs {
1863 my $extra_qsearch = ref($_[0]) ? shift : {};
1865 return $self->num_ncancelled_pkgs unless wantarray;
1868 if ( $self->{'_pkgnum'} ) {
1870 warn "$me ncancelled_pkgs: returning cached objects"
1873 @cust_pkg = grep { ! $_->getfield('cancel') }
1874 values %{ $self->{'_pkgnum'}->cache };
1878 warn "$me ncancelled_pkgs: searching for packages with custnum ".
1879 $self->custnum. "\n"
1882 $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
1884 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1888 sort sort_packages @cust_pkg;
1894 my $extra_qsearch = ref($_[0]) ? shift : {};
1896 $extra_qsearch->{'select'} ||= '*';
1897 $extra_qsearch->{'select'} .=
1898 ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
1902 $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
1907 'table' => 'cust_pkg',
1908 'hashref' => { 'custnum' => $self->custnum },
1913 # This should be generalized to use config options to determine order.
1916 if ( $a->get('cancel') xor $b->get('cancel') ) {
1917 return -1 if $b->get('cancel');
1918 return 1 if $a->get('cancel');
1919 #shouldn't get here...
1922 my $a_num_cust_svc = $a->num_cust_svc;
1923 my $b_num_cust_svc = $b->num_cust_svc;
1924 return 0 if !$a_num_cust_svc && !$b_num_cust_svc;
1925 return -1 if $a_num_cust_svc && !$b_num_cust_svc;
1926 return 1 if !$a_num_cust_svc && $b_num_cust_svc;
1927 my @a_cust_svc = $a->cust_svc;
1928 my @b_cust_svc = $b->cust_svc;
1929 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
1934 =item suspended_pkgs
1936 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1940 sub suspended_pkgs {
1942 grep { $_->susp } $self->ncancelled_pkgs;
1945 =item unflagged_suspended_pkgs
1947 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1948 customer (thouse packages without the `manual_flag' set).
1952 sub unflagged_suspended_pkgs {
1954 return $self->suspended_pkgs
1955 unless dbdef->table('cust_pkg')->column('manual_flag');
1956 grep { ! $_->manual_flag } $self->suspended_pkgs;
1959 =item unsuspended_pkgs
1961 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1966 sub unsuspended_pkgs {
1968 grep { ! $_->susp } $self->ncancelled_pkgs;
1971 =item num_cancelled_pkgs
1973 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1978 sub num_cancelled_pkgs {
1979 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1982 sub num_ncancelled_pkgs {
1983 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1987 my( $self ) = shift;
1988 my $sql = scalar(@_) ? shift : '';
1989 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1990 my $sth = dbh->prepare(
1991 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1992 ) or die dbh->errstr;
1993 $sth->execute($self->custnum) or die $sth->errstr;
1994 $sth->fetchrow_arrayref->[0];
1999 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2000 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2001 on success or a list of errors.
2007 grep { $_->unsuspend } $self->suspended_pkgs;
2012 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2014 Returns a list: an empty list on success or a list of errors.
2020 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2023 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2025 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2026 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2027 of a list of pkgparts; the hashref has the following keys:
2031 =item pkgparts - listref of pkgparts
2033 =item (other options are passed to the suspend method)
2038 Returns a list: an empty list on success or a list of errors.
2042 sub suspend_if_pkgpart {
2044 my (@pkgparts, %opt);
2045 if (ref($_[0]) eq 'HASH'){
2046 @pkgparts = @{$_[0]{pkgparts}};
2051 grep { $_->suspend(%opt) }
2052 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2053 $self->unsuspended_pkgs;
2056 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2058 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2059 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2060 instead of a list of pkgparts; the hashref has the following keys:
2064 =item pkgparts - listref of pkgparts
2066 =item (other options are passed to the suspend method)
2070 Returns a list: an empty list on success or a list of errors.
2074 sub suspend_unless_pkgpart {
2076 my (@pkgparts, %opt);
2077 if (ref($_[0]) eq 'HASH'){
2078 @pkgparts = @{$_[0]{pkgparts}};
2083 grep { $_->suspend(%opt) }
2084 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2085 $self->unsuspended_pkgs;
2088 =item cancel [ OPTION => VALUE ... ]
2090 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2092 Available options are:
2096 =item quiet - can be set true to supress email cancellation notices.
2098 =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.
2100 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2104 Always returns a list: an empty list on success or a list of errors.
2109 my( $self, %opt ) = @_;
2111 warn "$me cancel called on customer ". $self->custnum. " with options ".
2112 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2115 return ( 'access denied' )
2116 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2118 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2120 #should try decryption (we might have the private key)
2121 # and if not maybe queue a job for the server that does?
2122 return ( "Can't (yet) ban encrypted credit cards" )
2123 if $self->is_encrypted($self->payinfo);
2125 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2126 my $error = $ban->insert;
2127 return ( $error ) if $error;
2131 my @pkgs = $self->ncancelled_pkgs;
2133 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2134 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2137 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2140 sub _banned_pay_hashref {
2151 'payby' => $payby2ban{$self->payby},
2152 'payinfo' => md5_base64($self->payinfo),
2153 #don't ever *search* on reason! #'reason' =>
2159 Returns all notes (see L<FS::cust_main_note>) for this customer.
2166 qsearch( 'cust_main_note',
2167 { 'custnum' => $self->custnum },
2169 'ORDER BY _DATE DESC'
2175 Returns the agent (see L<FS::agent>) for this customer.
2181 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2184 =item bill_and_collect
2186 Cancels and suspends any packages due, generates bills, applies payments and
2189 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
2191 Options are passed as name-value pairs. Currently available options are:
2197 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:
2201 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2205 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.
2209 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2213 If set true, re-charges setup fees.
2217 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)
2223 sub bill_and_collect {
2224 my( $self, %options ) = @_;
2230 #$options{actual_time} not $options{time} because freeside-daily -d is for
2231 #pre-printing invoices
2232 my @cancel_pkgs = grep { $_->expire && $_->expire <= $options{actual_time} }
2233 $self->ncancelled_pkgs;
2235 foreach my $cust_pkg ( @cancel_pkgs ) {
2236 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2237 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2238 'reason_otaker' => $cpr->otaker
2242 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
2243 " for custnum ". $self->custnum. ": $error"
2251 #$options{actual_time} not $options{time} because freeside-daily -d is for
2252 #pre-printing invoices
2255 && ( ( $_->part_pkg->is_prepaid
2257 && $_->bill < $options{actual_time}
2260 && $_->adjourn <= $options{actual_time}
2264 $self->ncancelled_pkgs;
2266 foreach my $cust_pkg ( @susp_pkgs ) {
2267 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2268 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2269 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2270 'reason_otaker' => $cpr->otaker
2275 warn "Error suspending package ". $cust_pkg->pkgnum.
2276 " for custnum ". $self->custnum. ": $error"
2284 my $error = $self->bill( %options );
2285 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
2287 $self->apply_payments_and_credits;
2289 $error = $self->collect( %options );
2290 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
2296 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2297 conjunction with the collect method by calling B<bill_and_collect>.
2299 If there is an error, returns the error, otherwise returns false.
2301 Options are passed as name-value pairs. Currently available options are:
2307 If set true, re-charges setup fees.
2311 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:
2315 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2319 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2321 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2325 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.
2332 my( $self, %options ) = @_;
2333 return '' if $self->payby eq 'COMP';
2334 warn "$me bill customer ". $self->custnum. "\n"
2337 my $time = $options{'time'} || time;
2338 my $invoice_time = $options{'invoice_time'} || $time;
2341 local $SIG{HUP} = 'IGNORE';
2342 local $SIG{INT} = 'IGNORE';
2343 local $SIG{QUIT} = 'IGNORE';
2344 local $SIG{TERM} = 'IGNORE';
2345 local $SIG{TSTP} = 'IGNORE';
2346 local $SIG{PIPE} = 'IGNORE';
2348 my $oldAutoCommit = $FS::UID::AutoCommit;
2349 local $FS::UID::AutoCommit = 0;
2352 $self->select_for_update; #mutex
2354 my @cust_bill_pkg = ();
2357 # find the packages which are due for billing, find out how much they are
2358 # & generate invoice database.
2361 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2363 my @precommit_hooks = ();
2365 my @cust_pkgs = qsearch('cust_pkg', { 'custnum' => $self->custnum } );
2366 foreach my $cust_pkg (@cust_pkgs) {
2368 #NO!! next if $cust_pkg->cancel;
2369 next if $cust_pkg->getfield('cancel');
2371 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2373 #? to avoid use of uninitialized value errors... ?
2374 $cust_pkg->setfield('bill', '')
2375 unless defined($cust_pkg->bill);
2377 #my $part_pkg = $cust_pkg->part_pkg;
2379 my $real_pkgpart = $cust_pkg->pkgpart;
2380 my %hash = $cust_pkg->hash;
2382 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2384 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2387 $self->_make_lines( 'part_pkg' => $part_pkg,
2388 'cust_pkg' => $cust_pkg,
2389 'precommit_hooks' => \@precommit_hooks,
2390 'line_items' => \@cust_bill_pkg,
2391 'setup' => \$total_setup,
2392 'recur' => \$total_recur,
2393 'tax_matrix' => \%taxlisthash,
2395 'options' => \%options,
2398 $dbh->rollback if $oldAutoCommit;
2402 } #foreach my $part_pkg
2404 } #foreach my $cust_pkg
2406 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2407 #but do commit any package date cycling that happened
2408 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2412 my $postal_pkg = $self->charge_postal_fee();
2413 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2414 $dbh->rollback if $oldAutoCommit;
2415 return "can't charge postal invoice fee for customer ".
2416 $self->custnum. ": $postal_pkg";
2419 ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2420 !$conf->exists('postal_invoice-recurring_only')
2424 foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2426 $self->_make_lines( 'part_pkg' => $part_pkg,
2427 'cust_pkg' => $postal_pkg,
2428 'precommit_hooks' => \@precommit_hooks,
2429 'line_items' => \@cust_bill_pkg,
2430 'setup' => \$total_setup,
2431 'recur' => \$total_recur,
2432 'tax_matrix' => \%taxlisthash,
2434 'options' => \%options,
2437 $dbh->rollback if $oldAutoCommit;
2443 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2445 # keys are tax names (as printed on invoices / itemdesc )
2446 # values are listrefs of taxlisthash keys (internal identifiers)
2449 # keys are taxlisthash keys (internal identifiers)
2450 # values are (cumulative) amounts
2453 # keys are taxlisthash keys (internal identifiers)
2454 # values are listrefs of cust_bill_pkg_tax_location hashrefs
2455 my %tax_location = ();
2457 foreach my $tax ( keys %taxlisthash ) {
2458 my $tax_object = shift @{ $taxlisthash{$tax} };
2459 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2460 my $hashref_or_error =
2461 $tax_object->taxline( $taxlisthash{$tax},
2462 'custnum' => $self->custnum,
2463 'invoice_time' => $invoice_time
2465 unless ( ref($hashref_or_error) ) {
2466 $dbh->rollback if $oldAutoCommit;
2467 return $hashref_or_error;
2469 unshift @{ $taxlisthash{$tax} }, $tax_object;
2471 my $name = $hashref_or_error->{'name'};
2472 my $amount = $hashref_or_error->{'amount'};
2474 #warn "adding $amount as $name\n";
2475 $taxname{ $name } ||= [];
2476 push @{ $taxname{ $name } }, $tax;
2478 $tax{ $tax } += $amount;
2480 $tax_location{ $tax } ||= [];
2481 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2482 push @{ $tax_location{ $tax } },
2484 'taxnum' => $tax_object->taxnum,
2485 'taxtype' => ref($tax_object),
2486 'pkgnum' => $tax_object->get('pkgnum'),
2487 'locationnum' => $tax_object->get('locationnum'),
2488 'amount' => sprintf('%.2f', $amount ),
2494 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
2495 my %packagemap = map { $_->pkgnum => $_ } @cust_bill_pkg;
2496 foreach my $tax ( keys %taxlisthash ) {
2497 foreach ( @{ $taxlisthash{$tax} }[1 ... scalar(@{ $taxlisthash{$tax} })] ) {
2498 next unless ref($_) eq 'FS::cust_bill_pkg'; # shouldn't happen
2500 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
2501 splice( @{ $_->_cust_tax_exempt_pkg } );
2505 #some taxes are taxed
2508 warn "finding taxed taxes...\n" if $DEBUG > 2;
2509 foreach my $tax ( keys %taxlisthash ) {
2510 my $tax_object = shift @{ $taxlisthash{$tax} };
2511 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
2513 next unless $tax_object->can('tax_on_tax');
2515 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
2516 my $totname = ref( $tot ). ' '. $tot->taxnum;
2518 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
2520 next unless exists( $taxlisthash{ $totname } ); # only increase
2522 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
2523 if ( exists( $totlisthash{ $totname } ) ) {
2524 push @{ $totlisthash{ $totname } }, $tax{ $tax };
2526 $totlisthash{ $totname } = [ $tot, $tax{ $tax } ];
2531 warn "having a look at taxed taxes...\n" if $DEBUG > 2;
2532 foreach my $tax ( keys %totlisthash ) {
2533 my $tax_object = shift @{ $totlisthash{$tax} };
2534 warn "found previously found taxed tax ". $tax_object->taxname. "\n"
2536 my $listref_or_error =
2537 $tax_object->taxline( $totlisthash{$tax},
2538 'custnum' => $self->custnum,
2539 'invoice_time' => $invoice_time
2541 unless (ref($listref_or_error)) {
2542 $dbh->rollback if $oldAutoCommit;
2543 return $listref_or_error;
2546 warn "adding taxed tax amount ". $listref_or_error->[1].
2547 " as ". $tax_object->taxname. "\n"
2549 $tax{ $tax } += $listref_or_error->[1];
2552 #consolidate and create tax line items
2553 warn "consolidating and generating...\n" if $DEBUG > 2;
2554 foreach my $taxname ( keys %taxname ) {
2557 my @cust_bill_pkg_tax_location = ();
2558 warn "adding $taxname\n" if $DEBUG > 1;
2559 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2560 next if $seen{$taxitem}++;
2561 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2562 $tax += $tax{$taxitem};
2563 push @cust_bill_pkg_tax_location,
2564 map { new FS::cust_bill_pkg_tax_location $_ }
2565 @{ $tax_location{ $taxitem } };
2569 $tax = sprintf('%.2f', $tax );
2570 $total_setup = sprintf('%.2f', $total_setup+$tax );
2572 push @cust_bill_pkg, new FS::cust_bill_pkg {
2578 'itemdesc' => $taxname,
2579 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2584 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2586 #create the new invoice
2587 my $cust_bill = new FS::cust_bill ( {
2588 'custnum' => $self->custnum,
2589 '_date' => ( $invoice_time ),
2590 'charged' => $charged,
2592 my $error = $cust_bill->insert;
2594 $dbh->rollback if $oldAutoCommit;
2595 return "can't create invoice for customer #". $self->custnum. ": $error";
2598 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2599 $cust_bill_pkg->invnum($cust_bill->invnum);
2600 my $error = $cust_bill_pkg->insert;
2602 $dbh->rollback if $oldAutoCommit;
2603 return "can't create invoice line item: $error";
2608 foreach my $hook ( @precommit_hooks ) {
2610 &{$hook}; #($self) ?
2613 $dbh->rollback if $oldAutoCommit;
2614 return "$@ running precommit hook $hook\n";
2618 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2624 my ($self, %params) = @_;
2626 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
2627 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
2628 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
2629 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
2630 my $total_setup = $params{setup} or die "no setup accumulator specified";
2631 my $total_recur = $params{recur} or die "no recur accumulator specified";
2632 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
2633 my $time = $params{'time'} or die "no time specified";
2634 my (%options) = %{$params{options}}; #hmmm only for 'resetup'
2637 my $real_pkgpart = $cust_pkg->pkgpart;
2638 my %hash = $cust_pkg->hash;
2639 my $old_cust_pkg = new FS::cust_pkg \%hash;
2645 $cust_pkg->pkgpart($part_pkg->pkgpart);
2653 if ( ! $cust_pkg->setup &&
2655 ( $conf->exists('disable_setup_suspended_pkgs') &&
2656 ! $cust_pkg->getfield('susp')
2657 ) || ! $conf->exists('disable_setup_suspended_pkgs')
2659 || $options{'resetup'}
2662 warn " bill setup\n" if $DEBUG > 1;
2665 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2666 return "$@ running calc_setup for $cust_pkg\n"
2669 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
2671 $cust_pkg->setfield('setup', $time)
2672 unless $cust_pkg->setup;
2673 #do need it, but it won't get written to the db
2674 #|| $cust_pkg->pkgpart != $real_pkgpart;
2679 # bill recurring fee
2682 #XXX unit stuff here too
2686 if ( ! $cust_pkg->getfield('susp') and
2687 ( $part_pkg->getfield('freq') ne '0' &&
2688 ( $cust_pkg->getfield('bill') || 0 ) <= $time
2690 || ( $part_pkg->plan eq 'voip_cdr'
2691 && $part_pkg->option('bill_every_call')
2695 # XXX should this be a package event? probably. events are called
2696 # at collection time at the moment, though...
2697 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
2698 if $part_pkg->can('reset_usage');
2699 #don't want to reset usage just cause we want a line item??
2700 #&& $part_pkg->pkgpart == $real_pkgpart;
2702 warn " bill recur\n" if $DEBUG > 1;
2705 # XXX shared with $recur_prog
2706 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2708 #over two params! lets at least switch to a hashref for the rest...
2709 my $increment_next_bill = ( $part_pkg->freq ne '0'
2710 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
2712 my %param = ( 'precommit_hooks' => $precommit_hooks,
2713 'increment_next_bill' => $increment_next_bill,
2716 $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2717 return "$@ running calc_recur for $cust_pkg\n"
2720 if ( $increment_next_bill ) {
2722 my $next_bill = $part_pkg->add_freq($sdate);
2723 return "unparsable frequency: ". $part_pkg->freq
2724 if $next_bill == -1;
2726 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
2727 # only for figuring next bill date, nothing else, so, reset $sdate again
2729 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2730 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
2731 $cust_pkg->last_bill($sdate);
2733 $cust_pkg->setfield('bill', $next_bill );
2739 warn "\$setup is undefined" unless defined($setup);
2740 warn "\$recur is undefined" unless defined($recur);
2741 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2744 # If there's line items, create em cust_bill_pkg records
2745 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
2750 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
2751 # hmm.. and if just the options are modified in some weird price plan?
2753 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2756 my $error = $cust_pkg->replace( $old_cust_pkg,
2757 'options' => { $cust_pkg->options },
2759 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
2760 if $error; #just in case
2763 $setup = sprintf( "%.2f", $setup );
2764 $recur = sprintf( "%.2f", $recur );
2765 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2766 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2768 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2769 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2772 if ( $setup != 0 || $recur != 0 ) {
2774 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2777 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
2779 warn " adding customer package invoice detail: $_\n"
2780 foreach @cust_pkg_detail;
2782 push @details, @cust_pkg_detail;
2784 my $cust_bill_pkg = new FS::cust_bill_pkg {
2785 'pkgnum' => $cust_pkg->pkgnum,
2787 'unitsetup' => $unitsetup,
2789 'unitrecur' => $unitrecur,
2790 'quantity' => $cust_pkg->quantity,
2791 'details' => \@details,
2794 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
2795 $cust_bill_pkg->sdate( $hash{last_bill} );
2796 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
2797 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
2798 $cust_bill_pkg->sdate( $sdate );
2799 $cust_bill_pkg->edate( $cust_pkg->bill );
2802 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
2803 unless $part_pkg->pkgpart == $real_pkgpart;
2805 $$total_setup += $setup;
2806 $$total_recur += $recur;
2813 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg);
2814 return $error if $error;
2816 push @$cust_bill_pkgs, $cust_bill_pkg;
2818 } #if $setup != 0 || $recur != 0
2828 my $part_pkg = shift;
2829 my $taxlisthash = shift;
2830 my $cust_bill_pkg = shift;
2831 my $cust_pkg = shift;
2833 my %cust_bill_pkg = ();
2837 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
2838 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
2839 push @classes, 'setup' if $cust_bill_pkg->setup;
2840 push @classes, 'recur' if $cust_bill_pkg->recur;
2842 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
2844 if ( $conf->exists('enable_taxproducts')
2845 && ( scalar($part_pkg->part_pkg_taxoverride)
2846 || $part_pkg->has_taxproduct
2851 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
2852 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
2855 foreach my $class (@classes) {
2856 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
2857 return $err_or_ref unless ref($err_or_ref);
2858 $taxes{$class} = $err_or_ref;
2861 unless (exists $taxes{''}) {
2862 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
2863 return $err_or_ref unless ref($err_or_ref);
2864 $taxes{''} = $err_or_ref;
2869 my @loc_keys = qw( state county country );
2871 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
2872 my $cust_location = $cust_pkg->cust_location;
2873 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
2876 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2879 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
2882 $taxhash{'taxclass'} = $part_pkg->taxclass;
2884 my @taxes = qsearch( 'cust_main_county', \%taxhash );
2886 my %taxhash_elim = %taxhash;
2888 my @elim = qw( taxclass county state );
2889 while ( !scalar(@taxes) && scalar(@elim) ) {
2890 $taxhash_elim{ shift(@elim) } = '';
2891 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
2894 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
2896 $_->set('pkgnum', $cust_pkg->pkgnum );
2897 $_->set('locationnum', $cust_pkg->locationnum );
2901 $taxes{''} = [ @taxes ];
2902 $taxes{'setup'} = [ @taxes ];
2903 $taxes{'recur'} = [ @taxes ];
2904 $taxes{$_} = [ @taxes ] foreach (@classes);
2906 # maybe eliminate this entirely, along with all the 0% records
2909 "fatal: can't find tax rate for state/county/country/taxclass ".
2910 join('/', map $taxhash{$_}, qw(state county country taxclass) );
2913 } #if $conf->exists('enable_taxproducts') ...
2918 if ( $conf->exists('separate_usage') ) {
2919 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
2920 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
2921 push @display, new FS::cust_bill_pkg_display { type => 'S' };
2922 push @display, new FS::cust_bill_pkg_display { type => 'R' };
2923 push @display, new FS::cust_bill_pkg_display { type => 'U',
2926 if ($section && $summary) {
2927 $display[2]->post_total('Y');
2928 push @display, new FS::cust_bill_pkg_display { type => 'U',
2933 $cust_bill_pkg->set('display', \@display);
2935 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
2936 foreach my $key (keys %tax_cust_bill_pkg) {
2937 my @taxes = @{ $taxes{$key} || [] };
2938 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
2940 foreach my $tax ( @taxes ) {
2942 my $taxname = ref( $tax ). ' taxnum'. $tax->taxnum;
2943 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
2944 # ' locationnum'. $cust_pkg->locationnum
2945 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
2947 if ( exists( $taxlisthash->{ $taxname } ) ) {
2948 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
2950 $taxlisthash->{ $taxname } = [ $tax, $tax_cust_bill_pkg ];
2960 my $part_pkg = shift;
2964 my $geocode = $self->geocode('cch');
2966 my @taxclassnums = map { $_->taxclassnum }
2967 $part_pkg->part_pkg_taxoverride($class);
2969 unless (@taxclassnums) {
2970 @taxclassnums = map { $_->taxclassnum }
2971 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
2973 warn "Found taxclassnum values of ". join(',', @taxclassnums)
2978 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
2980 @taxes = qsearch({ 'table' => 'tax_rate',
2981 'hashref' => { 'geocode' => $geocode, },
2982 'extra_sql' => $extra_sql,
2984 if scalar(@taxclassnums);
2986 warn "Found taxes ".
2987 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
2994 =item collect OPTIONS
2996 (Attempt to) collect money for this customer's outstanding invoices (see
2997 L<FS::cust_bill>). Usually used after the bill method.
2999 Actions are now triggered by billing events; see L<FS::part_event> and the
3000 billing events web interface. Old-style invoice events (see
3001 L<FS::part_bill_event>) have been deprecated.
3003 If there is an error, returns the error, otherwise returns false.
3005 Options are passed as name-value pairs.
3007 Currently available options are:
3013 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.
3017 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3021 set true to surpress email card/ACH decline notices.
3025 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3029 allows for one time override of normal customer billing method
3033 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)
3041 my( $self, %options ) = @_;
3042 my $invoice_time = $options{'invoice_time'} || time;
3045 local $SIG{HUP} = 'IGNORE';
3046 local $SIG{INT} = 'IGNORE';
3047 local $SIG{QUIT} = 'IGNORE';
3048 local $SIG{TERM} = 'IGNORE';
3049 local $SIG{TSTP} = 'IGNORE';
3050 local $SIG{PIPE} = 'IGNORE';
3052 my $oldAutoCommit = $FS::UID::AutoCommit;
3053 local $FS::UID::AutoCommit = 0;
3056 $self->select_for_update; #mutex
3059 my $balance = $self->balance;
3060 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3063 if ( exists($options{'retry_card'}) ) {
3064 carp 'retry_card option passed to collect is deprecated; use retry';
3065 $options{'retry'} ||= $options{'retry_card'};
3067 if ( exists($options{'retry'}) && $options{'retry'} ) {
3068 my $error = $self->retry_realtime;
3070 $dbh->rollback if $oldAutoCommit;
3075 # false laziness w/pay_batch::import_results
3077 my $due_cust_event = $self->due_cust_event(
3078 'debug' => ( $options{'debug'} || 0 ),
3079 'time' => $invoice_time,
3080 'check_freq' => $options{'check_freq'},
3082 unless( ref($due_cust_event) ) {
3083 $dbh->rollback if $oldAutoCommit;
3084 return $due_cust_event;
3087 foreach my $cust_event ( @$due_cust_event ) {
3091 #re-eval event conditions (a previous event could have changed things)
3092 unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
3093 #don't leave stray "new/locked" records around
3094 my $error = $cust_event->delete;
3096 #gah, even with transactions
3097 $dbh->commit if $oldAutoCommit; #well.
3104 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3105 warn " running cust_event ". $cust_event->eventnum. "\n"
3109 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3110 if ( my $error = $cust_event->do_event() ) {
3111 #XXX wtf is this? figure out a proper dealio with return value
3113 # gah, even with transactions.
3114 $dbh->commit if $oldAutoCommit; #well.
3121 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3126 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3128 Inserts database records for and returns an ordered listref of new events due
3129 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3130 events are due, an empty listref is returned. If there is an error, returns a
3131 scalar error message.
3133 To actually run the events, call each event's test_condition method, and if
3134 still true, call the event's do_event method.
3136 Options are passed as a hashref or as a list of name-value pairs. Available
3143 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.
3147 "Current time" for the events.
3151 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)
3155 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3159 Explicitly pass the objects to be tested (typically used with eventtable).
3163 Set to true to return the objects, but not actually insert them into the
3170 sub due_cust_event {
3172 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3175 #my $DEBUG = $opt{'debug'}
3176 local($DEBUG) = $opt{'debug'}
3177 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3179 warn "$me due_cust_event called with options ".
3180 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3183 $opt{'time'} ||= time;
3185 local $SIG{HUP} = 'IGNORE';
3186 local $SIG{INT} = 'IGNORE';
3187 local $SIG{QUIT} = 'IGNORE';
3188 local $SIG{TERM} = 'IGNORE';
3189 local $SIG{TSTP} = 'IGNORE';
3190 local $SIG{PIPE} = 'IGNORE';
3192 my $oldAutoCommit = $FS::UID::AutoCommit;
3193 local $FS::UID::AutoCommit = 0;
3196 $self->select_for_update #mutex
3197 unless $opt{testonly};
3200 # 1: find possible events (initial search)
3203 my @cust_event = ();
3205 my @eventtable = $opt{'eventtable'}
3206 ? ( $opt{'eventtable'} )
3207 : FS::part_event->eventtables_runorder;
3209 foreach my $eventtable ( @eventtable ) {
3212 if ( $opt{'objects'} ) {
3214 @objects = @{ $opt{'objects'} };
3218 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3219 @objects = ( $eventtable eq 'cust_main' )
3221 : ( $self->$eventtable() );
3225 my @e_cust_event = ();
3227 my $cross = "CROSS JOIN $eventtable";
3228 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3229 unless $eventtable eq 'cust_main';
3231 foreach my $object ( @objects ) {
3233 #this first search uses the condition_sql magic for optimization.
3234 #the more possible events we can eliminate in this step the better
3236 my $cross_where = '';
3237 my $pkey = $object->primary_key;
3238 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3240 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3242 FS::part_event_condition->where_conditions_sql( $eventtable,
3243 'time'=>$opt{'time'}
3245 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3247 $extra_sql = "AND $extra_sql" if $extra_sql;
3249 #here is the agent virtualization
3250 $extra_sql .= " AND ( part_event.agentnum IS NULL
3251 OR part_event.agentnum = ". $self->agentnum. ' )';
3253 $extra_sql .= " $order";
3255 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3256 if $opt{'debug'} > 2;
3257 my @part_event = qsearch( {
3258 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3259 'select' => 'part_event.*',
3260 'table' => 'part_event',
3261 'addl_from' => "$cross $join",
3262 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3263 'eventtable' => $eventtable,
3266 'extra_sql' => "AND $cross_where $extra_sql",
3270 my $pkey = $object->primary_key;
3271 warn " ". scalar(@part_event).
3272 " possible events found for $eventtable ". $object->$pkey(). "\n";
3275 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3279 warn " ". scalar(@e_cust_event).
3280 " subtotal possible cust events found for $eventtable\n"
3283 push @cust_event, @e_cust_event;
3287 warn " ". scalar(@cust_event).
3288 " total possible cust events found in initial search\n"
3292 # 2: test conditions
3297 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3298 'stats_hashref' => \%unsat ),
3301 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3304 warn " invalid conditions not eliminated with condition_sql:\n".
3305 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3312 unless( $opt{testonly} ) {
3313 foreach my $cust_event ( @cust_event ) {
3315 my $error = $cust_event->insert();
3317 $dbh->rollback if $oldAutoCommit;
3324 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3330 warn " returning events: ". Dumper(@cust_event). "\n"
3337 =item retry_realtime
3339 Schedules realtime / batch credit card / electronic check / LEC billing
3340 events for for retry. Useful if card information has changed or manual
3341 retry is desired. The 'collect' method must be called to actually retry
3344 Implementation details: For either this customer, or for each of this
3345 customer's open invoices, changes the status of the first "done" (with
3346 statustext error) realtime processing event to "failed".
3350 sub retry_realtime {
3353 local $SIG{HUP} = 'IGNORE';
3354 local $SIG{INT} = 'IGNORE';
3355 local $SIG{QUIT} = 'IGNORE';
3356 local $SIG{TERM} = 'IGNORE';
3357 local $SIG{TSTP} = 'IGNORE';
3358 local $SIG{PIPE} = 'IGNORE';
3360 my $oldAutoCommit = $FS::UID::AutoCommit;
3361 local $FS::UID::AutoCommit = 0;
3364 #a little false laziness w/due_cust_event (not too bad, really)
3366 my $join = FS::part_event_condition->join_conditions_sql;
3367 my $order = FS::part_event_condition->order_conditions_sql;
3370 . join ( ' OR ' , map {
3371 "( part_event.eventtable = " . dbh->quote($_)
3372 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3373 } FS::part_event->eventtables)
3376 #here is the agent virtualization
3377 my $agent_virt = " ( part_event.agentnum IS NULL
3378 OR part_event.agentnum = ". $self->agentnum. ' )';
3380 #XXX this shouldn't be hardcoded, actions should declare it...
3381 my @realtime_events = qw(
3382 cust_bill_realtime_card
3383 cust_bill_realtime_check
3384 cust_bill_realtime_lec
3388 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3393 my @cust_event = qsearchs({
3394 'table' => 'cust_event',
3395 'select' => 'cust_event.*',
3396 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3397 'hashref' => { 'status' => 'done' },
3398 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3399 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3402 my %seen_invnum = ();
3403 foreach my $cust_event (@cust_event) {
3405 #max one for the customer, one for each open invoice
3406 my $cust_X = $cust_event->cust_X;
3407 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3411 or $cust_event->part_event->eventtable eq 'cust_bill'
3414 my $error = $cust_event->retry;
3416 $dbh->rollback if $oldAutoCommit;
3417 return "error scheduling event for retry: $error";
3422 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3427 # some horrid false laziness here to avoid refactor fallout
3428 # eventually realtime realtime_bop and realtime_refund_bop should go
3429 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
3431 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3433 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3434 via a Business::OnlinePayment realtime gateway. See
3435 L<http://420.am/business-onlinepayment> for supported gateways.
3437 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3439 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3441 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3442 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3443 if set, will override the value from the customer record.
3445 I<description> is a free-text field passed to the gateway. It defaults to
3446 "Internet services".
3448 If an I<invnum> is specified, this payment (if successful) is applied to the
3449 specified invoice. If you don't specify an I<invnum> you might want to
3450 call the B<apply_payments> method.
3452 I<quiet> can be set true to surpress email decline notices.
3454 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
3455 resulting paynum, if any.
3457 I<payunique> is a unique identifier for this payment.
3459 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
3466 return $self->_new_realtime_bop(@_)
3467 if $self->_new_bop_required();
3469 my( $method, $amount, %options ) = @_;
3471 warn "$me realtime_bop: $method $amount\n";
3472 warn " $_ => $options{$_}\n" foreach keys %options;
3475 $options{'description'} ||= 'Internet services';
3477 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
3479 eval "use Business::OnlinePayment";
3482 my $payinfo = exists($options{'payinfo'})
3483 ? $options{'payinfo'}
3486 my %method2payby = (
3493 # check for banned credit card/ACH
3496 my $ban = qsearchs('banned_pay', {
3497 'payby' => $method2payby{$method},
3498 'payinfo' => md5_base64($payinfo),
3500 return "Banned credit card" if $ban;
3507 if ( $options{'invnum'} ) {
3508 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
3509 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
3511 map { $_->part_pkg->taxclass }
3513 map { $_->cust_pkg }
3514 $cust_bill->cust_bill_pkg;
3515 unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
3516 #different taxclasses
3517 $taxclass = $taxclasses[0];
3521 #look for an agent gateway override first
3523 if ( $method eq 'CC' ) {
3524 $cardtype = cardtype($payinfo);
3525 } elsif ( $method eq 'ECHECK' ) {
3528 $cardtype = $method;
3532 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3533 cardtype => $cardtype,
3534 taxclass => $taxclass, } )
3535 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3537 taxclass => $taxclass, } )
3538 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3539 cardtype => $cardtype,
3541 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3543 taxclass => '', } );
3545 my $payment_gateway = '';
3546 my( $processor, $login, $password, $action, @bop_options );
3547 if ( $override ) { #use a payment gateway override
3549 $payment_gateway = $override->payment_gateway;
3551 $processor = $payment_gateway->gateway_module;
3552 $login = $payment_gateway->gateway_username;
3553 $password = $payment_gateway->gateway_password;
3554 $action = $payment_gateway->gateway_action;
3555 @bop_options = $payment_gateway->options;
3557 } else { #use the standard settings from the config
3559 ( $processor, $login, $password, $action, @bop_options ) =
3560 $self->default_payment_gateway($method);
3568 my $address = exists($options{'address1'})
3569 ? $options{'address1'}
3571 my $address2 = exists($options{'address2'})
3572 ? $options{'address2'}
3574 $address .= ", ". $address2 if length($address2);
3576 my $o_payname = exists($options{'payname'})
3577 ? $options{'payname'}
3579 my($payname, $payfirst, $paylast);
3580 if ( $o_payname && $method ne 'ECHECK' ) {
3581 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3582 or return "Illegal payname $payname";
3583 ($payfirst, $paylast) = ($1, $2);
3585 $payfirst = $self->getfield('first');
3586 $paylast = $self->getfield('last');
3587 $payname = "$payfirst $paylast";
3590 my @invoicing_list = $self->invoicing_list_emailonly;
3591 if ( $conf->exists('emailinvoiceautoalways')
3592 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3593 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3594 push @invoicing_list, $self->all_emails;
3597 my $email = ($conf->exists('business-onlinepayment-email-override'))
3598 ? $conf->config('business-onlinepayment-email-override')
3599 : $invoicing_list[0];
3603 my $payip = exists($options{'payip'})
3606 $content{customer_ip} = $payip
3609 $content{invoice_number} = $options{'invnum'}
3610 if exists($options{'invnum'}) && length($options{'invnum'});
3612 $content{email_customer} =
3613 ( $conf->exists('business-onlinepayment-email_customer')
3614 || $conf->exists('business-onlinepayment-email-override') );
3617 if ( $method eq 'CC' ) {
3619 $content{card_number} = $payinfo;
3620 $paydate = exists($options{'paydate'})
3621 ? $options{'paydate'}
3623 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3624 $content{expiration} = "$2/$1";
3626 my $paycvv = exists($options{'paycvv'})
3627 ? $options{'paycvv'}
3629 $content{cvv2} = $paycvv
3632 my $paystart_month = exists($options{'paystart_month'})
3633 ? $options{'paystart_month'}
3634 : $self->paystart_month;
3636 my $paystart_year = exists($options{'paystart_year'})
3637 ? $options{'paystart_year'}
3638 : $self->paystart_year;
3640 $content{card_start} = "$paystart_month/$paystart_year"
3641 if $paystart_month && $paystart_year;
3643 my $payissue = exists($options{'payissue'})
3644 ? $options{'payissue'}
3646 $content{issue_number} = $payissue if $payissue;
3648 $content{recurring_billing} = 'YES'
3649 if qsearch('cust_pay', { 'custnum' => $self->custnum,
3651 'payinfo' => $payinfo,
3653 || qsearch('cust_pay', { 'custnum' => $self->custnum,
3655 'paymask' => $self->mask_payinfo('CARD', $payinfo),
3659 } elsif ( $method eq 'ECHECK' ) {
3660 ( $content{account_number}, $content{routing_code} ) =
3661 split('@', $payinfo);
3662 $content{bank_name} = $o_payname;
3663 $content{bank_state} = exists($options{'paystate'})
3664 ? $options{'paystate'}
3665 : $self->getfield('paystate');
3666 $content{account_type} = exists($options{'paytype'})
3667 ? uc($options{'paytype'}) || 'CHECKING'
3668 : uc($self->getfield('paytype')) || 'CHECKING';
3669 $content{account_name} = $payname;
3670 $content{customer_org} = $self->company ? 'B' : 'I';
3671 $content{state_id} = exists($options{'stateid'})
3672 ? $options{'stateid'}
3673 : $self->getfield('stateid');
3674 $content{state_id_state} = exists($options{'stateid_state'})
3675 ? $options{'stateid_state'}
3676 : $self->getfield('stateid_state');
3677 $content{customer_ssn} = exists($options{'ss'})
3680 } elsif ( $method eq 'LEC' ) {
3681 $content{phone} = $payinfo;
3685 # run transaction(s)
3688 my $balance = exists( $options{'balance'} )
3689 ? $options{'balance'}
3692 $self->select_for_update; #mutex ... just until we get our pending record in
3694 #the checks here are intended to catch concurrent payments
3695 #double-form-submission prevention is taken care of in cust_pay_pending::check
3698 return "The customer's balance has changed; $method transaction aborted."
3699 if $self->balance < $balance;
3700 #&& $self->balance < $amount; #might as well anyway?
3702 #also check and make sure there aren't *other* pending payments for this cust
3704 my @pending = qsearch('cust_pay_pending', {
3705 'custnum' => $self->custnum,
3706 'status' => { op=>'!=', value=>'done' }
3708 return "A payment is already being processed for this customer (".
3709 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
3710 "); $method transaction aborted."
3711 if scalar(@pending);
3713 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
3715 my $cust_pay_pending = new FS::cust_pay_pending {
3716 'custnum' => $self->custnum,
3717 #'invnum' => $options{'invnum'},
3720 'payby' => $method2payby{$method},
3721 'payinfo' => $payinfo,
3722 'paydate' => $paydate,
3724 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
3726 $cust_pay_pending->payunique( $options{payunique} )
3727 if defined($options{payunique}) && length($options{payunique});
3728 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
3729 return $cpp_new_err if $cpp_new_err;
3731 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3733 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3734 $transaction->content(
3737 'password' => $password,
3738 'action' => $action1,
3739 'description' => $options{'description'},
3740 'amount' => $amount,
3741 #'invoice_number' => $options{'invnum'},
3742 'customer_id' => $self->custnum,
3743 'last_name' => $paylast,
3744 'first_name' => $payfirst,
3746 'address' => $address,
3747 'city' => ( exists($options{'city'})
3750 'state' => ( exists($options{'state'})
3753 'zip' => ( exists($options{'zip'})
3756 'country' => ( exists($options{'country'})
3757 ? $options{'country'}
3759 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
3761 'phone' => $self->daytime || $self->night,
3765 $cust_pay_pending->status('pending');
3766 my $cpp_pending_err = $cust_pay_pending->replace;
3767 return $cpp_pending_err if $cpp_pending_err;
3770 my $BOP_TESTING = 0;
3771 my $BOP_TESTING_SUCCESS = 1;
3773 unless ( $BOP_TESTING ) {
3774 $transaction->submit();
3776 if ( $BOP_TESTING_SUCCESS ) {
3777 $transaction->is_success(1);
3778 $transaction->authorization('fake auth');
3780 $transaction->is_success(0);
3781 $transaction->error_message('fake failure');
3785 if ( $transaction->is_success() && $action2 ) {
3787 $cust_pay_pending->status('authorized');
3788 my $cpp_authorized_err = $cust_pay_pending->replace;
3789 return $cpp_authorized_err if $cpp_authorized_err;
3791 my $auth = $transaction->authorization;
3792 my $ordernum = $transaction->can('order_number')
3793 ? $transaction->order_number
3797 new Business::OnlinePayment( $processor, @bop_options );
3804 password => $password,
3805 order_number => $ordernum,
3807 authorization => $auth,
3808 description => $options{'description'},
3811 foreach my $field (qw( authorization_source_code returned_ACI
3812 transaction_identifier validation_code
3813 transaction_sequence_num local_transaction_date
3814 local_transaction_time AVS_result_code )) {
3815 $capture{$field} = $transaction->$field() if $transaction->can($field);
3818 $capture->content( %capture );
3822 unless ( $capture->is_success ) {
3823 my $e = "Authorization successful but capture failed, custnum #".
3824 $self->custnum. ': '. $capture->result_code.
3825 ": ". $capture->error_message;
3832 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
3833 my $cpp_captured_err = $cust_pay_pending->replace;
3834 return $cpp_captured_err if $cpp_captured_err;
3837 # remove paycvv after initial transaction
3840 #false laziness w/misc/process/payment.cgi - check both to make sure working
3842 if ( defined $self->dbdef_table->column('paycvv')
3843 && length($self->paycvv)
3844 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3846 my $error = $self->remove_cvv;
3848 warn "WARNING: error removing cvv: $error\n";
3856 if ( $transaction->is_success() ) {
3859 if ( $payment_gateway ) { # agent override
3860 $paybatch = $payment_gateway->gatewaynum. '-';
3863 $paybatch .= "$processor:". $transaction->authorization;
3865 $paybatch .= ':'. $transaction->order_number
3866 if $transaction->can('order_number')
3867 && length($transaction->order_number);
3869 my $cust_pay = new FS::cust_pay ( {
3870 'custnum' => $self->custnum,
3871 'invnum' => $options{'invnum'},
3874 'payby' => $method2payby{$method},
3875 'payinfo' => $payinfo,
3876 'paybatch' => $paybatch,
3877 'paydate' => $paydate,
3879 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
3880 $cust_pay->payunique( $options{payunique} )
3881 if defined($options{payunique}) && length($options{payunique});
3883 my $oldAutoCommit = $FS::UID::AutoCommit;
3884 local $FS::UID::AutoCommit = 0;
3887 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
3889 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3892 $cust_pay->invnum(''); #try again with no specific invnum
3893 my $error2 = $cust_pay->insert( $options{'manual'} ?
3894 ( 'manual' => 1 ) : ()
3897 # gah. but at least we have a record of the state we had to abort in
3898 # from cust_pay_pending now.
3899 my $e = "WARNING: $method captured but payment not recorded - ".
3900 "error inserting payment ($processor): $error2".
3901 " (previously tried insert with invnum #$options{'invnum'}" .
3902 ": $error ) - pending payment saved as paypendingnum ".
3903 $cust_pay_pending->paypendingnum. "\n";
3909 if ( $options{'paynum_ref'} ) {
3910 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3913 $cust_pay_pending->status('done');
3914 $cust_pay_pending->statustext('captured');
3915 $cust_pay_pending->paynum($cust_pay->paynum);
3916 my $cpp_done_err = $cust_pay_pending->replace;
3918 if ( $cpp_done_err ) {
3920 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3921 my $e = "WARNING: $method captured but payment not recorded - ".
3922 "error updating status for paypendingnum ".
3923 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3929 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3930 return ''; #no error
3936 my $perror = "$processor error: ". $transaction->error_message;
3938 unless ( $transaction->error_message ) {
3941 if ( $transaction->can('response_page') ) {
3943 'page' => ( $transaction->can('response_page')
3944 ? $transaction->response_page
3947 'code' => ( $transaction->can('response_code')
3948 ? $transaction->response_code
3951 'headers' => ( $transaction->can('response_headers')
3952 ? $transaction->response_headers
3958 "No additional debugging information available for $processor";
3961 $perror .= "No error_message returned from $processor -- ".
3962 ( ref($t_response) ? Dumper($t_response) : $t_response );
3966 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3967 && $conf->exists('emaildecline')
3968 && grep { $_ ne 'POST' } $self->invoicing_list
3969 && ! grep { $transaction->error_message =~ /$_/ }
3970 $conf->config('emaildecline-exclude')
3972 my @templ = $conf->config('declinetemplate');
3973 my $template = new Text::Template (
3975 SOURCE => [ map "$_\n", @templ ],
3976 ) or return "($perror) can't create template: $Text::Template::ERROR";
3977 $template->compile()
3978 or return "($perror) can't compile template: $Text::Template::ERROR";
3980 my $templ_hash = { error => $transaction->error_message };
3982 my $error = send_email(
3983 'from' => $conf->config('invoice_from', $self->agentnum ),
3984 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3985 'subject' => 'Your payment could not be processed',
3986 'body' => [ $template->fill_in(HASH => $templ_hash) ],
3989 $perror .= " (also received error sending decline notification: $error)"
3994 $cust_pay_pending->status('done');
3995 $cust_pay_pending->statustext("declined: $perror");
3996 my $cpp_done_err = $cust_pay_pending->replace;
3997 if ( $cpp_done_err ) {
3998 my $e = "WARNING: $method declined but pending payment not resolved - ".
3999 "error updating status for paypendingnum ".
4000 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4002 $perror = "$e ($perror)";
4010 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4012 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4013 via a Business::OnlinePayment realtime gateway. See
4014 L<http://420.am/business-onlinepayment> for supported gateways.
4016 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4018 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4020 Most gateways require a reference to an original payment transaction to refund,
4021 so you probably need to specify a I<paynum>.
4023 I<amount> defaults to the original amount of the payment if not specified.
4025 I<reason> specifies a reason for the refund.
4027 I<paydate> specifies the expiration date for a credit card overriding the
4028 value from the customer record or the payment record. Specified as yyyy-mm-dd
4030 Implementation note: If I<amount> is unspecified or equal to the amount of the
4031 orignal payment, first an attempt is made to "void" the transaction via
4032 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4033 the normal attempt is made to "refund" ("credit") the transaction via the
4034 gateway is attempted.
4036 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4037 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4038 #if set, will override the value from the customer record.
4040 #If an I<invnum> is specified, this payment (if successful) is applied to the
4041 #specified invoice. If you don't specify an I<invnum> you might want to
4042 #call the B<apply_payments> method.
4046 #some false laziness w/realtime_bop, not enough to make it worth merging
4047 #but some useful small subs should be pulled out
4048 sub realtime_refund_bop {
4051 return $self->_new_realtime_refund_bop(@_)
4052 if $self->_new_bop_required();
4054 my( $method, %options ) = @_;
4056 warn "$me realtime_refund_bop: $method refund\n";
4057 warn " $_ => $options{$_}\n" foreach keys %options;
4060 eval "use Business::OnlinePayment";
4064 # look up the original payment and optionally a gateway for that payment
4068 my $amount = $options{'amount'};
4070 my( $processor, $login, $password, @bop_options ) ;
4071 my( $auth, $order_number ) = ( '', '', '' );
4073 if ( $options{'paynum'} ) {
4075 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4076 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4077 or return "Unknown paynum $options{'paynum'}";
4078 $amount ||= $cust_pay->paid;
4080 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4081 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4082 $cust_pay->paybatch;
4083 my $gatewaynum = '';
4084 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4086 if ( $gatewaynum ) { #gateway for the payment to be refunded
4088 my $payment_gateway =
4089 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4090 die "payment gateway $gatewaynum not found"
4091 unless $payment_gateway;
4093 $processor = $payment_gateway->gateway_module;
4094 $login = $payment_gateway->gateway_username;
4095 $password = $payment_gateway->gateway_password;
4096 @bop_options = $payment_gateway->options;
4098 } else { #try the default gateway
4100 my( $conf_processor, $unused_action );
4101 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4102 $self->default_payment_gateway($method);
4104 return "processor of payment $options{'paynum'} $processor does not".
4105 " match default processor $conf_processor"
4106 unless $processor eq $conf_processor;
4111 } else { # didn't specify a paynum, so look for agent gateway overrides
4112 # like a normal transaction
4115 if ( $method eq 'CC' ) {
4116 $cardtype = cardtype($self->payinfo);
4117 } elsif ( $method eq 'ECHECK' ) {
4120 $cardtype = $method;
4123 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4124 cardtype => $cardtype,
4126 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4128 taxclass => '', } );
4130 if ( $override ) { #use a payment gateway override
4132 my $payment_gateway = $override->payment_gateway;
4134 $processor = $payment_gateway->gateway_module;
4135 $login = $payment_gateway->gateway_username;
4136 $password = $payment_gateway->gateway_password;
4137 #$action = $payment_gateway->gateway_action;
4138 @bop_options = $payment_gateway->options;
4140 } else { #use the standard settings from the config
4143 ( $processor, $login, $password, $unused_action, @bop_options ) =
4144 $self->default_payment_gateway($method);
4149 return "neither amount nor paynum specified" unless $amount;
4154 'password' => $password,
4155 'order_number' => $order_number,
4156 'amount' => $amount,
4157 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4159 $content{authorization} = $auth
4160 if length($auth); #echeck/ACH transactions have an order # but no auth
4161 #(at least with authorize.net)
4163 my $disable_void_after;
4164 if ($conf->exists('disable_void_after')
4165 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4166 $disable_void_after = $1;
4169 #first try void if applicable
4170 if ( $cust_pay && $cust_pay->paid == $amount
4172 ( not defined($disable_void_after) )
4173 || ( time < ($cust_pay->_date + $disable_void_after ) )
4176 warn " attempting void\n" if $DEBUG > 1;
4177 my $void = new Business::OnlinePayment( $processor, @bop_options );
4178 $void->content( 'action' => 'void', %content );
4180 if ( $void->is_success ) {
4181 my $error = $cust_pay->void($options{'reason'});
4183 # gah, even with transactions.
4184 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4185 "error voiding payment: $error";
4189 warn " void successful\n" if $DEBUG > 1;
4194 warn " void unsuccessful, trying refund\n"
4198 my $address = $self->address1;
4199 $address .= ", ". $self->address2 if $self->address2;
4201 my($payname, $payfirst, $paylast);
4202 if ( $self->payname && $method ne 'ECHECK' ) {
4203 $payname = $self->payname;
4204 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4205 or return "Illegal payname $payname";
4206 ($payfirst, $paylast) = ($1, $2);
4208 $payfirst = $self->getfield('first');
4209 $paylast = $self->getfield('last');
4210 $payname = "$payfirst $paylast";
4213 my @invoicing_list = $self->invoicing_list_emailonly;
4214 if ( $conf->exists('emailinvoiceautoalways')
4215 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4216 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4217 push @invoicing_list, $self->all_emails;
4220 my $email = ($conf->exists('business-onlinepayment-email-override'))
4221 ? $conf->config('business-onlinepayment-email-override')
4222 : $invoicing_list[0];
4224 my $payip = exists($options{'payip'})
4227 $content{customer_ip} = $payip
4231 if ( $method eq 'CC' ) {
4234 $content{card_number} = $payinfo = $cust_pay->payinfo;
4235 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4236 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4237 ($content{expiration} = "$2/$1"); # where available
4239 $content{card_number} = $payinfo = $self->payinfo;
4240 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4241 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4242 $content{expiration} = "$2/$1";
4245 } elsif ( $method eq 'ECHECK' ) {
4248 $payinfo = $cust_pay->payinfo;
4250 $payinfo = $self->payinfo;
4252 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4253 $content{bank_name} = $self->payname;
4254 $content{account_type} = 'CHECKING';
4255 $content{account_name} = $payname;
4256 $content{customer_org} = $self->company ? 'B' : 'I';
4257 $content{customer_ssn} = $self->ss;
4258 } elsif ( $method eq 'LEC' ) {
4259 $content{phone} = $payinfo = $self->payinfo;
4263 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4264 my %sub_content = $refund->content(
4265 'action' => 'credit',
4266 'customer_id' => $self->custnum,
4267 'last_name' => $paylast,
4268 'first_name' => $payfirst,
4270 'address' => $address,
4271 'city' => $self->city,
4272 'state' => $self->state,
4273 'zip' => $self->zip,
4274 'country' => $self->country,
4276 'phone' => $self->daytime || $self->night,
4279 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4283 return "$processor error: ". $refund->error_message
4284 unless $refund->is_success();
4286 my %method2payby = (
4292 my $paybatch = "$processor:". $refund->authorization;
4293 $paybatch .= ':'. $refund->order_number
4294 if $refund->can('order_number') && $refund->order_number;
4296 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4297 my @cust_bill_pay = $cust_pay->cust_bill_pay;
4298 last unless @cust_bill_pay;
4299 my $cust_bill_pay = pop @cust_bill_pay;
4300 my $error = $cust_bill_pay->delete;
4304 my $cust_refund = new FS::cust_refund ( {
4305 'custnum' => $self->custnum,
4306 'paynum' => $options{'paynum'},
4307 'refund' => $amount,
4309 'payby' => $method2payby{$method},
4310 'payinfo' => $payinfo,
4311 'paybatch' => $paybatch,
4312 'reason' => $options{'reason'} || 'card or ACH refund',
4314 my $error = $cust_refund->insert;
4316 $cust_refund->paynum(''); #try again with no specific paynum
4317 my $error2 = $cust_refund->insert;
4319 # gah, even with transactions.
4320 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4321 "error inserting refund ($processor): $error2".
4322 " (previously tried insert with paynum #$options{'paynum'}" .
4333 # does the configuration indicate the new bop routines are required?
4335 sub _new_bop_required {
4338 my $botpp = 'Business::OnlineThirdPartyPayment';
4341 if ( $conf->config('business-onlinepayment-namespace') eq $botpp ||
4342 scalar( grep { $_->gateway_namespace eq $botpp }
4343 qsearch( 'payment_gateway', { 'disabled' => '' } )
4352 =item realtime_collect [ OPTION => VALUE ... ]
4354 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4355 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4356 gateway. See L<http://420.am/business-onlinepayment> and
4357 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4359 On failure returns an error message.
4361 Returns false or a hashref upon success. The hashref contains keys popup_url reference, and collectitems. The first is a URL to which a browser should be redirected for completion of collection. The second is a reference id for the transaction suitable for the end user. The collectitems is a reference to a list of name value pairs suitable for assigning to a html form and posted to popup_url.
4363 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4365 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
4366 then it is deduced from the customer record.
4368 If no I<amount> is specified, then the customer balance is used.
4370 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4371 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4372 if set, will override the value from the customer record.
4374 I<description> is a free-text field passed to the gateway. It defaults to
4375 "Internet services".
4377 If an I<invnum> is specified, this payment (if successful) is applied to the
4378 specified invoice. If you don't specify an I<invnum> you might want to
4379 call the B<apply_payments> method.
4381 I<quiet> can be set true to surpress email decline notices.
4383 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4384 resulting paynum, if any.
4386 I<payunique> is a unique identifier for this payment.
4388 I<session_id> is a session identifier associated with this payment.
4390 I<depend_jobnum> allows payment capture to unlock export jobs
4394 sub realtime_collect {
4395 my( $self, %options ) = @_;
4398 warn "$me realtime_collect:\n";
4399 warn " $_ => $options{$_}\n" foreach keys %options;
4402 $options{amount} = $self->balance unless exists( $options{amount} );
4403 $options{method} = FS::payby->payby2bop($self->payby)
4404 unless exists( $options{method} );
4406 return $self->realtime_bop({%options});
4410 =item _realtime_bop { [ ARG => VALUE ... ] }
4412 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4413 via a Business::OnlinePayment realtime gateway. See
4414 L<http://420.am/business-onlinepayment> for supported gateways.
4416 Required arguments in the hashref are I<method>, and I<amount>
4418 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4420 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4422 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4423 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4424 if set, will override the value from the customer record.
4426 I<description> is a free-text field passed to the gateway. It defaults to
4427 "Internet services".
4429 If an I<invnum> is specified, this payment (if successful) is applied to the
4430 specified invoice. If you don't specify an I<invnum> you might want to
4431 call the B<apply_payments> method.
4433 I<quiet> can be set true to surpress email decline notices.
4435 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4436 resulting paynum, if any.
4438 I<payunique> is a unique identifier for this payment.
4440 I<session_id> is a session identifier associated with this payment.
4442 I<depend_jobnum> allows payment capture to unlock export jobs
4444 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4448 # some helper routines
4449 sub _payment_gateway {
4450 my ($self, $options) = @_;
4452 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
4453 unless exists($options->{payment_gateway});
4455 $options->{payment_gateway};
4459 my ($self, $options) = @_;
4462 'login' => $options->{payment_gateway}->gateway_username,
4463 'password' => $options->{payment_gateway}->gateway_password,
4468 my ($self, $options) = @_;
4470 $options->{payment_gateway}->gatewaynum
4471 ? $options->{payment_gateway}->options
4472 : @{ $options->{payment_gateway}->get('options') };
4476 my ($self, $options) = @_;
4478 $options->{description} ||= 'Internet services';
4479 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
4480 $options->{invnum} ||= '';
4481 $options->{payname} = $self->payname unless exists( $options->{payname} );
4485 my ($self, $options) = @_;
4488 $content{address} = exists($options->{'address1'})
4489 ? $options->{'address1'}
4491 my $address2 = exists($options->{'address2'})
4492 ? $options->{'address2'}
4494 $content{address} .= ", ". $address2 if length($address2);
4496 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
4497 $content{customer_ip} = $payip if length($payip);
4499 $content{invoice_number} = $options->{'invnum'}
4500 if exists($options->{'invnum'}) && length($options->{'invnum'});
4502 $content{email_customer} =
4503 ( $conf->exists('business-onlinepayment-email_customer')
4504 || $conf->exists('business-onlinepayment-email-override') );
4506 $content{payfirst} = $self->getfield('first');
4507 $content{paylast} = $self->getfield('last');
4509 $content{account_name} = "$content{payfirst} $content{paylast}"
4510 if $options->{method} eq 'ECHECK';
4512 $content{name} = $options->{payname};
4513 $content{name} = $content{account_name} if exists($content{account_name});
4515 $content{city} = exists($options->{city})
4518 $content{state} = exists($options->{state})
4521 $content{zip} = exists($options->{zip})
4524 $content{country} = exists($options->{country})
4525 ? $options->{country}
4527 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
4528 $content{phone} = $self->daytime || $self->night;
4533 my %bop_method2payby = (
4539 sub _new_realtime_bop {
4543 if (ref($_[0]) eq 'HASH') {
4544 %options = %{$_[0]};
4546 my ( $method, $amount ) = ( shift, shift );
4548 $options{method} = $method;
4549 $options{amount} = $amount;
4553 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
4554 warn " $_ => $options{$_}\n" foreach keys %options;
4557 return $self->fake_bop(%options) if $options{'fake'};
4559 $self->_bop_defaults(\%options);
4565 my $payment_gateway = $self->_payment_gateway( \%options );
4566 my $namespace = $payment_gateway->gateway_namespace;
4568 eval "use $namespace";
4572 # check for banned credit card/ACH
4575 my $ban = qsearchs('banned_pay', {
4576 'payby' => $bop_method2payby{$options{method}},
4577 'payinfo' => md5_base64($options{payinfo}),
4579 return "Banned credit card" if $ban;
4585 my (%bop_content) = $self->_bop_content(\%options);
4587 if ( $options{method} ne 'ECHECK' ) {
4588 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4589 or return "Illegal payname $options{payname}";
4590 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
4593 my @invoicing_list = $self->invoicing_list_emailonly;
4594 if ( $conf->exists('emailinvoiceautoalways')
4595 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4596 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4597 push @invoicing_list, $self->all_emails;
4600 my $email = ($conf->exists('business-onlinepayment-email-override'))
4601 ? $conf->config('business-onlinepayment-email-override')
4602 : $invoicing_list[0];
4606 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
4608 $content{card_number} = $options{payinfo};
4609 $paydate = exists($options{'paydate'})
4610 ? $options{'paydate'}
4612 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4613 $content{expiration} = "$2/$1";
4615 my $paycvv = exists($options{'paycvv'})
4616 ? $options{'paycvv'}
4618 $content{cvv2} = $paycvv
4621 my $paystart_month = exists($options{'paystart_month'})
4622 ? $options{'paystart_month'}
4623 : $self->paystart_month;
4625 my $paystart_year = exists($options{'paystart_year'})
4626 ? $options{'paystart_year'}
4627 : $self->paystart_year;
4629 $content{card_start} = "$paystart_month/$paystart_year"
4630 if $paystart_month && $paystart_year;
4632 my $payissue = exists($options{'payissue'})
4633 ? $options{'payissue'}
4635 $content{issue_number} = $payissue if $payissue;
4637 $content{recurring_billing} = 'YES'
4638 if qsearch('cust_pay', { 'custnum' => $self->custnum,
4640 'payinfo' => $options{payinfo},
4642 || qsearch('cust_pay', { 'custnum' => $self->custnum,
4644 'paymask' => $self->mask_payinfo('CARD', $options{payinfo}),
4648 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
4649 ( $content{account_number}, $content{routing_code} ) =
4650 split('@', $options{payinfo});
4651 $content{bank_name} = $options{payname};
4652 $content{bank_state} = exists($options{'paystate'})
4653 ? $options{'paystate'}
4654 : $self->getfield('paystate');
4655 $content{account_type} = exists($options{'paytype'})
4656 ? uc($options{'paytype'}) || 'CHECKING'
4657 : uc($self->getfield('paytype')) || 'CHECKING';
4658 $content{customer_org} = $self->company ? 'B' : 'I';
4659 $content{state_id} = exists($options{'stateid'})
4660 ? $options{'stateid'}
4661 : $self->getfield('stateid');
4662 $content{state_id_state} = exists($options{'stateid_state'})
4663 ? $options{'stateid_state'}
4664 : $self->getfield('stateid_state');
4665 $content{customer_ssn} = exists($options{'ss'})
4668 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
4669 $content{phone} = $options{payinfo};
4670 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
4677 # run transaction(s)
4680 my $balance = exists( $options{'balance'} )
4681 ? $options{'balance'}
4684 $self->select_for_update; #mutex ... just until we get our pending record in
4686 #the checks here are intended to catch concurrent payments
4687 #double-form-submission prevention is taken care of in cust_pay_pending::check
4690 return "The customer's balance has changed; $options{method} transaction aborted."
4691 if $self->balance < $balance;
4692 #&& $self->balance < $options{amount}; #might as well anyway?
4694 #also check and make sure there aren't *other* pending payments for this cust
4696 my @pending = qsearch('cust_pay_pending', {
4697 'custnum' => $self->custnum,
4698 'status' => { op=>'!=', value=>'done' }
4700 return "A payment is already being processed for this customer (".
4701 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4702 "); $options{method} transaction aborted."
4703 if scalar(@pending);
4705 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4707 my $cust_pay_pending = new FS::cust_pay_pending {
4708 'custnum' => $self->custnum,
4709 #'invnum' => $options{'invnum'},
4710 'paid' => $options{amount},
4712 'payby' => $bop_method2payby{$options{method}},
4713 'payinfo' => $options{payinfo},
4714 'paydate' => $paydate,
4716 'gatewaynum' => $payment_gateway->gatewaynum || '',
4717 'session_id' => $options{session_id} || '',
4718 'jobnum' => $options{depend_jobnum} || '',
4720 $cust_pay_pending->payunique( $options{payunique} )
4721 if defined($options{payunique}) && length($options{payunique});
4722 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4723 return $cpp_new_err if $cpp_new_err;
4725 my( $action1, $action2 ) =
4726 split( /\s*\,\s*/, $payment_gateway->gateway_action );
4728 my $transaction = new $namespace( $payment_gateway->gateway_module,
4729 $self->_bop_options(\%options),
4732 $transaction->content(
4733 'type' => $options{method},
4734 $self->_bop_auth(\%options),
4735 'action' => $action1,
4736 'description' => $options{'description'},
4737 'amount' => $options{amount},
4738 #'invoice_number' => $options{'invnum'},
4739 'customer_id' => $self->custnum,
4741 'reference' => $cust_pay_pending->paypendingnum, #for now
4746 $cust_pay_pending->status('pending');
4747 my $cpp_pending_err = $cust_pay_pending->replace;
4748 return $cpp_pending_err if $cpp_pending_err;
4751 my $BOP_TESTING = 0;
4752 my $BOP_TESTING_SUCCESS = 1;
4754 unless ( $BOP_TESTING ) {
4755 $transaction->submit();
4757 if ( $BOP_TESTING_SUCCESS ) {
4758 $transaction->is_success(1);
4759 $transaction->authorization('fake auth');
4761 $transaction->is_success(0);
4762 $transaction->error_message('fake failure');
4766 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
4768 return { reference => $cust_pay_pending->paypendingnum,
4769 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
4771 } elsif ( $transaction->is_success() && $action2 ) {
4773 $cust_pay_pending->status('authorized');
4774 my $cpp_authorized_err = $cust_pay_pending->replace;
4775 return $cpp_authorized_err if $cpp_authorized_err;
4777 my $auth = $transaction->authorization;
4778 my $ordernum = $transaction->can('order_number')
4779 ? $transaction->order_number
4783 new Business::OnlinePayment( $payment_gateway->gateway_module,
4784 $self->_bop_options(\%options),
4789 type => $options{method},
4791 $self->_bop_auth(\%options),
4792 order_number => $ordernum,
4793 amount => $options{amount},
4794 authorization => $auth,
4795 description => $options{'description'},
4798 foreach my $field (qw( authorization_source_code returned_ACI
4799 transaction_identifier validation_code
4800 transaction_sequence_num local_transaction_date
4801 local_transaction_time AVS_result_code )) {
4802 $capture{$field} = $transaction->$field() if $transaction->can($field);
4805 $capture->content( %capture );
4809 unless ( $capture->is_success ) {
4810 my $e = "Authorization successful but capture failed, custnum #".
4811 $self->custnum. ': '. $capture->result_code.
4812 ": ". $capture->error_message;
4820 # remove paycvv after initial transaction
4823 #false laziness w/misc/process/payment.cgi - check both to make sure working
4825 if ( defined $self->dbdef_table->column('paycvv')
4826 && length($self->paycvv)
4827 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
4829 my $error = $self->remove_cvv;
4831 warn "WARNING: error removing cvv: $error\n";
4839 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
4851 if (ref($_[0]) eq 'HASH') {
4852 %options = %{$_[0]};
4854 my ( $method, $amount ) = ( shift, shift );
4856 $options{method} = $method;
4857 $options{amount} = $amount;
4860 if ( $options{'fake_failure'} ) {
4861 return "Error: No error; test failure requested with fake_failure";
4865 #if ( $payment_gateway->gatewaynum ) { # agent override
4866 # $paybatch = $payment_gateway->gatewaynum. '-';
4869 #$paybatch .= "$processor:". $transaction->authorization;
4871 #$paybatch .= ':'. $transaction->order_number
4872 # if $transaction->can('order_number')
4873 # && length($transaction->order_number);
4875 my $paybatch = 'FakeProcessor:54:32';
4877 my $cust_pay = new FS::cust_pay ( {
4878 'custnum' => $self->custnum,
4879 'invnum' => $options{'invnum'},
4880 'paid' => $options{amount},
4882 'payby' => $bop_method2payby{$options{method}},
4883 #'payinfo' => $payinfo,
4884 'payinfo' => '4111111111111111',
4885 'paybatch' => $paybatch,
4886 #'paydate' => $paydate,
4887 'paydate' => '2012-05-01',
4889 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
4891 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4894 $cust_pay->invnum(''); #try again with no specific invnum
4895 my $error2 = $cust_pay->insert( $options{'manual'} ?
4896 ( 'manual' => 1 ) : ()
4899 # gah, even with transactions.
4900 my $e = 'WARNING: Card/ACH debited but database not updated - '.
4901 "error inserting (fake!) payment: $error2".
4902 " (previously tried insert with invnum #$options{'invnum'}" .
4909 if ( $options{'paynum_ref'} ) {
4910 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4913 return ''; #no error
4918 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
4920 # Wraps up processing of a realtime credit card, ACH (electronic check) or
4921 # phone bill transaction.
4923 sub _realtime_bop_result {
4924 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
4926 warn "$me _realtime_bop_result: pending transaction ".
4927 $cust_pay_pending->paypendingnum. "\n";
4928 warn " $_ => $options{$_}\n" foreach keys %options;
4931 my $payment_gateway = $options{payment_gateway}
4932 or return "no payment gateway in arguments to _realtime_bop_result";
4934 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4935 my $cpp_captured_err = $cust_pay_pending->replace;
4936 return $cpp_captured_err if $cpp_captured_err;
4938 if ( $transaction->is_success() ) {
4941 if ( $payment_gateway->gatewaynum ) { # agent override
4942 $paybatch = $payment_gateway->gatewaynum. '-';
4945 $paybatch .= $payment_gateway->gateway_module. ":".
4946 $transaction->authorization;
4948 $paybatch .= ':'. $transaction->order_number
4949 if $transaction->can('order_number')
4950 && length($transaction->order_number);
4952 my $cust_pay = new FS::cust_pay ( {
4953 'custnum' => $self->custnum,
4954 'invnum' => $options{'invnum'},
4955 'paid' => $cust_pay_pending->paid,
4957 'payby' => $cust_pay_pending->payby,
4958 #'payinfo' => $payinfo,
4959 'paybatch' => $paybatch,
4960 'paydate' => $cust_pay_pending->paydate,
4962 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4963 $cust_pay->payunique( $options{payunique} )
4964 if defined($options{payunique}) && length($options{payunique});
4966 my $oldAutoCommit = $FS::UID::AutoCommit;
4967 local $FS::UID::AutoCommit = 0;
4970 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4972 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4975 $cust_pay->invnum(''); #try again with no specific invnum
4976 my $error2 = $cust_pay->insert( $options{'manual'} ?
4977 ( 'manual' => 1 ) : ()
4980 # gah. but at least we have a record of the state we had to abort in
4981 # from cust_pay_pending now.
4982 my $e = "WARNING: $options{method} captured but payment not recorded -".
4983 " error inserting payment (". $payment_gateway->gateway_module.
4985 " (previously tried insert with invnum #$options{'invnum'}" .
4986 ": $error ) - pending payment saved as paypendingnum ".
4987 $cust_pay_pending->paypendingnum. "\n";
4993 my $jobnum = $cust_pay_pending->jobnum;
4995 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
4997 unless ( $placeholder ) {
4998 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4999 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5000 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5005 $error = $placeholder->delete;
5008 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5009 my $e = "WARNING: $options{method} captured but could not delete ".
5010 "job $jobnum for paypendingnum ".
5011 $cust_pay_pending->paypendingnum. ": $error\n";
5018 if ( $options{'paynum_ref'} ) {
5019 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5022 $cust_pay_pending->status('done');
5023 $cust_pay_pending->statustext('captured');
5024 $cust_pay_pending->paynum($cust_pay->paynum);
5025 my $cpp_done_err = $cust_pay_pending->replace;
5027 if ( $cpp_done_err ) {
5029 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5030 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5031 "error updating status for paypendingnum ".
5032 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5038 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5039 return ''; #no error
5045 my $perror = $payment_gateway->gateway_module. " error: ".
5046 $transaction->error_message;
5048 my $jobnum = $cust_pay_pending->jobnum;
5050 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5052 if ( $placeholder ) {
5053 my $error = $placeholder->depended_delete;
5054 $error ||= $placeholder->delete;
5055 warn "error removing provisioning jobs after declined paypendingnum ".
5056 $cust_pay_pending->paypendingnum. "\n";
5058 my $e = "error finding job $jobnum for declined paypendingnum ".
5059 $cust_pay_pending->paypendingnum. "\n";
5065 unless ( $transaction->error_message ) {
5068 if ( $transaction->can('response_page') ) {
5070 'page' => ( $transaction->can('response_page')
5071 ? $transaction->response_page
5074 'code' => ( $transaction->can('response_code')
5075 ? $transaction->response_code
5078 'headers' => ( $transaction->can('response_headers')
5079 ? $transaction->response_headers
5085 "No additional debugging information available for ".
5086 $payment_gateway->gateway_module;
5089 $perror .= "No error_message returned from ".
5090 $payment_gateway->gateway_module. " -- ".
5091 ( ref($t_response) ? Dumper($t_response) : $t_response );
5095 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5096 && $conf->exists('emaildecline')
5097 && grep { $_ ne 'POST' } $self->invoicing_list
5098 && ! grep { $transaction->error_message =~ /$_/ }
5099 $conf->config('emaildecline-exclude')
5101 my @templ = $conf->config('declinetemplate');
5102 my $template = new Text::Template (
5104 SOURCE => [ map "$_\n", @templ ],
5105 ) or return "($perror) can't create template: $Text::Template::ERROR";
5106 $template->compile()
5107 or return "($perror) can't compile template: $Text::Template::ERROR";
5109 my $templ_hash = { error => $transaction->error_message };
5111 my $error = send_email(
5112 'from' => $conf->config('invoice_from', $self->agentnum ),
5113 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5114 'subject' => 'Your payment could not be processed',
5115 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5118 $perror .= " (also received error sending decline notification: $error)"
5123 $cust_pay_pending->status('done');
5124 $cust_pay_pending->statustext("declined: $perror");
5125 my $cpp_done_err = $cust_pay_pending->replace;
5126 if ( $cpp_done_err ) {
5127 my $e = "WARNING: $options{method} declined but pending payment not ".
5128 "resolved - error updating status for paypendingnum ".
5129 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5131 $perror = "$e ($perror)";
5139 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5141 Verifies successful third party processing of a realtime credit card,
5142 ACH (electronic check) or phone bill transaction via a
5143 Business::OnlineThirdPartyPayment realtime gateway. See
5144 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5146 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5148 The additional options I<payname>, I<city>, I<state>,
5149 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5150 if set, will override the value from the customer record.
5152 I<description> is a free-text field passed to the gateway. It defaults to
5153 "Internet services".
5155 If an I<invnum> is specified, this payment (if successful) is applied to the
5156 specified invoice. If you don't specify an I<invnum> you might want to
5157 call the B<apply_payments> method.
5159 I<quiet> can be set true to surpress email decline notices.
5161 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5162 resulting paynum, if any.
5164 I<payunique> is a unique identifier for this payment.
5166 Returns a hashref containing elements bill_error (which will be undefined
5167 upon success) and session_id of any associated session.
5171 sub realtime_botpp_capture {
5172 my( $self, $cust_pay_pending, %options ) = @_;
5174 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5175 warn " $_ => $options{$_}\n" foreach keys %options;
5178 eval "use Business::OnlineThirdPartyPayment";
5182 # select the gateway
5185 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5187 my $payment_gateway = $cust_pay_pending->gatewaynum
5188 ? qsearchs( 'payment_gateway',
5189 { gatewaynum => $cust_pay_pending->gatewaynum }
5191 : $self->agent->payment_gateway( 'method' => $method,
5192 # 'invnum' => $cust_pay_pending->invnum,
5193 # 'payinfo' => $cust_pay_pending->payinfo,
5196 $options{payment_gateway} = $payment_gateway; # for the helper subs
5202 my @invoicing_list = $self->invoicing_list_emailonly;
5203 if ( $conf->exists('emailinvoiceautoalways')
5204 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5205 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5206 push @invoicing_list, $self->all_emails;
5209 my $email = ($conf->exists('business-onlinepayment-email-override'))
5210 ? $conf->config('business-onlinepayment-email-override')
5211 : $invoicing_list[0];
5215 $content{email_customer} =
5216 ( $conf->exists('business-onlinepayment-email_customer')
5217 || $conf->exists('business-onlinepayment-email-override') );
5220 # run transaction(s)
5224 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5225 $self->_bop_options(\%options),
5228 $transaction->reference({ %options });
5230 $transaction->content(
5232 $self->_bop_auth(\%options),
5233 'action' => 'Post Authorization',
5234 'description' => $options{'description'},
5235 'amount' => $cust_pay_pending->paid,
5236 #'invoice_number' => $options{'invnum'},
5237 'customer_id' => $self->custnum,
5238 'referer' => 'http://cleanwhisker.420.am/',
5239 'reference' => $cust_pay_pending->paypendingnum,
5241 'phone' => $self->daytime || $self->night,
5243 # plus whatever is required for bogus capture avoidance
5246 $transaction->submit();
5249 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5252 bill_error => $error,
5253 session_id => $cust_pay_pending->session_id,
5258 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5262 sub default_payment_gateway {
5263 my( $self, $method ) = @_;
5265 die "Real-time processing not enabled\n"
5266 unless $conf->exists('business-onlinepayment');
5268 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5271 my $bop_config = 'business-onlinepayment';
5272 $bop_config .= '-ach'
5273 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5274 my ( $processor, $login, $password, $action, @bop_options ) =
5275 $conf->config($bop_config);
5276 $action ||= 'normal authorization';
5277 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5278 die "No real-time processor is enabled - ".
5279 "did you set the business-onlinepayment configuration value?\n"
5282 ( $processor, $login, $password, $action, @bop_options )
5287 Removes the I<paycvv> field from the database directly.
5289 If there is an error, returns the error, otherwise returns false.
5295 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5296 or return dbh->errstr;
5297 $sth->execute($self->custnum)
5298 or return $sth->errstr;
5303 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5305 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5306 via a Business::OnlinePayment realtime gateway. See
5307 L<http://420.am/business-onlinepayment> for supported gateways.
5309 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5311 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5313 Most gateways require a reference to an original payment transaction to refund,
5314 so you probably need to specify a I<paynum>.
5316 I<amount> defaults to the original amount of the payment if not specified.
5318 I<reason> specifies a reason for the refund.
5320 I<paydate> specifies the expiration date for a credit card overriding the
5321 value from the customer record or the payment record. Specified as yyyy-mm-dd
5323 Implementation note: If I<amount> is unspecified or equal to the amount of the
5324 orignal payment, first an attempt is made to "void" the transaction via
5325 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5326 the normal attempt is made to "refund" ("credit") the transaction via the
5327 gateway is attempted.
5329 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5330 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5331 #if set, will override the value from the customer record.
5333 #If an I<invnum> is specified, this payment (if successful) is applied to the
5334 #specified invoice. If you don't specify an I<invnum> you might want to
5335 #call the B<apply_payments> method.
5339 #some false laziness w/realtime_bop, not enough to make it worth merging
5340 #but some useful small subs should be pulled out
5341 sub _new_realtime_refund_bop {
5345 if (ref($_[0]) ne 'HASH') {
5346 %options = %{$_[0]};
5350 $options{method} = $method;
5354 warn "$me realtime_refund_bop (new): $options{method} refund\n";
5355 warn " $_ => $options{$_}\n" foreach keys %options;
5359 # look up the original payment and optionally a gateway for that payment
5363 my $amount = $options{'amount'};
5365 my( $processor, $login, $password, @bop_options, $namespace ) ;
5366 my( $auth, $order_number ) = ( '', '', '' );
5368 if ( $options{'paynum'} ) {
5370 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
5371 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
5372 or return "Unknown paynum $options{'paynum'}";
5373 $amount ||= $cust_pay->paid;
5375 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
5376 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
5377 $cust_pay->paybatch;
5378 my $gatewaynum = '';
5379 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
5381 if ( $gatewaynum ) { #gateway for the payment to be refunded
5383 my $payment_gateway =
5384 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
5385 die "payment gateway $gatewaynum not found"
5386 unless $payment_gateway;
5388 $processor = $payment_gateway->gateway_module;
5389 $login = $payment_gateway->gateway_username;
5390 $password = $payment_gateway->gateway_password;
5391 $namespace = $payment_gateway->gateway_namespace;
5392 @bop_options = $payment_gateway->options;
5394 } else { #try the default gateway
5397 my $payment_gateway =
5398 $self->agent->payment_gateway('method' => $options{method});
5400 ( $conf_processor, $login, $password, $namespace ) =
5401 map { my $method = "gateway_$_"; $payment_gateway->$method }
5402 qw( module username password namespace );
5404 @bop_options = $payment_gateway->gatewaynum
5405 ? $payment_gateway->options
5406 : @{ $payment_gateway->get('options') };
5408 return "processor of payment $options{'paynum'} $processor does not".
5409 " match default processor $conf_processor"
5410 unless $processor eq $conf_processor;
5415 } else { # didn't specify a paynum, so look for agent gateway overrides
5416 # like a normal transaction
5418 my $payment_gateway =
5419 $self->agent->payment_gateway( 'method' => $options{method},
5420 #'payinfo' => $payinfo,
5422 my( $processor, $login, $password, $namespace ) =
5423 map { my $method = "gateway_$_"; $payment_gateway->$method }
5424 qw( module username password namespace );
5426 my @bop_options = $payment_gateway->gatewaynum
5427 ? $payment_gateway->options
5428 : @{ $payment_gateway->get('options') };
5431 return "neither amount nor paynum specified" unless $amount;
5433 eval "use $namespace";
5437 'type' => $options{method},
5439 'password' => $password,
5440 'order_number' => $order_number,
5441 'amount' => $amount,
5442 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
5444 $content{authorization} = $auth
5445 if length($auth); #echeck/ACH transactions have an order # but no auth
5446 #(at least with authorize.net)
5448 my $disable_void_after;
5449 if ($conf->exists('disable_void_after')
5450 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
5451 $disable_void_after = $1;
5454 #first try void if applicable
5455 if ( $cust_pay && $cust_pay->paid == $amount
5457 ( not defined($disable_void_after) )
5458 || ( time < ($cust_pay->_date + $disable_void_after ) )
5461 warn " attempting void\n" if $DEBUG > 1;
5462 my $void = new Business::OnlinePayment( $processor, @bop_options );
5463 $void->content( 'action' => 'void', %content );
5465 if ( $void->is_success ) {
5466 my $error = $cust_pay->void($options{'reason'});
5468 # gah, even with transactions.
5469 my $e = 'WARNING: Card/ACH voided but database not updated - '.
5470 "error voiding payment: $error";
5474 warn " void successful\n" if $DEBUG > 1;
5479 warn " void unsuccessful, trying refund\n"
5483 my $address = $self->address1;
5484 $address .= ", ". $self->address2 if $self->address2;
5486 my($payname, $payfirst, $paylast);
5487 if ( $self->payname && $options{method} ne 'ECHECK' ) {
5488 $payname = $self->payname;
5489 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5490 or return "Illegal payname $payname";
5491 ($payfirst, $paylast) = ($1, $2);
5493 $payfirst = $self->getfield('first');
5494 $paylast = $self->getfield('last');
5495 $payname = "$payfirst $paylast";
5498 my @invoicing_list = $self->invoicing_list_emailonly;
5499 if ( $conf->exists('emailinvoiceautoalways')
5500 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5501 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5502 push @invoicing_list, $self->all_emails;
5505 my $email = ($conf->exists('business-onlinepayment-email-override'))
5506 ? $conf->config('business-onlinepayment-email-override')
5507 : $invoicing_list[0];
5509 my $payip = exists($options{'payip'})
5512 $content{customer_ip} = $payip
5516 if ( $options{method} eq 'CC' ) {
5519 $content{card_number} = $payinfo = $cust_pay->payinfo;
5520 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
5521 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
5522 ($content{expiration} = "$2/$1"); # where available
5524 $content{card_number} = $payinfo = $self->payinfo;
5525 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
5526 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5527 $content{expiration} = "$2/$1";
5530 } elsif ( $options{method} eq 'ECHECK' ) {
5533 $payinfo = $cust_pay->payinfo;
5535 $payinfo = $self->payinfo;
5537 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
5538 $content{bank_name} = $self->payname;
5539 $content{account_type} = 'CHECKING';
5540 $content{account_name} = $payname;
5541 $content{customer_org} = $self->company ? 'B' : 'I';
5542 $content{customer_ssn} = $self->ss;
5543 } elsif ( $options{method} eq 'LEC' ) {
5544 $content{phone} = $payinfo = $self->payinfo;
5548 my $refund = new Business::OnlinePayment( $processor, @bop_options );
5549 my %sub_content = $refund->content(
5550 'action' => 'credit',
5551 'customer_id' => $self->custnum,
5552 'last_name' => $paylast,
5553 'first_name' => $payfirst,
5555 'address' => $address,
5556 'city' => $self->city,
5557 'state' => $self->state,
5558 'zip' => $self->zip,
5559 'country' => $self->country,
5561 'phone' => $self->daytime || $self->night,
5564 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
5568 return "$processor error: ". $refund->error_message
5569 unless $refund->is_success();
5571 my $paybatch = "$processor:". $refund->authorization;
5572 $paybatch .= ':'. $refund->order_number
5573 if $refund->can('order_number') && $refund->order_number;
5575 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
5576 my @cust_bill_pay = $cust_pay->cust_bill_pay;
5577 last unless @cust_bill_pay;
5578 my $cust_bill_pay = pop @cust_bill_pay;
5579 my $error = $cust_bill_pay->delete;
5583 my $cust_refund = new FS::cust_refund ( {
5584 'custnum' => $self->custnum,
5585 'paynum' => $options{'paynum'},
5586 'refund' => $amount,
5588 'payby' => $bop_method2payby{$options{method}},
5589 'payinfo' => $payinfo,
5590 'paybatch' => $paybatch,
5591 'reason' => $options{'reason'} || 'card or ACH refund',
5593 my $error = $cust_refund->insert;
5595 $cust_refund->paynum(''); #try again with no specific paynum
5596 my $error2 = $cust_refund->insert;
5598 # gah, even with transactions.
5599 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
5600 "error inserting refund ($processor): $error2".
5601 " (previously tried insert with paynum #$options{'paynum'}" .
5612 =item batch_card OPTION => VALUE...
5614 Adds a payment for this invoice to the pending credit card batch (see
5615 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
5616 runs the payment using a realtime gateway.
5621 my ($self, %options) = @_;
5624 if (exists($options{amount})) {
5625 $amount = $options{amount};
5627 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
5629 return '' unless $amount > 0;
5631 my $invnum = delete $options{invnum};
5632 my $payby = $options{invnum} || $self->payby; #dubious
5634 if ($options{'realtime'}) {
5635 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
5641 my $oldAutoCommit = $FS::UID::AutoCommit;
5642 local $FS::UID::AutoCommit = 0;
5645 #this needs to handle mysql as well as Pg, like svc_acct.pm
5646 #(make it into a common function if folks need to do batching with mysql)
5647 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
5648 or return "Cannot lock pay_batch: " . $dbh->errstr;
5652 'payby' => FS::payby->payby2payment($payby),
5655 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
5657 unless ( $pay_batch ) {
5658 $pay_batch = new FS::pay_batch \%pay_batch;
5659 my $error = $pay_batch->insert;
5661 $dbh->rollback if $oldAutoCommit;
5662 die "error creating new batch: $error\n";
5666 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
5667 'batchnum' => $pay_batch->batchnum,
5668 'custnum' => $self->custnum,
5671 foreach (qw( address1 address2 city state zip country payby payinfo paydate
5673 $options{$_} = '' unless exists($options{$_});
5676 my $cust_pay_batch = new FS::cust_pay_batch ( {
5677 'batchnum' => $pay_batch->batchnum,
5678 'invnum' => $invnum || 0, # is there a better value?
5679 # this field should be
5681 # cust_bill_pay_batch now
5682 'custnum' => $self->custnum,
5683 'last' => $self->getfield('last'),
5684 'first' => $self->getfield('first'),
5685 'address1' => $options{address1} || $self->address1,
5686 'address2' => $options{address2} || $self->address2,
5687 'city' => $options{city} || $self->city,
5688 'state' => $options{state} || $self->state,
5689 'zip' => $options{zip} || $self->zip,
5690 'country' => $options{country} || $self->country,
5691 'payby' => $options{payby} || $self->payby,
5692 'payinfo' => $options{payinfo} || $self->payinfo,
5693 'exp' => $options{paydate} || $self->paydate,
5694 'payname' => $options{payname} || $self->payname,
5695 'amount' => $amount, # consolidating
5698 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
5699 if $old_cust_pay_batch;
5702 if ($old_cust_pay_batch) {
5703 $error = $cust_pay_batch->replace($old_cust_pay_batch)
5705 $error = $cust_pay_batch->insert;
5709 $dbh->rollback if $oldAutoCommit;
5713 my $unapplied = $self->total_unapplied_credits
5714 + $self->total_unapplied_payments
5715 + $self->in_transit_payments;
5716 foreach my $cust_bill ($self->open_cust_bill) {
5717 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
5718 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
5719 'invnum' => $cust_bill->invnum,
5720 'paybatchnum' => $cust_pay_batch->paybatchnum,
5721 'amount' => $cust_bill->owed,
5724 if ($unapplied >= $cust_bill_pay_batch->amount){
5725 $unapplied -= $cust_bill_pay_batch->amount;
5728 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
5729 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
5731 $error = $cust_bill_pay_batch->insert;
5733 $dbh->rollback if $oldAutoCommit;
5738 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5742 =item apply_payments_and_credits
5744 Applies unapplied payments and credits.
5746 In most cases, this new method should be used in place of sequential
5747 apply_payments and apply_credits methods.
5749 If there is an error, returns the error, otherwise returns false.
5753 sub apply_payments_and_credits {
5756 local $SIG{HUP} = 'IGNORE';
5757 local $SIG{INT} = 'IGNORE';
5758 local $SIG{QUIT} = 'IGNORE';
5759 local $SIG{TERM} = 'IGNORE';
5760 local $SIG{TSTP} = 'IGNORE';
5761 local $SIG{PIPE} = 'IGNORE';
5763 my $oldAutoCommit = $FS::UID::AutoCommit;
5764 local $FS::UID::AutoCommit = 0;
5767 $self->select_for_update; #mutex
5769 foreach my $cust_bill ( $self->open_cust_bill ) {
5770 my $error = $cust_bill->apply_payments_and_credits;
5772 $dbh->rollback if $oldAutoCommit;
5773 return "Error applying: $error";
5777 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5782 =item apply_credits OPTION => VALUE ...
5784 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
5785 to outstanding invoice balances in chronological order (or reverse
5786 chronological order if the I<order> option is set to B<newest>) and returns the
5787 value of any remaining unapplied credits available for refund (see
5788 L<FS::cust_refund>).
5790 Dies if there is an error.
5798 local $SIG{HUP} = 'IGNORE';
5799 local $SIG{INT} = 'IGNORE';
5800 local $SIG{QUIT} = 'IGNORE';
5801 local $SIG{TERM} = 'IGNORE';
5802 local $SIG{TSTP} = 'IGNORE';
5803 local $SIG{PIPE} = 'IGNORE';
5805 my $oldAutoCommit = $FS::UID::AutoCommit;
5806 local $FS::UID::AutoCommit = 0;
5809 $self->select_for_update; #mutex
5811 unless ( $self->total_unapplied_credits ) {
5812 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5816 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
5817 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
5819 my @invoices = $self->open_cust_bill;
5820 @invoices = sort { $b->_date <=> $a->_date } @invoices
5821 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
5824 foreach my $cust_bill ( @invoices ) {
5827 if ( !defined($credit) || $credit->credited == 0) {
5828 $credit = pop @credits or last;
5831 if ($cust_bill->owed >= $credit->credited) {
5832 $amount=$credit->credited;
5834 $amount=$cust_bill->owed;
5837 my $cust_credit_bill = new FS::cust_credit_bill ( {
5838 'crednum' => $credit->crednum,
5839 'invnum' => $cust_bill->invnum,
5840 'amount' => $amount,
5842 my $error = $cust_credit_bill->insert;
5844 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5848 redo if ($cust_bill->owed > 0);
5852 my $total_unapplied_credits = $self->total_unapplied_credits;
5854 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5856 return $total_unapplied_credits;
5859 =item apply_payments
5861 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
5862 to outstanding invoice balances in chronological order.
5864 #and returns the value of any remaining unapplied payments.
5866 Dies if there is an error.
5870 sub apply_payments {
5873 local $SIG{HUP} = 'IGNORE';
5874 local $SIG{INT} = 'IGNORE';
5875 local $SIG{QUIT} = 'IGNORE';
5876 local $SIG{TERM} = 'IGNORE';
5877 local $SIG{TSTP} = 'IGNORE';
5878 local $SIG{PIPE} = 'IGNORE';
5880 my $oldAutoCommit = $FS::UID::AutoCommit;
5881 local $FS::UID::AutoCommit = 0;
5884 $self->select_for_update; #mutex
5888 my @payments = sort { $b->_date <=> $a->_date }
5889 grep { $_->unapplied > 0 }
5892 my @invoices = sort { $a->_date <=> $b->_date}
5893 grep { $_->owed > 0 }
5898 foreach my $cust_bill ( @invoices ) {
5901 if ( !defined($payment) || $payment->unapplied == 0 ) {
5902 $payment = pop @payments or last;
5905 if ( $cust_bill->owed >= $payment->unapplied ) {
5906 $amount = $payment->unapplied;
5908 $amount = $cust_bill->owed;
5911 my $cust_bill_pay = new FS::cust_bill_pay ( {
5912 'paynum' => $payment->paynum,
5913 'invnum' => $cust_bill->invnum,
5914 'amount' => $amount,
5916 my $error = $cust_bill_pay->insert;
5918 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5922 redo if ( $cust_bill->owed > 0);
5926 my $total_unapplied_payments = $self->total_unapplied_payments;
5928 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5930 return $total_unapplied_payments;
5935 Returns the total owed for this customer on all invoices
5936 (see L<FS::cust_bill/owed>).
5942 $self->total_owed_date(2145859200); #12/31/2037
5945 =item total_owed_date TIME
5947 Returns the total owed for this customer on all invoices with date earlier than
5948 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
5949 see L<Time::Local> and L<Date::Parse> for conversion functions.
5953 sub total_owed_date {
5957 foreach my $cust_bill (
5958 grep { $_->_date <= $time }
5959 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
5961 $total_bill += $cust_bill->owed;
5963 sprintf( "%.2f", $total_bill );
5968 Returns the total amount of all payments.
5975 $total += $_->paid foreach $self->cust_pay;
5976 sprintf( "%.2f", $total );
5979 =item total_unapplied_credits
5981 Returns the total outstanding credit (see L<FS::cust_credit>) for this
5982 customer. See L<FS::cust_credit/credited>.
5984 =item total_credited
5986 Old name for total_unapplied_credits. Don't use.
5990 sub total_credited {
5991 #carp "total_credited deprecated, use total_unapplied_credits";
5992 shift->total_unapplied_credits(@_);
5995 sub total_unapplied_credits {
5997 my $total_credit = 0;
5998 $total_credit += $_->credited foreach $self->cust_credit;
5999 sprintf( "%.2f", $total_credit );
6002 =item total_unapplied_payments
6004 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6005 See L<FS::cust_pay/unapplied>.
6009 sub total_unapplied_payments {
6011 my $total_unapplied = 0;
6012 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6013 sprintf( "%.2f", $total_unapplied );
6016 =item total_unapplied_refunds
6018 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6019 customer. See L<FS::cust_refund/unapplied>.
6023 sub total_unapplied_refunds {
6025 my $total_unapplied = 0;
6026 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6027 sprintf( "%.2f", $total_unapplied );
6032 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6033 total_unapplied_credits minus total_unapplied_payments).
6041 + $self->total_unapplied_refunds
6042 - $self->total_unapplied_credits
6043 - $self->total_unapplied_payments
6047 =item balance_date TIME
6049 Returns the balance for this customer, only considering invoices with date
6050 earlier than TIME (total_owed_date minus total_credited minus
6051 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6052 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6061 $self->total_owed_date($time)
6062 + $self->total_unapplied_refunds
6063 - $self->total_unapplied_credits
6064 - $self->total_unapplied_payments
6068 =item in_transit_payments
6070 Returns the total of requests for payments for this customer pending in
6071 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
6075 sub in_transit_payments {
6077 my $in_transit_payments = 0;
6078 foreach my $pay_batch ( qsearch('pay_batch', {
6081 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6082 'batchnum' => $pay_batch->batchnum,
6083 'custnum' => $self->custnum,
6085 $in_transit_payments += $cust_pay_batch->amount;
6088 sprintf( "%.2f", $in_transit_payments );
6093 Returns a hash of useful information for making a payment.
6103 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6104 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6105 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6109 For credit card transactions:
6121 For electronic check transactions:
6136 $return{balance} = $self->balance;
6138 $return{payname} = $self->payname
6139 || ( $self->first. ' '. $self->get('last') );
6141 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6143 $return{payby} = $self->payby;
6144 $return{stateid_state} = $self->stateid_state;
6146 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6147 $return{card_type} = cardtype($self->payinfo);
6148 $return{payinfo} = $self->paymask;
6150 @return{'month', 'year'} = $self->paydate_monthyear;
6154 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6155 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6156 $return{payinfo1} = $payinfo1;
6157 $return{payinfo2} = $payinfo2;
6158 $return{paytype} = $self->paytype;
6159 $return{paystate} = $self->paystate;
6163 #doubleclick protection
6165 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
6171 =item paydate_monthyear
6173 Returns a two-element list consisting of the month and year of this customer's
6174 paydate (credit card expiration date for CARD customers)
6178 sub paydate_monthyear {
6180 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
6182 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
6189 =item invoicing_list [ ARRAYREF ]
6191 If an arguement is given, sets these email addresses as invoice recipients
6192 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
6193 (except as warnings), so use check_invoicing_list first.
6195 Returns a list of email addresses (with svcnum entries expanded).
6197 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
6198 check it without disturbing anything by passing nothing.
6200 This interface may change in the future.
6204 sub invoicing_list {
6205 my( $self, $arrayref ) = @_;
6208 my @cust_main_invoice;
6209 if ( $self->custnum ) {
6210 @cust_main_invoice =
6211 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6213 @cust_main_invoice = ();
6215 foreach my $cust_main_invoice ( @cust_main_invoice ) {
6216 #warn $cust_main_invoice->destnum;
6217 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
6218 #warn $cust_main_invoice->destnum;
6219 my $error = $cust_main_invoice->delete;
6220 warn $error if $error;
6223 if ( $self->custnum ) {
6224 @cust_main_invoice =
6225 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6227 @cust_main_invoice = ();
6229 my %seen = map { $_->address => 1 } @cust_main_invoice;
6230 foreach my $address ( @{$arrayref} ) {
6231 next if exists $seen{$address} && $seen{$address};
6232 $seen{$address} = 1;
6233 my $cust_main_invoice = new FS::cust_main_invoice ( {
6234 'custnum' => $self->custnum,
6237 my $error = $cust_main_invoice->insert;
6238 warn $error if $error;
6242 if ( $self->custnum ) {
6244 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6251 =item check_invoicing_list ARRAYREF
6253 Checks these arguements as valid input for the invoicing_list method. If there
6254 is an error, returns the error, otherwise returns false.
6258 sub check_invoicing_list {
6259 my( $self, $arrayref ) = @_;
6261 foreach my $address ( @$arrayref ) {
6263 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
6264 return 'Can\'t add FAX invoice destination with a blank FAX number.';
6267 my $cust_main_invoice = new FS::cust_main_invoice ( {
6268 'custnum' => $self->custnum,
6271 my $error = $self->custnum
6272 ? $cust_main_invoice->check
6273 : $cust_main_invoice->checkdest
6275 return $error if $error;
6279 return "Email address required"
6280 if $conf->exists('cust_main-require_invoicing_list_email')
6281 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
6286 =item set_default_invoicing_list
6288 Sets the invoicing list to all accounts associated with this customer,
6289 overwriting any previous invoicing list.
6293 sub set_default_invoicing_list {
6295 $self->invoicing_list($self->all_emails);
6300 Returns the email addresses of all accounts provisioned for this customer.
6307 foreach my $cust_pkg ( $self->all_pkgs ) {
6308 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
6310 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6311 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6313 $list{$_}=1 foreach map { $_->email } @svc_acct;
6318 =item invoicing_list_addpost
6320 Adds postal invoicing to this customer. If this customer is already configured
6321 to receive postal invoices, does nothing.
6325 sub invoicing_list_addpost {
6327 return if grep { $_ eq 'POST' } $self->invoicing_list;
6328 my @invoicing_list = $self->invoicing_list;
6329 push @invoicing_list, 'POST';
6330 $self->invoicing_list(\@invoicing_list);
6333 =item invoicing_list_emailonly
6335 Returns the list of email invoice recipients (invoicing_list without non-email
6336 destinations such as POST and FAX).
6340 sub invoicing_list_emailonly {
6342 warn "$me invoicing_list_emailonly called"
6344 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
6347 =item invoicing_list_emailonly_scalar
6349 Returns the list of email invoice recipients (invoicing_list without non-email
6350 destinations such as POST and FAX) as a comma-separated scalar.
6354 sub invoicing_list_emailonly_scalar {
6356 warn "$me invoicing_list_emailonly_scalar called"
6358 join(', ', $self->invoicing_list_emailonly);
6361 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
6363 Returns an array of customers referred by this customer (referral_custnum set
6364 to this custnum). If DEPTH is given, recurses up to the given depth, returning
6365 customers referred by customers referred by this customer and so on, inclusive.
6366 The default behavior is DEPTH 1 (no recursion).
6370 sub referral_cust_main {
6372 my $depth = @_ ? shift : 1;
6373 my $exclude = @_ ? shift : {};
6376 map { $exclude->{$_->custnum}++; $_; }
6377 grep { ! $exclude->{ $_->custnum } }
6378 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
6382 map { $_->referral_cust_main($depth-1, $exclude) }
6389 =item referral_cust_main_ncancelled
6391 Same as referral_cust_main, except only returns customers with uncancelled
6396 sub referral_cust_main_ncancelled {
6398 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
6401 =item referral_cust_pkg [ DEPTH ]
6403 Like referral_cust_main, except returns a flat list of all unsuspended (and
6404 uncancelled) packages for each customer. The number of items in this list may
6405 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
6409 sub referral_cust_pkg {
6411 my $depth = @_ ? shift : 1;
6413 map { $_->unsuspended_pkgs }
6414 grep { $_->unsuspended_pkgs }
6415 $self->referral_cust_main($depth);
6418 =item referring_cust_main
6420 Returns the single cust_main record for the customer who referred this customer
6421 (referral_custnum), or false.
6425 sub referring_cust_main {
6427 return '' unless $self->referral_custnum;
6428 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
6431 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
6433 Applies a credit to this customer. If there is an error, returns the error,
6434 otherwise returns false.
6436 REASON can be a text string, an FS::reason object, or a scalar reference to
6437 a reasonnum. If a text string, it will be automatically inserted as a new
6438 reason, and a 'reason_type' option must be passed to indicate the
6439 FS::reason_type for the new reason.
6441 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
6443 Any other options are passed to FS::cust_credit::insert.
6448 my( $self, $amount, $reason, %options ) = @_;
6450 my $cust_credit = new FS::cust_credit {
6451 'custnum' => $self->custnum,
6452 'amount' => $amount,
6455 if ( ref($reason) ) {
6457 if ( ref($reason) eq 'SCALAR' ) {
6458 $cust_credit->reasonnum( $$reason );
6460 $cust_credit->reasonnum( $reason->reasonnum );
6464 $cust_credit->set('reason', $reason)
6467 $cust_credit->addlinfo( delete $options{'addlinfo'} )
6468 if exists($options{'addlinfo'});
6470 $cust_credit->insert(%options);
6474 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
6476 Creates a one-time charge for this customer. If there is an error, returns
6477 the error, otherwise returns false.
6483 my ( $amount, $quantity, $pkg, $comment, $classnum, $additional );
6484 my ( $setuptax, $taxclass ); #internal taxes
6485 my ( $taxproduct, $override ); #vendor (CCH) taxes
6486 if ( ref( $_[0] ) ) {
6487 $amount = $_[0]->{amount};
6488 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
6489 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
6490 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
6491 : '$'. sprintf("%.2f",$amount);
6492 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
6493 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
6494 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
6495 $additional = $_[0]->{additional};
6496 $taxproduct = $_[0]->{taxproductnum};
6497 $override = { '' => $_[0]->{tax_override} };
6501 $pkg = @_ ? shift : 'One-time charge';
6502 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
6504 $taxclass = @_ ? shift : '';
6508 local $SIG{HUP} = 'IGNORE';
6509 local $SIG{INT} = 'IGNORE';
6510 local $SIG{QUIT} = 'IGNORE';
6511 local $SIG{TERM} = 'IGNORE';
6512 local $SIG{TSTP} = 'IGNORE';
6513 local $SIG{PIPE} = 'IGNORE';
6515 my $oldAutoCommit = $FS::UID::AutoCommit;
6516 local $FS::UID::AutoCommit = 0;
6519 my $part_pkg = new FS::part_pkg ( {
6521 'comment' => $comment,
6525 'classnum' => $classnum ? $classnum : '',
6526 'setuptax' => $setuptax,
6527 'taxclass' => $taxclass,
6528 'taxproductnum' => $taxproduct,
6531 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
6532 ( 0 .. @$additional - 1 )
6534 'additional_count' => scalar(@$additional),
6535 'setup_fee' => $amount,
6538 my $error = $part_pkg->insert( options => \%options,
6539 tax_overrides => $override,
6542 $dbh->rollback if $oldAutoCommit;
6546 my $pkgpart = $part_pkg->pkgpart;
6547 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
6548 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
6549 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
6550 $error = $type_pkgs->insert;
6552 $dbh->rollback if $oldAutoCommit;
6557 my $cust_pkg = new FS::cust_pkg ( {
6558 'custnum' => $self->custnum,
6559 'pkgpart' => $pkgpart,
6560 'quantity' => $quantity,
6563 $error = $cust_pkg->insert;
6565 $dbh->rollback if $oldAutoCommit;
6569 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6574 #=item charge_postal_fee
6576 #Applies a one time charge this customer. If there is an error,
6577 #returns the error, returns the cust_pkg charge object or false
6578 #if there was no charge.
6582 # This should be a customer event. For that to work requires that bill
6583 # also be a customer event.
6585 sub charge_postal_fee {
6588 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
6589 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
6591 my $cust_pkg = new FS::cust_pkg ( {
6592 'custnum' => $self->custnum,
6593 'pkgpart' => $pkgpart,
6597 my $error = $cust_pkg->insert;
6598 $error ? $error : $cust_pkg;
6603 Returns all the invoices (see L<FS::cust_bill>) for this customer.
6609 sort { $a->_date <=> $b->_date }
6610 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6613 =item open_cust_bill
6615 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
6620 sub open_cust_bill {
6622 grep { $_->owed > 0 } $self->cust_bill;
6627 Returns all the credits (see L<FS::cust_credit>) for this customer.
6633 sort { $a->_date <=> $b->_date }
6634 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
6639 Returns all the payments (see L<FS::cust_pay>) for this customer.
6645 sort { $a->_date <=> $b->_date }
6646 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
6651 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
6657 sort { $a->_date <=> $b->_date }
6658 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
6661 =item cust_pay_batch
6663 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
6667 sub cust_pay_batch {
6669 sort { $a->_date <=> $b->_date }
6670 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
6673 =item cust_pay_pending
6675 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
6676 (without status "done").
6680 sub cust_pay_pending {
6682 return $self->num_cust_pay_pending unless wantarray;
6683 sort { $a->_date <=> $b->_date }
6684 qsearch( 'cust_pay_pending', {
6685 'custnum' => $self->custnum,
6686 'status' => { op=>'!=', value=>'done' },
6691 =item num_cust_pay_pending
6693 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
6694 customer (without status "done"). Also called automatically when the
6695 cust_pay_pending method is used in a scalar context.
6699 sub num_cust_pay_pending {
6701 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
6702 " WHERE custnum = ? AND status != 'done' ";
6703 my $sth = dbh->prepare($sql) or die dbh->errstr;
6704 $sth->execute($self->custnum) or die $sth->errstr;
6705 $sth->fetchrow_arrayref->[0];
6710 Returns all the refunds (see L<FS::cust_refund>) for this customer.
6716 sort { $a->_date <=> $b->_date }
6717 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
6720 =item display_custnum
6722 Returns the displayed customer number for this customer: agent_custid if
6723 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
6727 sub display_custnum {
6729 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
6730 return $self->agent_custid;
6732 return $self->custnum;
6738 Returns a name string for this customer, either "Company (Last, First)" or
6745 my $name = $self->contact;
6746 $name = $self->company. " ($name)" if $self->company;
6752 Returns a name string for this (service/shipping) contact, either
6753 "Company (Last, First)" or "Last, First".
6759 if ( $self->get('ship_last') ) {
6760 my $name = $self->ship_contact;
6761 $name = $self->ship_company. " ($name)" if $self->ship_company;
6770 Returns a name string for this customer, either "Company" or "First Last".
6776 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
6779 =item ship_name_short
6781 Returns a name string for this (service/shipping) contact, either "Company"
6786 sub ship_name_short {
6788 if ( $self->get('ship_last') ) {
6789 $self->ship_company !~ /^\s*$/
6790 ? $self->ship_company
6791 : $self->ship_contact_firstlast;
6793 $self->name_company_or_firstlast;
6799 Returns this customer's full (billing) contact name only, "Last, First"
6805 $self->get('last'). ', '. $self->first;
6810 Returns this customer's full (shipping) contact name only, "Last, First"
6816 $self->get('ship_last')
6817 ? $self->get('ship_last'). ', '. $self->ship_first
6821 =item contact_firstlast
6823 Returns this customers full (billing) contact name only, "First Last".
6827 sub contact_firstlast {
6829 $self->first. ' '. $self->get('last');
6832 =item ship_contact_firstlast
6834 Returns this customer's full (shipping) contact name only, "First Last".
6838 sub ship_contact_firstlast {
6840 $self->get('ship_last')
6841 ? $self->first. ' '. $self->get('ship_last')
6842 : $self->contact_firstlast;
6847 Returns this customer's full country name
6853 code2country($self->country);
6856 =item geocode DATA_VENDOR
6858 Returns a value for the customer location as encoded by DATA_VENDOR.
6859 Currently this only makes sense for "CCH" as DATA_VENDOR.
6864 my ($self, $data_vendor) = (shift, shift); #always cch for now
6866 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
6867 return $geocode if $geocode;
6869 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
6873 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
6874 if $self->country eq 'US';
6876 #CCH specific location stuff
6877 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
6879 my @cust_tax_location =
6881 'table' => 'cust_tax_location',
6882 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
6883 'extra_sql' => $extra_sql,
6884 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
6887 $geocode = $cust_tax_location[0]->geocode
6888 if scalar(@cust_tax_location);
6897 Returns a status string for this customer, currently:
6901 =item prospect - No packages have ever been ordered
6903 =item active - One or more recurring packages is active
6905 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
6907 =item suspended - All non-cancelled recurring packages are suspended
6909 =item cancelled - All recurring packages are cancelled
6915 sub status { shift->cust_status(@_); }
6919 for my $status (qw( prospect active inactive suspended cancelled )) {
6920 my $method = $status.'_sql';
6921 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
6922 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
6923 $sth->execute( ($self->custnum) x $numnum )
6924 or die "Error executing 'SELECT $sql': ". $sth->errstr;
6925 return $status if $sth->fetchrow_arrayref->[0];
6929 =item ucfirst_cust_status
6931 =item ucfirst_status
6933 Returns the status with the first character capitalized.
6937 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
6939 sub ucfirst_cust_status {
6941 ucfirst($self->cust_status);
6946 Returns a hex triplet color string for this customer's status.
6950 use vars qw(%statuscolor);
6951 tie %statuscolor, 'Tie::IxHash',
6952 'prospect' => '7e0079', #'000000', #black? naw, purple
6953 'active' => '00CC00', #green
6954 'inactive' => '0000CC', #blue
6955 'suspended' => 'FF9900', #yellow
6956 'cancelled' => 'FF0000', #red
6959 sub statuscolor { shift->cust_statuscolor(@_); }
6961 sub cust_statuscolor {
6963 $statuscolor{$self->cust_status};
6968 Returns an array of hashes representing the customer's RT tickets.
6975 my $num = $conf->config('cust_main-max_tickets') || 10;
6978 if ( $conf->config('ticket_system') ) {
6979 unless ( $conf->config('ticket_system-custom_priority_field') ) {
6981 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
6985 foreach my $priority (
6986 $conf->config('ticket_system-custom_priority_field-values'), ''
6988 last if scalar(@tickets) >= $num;
6990 @{ FS::TicketSystem->customer_tickets( $self->custnum,
6991 $num - scalar(@tickets),
7001 # Return services representing svc_accts in customer support packages
7002 sub support_services {
7004 my %packages = map { $_ => 1 } $conf->config('support_packages');
7006 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
7007 grep { $_->part_svc->svcdb eq 'svc_acct' }
7008 map { $_->cust_svc }
7009 grep { exists $packages{ $_->pkgpart } }
7010 $self->ncancelled_pkgs;
7016 =head1 CLASS METHODS
7022 Class method that returns the list of possible status strings for customers
7023 (see L<the status method|/status>). For example:
7025 @statuses = FS::cust_main->statuses();
7030 #my $self = shift; #could be class...
7036 Returns an SQL expression identifying prospective cust_main records (customers
7037 with no packages ever ordered)
7041 use vars qw($select_count_pkgs);
7042 $select_count_pkgs =
7043 "SELECT COUNT(*) FROM cust_pkg
7044 WHERE cust_pkg.custnum = cust_main.custnum";
7046 sub select_count_pkgs_sql {
7050 sub prospect_sql { "
7051 0 = ( $select_count_pkgs )
7056 Returns an SQL expression identifying active cust_main records (customers with
7057 active recurring packages).
7062 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
7068 Returns an SQL expression identifying inactive cust_main records (customers with
7069 no active recurring packages, but otherwise unsuspended/uncancelled).
7073 sub inactive_sql { "
7074 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7076 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7082 Returns an SQL expression identifying suspended cust_main records.
7087 sub suspended_sql { susp_sql(@_); }
7089 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
7091 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7097 Returns an SQL expression identifying cancelled cust_main records.
7101 sub cancelled_sql { cancel_sql(@_); }
7104 my $recurring_sql = FS::cust_pkg->recurring_sql;
7105 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
7108 0 < ( $select_count_pkgs )
7109 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
7110 AND 0 = ( $select_count_pkgs AND $recurring_sql
7111 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
7113 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7119 =item uncancelled_sql
7121 Returns an SQL expression identifying un-cancelled cust_main records.
7125 sub uncancelled_sql { uncancel_sql(@_); }
7126 sub uncancel_sql { "
7127 ( 0 < ( $select_count_pkgs
7128 AND ( cust_pkg.cancel IS NULL
7129 OR cust_pkg.cancel = 0
7132 OR 0 = ( $select_count_pkgs )
7138 Returns an SQL fragment to retreive the balance.
7143 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
7144 WHERE cust_bill.custnum = cust_main.custnum )
7145 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
7146 WHERE cust_pay.custnum = cust_main.custnum )
7147 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
7148 WHERE cust_credit.custnum = cust_main.custnum )
7149 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
7150 WHERE cust_refund.custnum = cust_main.custnum )
7153 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7155 Returns an SQL fragment to retreive the balance for this customer, only
7156 considering invoices with date earlier than START_TIME, and optionally not
7157 later than END_TIME (total_owed_date minus total_unapplied_credits minus
7158 total_unapplied_payments).
7160 Times are specified as SQL fragments or numeric
7161 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7162 L<Date::Parse> for conversion functions. The empty string can be passed
7163 to disable that time constraint completely.
7165 Available options are:
7169 =item unapplied_date
7171 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)
7176 set to true to remove all customer comparison clauses, for totals
7181 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
7186 JOIN clause (typically used with the total option)
7192 sub balance_date_sql {
7193 my( $class, $start, $end, %opt ) = @_;
7195 my $owed = FS::cust_bill->owed_sql;
7196 my $unapp_refund = FS::cust_refund->unapplied_sql;
7197 my $unapp_credit = FS::cust_credit->unapplied_sql;
7198 my $unapp_pay = FS::cust_pay->unapplied_sql;
7200 my $j = $opt{'join'} || '';
7202 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
7203 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
7204 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
7205 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
7207 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
7208 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
7209 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
7210 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
7215 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7217 Helper method for balance_date_sql; name (and usage) subject to change
7218 (suggestions welcome).
7220 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
7221 cust_refund, cust_credit or cust_pay).
7223 If TABLE is "cust_bill" or the unapplied_date option is true, only
7224 considers records with date earlier than START_TIME, and optionally not
7225 later than END_TIME .
7229 sub _money_table_where {
7230 my( $class, $table, $start, $end, %opt ) = @_;
7233 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
7234 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
7235 push @where, "$table._date <= $start" if defined($start) && length($start);
7236 push @where, "$table._date > $end" if defined($end) && length($end);
7238 push @where, @{$opt{'where'}} if $opt{'where'};
7239 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
7245 =item search_sql HASHREF
7249 Returns a qsearch hash expression to search for parameters specified in HREF.
7250 Valid parameters are
7258 =item cancelled_pkgs
7264 listref of start date, end date
7270 =item current_balance
7272 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
7276 =item flattened_pkgs
7285 my ($class, $params) = @_;
7296 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
7298 "cust_main.agentnum = $1";
7305 #prospect active inactive suspended cancelled
7306 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
7307 my $method = $params->{'status'}. '_sql';
7308 #push @where, $class->$method();
7309 push @where, FS::cust_main->$method();
7313 # parse cancelled package checkbox
7318 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
7319 unless $params->{'cancelled_pkgs'};
7325 foreach my $field (qw( signupdate )) {
7327 next unless exists($params->{$field});
7329 my($beginning, $ending) = @{$params->{$field}};
7332 "cust_main.$field IS NOT NULL",
7333 "cust_main.$field >= $beginning",
7334 "cust_main.$field <= $ending";
7336 $orderby ||= "ORDER BY cust_main.$field";
7344 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
7346 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
7353 #my $balance_sql = $class->balance_sql();
7354 my $balance_sql = FS::cust_main->balance_sql();
7356 push @where, map { s/current_balance/$balance_sql/; $_ }
7357 @{ $params->{'current_balance'} };
7363 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
7365 "cust_main.custbatch = '$1'";
7369 # setup queries, subs, etc. for the search
7372 $orderby ||= 'ORDER BY custnum';
7374 # here is the agent virtualization
7375 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
7377 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
7379 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
7381 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
7383 my $select = join(', ',
7384 'cust_main.custnum',
7385 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
7388 my(@extra_headers) = ();
7389 my(@extra_fields) = ();
7391 if ($params->{'flattened_pkgs'}) {
7393 if ($dbh->{Driver}->{Name} eq 'Pg') {
7395 $select .= ", array_to_string(array(select pkg from cust_pkg left join part_pkg using ( pkgpart ) where cust_main.custnum = cust_pkg.custnum $pkgwhere),'|') as magic";
7397 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
7398 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
7399 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
7401 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
7402 "omitting packing information from report.";
7405 my $header_query = "SELECT COUNT(cust_pkg.custnum = cust_main.custnum) AS count FROM cust_main $addl_from $extra_sql $pkgwhere group by cust_main.custnum order by count desc limit 1";
7407 my $sth = dbh->prepare($header_query) or die dbh->errstr;
7408 $sth->execute() or die $sth->errstr;
7409 my $headerrow = $sth->fetchrow_arrayref;
7410 my $headercount = $headerrow ? $headerrow->[0] : 0;
7411 while($headercount) {
7412 unshift @extra_headers, "Package ". $headercount;
7413 unshift @extra_fields, eval q!sub {my $c = shift;
7414 my @a = split '\|', $c->magic;
7415 my $p = $a[!.--$headercount. q!];
7423 'table' => 'cust_main',
7424 'select' => $select,
7426 'extra_sql' => $extra_sql,
7427 'order_by' => $orderby,
7428 'count_query' => $count_query,
7429 'extra_headers' => \@extra_headers,
7430 'extra_fields' => \@extra_fields,
7435 =item email_search_sql HASHREF
7439 Emails a notice to the specified customers.
7441 Valid parameters are those of the L<search_sql> method, plus the following:
7463 Optional job queue job for status updates.
7467 Returns an error message, or false for success.
7469 If an error occurs during any email, stops the enture send and returns that
7470 error. Presumably if you're getting SMTP errors aborting is better than
7471 retrying everything.
7475 sub email_search_sql {
7476 my($class, $params) = @_;
7478 my $from = delete $params->{from};
7479 my $subject = delete $params->{subject};
7480 my $html_body = delete $params->{html_body};
7481 my $text_body = delete $params->{text_body};
7483 my $job = delete $params->{'job'};
7485 my $sql_query = $class->search_sql($params);
7487 my $count_query = delete($sql_query->{'count_query'});
7488 my $count_sth = dbh->prepare($count_query)
7489 or die "Error preparing $count_query: ". dbh->errstr;
7491 or die "Error executing $count_query: ". $count_sth->errstr;
7492 my $count_arrayref = $count_sth->fetchrow_arrayref;
7493 my $num_cust = $count_arrayref->[0];
7495 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
7496 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
7499 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
7501 #eventually order+limit magic to reduce memory use?
7502 foreach my $cust_main ( qsearch($sql_query) ) {
7504 my $to = $cust_main->invoicing_list_emailonly_scalar;
7507 my $error = send_email(
7511 'subject' => $subject,
7512 'html_body' => $html_body,
7513 'text_body' => $text_body,
7516 return $error if $error;
7518 if ( $job ) { #progressbar foo
7520 if ( time - $min_sec > $last ) {
7521 my $error = $job->update_statustext(
7522 int( 100 * $num / $num_cust )
7524 die $error if $error;
7534 use Storable qw(thaw);
7537 sub process_email_search_sql {
7539 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
7541 my $param = thaw(decode_base64(shift));
7542 warn Dumper($param) if $DEBUG;
7544 $param->{'job'} = $job;
7546 my $error = FS::cust_main->email_search_sql( $param );
7547 die $error if $error;
7551 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
7553 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
7554 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
7555 appropriate ship_ field is also searched).
7557 Additional options are the same as FS::Record::qsearch
7562 my( $self, $fuzzy, $hash, @opt) = @_;
7567 check_and_rebuild_fuzzyfiles();
7568 foreach my $field ( keys %$fuzzy ) {
7570 my $all = $self->all_X($field);
7571 next unless scalar(@$all);
7574 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
7577 foreach ( keys %match ) {
7578 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
7579 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
7582 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
7585 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
7587 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
7595 Returns a masked version of the named field
7600 my ($self,$field) = @_;
7604 'x'x(length($self->getfield($field))-4).
7605 substr($self->getfield($field), (length($self->getfield($field))-4));
7615 =item smart_search OPTION => VALUE ...
7617 Accepts the following options: I<search>, the string to search for. The string
7618 will be searched for as a customer number, phone number, name or company name,
7619 as an exact, or, in some cases, a substring or fuzzy match (see the source code
7620 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
7621 skip fuzzy matching when an exact match is found.
7623 Any additional options are treated as an additional qualifier on the search
7626 Returns a (possibly empty) array of FS::cust_main objects.
7633 #here is the agent virtualization
7634 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
7638 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
7639 my $search = delete $options{'search'};
7640 ( my $alphanum_search = $search ) =~ s/\W//g;
7642 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
7644 #false laziness w/Record::ut_phone
7645 my $phonen = "$1-$2-$3";
7646 $phonen .= " x$4" if $4;
7648 push @cust_main, qsearch( {
7649 'table' => 'cust_main',
7650 'hashref' => { %options },
7651 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
7653 join(' OR ', map "$_ = '$phonen'",
7654 qw( daytime night fax
7655 ship_daytime ship_night ship_fax )
7658 " AND $agentnums_sql", #agent virtualization
7661 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
7662 #try looking for matches with extensions unless one was specified
7664 push @cust_main, qsearch( {
7665 'table' => 'cust_main',
7666 'hashref' => { %options },
7667 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
7669 join(' OR ', map "$_ LIKE '$phonen\%'",
7671 ship_daytime ship_night )
7674 " AND $agentnums_sql", #agent virtualization
7679 # custnum search (also try agent_custid), with some tweaking options if your
7680 # legacy cust "numbers" have letters
7683 if ( $search =~ /^\s*(\d+)\s*$/
7684 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
7685 && $search =~ /^\s*(\w\w?\d+)\s*$/
7692 if ( $num <= 2147483647 ) { #need a bigint custnum? wow.
7693 push @cust_main, qsearch( {
7694 'table' => 'cust_main',
7695 'hashref' => { 'custnum' => $num, %options },
7696 'extra_sql' => " AND $agentnums_sql", #agent virtualization
7700 push @cust_main, qsearch( {
7701 'table' => 'cust_main',
7702 'hashref' => { 'agent_custid' => $num, %options },
7703 'extra_sql' => " AND $agentnums_sql", #agent virtualization
7706 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
7708 my($company, $last, $first) = ( $1, $2, $3 );
7710 # "Company (Last, First)"
7711 #this is probably something a browser remembered,
7712 #so just do an exact search
7714 foreach my $prefix ( '', 'ship_' ) {
7715 push @cust_main, qsearch( {
7716 'table' => 'cust_main',
7717 'hashref' => { $prefix.'first' => $first,
7718 $prefix.'last' => $last,
7719 $prefix.'company' => $company,
7722 'extra_sql' => " AND $agentnums_sql",
7726 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
7727 # try (ship_){last,company}
7731 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
7732 # # full strings the browser remembers won't work
7733 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
7735 use Lingua::EN::NameParse;
7736 my $NameParse = new Lingua::EN::NameParse(
7738 allow_reversed => 1,
7741 my($last, $first) = ( '', '' );
7742 #maybe disable this too and just rely on NameParse?
7743 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
7745 ($last, $first) = ( $1, $2 );
7747 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
7748 } elsif ( ! $NameParse->parse($value) ) {
7750 my %name = $NameParse->components;
7751 $first = $name{'given_name_1'};
7752 $last = $name{'surname_1'};
7756 if ( $first && $last ) {
7758 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
7761 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
7763 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
7764 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
7767 push @cust_main, qsearch( {
7768 'table' => 'cust_main',
7769 'hashref' => \%options,
7770 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
7773 # or it just be something that was typed in... (try that in a sec)
7777 my $q_value = dbh->quote($value);
7780 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
7781 $sql .= " ( LOWER(last) = $q_value
7782 OR LOWER(company) = $q_value
7783 OR LOWER(ship_last) = $q_value
7784 OR LOWER(ship_company) = $q_value
7787 push @cust_main, qsearch( {
7788 'table' => 'cust_main',
7789 'hashref' => \%options,
7790 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
7793 #no exact match, trying substring/fuzzy
7794 #always do substring & fuzzy (unless they're explicity config'ed off)
7795 #getting complaints searches are not returning enough
7796 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
7798 #still some false laziness w/search_sql (was search/cust_main.cgi)
7803 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
7804 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
7807 if ( $first && $last ) {
7810 { 'first' => { op=>'ILIKE', value=>"%$first%" },
7811 'last' => { op=>'ILIKE', value=>"%$last%" },
7813 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
7814 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
7821 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
7822 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
7826 foreach my $hashref ( @hashrefs ) {
7828 push @cust_main, qsearch( {
7829 'table' => 'cust_main',
7830 'hashref' => { %$hashref,
7833 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
7842 " AND $agentnums_sql", #extra_sql #agent virtualization
7845 if ( $first && $last ) {
7846 push @cust_main, FS::cust_main->fuzzy_search(
7847 { 'last' => $last, #fuzzy hashref
7848 'first' => $first }, #
7852 foreach my $field ( 'last', 'company' ) {
7854 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
7859 #eliminate duplicates
7861 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
7871 Accepts the following options: I<email>, the email address to search for. The
7872 email address will be searched for as an email invoice destination and as an
7875 #Any additional options are treated as an additional qualifier on the search
7876 #(i.e. I<agentnum>).
7878 Returns a (possibly empty) array of FS::cust_main objects (but usually just
7888 my $email = delete $options{'email'};
7890 #we're only being used by RT at the moment... no agent virtualization yet
7891 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
7895 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
7897 my ( $user, $domain ) = ( $1, $2 );
7899 warn "$me smart_search: searching for $user in domain $domain"
7905 'table' => 'cust_main_invoice',
7906 'hashref' => { 'dest' => $email },
7913 map $_->cust_svc->cust_pkg,
7915 'table' => 'svc_acct',
7916 'hashref' => { 'username' => $user, },
7918 'AND ( SELECT domain FROM svc_domain
7919 WHERE svc_acct.domsvc = svc_domain.svcnum
7920 ) = '. dbh->quote($domain),
7926 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
7928 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
7935 =item check_and_rebuild_fuzzyfiles
7939 use vars qw(@fuzzyfields);
7940 @fuzzyfields = ( 'last', 'first', 'company' );
7942 sub check_and_rebuild_fuzzyfiles {
7943 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
7944 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
7947 =item rebuild_fuzzyfiles
7951 sub rebuild_fuzzyfiles {
7953 use Fcntl qw(:flock);
7955 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
7956 mkdir $dir, 0700 unless -d $dir;
7958 foreach my $fuzzy ( @fuzzyfields ) {
7960 open(LOCK,">>$dir/cust_main.$fuzzy")
7961 or die "can't open $dir/cust_main.$fuzzy: $!";
7963 or die "can't lock $dir/cust_main.$fuzzy: $!";
7965 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
7966 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
7968 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
7969 my $sth = dbh->prepare("SELECT $field FROM cust_main".
7970 " WHERE $field != '' AND $field IS NOT NULL");
7971 $sth->execute or die $sth->errstr;
7973 while ( my $row = $sth->fetchrow_arrayref ) {
7974 print CACHE $row->[0]. "\n";
7979 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
7981 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
7992 my( $self, $field ) = @_;
7993 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
7994 open(CACHE,"<$dir/cust_main.$field")
7995 or die "can't open $dir/cust_main.$field: $!";
7996 my @array = map { chomp; $_; } <CACHE>;
8001 =item append_fuzzyfiles LASTNAME COMPANY
8005 sub append_fuzzyfiles {
8006 #my( $first, $last, $company ) = @_;
8008 &check_and_rebuild_fuzzyfiles;
8010 use Fcntl qw(:flock);
8012 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8014 foreach my $field (qw( first last company )) {
8019 open(CACHE,">>$dir/cust_main.$field")
8020 or die "can't open $dir/cust_main.$field: $!";
8021 flock(CACHE,LOCK_EX)
8022 or die "can't lock $dir/cust_main.$field: $!";
8024 print CACHE "$value\n";
8026 flock(CACHE,LOCK_UN)
8027 or die "can't unlock $dir/cust_main.$field: $!";
8042 #warn join('-',keys %$param);
8043 my $fh = $param->{filehandle};
8044 my @fields = @{$param->{fields}};
8046 eval "use Text::CSV_XS;";
8049 my $csv = new Text::CSV_XS;
8056 local $SIG{HUP} = 'IGNORE';
8057 local $SIG{INT} = 'IGNORE';
8058 local $SIG{QUIT} = 'IGNORE';
8059 local $SIG{TERM} = 'IGNORE';
8060 local $SIG{TSTP} = 'IGNORE';
8061 local $SIG{PIPE} = 'IGNORE';
8063 my $oldAutoCommit = $FS::UID::AutoCommit;
8064 local $FS::UID::AutoCommit = 0;
8067 #while ( $columns = $csv->getline($fh) ) {
8069 while ( defined($line=<$fh>) ) {
8071 $csv->parse($line) or do {
8072 $dbh->rollback if $oldAutoCommit;
8073 return "can't parse: ". $csv->error_input();
8076 my @columns = $csv->fields();
8077 #warn join('-',@columns);
8080 foreach my $field ( @fields ) {
8081 $row{$field} = shift @columns;
8084 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
8085 unless ( $cust_main ) {
8086 $dbh->rollback if $oldAutoCommit;
8087 return "unknown custnum $row{'custnum'}";
8090 if ( $row{'amount'} > 0 ) {
8091 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
8093 $dbh->rollback if $oldAutoCommit;
8097 } elsif ( $row{'amount'} < 0 ) {
8098 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
8101 $dbh->rollback if $oldAutoCommit;
8111 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
8113 return "Empty file!" unless $imported;
8119 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8121 Sends a templated email notification to the customer (see L<Text::Template>).
8123 OPTIONS is a hash and may include
8125 I<from> - the email sender (default is invoice_from)
8127 I<to> - comma-separated scalar or arrayref of recipients
8128 (default is invoicing_list)
8130 I<subject> - The subject line of the sent email notification
8131 (default is "Notice from company_name")
8133 I<extra_fields> - a hashref of name/value pairs which will be substituted
8136 The following variables are vavailable in the template.
8138 I<$first> - the customer first name
8139 I<$last> - the customer last name
8140 I<$company> - the customer company
8141 I<$payby> - a description of the method of payment for the customer
8142 # would be nice to use FS::payby::shortname
8143 I<$payinfo> - the account information used to collect for this customer
8144 I<$expdate> - the expiration of the customer payment in seconds from epoch
8149 my ($self, $template, %options) = @_;
8151 return unless $conf->exists($template);
8153 my $from = $conf->config('invoice_from', $self->agentnum)
8154 if $conf->exists('invoice_from', $self->agentnum);
8155 $from = $options{from} if exists($options{from});
8157 my $to = join(',', $self->invoicing_list_emailonly);
8158 $to = $options{to} if exists($options{to});
8160 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
8161 if $conf->exists('company_name', $self->agentnum);
8162 $subject = $options{subject} if exists($options{subject});
8164 my $notify_template = new Text::Template (TYPE => 'ARRAY',
8165 SOURCE => [ map "$_\n",
8166 $conf->config($template)]
8168 or die "can't create new Text::Template object: Text::Template::ERROR";
8169 $notify_template->compile()
8170 or die "can't compile template: Text::Template::ERROR";
8172 $FS::notify_template::_template::company_name =
8173 $conf->config('company_name', $self->agentnum);
8174 $FS::notify_template::_template::company_address =
8175 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
8177 my $paydate = $self->paydate || '2037-12-31';
8178 $FS::notify_template::_template::first = $self->first;
8179 $FS::notify_template::_template::last = $self->last;
8180 $FS::notify_template::_template::company = $self->company;
8181 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
8182 my $payby = $self->payby;
8183 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
8184 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
8186 #credit cards expire at the end of the month/year of their exp date
8187 if ($payby eq 'CARD' || $payby eq 'DCRD') {
8188 $FS::notify_template::_template::payby = 'credit card';
8189 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
8190 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
8192 }elsif ($payby eq 'COMP') {
8193 $FS::notify_template::_template::payby = 'complimentary account';
8195 $FS::notify_template::_template::payby = 'current method';
8197 $FS::notify_template::_template::expdate = $expire_time;
8199 for (keys %{$options{extra_fields}}){
8201 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
8204 send_email(from => $from,
8206 subject => $subject,
8207 body => $notify_template->fill_in( PACKAGE =>
8208 'FS::notify_template::_template' ),
8213 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8215 Generates a templated notification to the customer (see L<Text::Template>).
8217 OPTIONS is a hash and may include
8219 I<extra_fields> - a hashref of name/value pairs which will be substituted
8220 into the template. These values may override values mentioned below
8221 and those from the customer record.
8223 The following variables are available in the template instead of or in addition
8224 to the fields of the customer record.
8226 I<$payby> - a description of the method of payment for the customer
8227 # would be nice to use FS::payby::shortname
8228 I<$payinfo> - the masked account information used to collect for this customer
8229 I<$expdate> - the expiration of the customer payment method in seconds from epoch
8230 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
8234 sub generate_letter {
8235 my ($self, $template, %options) = @_;
8237 return unless $conf->exists($template);
8239 my $letter_template = new Text::Template
8241 SOURCE => [ map "$_\n", $conf->config($template)],
8242 DELIMITERS => [ '[@--', '--@]' ],
8244 or die "can't create new Text::Template object: Text::Template::ERROR";
8246 $letter_template->compile()
8247 or die "can't compile template: Text::Template::ERROR";
8249 my %letter_data = map { $_ => $self->$_ } $self->fields;
8250 $letter_data{payinfo} = $self->mask_payinfo;
8252 #my $paydate = $self->paydate || '2037-12-31';
8253 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
8255 my $payby = $self->payby;
8256 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
8257 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
8259 #credit cards expire at the end of the month/year of their exp date
8260 if ($payby eq 'CARD' || $payby eq 'DCRD') {
8261 $letter_data{payby} = 'credit card';
8262 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
8263 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
8265 }elsif ($payby eq 'COMP') {
8266 $letter_data{payby} = 'complimentary account';
8268 $letter_data{payby} = 'current method';
8270 $letter_data{expdate} = $expire_time;
8272 for (keys %{$options{extra_fields}}){
8273 $letter_data{$_} = $options{extra_fields}->{$_};
8276 unless(exists($letter_data{returnaddress})){
8277 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
8278 $self->agent_template)
8280 if ( length($retadd) ) {
8281 $letter_data{returnaddress} = $retadd;
8282 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
8283 $letter_data{returnaddress} =
8284 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
8285 $conf->config('company_address', $self->agentnum)
8288 $letter_data{returnaddress} = '~';
8292 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
8294 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
8296 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
8297 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
8301 ) or die "can't open temp file: $!\n";
8303 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
8305 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
8309 =item print_ps TEMPLATE
8311 Returns an postscript letter filled in from TEMPLATE, as a scalar.
8317 my $file = $self->generate_letter(@_);
8318 FS::Misc::generate_ps($file);
8321 =item print TEMPLATE
8323 Prints the filled in template.
8325 TEMPLATE is the name of a L<Text::Template> to fill in and print.
8329 sub queueable_print {
8332 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
8333 or die "invalid customer number: " . $opt{custvnum};
8335 my $error = $self->print( $opt{template} );
8336 die $error if $error;
8340 my ($self, $template) = (shift, shift);
8341 do_print [ $self->print_ps($template) ];
8344 #these three subs should just go away once agent stuff is all config overrides
8346 sub agent_template {
8348 $self->_agent_plandata('agent_templatename');
8351 sub agent_invoice_from {
8353 $self->_agent_plandata('agent_invoice_from');
8356 sub _agent_plandata {
8357 my( $self, $option ) = @_;
8359 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
8360 #agent-specific Conf
8362 use FS::part_event::Condition;
8364 my $agentnum = $self->agentnum;
8367 if ( driver_name =~ /^Pg/i ) {
8369 } elsif ( driver_name =~ /^mysql/i ) {
8372 die "don't know how to use regular expressions in ". driver_name. " databases";
8375 my $part_event_option =
8377 'select' => 'part_event_option.*',
8378 'table' => 'part_event_option',
8380 LEFT JOIN part_event USING ( eventpart )
8381 LEFT JOIN part_event_option AS peo_agentnum
8382 ON ( part_event.eventpart = peo_agentnum.eventpart
8383 AND peo_agentnum.optionname = 'agentnum'
8384 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
8386 LEFT JOIN part_event_condition
8387 ON ( part_event.eventpart = part_event_condition.eventpart
8388 AND part_event_condition.conditionname = 'cust_bill_age'
8390 LEFT JOIN part_event_condition_option
8391 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
8392 AND part_event_condition_option.optionname = 'age'
8395 #'hashref' => { 'optionname' => $option },
8396 #'hashref' => { 'part_event_option.optionname' => $option },
8398 " WHERE part_event_option.optionname = ". dbh->quote($option).
8399 " AND action = 'cust_bill_send_agent' ".
8400 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
8401 " AND peo_agentnum.optionname = 'agentnum' ".
8402 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
8404 CASE WHEN part_event_condition_option.optionname IS NULL
8406 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
8408 , part_event.weight".
8412 unless ( $part_event_option ) {
8413 return $self->agent->invoice_template || ''
8414 if $option eq 'agent_templatename';
8418 $part_event_option->optionvalue;
8423 ## actual sub, not a method, designed to be called from the queue.
8424 ## sets up the customer, and calls the bill_and_collect
8425 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
8426 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
8427 $cust_main->bill_and_collect(
8438 The delete method should possibly take an FS::cust_main object reference
8439 instead of a scalar customer number.
8441 Bill and collect options should probably be passed as references instead of a
8444 There should probably be a configuration file with a list of allowed credit
8447 No multiple currency support (probably a larger project than just this module).
8449 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
8451 Birthdates rely on negative epoch values.
8453 The payby for card/check batches is broken. With mixed batching, bad
8456 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
8460 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
8461 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
8462 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.