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 List::Util qw( min );
13 use Time::Local qw(timelocal);
16 use Digest::MD5 qw(md5_base64);
19 use File::Temp qw( tempfile );
20 use String::Approx qw(amatch);
21 use Business::CreditCard 0.28;
23 use FS::UID qw( getotaker dbh driver_name );
24 use FS::Record qw( qsearchs qsearch dbdef );
25 use FS::Misc qw( generate_email send_email generate_ps do_print );
26 use FS::Msgcat qw(gettext);
31 use FS::cust_bill_pkg;
32 use FS::cust_bill_pkg_display;
33 use FS::cust_bill_pkg_tax_location;
34 use FS::cust_bill_pkg_tax_rate_location;
36 use FS::cust_pay_pending;
37 use FS::cust_pay_void;
38 use FS::cust_pay_batch;
41 use FS::part_referral;
42 use FS::cust_main_county;
43 use FS::cust_location;
44 use FS::cust_main_exemption;
45 use FS::cust_tax_adjustment;
47 use FS::tax_rate_location;
48 use FS::cust_tax_location;
49 use FS::part_pkg_taxrate;
51 use FS::cust_main_invoice;
52 use FS::cust_credit_bill;
53 use FS::cust_bill_pay;
54 use FS::prepay_credit;
58 use FS::part_event_condition;
61 use FS::payment_gateway;
62 use FS::agent_payment_gateway;
64 use FS::payinfo_Mixin;
67 @ISA = qw( FS::payinfo_Mixin FS::Record );
69 @EXPORT_OK = qw( smart_search );
71 $realtime_bop_decline_quiet = 0;
73 # 1 is mostly method/subroutine entry and options
74 # 2 traces progress of some operations
75 # 3 is even more information including possibly sensitive data
77 $me = '[FS::cust_main]';
81 $ignore_expired_card = 0;
83 @encrypted_fields = ('payinfo', 'paycvv');
84 sub nohistory_fields { ('paycvv'); }
86 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
88 #ask FS::UID to run this stuff for us later
89 #$FS::UID::callback{'FS::cust_main'} = sub {
90 install_callback FS::UID sub {
92 #yes, need it for stuff below (prolly should be cached)
97 my ( $hashref, $cache ) = @_;
98 if ( exists $hashref->{'pkgnum'} ) {
99 #@{ $self->{'_pkgnum'} } = ();
100 my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
101 $self->{'_pkgnum'} = $subcache;
102 #push @{ $self->{'_pkgnum'} },
103 FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
109 FS::cust_main - Object methods for cust_main records
115 $record = new FS::cust_main \%hash;
116 $record = new FS::cust_main { 'column' => 'value' };
118 $error = $record->insert;
120 $error = $new_record->replace($old_record);
122 $error = $record->delete;
124 $error = $record->check;
126 @cust_pkg = $record->all_pkgs;
128 @cust_pkg = $record->ncancelled_pkgs;
130 @cust_pkg = $record->suspended_pkgs;
132 $error = $record->bill;
133 $error = $record->bill %options;
134 $error = $record->bill 'time' => $time;
136 $error = $record->collect;
137 $error = $record->collect %options;
138 $error = $record->collect 'invoice_time' => $time,
143 An FS::cust_main object represents a customer. FS::cust_main inherits from
144 FS::Record. The following fields are currently supported:
150 Primary key (assigned automatically for new customers)
154 Agent (see L<FS::agent>)
158 Advertising source (see L<FS::part_referral>)
170 Cocial security number (optional)
186 (optional, see L<FS::cust_main_county>)
190 (see L<FS::cust_main_county>)
196 (see L<FS::cust_main_county>)
232 (optional, see L<FS::cust_main_county>)
236 (see L<FS::cust_main_county>)
242 (see L<FS::cust_main_county>)
258 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
262 Payment Information (See L<FS::payinfo_Mixin> for data format)
266 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
270 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
274 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
278 Start date month (maestro/solo cards only)
282 Start date year (maestro/solo cards only)
286 Issue number (maestro/solo cards only)
290 Name on card or billing name
294 IP address from which payment information was received
298 Tax exempt, empty or `Y'
302 Order taker (assigned automatically, see L<FS::UID>)
308 =item referral_custnum
310 Referring customer number
314 Enable individual CDR spooling, empty or `Y'
318 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
322 Discourage individual CDR printing, empty or `Y'
332 Creates a new customer. To add the customer to the database, see L<"insert">.
334 Note that this stores the hash reference, not a distinct copy of the hash it
335 points to. You can ask the object for a copy with the I<hash> method.
339 sub table { 'cust_main'; }
341 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
343 Adds this customer to the database. If there is an error, returns the error,
344 otherwise returns false.
346 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
347 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
348 are inserted atomicly, or the transaction is rolled back. Passing an empty
349 hash reference is equivalent to not supplying this parameter. There should be
350 a better explanation of this, but until then, here's an example:
353 tie %hash, 'Tie::RefHash'; #this part is important
355 $cust_pkg => [ $svc_acct ],
358 $cust_main->insert( \%hash );
360 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
361 be set as the invoicing list (see L<"invoicing_list">). Errors return as
362 expected and rollback the entire transaction; it is not necessary to call
363 check_invoicing_list first. The invoicing_list is set after the records in the
364 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
365 invoicing_list destination to the newly-created svc_acct. Here's an example:
367 $cust_main->insert( {}, [ $email, 'POST' ] );
369 Currently available options are: I<depend_jobnum>, I<noexport> and I<tax_exemption>.
371 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
372 on the supplied jobnum (they will not run until the specific job completes).
373 This can be used to defer provisioning until some action completes (such
374 as running the customer's credit card successfully).
376 The I<noexport> option is deprecated. If I<noexport> is set true, no
377 provisioning jobs (exports) are scheduled. (You can schedule them later with
378 the B<reexport> method.)
380 The I<tax_exemption> option can be set to an arrayref of tax names.
381 FS::cust_main_exemption records will be created and inserted.
387 my $cust_pkgs = @_ ? shift : {};
388 my $invoicing_list = @_ ? shift : '';
390 warn "$me insert called with options ".
391 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
394 local $SIG{HUP} = 'IGNORE';
395 local $SIG{INT} = 'IGNORE';
396 local $SIG{QUIT} = 'IGNORE';
397 local $SIG{TERM} = 'IGNORE';
398 local $SIG{TSTP} = 'IGNORE';
399 local $SIG{PIPE} = 'IGNORE';
401 my $oldAutoCommit = $FS::UID::AutoCommit;
402 local $FS::UID::AutoCommit = 0;
405 my $prepay_identifier = '';
406 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
408 if ( $self->payby eq 'PREPAY' ) {
410 $self->payby('BILL');
411 $prepay_identifier = $self->payinfo;
414 warn " looking up prepaid card $prepay_identifier\n"
417 my $error = $self->get_prepay( $prepay_identifier,
418 'amount_ref' => \$amount,
419 'seconds_ref' => \$seconds,
420 'upbytes_ref' => \$upbytes,
421 'downbytes_ref' => \$downbytes,
422 'totalbytes_ref' => \$totalbytes,
425 $dbh->rollback if $oldAutoCommit;
426 #return "error applying prepaid card (transaction rolled back): $error";
430 $payby = 'PREP' if $amount;
432 } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
435 $self->payby('BILL');
436 $amount = $self->paid;
440 warn " inserting $self\n"
443 $self->signupdate(time) unless $self->signupdate;
445 $self->auto_agent_custid()
446 if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
448 my $error = $self->SUPER::insert;
450 $dbh->rollback if $oldAutoCommit;
451 #return "inserting cust_main record (transaction rolled back): $error";
455 warn " setting invoicing list\n"
458 if ( $invoicing_list ) {
459 $error = $self->check_invoicing_list( $invoicing_list );
461 $dbh->rollback if $oldAutoCommit;
462 #return "checking invoicing_list (transaction rolled back): $error";
465 $self->invoicing_list( $invoicing_list );
468 warn " setting cust_main_exemption\n"
471 my $tax_exemption = delete $options{'tax_exemption'};
472 if ( $tax_exemption ) {
473 foreach my $taxname ( @$tax_exemption ) {
474 my $cust_main_exemption = new FS::cust_main_exemption {
475 'custnum' => $self->custnum,
476 'taxname' => $taxname,
478 my $error = $cust_main_exemption->insert;
480 $dbh->rollback if $oldAutoCommit;
481 return "inserting cust_main_exemption (transaction rolled back): $error";
486 if ( $conf->config('cust_main-skeleton_tables')
487 && $conf->config('cust_main-skeleton_custnum') ) {
489 warn " inserting skeleton records\n"
492 my $error = $self->start_copy_skel;
494 $dbh->rollback if $oldAutoCommit;
500 warn " ordering packages\n"
503 $error = $self->order_pkgs( $cust_pkgs,
505 'seconds_ref' => \$seconds,
506 'upbytes_ref' => \$upbytes,
507 'downbytes_ref' => \$downbytes,
508 'totalbytes_ref' => \$totalbytes,
511 $dbh->rollback if $oldAutoCommit;
516 $dbh->rollback if $oldAutoCommit;
517 return "No svc_acct record to apply pre-paid time";
519 if ( $upbytes || $downbytes || $totalbytes ) {
520 $dbh->rollback if $oldAutoCommit;
521 return "No svc_acct record to apply pre-paid data";
525 warn " inserting initial $payby payment of $amount\n"
527 $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
529 $dbh->rollback if $oldAutoCommit;
530 return "inserting payment (transaction rolled back): $error";
534 unless ( $import || $skip_fuzzyfiles ) {
535 warn " queueing fuzzyfiles update\n"
537 $error = $self->queue_fuzzyfiles_update;
539 $dbh->rollback if $oldAutoCommit;
540 return "updating fuzzy search cache: $error";
544 warn " insert complete; committing transaction\n"
547 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
552 use File::CounterFile;
553 sub auto_agent_custid {
556 my $format = $conf->config('cust_main-auto_agent_custid');
558 if ( $format eq '1YMMXXXXXXXX' ) {
560 my $counter = new File::CounterFile 'cust_main.agent_custid';
563 my $ym = 100000000000 + time2str('%y%m00000000', time);
564 if ( $ym > $counter->value ) {
565 $counter->{'value'} = $agent_custid = $ym;
566 $counter->{'updated'} = 1;
568 $agent_custid = $counter->inc;
574 die "Unknown cust_main-auto_agent_custid format: $format";
577 $self->agent_custid($agent_custid);
581 sub start_copy_skel {
584 #'mg_user_preference' => {},
585 #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
586 #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
587 #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
588 #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
589 my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
592 _copy_skel( 'cust_main', #tablename
593 $conf->config('cust_main-skeleton_custnum'), #sourceid
594 $self->custnum, #destid
595 @tables, #child tables
599 #recursive subroutine, not a method
601 my( $table, $sourceid, $destid, %child_tables ) = @_;
604 if ( $table =~ /^(\w+)\.(\w+)$/ ) {
605 ( $table, $primary_key ) = ( $1, $2 );
607 my $dbdef_table = dbdef->table($table);
608 $primary_key = $dbdef_table->primary_key
609 or return "$table has no primary key".
610 " (or do you need to run dbdef-create?)";
613 warn " _copy_skel: $table.$primary_key $sourceid to $destid for ".
614 join (', ', keys %child_tables). "\n"
617 foreach my $child_table_def ( keys %child_tables ) {
621 if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
622 ( $child_table, $child_pkey ) = ( $1, $2 );
624 $child_table = $child_table_def;
626 $child_pkey = dbdef->table($child_table)->primary_key;
627 # or return "$table has no primary key".
628 # " (or do you need to run dbdef-create?)\n";
632 if ( keys %{ $child_tables{$child_table_def} } ) {
634 return "$child_table has no primary key".
635 " (run dbdef-create or try specifying it?)\n"
638 #false laziness w/Record::insert and only works on Pg
639 #refactor the proper last-inserted-id stuff out of Record::insert if this
640 # ever gets use for anything besides a quick kludge for one customer
641 my $default = dbdef->table($child_table)->column($child_pkey)->default;
642 $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
643 or return "can't parse $child_table.$child_pkey default value ".
644 " for sequence name: $default";
649 my @sel_columns = grep { $_ ne $primary_key }
650 dbdef->table($child_table)->columns;
651 my $sel_columns = join(', ', @sel_columns );
653 my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
654 my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
655 my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
657 my $sel_st = "SELECT $sel_columns FROM $child_table".
658 " WHERE $primary_key = $sourceid";
661 my $sel_sth = dbh->prepare( $sel_st )
662 or return dbh->errstr;
664 $sel_sth->execute or return $sel_sth->errstr;
666 while ( my $row = $sel_sth->fetchrow_hashref ) {
668 warn " selected row: ".
669 join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
673 "INSERT INTO $child_table $ins_columns VALUES $placeholders";
674 my $ins_sth =dbh->prepare($statement)
675 or return dbh->errstr;
676 my @param = ( $destid, map $row->{$_}, @ins_columns );
677 warn " $statement: [ ". join(', ', @param). " ]\n"
679 $ins_sth->execute( @param )
680 or return $ins_sth->errstr;
682 #next unless keys %{ $child_tables{$child_table} };
683 next unless $sequence;
685 #another section of that laziness
686 my $seq_sql = "SELECT currval('$sequence')";
687 my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
688 $seq_sth->execute or return $seq_sth->errstr;
689 my $insertid = $seq_sth->fetchrow_arrayref->[0];
691 # don't drink soap! recurse! recurse! okay!
693 _copy_skel( $child_table_def,
694 $row->{$child_pkey}, #sourceid
696 %{ $child_tables{$child_table_def} },
698 return $error if $error;
708 =item order_pkg HASHREF | OPTION => VALUE ...
710 Orders a single package.
712 Options may be passed as a list of key/value pairs or as a hash reference.
723 Optional FS::cust_location object
727 Optional arryaref of FS::svc_* service objects.
731 If this option is set to a job queue jobnum (see L<FS::queue>), all provisioning
732 jobs will have a dependancy on the supplied job (they will not run until the
733 specific job completes). This can be used to defer provisioning until some
734 action completes (such as running the customer's credit card successfully).
738 Optional subject for a ticket created and attached to this customer
742 Optional queue name for ticket additions
750 my $opt = ref($_[0]) ? shift : { @_ };
752 warn "$me order_pkg called with options ".
753 join(', ', map { "$_: $opt->{$_}" } keys %$opt ). "\n"
756 my $cust_pkg = $opt->{'cust_pkg'};
757 my $svcs = $opt->{'svcs'} || [];
759 my %svc_options = ();
760 $svc_options{'depend_jobnum'} = $opt->{'depend_jobnum'}
761 if exists($opt->{'depend_jobnum'}) && $opt->{'depend_jobnum'};
763 my %insert_params = map { $opt->{$_} ? ( $_ => $opt->{$_} ) : () }
764 qw( ticket_subject ticket_queue );
766 local $SIG{HUP} = 'IGNORE';
767 local $SIG{INT} = 'IGNORE';
768 local $SIG{QUIT} = 'IGNORE';
769 local $SIG{TERM} = 'IGNORE';
770 local $SIG{TSTP} = 'IGNORE';
771 local $SIG{PIPE} = 'IGNORE';
773 my $oldAutoCommit = $FS::UID::AutoCommit;
774 local $FS::UID::AutoCommit = 0;
777 if ( $opt->{'cust_location'} &&
778 ( ! $cust_pkg->locationnum || $cust_pkg->locationnum == -1 ) ) {
779 my $error = $opt->{'cust_location'}->insert;
781 $dbh->rollback if $oldAutoCommit;
782 return "inserting cust_location (transaction rolled back): $error";
784 $cust_pkg->locationnum($opt->{'cust_location'}->locationnum);
787 $cust_pkg->custnum( $self->custnum );
789 my $error = $cust_pkg->insert( %insert_params );
791 $dbh->rollback if $oldAutoCommit;
792 return "inserting cust_pkg (transaction rolled back): $error";
795 foreach my $svc_something ( @{ $opt->{'svcs'} } ) {
796 if ( $svc_something->svcnum ) {
797 my $old_cust_svc = $svc_something->cust_svc;
798 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
799 $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
800 $error = $new_cust_svc->replace($old_cust_svc);
802 $svc_something->pkgnum( $cust_pkg->pkgnum );
803 if ( $svc_something->isa('FS::svc_acct') ) {
804 foreach ( grep { $opt->{$_.'_ref'} && ${ $opt->{$_.'_ref'} } }
805 qw( seconds upbytes downbytes totalbytes ) ) {
806 $svc_something->$_( $svc_something->$_() + ${ $opt->{$_.'_ref'} } );
807 ${ $opt->{$_.'_ref'} } = 0;
810 $error = $svc_something->insert(%svc_options);
813 $dbh->rollback if $oldAutoCommit;
814 return "inserting svc_ (transaction rolled back): $error";
818 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
823 #deprecated #=item order_pkgs HASHREF [ , SECONDSREF ] [ , OPTION => VALUE ... ]
824 =item order_pkgs HASHREF [ , OPTION => VALUE ... ]
826 Like the insert method on an existing record, this method orders multiple
827 packages and included services atomicaly. Pass a Tie::RefHash data structure
828 to this method containing FS::cust_pkg and FS::svc_I<tablename> objects.
829 There should be a better explanation of this, but until then, here's an
833 tie %hash, 'Tie::RefHash'; #this part is important
835 $cust_pkg => [ $svc_acct ],
838 $cust_main->order_pkgs( \%hash, 'noexport'=>1 );
840 Services can be new, in which case they are inserted, or existing unaudited
841 services, in which case they are linked to the newly-created package.
843 Currently available options are: I<depend_jobnum>, I<noexport>, I<seconds_ref>,
844 I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>.
846 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
847 on the supplied jobnum (they will not run until the specific job completes).
848 This can be used to defer provisioning until some action completes (such
849 as running the customer's credit card successfully).
851 The I<noexport> option is deprecated. If I<noexport> is set true, no
852 provisioning jobs (exports) are scheduled. (You can schedule them later with
853 the B<reexport> method for each cust_pkg object. Using the B<reexport> method
854 on the cust_main object is not recommended, as existing services will also be
857 If I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, or I<totalbytes_ref> is
858 provided, the scalars (provided by references) will be incremented by the
859 values of the prepaid card.`
865 my $cust_pkgs = shift;
866 my $seconds_ref = ref($_[0]) ? shift : ''; #deprecated
868 $seconds_ref ||= $options{'seconds_ref'};
870 warn "$me order_pkgs called with options ".
871 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
874 local $SIG{HUP} = 'IGNORE';
875 local $SIG{INT} = 'IGNORE';
876 local $SIG{QUIT} = 'IGNORE';
877 local $SIG{TERM} = 'IGNORE';
878 local $SIG{TSTP} = 'IGNORE';
879 local $SIG{PIPE} = 'IGNORE';
881 my $oldAutoCommit = $FS::UID::AutoCommit;
882 local $FS::UID::AutoCommit = 0;
885 local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
887 foreach my $cust_pkg ( keys %$cust_pkgs ) {
889 my $error = $self->order_pkg(
890 'cust_pkg' => $cust_pkg,
891 'svcs' => $cust_pkgs->{$cust_pkg},
892 'seconds_ref' => $seconds_ref,
893 map { $_ => $options{$_} } qw( upbytes_ref downbytes_ref totalbytes_ref
898 $dbh->rollback if $oldAutoCommit;
904 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
908 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
910 Recharges this (existing) customer with the specified prepaid card (see
911 L<FS::prepay_credit>), specified either by I<identifier> or as an
912 FS::prepay_credit object. If there is an error, returns the error, otherwise
915 Optionally, five scalar references can be passed as well. They will have their
916 values filled in with the amount, number of seconds, and number of upload,
917 download, and total bytes applied by this prepaid card.
921 #the ref bullshit here should be refactored like get_prepay. MyAccount.pm is
922 #the only place that uses these args
923 sub recharge_prepay {
924 my( $self, $prepay_credit, $amountref, $secondsref,
925 $upbytesref, $downbytesref, $totalbytesref ) = @_;
927 local $SIG{HUP} = 'IGNORE';
928 local $SIG{INT} = 'IGNORE';
929 local $SIG{QUIT} = 'IGNORE';
930 local $SIG{TERM} = 'IGNORE';
931 local $SIG{TSTP} = 'IGNORE';
932 local $SIG{PIPE} = 'IGNORE';
934 my $oldAutoCommit = $FS::UID::AutoCommit;
935 local $FS::UID::AutoCommit = 0;
938 my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
940 my $error = $self->get_prepay( $prepay_credit,
941 'amount_ref' => \$amount,
942 'seconds_ref' => \$seconds,
943 'upbytes_ref' => \$upbytes,
944 'downbytes_ref' => \$downbytes,
945 'totalbytes_ref' => \$totalbytes,
947 || $self->increment_seconds($seconds)
948 || $self->increment_upbytes($upbytes)
949 || $self->increment_downbytes($downbytes)
950 || $self->increment_totalbytes($totalbytes)
951 || $self->insert_cust_pay_prepay( $amount,
953 ? $prepay_credit->identifier
958 $dbh->rollback if $oldAutoCommit;
962 if ( defined($amountref) ) { $$amountref = $amount; }
963 if ( defined($secondsref) ) { $$secondsref = $seconds; }
964 if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
965 if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
966 if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
968 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
973 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
975 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
976 specified either by I<identifier> or as an FS::prepay_credit object.
978 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
979 incremented by the values of the prepaid card.
981 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
982 check or set this customer's I<agentnum>.
984 If there is an error, returns the error, otherwise returns false.
990 my( $self, $prepay_credit, %opt ) = @_;
992 local $SIG{HUP} = 'IGNORE';
993 local $SIG{INT} = 'IGNORE';
994 local $SIG{QUIT} = 'IGNORE';
995 local $SIG{TERM} = 'IGNORE';
996 local $SIG{TSTP} = 'IGNORE';
997 local $SIG{PIPE} = 'IGNORE';
999 my $oldAutoCommit = $FS::UID::AutoCommit;
1000 local $FS::UID::AutoCommit = 0;
1003 unless ( ref($prepay_credit) ) {
1005 my $identifier = $prepay_credit;
1007 $prepay_credit = qsearchs(
1009 { 'identifier' => $prepay_credit },
1014 unless ( $prepay_credit ) {
1015 $dbh->rollback if $oldAutoCommit;
1016 return "Invalid prepaid card: ". $identifier;
1021 if ( $prepay_credit->agentnum ) {
1022 if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
1023 $dbh->rollback if $oldAutoCommit;
1024 return "prepaid card not valid for agent ". $self->agentnum;
1026 $self->agentnum($prepay_credit->agentnum);
1029 my $error = $prepay_credit->delete;
1031 $dbh->rollback if $oldAutoCommit;
1032 return "removing prepay_credit (transaction rolled back): $error";
1035 ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
1036 for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
1038 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1043 =item increment_upbytes SECONDS
1045 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1046 the specified number of upbytes. If there is an error, returns the error,
1047 otherwise returns false.
1051 sub increment_upbytes {
1052 _increment_column( shift, 'upbytes', @_);
1055 =item increment_downbytes SECONDS
1057 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1058 the specified number of downbytes. If there is an error, returns the error,
1059 otherwise returns false.
1063 sub increment_downbytes {
1064 _increment_column( shift, 'downbytes', @_);
1067 =item increment_totalbytes SECONDS
1069 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1070 the specified number of totalbytes. If there is an error, returns the error,
1071 otherwise returns false.
1075 sub increment_totalbytes {
1076 _increment_column( shift, 'totalbytes', @_);
1079 =item increment_seconds SECONDS
1081 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1082 the specified number of seconds. If there is an error, returns the error,
1083 otherwise returns false.
1087 sub increment_seconds {
1088 _increment_column( shift, 'seconds', @_);
1091 =item _increment_column AMOUNT
1093 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1094 the specified number of seconds or bytes. If there is an error, returns
1095 the error, otherwise returns false.
1099 sub _increment_column {
1100 my( $self, $column, $amount ) = @_;
1101 warn "$me increment_column called: $column, $amount\n"
1104 return '' unless $amount;
1106 my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1107 $self->ncancelled_pkgs;
1109 if ( ! @cust_pkg ) {
1110 return 'No packages with primary or single services found'.
1111 ' to apply pre-paid time';
1112 } elsif ( scalar(@cust_pkg) > 1 ) {
1113 #maybe have a way to specify the package/account?
1114 return 'Multiple packages found to apply pre-paid time';
1117 my $cust_pkg = $cust_pkg[0];
1118 warn " found package pkgnum ". $cust_pkg->pkgnum. "\n"
1122 $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1124 if ( ! @cust_svc ) {
1125 return 'No account found to apply pre-paid time';
1126 } elsif ( scalar(@cust_svc) > 1 ) {
1127 return 'Multiple accounts found to apply pre-paid time';
1130 my $svc_acct = $cust_svc[0]->svc_x;
1131 warn " found service svcnum ". $svc_acct->pkgnum.
1132 ' ('. $svc_acct->email. ")\n"
1135 $column = "increment_$column";
1136 $svc_acct->$column($amount);
1140 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1142 Inserts a prepayment in the specified amount for this customer. An optional
1143 second argument can specify the prepayment identifier for tracking purposes.
1144 If there is an error, returns the error, otherwise returns false.
1148 sub insert_cust_pay_prepay {
1149 shift->insert_cust_pay('PREP', @_);
1152 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1154 Inserts a cash payment in the specified amount for this customer. An optional
1155 second argument can specify the payment identifier for tracking purposes.
1156 If there is an error, returns the error, otherwise returns false.
1160 sub insert_cust_pay_cash {
1161 shift->insert_cust_pay('CASH', @_);
1164 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1166 Inserts a Western Union payment in the specified amount for this customer. An
1167 optional second argument can specify the prepayment identifier for tracking
1168 purposes. If there is an error, returns the error, otherwise returns false.
1172 sub insert_cust_pay_west {
1173 shift->insert_cust_pay('WEST', @_);
1176 sub insert_cust_pay {
1177 my( $self, $payby, $amount ) = splice(@_, 0, 3);
1178 my $payinfo = scalar(@_) ? shift : '';
1180 my $cust_pay = new FS::cust_pay {
1181 'custnum' => $self->custnum,
1182 'paid' => sprintf('%.2f', $amount),
1183 #'_date' => #date the prepaid card was purchased???
1185 'payinfo' => $payinfo,
1193 This method is deprecated. See the I<depend_jobnum> option to the insert and
1194 order_pkgs methods for a better way to defer provisioning.
1196 Re-schedules all exports by calling the B<reexport> method of all associated
1197 packages (see L<FS::cust_pkg>). If there is an error, returns the error;
1198 otherwise returns false.
1205 carp "WARNING: FS::cust_main::reexport is deprectated; ".
1206 "use the depend_jobnum option to insert or order_pkgs to delay export";
1208 local $SIG{HUP} = 'IGNORE';
1209 local $SIG{INT} = 'IGNORE';
1210 local $SIG{QUIT} = 'IGNORE';
1211 local $SIG{TERM} = 'IGNORE';
1212 local $SIG{TSTP} = 'IGNORE';
1213 local $SIG{PIPE} = 'IGNORE';
1215 my $oldAutoCommit = $FS::UID::AutoCommit;
1216 local $FS::UID::AutoCommit = 0;
1219 foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1220 my $error = $cust_pkg->reexport;
1222 $dbh->rollback if $oldAutoCommit;
1227 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1232 =item delete NEW_CUSTNUM
1234 This deletes the customer. If there is an error, returns the error, otherwise
1237 This will completely remove all traces of the customer record. This is not
1238 what you want when a customer cancels service; for that, cancel all of the
1239 customer's packages (see L</cancel>).
1241 If the customer has any uncancelled packages, you need to pass a new (valid)
1242 customer number for those packages to be transferred to. Cancelled packages
1243 will be deleted. Did I mention that this is NOT what you want when a customer
1244 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
1246 You can't delete a customer with invoices (see L<FS::cust_bill>),
1247 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
1248 refunds (see L<FS::cust_refund>).
1255 local $SIG{HUP} = 'IGNORE';
1256 local $SIG{INT} = 'IGNORE';
1257 local $SIG{QUIT} = 'IGNORE';
1258 local $SIG{TERM} = 'IGNORE';
1259 local $SIG{TSTP} = 'IGNORE';
1260 local $SIG{PIPE} = 'IGNORE';
1262 my $oldAutoCommit = $FS::UID::AutoCommit;
1263 local $FS::UID::AutoCommit = 0;
1266 if ( $self->cust_bill ) {
1267 $dbh->rollback if $oldAutoCommit;
1268 return "Can't delete a customer with invoices";
1270 if ( $self->cust_credit ) {
1271 $dbh->rollback if $oldAutoCommit;
1272 return "Can't delete a customer with credits";
1274 if ( $self->cust_pay ) {
1275 $dbh->rollback if $oldAutoCommit;
1276 return "Can't delete a customer with payments";
1278 if ( $self->cust_refund ) {
1279 $dbh->rollback if $oldAutoCommit;
1280 return "Can't delete a customer with refunds";
1283 my @cust_pkg = $self->ncancelled_pkgs;
1285 my $new_custnum = shift;
1286 unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1287 $dbh->rollback if $oldAutoCommit;
1288 return "Invalid new customer number: $new_custnum";
1290 foreach my $cust_pkg ( @cust_pkg ) {
1291 my %hash = $cust_pkg->hash;
1292 $hash{'custnum'} = $new_custnum;
1293 my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1294 my $error = $new_cust_pkg->replace($cust_pkg,
1295 options => { $cust_pkg->options },
1298 $dbh->rollback if $oldAutoCommit;
1303 my @cancelled_cust_pkg = $self->all_pkgs;
1304 foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1305 my $error = $cust_pkg->delete;
1307 $dbh->rollback if $oldAutoCommit;
1312 foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1313 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1315 my $error = $cust_main_invoice->delete;
1317 $dbh->rollback if $oldAutoCommit;
1322 foreach my $cust_main_exemption (
1323 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } )
1325 my $error = $cust_main_exemption->delete;
1327 $dbh->rollback if $oldAutoCommit;
1332 my $error = $self->SUPER::delete;
1334 $dbh->rollback if $oldAutoCommit;
1338 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1343 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1346 Replaces the OLD_RECORD with this one in the database. If there is an error,
1347 returns the error, otherwise returns false.
1349 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1350 be set as the invoicing list (see L<"invoicing_list">). Errors return as
1351 expected and rollback the entire transaction; it is not necessary to call
1352 check_invoicing_list first. Here's an example:
1354 $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1356 Currently available options are: I<tax_exemption>.
1358 The I<tax_exemption> option can be set to an arrayref of tax names.
1359 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1366 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1368 : $self->replace_old;
1372 warn "$me replace called\n"
1375 my $curuser = $FS::CurrentUser::CurrentUser;
1376 if ( $self->payby eq 'COMP'
1377 && $self->payby ne $old->payby
1378 && ! $curuser->access_right('Complimentary customer')
1381 return "You are not permitted to create complimentary accounts.";
1384 local($ignore_expired_card) = 1
1385 if $old->payby =~ /^(CARD|DCRD)$/
1386 && $self->payby =~ /^(CARD|DCRD)$/
1387 && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1389 local $SIG{HUP} = 'IGNORE';
1390 local $SIG{INT} = 'IGNORE';
1391 local $SIG{QUIT} = 'IGNORE';
1392 local $SIG{TERM} = 'IGNORE';
1393 local $SIG{TSTP} = 'IGNORE';
1394 local $SIG{PIPE} = 'IGNORE';
1396 my $oldAutoCommit = $FS::UID::AutoCommit;
1397 local $FS::UID::AutoCommit = 0;
1400 my $error = $self->SUPER::replace($old);
1403 $dbh->rollback if $oldAutoCommit;
1407 if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1408 my $invoicing_list = shift @param;
1409 $error = $self->check_invoicing_list( $invoicing_list );
1411 $dbh->rollback if $oldAutoCommit;
1414 $self->invoicing_list( $invoicing_list );
1417 my %options = @param;
1419 my $tax_exemption = delete $options{'tax_exemption'};
1420 if ( $tax_exemption ) {
1422 my %cust_main_exemption =
1423 map { $_->taxname => $_ }
1424 qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1426 foreach my $taxname ( @$tax_exemption ) {
1428 next if delete $cust_main_exemption{$taxname};
1430 my $cust_main_exemption = new FS::cust_main_exemption {
1431 'custnum' => $self->custnum,
1432 'taxname' => $taxname,
1434 my $error = $cust_main_exemption->insert;
1436 $dbh->rollback if $oldAutoCommit;
1437 return "inserting cust_main_exemption (transaction rolled back): $error";
1441 foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1442 my $error = $cust_main_exemption->delete;
1444 $dbh->rollback if $oldAutoCommit;
1445 return "deleting cust_main_exemption (transaction rolled back): $error";
1451 if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1452 grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1453 # card/check/lec info has changed, want to retry realtime_ invoice events
1454 my $error = $self->retry_realtime;
1456 $dbh->rollback if $oldAutoCommit;
1461 unless ( $import || $skip_fuzzyfiles ) {
1462 $error = $self->queue_fuzzyfiles_update;
1464 $dbh->rollback if $oldAutoCommit;
1465 return "updating fuzzy search cache: $error";
1469 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1474 =item queue_fuzzyfiles_update
1476 Used by insert & replace to update the fuzzy search cache
1480 sub queue_fuzzyfiles_update {
1483 local $SIG{HUP} = 'IGNORE';
1484 local $SIG{INT} = 'IGNORE';
1485 local $SIG{QUIT} = 'IGNORE';
1486 local $SIG{TERM} = 'IGNORE';
1487 local $SIG{TSTP} = 'IGNORE';
1488 local $SIG{PIPE} = 'IGNORE';
1490 my $oldAutoCommit = $FS::UID::AutoCommit;
1491 local $FS::UID::AutoCommit = 0;
1494 my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1495 my $error = $queue->insert( map $self->getfield($_),
1496 qw(first last company)
1499 $dbh->rollback if $oldAutoCommit;
1500 return "queueing job (transaction rolled back): $error";
1503 if ( $self->ship_last ) {
1504 $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1505 $error = $queue->insert( map $self->getfield("ship_$_"),
1506 qw(first last company)
1509 $dbh->rollback if $oldAutoCommit;
1510 return "queueing job (transaction rolled back): $error";
1514 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1521 Checks all fields to make sure this is a valid customer record. If there is
1522 an error, returns the error, otherwise returns false. Called by the insert
1523 and replace methods.
1530 warn "$me check BEFORE: \n". $self->_dump
1534 $self->ut_numbern('custnum')
1535 || $self->ut_number('agentnum')
1536 || $self->ut_textn('agent_custid')
1537 || $self->ut_number('refnum')
1538 || $self->ut_textn('custbatch')
1539 || $self->ut_name('last')
1540 || $self->ut_name('first')
1541 || $self->ut_snumbern('birthdate')
1542 || $self->ut_snumbern('signupdate')
1543 || $self->ut_textn('company')
1544 || $self->ut_text('address1')
1545 || $self->ut_textn('address2')
1546 || $self->ut_text('city')
1547 || $self->ut_textn('county')
1548 || $self->ut_textn('state')
1549 || $self->ut_country('country')
1550 || $self->ut_anything('comments')
1551 || $self->ut_numbern('referral_custnum')
1552 || $self->ut_textn('stateid')
1553 || $self->ut_textn('stateid_state')
1554 || $self->ut_textn('invoice_terms')
1555 || $self->ut_alphan('geocode')
1556 || $self->ut_floatn('cdr_termination_percentage')
1559 #barf. need message catalogs. i18n. etc.
1560 $error .= "Please select an advertising source."
1561 if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1562 return $error if $error;
1564 return "Unknown agent"
1565 unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1567 return "Unknown refnum"
1568 unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1570 return "Unknown referring custnum: ". $self->referral_custnum
1571 unless ! $self->referral_custnum
1572 || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1574 if ( $self->censustract ne '' ) {
1575 $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1576 or return "Illegal census tract: ". $self->censustract;
1578 $self->censustract("$1.$2");
1581 if ( $self->ss eq '' ) {
1586 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1587 or return "Illegal social security number: ". $self->ss;
1588 $self->ss("$1-$2-$3");
1592 # bad idea to disable, causes billing to fail because of no tax rates later
1593 # unless ( $import ) {
1594 unless ( qsearch('cust_main_county', {
1595 'country' => $self->country,
1598 return "Unknown state/county/country: ".
1599 $self->state. "/". $self->county. "/". $self->country
1600 unless qsearch('cust_main_county',{
1601 'state' => $self->state,
1602 'county' => $self->county,
1603 'country' => $self->country,
1609 $self->ut_phonen('daytime', $self->country)
1610 || $self->ut_phonen('night', $self->country)
1611 || $self->ut_phonen('fax', $self->country)
1612 || $self->ut_zip('zip', $self->country)
1614 return $error if $error;
1616 if ( $conf->exists('cust_main-require_phone')
1617 && ! length($self->daytime) && ! length($self->night)
1620 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1622 : FS::Msgcat::_gettext('daytime');
1623 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1625 : FS::Msgcat::_gettext('night');
1627 return "$daytime_label or $night_label is required"
1631 if ( $self->has_ship_address
1632 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1633 $self->addr_fields )
1637 $self->ut_name('ship_last')
1638 || $self->ut_name('ship_first')
1639 || $self->ut_textn('ship_company')
1640 || $self->ut_text('ship_address1')
1641 || $self->ut_textn('ship_address2')
1642 || $self->ut_text('ship_city')
1643 || $self->ut_textn('ship_county')
1644 || $self->ut_textn('ship_state')
1645 || $self->ut_country('ship_country')
1647 return $error if $error;
1649 #false laziness with above
1650 unless ( qsearchs('cust_main_county', {
1651 'country' => $self->ship_country,
1654 return "Unknown ship_state/ship_county/ship_country: ".
1655 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1656 unless qsearch('cust_main_county',{
1657 'state' => $self->ship_state,
1658 'county' => $self->ship_county,
1659 'country' => $self->ship_country,
1665 $self->ut_phonen('ship_daytime', $self->ship_country)
1666 || $self->ut_phonen('ship_night', $self->ship_country)
1667 || $self->ut_phonen('ship_fax', $self->ship_country)
1668 || $self->ut_zip('ship_zip', $self->ship_country)
1670 return $error if $error;
1672 return "Unit # is required."
1673 if $self->ship_address2 =~ /^\s*$/
1674 && $conf->exists('cust_main-require_address2');
1676 } else { # ship_ info eq billing info, so don't store dup info in database
1678 $self->setfield("ship_$_", '')
1679 foreach $self->addr_fields;
1681 return "Unit # is required."
1682 if $self->address2 =~ /^\s*$/
1683 && $conf->exists('cust_main-require_address2');
1687 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1688 # or return "Illegal payby: ". $self->payby;
1690 FS::payby->can_payby($self->table, $self->payby)
1691 or return "Illegal payby: ". $self->payby;
1693 $error = $self->ut_numbern('paystart_month')
1694 || $self->ut_numbern('paystart_year')
1695 || $self->ut_numbern('payissue')
1696 || $self->ut_textn('paytype')
1698 return $error if $error;
1700 if ( $self->payip eq '' ) {
1703 $error = $self->ut_ip('payip');
1704 return $error if $error;
1707 # If it is encrypted and the private key is not availaible then we can't
1708 # check the credit card.
1710 my $check_payinfo = 1;
1712 if ($self->is_encrypted($self->payinfo)) {
1716 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1718 my $payinfo = $self->payinfo;
1719 $payinfo =~ s/\D//g;
1720 $payinfo =~ /^(\d{13,16})$/
1721 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1723 $self->payinfo($payinfo);
1725 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1727 return gettext('unknown_card_type')
1728 if cardtype($self->payinfo) eq "Unknown";
1730 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1732 return 'Banned credit card: banned on '.
1733 time2str('%a %h %o at %r', $ban->_date).
1734 ' by '. $ban->otaker.
1735 ' (ban# '. $ban->bannum. ')';
1738 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1739 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1740 $self->paycvv =~ /^(\d{4})$/
1741 or return "CVV2 (CID) for American Express cards is four digits.";
1744 $self->paycvv =~ /^(\d{3})$/
1745 or return "CVV2 (CVC2/CID) is three digits.";
1752 my $cardtype = cardtype($payinfo);
1753 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1755 return "Start date or issue number is required for $cardtype cards"
1756 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1758 return "Start month must be between 1 and 12"
1759 if $self->paystart_month
1760 and $self->paystart_month < 1 || $self->paystart_month > 12;
1762 return "Start year must be 1990 or later"
1763 if $self->paystart_year
1764 and $self->paystart_year < 1990;
1766 return "Issue number must be beween 1 and 99"
1768 and $self->payissue < 1 || $self->payissue > 99;
1771 $self->paystart_month('');
1772 $self->paystart_year('');
1773 $self->payissue('');
1776 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1778 my $payinfo = $self->payinfo;
1779 $payinfo =~ s/[^\d\@]//g;
1780 if ( $conf->exists('echeck-nonus') ) {
1781 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1782 $payinfo = "$1\@$2";
1784 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1785 $payinfo = "$1\@$2";
1787 $self->payinfo($payinfo);
1790 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1792 return 'Banned ACH account: banned on '.
1793 time2str('%a %h %o at %r', $ban->_date).
1794 ' by '. $ban->otaker.
1795 ' (ban# '. $ban->bannum. ')';
1798 } elsif ( $self->payby eq 'LECB' ) {
1800 my $payinfo = $self->payinfo;
1801 $payinfo =~ s/\D//g;
1802 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1804 $self->payinfo($payinfo);
1807 } elsif ( $self->payby eq 'BILL' ) {
1809 $error = $self->ut_textn('payinfo');
1810 return "Illegal P.O. number: ". $self->payinfo if $error;
1813 } elsif ( $self->payby eq 'COMP' ) {
1815 my $curuser = $FS::CurrentUser::CurrentUser;
1816 if ( ! $self->custnum
1817 && ! $curuser->access_right('Complimentary customer')
1820 return "You are not permitted to create complimentary accounts."
1823 $error = $self->ut_textn('payinfo');
1824 return "Illegal comp account issuer: ". $self->payinfo if $error;
1827 } elsif ( $self->payby eq 'PREPAY' ) {
1829 my $payinfo = $self->payinfo;
1830 $payinfo =~ s/\W//g; #anything else would just confuse things
1831 $self->payinfo($payinfo);
1832 $error = $self->ut_alpha('payinfo');
1833 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1834 return "Unknown prepayment identifier"
1835 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1840 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1841 return "Expiration date required"
1842 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1846 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1847 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1848 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1849 ( $m, $y ) = ( $3, "20$2" );
1851 return "Illegal expiration date: ". $self->paydate;
1853 $self->paydate("$y-$m-01");
1854 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1855 return gettext('expired_card')
1857 && !$ignore_expired_card
1858 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1861 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1862 ( ! $conf->exists('require_cardname')
1863 || $self->payby !~ /^(CARD|DCRD)$/ )
1865 $self->payname( $self->first. " ". $self->getfield('last') );
1867 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1868 or return gettext('illegal_name'). " payname: ". $self->payname;
1872 foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
1873 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1877 $self->otaker(getotaker) unless $self->otaker;
1879 warn "$me check AFTER: \n". $self->_dump
1882 $self->SUPER::check;
1887 Returns a list of fields which have ship_ duplicates.
1892 qw( last first company
1893 address1 address2 city county state zip country
1898 =item has_ship_address
1900 Returns true if this customer record has a separate shipping address.
1904 sub has_ship_address {
1906 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1909 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1911 Returns all packages (see L<FS::cust_pkg>) for this customer.
1917 my $extra_qsearch = ref($_[0]) ? shift : {};
1919 return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
1922 if ( $self->{'_pkgnum'} ) {
1923 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1925 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1928 sort sort_packages @cust_pkg;
1933 Synonym for B<all_pkgs>.
1938 shift->all_pkgs(@_);
1943 Returns all locations (see L<FS::cust_location>) for this customer.
1949 qsearch('cust_location', { 'custnum' => $self->custnum } );
1952 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1954 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1958 sub ncancelled_pkgs {
1960 my $extra_qsearch = ref($_[0]) ? shift : {};
1962 return $self->num_ncancelled_pkgs unless wantarray;
1965 if ( $self->{'_pkgnum'} ) {
1967 warn "$me ncancelled_pkgs: returning cached objects"
1970 @cust_pkg = grep { ! $_->getfield('cancel') }
1971 values %{ $self->{'_pkgnum'}->cache };
1975 warn "$me ncancelled_pkgs: searching for packages with custnum ".
1976 $self->custnum. "\n"
1979 $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
1981 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1985 sort sort_packages @cust_pkg;
1991 my $extra_qsearch = ref($_[0]) ? shift : {};
1993 $extra_qsearch->{'select'} ||= '*';
1994 $extra_qsearch->{'select'} .=
1995 ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
1999 $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
2004 'table' => 'cust_pkg',
2005 'hashref' => { 'custnum' => $self->custnum },
2010 # This should be generalized to use config options to determine order.
2013 if ( $a->get('cancel') xor $b->get('cancel') ) {
2014 return -1 if $b->get('cancel');
2015 return 1 if $a->get('cancel');
2016 #shouldn't get here...
2019 my $a_num_cust_svc = $a->num_cust_svc;
2020 my $b_num_cust_svc = $b->num_cust_svc;
2021 return 0 if !$a_num_cust_svc && !$b_num_cust_svc;
2022 return -1 if $a_num_cust_svc && !$b_num_cust_svc;
2023 return 1 if !$a_num_cust_svc && $b_num_cust_svc;
2024 my @a_cust_svc = $a->cust_svc;
2025 my @b_cust_svc = $b->cust_svc;
2026 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
2031 =item suspended_pkgs
2033 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
2037 sub suspended_pkgs {
2039 grep { $_->susp } $self->ncancelled_pkgs;
2042 =item unflagged_suspended_pkgs
2044 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
2045 customer (thouse packages without the `manual_flag' set).
2049 sub unflagged_suspended_pkgs {
2051 return $self->suspended_pkgs
2052 unless dbdef->table('cust_pkg')->column('manual_flag');
2053 grep { ! $_->manual_flag } $self->suspended_pkgs;
2056 =item unsuspended_pkgs
2058 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
2063 sub unsuspended_pkgs {
2065 grep { ! $_->susp } $self->ncancelled_pkgs;
2068 =item next_bill_date
2070 Returns the next date this customer will be billed, as a UNIX timestamp, or
2071 undef if no active package has a next bill date.
2075 sub next_bill_date {
2077 min( map $_->get('bill'), grep $_->get('bill'), $self->unsuspended_pkgs );
2080 =item num_cancelled_pkgs
2082 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
2087 sub num_cancelled_pkgs {
2088 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
2091 sub num_ncancelled_pkgs {
2092 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
2096 my( $self ) = shift;
2097 my $sql = scalar(@_) ? shift : '';
2098 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2099 my $sth = dbh->prepare(
2100 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2101 ) or die dbh->errstr;
2102 $sth->execute($self->custnum) or die $sth->errstr;
2103 $sth->fetchrow_arrayref->[0];
2108 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2109 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2110 on success or a list of errors.
2116 grep { $_->unsuspend } $self->suspended_pkgs;
2121 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2123 Returns a list: an empty list on success or a list of errors.
2129 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2132 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2134 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2135 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2136 of a list of pkgparts; the hashref has the following keys:
2140 =item pkgparts - listref of pkgparts
2142 =item (other options are passed to the suspend method)
2147 Returns a list: an empty list on success or a list of errors.
2151 sub suspend_if_pkgpart {
2153 my (@pkgparts, %opt);
2154 if (ref($_[0]) eq 'HASH'){
2155 @pkgparts = @{$_[0]{pkgparts}};
2160 grep { $_->suspend(%opt) }
2161 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2162 $self->unsuspended_pkgs;
2165 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2167 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2168 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2169 instead of a list of pkgparts; the hashref has the following keys:
2173 =item pkgparts - listref of pkgparts
2175 =item (other options are passed to the suspend method)
2179 Returns a list: an empty list on success or a list of errors.
2183 sub suspend_unless_pkgpart {
2185 my (@pkgparts, %opt);
2186 if (ref($_[0]) eq 'HASH'){
2187 @pkgparts = @{$_[0]{pkgparts}};
2192 grep { $_->suspend(%opt) }
2193 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2194 $self->unsuspended_pkgs;
2197 =item cancel [ OPTION => VALUE ... ]
2199 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2201 Available options are:
2205 =item quiet - can be set true to supress email cancellation notices.
2207 =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.
2209 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2211 =item nobill - can be set true to skip billing if it might otherwise be done.
2215 Always returns a list: an empty list on success or a list of errors.
2219 # nb that dates are not specified as valid options to this method
2222 my( $self, %opt ) = @_;
2224 warn "$me cancel called on customer ". $self->custnum. " with options ".
2225 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2228 return ( 'access denied' )
2229 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2231 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2233 #should try decryption (we might have the private key)
2234 # and if not maybe queue a job for the server that does?
2235 return ( "Can't (yet) ban encrypted credit cards" )
2236 if $self->is_encrypted($self->payinfo);
2238 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2239 my $error = $ban->insert;
2240 return ( $error ) if $error;
2244 my @pkgs = $self->ncancelled_pkgs;
2246 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2248 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2249 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2253 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2254 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2257 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2260 sub _banned_pay_hashref {
2271 'payby' => $payby2ban{$self->payby},
2272 'payinfo' => md5_base64($self->payinfo),
2273 #don't ever *search* on reason! #'reason' =>
2279 Returns all notes (see L<FS::cust_main_note>) for this customer.
2286 qsearch( 'cust_main_note',
2287 { 'custnum' => $self->custnum },
2289 'ORDER BY _DATE DESC'
2295 Returns the agent (see L<FS::agent>) for this customer.
2301 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2304 =item bill_and_collect
2306 Cancels and suspends any packages due, generates bills, applies payments and
2309 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
2311 Options are passed as name-value pairs. Currently available options are:
2317 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:
2321 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
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.
2329 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2333 If set true, re-charges setup fees.
2337 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)
2341 Options are passed to the B<bill> and B<collect> methods verbatim, so all
2342 options of those methods are also available.
2346 sub bill_and_collect {
2347 my( $self, %options ) = @_;
2349 #$options{actual_time} not $options{time} because freeside-daily -d is for
2350 #pre-printing invoices
2351 $self->cancel_expired_pkgs( $options{actual_time} );
2352 $self->suspend_adjourned_pkgs( $options{actual_time} );
2354 my $error = $self->bill( %options );
2355 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
2357 $self->apply_payments_and_credits;
2359 unless ( $conf->exists('cancelled_cust-noevents')
2360 && ! $self->num_ncancelled_pkgs
2363 $error = $self->collect( %options );
2364 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
2370 sub cancel_expired_pkgs {
2371 my ( $self, $time ) = @_;
2373 my @cancel_pkgs = $self->ncancelled_pkgs( {
2374 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
2377 foreach my $cust_pkg ( @cancel_pkgs ) {
2378 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2379 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2380 'reason_otaker' => $cpr->otaker
2384 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
2385 " for custnum ". $self->custnum. ": $error"
2391 sub suspend_adjourned_pkgs {
2392 my ( $self, $time ) = @_;
2394 my @susp_pkgs = $self->ncancelled_pkgs( {
2396 " AND ( susp IS NULL OR susp = 0 )
2397 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
2398 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
2403 #only because there's no SQL test for is_prepaid :/
2405 grep { ( $_->part_pkg->is_prepaid
2410 && $_->adjourn <= $time
2416 foreach my $cust_pkg ( @susp_pkgs ) {
2417 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2418 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2419 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2420 'reason_otaker' => $cpr->otaker
2425 warn "Error suspending package ". $cust_pkg->pkgnum.
2426 " for custnum ". $self->custnum. ": $error"
2434 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2435 conjunction with the collect method by calling B<bill_and_collect>.
2437 If there is an error, returns the error, otherwise returns false.
2439 Options are passed as name-value pairs. Currently available options are:
2445 If set true, re-charges setup fees.
2449 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:
2453 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2457 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2459 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2463 A hashref of pkgparts to exclude from this billing run.
2467 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.
2471 This boolean value informs the us that the package is being cancelled. This
2472 typically might mean not charging the normal recurring fee but only usage
2473 fees since the last billing. Setup charges may be charged. Not all package
2474 plans support this feature (they tend to charge 0).
2481 my( $self, %options ) = @_;
2482 return '' if $self->payby eq 'COMP';
2483 warn "$me bill customer ". $self->custnum. "\n"
2486 my $time = $options{'time'} || time;
2487 my $invoice_time = $options{'invoice_time'} || $time;
2489 $options{'not_pkgpart'} ||= {};
2491 local $SIG{HUP} = 'IGNORE';
2492 local $SIG{INT} = 'IGNORE';
2493 local $SIG{QUIT} = 'IGNORE';
2494 local $SIG{TERM} = 'IGNORE';
2495 local $SIG{TSTP} = 'IGNORE';
2496 local $SIG{PIPE} = 'IGNORE';
2498 my $oldAutoCommit = $FS::UID::AutoCommit;
2499 local $FS::UID::AutoCommit = 0;
2502 $self->select_for_update; #mutex
2504 my $error = $self->do_cust_event(
2505 'debug' => ( $options{'debug'} || 0 ),
2506 'time' => $invoice_time,
2507 'check_freq' => $options{'check_freq'},
2508 'stage' => 'pre-bill',
2511 $dbh->rollback if $oldAutoCommit;
2515 my @cust_bill_pkg = ();
2518 # find the packages which are due for billing, find out how much they are
2519 # & generate invoice database.
2522 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2524 my @precommit_hooks = ();
2526 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
2527 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
2529 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
2531 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2533 #? to avoid use of uninitialized value errors... ?
2534 $cust_pkg->setfield('bill', '')
2535 unless defined($cust_pkg->bill);
2537 #my $part_pkg = $cust_pkg->part_pkg;
2539 my $real_pkgpart = $cust_pkg->pkgpart;
2540 my %hash = $cust_pkg->hash;
2542 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2544 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2547 $self->_make_lines( 'part_pkg' => $part_pkg,
2548 'cust_pkg' => $cust_pkg,
2549 'precommit_hooks' => \@precommit_hooks,
2550 'line_items' => \@cust_bill_pkg,
2551 'setup' => \$total_setup,
2552 'recur' => \$total_recur,
2553 'tax_matrix' => \%taxlisthash,
2555 'real_pkgpart' => $real_pkgpart,
2556 'options' => \%options,
2559 $dbh->rollback if $oldAutoCommit;
2563 } #foreach my $part_pkg
2565 } #foreach my $cust_pkg
2567 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2568 #but do commit any package date cycling that happened
2569 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2573 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2574 !$conf->exists('postal_invoice-recurring_only')
2578 my $postal_pkg = $self->charge_postal_fee();
2579 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2581 $dbh->rollback if $oldAutoCommit;
2582 return "can't charge postal invoice fee for customer ".
2583 $self->custnum. ": $postal_pkg";
2585 } elsif ( $postal_pkg ) {
2587 my $real_pkgpart = $postal_pkg->pkgpart;
2588 foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2589 my %postal_options = %options;
2590 delete $postal_options{cancel};
2592 $self->_make_lines( 'part_pkg' => $part_pkg,
2593 'cust_pkg' => $postal_pkg,
2594 'precommit_hooks' => \@precommit_hooks,
2595 'line_items' => \@cust_bill_pkg,
2596 'setup' => \$total_setup,
2597 'recur' => \$total_recur,
2598 'tax_matrix' => \%taxlisthash,
2600 'real_pkgpart' => $real_pkgpart,
2601 'options' => \%postal_options,
2604 $dbh->rollback if $oldAutoCommit;
2613 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2615 # keys are tax names (as printed on invoices / itemdesc )
2616 # values are listrefs of taxlisthash keys (internal identifiers)
2619 # keys are taxlisthash keys (internal identifiers)
2620 # values are (cumulative) amounts
2623 # keys are taxlisthash keys (internal identifiers)
2624 # values are listrefs of cust_bill_pkg_tax_location hashrefs
2625 my %tax_location = ();
2627 # keys are taxlisthash keys (internal identifiers)
2628 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
2629 my %tax_rate_location = ();
2631 foreach my $tax ( keys %taxlisthash ) {
2632 my $tax_object = shift @{ $taxlisthash{$tax} };
2633 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2634 warn " ". join('/', @{ $taxlisthash{$tax} } ). "\n" if $DEBUG > 2;
2635 my $hashref_or_error =
2636 $tax_object->taxline( $taxlisthash{$tax},
2637 'custnum' => $self->custnum,
2638 'invoice_time' => $invoice_time
2640 unless ( ref($hashref_or_error) ) {
2641 $dbh->rollback if $oldAutoCommit;
2642 return $hashref_or_error;
2644 unshift @{ $taxlisthash{$tax} }, $tax_object;
2646 my $name = $hashref_or_error->{'name'};
2647 my $amount = $hashref_or_error->{'amount'};
2649 #warn "adding $amount as $name\n";
2650 $taxname{ $name } ||= [];
2651 push @{ $taxname{ $name } }, $tax;
2653 $tax{ $tax } += $amount;
2655 $tax_location{ $tax } ||= [];
2656 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2657 push @{ $tax_location{ $tax } },
2659 'taxnum' => $tax_object->taxnum,
2660 'taxtype' => ref($tax_object),
2661 'pkgnum' => $tax_object->get('pkgnum'),
2662 'locationnum' => $tax_object->get('locationnum'),
2663 'amount' => sprintf('%.2f', $amount ),
2667 $tax_rate_location{ $tax } ||= [];
2668 if ( ref($tax_object) eq 'FS::tax_rate' ) {
2669 my $taxratelocationnum =
2670 $tax_object->tax_rate_location->taxratelocationnum;
2671 push @{ $tax_rate_location{ $tax } },
2673 'taxnum' => $tax_object->taxnum,
2674 'taxtype' => ref($tax_object),
2675 'amount' => sprintf('%.2f', $amount ),
2676 'locationtaxid' => $tax_object->location,
2677 'taxratelocationnum' => $taxratelocationnum,
2683 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
2684 my %packagemap = map { $_->pkgnum => $_ } @cust_bill_pkg;
2685 foreach my $tax ( keys %taxlisthash ) {
2686 foreach ( @{ $taxlisthash{$tax} }[1 ... scalar(@{ $taxlisthash{$tax} })] ) {
2687 next unless ref($_) eq 'FS::cust_bill_pkg';
2689 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
2690 splice( @{ $_->_cust_tax_exempt_pkg } );
2694 #consolidate and create tax line items
2695 warn "consolidating and generating...\n" if $DEBUG > 2;
2696 foreach my $taxname ( keys %taxname ) {
2699 my @cust_bill_pkg_tax_location = ();
2700 my @cust_bill_pkg_tax_rate_location = ();
2701 warn "adding $taxname\n" if $DEBUG > 1;
2702 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2703 next if $seen{$taxitem}++;
2704 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2705 $tax += $tax{$taxitem};
2706 push @cust_bill_pkg_tax_location,
2707 map { new FS::cust_bill_pkg_tax_location $_ }
2708 @{ $tax_location{ $taxitem } };
2709 push @cust_bill_pkg_tax_rate_location,
2710 map { new FS::cust_bill_pkg_tax_rate_location $_ }
2711 @{ $tax_rate_location{ $taxitem } };
2715 $tax = sprintf('%.2f', $tax );
2716 $total_setup = sprintf('%.2f', $total_setup+$tax );
2718 push @cust_bill_pkg, new FS::cust_bill_pkg {
2724 'itemdesc' => $taxname,
2725 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2726 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
2731 #add tax adjustments
2732 warn "adding tax adjustments...\n" if $DEBUG > 2;
2733 foreach my $cust_tax_adjustment (
2734 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
2740 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
2741 $total_setup = sprintf('%.2f', $total_setup+$tax );
2743 my $itemdesc = $cust_tax_adjustment->taxname;
2744 $itemdesc = '' if $itemdesc eq 'Tax';
2746 push @cust_bill_pkg, new FS::cust_bill_pkg {
2752 'itemdesc' => $itemdesc,
2753 'itemcomment' => $cust_tax_adjustment->comment,
2754 'cust_tax_adjustment' => $cust_tax_adjustment,
2755 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2760 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2762 #create the new invoice
2763 my $cust_bill = new FS::cust_bill ( {
2764 'custnum' => $self->custnum,
2765 '_date' => ( $invoice_time ),
2766 'charged' => $charged,
2768 $error = $cust_bill->insert;
2770 $dbh->rollback if $oldAutoCommit;
2771 return "can't create invoice for customer #". $self->custnum. ": $error";
2774 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2775 $cust_bill_pkg->invnum($cust_bill->invnum);
2776 my $error = $cust_bill_pkg->insert;
2778 $dbh->rollback if $oldAutoCommit;
2779 return "can't create invoice line item: $error";
2784 foreach my $hook ( @precommit_hooks ) {
2786 &{$hook}; #($self) ?
2789 $dbh->rollback if $oldAutoCommit;
2790 return "$@ running precommit hook $hook\n";
2794 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2800 my ($self, %params) = @_;
2802 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
2803 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
2804 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
2805 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
2806 my $total_setup = $params{setup} or die "no setup accumulator specified";
2807 my $total_recur = $params{recur} or die "no recur accumulator specified";
2808 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
2809 my $time = $params{'time'} or die "no time specified";
2810 my (%options) = %{$params{options}};
2813 my $real_pkgpart = $params{real_pkgpart};
2814 my %hash = $cust_pkg->hash;
2815 my $old_cust_pkg = new FS::cust_pkg \%hash;
2821 $cust_pkg->pkgpart($part_pkg->pkgpart);
2829 if ( $options{'resetup'}
2830 || ( ! $cust_pkg->setup
2831 && ( ! $cust_pkg->start_date
2832 || $cust_pkg->start_date <= $time
2834 && ( ! $conf->exists('disable_setup_suspended_pkgs')
2835 || ( $conf->exists('disable_setup_suspended_pkgs') &&
2836 ! $cust_pkg->getfield('susp')
2843 warn " bill setup\n" if $DEBUG > 1;
2846 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2847 return "$@ running calc_setup for $cust_pkg\n"
2850 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
2852 $cust_pkg->setfield('setup', $time)
2853 unless $cust_pkg->setup;
2854 #do need it, but it won't get written to the db
2855 #|| $cust_pkg->pkgpart != $real_pkgpart;
2857 $cust_pkg->setfield('start_date', '')
2858 if $cust_pkg->start_date;
2863 # bill recurring fee
2866 #XXX unit stuff here too
2870 if ( ! $cust_pkg->get('susp')
2871 and ! $cust_pkg->get('start_date')
2872 and ( $part_pkg->getfield('freq') ne '0'
2873 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
2875 || ( $part_pkg->plan eq 'voip_cdr'
2876 && $part_pkg->option('bill_every_call')
2878 || ( $options{cancel} )
2881 # XXX should this be a package event? probably. events are called
2882 # at collection time at the moment, though...
2883 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
2884 if $part_pkg->can('reset_usage');
2885 #don't want to reset usage just cause we want a line item??
2886 #&& $part_pkg->pkgpart == $real_pkgpart;
2888 warn " bill recur\n" if $DEBUG > 1;
2891 # XXX shared with $recur_prog
2892 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
2896 #over two params! lets at least switch to a hashref for the rest...
2897 my $increment_next_bill = ( $part_pkg->freq ne '0'
2898 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
2899 && !$options{cancel}
2901 my %param = ( 'precommit_hooks' => $precommit_hooks,
2902 'increment_next_bill' => $increment_next_bill,
2905 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
2906 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
2907 return "$@ running $method for $cust_pkg\n"
2910 if ( $increment_next_bill ) {
2912 my $next_bill = $part_pkg->add_freq($sdate);
2913 return "unparsable frequency: ". $part_pkg->freq
2914 if $next_bill == -1;
2916 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
2917 # only for figuring next bill date, nothing else, so, reset $sdate again
2919 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2920 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
2921 $cust_pkg->last_bill($sdate);
2923 $cust_pkg->setfield('bill', $next_bill );
2929 warn "\$setup is undefined" unless defined($setup);
2930 warn "\$recur is undefined" unless defined($recur);
2931 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2934 # If there's line items, create em cust_bill_pkg records
2935 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
2940 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
2941 # hmm.. and if just the options are modified in some weird price plan?
2943 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2946 my $error = $cust_pkg->replace( $old_cust_pkg,
2947 'options' => { $cust_pkg->options },
2949 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
2950 if $error; #just in case
2953 $setup = sprintf( "%.2f", $setup );
2954 $recur = sprintf( "%.2f", $recur );
2955 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2956 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2958 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2959 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2962 if ( $setup != 0 || $recur != 0 ) {
2964 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2967 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
2969 warn " adding customer package invoice detail: $_\n"
2970 foreach @cust_pkg_detail;
2972 push @details, @cust_pkg_detail;
2974 my $cust_bill_pkg = new FS::cust_bill_pkg {
2975 'pkgnum' => $cust_pkg->pkgnum,
2977 'unitsetup' => $unitsetup,
2979 'unitrecur' => $unitrecur,
2980 'quantity' => $cust_pkg->quantity,
2981 'details' => \@details,
2982 'hidden' => $part_pkg->hidden,
2985 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
2986 $cust_bill_pkg->sdate( $hash{last_bill} );
2987 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
2988 $cust_bill_pkg->edate( $time ) if $options{cancel};
2989 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
2990 $cust_bill_pkg->sdate( $sdate );
2991 $cust_bill_pkg->edate( $cust_pkg->bill );
2992 #$cust_bill_pkg->edate( $time ) if $options{cancel};
2995 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
2996 unless $part_pkg->pkgpart == $real_pkgpart;
2998 $$total_setup += $setup;
2999 $$total_recur += $recur;
3006 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart);
3007 return $error if $error;
3009 push @$cust_bill_pkgs, $cust_bill_pkg;
3011 } #if $setup != 0 || $recur != 0
3021 my $part_pkg = shift;
3022 my $taxlisthash = shift;
3023 my $cust_bill_pkg = shift;
3024 my $cust_pkg = shift;
3025 my $invoice_time = shift;
3026 my $real_pkgpart = shift;
3028 my %cust_bill_pkg = ();
3032 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3033 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3034 push @classes, 'setup' if $cust_bill_pkg->setup;
3035 push @classes, 'recur' if $cust_bill_pkg->recur;
3037 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3039 if ( $conf->exists('enable_taxproducts')
3040 && ( scalar($part_pkg->part_pkg_taxoverride)
3041 || $part_pkg->has_taxproduct
3046 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3047 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3050 foreach my $class (@classes) {
3051 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3052 return $err_or_ref unless ref($err_or_ref);
3053 $taxes{$class} = $err_or_ref;
3056 unless (exists $taxes{''}) {
3057 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3058 return $err_or_ref unless ref($err_or_ref);
3059 $taxes{''} = $err_or_ref;
3064 my @loc_keys = qw( state county country );
3066 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3067 my $cust_location = $cust_pkg->cust_location;
3068 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3071 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3074 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3077 $taxhash{'taxclass'} = $part_pkg->taxclass;
3079 my @taxes = qsearch( 'cust_main_county', \%taxhash );
3081 my %taxhash_elim = %taxhash;
3083 my @elim = qw( taxclass county state );
3084 while ( !scalar(@taxes) && scalar(@elim) ) {
3085 $taxhash_elim{ shift(@elim) } = '';
3086 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3089 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3091 if $self->cust_main_exemption; #just to be safe
3093 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3095 $_->set('pkgnum', $cust_pkg->pkgnum );
3096 $_->set('locationnum', $cust_pkg->locationnum );
3100 $taxes{''} = [ @taxes ];
3101 $taxes{'setup'} = [ @taxes ];
3102 $taxes{'recur'} = [ @taxes ];
3103 $taxes{$_} = [ @taxes ] foreach (@classes);
3105 # # maybe eliminate this entirely, along with all the 0% records
3106 # unless ( @taxes ) {
3108 # "fatal: can't find tax rate for state/county/country/taxclass ".
3109 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3112 } #if $conf->exists('enable_taxproducts') ...
3117 if ( $conf->exists('separate_usage') || $cust_bill_pkg->hidden ) {
3119 my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3120 my %hash = $cust_bill_pkg->hidden # maybe for all bill linked?
3121 ? ( 'section' => $temp_pkg->part_pkg->categoryname )
3124 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
3125 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
3126 push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3127 push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3129 if ($section && $summary) {
3130 push @display, new FS::cust_bill_pkg_display { type => 'U',
3134 $hash{post_total} = 'Y';
3137 $hash{section} = $section if $conf->exists('separate_usage');
3138 push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3141 $cust_bill_pkg->set('display', \@display);
3143 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3144 foreach my $key (keys %tax_cust_bill_pkg) {
3145 my @taxes = @{ $taxes{$key} || [] };
3146 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3148 my %localtaxlisthash = ();
3149 foreach my $tax ( @taxes ) {
3151 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3152 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3153 # ' locationnum'. $cust_pkg->locationnum
3154 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3156 $taxlisthash->{ $taxname } ||= [ $tax ];
3157 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3159 $localtaxlisthash{ $taxname } ||= [ $tax ];
3160 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3164 warn "finding taxed taxes...\n" if $DEBUG > 2;
3165 foreach my $tax ( keys %localtaxlisthash ) {
3166 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3167 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3169 next unless $tax_object->can('tax_on_tax');
3171 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3172 my $totname = ref( $tot ). ' '. $tot->taxnum;
3174 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3176 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3178 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3179 my $hashref_or_error =
3180 $tax_object->taxline( $localtaxlisthash{$tax},
3181 'custnum' => $self->custnum,
3182 'invoice_time' => $invoice_time,
3184 return $hashref_or_error
3185 unless ref($hashref_or_error);
3187 $taxlisthash->{ $totname } ||= [ $tot ];
3188 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3200 my $part_pkg = shift;
3204 my $geocode = $self->geocode('cch');
3206 my @taxclassnums = map { $_->taxclassnum }
3207 $part_pkg->part_pkg_taxoverride($class);
3209 unless (@taxclassnums) {
3210 @taxclassnums = map { $_->taxclassnum }
3211 grep { $_->taxable eq 'Y' }
3212 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3214 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3219 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3221 @taxes = qsearch({ 'table' => 'tax_rate',
3222 'hashref' => { 'geocode' => $geocode, },
3223 'extra_sql' => $extra_sql,
3225 if scalar(@taxclassnums);
3227 warn "Found taxes ".
3228 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3235 =item collect [ HASHREF | OPTION => VALUE ... ]
3237 (Attempt to) collect money for this customer's outstanding invoices (see
3238 L<FS::cust_bill>). Usually used after the bill method.
3240 Actions are now triggered by billing events; see L<FS::part_event> and the
3241 billing events web interface. Old-style invoice events (see
3242 L<FS::part_bill_event>) have been deprecated.
3244 If there is an error, returns the error, otherwise returns false.
3246 Options are passed as name-value pairs.
3248 Currently available options are:
3254 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.
3258 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3262 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3266 set true to surpress email card/ACH decline notices.
3270 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)
3276 # allows for one time override of normal customer billing method
3281 my( $self, %options ) = @_;
3282 my $invoice_time = $options{'invoice_time'} || time;
3285 local $SIG{HUP} = 'IGNORE';
3286 local $SIG{INT} = 'IGNORE';
3287 local $SIG{QUIT} = 'IGNORE';
3288 local $SIG{TERM} = 'IGNORE';
3289 local $SIG{TSTP} = 'IGNORE';
3290 local $SIG{PIPE} = 'IGNORE';
3292 my $oldAutoCommit = $FS::UID::AutoCommit;
3293 local $FS::UID::AutoCommit = 0;
3296 $self->select_for_update; #mutex
3299 my $balance = $self->balance;
3300 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3303 if ( exists($options{'retry_card'}) ) {
3304 carp 'retry_card option passed to collect is deprecated; use retry';
3305 $options{'retry'} ||= $options{'retry_card'};
3307 if ( exists($options{'retry'}) && $options{'retry'} ) {
3308 my $error = $self->retry_realtime;
3310 $dbh->rollback if $oldAutoCommit;
3315 my $error = $self->do_cust_event(
3316 'debug' => ( $options{'debug'} || 0 ),
3317 'time' => $invoice_time,
3318 'check_freq' => $options{'check_freq'},
3319 'stage' => 'collect',
3322 $dbh->rollback if $oldAutoCommit;
3326 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3331 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3333 Runs billing events; see L<FS::part_event> and the billing events web
3336 If there is an error, returns the error, otherwise returns false.
3338 Options are passed as name-value pairs.
3340 Currently available options are:
3346 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.
3350 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3354 "collect" (the default) or "pre-bill"
3358 set true to surpress email card/ACH decline notices.
3362 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)
3368 # allows for one time override of normal customer billing method
3372 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3375 my( $self, %options ) = @_;
3376 my $time = $options{'time'} || time;
3379 local $SIG{HUP} = 'IGNORE';
3380 local $SIG{INT} = 'IGNORE';
3381 local $SIG{QUIT} = 'IGNORE';
3382 local $SIG{TERM} = 'IGNORE';
3383 local $SIG{TSTP} = 'IGNORE';
3384 local $SIG{PIPE} = 'IGNORE';
3386 my $oldAutoCommit = $FS::UID::AutoCommit;
3387 local $FS::UID::AutoCommit = 0;
3390 $self->select_for_update; #mutex
3393 my $balance = $self->balance;
3394 warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3397 # if ( exists($options{'retry_card'}) ) {
3398 # carp 'retry_card option passed to collect is deprecated; use retry';
3399 # $options{'retry'} ||= $options{'retry_card'};
3401 # if ( exists($options{'retry'}) && $options{'retry'} ) {
3402 # my $error = $self->retry_realtime;
3404 # $dbh->rollback if $oldAutoCommit;
3409 # false laziness w/pay_batch::import_results
3411 my $due_cust_event = $self->due_cust_event(
3412 'debug' => ( $options{'debug'} || 0 ),
3414 'check_freq' => $options{'check_freq'},
3415 'stage' => ( $options{'stage'} || 'collect' ),
3417 unless( ref($due_cust_event) ) {
3418 $dbh->rollback if $oldAutoCommit;
3419 return $due_cust_event;
3422 foreach my $cust_event ( @$due_cust_event ) {
3426 #re-eval event conditions (a previous event could have changed things)
3427 unless ( $cust_event->test_conditions( 'time' => $time ) ) {
3428 #don't leave stray "new/locked" records around
3429 my $error = $cust_event->delete;
3431 #gah, even with transactions
3432 $dbh->commit if $oldAutoCommit; #well.
3439 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3440 warn " running cust_event ". $cust_event->eventnum. "\n"
3444 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3445 if ( my $error = $cust_event->do_event() ) {
3446 #XXX wtf is this? figure out a proper dealio with return value
3448 # gah, even with transactions.
3449 $dbh->commit if $oldAutoCommit; #well.
3456 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3461 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3463 Inserts database records for and returns an ordered listref of new events due
3464 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3465 events are due, an empty listref is returned. If there is an error, returns a
3466 scalar error message.
3468 To actually run the events, call each event's test_condition method, and if
3469 still true, call the event's do_event method.
3471 Options are passed as a hashref or as a list of name-value pairs. Available
3478 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.
3482 "collect" (the default) or "pre-bill"
3486 "Current time" for the events.
3490 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)
3494 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3498 Explicitly pass the objects to be tested (typically used with eventtable).
3502 Set to true to return the objects, but not actually insert them into the
3509 sub due_cust_event {
3511 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3514 #my $DEBUG = $opt{'debug'}
3515 local($DEBUG) = $opt{'debug'}
3516 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3518 warn "$me due_cust_event called with options ".
3519 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3522 $opt{'time'} ||= time;
3524 local $SIG{HUP} = 'IGNORE';
3525 local $SIG{INT} = 'IGNORE';
3526 local $SIG{QUIT} = 'IGNORE';
3527 local $SIG{TERM} = 'IGNORE';
3528 local $SIG{TSTP} = 'IGNORE';
3529 local $SIG{PIPE} = 'IGNORE';
3531 my $oldAutoCommit = $FS::UID::AutoCommit;
3532 local $FS::UID::AutoCommit = 0;
3535 $self->select_for_update #mutex
3536 unless $opt{testonly};
3539 # find possible events (initial search)
3542 my @cust_event = ();
3544 my @eventtable = $opt{'eventtable'}
3545 ? ( $opt{'eventtable'} )
3546 : FS::part_event->eventtables_runorder;
3548 foreach my $eventtable ( @eventtable ) {
3551 if ( $opt{'objects'} ) {
3553 @objects = @{ $opt{'objects'} };
3557 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3558 @objects = ( $eventtable eq 'cust_main' )
3560 : ( $self->$eventtable() );
3564 my @e_cust_event = ();
3566 my $cross = "CROSS JOIN $eventtable";
3567 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3568 unless $eventtable eq 'cust_main';
3570 foreach my $object ( @objects ) {
3572 #this first search uses the condition_sql magic for optimization.
3573 #the more possible events we can eliminate in this step the better
3575 my $cross_where = '';
3576 my $pkey = $object->primary_key;
3577 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3579 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3581 FS::part_event_condition->where_conditions_sql( $eventtable,
3582 'time'=>$opt{'time'}
3584 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3586 $extra_sql = "AND $extra_sql" if $extra_sql;
3588 #here is the agent virtualization
3589 $extra_sql .= " AND ( part_event.agentnum IS NULL
3590 OR part_event.agentnum = ". $self->agentnum. ' )';
3592 $extra_sql .= " $order";
3594 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3595 if $opt{'debug'} > 2;
3596 my @part_event = qsearch( {
3597 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3598 'select' => 'part_event.*',
3599 'table' => 'part_event',
3600 'addl_from' => "$cross $join",
3601 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3602 'eventtable' => $eventtable,
3605 'extra_sql' => "AND $cross_where $extra_sql",
3609 my $pkey = $object->primary_key;
3610 warn " ". scalar(@part_event).
3611 " possible events found for $eventtable ". $object->$pkey(). "\n";
3614 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3618 warn " ". scalar(@e_cust_event).
3619 " subtotal possible cust events found for $eventtable\n"
3622 push @cust_event, @e_cust_event;
3626 warn " ". scalar(@cust_event).
3627 " total possible cust events found in initial search\n"
3635 $opt{stage} ||= 'collect';
3637 grep { my $stage = $_->part_event->event_stage;
3638 $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
3648 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3649 'stats_hashref' => \%unsat ),
3652 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3655 warn " invalid conditions not eliminated with condition_sql:\n".
3656 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3663 unless( $opt{testonly} ) {
3664 foreach my $cust_event ( @cust_event ) {
3666 my $error = $cust_event->insert();
3668 $dbh->rollback if $oldAutoCommit;
3675 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3681 warn " returning events: ". Dumper(@cust_event). "\n"
3688 =item retry_realtime
3690 Schedules realtime / batch credit card / electronic check / LEC billing
3691 events for for retry. Useful if card information has changed or manual
3692 retry is desired. The 'collect' method must be called to actually retry
3695 Implementation details: For either this customer, or for each of this
3696 customer's open invoices, changes the status of the first "done" (with
3697 statustext error) realtime processing event to "failed".
3701 sub retry_realtime {
3704 local $SIG{HUP} = 'IGNORE';
3705 local $SIG{INT} = 'IGNORE';
3706 local $SIG{QUIT} = 'IGNORE';
3707 local $SIG{TERM} = 'IGNORE';
3708 local $SIG{TSTP} = 'IGNORE';
3709 local $SIG{PIPE} = 'IGNORE';
3711 my $oldAutoCommit = $FS::UID::AutoCommit;
3712 local $FS::UID::AutoCommit = 0;
3715 #a little false laziness w/due_cust_event (not too bad, really)
3717 my $join = FS::part_event_condition->join_conditions_sql;
3718 my $order = FS::part_event_condition->order_conditions_sql;
3721 . join ( ' OR ' , map {
3722 "( part_event.eventtable = " . dbh->quote($_)
3723 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3724 } FS::part_event->eventtables)
3727 #here is the agent virtualization
3728 my $agent_virt = " ( part_event.agentnum IS NULL
3729 OR part_event.agentnum = ". $self->agentnum. ' )';
3731 #XXX this shouldn't be hardcoded, actions should declare it...
3732 my @realtime_events = qw(
3733 cust_bill_realtime_card
3734 cust_bill_realtime_check
3735 cust_bill_realtime_lec
3739 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3744 my @cust_event = qsearchs({
3745 'table' => 'cust_event',
3746 'select' => 'cust_event.*',
3747 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3748 'hashref' => { 'status' => 'done' },
3749 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3750 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3753 my %seen_invnum = ();
3754 foreach my $cust_event (@cust_event) {
3756 #max one for the customer, one for each open invoice
3757 my $cust_X = $cust_event->cust_X;
3758 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3762 or $cust_event->part_event->eventtable eq 'cust_bill'
3765 my $error = $cust_event->retry;
3767 $dbh->rollback if $oldAutoCommit;
3768 return "error scheduling event for retry: $error";
3773 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3778 # some horrid false laziness here to avoid refactor fallout
3779 # eventually realtime realtime_bop and realtime_refund_bop should go
3780 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
3782 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3784 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3785 via a Business::OnlinePayment realtime gateway. See
3786 L<http://420.am/business-onlinepayment> for supported gateways.
3788 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3790 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3792 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3793 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3794 if set, will override the value from the customer record.
3796 I<description> is a free-text field passed to the gateway. It defaults to
3797 "Internet services".
3799 If an I<invnum> is specified, this payment (if successful) is applied to the
3800 specified invoice. If you don't specify an I<invnum> you might want to
3801 call the B<apply_payments> method.
3803 I<quiet> can be set true to surpress email decline notices.
3805 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
3806 resulting paynum, if any.
3808 I<payunique> is a unique identifier for this payment.
3810 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
3817 return $self->_new_realtime_bop(@_)
3818 if $self->_new_bop_required();
3820 my( $method, $amount, %options ) = @_;
3822 warn "$me realtime_bop: $method $amount\n";
3823 warn " $_ => $options{$_}\n" foreach keys %options;
3826 $options{'description'} ||= 'Internet services';
3828 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
3830 eval "use Business::OnlinePayment";
3833 my $payinfo = exists($options{'payinfo'})
3834 ? $options{'payinfo'}
3837 my %method2payby = (
3844 # check for banned credit card/ACH
3847 my $ban = qsearchs('banned_pay', {
3848 'payby' => $method2payby{$method},
3849 'payinfo' => md5_base64($payinfo),
3851 return "Banned credit card" if $ban;
3854 # set taxclass and trans_is_recur based on invnum if there is one
3858 my $trans_is_recur = 0;
3859 if ( $options{'invnum'} ) {
3861 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
3862 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
3865 map { $_->part_pkg }
3867 map { $_->cust_pkg }
3868 $cust_bill->cust_bill_pkg;
3870 my @taxclasses = map $_->taxclass, @part_pkg;
3871 $taxclass = $taxclasses[0]
3872 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
3873 #different taxclasses
3875 if grep { $_->freq ne '0' } @part_pkg;
3883 #look for an agent gateway override first
3885 if ( $method eq 'CC' ) {
3886 $cardtype = cardtype($payinfo);
3887 } elsif ( $method eq 'ECHECK' ) {
3890 $cardtype = $method;
3894 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3895 cardtype => $cardtype,
3896 taxclass => $taxclass, } )
3897 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3899 taxclass => $taxclass, } )
3900 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3901 cardtype => $cardtype,
3903 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3905 taxclass => '', } );
3907 my $payment_gateway = '';
3908 my( $processor, $login, $password, $action, @bop_options );
3909 if ( $override ) { #use a payment gateway override
3911 $payment_gateway = $override->payment_gateway;
3913 $processor = $payment_gateway->gateway_module;
3914 $login = $payment_gateway->gateway_username;
3915 $password = $payment_gateway->gateway_password;
3916 $action = $payment_gateway->gateway_action;
3917 @bop_options = $payment_gateway->options;
3919 } else { #use the standard settings from the config
3921 ( $processor, $login, $password, $action, @bop_options ) =
3922 $self->default_payment_gateway($method);
3930 my $address = exists($options{'address1'})
3931 ? $options{'address1'}
3933 my $address2 = exists($options{'address2'})
3934 ? $options{'address2'}
3936 $address .= ", ". $address2 if length($address2);
3938 my $o_payname = exists($options{'payname'})
3939 ? $options{'payname'}
3941 my($payname, $payfirst, $paylast);
3942 if ( $o_payname && $method ne 'ECHECK' ) {
3943 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3944 or return "Illegal payname $payname";
3945 ($payfirst, $paylast) = ($1, $2);
3947 $payfirst = $self->getfield('first');
3948 $paylast = $self->getfield('last');
3949 $payname = "$payfirst $paylast";
3952 my @invoicing_list = $self->invoicing_list_emailonly;
3953 if ( $conf->exists('emailinvoiceautoalways')
3954 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3955 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3956 push @invoicing_list, $self->all_emails;
3959 my $email = ($conf->exists('business-onlinepayment-email-override'))
3960 ? $conf->config('business-onlinepayment-email-override')
3961 : $invoicing_list[0];
3965 my $payip = exists($options{'payip'})
3968 $content{customer_ip} = $payip
3971 $content{invoice_number} = $options{'invnum'}
3972 if exists($options{'invnum'}) && length($options{'invnum'});
3974 $content{email_customer} =
3975 ( $conf->exists('business-onlinepayment-email_customer')
3976 || $conf->exists('business-onlinepayment-email-override') );
3979 if ( $method eq 'CC' ) {
3981 $content{card_number} = $payinfo;
3982 $paydate = exists($options{'paydate'})
3983 ? $options{'paydate'}
3985 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3986 $content{expiration} = "$2/$1";
3988 my $paycvv = exists($options{'paycvv'})
3989 ? $options{'paycvv'}
3991 $content{cvv2} = $paycvv
3994 my $paystart_month = exists($options{'paystart_month'})
3995 ? $options{'paystart_month'}
3996 : $self->paystart_month;
3998 my $paystart_year = exists($options{'paystart_year'})
3999 ? $options{'paystart_year'}
4000 : $self->paystart_year;
4002 $content{card_start} = "$paystart_month/$paystart_year"
4003 if $paystart_month && $paystart_year;
4005 my $payissue = exists($options{'payissue'})
4006 ? $options{'payissue'}
4008 $content{issue_number} = $payissue if $payissue;
4010 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
4011 'trans_is_recur' => $trans_is_recur,
4015 $content{recurring_billing} = 'YES';
4016 $content{acct_code} = 'rebill'
4017 if $conf->exists('credit_card-recurring_billing_acct_code');
4020 } elsif ( $method eq 'ECHECK' ) {
4021 ( $content{account_number}, $content{routing_code} ) =
4022 split('@', $payinfo);
4023 $content{bank_name} = $o_payname;
4024 $content{bank_state} = exists($options{'paystate'})
4025 ? $options{'paystate'}
4026 : $self->getfield('paystate');
4027 $content{account_type} = exists($options{'paytype'})
4028 ? uc($options{'paytype'}) || 'CHECKING'
4029 : uc($self->getfield('paytype')) || 'CHECKING';
4030 $content{account_name} = $payname;
4031 $content{customer_org} = $self->company ? 'B' : 'I';
4032 $content{state_id} = exists($options{'stateid'})
4033 ? $options{'stateid'}
4034 : $self->getfield('stateid');
4035 $content{state_id_state} = exists($options{'stateid_state'})
4036 ? $options{'stateid_state'}
4037 : $self->getfield('stateid_state');
4038 $content{customer_ssn} = exists($options{'ss'})
4041 } elsif ( $method eq 'LEC' ) {
4042 $content{phone} = $payinfo;
4046 # run transaction(s)
4049 my $balance = exists( $options{'balance'} )
4050 ? $options{'balance'}
4053 $self->select_for_update; #mutex ... just until we get our pending record in
4055 #the checks here are intended to catch concurrent payments
4056 #double-form-submission prevention is taken care of in cust_pay_pending::check
4059 return "The customer's balance has changed; $method transaction aborted."
4060 if $self->balance < $balance;
4061 #&& $self->balance < $amount; #might as well anyway?
4063 #also check and make sure there aren't *other* pending payments for this cust
4065 my @pending = qsearch('cust_pay_pending', {
4066 'custnum' => $self->custnum,
4067 'status' => { op=>'!=', value=>'done' }
4069 return "A payment is already being processed for this customer (".
4070 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4071 "); $method transaction aborted."
4072 if scalar(@pending);
4074 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4076 my $cust_pay_pending = new FS::cust_pay_pending {
4077 'custnum' => $self->custnum,
4078 #'invnum' => $options{'invnum'},
4081 'payby' => $method2payby{$method},
4082 'payinfo' => $payinfo,
4083 'paydate' => $paydate,
4084 'recurring_billing' => $content{recurring_billing},
4085 'pkgnum' => $options{'pkgnum'},
4087 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
4089 $cust_pay_pending->payunique( $options{payunique} )
4090 if defined($options{payunique}) && length($options{payunique});
4091 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4092 return $cpp_new_err if $cpp_new_err;
4094 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
4096 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
4097 $transaction->content(
4100 'password' => $password,
4101 'action' => $action1,
4102 'description' => $options{'description'},
4103 'amount' => $amount,
4104 #'invoice_number' => $options{'invnum'},
4105 'customer_id' => $self->custnum,
4106 'last_name' => $paylast,
4107 'first_name' => $payfirst,
4109 'address' => $address,
4110 'city' => ( exists($options{'city'})
4113 'state' => ( exists($options{'state'})
4116 'zip' => ( exists($options{'zip'})
4119 'country' => ( exists($options{'country'})
4120 ? $options{'country'}
4122 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4124 'phone' => $self->daytime || $self->night,
4128 $cust_pay_pending->status('pending');
4129 my $cpp_pending_err = $cust_pay_pending->replace;
4130 return $cpp_pending_err if $cpp_pending_err;
4133 my $BOP_TESTING = 0;
4134 my $BOP_TESTING_SUCCESS = 1;
4136 unless ( $BOP_TESTING ) {
4137 $transaction->submit();
4139 if ( $BOP_TESTING_SUCCESS ) {
4140 $transaction->is_success(1);
4141 $transaction->authorization('fake auth');
4143 $transaction->is_success(0);
4144 $transaction->error_message('fake failure');
4148 if ( $transaction->is_success() && $action2 ) {
4150 $cust_pay_pending->status('authorized');
4151 my $cpp_authorized_err = $cust_pay_pending->replace;
4152 return $cpp_authorized_err if $cpp_authorized_err;
4154 my $auth = $transaction->authorization;
4155 my $ordernum = $transaction->can('order_number')
4156 ? $transaction->order_number
4160 new Business::OnlinePayment( $processor, @bop_options );
4167 password => $password,
4168 order_number => $ordernum,
4170 authorization => $auth,
4171 description => $options{'description'},
4174 foreach my $field (qw( authorization_source_code returned_ACI
4175 transaction_identifier validation_code
4176 transaction_sequence_num local_transaction_date
4177 local_transaction_time AVS_result_code )) {
4178 $capture{$field} = $transaction->$field() if $transaction->can($field);
4181 $capture->content( %capture );
4185 unless ( $capture->is_success ) {
4186 my $e = "Authorization successful but capture failed, custnum #".
4187 $self->custnum. ': '. $capture->result_code.
4188 ": ". $capture->error_message;
4195 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4196 my $cpp_captured_err = $cust_pay_pending->replace;
4197 return $cpp_captured_err if $cpp_captured_err;
4200 # remove paycvv after initial transaction
4203 #false laziness w/misc/process/payment.cgi - check both to make sure working
4205 if ( defined $self->dbdef_table->column('paycvv')
4206 && length($self->paycvv)
4207 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4209 my $error = $self->remove_cvv;
4211 warn "WARNING: error removing cvv: $error\n";
4219 if ( $transaction->is_success() ) {
4222 if ( $payment_gateway ) { # agent override
4223 $paybatch = $payment_gateway->gatewaynum. '-';
4226 $paybatch .= "$processor:". $transaction->authorization;
4228 $paybatch .= ':'. $transaction->order_number
4229 if $transaction->can('order_number')
4230 && length($transaction->order_number);
4232 my $cust_pay = new FS::cust_pay ( {
4233 'custnum' => $self->custnum,
4234 'invnum' => $options{'invnum'},
4237 'payby' => $method2payby{$method},
4238 'payinfo' => $payinfo,
4239 'paybatch' => $paybatch,
4240 'paydate' => $paydate,
4241 'pkgnum' => $options{'pkgnum'},
4243 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4244 $cust_pay->payunique( $options{payunique} )
4245 if defined($options{payunique}) && length($options{payunique});
4247 my $oldAutoCommit = $FS::UID::AutoCommit;
4248 local $FS::UID::AutoCommit = 0;
4251 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4253 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4256 $cust_pay->invnum(''); #try again with no specific invnum
4257 my $error2 = $cust_pay->insert( $options{'manual'} ?
4258 ( 'manual' => 1 ) : ()
4261 # gah. but at least we have a record of the state we had to abort in
4262 # from cust_pay_pending now.
4263 my $e = "WARNING: $method captured but payment not recorded - ".
4264 "error inserting payment ($processor): $error2".
4265 " (previously tried insert with invnum #$options{'invnum'}" .
4266 ": $error ) - pending payment saved as paypendingnum ".
4267 $cust_pay_pending->paypendingnum. "\n";
4273 if ( $options{'paynum_ref'} ) {
4274 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4277 $cust_pay_pending->status('done');
4278 $cust_pay_pending->statustext('captured');
4279 $cust_pay_pending->paynum($cust_pay->paynum);
4280 my $cpp_done_err = $cust_pay_pending->replace;
4282 if ( $cpp_done_err ) {
4284 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4285 my $e = "WARNING: $method captured but payment not recorded - ".
4286 "error updating status for paypendingnum ".
4287 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4293 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4294 return ''; #no error
4300 my $perror = "$processor error: ". $transaction->error_message;
4302 unless ( $transaction->error_message ) {
4305 if ( $transaction->can('response_page') ) {
4307 'page' => ( $transaction->can('response_page')
4308 ? $transaction->response_page
4311 'code' => ( $transaction->can('response_code')
4312 ? $transaction->response_code
4315 'headers' => ( $transaction->can('response_headers')
4316 ? $transaction->response_headers
4322 "No additional debugging information available for $processor";
4325 $perror .= "No error_message returned from $processor -- ".
4326 ( ref($t_response) ? Dumper($t_response) : $t_response );
4330 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4331 && $conf->exists('emaildecline')
4332 && grep { $_ ne 'POST' } $self->invoicing_list
4333 && ! grep { $transaction->error_message =~ /$_/ }
4334 $conf->config('emaildecline-exclude')
4336 my @templ = $conf->config('declinetemplate');
4337 my $template = new Text::Template (
4339 SOURCE => [ map "$_\n", @templ ],
4340 ) or return "($perror) can't create template: $Text::Template::ERROR";
4341 $template->compile()
4342 or return "($perror) can't compile template: $Text::Template::ERROR";
4346 scalar( $conf->config('company_name', $self->agentnum ) ),
4347 'company_address' =>
4348 join("\n", $conf->config('company_address', $self->agentnum ) ),
4349 'error' => $transaction->error_message,
4352 my $error = send_email(
4353 'from' => $conf->config('invoice_from', $self->agentnum ),
4354 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4355 'subject' => 'Your payment could not be processed',
4356 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4359 $perror .= " (also received error sending decline notification: $error)"
4364 $cust_pay_pending->status('done');
4365 $cust_pay_pending->statustext("declined: $perror");
4366 my $cpp_done_err = $cust_pay_pending->replace;
4367 if ( $cpp_done_err ) {
4368 my $e = "WARNING: $method declined but pending payment not resolved - ".
4369 "error updating status for paypendingnum ".
4370 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4372 $perror = "$e ($perror)";
4380 sub _bop_recurring_billing {
4381 my( $self, %opt ) = @_;
4383 my $method = $conf->config('credit_card-recurring_billing_flag');
4385 if ( $method eq 'transaction_is_recur' ) {
4387 return 1 if $opt{'trans_is_recur'};
4391 my %hash = ( 'custnum' => $self->custnum,
4396 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4397 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4408 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4410 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4411 via a Business::OnlinePayment realtime gateway. See
4412 L<http://420.am/business-onlinepayment> for supported gateways.
4414 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4416 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4418 Most gateways require a reference to an original payment transaction to refund,
4419 so you probably need to specify a I<paynum>.
4421 I<amount> defaults to the original amount of the payment if not specified.
4423 I<reason> specifies a reason for the refund.
4425 I<paydate> specifies the expiration date for a credit card overriding the
4426 value from the customer record or the payment record. Specified as yyyy-mm-dd
4428 Implementation note: If I<amount> is unspecified or equal to the amount of the
4429 orignal payment, first an attempt is made to "void" the transaction via
4430 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4431 the normal attempt is made to "refund" ("credit") the transaction via the
4432 gateway is attempted.
4434 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4435 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4436 #if set, will override the value from the customer record.
4438 #If an I<invnum> is specified, this payment (if successful) is applied to the
4439 #specified invoice. If you don't specify an I<invnum> you might want to
4440 #call the B<apply_payments> method.
4444 #some false laziness w/realtime_bop, not enough to make it worth merging
4445 #but some useful small subs should be pulled out
4446 sub realtime_refund_bop {
4449 return $self->_new_realtime_refund_bop(@_)
4450 if $self->_new_bop_required();
4452 my( $method, %options ) = @_;
4454 warn "$me realtime_refund_bop: $method refund\n";
4455 warn " $_ => $options{$_}\n" foreach keys %options;
4458 eval "use Business::OnlinePayment";
4462 # look up the original payment and optionally a gateway for that payment
4466 my $amount = $options{'amount'};
4468 my( $processor, $login, $password, @bop_options ) ;
4469 my( $auth, $order_number ) = ( '', '', '' );
4471 if ( $options{'paynum'} ) {
4473 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4474 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4475 or return "Unknown paynum $options{'paynum'}";
4476 $amount ||= $cust_pay->paid;
4478 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4479 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4480 $cust_pay->paybatch;
4481 my $gatewaynum = '';
4482 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4484 if ( $gatewaynum ) { #gateway for the payment to be refunded
4486 my $payment_gateway =
4487 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4488 die "payment gateway $gatewaynum not found"
4489 unless $payment_gateway;
4491 $processor = $payment_gateway->gateway_module;
4492 $login = $payment_gateway->gateway_username;
4493 $password = $payment_gateway->gateway_password;
4494 @bop_options = $payment_gateway->options;
4496 } else { #try the default gateway
4498 my( $conf_processor, $unused_action );
4499 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4500 $self->default_payment_gateway($method);
4502 return "processor of payment $options{'paynum'} $processor does not".
4503 " match default processor $conf_processor"
4504 unless $processor eq $conf_processor;
4509 } else { # didn't specify a paynum, so look for agent gateway overrides
4510 # like a normal transaction
4513 if ( $method eq 'CC' ) {
4514 $cardtype = cardtype($self->payinfo);
4515 } elsif ( $method eq 'ECHECK' ) {
4518 $cardtype = $method;
4521 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4522 cardtype => $cardtype,
4524 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4526 taxclass => '', } );
4528 if ( $override ) { #use a payment gateway override
4530 my $payment_gateway = $override->payment_gateway;
4532 $processor = $payment_gateway->gateway_module;
4533 $login = $payment_gateway->gateway_username;
4534 $password = $payment_gateway->gateway_password;
4535 #$action = $payment_gateway->gateway_action;
4536 @bop_options = $payment_gateway->options;
4538 } else { #use the standard settings from the config
4541 ( $processor, $login, $password, $unused_action, @bop_options ) =
4542 $self->default_payment_gateway($method);
4547 return "neither amount nor paynum specified" unless $amount;
4552 'password' => $password,
4553 'order_number' => $order_number,
4554 'amount' => $amount,
4555 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4557 $content{authorization} = $auth
4558 if length($auth); #echeck/ACH transactions have an order # but no auth
4559 #(at least with authorize.net)
4561 my $disable_void_after;
4562 if ($conf->exists('disable_void_after')
4563 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4564 $disable_void_after = $1;
4567 #first try void if applicable
4568 if ( $cust_pay && $cust_pay->paid == $amount
4570 ( not defined($disable_void_after) )
4571 || ( time < ($cust_pay->_date + $disable_void_after ) )
4574 warn " attempting void\n" if $DEBUG > 1;
4575 my $void = new Business::OnlinePayment( $processor, @bop_options );
4576 $void->content( 'action' => 'void', %content );
4578 if ( $void->is_success ) {
4579 my $error = $cust_pay->void($options{'reason'});
4581 # gah, even with transactions.
4582 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4583 "error voiding payment: $error";
4587 warn " void successful\n" if $DEBUG > 1;
4592 warn " void unsuccessful, trying refund\n"
4596 my $address = $self->address1;
4597 $address .= ", ". $self->address2 if $self->address2;
4599 my($payname, $payfirst, $paylast);
4600 if ( $self->payname && $method ne 'ECHECK' ) {
4601 $payname = $self->payname;
4602 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4603 or return "Illegal payname $payname";
4604 ($payfirst, $paylast) = ($1, $2);
4606 $payfirst = $self->getfield('first');
4607 $paylast = $self->getfield('last');
4608 $payname = "$payfirst $paylast";
4611 my @invoicing_list = $self->invoicing_list_emailonly;
4612 if ( $conf->exists('emailinvoiceautoalways')
4613 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4614 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4615 push @invoicing_list, $self->all_emails;
4618 my $email = ($conf->exists('business-onlinepayment-email-override'))
4619 ? $conf->config('business-onlinepayment-email-override')
4620 : $invoicing_list[0];
4622 my $payip = exists($options{'payip'})
4625 $content{customer_ip} = $payip
4629 if ( $method eq 'CC' ) {
4632 $content{card_number} = $payinfo = $cust_pay->payinfo;
4633 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4634 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4635 ($content{expiration} = "$2/$1"); # where available
4637 $content{card_number} = $payinfo = $self->payinfo;
4638 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4639 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4640 $content{expiration} = "$2/$1";
4643 } elsif ( $method eq 'ECHECK' ) {
4646 $payinfo = $cust_pay->payinfo;
4648 $payinfo = $self->payinfo;
4650 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4651 $content{bank_name} = $self->payname;
4652 $content{account_type} = 'CHECKING';
4653 $content{account_name} = $payname;
4654 $content{customer_org} = $self->company ? 'B' : 'I';
4655 $content{customer_ssn} = $self->ss;
4656 } elsif ( $method eq 'LEC' ) {
4657 $content{phone} = $payinfo = $self->payinfo;
4661 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4662 my %sub_content = $refund->content(
4663 'action' => 'credit',
4664 'customer_id' => $self->custnum,
4665 'last_name' => $paylast,
4666 'first_name' => $payfirst,
4668 'address' => $address,
4669 'city' => $self->city,
4670 'state' => $self->state,
4671 'zip' => $self->zip,
4672 'country' => $self->country,
4674 'phone' => $self->daytime || $self->night,
4677 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4681 return "$processor error: ". $refund->error_message
4682 unless $refund->is_success();
4684 my %method2payby = (
4690 my $paybatch = "$processor:". $refund->authorization;
4691 $paybatch .= ':'. $refund->order_number
4692 if $refund->can('order_number') && $refund->order_number;
4694 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4695 my @cust_bill_pay = $cust_pay->cust_bill_pay;
4696 last unless @cust_bill_pay;
4697 my $cust_bill_pay = pop @cust_bill_pay;
4698 my $error = $cust_bill_pay->delete;
4702 my $cust_refund = new FS::cust_refund ( {
4703 'custnum' => $self->custnum,
4704 'paynum' => $options{'paynum'},
4705 'refund' => $amount,
4707 'payby' => $method2payby{$method},
4708 'payinfo' => $payinfo,
4709 'paybatch' => $paybatch,
4710 'reason' => $options{'reason'} || 'card or ACH refund',
4712 my $error = $cust_refund->insert;
4714 $cust_refund->paynum(''); #try again with no specific paynum
4715 my $error2 = $cust_refund->insert;
4717 # gah, even with transactions.
4718 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4719 "error inserting refund ($processor): $error2".
4720 " (previously tried insert with paynum #$options{'paynum'}" .
4731 # does the configuration indicate the new bop routines are required?
4733 sub _new_bop_required {
4736 my $botpp = 'Business::OnlineThirdPartyPayment';
4739 if ( $conf->config('business-onlinepayment-namespace') eq $botpp ||
4740 scalar( grep { $_->gateway_namespace eq $botpp }
4741 qsearch( 'payment_gateway', { 'disabled' => '' } )
4750 =item realtime_collect [ OPTION => VALUE ... ]
4752 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4753 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4754 gateway. See L<http://420.am/business-onlinepayment> and
4755 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4757 On failure returns an error message.
4759 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.
4761 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
4763 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
4764 then it is deduced from the customer record.
4766 If no I<amount> is specified, then the customer balance is used.
4768 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4769 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4770 if set, will override the value from the customer record.
4772 I<description> is a free-text field passed to the gateway. It defaults to
4773 "Internet services".
4775 If an I<invnum> is specified, this payment (if successful) is applied to the
4776 specified invoice. If you don't specify an I<invnum> you might want to
4777 call the B<apply_payments> method.
4779 I<quiet> can be set true to surpress email decline notices.
4781 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4782 resulting paynum, if any.
4784 I<payunique> is a unique identifier for this payment.
4786 I<session_id> is a session identifier associated with this payment.
4788 I<depend_jobnum> allows payment capture to unlock export jobs
4792 sub realtime_collect {
4793 my( $self, %options ) = @_;
4796 warn "$me realtime_collect:\n";
4797 warn " $_ => $options{$_}\n" foreach keys %options;
4800 $options{amount} = $self->balance unless exists( $options{amount} );
4801 $options{method} = FS::payby->payby2bop($self->payby)
4802 unless exists( $options{method} );
4804 return $self->realtime_bop({%options});
4808 =item _realtime_bop { [ ARG => VALUE ... ] }
4810 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4811 via a Business::OnlinePayment realtime gateway. See
4812 L<http://420.am/business-onlinepayment> for supported gateways.
4814 Required arguments in the hashref are I<method>, and I<amount>
4816 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4818 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4820 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4821 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4822 if set, will override the value from the customer record.
4824 I<description> is a free-text field passed to the gateway. It defaults to
4825 "Internet services".
4827 If an I<invnum> is specified, this payment (if successful) is applied to the
4828 specified invoice. If you don't specify an I<invnum> you might want to
4829 call the B<apply_payments> method.
4831 I<quiet> can be set true to surpress email decline notices.
4833 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4834 resulting paynum, if any.
4836 I<payunique> is a unique identifier for this payment.
4838 I<session_id> is a session identifier associated with this payment.
4840 I<depend_jobnum> allows payment capture to unlock export jobs
4842 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4846 # some helper routines
4847 sub _payment_gateway {
4848 my ($self, $options) = @_;
4850 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
4851 unless exists($options->{payment_gateway});
4853 $options->{payment_gateway};
4857 my ($self, $options) = @_;
4860 'login' => $options->{payment_gateway}->gateway_username,
4861 'password' => $options->{payment_gateway}->gateway_password,
4866 my ($self, $options) = @_;
4868 $options->{payment_gateway}->gatewaynum
4869 ? $options->{payment_gateway}->options
4870 : @{ $options->{payment_gateway}->get('options') };
4874 my ($self, $options) = @_;
4876 $options->{description} ||= 'Internet services';
4877 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
4878 $options->{invnum} ||= '';
4879 $options->{payname} = $self->payname unless exists( $options->{payname} );
4883 my ($self, $options) = @_;
4886 $content{address} = exists($options->{'address1'})
4887 ? $options->{'address1'}
4889 my $address2 = exists($options->{'address2'})
4890 ? $options->{'address2'}
4892 $content{address} .= ", ". $address2 if length($address2);
4894 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
4895 $content{customer_ip} = $payip if length($payip);
4897 $content{invoice_number} = $options->{'invnum'}
4898 if exists($options->{'invnum'}) && length($options->{'invnum'});
4900 $content{email_customer} =
4901 ( $conf->exists('business-onlinepayment-email_customer')
4902 || $conf->exists('business-onlinepayment-email-override') );
4904 $content{payfirst} = $self->getfield('first');
4905 $content{paylast} = $self->getfield('last');
4907 $content{account_name} = "$content{payfirst} $content{paylast}"
4908 if $options->{method} eq 'ECHECK';
4910 $content{name} = $options->{payname};
4911 $content{name} = $content{account_name} if exists($content{account_name});
4913 $content{city} = exists($options->{city})
4916 $content{state} = exists($options->{state})
4919 $content{zip} = exists($options->{zip})
4922 $content{country} = exists($options->{country})
4923 ? $options->{country}
4925 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
4926 $content{phone} = $self->daytime || $self->night;
4931 my %bop_method2payby = (
4937 sub _new_realtime_bop {
4941 if (ref($_[0]) eq 'HASH') {
4942 %options = %{$_[0]};
4944 my ( $method, $amount ) = ( shift, shift );
4946 $options{method} = $method;
4947 $options{amount} = $amount;
4951 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
4952 warn " $_ => $options{$_}\n" foreach keys %options;
4955 return $self->fake_bop(%options) if $options{'fake'};
4957 $self->_bop_defaults(\%options);
4960 # set trans_is_recur based on invnum if there is one
4963 my $trans_is_recur = 0;
4964 if ( $options{'invnum'} ) {
4966 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4967 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4970 map { $_->part_pkg }
4972 map { $_->cust_pkg }
4973 $cust_bill->cust_bill_pkg;
4976 if grep { $_->freq ne '0' } @part_pkg;
4984 my $payment_gateway = $self->_payment_gateway( \%options );
4985 my $namespace = $payment_gateway->gateway_namespace;
4987 eval "use $namespace";
4991 # check for banned credit card/ACH
4994 my $ban = qsearchs('banned_pay', {
4995 'payby' => $bop_method2payby{$options{method}},
4996 'payinfo' => md5_base64($options{payinfo}),
4998 return "Banned credit card" if $ban;
5004 my (%bop_content) = $self->_bop_content(\%options);
5006 if ( $options{method} ne 'ECHECK' ) {
5007 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5008 or return "Illegal payname $options{payname}";
5009 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
5012 my @invoicing_list = $self->invoicing_list_emailonly;
5013 if ( $conf->exists('emailinvoiceautoalways')
5014 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5015 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5016 push @invoicing_list, $self->all_emails;
5019 my $email = ($conf->exists('business-onlinepayment-email-override'))
5020 ? $conf->config('business-onlinepayment-email-override')
5021 : $invoicing_list[0];
5025 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
5027 $content{card_number} = $options{payinfo};
5028 $paydate = exists($options{'paydate'})
5029 ? $options{'paydate'}
5031 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5032 $content{expiration} = "$2/$1";
5034 my $paycvv = exists($options{'paycvv'})
5035 ? $options{'paycvv'}
5037 $content{cvv2} = $paycvv
5040 my $paystart_month = exists($options{'paystart_month'})
5041 ? $options{'paystart_month'}
5042 : $self->paystart_month;
5044 my $paystart_year = exists($options{'paystart_year'})
5045 ? $options{'paystart_year'}
5046 : $self->paystart_year;
5048 $content{card_start} = "$paystart_month/$paystart_year"
5049 if $paystart_month && $paystart_year;
5051 my $payissue = exists($options{'payissue'})
5052 ? $options{'payissue'}
5054 $content{issue_number} = $payissue if $payissue;
5056 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
5057 'trans_is_recur' => $trans_is_recur,
5061 $content{recurring_billing} = 'YES';
5062 $content{acct_code} = 'rebill'
5063 if $conf->exists('credit_card-recurring_billing_acct_code');
5066 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
5067 ( $content{account_number}, $content{routing_code} ) =
5068 split('@', $options{payinfo});
5069 $content{bank_name} = $options{payname};
5070 $content{bank_state} = exists($options{'paystate'})
5071 ? $options{'paystate'}
5072 : $self->getfield('paystate');
5073 $content{account_type} = exists($options{'paytype'})
5074 ? uc($options{'paytype'}) || 'CHECKING'
5075 : uc($self->getfield('paytype')) || 'CHECKING';
5076 $content{customer_org} = $self->company ? 'B' : 'I';
5077 $content{state_id} = exists($options{'stateid'})
5078 ? $options{'stateid'}
5079 : $self->getfield('stateid');
5080 $content{state_id_state} = exists($options{'stateid_state'})
5081 ? $options{'stateid_state'}
5082 : $self->getfield('stateid_state');
5083 $content{customer_ssn} = exists($options{'ss'})
5086 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
5087 $content{phone} = $options{payinfo};
5088 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5095 # run transaction(s)
5098 my $balance = exists( $options{'balance'} )
5099 ? $options{'balance'}
5102 $self->select_for_update; #mutex ... just until we get our pending record in
5104 #the checks here are intended to catch concurrent payments
5105 #double-form-submission prevention is taken care of in cust_pay_pending::check
5108 return "The customer's balance has changed; $options{method} transaction aborted."
5109 if $self->balance < $balance;
5110 #&& $self->balance < $options{amount}; #might as well anyway?
5112 #also check and make sure there aren't *other* pending payments for this cust
5114 my @pending = qsearch('cust_pay_pending', {
5115 'custnum' => $self->custnum,
5116 'status' => { op=>'!=', value=>'done' }
5118 return "A payment is already being processed for this customer (".
5119 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
5120 "); $options{method} transaction aborted."
5121 if scalar(@pending);
5123 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
5125 my $cust_pay_pending = new FS::cust_pay_pending {
5126 'custnum' => $self->custnum,
5127 #'invnum' => $options{'invnum'},
5128 'paid' => $options{amount},
5130 'payby' => $bop_method2payby{$options{method}},
5131 'payinfo' => $options{payinfo},
5132 'paydate' => $paydate,
5133 'recurring_billing' => $content{recurring_billing},
5134 'pkgnum' => $options{'pkgnum'},
5136 'gatewaynum' => $payment_gateway->gatewaynum || '',
5137 'session_id' => $options{session_id} || '',
5138 'jobnum' => $options{depend_jobnum} || '',
5140 $cust_pay_pending->payunique( $options{payunique} )
5141 if defined($options{payunique}) && length($options{payunique});
5142 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5143 return $cpp_new_err if $cpp_new_err;
5145 my( $action1, $action2 ) =
5146 split( /\s*\,\s*/, $payment_gateway->gateway_action );
5148 my $transaction = new $namespace( $payment_gateway->gateway_module,
5149 $self->_bop_options(\%options),
5152 $transaction->content(
5153 'type' => $options{method},
5154 $self->_bop_auth(\%options),
5155 'action' => $action1,
5156 'description' => $options{'description'},
5157 'amount' => $options{amount},
5158 #'invoice_number' => $options{'invnum'},
5159 'customer_id' => $self->custnum,
5161 'reference' => $cust_pay_pending->paypendingnum, #for now
5166 $cust_pay_pending->status('pending');
5167 my $cpp_pending_err = $cust_pay_pending->replace;
5168 return $cpp_pending_err if $cpp_pending_err;
5171 my $BOP_TESTING = 0;
5172 my $BOP_TESTING_SUCCESS = 1;
5174 unless ( $BOP_TESTING ) {
5175 $transaction->submit();
5177 if ( $BOP_TESTING_SUCCESS ) {
5178 $transaction->is_success(1);
5179 $transaction->authorization('fake auth');
5181 $transaction->is_success(0);
5182 $transaction->error_message('fake failure');
5186 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5188 return { reference => $cust_pay_pending->paypendingnum,
5189 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5191 } elsif ( $transaction->is_success() && $action2 ) {
5193 $cust_pay_pending->status('authorized');
5194 my $cpp_authorized_err = $cust_pay_pending->replace;
5195 return $cpp_authorized_err if $cpp_authorized_err;
5197 my $auth = $transaction->authorization;
5198 my $ordernum = $transaction->can('order_number')
5199 ? $transaction->order_number
5203 new Business::OnlinePayment( $payment_gateway->gateway_module,
5204 $self->_bop_options(\%options),
5209 type => $options{method},
5211 $self->_bop_auth(\%options),
5212 order_number => $ordernum,
5213 amount => $options{amount},
5214 authorization => $auth,
5215 description => $options{'description'},
5218 foreach my $field (qw( authorization_source_code returned_ACI
5219 transaction_identifier validation_code
5220 transaction_sequence_num local_transaction_date
5221 local_transaction_time AVS_result_code )) {
5222 $capture{$field} = $transaction->$field() if $transaction->can($field);
5225 $capture->content( %capture );
5229 unless ( $capture->is_success ) {
5230 my $e = "Authorization successful but capture failed, custnum #".
5231 $self->custnum. ': '. $capture->result_code.
5232 ": ". $capture->error_message;
5240 # remove paycvv after initial transaction
5243 #false laziness w/misc/process/payment.cgi - check both to make sure working
5245 if ( defined $self->dbdef_table->column('paycvv')
5246 && length($self->paycvv)
5247 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5249 my $error = $self->remove_cvv;
5251 warn "WARNING: error removing cvv: $error\n";
5259 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5271 if (ref($_[0]) eq 'HASH') {
5272 %options = %{$_[0]};
5274 my ( $method, $amount ) = ( shift, shift );
5276 $options{method} = $method;
5277 $options{amount} = $amount;
5280 if ( $options{'fake_failure'} ) {
5281 return "Error: No error; test failure requested with fake_failure";
5285 #if ( $payment_gateway->gatewaynum ) { # agent override
5286 # $paybatch = $payment_gateway->gatewaynum. '-';
5289 #$paybatch .= "$processor:". $transaction->authorization;
5291 #$paybatch .= ':'. $transaction->order_number
5292 # if $transaction->can('order_number')
5293 # && length($transaction->order_number);
5295 my $paybatch = 'FakeProcessor:54:32';
5297 my $cust_pay = new FS::cust_pay ( {
5298 'custnum' => $self->custnum,
5299 'invnum' => $options{'invnum'},
5300 'paid' => $options{amount},
5302 'payby' => $bop_method2payby{$options{method}},
5303 #'payinfo' => $payinfo,
5304 'payinfo' => '4111111111111111',
5305 'paybatch' => $paybatch,
5306 #'paydate' => $paydate,
5307 'paydate' => '2012-05-01',
5309 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5311 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5314 $cust_pay->invnum(''); #try again with no specific invnum
5315 my $error2 = $cust_pay->insert( $options{'manual'} ?
5316 ( 'manual' => 1 ) : ()
5319 # gah, even with transactions.
5320 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5321 "error inserting (fake!) payment: $error2".
5322 " (previously tried insert with invnum #$options{'invnum'}" .
5329 if ( $options{'paynum_ref'} ) {
5330 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5333 return ''; #no error
5338 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5340 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5341 # phone bill transaction.
5343 sub _realtime_bop_result {
5344 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5346 warn "$me _realtime_bop_result: pending transaction ".
5347 $cust_pay_pending->paypendingnum. "\n";
5348 warn " $_ => $options{$_}\n" foreach keys %options;
5351 my $payment_gateway = $options{payment_gateway}
5352 or return "no payment gateway in arguments to _realtime_bop_result";
5354 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5355 my $cpp_captured_err = $cust_pay_pending->replace;
5356 return $cpp_captured_err if $cpp_captured_err;
5358 if ( $transaction->is_success() ) {
5361 if ( $payment_gateway->gatewaynum ) { # agent override
5362 $paybatch = $payment_gateway->gatewaynum. '-';
5365 $paybatch .= $payment_gateway->gateway_module. ":".
5366 $transaction->authorization;
5368 $paybatch .= ':'. $transaction->order_number
5369 if $transaction->can('order_number')
5370 && length($transaction->order_number);
5372 my $cust_pay = new FS::cust_pay ( {
5373 'custnum' => $self->custnum,
5374 'invnum' => $options{'invnum'},
5375 'paid' => $cust_pay_pending->paid,
5377 'payby' => $cust_pay_pending->payby,
5378 #'payinfo' => $payinfo,
5379 'paybatch' => $paybatch,
5380 'paydate' => $cust_pay_pending->paydate,
5381 'pkgnum' => $cust_pay_pending->pkgnum,
5383 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5384 $cust_pay->payunique( $options{payunique} )
5385 if defined($options{payunique}) && length($options{payunique});
5387 my $oldAutoCommit = $FS::UID::AutoCommit;
5388 local $FS::UID::AutoCommit = 0;
5391 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5393 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5396 $cust_pay->invnum(''); #try again with no specific invnum
5397 my $error2 = $cust_pay->insert( $options{'manual'} ?
5398 ( 'manual' => 1 ) : ()
5401 # gah. but at least we have a record of the state we had to abort in
5402 # from cust_pay_pending now.
5403 my $e = "WARNING: $options{method} captured but payment not recorded -".
5404 " error inserting payment (". $payment_gateway->gateway_module.
5406 " (previously tried insert with invnum #$options{'invnum'}" .
5407 ": $error ) - pending payment saved as paypendingnum ".
5408 $cust_pay_pending->paypendingnum. "\n";
5414 my $jobnum = $cust_pay_pending->jobnum;
5416 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5418 unless ( $placeholder ) {
5419 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5420 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5421 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5426 $error = $placeholder->delete;
5429 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5430 my $e = "WARNING: $options{method} captured but could not delete ".
5431 "job $jobnum for paypendingnum ".
5432 $cust_pay_pending->paypendingnum. ": $error\n";
5439 if ( $options{'paynum_ref'} ) {
5440 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5443 $cust_pay_pending->status('done');
5444 $cust_pay_pending->statustext('captured');
5445 $cust_pay_pending->paynum($cust_pay->paynum);
5446 my $cpp_done_err = $cust_pay_pending->replace;
5448 if ( $cpp_done_err ) {
5450 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5451 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5452 "error updating status for paypendingnum ".
5453 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5459 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5460 return ''; #no error
5466 my $perror = $payment_gateway->gateway_module. " error: ".
5467 $transaction->error_message;
5469 my $jobnum = $cust_pay_pending->jobnum;
5471 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5473 if ( $placeholder ) {
5474 my $error = $placeholder->depended_delete;
5475 $error ||= $placeholder->delete;
5476 warn "error removing provisioning jobs after declined paypendingnum ".
5477 $cust_pay_pending->paypendingnum. "\n";
5479 my $e = "error finding job $jobnum for declined paypendingnum ".
5480 $cust_pay_pending->paypendingnum. "\n";
5486 unless ( $transaction->error_message ) {
5489 if ( $transaction->can('response_page') ) {
5491 'page' => ( $transaction->can('response_page')
5492 ? $transaction->response_page
5495 'code' => ( $transaction->can('response_code')
5496 ? $transaction->response_code
5499 'headers' => ( $transaction->can('response_headers')
5500 ? $transaction->response_headers
5506 "No additional debugging information available for ".
5507 $payment_gateway->gateway_module;
5510 $perror .= "No error_message returned from ".
5511 $payment_gateway->gateway_module. " -- ".
5512 ( ref($t_response) ? Dumper($t_response) : $t_response );
5516 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5517 && $conf->exists('emaildecline')
5518 && grep { $_ ne 'POST' } $self->invoicing_list
5519 && ! grep { $transaction->error_message =~ /$_/ }
5520 $conf->config('emaildecline-exclude')
5522 my @templ = $conf->config('declinetemplate');
5523 my $template = new Text::Template (
5525 SOURCE => [ map "$_\n", @templ ],
5526 ) or return "($perror) can't create template: $Text::Template::ERROR";
5527 $template->compile()
5528 or return "($perror) can't compile template: $Text::Template::ERROR";
5532 scalar( $conf->config('company_name', $self->agentnum ) ),
5533 'company_address' =>
5534 join("\n", $conf->config('company_address', $self->agentnum ) ),
5535 'error' => $transaction->error_message,
5538 my $error = send_email(
5539 'from' => $conf->config('invoice_from', $self->agentnum ),
5540 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5541 'subject' => 'Your payment could not be processed',
5542 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5545 $perror .= " (also received error sending decline notification: $error)"
5550 $cust_pay_pending->status('done');
5551 $cust_pay_pending->statustext("declined: $perror");
5552 my $cpp_done_err = $cust_pay_pending->replace;
5553 if ( $cpp_done_err ) {
5554 my $e = "WARNING: $options{method} declined but pending payment not ".
5555 "resolved - error updating status for paypendingnum ".
5556 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5558 $perror = "$e ($perror)";
5566 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5568 Verifies successful third party processing of a realtime credit card,
5569 ACH (electronic check) or phone bill transaction via a
5570 Business::OnlineThirdPartyPayment realtime gateway. See
5571 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5573 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5575 The additional options I<payname>, I<city>, I<state>,
5576 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5577 if set, will override the value from the customer record.
5579 I<description> is a free-text field passed to the gateway. It defaults to
5580 "Internet services".
5582 If an I<invnum> is specified, this payment (if successful) is applied to the
5583 specified invoice. If you don't specify an I<invnum> you might want to
5584 call the B<apply_payments> method.
5586 I<quiet> can be set true to surpress email decline notices.
5588 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5589 resulting paynum, if any.
5591 I<payunique> is a unique identifier for this payment.
5593 Returns a hashref containing elements bill_error (which will be undefined
5594 upon success) and session_id of any associated session.
5598 sub realtime_botpp_capture {
5599 my( $self, $cust_pay_pending, %options ) = @_;
5601 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5602 warn " $_ => $options{$_}\n" foreach keys %options;
5605 eval "use Business::OnlineThirdPartyPayment";
5609 # select the gateway
5612 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5614 my $payment_gateway = $cust_pay_pending->gatewaynum
5615 ? qsearchs( 'payment_gateway',
5616 { gatewaynum => $cust_pay_pending->gatewaynum }
5618 : $self->agent->payment_gateway( 'method' => $method,
5619 # 'invnum' => $cust_pay_pending->invnum,
5620 # 'payinfo' => $cust_pay_pending->payinfo,
5623 $options{payment_gateway} = $payment_gateway; # for the helper subs
5629 my @invoicing_list = $self->invoicing_list_emailonly;
5630 if ( $conf->exists('emailinvoiceautoalways')
5631 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5632 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5633 push @invoicing_list, $self->all_emails;
5636 my $email = ($conf->exists('business-onlinepayment-email-override'))
5637 ? $conf->config('business-onlinepayment-email-override')
5638 : $invoicing_list[0];
5642 $content{email_customer} =
5643 ( $conf->exists('business-onlinepayment-email_customer')
5644 || $conf->exists('business-onlinepayment-email-override') );
5647 # run transaction(s)
5651 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5652 $self->_bop_options(\%options),
5655 $transaction->reference({ %options });
5657 $transaction->content(
5659 $self->_bop_auth(\%options),
5660 'action' => 'Post Authorization',
5661 'description' => $options{'description'},
5662 'amount' => $cust_pay_pending->paid,
5663 #'invoice_number' => $options{'invnum'},
5664 'customer_id' => $self->custnum,
5665 'referer' => 'http://cleanwhisker.420.am/',
5666 'reference' => $cust_pay_pending->paypendingnum,
5668 'phone' => $self->daytime || $self->night,
5670 # plus whatever is required for bogus capture avoidance
5673 $transaction->submit();
5676 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5679 bill_error => $error,
5680 session_id => $cust_pay_pending->session_id,
5685 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5689 sub default_payment_gateway {
5690 my( $self, $method ) = @_;
5692 die "Real-time processing not enabled\n"
5693 unless $conf->exists('business-onlinepayment');
5695 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5698 my $bop_config = 'business-onlinepayment';
5699 $bop_config .= '-ach'
5700 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5701 my ( $processor, $login, $password, $action, @bop_options ) =
5702 $conf->config($bop_config);
5703 $action ||= 'normal authorization';
5704 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5705 die "No real-time processor is enabled - ".
5706 "did you set the business-onlinepayment configuration value?\n"
5709 ( $processor, $login, $password, $action, @bop_options )
5714 Removes the I<paycvv> field from the database directly.
5716 If there is an error, returns the error, otherwise returns false.
5722 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5723 or return dbh->errstr;
5724 $sth->execute($self->custnum)
5725 or return $sth->errstr;
5730 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5732 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5733 via a Business::OnlinePayment realtime gateway. See
5734 L<http://420.am/business-onlinepayment> for supported gateways.
5736 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5738 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5740 Most gateways require a reference to an original payment transaction to refund,
5741 so you probably need to specify a I<paynum>.
5743 I<amount> defaults to the original amount of the payment if not specified.
5745 I<reason> specifies a reason for the refund.
5747 I<paydate> specifies the expiration date for a credit card overriding the
5748 value from the customer record or the payment record. Specified as yyyy-mm-dd
5750 Implementation note: If I<amount> is unspecified or equal to the amount of the
5751 orignal payment, first an attempt is made to "void" the transaction via
5752 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5753 the normal attempt is made to "refund" ("credit") the transaction via the
5754 gateway is attempted.
5756 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5757 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5758 #if set, will override the value from the customer record.
5760 #If an I<invnum> is specified, this payment (if successful) is applied to the
5761 #specified invoice. If you don't specify an I<invnum> you might want to
5762 #call the B<apply_payments> method.
5766 #some false laziness w/realtime_bop, not enough to make it worth merging
5767 #but some useful small subs should be pulled out
5768 sub _new_realtime_refund_bop {
5772 if (ref($_[0]) ne 'HASH') {
5773 %options = %{$_[0]};
5777 $options{method} = $method;
5781 warn "$me realtime_refund_bop (new): $options{method} refund\n";
5782 warn " $_ => $options{$_}\n" foreach keys %options;
5786 # look up the original payment and optionally a gateway for that payment
5790 my $amount = $options{'amount'};
5792 my( $processor, $login, $password, @bop_options, $namespace ) ;
5793 my( $auth, $order_number ) = ( '', '', '' );
5795 if ( $options{'paynum'} ) {
5797 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
5798 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
5799 or return "Unknown paynum $options{'paynum'}";
5800 $amount ||= $cust_pay->paid;
5802 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
5803 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
5804 $cust_pay->paybatch;
5805 my $gatewaynum = '';
5806 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
5808 if ( $gatewaynum ) { #gateway for the payment to be refunded
5810 my $payment_gateway =
5811 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
5812 die "payment gateway $gatewaynum not found"
5813 unless $payment_gateway;
5815 $processor = $payment_gateway->gateway_module;
5816 $login = $payment_gateway->gateway_username;
5817 $password = $payment_gateway->gateway_password;
5818 $namespace = $payment_gateway->gateway_namespace;
5819 @bop_options = $payment_gateway->options;
5821 } else { #try the default gateway
5824 my $payment_gateway =
5825 $self->agent->payment_gateway('method' => $options{method});
5827 ( $conf_processor, $login, $password, $namespace ) =
5828 map { my $method = "gateway_$_"; $payment_gateway->$method }
5829 qw( module username password namespace );
5831 @bop_options = $payment_gateway->gatewaynum
5832 ? $payment_gateway->options
5833 : @{ $payment_gateway->get('options') };
5835 return "processor of payment $options{'paynum'} $processor does not".
5836 " match default processor $conf_processor"
5837 unless $processor eq $conf_processor;
5842 } else { # didn't specify a paynum, so look for agent gateway overrides
5843 # like a normal transaction
5845 my $payment_gateway =
5846 $self->agent->payment_gateway( 'method' => $options{method},
5847 #'payinfo' => $payinfo,
5849 my( $processor, $login, $password, $namespace ) =
5850 map { my $method = "gateway_$_"; $payment_gateway->$method }
5851 qw( module username password namespace );
5853 my @bop_options = $payment_gateway->gatewaynum
5854 ? $payment_gateway->options
5855 : @{ $payment_gateway->get('options') };
5858 return "neither amount nor paynum specified" unless $amount;
5860 eval "use $namespace";
5864 'type' => $options{method},
5866 'password' => $password,
5867 'order_number' => $order_number,
5868 'amount' => $amount,
5869 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
5871 $content{authorization} = $auth
5872 if length($auth); #echeck/ACH transactions have an order # but no auth
5873 #(at least with authorize.net)
5875 my $disable_void_after;
5876 if ($conf->exists('disable_void_after')
5877 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
5878 $disable_void_after = $1;
5881 #first try void if applicable
5882 if ( $cust_pay && $cust_pay->paid == $amount
5884 ( not defined($disable_void_after) )
5885 || ( time < ($cust_pay->_date + $disable_void_after ) )
5888 warn " attempting void\n" if $DEBUG > 1;
5889 my $void = new Business::OnlinePayment( $processor, @bop_options );
5890 $void->content( 'action' => 'void', %content );
5892 if ( $void->is_success ) {
5893 my $error = $cust_pay->void($options{'reason'});
5895 # gah, even with transactions.
5896 my $e = 'WARNING: Card/ACH voided but database not updated - '.
5897 "error voiding payment: $error";
5901 warn " void successful\n" if $DEBUG > 1;
5906 warn " void unsuccessful, trying refund\n"
5910 my $address = $self->address1;
5911 $address .= ", ". $self->address2 if $self->address2;
5913 my($payname, $payfirst, $paylast);
5914 if ( $self->payname && $options{method} ne 'ECHECK' ) {
5915 $payname = $self->payname;
5916 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5917 or return "Illegal payname $payname";
5918 ($payfirst, $paylast) = ($1, $2);
5920 $payfirst = $self->getfield('first');
5921 $paylast = $self->getfield('last');
5922 $payname = "$payfirst $paylast";
5925 my @invoicing_list = $self->invoicing_list_emailonly;
5926 if ( $conf->exists('emailinvoiceautoalways')
5927 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5928 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5929 push @invoicing_list, $self->all_emails;
5932 my $email = ($conf->exists('business-onlinepayment-email-override'))
5933 ? $conf->config('business-onlinepayment-email-override')
5934 : $invoicing_list[0];
5936 my $payip = exists($options{'payip'})
5939 $content{customer_ip} = $payip
5943 if ( $options{method} eq 'CC' ) {
5946 $content{card_number} = $payinfo = $cust_pay->payinfo;
5947 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
5948 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
5949 ($content{expiration} = "$2/$1"); # where available
5951 $content{card_number} = $payinfo = $self->payinfo;
5952 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
5953 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5954 $content{expiration} = "$2/$1";
5957 } elsif ( $options{method} eq 'ECHECK' ) {
5960 $payinfo = $cust_pay->payinfo;
5962 $payinfo = $self->payinfo;
5964 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
5965 $content{bank_name} = $self->payname;
5966 $content{account_type} = 'CHECKING';
5967 $content{account_name} = $payname;
5968 $content{customer_org} = $self->company ? 'B' : 'I';
5969 $content{customer_ssn} = $self->ss;
5970 } elsif ( $options{method} eq 'LEC' ) {
5971 $content{phone} = $payinfo = $self->payinfo;
5975 my $refund = new Business::OnlinePayment( $processor, @bop_options );
5976 my %sub_content = $refund->content(
5977 'action' => 'credit',
5978 'customer_id' => $self->custnum,
5979 'last_name' => $paylast,
5980 'first_name' => $payfirst,
5982 'address' => $address,
5983 'city' => $self->city,
5984 'state' => $self->state,
5985 'zip' => $self->zip,
5986 'country' => $self->country,
5988 'phone' => $self->daytime || $self->night,
5991 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
5995 return "$processor error: ". $refund->error_message
5996 unless $refund->is_success();
5998 my $paybatch = "$processor:". $refund->authorization;
5999 $paybatch .= ':'. $refund->order_number
6000 if $refund->can('order_number') && $refund->order_number;
6002 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
6003 my @cust_bill_pay = $cust_pay->cust_bill_pay;
6004 last unless @cust_bill_pay;
6005 my $cust_bill_pay = pop @cust_bill_pay;
6006 my $error = $cust_bill_pay->delete;
6010 my $cust_refund = new FS::cust_refund ( {
6011 'custnum' => $self->custnum,
6012 'paynum' => $options{'paynum'},
6013 'refund' => $amount,
6015 'payby' => $bop_method2payby{$options{method}},
6016 'payinfo' => $payinfo,
6017 'paybatch' => $paybatch,
6018 'reason' => $options{'reason'} || 'card or ACH refund',
6020 my $error = $cust_refund->insert;
6022 $cust_refund->paynum(''); #try again with no specific paynum
6023 my $error2 = $cust_refund->insert;
6025 # gah, even with transactions.
6026 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
6027 "error inserting refund ($processor): $error2".
6028 " (previously tried insert with paynum #$options{'paynum'}" .
6039 =item batch_card OPTION => VALUE...
6041 Adds a payment for this invoice to the pending credit card batch (see
6042 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
6043 runs the payment using a realtime gateway.
6048 my ($self, %options) = @_;
6051 if (exists($options{amount})) {
6052 $amount = $options{amount};
6054 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
6056 return '' unless $amount > 0;
6058 my $invnum = delete $options{invnum};
6059 my $payby = $options{invnum} || $self->payby; #dubious
6061 if ($options{'realtime'}) {
6062 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
6068 my $oldAutoCommit = $FS::UID::AutoCommit;
6069 local $FS::UID::AutoCommit = 0;
6072 #this needs to handle mysql as well as Pg, like svc_acct.pm
6073 #(make it into a common function if folks need to do batching with mysql)
6074 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
6075 or return "Cannot lock pay_batch: " . $dbh->errstr;
6079 'payby' => FS::payby->payby2payment($payby),
6082 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
6084 unless ( $pay_batch ) {
6085 $pay_batch = new FS::pay_batch \%pay_batch;
6086 my $error = $pay_batch->insert;
6088 $dbh->rollback if $oldAutoCommit;
6089 die "error creating new batch: $error\n";
6093 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
6094 'batchnum' => $pay_batch->batchnum,
6095 'custnum' => $self->custnum,
6098 foreach (qw( address1 address2 city state zip country payby payinfo paydate
6100 $options{$_} = '' unless exists($options{$_});
6103 my $cust_pay_batch = new FS::cust_pay_batch ( {
6104 'batchnum' => $pay_batch->batchnum,
6105 'invnum' => $invnum || 0, # is there a better value?
6106 # this field should be
6108 # cust_bill_pay_batch now
6109 'custnum' => $self->custnum,
6110 'last' => $self->getfield('last'),
6111 'first' => $self->getfield('first'),
6112 'address1' => $options{address1} || $self->address1,
6113 'address2' => $options{address2} || $self->address2,
6114 'city' => $options{city} || $self->city,
6115 'state' => $options{state} || $self->state,
6116 'zip' => $options{zip} || $self->zip,
6117 'country' => $options{country} || $self->country,
6118 'payby' => $options{payby} || $self->payby,
6119 'payinfo' => $options{payinfo} || $self->payinfo,
6120 'exp' => $options{paydate} || $self->paydate,
6121 'payname' => $options{payname} || $self->payname,
6122 'amount' => $amount, # consolidating
6125 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
6126 if $old_cust_pay_batch;
6129 if ($old_cust_pay_batch) {
6130 $error = $cust_pay_batch->replace($old_cust_pay_batch)
6132 $error = $cust_pay_batch->insert;
6136 $dbh->rollback if $oldAutoCommit;
6140 my $unapplied = $self->total_unapplied_credits
6141 + $self->total_unapplied_payments
6142 + $self->in_transit_payments;
6143 foreach my $cust_bill ($self->open_cust_bill) {
6144 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6145 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6146 'invnum' => $cust_bill->invnum,
6147 'paybatchnum' => $cust_pay_batch->paybatchnum,
6148 'amount' => $cust_bill->owed,
6151 if ($unapplied >= $cust_bill_pay_batch->amount){
6152 $unapplied -= $cust_bill_pay_batch->amount;
6155 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6156 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
6158 $error = $cust_bill_pay_batch->insert;
6160 $dbh->rollback if $oldAutoCommit;
6165 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6169 =item apply_payments_and_credits
6171 Applies unapplied payments and credits.
6173 In most cases, this new method should be used in place of sequential
6174 apply_payments and apply_credits methods.
6176 If there is an error, returns the error, otherwise returns false.
6180 sub apply_payments_and_credits {
6183 local $SIG{HUP} = 'IGNORE';
6184 local $SIG{INT} = 'IGNORE';
6185 local $SIG{QUIT} = 'IGNORE';
6186 local $SIG{TERM} = 'IGNORE';
6187 local $SIG{TSTP} = 'IGNORE';
6188 local $SIG{PIPE} = 'IGNORE';
6190 my $oldAutoCommit = $FS::UID::AutoCommit;
6191 local $FS::UID::AutoCommit = 0;
6194 $self->select_for_update; #mutex
6196 foreach my $cust_bill ( $self->open_cust_bill ) {
6197 my $error = $cust_bill->apply_payments_and_credits;
6199 $dbh->rollback if $oldAutoCommit;
6200 return "Error applying: $error";
6204 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6209 =item apply_credits OPTION => VALUE ...
6211 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6212 to outstanding invoice balances in chronological order (or reverse
6213 chronological order if the I<order> option is set to B<newest>) and returns the
6214 value of any remaining unapplied credits available for refund (see
6215 L<FS::cust_refund>).
6217 Dies if there is an error.
6225 local $SIG{HUP} = 'IGNORE';
6226 local $SIG{INT} = 'IGNORE';
6227 local $SIG{QUIT} = 'IGNORE';
6228 local $SIG{TERM} = 'IGNORE';
6229 local $SIG{TSTP} = 'IGNORE';
6230 local $SIG{PIPE} = 'IGNORE';
6232 my $oldAutoCommit = $FS::UID::AutoCommit;
6233 local $FS::UID::AutoCommit = 0;
6236 $self->select_for_update; #mutex
6238 unless ( $self->total_unapplied_credits ) {
6239 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6243 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6244 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6246 my @invoices = $self->open_cust_bill;
6247 @invoices = sort { $b->_date <=> $a->_date } @invoices
6248 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6250 if ( $conf->exists('pkg-balances') ) {
6251 # limit @credits to those w/ a pkgnum grepped from $self
6253 foreach my $i (@invoices) {
6254 foreach my $li ( $i->cust_bill_pkg ) {
6255 $pkgnums{$li->pkgnum} = 1;
6258 @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6263 foreach my $cust_bill ( @invoices ) {
6265 if ( !defined($credit) || $credit->credited == 0) {
6266 $credit = pop @credits or last;
6270 if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6271 $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6273 $owed = $cust_bill->owed;
6275 unless ( $owed > 0 ) {
6276 push @credits, $credit;
6280 my $amount = min( $credit->credited, $owed );
6282 my $cust_credit_bill = new FS::cust_credit_bill ( {
6283 'crednum' => $credit->crednum,
6284 'invnum' => $cust_bill->invnum,
6285 'amount' => $amount,
6287 $cust_credit_bill->pkgnum( $credit->pkgnum )
6288 if $conf->exists('pkg-balances') && $credit->pkgnum;
6289 my $error = $cust_credit_bill->insert;
6291 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6295 redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6299 my $total_unapplied_credits = $self->total_unapplied_credits;
6301 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6303 return $total_unapplied_credits;
6306 =item apply_payments
6308 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6309 to outstanding invoice balances in chronological order.
6311 #and returns the value of any remaining unapplied payments.
6313 Dies if there is an error.
6317 sub apply_payments {
6320 local $SIG{HUP} = 'IGNORE';
6321 local $SIG{INT} = 'IGNORE';
6322 local $SIG{QUIT} = 'IGNORE';
6323 local $SIG{TERM} = 'IGNORE';
6324 local $SIG{TSTP} = 'IGNORE';
6325 local $SIG{PIPE} = 'IGNORE';
6327 my $oldAutoCommit = $FS::UID::AutoCommit;
6328 local $FS::UID::AutoCommit = 0;
6331 $self->select_for_update; #mutex
6335 my @payments = sort { $b->_date <=> $a->_date }
6336 grep { $_->unapplied > 0 }
6339 my @invoices = sort { $a->_date <=> $b->_date}
6340 grep { $_->owed > 0 }
6343 if ( $conf->exists('pkg-balances') ) {
6344 # limit @payments to those w/ a pkgnum grepped from $self
6346 foreach my $i (@invoices) {
6347 foreach my $li ( $i->cust_bill_pkg ) {
6348 $pkgnums{$li->pkgnum} = 1;
6351 @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6356 foreach my $cust_bill ( @invoices ) {
6358 if ( !defined($payment) || $payment->unapplied == 0 ) {
6359 $payment = pop @payments or last;
6363 if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6364 $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6366 $owed = $cust_bill->owed;
6368 unless ( $owed > 0 ) {
6369 push @payments, $payment;
6373 my $amount = min( $payment->unapplied, $owed );
6375 my $cust_bill_pay = new FS::cust_bill_pay ( {
6376 'paynum' => $payment->paynum,
6377 'invnum' => $cust_bill->invnum,
6378 'amount' => $amount,
6380 $cust_bill_pay->pkgnum( $payment->pkgnum )
6381 if $conf->exists('pkg-balances') && $payment->pkgnum;
6382 my $error = $cust_bill_pay->insert;
6384 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6388 redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6392 my $total_unapplied_payments = $self->total_unapplied_payments;
6394 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6396 return $total_unapplied_payments;
6401 Returns the total owed for this customer on all invoices
6402 (see L<FS::cust_bill/owed>).
6408 $self->total_owed_date(2145859200); #12/31/2037
6411 =item total_owed_date TIME
6413 Returns the total owed for this customer on all invoices with date earlier than
6414 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6415 see L<Time::Local> and L<Date::Parse> for conversion functions.
6419 sub total_owed_date {
6423 # my $custnum = $self->custnum;
6425 # my $owed_sql = FS::cust_bill->owed_sql;
6428 # SELECT SUM($owed_sql) FROM cust_bill
6429 # WHERE custnum = $custnum
6430 # AND _date <= $time
6433 # my $sth = dbh->prepare($sql) or die dbh->errstr;
6434 # $sth->execute() or die $sth->errstr;
6436 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6439 foreach my $cust_bill (
6440 grep { $_->_date <= $time }
6441 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6443 $total_bill += $cust_bill->owed;
6445 sprintf( "%.2f", $total_bill );
6449 =item total_owed_pkgnum PKGNUM
6451 Returns the total owed on all invoices for this customer's specific package
6452 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6456 sub total_owed_pkgnum {
6457 my( $self, $pkgnum ) = @_;
6458 $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6461 =item total_owed_date_pkgnum TIME PKGNUM
6463 Returns the total owed for this customer's specific package when using
6464 experimental package balances on all invoices with date earlier than
6465 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6466 see L<Time::Local> and L<Date::Parse> for conversion functions.
6470 sub total_owed_date_pkgnum {
6471 my( $self, $time, $pkgnum ) = @_;
6474 foreach my $cust_bill (
6475 grep { $_->_date <= $time }
6476 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6478 $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6480 sprintf( "%.2f", $total_bill );
6486 Returns the total amount of all payments.
6493 $total += $_->paid foreach $self->cust_pay;
6494 sprintf( "%.2f", $total );
6497 =item total_unapplied_credits
6499 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6500 customer. See L<FS::cust_credit/credited>.
6502 =item total_credited
6504 Old name for total_unapplied_credits. Don't use.
6508 sub total_credited {
6509 #carp "total_credited deprecated, use total_unapplied_credits";
6510 shift->total_unapplied_credits(@_);
6513 sub total_unapplied_credits {
6515 my $total_credit = 0;
6516 $total_credit += $_->credited foreach $self->cust_credit;
6517 sprintf( "%.2f", $total_credit );
6520 =item total_unapplied_credits_pkgnum PKGNUM
6522 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6523 customer. See L<FS::cust_credit/credited>.
6527 sub total_unapplied_credits_pkgnum {
6528 my( $self, $pkgnum ) = @_;
6529 my $total_credit = 0;
6530 $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6531 sprintf( "%.2f", $total_credit );
6535 =item total_unapplied_payments
6537 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6538 See L<FS::cust_pay/unapplied>.
6542 sub total_unapplied_payments {
6544 my $total_unapplied = 0;
6545 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6546 sprintf( "%.2f", $total_unapplied );
6549 =item total_unapplied_payments_pkgnum PKGNUM
6551 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6552 specific package when using experimental package balances. See
6553 L<FS::cust_pay/unapplied>.
6557 sub total_unapplied_payments_pkgnum {
6558 my( $self, $pkgnum ) = @_;
6559 my $total_unapplied = 0;
6560 $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6561 sprintf( "%.2f", $total_unapplied );
6565 =item total_unapplied_refunds
6567 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6568 customer. See L<FS::cust_refund/unapplied>.
6572 sub total_unapplied_refunds {
6574 my $total_unapplied = 0;
6575 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6576 sprintf( "%.2f", $total_unapplied );
6581 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6582 total_unapplied_credits minus total_unapplied_payments).
6590 + $self->total_unapplied_refunds
6591 - $self->total_unapplied_credits
6592 - $self->total_unapplied_payments
6596 =item balance_date TIME
6598 Returns the balance for this customer, only considering invoices with date
6599 earlier than TIME (total_owed_date minus total_credited minus
6600 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6601 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6610 $self->total_owed_date($time)
6611 + $self->total_unapplied_refunds
6612 - $self->total_unapplied_credits
6613 - $self->total_unapplied_payments
6617 =item balance_pkgnum PKGNUM
6619 Returns the balance for this customer's specific package when using
6620 experimental package balances (total_owed plus total_unrefunded, minus
6621 total_unapplied_credits minus total_unapplied_payments)
6625 sub balance_pkgnum {
6626 my( $self, $pkgnum ) = @_;
6629 $self->total_owed_pkgnum($pkgnum)
6630 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
6631 # + $self->total_unapplied_refunds_pkgnum($pkgnum)
6632 - $self->total_unapplied_credits_pkgnum($pkgnum)
6633 - $self->total_unapplied_payments_pkgnum($pkgnum)
6637 =item in_transit_payments
6639 Returns the total of requests for payments for this customer pending in
6640 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
6644 sub in_transit_payments {
6646 my $in_transit_payments = 0;
6647 foreach my $pay_batch ( qsearch('pay_batch', {
6650 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6651 'batchnum' => $pay_batch->batchnum,
6652 'custnum' => $self->custnum,
6654 $in_transit_payments += $cust_pay_batch->amount;
6657 sprintf( "%.2f", $in_transit_payments );
6662 Returns a hash of useful information for making a payment.
6672 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6673 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6674 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6678 For credit card transactions:
6690 For electronic check transactions:
6705 $return{balance} = $self->balance;
6707 $return{payname} = $self->payname
6708 || ( $self->first. ' '. $self->get('last') );
6710 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6712 $return{payby} = $self->payby;
6713 $return{stateid_state} = $self->stateid_state;
6715 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6716 $return{card_type} = cardtype($self->payinfo);
6717 $return{payinfo} = $self->paymask;
6719 @return{'month', 'year'} = $self->paydate_monthyear;
6723 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6724 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6725 $return{payinfo1} = $payinfo1;
6726 $return{payinfo2} = $payinfo2;
6727 $return{paytype} = $self->paytype;
6728 $return{paystate} = $self->paystate;
6732 #doubleclick protection
6734 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
6740 =item paydate_monthyear
6742 Returns a two-element list consisting of the month and year of this customer's
6743 paydate (credit card expiration date for CARD customers)
6747 sub paydate_monthyear {
6749 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
6751 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
6758 =item tax_exemption TAXNAME
6763 my( $self, $taxname ) = @_;
6765 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
6766 'taxname' => $taxname,
6771 =item cust_main_exemption
6775 sub cust_main_exemption {
6777 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
6780 =item invoicing_list [ ARRAYREF ]
6782 If an arguement is given, sets these email addresses as invoice recipients
6783 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
6784 (except as warnings), so use check_invoicing_list first.
6786 Returns a list of email addresses (with svcnum entries expanded).
6788 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
6789 check it without disturbing anything by passing nothing.
6791 This interface may change in the future.
6795 sub invoicing_list {
6796 my( $self, $arrayref ) = @_;
6799 my @cust_main_invoice;
6800 if ( $self->custnum ) {
6801 @cust_main_invoice =
6802 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6804 @cust_main_invoice = ();
6806 foreach my $cust_main_invoice ( @cust_main_invoice ) {
6807 #warn $cust_main_invoice->destnum;
6808 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
6809 #warn $cust_main_invoice->destnum;
6810 my $error = $cust_main_invoice->delete;
6811 warn $error if $error;
6814 if ( $self->custnum ) {
6815 @cust_main_invoice =
6816 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6818 @cust_main_invoice = ();
6820 my %seen = map { $_->address => 1 } @cust_main_invoice;
6821 foreach my $address ( @{$arrayref} ) {
6822 next if exists $seen{$address} && $seen{$address};
6823 $seen{$address} = 1;
6824 my $cust_main_invoice = new FS::cust_main_invoice ( {
6825 'custnum' => $self->custnum,
6828 my $error = $cust_main_invoice->insert;
6829 warn $error if $error;
6833 if ( $self->custnum ) {
6835 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6842 =item check_invoicing_list ARRAYREF
6844 Checks these arguements as valid input for the invoicing_list method. If there
6845 is an error, returns the error, otherwise returns false.
6849 sub check_invoicing_list {
6850 my( $self, $arrayref ) = @_;
6852 foreach my $address ( @$arrayref ) {
6854 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
6855 return 'Can\'t add FAX invoice destination with a blank FAX number.';
6858 my $cust_main_invoice = new FS::cust_main_invoice ( {
6859 'custnum' => $self->custnum,
6862 my $error = $self->custnum
6863 ? $cust_main_invoice->check
6864 : $cust_main_invoice->checkdest
6866 return $error if $error;
6870 return "Email address required"
6871 if $conf->exists('cust_main-require_invoicing_list_email')
6872 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
6877 =item set_default_invoicing_list
6879 Sets the invoicing list to all accounts associated with this customer,
6880 overwriting any previous invoicing list.
6884 sub set_default_invoicing_list {
6886 $self->invoicing_list($self->all_emails);
6891 Returns the email addresses of all accounts provisioned for this customer.
6898 foreach my $cust_pkg ( $self->all_pkgs ) {
6899 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
6901 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6902 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6904 $list{$_}=1 foreach map { $_->email } @svc_acct;
6909 =item invoicing_list_addpost
6911 Adds postal invoicing to this customer. If this customer is already configured
6912 to receive postal invoices, does nothing.
6916 sub invoicing_list_addpost {
6918 return if grep { $_ eq 'POST' } $self->invoicing_list;
6919 my @invoicing_list = $self->invoicing_list;
6920 push @invoicing_list, 'POST';
6921 $self->invoicing_list(\@invoicing_list);
6924 =item invoicing_list_emailonly
6926 Returns the list of email invoice recipients (invoicing_list without non-email
6927 destinations such as POST and FAX).
6931 sub invoicing_list_emailonly {
6933 warn "$me invoicing_list_emailonly called"
6935 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
6938 =item invoicing_list_emailonly_scalar
6940 Returns the list of email invoice recipients (invoicing_list without non-email
6941 destinations such as POST and FAX) as a comma-separated scalar.
6945 sub invoicing_list_emailonly_scalar {
6947 warn "$me invoicing_list_emailonly_scalar called"
6949 join(', ', $self->invoicing_list_emailonly);
6952 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
6954 Returns an array of customers referred by this customer (referral_custnum set
6955 to this custnum). If DEPTH is given, recurses up to the given depth, returning
6956 customers referred by customers referred by this customer and so on, inclusive.
6957 The default behavior is DEPTH 1 (no recursion).
6961 sub referral_cust_main {
6963 my $depth = @_ ? shift : 1;
6964 my $exclude = @_ ? shift : {};
6967 map { $exclude->{$_->custnum}++; $_; }
6968 grep { ! $exclude->{ $_->custnum } }
6969 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
6973 map { $_->referral_cust_main($depth-1, $exclude) }
6980 =item referral_cust_main_ncancelled
6982 Same as referral_cust_main, except only returns customers with uncancelled
6987 sub referral_cust_main_ncancelled {
6989 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
6992 =item referral_cust_pkg [ DEPTH ]
6994 Like referral_cust_main, except returns a flat list of all unsuspended (and
6995 uncancelled) packages for each customer. The number of items in this list may
6996 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
7000 sub referral_cust_pkg {
7002 my $depth = @_ ? shift : 1;
7004 map { $_->unsuspended_pkgs }
7005 grep { $_->unsuspended_pkgs }
7006 $self->referral_cust_main($depth);
7009 =item referring_cust_main
7011 Returns the single cust_main record for the customer who referred this customer
7012 (referral_custnum), or false.
7016 sub referring_cust_main {
7018 return '' unless $self->referral_custnum;
7019 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7022 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
7024 Applies a credit to this customer. If there is an error, returns the error,
7025 otherwise returns false.
7027 REASON can be a text string, an FS::reason object, or a scalar reference to
7028 a reasonnum. If a text string, it will be automatically inserted as a new
7029 reason, and a 'reason_type' option must be passed to indicate the
7030 FS::reason_type for the new reason.
7032 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
7034 Any other options are passed to FS::cust_credit::insert.
7039 my( $self, $amount, $reason, %options ) = @_;
7041 my $cust_credit = new FS::cust_credit {
7042 'custnum' => $self->custnum,
7043 'amount' => $amount,
7046 if ( ref($reason) ) {
7048 if ( ref($reason) eq 'SCALAR' ) {
7049 $cust_credit->reasonnum( $$reason );
7051 $cust_credit->reasonnum( $reason->reasonnum );
7055 $cust_credit->set('reason', $reason)
7058 $cust_credit->addlinfo( delete $options{'addlinfo'} )
7059 if exists($options{'addlinfo'});
7061 $cust_credit->insert(%options);
7065 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
7067 Creates a one-time charge for this customer. If there is an error, returns
7068 the error, otherwise returns false.
7070 New-style, with a hashref of options:
7072 my $error = $cust_main->charge(
7076 'start_date' => str2time('7/4/2009'),
7077 'pkg' => 'Description',
7078 'comment' => 'Comment',
7079 'additional' => [], #extra invoice detail
7080 'classnum' => 1, #pkg_class
7082 'setuptax' => '', # or 'Y' for tax exempt
7085 'taxclass' => 'Tax class',
7088 'taxproduct' => 2, #part_pkg_taxproduct
7089 'override' => {}, #XXX describe
7095 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
7101 my ( $amount, $quantity, $start_date, $classnum );
7102 my ( $pkg, $comment, $additional );
7103 my ( $setuptax, $taxclass ); #internal taxes
7104 my ( $taxproduct, $override ); #vendor (CCH) taxes
7105 if ( ref( $_[0] ) ) {
7106 $amount = $_[0]->{amount};
7107 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
7108 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
7109 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
7110 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
7111 : '$'. sprintf("%.2f",$amount);
7112 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
7113 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
7114 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
7115 $additional = $_[0]->{additional} || [];
7116 $taxproduct = $_[0]->{taxproductnum};
7117 $override = { '' => $_[0]->{tax_override} };
7122 $pkg = @_ ? shift : 'One-time charge';
7123 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
7125 $taxclass = @_ ? shift : '';
7129 local $SIG{HUP} = 'IGNORE';
7130 local $SIG{INT} = 'IGNORE';
7131 local $SIG{QUIT} = 'IGNORE';
7132 local $SIG{TERM} = 'IGNORE';
7133 local $SIG{TSTP} = 'IGNORE';
7134 local $SIG{PIPE} = 'IGNORE';
7136 my $oldAutoCommit = $FS::UID::AutoCommit;
7137 local $FS::UID::AutoCommit = 0;
7140 my $part_pkg = new FS::part_pkg ( {
7142 'comment' => $comment,
7146 'classnum' => $classnum ? $classnum : '',
7147 'setuptax' => $setuptax,
7148 'taxclass' => $taxclass,
7149 'taxproductnum' => $taxproduct,
7152 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7153 ( 0 .. @$additional - 1 )
7155 'additional_count' => scalar(@$additional),
7156 'setup_fee' => $amount,
7159 my $error = $part_pkg->insert( options => \%options,
7160 tax_overrides => $override,
7163 $dbh->rollback if $oldAutoCommit;
7167 my $pkgpart = $part_pkg->pkgpart;
7168 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7169 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7170 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7171 $error = $type_pkgs->insert;
7173 $dbh->rollback if $oldAutoCommit;
7178 my $cust_pkg = new FS::cust_pkg ( {
7179 'custnum' => $self->custnum,
7180 'pkgpart' => $pkgpart,
7181 'quantity' => $quantity,
7182 'start_date' => $start_date,
7185 $error = $cust_pkg->insert;
7187 $dbh->rollback if $oldAutoCommit;
7191 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7196 #=item charge_postal_fee
7198 #Applies a one time charge this customer. If there is an error,
7199 #returns the error, returns the cust_pkg charge object or false
7200 #if there was no charge.
7204 # This should be a customer event. For that to work requires that bill
7205 # also be a customer event.
7207 sub charge_postal_fee {
7210 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7211 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7213 my $cust_pkg = new FS::cust_pkg ( {
7214 'custnum' => $self->custnum,
7215 'pkgpart' => $pkgpart,
7219 my $error = $cust_pkg->insert;
7220 $error ? $error : $cust_pkg;
7225 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7231 sort { $a->_date <=> $b->_date }
7232 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7235 =item open_cust_bill
7237 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7242 sub open_cust_bill {
7246 'table' => 'cust_bill',
7247 'hashref' => { 'custnum' => $self->custnum, },
7248 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7249 'order_by' => 'ORDER BY _date ASC',
7256 Returns all the credits (see L<FS::cust_credit>) for this customer.
7262 sort { $a->_date <=> $b->_date }
7263 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7266 =item cust_credit_pkgnum
7268 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7269 package when using experimental package balances.
7273 sub cust_credit_pkgnum {
7274 my( $self, $pkgnum ) = @_;
7275 sort { $a->_date <=> $b->_date }
7276 qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7277 'pkgnum' => $pkgnum,
7284 Returns all the payments (see L<FS::cust_pay>) for this customer.
7290 sort { $a->_date <=> $b->_date }
7291 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7294 =item cust_pay_pkgnum
7296 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7297 package when using experimental package balances.
7301 sub cust_pay_pkgnum {
7302 my( $self, $pkgnum ) = @_;
7303 sort { $a->_date <=> $b->_date }
7304 qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7305 'pkgnum' => $pkgnum,
7312 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7318 sort { $a->_date <=> $b->_date }
7319 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7322 =item cust_pay_batch
7324 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7328 sub cust_pay_batch {
7330 sort { $a->paybatchnum <=> $b->paybatchnum }
7331 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7334 =item cust_pay_pending
7336 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7337 (without status "done").
7341 sub cust_pay_pending {
7343 return $self->num_cust_pay_pending unless wantarray;
7344 sort { $a->_date <=> $b->_date }
7345 qsearch( 'cust_pay_pending', {
7346 'custnum' => $self->custnum,
7347 'status' => { op=>'!=', value=>'done' },
7352 =item num_cust_pay_pending
7354 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7355 customer (without status "done"). Also called automatically when the
7356 cust_pay_pending method is used in a scalar context.
7360 sub num_cust_pay_pending {
7362 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7363 " WHERE custnum = ? AND status != 'done' ";
7364 my $sth = dbh->prepare($sql) or die dbh->errstr;
7365 $sth->execute($self->custnum) or die $sth->errstr;
7366 $sth->fetchrow_arrayref->[0];
7371 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7377 sort { $a->_date <=> $b->_date }
7378 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7381 =item display_custnum
7383 Returns the displayed customer number for this customer: agent_custid if
7384 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7388 sub display_custnum {
7390 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7391 return $self->agent_custid;
7393 return $self->custnum;
7399 Returns a name string for this customer, either "Company (Last, First)" or
7406 my $name = $self->contact;
7407 $name = $self->company. " ($name)" if $self->company;
7413 Returns a name string for this (service/shipping) contact, either
7414 "Company (Last, First)" or "Last, First".
7420 if ( $self->get('ship_last') ) {
7421 my $name = $self->ship_contact;
7422 $name = $self->ship_company. " ($name)" if $self->ship_company;
7431 Returns a name string for this customer, either "Company" or "First Last".
7437 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7440 =item ship_name_short
7442 Returns a name string for this (service/shipping) contact, either "Company"
7447 sub ship_name_short {
7449 if ( $self->get('ship_last') ) {
7450 $self->ship_company !~ /^\s*$/
7451 ? $self->ship_company
7452 : $self->ship_contact_firstlast;
7454 $self->name_company_or_firstlast;
7460 Returns this customer's full (billing) contact name only, "Last, First"
7466 $self->get('last'). ', '. $self->first;
7471 Returns this customer's full (shipping) contact name only, "Last, First"
7477 $self->get('ship_last')
7478 ? $self->get('ship_last'). ', '. $self->ship_first
7482 =item contact_firstlast
7484 Returns this customers full (billing) contact name only, "First Last".
7488 sub contact_firstlast {
7490 $self->first. ' '. $self->get('last');
7493 =item ship_contact_firstlast
7495 Returns this customer's full (shipping) contact name only, "First Last".
7499 sub ship_contact_firstlast {
7501 $self->get('ship_last')
7502 ? $self->first. ' '. $self->get('ship_last')
7503 : $self->contact_firstlast;
7508 Returns this customer's full country name
7514 code2country($self->country);
7517 =item geocode DATA_VENDOR
7519 Returns a value for the customer location as encoded by DATA_VENDOR.
7520 Currently this only makes sense for "CCH" as DATA_VENDOR.
7525 my ($self, $data_vendor) = (shift, shift); #always cch for now
7527 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7528 return $geocode if $geocode;
7530 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7534 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7535 if $self->country eq 'US';
7537 #CCH specific location stuff
7538 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7540 my @cust_tax_location =
7542 'table' => 'cust_tax_location',
7543 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7544 'extra_sql' => $extra_sql,
7545 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
7548 $geocode = $cust_tax_location[0]->geocode
7549 if scalar(@cust_tax_location);
7558 Returns a status string for this customer, currently:
7562 =item prospect - No packages have ever been ordered
7564 =item active - One or more recurring packages is active
7566 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7568 =item suspended - All non-cancelled recurring packages are suspended
7570 =item cancelled - All recurring packages are cancelled
7576 sub status { shift->cust_status(@_); }
7580 for my $status (qw( prospect active inactive suspended cancelled )) {
7581 my $method = $status.'_sql';
7582 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7583 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7584 $sth->execute( ($self->custnum) x $numnum )
7585 or die "Error executing 'SELECT $sql': ". $sth->errstr;
7586 return $status if $sth->fetchrow_arrayref->[0];
7590 =item ucfirst_cust_status
7592 =item ucfirst_status
7594 Returns the status with the first character capitalized.
7598 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7600 sub ucfirst_cust_status {
7602 ucfirst($self->cust_status);
7607 Returns a hex triplet color string for this customer's status.
7611 use vars qw(%statuscolor);
7612 tie %statuscolor, 'Tie::IxHash',
7613 'prospect' => '7e0079', #'000000', #black? naw, purple
7614 'active' => '00CC00', #green
7615 'inactive' => '0000CC', #blue
7616 'suspended' => 'FF9900', #yellow
7617 'cancelled' => 'FF0000', #red
7620 sub statuscolor { shift->cust_statuscolor(@_); }
7622 sub cust_statuscolor {
7624 $statuscolor{$self->cust_status};
7629 Returns an array of hashes representing the customer's RT tickets.
7636 my $num = $conf->config('cust_main-max_tickets') || 10;
7639 if ( $conf->config('ticket_system') ) {
7640 unless ( $conf->config('ticket_system-custom_priority_field') ) {
7642 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
7646 foreach my $priority (
7647 $conf->config('ticket_system-custom_priority_field-values'), ''
7649 last if scalar(@tickets) >= $num;
7651 @{ FS::TicketSystem->customer_tickets( $self->custnum,
7652 $num - scalar(@tickets),
7662 # Return services representing svc_accts in customer support packages
7663 sub support_services {
7665 my %packages = map { $_ => 1 } $conf->config('support_packages');
7667 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
7668 grep { $_->part_svc->svcdb eq 'svc_acct' }
7669 map { $_->cust_svc }
7670 grep { exists $packages{ $_->pkgpart } }
7671 $self->ncancelled_pkgs;
7675 # Return a list of latitude/longitude for one of the services (if any)
7676 sub service_coordinates {
7680 grep { $_->latitude && $_->longitude }
7682 map { $_->cust_svc }
7683 $self->ncancelled_pkgs;
7685 scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
7690 =head1 CLASS METHODS
7696 Class method that returns the list of possible status strings for customers
7697 (see L<the status method|/status>). For example:
7699 @statuses = FS::cust_main->statuses();
7704 #my $self = shift; #could be class...
7710 Returns an SQL expression identifying prospective cust_main records (customers
7711 with no packages ever ordered)
7715 use vars qw($select_count_pkgs);
7716 $select_count_pkgs =
7717 "SELECT COUNT(*) FROM cust_pkg
7718 WHERE cust_pkg.custnum = cust_main.custnum";
7720 sub select_count_pkgs_sql {
7724 sub prospect_sql { "
7725 0 = ( $select_count_pkgs )
7730 Returns an SQL expression identifying active cust_main records (customers with
7731 active recurring packages).
7736 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
7742 Returns an SQL expression identifying inactive cust_main records (customers with
7743 no active recurring packages, but otherwise unsuspended/uncancelled).
7747 sub inactive_sql { "
7748 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7750 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7756 Returns an SQL expression identifying suspended cust_main records.
7761 sub suspended_sql { susp_sql(@_); }
7763 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
7765 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7771 Returns an SQL expression identifying cancelled cust_main records.
7775 sub cancelled_sql { cancel_sql(@_); }
7778 my $recurring_sql = FS::cust_pkg->recurring_sql;
7779 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
7782 0 < ( $select_count_pkgs )
7783 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
7784 AND 0 = ( $select_count_pkgs AND $recurring_sql
7785 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
7787 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7793 =item uncancelled_sql
7795 Returns an SQL expression identifying un-cancelled cust_main records.
7799 sub uncancelled_sql { uncancel_sql(@_); }
7800 sub uncancel_sql { "
7801 ( 0 < ( $select_count_pkgs
7802 AND ( cust_pkg.cancel IS NULL
7803 OR cust_pkg.cancel = 0
7806 OR 0 = ( $select_count_pkgs )
7812 Returns an SQL fragment to retreive the balance.
7817 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
7818 WHERE cust_bill.custnum = cust_main.custnum )
7819 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
7820 WHERE cust_pay.custnum = cust_main.custnum )
7821 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
7822 WHERE cust_credit.custnum = cust_main.custnum )
7823 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
7824 WHERE cust_refund.custnum = cust_main.custnum )
7827 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7829 Returns an SQL fragment to retreive the balance for this customer, only
7830 considering invoices with date earlier than START_TIME, and optionally not
7831 later than END_TIME (total_owed_date minus total_unapplied_credits minus
7832 total_unapplied_payments).
7834 Times are specified as SQL fragments or numeric
7835 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7836 L<Date::Parse> for conversion functions. The empty string can be passed
7837 to disable that time constraint completely.
7839 Available options are:
7843 =item unapplied_date
7845 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)
7850 set to true to remove all customer comparison clauses, for totals
7855 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
7860 JOIN clause (typically used with the total option)
7866 sub balance_date_sql {
7867 my( $class, $start, $end, %opt ) = @_;
7869 my $owed = FS::cust_bill->owed_sql;
7870 my $unapp_refund = FS::cust_refund->unapplied_sql;
7871 my $unapp_credit = FS::cust_credit->unapplied_sql;
7872 my $unapp_pay = FS::cust_pay->unapplied_sql;
7874 my $j = $opt{'join'} || '';
7876 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
7877 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
7878 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
7879 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
7881 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
7882 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
7883 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
7884 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
7889 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
7891 Returns an SQL fragment to retreive the total unapplied payments for this
7892 customer, only considering invoices with date earlier than START_TIME, and
7893 optionally not later than END_TIME.
7895 Times are specified as SQL fragments or numeric
7896 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7897 L<Date::Parse> for conversion functions. The empty string can be passed
7898 to disable that time constraint completely.
7900 Available options are:
7904 sub unapplied_payments_date_sql {
7905 my( $class, $start, $end, ) = @_;
7907 my $unapp_pay = FS::cust_pay->unapplied_sql;
7909 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
7910 'unapplied_date'=>1 );
7912 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
7915 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7917 Helper method for balance_date_sql; name (and usage) subject to change
7918 (suggestions welcome).
7920 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
7921 cust_refund, cust_credit or cust_pay).
7923 If TABLE is "cust_bill" or the unapplied_date option is true, only
7924 considers records with date earlier than START_TIME, and optionally not
7925 later than END_TIME .
7929 sub _money_table_where {
7930 my( $class, $table, $start, $end, %opt ) = @_;
7933 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
7934 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
7935 push @where, "$table._date <= $start" if defined($start) && length($start);
7936 push @where, "$table._date > $end" if defined($end) && length($end);
7938 push @where, @{$opt{'where'}} if $opt{'where'};
7939 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
7945 =item search_sql HASHREF
7949 Returns a qsearch hash expression to search for parameters specified in HREF.
7950 Valid parameters are
7958 =item cancelled_pkgs
7964 listref of start date, end date
7970 =item current_balance
7972 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
7976 =item flattened_pkgs
7985 my ($class, $params) = @_;
7996 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
7998 "cust_main.agentnum = $1";
8005 #prospect active inactive suspended cancelled
8006 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
8007 my $method = $params->{'status'}. '_sql';
8008 #push @where, $class->$method();
8009 push @where, FS::cust_main->$method();
8013 # parse cancelled package checkbox
8018 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
8019 unless $params->{'cancelled_pkgs'};
8022 # parse without census tract checkbox
8025 push @where, "(censustract = '' or censustract is null)"
8026 if $params->{'no_censustract'};
8032 foreach my $field (qw( signupdate )) {
8034 next unless exists($params->{$field});
8036 my($beginning, $ending) = @{$params->{$field}};
8039 "cust_main.$field IS NOT NULL",
8040 "cust_main.$field >= $beginning",
8041 "cust_main.$field <= $ending";
8043 $orderby ||= "ORDER BY cust_main.$field";
8051 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8053 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
8060 #my $balance_sql = $class->balance_sql();
8061 my $balance_sql = FS::cust_main->balance_sql();
8063 push @where, map { s/current_balance/$balance_sql/; $_ }
8064 @{ $params->{'current_balance'} };
8070 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8072 "cust_main.custbatch = '$1'";
8076 # setup queries, subs, etc. for the search
8079 $orderby ||= 'ORDER BY custnum';
8081 # here is the agent virtualization
8082 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8084 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8086 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
8088 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8090 my $select = join(', ',
8091 'cust_main.custnum',
8092 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8095 my(@extra_headers) = ();
8096 my(@extra_fields) = ();
8098 if ($params->{'flattened_pkgs'}) {
8100 if ($dbh->{Driver}->{Name} eq 'Pg') {
8102 $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";
8104 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8105 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8106 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8108 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8109 "omitting packing information from report.";
8112 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";
8114 my $sth = dbh->prepare($header_query) or die dbh->errstr;
8115 $sth->execute() or die $sth->errstr;
8116 my $headerrow = $sth->fetchrow_arrayref;
8117 my $headercount = $headerrow ? $headerrow->[0] : 0;
8118 while($headercount) {
8119 unshift @extra_headers, "Package ". $headercount;
8120 unshift @extra_fields, eval q!sub {my $c = shift;
8121 my @a = split '\|', $c->magic;
8122 my $p = $a[!.--$headercount. q!];
8130 'table' => 'cust_main',
8131 'select' => $select,
8133 'extra_sql' => $extra_sql,
8134 'order_by' => $orderby,
8135 'count_query' => $count_query,
8136 'extra_headers' => \@extra_headers,
8137 'extra_fields' => \@extra_fields,
8142 =item email_search_sql HASHREF
8146 Emails a notice to the specified customers.
8148 Valid parameters are those of the L<search_sql> method, plus the following:
8170 Optional job queue job for status updates.
8174 Returns an error message, or false for success.
8176 If an error occurs during any email, stops the enture send and returns that
8177 error. Presumably if you're getting SMTP errors aborting is better than
8178 retrying everything.
8182 sub email_search_sql {
8183 my($class, $params) = @_;
8185 my $from = delete $params->{from};
8186 my $subject = delete $params->{subject};
8187 my $html_body = delete $params->{html_body};
8188 my $text_body = delete $params->{text_body};
8190 my $job = delete $params->{'job'};
8192 my $sql_query = $class->search_sql($params);
8194 my $count_query = delete($sql_query->{'count_query'});
8195 my $count_sth = dbh->prepare($count_query)
8196 or die "Error preparing $count_query: ". dbh->errstr;
8198 or die "Error executing $count_query: ". $count_sth->errstr;
8199 my $count_arrayref = $count_sth->fetchrow_arrayref;
8200 my $num_cust = $count_arrayref->[0];
8202 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8203 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
8206 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8208 #eventually order+limit magic to reduce memory use?
8209 foreach my $cust_main ( qsearch($sql_query) ) {
8211 my $to = $cust_main->invoicing_list_emailonly_scalar;
8214 my $error = send_email(
8218 'subject' => $subject,
8219 'html_body' => $html_body,
8220 'text_body' => $text_body,
8223 return $error if $error;
8225 if ( $job ) { #progressbar foo
8227 if ( time - $min_sec > $last ) {
8228 my $error = $job->update_statustext(
8229 int( 100 * $num / $num_cust )
8231 die $error if $error;
8241 use Storable qw(thaw);
8244 sub process_email_search_sql {
8246 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8248 my $param = thaw(decode_base64(shift));
8249 warn Dumper($param) if $DEBUG;
8251 $param->{'job'} = $job;
8253 my $error = FS::cust_main->email_search_sql( $param );
8254 die $error if $error;
8258 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8260 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8261 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
8262 appropriate ship_ field is also searched).
8264 Additional options are the same as FS::Record::qsearch
8269 my( $self, $fuzzy, $hash, @opt) = @_;
8274 check_and_rebuild_fuzzyfiles();
8275 foreach my $field ( keys %$fuzzy ) {
8277 my $all = $self->all_X($field);
8278 next unless scalar(@$all);
8281 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8284 foreach ( keys %match ) {
8285 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8286 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8289 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8292 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8294 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8302 Returns a masked version of the named field
8307 my ($self,$field) = @_;
8311 'x'x(length($self->getfield($field))-4).
8312 substr($self->getfield($field), (length($self->getfield($field))-4));
8322 =item smart_search OPTION => VALUE ...
8324 Accepts the following options: I<search>, the string to search for. The string
8325 will be searched for as a customer number, phone number, name or company name,
8326 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8327 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8328 skip fuzzy matching when an exact match is found.
8330 Any additional options are treated as an additional qualifier on the search
8333 Returns a (possibly empty) array of FS::cust_main objects.
8340 #here is the agent virtualization
8341 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8345 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8346 my $search = delete $options{'search'};
8347 ( my $alphanum_search = $search ) =~ s/\W//g;
8349 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8351 #false laziness w/Record::ut_phone
8352 my $phonen = "$1-$2-$3";
8353 $phonen .= " x$4" if $4;
8355 push @cust_main, qsearch( {
8356 'table' => 'cust_main',
8357 'hashref' => { %options },
8358 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8360 join(' OR ', map "$_ = '$phonen'",
8361 qw( daytime night fax
8362 ship_daytime ship_night ship_fax )
8365 " AND $agentnums_sql", #agent virtualization
8368 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8369 #try looking for matches with extensions unless one was specified
8371 push @cust_main, qsearch( {
8372 'table' => 'cust_main',
8373 'hashref' => { %options },
8374 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8376 join(' OR ', map "$_ LIKE '$phonen\%'",
8378 ship_daytime ship_night )
8381 " AND $agentnums_sql", #agent virtualization
8386 # custnum search (also try agent_custid), with some tweaking options if your
8387 # legacy cust "numbers" have letters
8390 if ( $search =~ /^\s*(\d+)\s*$/
8391 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8392 && $search =~ /^\s*(\w\w?\d+)\s*$/
8399 if ( $num <= 2147483647 ) { #need a bigint custnum? wow.
8400 push @cust_main, qsearch( {
8401 'table' => 'cust_main',
8402 'hashref' => { 'custnum' => $num, %options },
8403 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8407 push @cust_main, qsearch( {
8408 'table' => 'cust_main',
8409 'hashref' => { 'agent_custid' => $num, %options },
8410 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8413 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8415 my($company, $last, $first) = ( $1, $2, $3 );
8417 # "Company (Last, First)"
8418 #this is probably something a browser remembered,
8419 #so just do an exact search
8421 foreach my $prefix ( '', 'ship_' ) {
8422 push @cust_main, qsearch( {
8423 'table' => 'cust_main',
8424 'hashref' => { $prefix.'first' => $first,
8425 $prefix.'last' => $last,
8426 $prefix.'company' => $company,
8429 'extra_sql' => " AND $agentnums_sql",
8433 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8434 # try (ship_){last,company}
8438 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8439 # # full strings the browser remembers won't work
8440 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8442 use Lingua::EN::NameParse;
8443 my $NameParse = new Lingua::EN::NameParse(
8445 allow_reversed => 1,
8448 my($last, $first) = ( '', '' );
8449 #maybe disable this too and just rely on NameParse?
8450 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8452 ($last, $first) = ( $1, $2 );
8454 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
8455 } elsif ( ! $NameParse->parse($value) ) {
8457 my %name = $NameParse->components;
8458 $first = $name{'given_name_1'};
8459 $last = $name{'surname_1'};
8463 if ( $first && $last ) {
8465 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8468 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8470 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8471 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8474 push @cust_main, qsearch( {
8475 'table' => 'cust_main',
8476 'hashref' => \%options,
8477 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8480 # or it just be something that was typed in... (try that in a sec)
8484 my $q_value = dbh->quote($value);
8487 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8488 $sql .= " ( LOWER(last) = $q_value
8489 OR LOWER(company) = $q_value
8490 OR LOWER(ship_last) = $q_value
8491 OR LOWER(ship_company) = $q_value
8494 push @cust_main, qsearch( {
8495 'table' => 'cust_main',
8496 'hashref' => \%options,
8497 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8500 #no exact match, trying substring/fuzzy
8501 #always do substring & fuzzy (unless they're explicity config'ed off)
8502 #getting complaints searches are not returning enough
8503 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8505 #still some false laziness w/search_sql (was search/cust_main.cgi)
8510 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
8511 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
8514 if ( $first && $last ) {
8517 { 'first' => { op=>'ILIKE', value=>"%$first%" },
8518 'last' => { op=>'ILIKE', value=>"%$last%" },
8520 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
8521 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
8528 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
8529 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
8533 foreach my $hashref ( @hashrefs ) {
8535 push @cust_main, qsearch( {
8536 'table' => 'cust_main',
8537 'hashref' => { %$hashref,
8540 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
8549 " AND $agentnums_sql", #extra_sql #agent virtualization
8552 if ( $first && $last ) {
8553 push @cust_main, FS::cust_main->fuzzy_search(
8554 { 'last' => $last, #fuzzy hashref
8555 'first' => $first }, #
8559 foreach my $field ( 'last', 'company' ) {
8561 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
8568 #eliminate duplicates
8570 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8578 Accepts the following options: I<email>, the email address to search for. The
8579 email address will be searched for as an email invoice destination and as an
8582 #Any additional options are treated as an additional qualifier on the search
8583 #(i.e. I<agentnum>).
8585 Returns a (possibly empty) array of FS::cust_main objects (but usually just
8595 my $email = delete $options{'email'};
8597 #we're only being used by RT at the moment... no agent virtualization yet
8598 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8602 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
8604 my ( $user, $domain ) = ( $1, $2 );
8606 warn "$me smart_search: searching for $user in domain $domain"
8612 'table' => 'cust_main_invoice',
8613 'hashref' => { 'dest' => $email },
8620 map $_->cust_svc->cust_pkg,
8622 'table' => 'svc_acct',
8623 'hashref' => { 'username' => $user, },
8625 'AND ( SELECT domain FROM svc_domain
8626 WHERE svc_acct.domsvc = svc_domain.svcnum
8627 ) = '. dbh->quote($domain),
8633 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8635 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
8642 =item check_and_rebuild_fuzzyfiles
8646 use vars qw(@fuzzyfields);
8647 @fuzzyfields = ( 'last', 'first', 'company' );
8649 sub check_and_rebuild_fuzzyfiles {
8650 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8651 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
8654 =item rebuild_fuzzyfiles
8658 sub rebuild_fuzzyfiles {
8660 use Fcntl qw(:flock);
8662 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8663 mkdir $dir, 0700 unless -d $dir;
8665 foreach my $fuzzy ( @fuzzyfields ) {
8667 open(LOCK,">>$dir/cust_main.$fuzzy")
8668 or die "can't open $dir/cust_main.$fuzzy: $!";
8670 or die "can't lock $dir/cust_main.$fuzzy: $!";
8672 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
8673 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
8675 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
8676 my $sth = dbh->prepare("SELECT $field FROM cust_main".
8677 " WHERE $field != '' AND $field IS NOT NULL");
8678 $sth->execute or die $sth->errstr;
8680 while ( my $row = $sth->fetchrow_arrayref ) {
8681 print CACHE $row->[0]. "\n";
8686 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
8688 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
8699 my( $self, $field ) = @_;
8700 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8701 open(CACHE,"<$dir/cust_main.$field")
8702 or die "can't open $dir/cust_main.$field: $!";
8703 my @array = map { chomp; $_; } <CACHE>;
8708 =item append_fuzzyfiles LASTNAME COMPANY
8712 sub append_fuzzyfiles {
8713 #my( $first, $last, $company ) = @_;
8715 &check_and_rebuild_fuzzyfiles;
8717 use Fcntl qw(:flock);
8719 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8721 foreach my $field (qw( first last company )) {
8726 open(CACHE,">>$dir/cust_main.$field")
8727 or die "can't open $dir/cust_main.$field: $!";
8728 flock(CACHE,LOCK_EX)
8729 or die "can't lock $dir/cust_main.$field: $!";
8731 print CACHE "$value\n";
8733 flock(CACHE,LOCK_UN)
8734 or die "can't unlock $dir/cust_main.$field: $!";
8749 #warn join('-',keys %$param);
8750 my $fh = $param->{filehandle};
8751 my @fields = @{$param->{fields}};
8753 eval "use Text::CSV_XS;";
8756 my $csv = new Text::CSV_XS;
8763 local $SIG{HUP} = 'IGNORE';
8764 local $SIG{INT} = 'IGNORE';
8765 local $SIG{QUIT} = 'IGNORE';
8766 local $SIG{TERM} = 'IGNORE';
8767 local $SIG{TSTP} = 'IGNORE';
8768 local $SIG{PIPE} = 'IGNORE';
8770 my $oldAutoCommit = $FS::UID::AutoCommit;
8771 local $FS::UID::AutoCommit = 0;
8774 #while ( $columns = $csv->getline($fh) ) {
8776 while ( defined($line=<$fh>) ) {
8778 $csv->parse($line) or do {
8779 $dbh->rollback if $oldAutoCommit;
8780 return "can't parse: ". $csv->error_input();
8783 my @columns = $csv->fields();
8784 #warn join('-',@columns);
8787 foreach my $field ( @fields ) {
8788 $row{$field} = shift @columns;
8791 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
8792 unless ( $cust_main ) {
8793 $dbh->rollback if $oldAutoCommit;
8794 return "unknown custnum $row{'custnum'}";
8797 if ( $row{'amount'} > 0 ) {
8798 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
8800 $dbh->rollback if $oldAutoCommit;
8804 } elsif ( $row{'amount'} < 0 ) {
8805 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
8808 $dbh->rollback if $oldAutoCommit;
8818 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
8820 return "Empty file!" unless $imported;
8826 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8828 Sends a templated email notification to the customer (see L<Text::Template>).
8830 OPTIONS is a hash and may include
8832 I<from> - the email sender (default is invoice_from)
8834 I<to> - comma-separated scalar or arrayref of recipients
8835 (default is invoicing_list)
8837 I<subject> - The subject line of the sent email notification
8838 (default is "Notice from company_name")
8840 I<extra_fields> - a hashref of name/value pairs which will be substituted
8843 The following variables are vavailable in the template.
8845 I<$first> - the customer first name
8846 I<$last> - the customer last name
8847 I<$company> - the customer company
8848 I<$payby> - a description of the method of payment for the customer
8849 # would be nice to use FS::payby::shortname
8850 I<$payinfo> - the account information used to collect for this customer
8851 I<$expdate> - the expiration of the customer payment in seconds from epoch
8856 my ($self, $template, %options) = @_;
8858 return unless $conf->exists($template);
8860 my $from = $conf->config('invoice_from', $self->agentnum)
8861 if $conf->exists('invoice_from', $self->agentnum);
8862 $from = $options{from} if exists($options{from});
8864 my $to = join(',', $self->invoicing_list_emailonly);
8865 $to = $options{to} if exists($options{to});
8867 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
8868 if $conf->exists('company_name', $self->agentnum);
8869 $subject = $options{subject} if exists($options{subject});
8871 my $notify_template = new Text::Template (TYPE => 'ARRAY',
8872 SOURCE => [ map "$_\n",
8873 $conf->config($template)]
8875 or die "can't create new Text::Template object: Text::Template::ERROR";
8876 $notify_template->compile()
8877 or die "can't compile template: Text::Template::ERROR";
8879 $FS::notify_template::_template::company_name =
8880 $conf->config('company_name', $self->agentnum);
8881 $FS::notify_template::_template::company_address =
8882 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
8884 my $paydate = $self->paydate || '2037-12-31';
8885 $FS::notify_template::_template::first = $self->first;
8886 $FS::notify_template::_template::last = $self->last;
8887 $FS::notify_template::_template::company = $self->company;
8888 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
8889 my $payby = $self->payby;
8890 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
8891 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
8893 #credit cards expire at the end of the month/year of their exp date
8894 if ($payby eq 'CARD' || $payby eq 'DCRD') {
8895 $FS::notify_template::_template::payby = 'credit card';
8896 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
8897 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
8899 }elsif ($payby eq 'COMP') {
8900 $FS::notify_template::_template::payby = 'complimentary account';
8902 $FS::notify_template::_template::payby = 'current method';
8904 $FS::notify_template::_template::expdate = $expire_time;
8906 for (keys %{$options{extra_fields}}){
8908 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
8911 send_email(from => $from,
8913 subject => $subject,
8914 body => $notify_template->fill_in( PACKAGE =>
8915 'FS::notify_template::_template' ),
8920 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8922 Generates a templated notification to the customer (see L<Text::Template>).
8924 OPTIONS is a hash and may include
8926 I<extra_fields> - a hashref of name/value pairs which will be substituted
8927 into the template. These values may override values mentioned below
8928 and those from the customer record.
8930 The following variables are available in the template instead of or in addition
8931 to the fields of the customer record.
8933 I<$payby> - a description of the method of payment for the customer
8934 # would be nice to use FS::payby::shortname
8935 I<$payinfo> - the masked account information used to collect for this customer
8936 I<$expdate> - the expiration of the customer payment method in seconds from epoch
8937 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
8941 sub generate_letter {
8942 my ($self, $template, %options) = @_;
8944 return unless $conf->exists($template);
8946 my $letter_template = new Text::Template
8948 SOURCE => [ map "$_\n", $conf->config($template)],
8949 DELIMITERS => [ '[@--', '--@]' ],
8951 or die "can't create new Text::Template object: Text::Template::ERROR";
8953 $letter_template->compile()
8954 or die "can't compile template: Text::Template::ERROR";
8956 my %letter_data = map { $_ => $self->$_ } $self->fields;
8957 $letter_data{payinfo} = $self->mask_payinfo;
8959 #my $paydate = $self->paydate || '2037-12-31';
8960 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
8962 my $payby = $self->payby;
8963 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
8964 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
8966 #credit cards expire at the end of the month/year of their exp date
8967 if ($payby eq 'CARD' || $payby eq 'DCRD') {
8968 $letter_data{payby} = 'credit card';
8969 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
8970 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
8972 }elsif ($payby eq 'COMP') {
8973 $letter_data{payby} = 'complimentary account';
8975 $letter_data{payby} = 'current method';
8977 $letter_data{expdate} = $expire_time;
8979 for (keys %{$options{extra_fields}}){
8980 $letter_data{$_} = $options{extra_fields}->{$_};
8983 unless(exists($letter_data{returnaddress})){
8984 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
8985 $self->agent_template)
8987 if ( length($retadd) ) {
8988 $letter_data{returnaddress} = $retadd;
8989 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
8990 $letter_data{returnaddress} =
8991 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
8992 $conf->config('company_address', $self->agentnum)
8995 $letter_data{returnaddress} = '~';
8999 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9001 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9003 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9004 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9008 ) or die "can't open temp file: $!\n";
9010 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9012 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9016 =item print_ps TEMPLATE
9018 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9024 my $file = $self->generate_letter(@_);
9025 FS::Misc::generate_ps($file);
9028 =item print TEMPLATE
9030 Prints the filled in template.
9032 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9036 sub queueable_print {
9039 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9040 or die "invalid customer number: " . $opt{custvnum};
9042 my $error = $self->print( $opt{template} );
9043 die $error if $error;
9047 my ($self, $template) = (shift, shift);
9048 do_print [ $self->print_ps($template) ];
9051 #these three subs should just go away once agent stuff is all config overrides
9053 sub agent_template {
9055 $self->_agent_plandata('agent_templatename');
9058 sub agent_invoice_from {
9060 $self->_agent_plandata('agent_invoice_from');
9063 sub _agent_plandata {
9064 my( $self, $option ) = @_;
9066 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
9067 #agent-specific Conf
9069 use FS::part_event::Condition;
9071 my $agentnum = $self->agentnum;
9074 if ( driver_name =~ /^Pg/i ) {
9076 } elsif ( driver_name =~ /^mysql/i ) {
9079 die "don't know how to use regular expressions in ". driver_name. " databases";
9082 my $part_event_option =
9084 'select' => 'part_event_option.*',
9085 'table' => 'part_event_option',
9087 LEFT JOIN part_event USING ( eventpart )
9088 LEFT JOIN part_event_option AS peo_agentnum
9089 ON ( part_event.eventpart = peo_agentnum.eventpart
9090 AND peo_agentnum.optionname = 'agentnum'
9091 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9093 LEFT JOIN part_event_condition
9094 ON ( part_event.eventpart = part_event_condition.eventpart
9095 AND part_event_condition.conditionname = 'cust_bill_age'
9097 LEFT JOIN part_event_condition_option
9098 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9099 AND part_event_condition_option.optionname = 'age'
9102 #'hashref' => { 'optionname' => $option },
9103 #'hashref' => { 'part_event_option.optionname' => $option },
9105 " WHERE part_event_option.optionname = ". dbh->quote($option).
9106 " AND action = 'cust_bill_send_agent' ".
9107 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9108 " AND peo_agentnum.optionname = 'agentnum' ".
9109 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9111 CASE WHEN part_event_condition_option.optionname IS NULL
9113 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9115 , part_event.weight".
9119 unless ( $part_event_option ) {
9120 return $self->agent->invoice_template || ''
9121 if $option eq 'agent_templatename';
9125 $part_event_option->optionvalue;
9130 ## actual sub, not a method, designed to be called from the queue.
9131 ## sets up the customer, and calls the bill_and_collect
9132 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9133 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9134 $cust_main->bill_and_collect(
9139 sub _upgrade_data { #class method
9140 my ($class, %opts) = @_;
9142 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9143 my $sth = dbh->prepare($sql) or die dbh->errstr;
9144 $sth->execute or die $sth->errstr;
9154 The delete method should possibly take an FS::cust_main object reference
9155 instead of a scalar customer number.
9157 Bill and collect options should probably be passed as references instead of a
9160 There should probably be a configuration file with a list of allowed credit
9163 No multiple currency support (probably a larger project than just this module).
9165 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9167 Birthdates rely on negative epoch values.
9169 The payby for card/check batches is broken. With mixed batching, bad
9172 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9176 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9177 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9178 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.