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->ss eq '' ) {
1579 $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1580 or return "Illegal social security number: ". $self->ss;
1581 $self->ss("$1-$2-$3");
1585 # bad idea to disable, causes billing to fail because of no tax rates later
1586 # unless ( $import ) {
1587 unless ( qsearch('cust_main_county', {
1588 'country' => $self->country,
1591 return "Unknown state/county/country: ".
1592 $self->state. "/". $self->county. "/". $self->country
1593 unless qsearch('cust_main_county',{
1594 'state' => $self->state,
1595 'county' => $self->county,
1596 'country' => $self->country,
1602 $self->ut_phonen('daytime', $self->country)
1603 || $self->ut_phonen('night', $self->country)
1604 || $self->ut_phonen('fax', $self->country)
1605 || $self->ut_zip('zip', $self->country)
1607 return $error if $error;
1609 if ( $conf->exists('cust_main-require_phone')
1610 && ! length($self->daytime) && ! length($self->night)
1613 my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1615 : FS::Msgcat::_gettext('daytime');
1616 my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1618 : FS::Msgcat::_gettext('night');
1620 return "$daytime_label or $night_label is required"
1624 if ( $self->has_ship_address
1625 && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1626 $self->addr_fields )
1630 $self->ut_name('ship_last')
1631 || $self->ut_name('ship_first')
1632 || $self->ut_textn('ship_company')
1633 || $self->ut_text('ship_address1')
1634 || $self->ut_textn('ship_address2')
1635 || $self->ut_text('ship_city')
1636 || $self->ut_textn('ship_county')
1637 || $self->ut_textn('ship_state')
1638 || $self->ut_country('ship_country')
1640 return $error if $error;
1642 #false laziness with above
1643 unless ( qsearchs('cust_main_county', {
1644 'country' => $self->ship_country,
1647 return "Unknown ship_state/ship_county/ship_country: ".
1648 $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1649 unless qsearch('cust_main_county',{
1650 'state' => $self->ship_state,
1651 'county' => $self->ship_county,
1652 'country' => $self->ship_country,
1658 $self->ut_phonen('ship_daytime', $self->ship_country)
1659 || $self->ut_phonen('ship_night', $self->ship_country)
1660 || $self->ut_phonen('ship_fax', $self->ship_country)
1661 || $self->ut_zip('ship_zip', $self->ship_country)
1663 return $error if $error;
1665 return "Unit # is required."
1666 if $self->ship_address2 =~ /^\s*$/
1667 && $conf->exists('cust_main-require_address2');
1669 } else { # ship_ info eq billing info, so don't store dup info in database
1671 $self->setfield("ship_$_", '')
1672 foreach $self->addr_fields;
1674 return "Unit # is required."
1675 if $self->address2 =~ /^\s*$/
1676 && $conf->exists('cust_main-require_address2');
1680 #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1681 # or return "Illegal payby: ". $self->payby;
1683 FS::payby->can_payby($self->table, $self->payby)
1684 or return "Illegal payby: ". $self->payby;
1686 $error = $self->ut_numbern('paystart_month')
1687 || $self->ut_numbern('paystart_year')
1688 || $self->ut_numbern('payissue')
1689 || $self->ut_textn('paytype')
1691 return $error if $error;
1693 if ( $self->payip eq '' ) {
1696 $error = $self->ut_ip('payip');
1697 return $error if $error;
1700 # If it is encrypted and the private key is not availaible then we can't
1701 # check the credit card.
1703 my $check_payinfo = 1;
1705 if ($self->is_encrypted($self->payinfo)) {
1709 if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1711 my $payinfo = $self->payinfo;
1712 $payinfo =~ s/\D//g;
1713 $payinfo =~ /^(\d{13,16})$/
1714 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1716 $self->payinfo($payinfo);
1718 or return gettext('invalid_card'); # . ": ". $self->payinfo;
1720 return gettext('unknown_card_type')
1721 if cardtype($self->payinfo) eq "Unknown";
1723 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1725 return 'Banned credit card: banned on '.
1726 time2str('%a %h %o at %r', $ban->_date).
1727 ' by '. $ban->otaker.
1728 ' (ban# '. $ban->bannum. ')';
1731 if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1732 if ( cardtype($self->payinfo) eq 'American Express card' ) {
1733 $self->paycvv =~ /^(\d{4})$/
1734 or return "CVV2 (CID) for American Express cards is four digits.";
1737 $self->paycvv =~ /^(\d{3})$/
1738 or return "CVV2 (CVC2/CID) is three digits.";
1745 my $cardtype = cardtype($payinfo);
1746 if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1748 return "Start date or issue number is required for $cardtype cards"
1749 unless $self->paystart_month && $self->paystart_year or $self->payissue;
1751 return "Start month must be between 1 and 12"
1752 if $self->paystart_month
1753 and $self->paystart_month < 1 || $self->paystart_month > 12;
1755 return "Start year must be 1990 or later"
1756 if $self->paystart_year
1757 and $self->paystart_year < 1990;
1759 return "Issue number must be beween 1 and 99"
1761 and $self->payissue < 1 || $self->payissue > 99;
1764 $self->paystart_month('');
1765 $self->paystart_year('');
1766 $self->payissue('');
1769 } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1771 my $payinfo = $self->payinfo;
1772 $payinfo =~ s/[^\d\@]//g;
1773 if ( $conf->exists('echeck-nonus') ) {
1774 $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1775 $payinfo = "$1\@$2";
1777 $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1778 $payinfo = "$1\@$2";
1780 $self->payinfo($payinfo);
1783 my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1785 return 'Banned ACH account: banned on '.
1786 time2str('%a %h %o at %r', $ban->_date).
1787 ' by '. $ban->otaker.
1788 ' (ban# '. $ban->bannum. ')';
1791 } elsif ( $self->payby eq 'LECB' ) {
1793 my $payinfo = $self->payinfo;
1794 $payinfo =~ s/\D//g;
1795 $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1797 $self->payinfo($payinfo);
1800 } elsif ( $self->payby eq 'BILL' ) {
1802 $error = $self->ut_textn('payinfo');
1803 return "Illegal P.O. number: ". $self->payinfo if $error;
1806 } elsif ( $self->payby eq 'COMP' ) {
1808 my $curuser = $FS::CurrentUser::CurrentUser;
1809 if ( ! $self->custnum
1810 && ! $curuser->access_right('Complimentary customer')
1813 return "You are not permitted to create complimentary accounts."
1816 $error = $self->ut_textn('payinfo');
1817 return "Illegal comp account issuer: ". $self->payinfo if $error;
1820 } elsif ( $self->payby eq 'PREPAY' ) {
1822 my $payinfo = $self->payinfo;
1823 $payinfo =~ s/\W//g; #anything else would just confuse things
1824 $self->payinfo($payinfo);
1825 $error = $self->ut_alpha('payinfo');
1826 return "Illegal prepayment identifier: ". $self->payinfo if $error;
1827 return "Unknown prepayment identifier"
1828 unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1833 if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1834 return "Expiration date required"
1835 unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1839 if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1840 ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1841 } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1842 ( $m, $y ) = ( $3, "20$2" );
1844 return "Illegal expiration date: ". $self->paydate;
1846 $self->paydate("$y-$m-01");
1847 my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1848 return gettext('expired_card')
1850 && !$ignore_expired_card
1851 && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1854 if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1855 ( ! $conf->exists('require_cardname')
1856 || $self->payby !~ /^(CARD|DCRD)$/ )
1858 $self->payname( $self->first. " ". $self->getfield('last') );
1860 $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1861 or return gettext('illegal_name'). " payname: ". $self->payname;
1865 foreach my $flag (qw( tax spool_cdr squelch_cdr archived )) {
1866 $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1870 $self->otaker(getotaker) unless $self->otaker;
1872 warn "$me check AFTER: \n". $self->_dump
1875 $self->SUPER::check;
1880 Returns a list of fields which have ship_ duplicates.
1885 qw( last first company
1886 address1 address2 city county state zip country
1891 =item has_ship_address
1893 Returns true if this customer record has a separate shipping address.
1897 sub has_ship_address {
1899 scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1902 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1904 Returns all packages (see L<FS::cust_pkg>) for this customer.
1910 my $extra_qsearch = ref($_[0]) ? shift : {};
1912 return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
1915 if ( $self->{'_pkgnum'} ) {
1916 @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1918 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1921 sort sort_packages @cust_pkg;
1926 Synonym for B<all_pkgs>.
1931 shift->all_pkgs(@_);
1936 Returns all locations (see L<FS::cust_location>) for this customer.
1942 qsearch('cust_location', { 'custnum' => $self->custnum } );
1945 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1947 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1951 sub ncancelled_pkgs {
1953 my $extra_qsearch = ref($_[0]) ? shift : {};
1955 return $self->num_ncancelled_pkgs unless wantarray;
1958 if ( $self->{'_pkgnum'} ) {
1960 warn "$me ncancelled_pkgs: returning cached objects"
1963 @cust_pkg = grep { ! $_->getfield('cancel') }
1964 values %{ $self->{'_pkgnum'}->cache };
1968 warn "$me ncancelled_pkgs: searching for packages with custnum ".
1969 $self->custnum. "\n"
1972 $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
1974 @cust_pkg = $self->_cust_pkg($extra_qsearch);
1978 sort sort_packages @cust_pkg;
1984 my $extra_qsearch = ref($_[0]) ? shift : {};
1986 $extra_qsearch->{'select'} ||= '*';
1987 $extra_qsearch->{'select'} .=
1988 ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
1992 $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
1997 'table' => 'cust_pkg',
1998 'hashref' => { 'custnum' => $self->custnum },
2003 # This should be generalized to use config options to determine order.
2006 if ( $a->get('cancel') xor $b->get('cancel') ) {
2007 return -1 if $b->get('cancel');
2008 return 1 if $a->get('cancel');
2009 #shouldn't get here...
2012 my $a_num_cust_svc = $a->num_cust_svc;
2013 my $b_num_cust_svc = $b->num_cust_svc;
2014 return 0 if !$a_num_cust_svc && !$b_num_cust_svc;
2015 return -1 if $a_num_cust_svc && !$b_num_cust_svc;
2016 return 1 if !$a_num_cust_svc && $b_num_cust_svc;
2017 my @a_cust_svc = $a->cust_svc;
2018 my @b_cust_svc = $b->cust_svc;
2019 $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
2024 =item suspended_pkgs
2026 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
2030 sub suspended_pkgs {
2032 grep { $_->susp } $self->ncancelled_pkgs;
2035 =item unflagged_suspended_pkgs
2037 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
2038 customer (thouse packages without the `manual_flag' set).
2042 sub unflagged_suspended_pkgs {
2044 return $self->suspended_pkgs
2045 unless dbdef->table('cust_pkg')->column('manual_flag');
2046 grep { ! $_->manual_flag } $self->suspended_pkgs;
2049 =item unsuspended_pkgs
2051 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
2056 sub unsuspended_pkgs {
2058 grep { ! $_->susp } $self->ncancelled_pkgs;
2061 =item next_bill_date
2063 Returns the next date this customer will be billed, as a UNIX timestamp, or
2064 undef if no active package has a next bill date.
2068 sub next_bill_date {
2070 min( map $_->get('bill'), grep $_->get('bill'), $self->unsuspended_pkgs );
2073 =item num_cancelled_pkgs
2075 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
2080 sub num_cancelled_pkgs {
2081 shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
2084 sub num_ncancelled_pkgs {
2085 shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
2089 my( $self ) = shift;
2090 my $sql = scalar(@_) ? shift : '';
2091 $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2092 my $sth = dbh->prepare(
2093 "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2094 ) or die dbh->errstr;
2095 $sth->execute($self->custnum) or die $sth->errstr;
2096 $sth->fetchrow_arrayref->[0];
2101 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2102 and L<FS::cust_pkg>) for this customer. Always returns a list: an empty list
2103 on success or a list of errors.
2109 grep { $_->unsuspend } $self->suspended_pkgs;
2114 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2116 Returns a list: an empty list on success or a list of errors.
2122 grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2125 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2127 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2128 PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref instead
2129 of a list of pkgparts; the hashref has the following keys:
2133 =item pkgparts - listref of pkgparts
2135 =item (other options are passed to the suspend method)
2140 Returns a list: an empty list on success or a list of errors.
2144 sub suspend_if_pkgpart {
2146 my (@pkgparts, %opt);
2147 if (ref($_[0]) eq 'HASH'){
2148 @pkgparts = @{$_[0]{pkgparts}};
2153 grep { $_->suspend(%opt) }
2154 grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2155 $self->unsuspended_pkgs;
2158 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2160 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2161 given PKGPARTs (see L<FS::part_pkg>). Preferred usage is to pass a hashref
2162 instead of a list of pkgparts; the hashref has the following keys:
2166 =item pkgparts - listref of pkgparts
2168 =item (other options are passed to the suspend method)
2172 Returns a list: an empty list on success or a list of errors.
2176 sub suspend_unless_pkgpart {
2178 my (@pkgparts, %opt);
2179 if (ref($_[0]) eq 'HASH'){
2180 @pkgparts = @{$_[0]{pkgparts}};
2185 grep { $_->suspend(%opt) }
2186 grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2187 $self->unsuspended_pkgs;
2190 =item cancel [ OPTION => VALUE ... ]
2192 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2194 Available options are:
2198 =item quiet - can be set true to supress email cancellation notices.
2200 =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.
2202 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2204 =item nobill - can be set true to skip billing if it might otherwise be done.
2208 Always returns a list: an empty list on success or a list of errors.
2212 # nb that dates are not specified as valid options to this method
2215 my( $self, %opt ) = @_;
2217 warn "$me cancel called on customer ". $self->custnum. " with options ".
2218 join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2221 return ( 'access denied' )
2222 unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2224 if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2226 #should try decryption (we might have the private key)
2227 # and if not maybe queue a job for the server that does?
2228 return ( "Can't (yet) ban encrypted credit cards" )
2229 if $self->is_encrypted($self->payinfo);
2231 my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2232 my $error = $ban->insert;
2233 return ( $error ) if $error;
2237 my @pkgs = $self->ncancelled_pkgs;
2239 if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2241 my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2242 warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2246 warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2247 scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2250 grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2253 sub _banned_pay_hashref {
2264 'payby' => $payby2ban{$self->payby},
2265 'payinfo' => md5_base64($self->payinfo),
2266 #don't ever *search* on reason! #'reason' =>
2272 Returns all notes (see L<FS::cust_main_note>) for this customer.
2279 qsearch( 'cust_main_note',
2280 { 'custnum' => $self->custnum },
2282 'ORDER BY _DATE DESC'
2288 Returns the agent (see L<FS::agent>) for this customer.
2294 qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2297 =item bill_and_collect
2299 Cancels and suspends any packages due, generates bills, applies payments and
2302 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
2304 Options are passed as name-value pairs. Currently available options are:
2310 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:
2314 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2318 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.
2322 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2326 If set true, re-charges setup fees.
2330 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)
2334 Options are passed to the B<bill> and B<collect> methods verbatim, so all
2335 options of those methods are also available.
2339 sub bill_and_collect {
2340 my( $self, %options ) = @_;
2342 #$options{actual_time} not $options{time} because freeside-daily -d is for
2343 #pre-printing invoices
2344 $self->cancel_expired_pkgs( $options{actual_time} );
2345 $self->suspend_adjourned_pkgs( $options{actual_time} );
2347 my $error = $self->bill( %options );
2348 warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
2350 $self->apply_payments_and_credits;
2352 unless ( $conf->exists('cancelled_cust-noevents')
2353 && ! $self->num_ncancelled_pkgs
2356 $error = $self->collect( %options );
2357 warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
2363 sub cancel_expired_pkgs {
2364 my ( $self, $time ) = @_;
2366 my @cancel_pkgs = $self->ncancelled_pkgs( {
2367 'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
2370 foreach my $cust_pkg ( @cancel_pkgs ) {
2371 my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2372 my $error = $cust_pkg->cancel($cpr ? ( 'reason' => $cpr->reasonnum,
2373 'reason_otaker' => $cpr->otaker
2377 warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
2378 " for custnum ". $self->custnum. ": $error"
2384 sub suspend_adjourned_pkgs {
2385 my ( $self, $time ) = @_;
2387 my @susp_pkgs = $self->ncancelled_pkgs( {
2389 " AND ( susp IS NULL OR susp = 0 )
2390 AND ( ( bill IS NOT NULL AND bill != 0 AND bill < $time )
2391 OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
2396 #only because there's no SQL test for is_prepaid :/
2398 grep { ( $_->part_pkg->is_prepaid
2403 && $_->adjourn <= $time
2409 foreach my $cust_pkg ( @susp_pkgs ) {
2410 my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2411 if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2412 my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2413 'reason_otaker' => $cpr->otaker
2418 warn "Error suspending package ". $cust_pkg->pkgnum.
2419 " for custnum ". $self->custnum. ": $error"
2427 Generates invoices (see L<FS::cust_bill>) for this customer. Usually used in
2428 conjunction with the collect method by calling B<bill_and_collect>.
2430 If there is an error, returns the error, otherwise returns false.
2432 Options are passed as name-value pairs. Currently available options are:
2438 If set true, re-charges setup fees.
2442 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:
2446 $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2450 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2452 $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2456 A hashref of pkgparts to exclude from this billing run.
2460 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.
2464 This boolean value informs the us that the package is being cancelled. This
2465 typically might mean not charging the normal recurring fee but only usage
2466 fees since the last billing. Setup charges may be charged. Not all package
2467 plans support this feature (they tend to charge 0).
2474 my( $self, %options ) = @_;
2475 return '' if $self->payby eq 'COMP';
2476 warn "$me bill customer ". $self->custnum. "\n"
2479 my $time = $options{'time'} || time;
2480 my $invoice_time = $options{'invoice_time'} || $time;
2482 $options{'not_pkgpart'} ||= {};
2485 local $SIG{HUP} = 'IGNORE';
2486 local $SIG{INT} = 'IGNORE';
2487 local $SIG{QUIT} = 'IGNORE';
2488 local $SIG{TERM} = 'IGNORE';
2489 local $SIG{TSTP} = 'IGNORE';
2490 local $SIG{PIPE} = 'IGNORE';
2492 my $oldAutoCommit = $FS::UID::AutoCommit;
2493 local $FS::UID::AutoCommit = 0;
2496 $self->select_for_update; #mutex
2498 my @cust_bill_pkg = ();
2501 # find the packages which are due for billing, find out how much they are
2502 # & generate invoice database.
2505 my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2507 my @precommit_hooks = ();
2509 $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ]; #param checks?
2510 foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
2512 next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
2514 warn " bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2516 #? to avoid use of uninitialized value errors... ?
2517 $cust_pkg->setfield('bill', '')
2518 unless defined($cust_pkg->bill);
2520 #my $part_pkg = $cust_pkg->part_pkg;
2522 my $real_pkgpart = $cust_pkg->pkgpart;
2523 my %hash = $cust_pkg->hash;
2525 foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2527 $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2530 $self->_make_lines( 'part_pkg' => $part_pkg,
2531 'cust_pkg' => $cust_pkg,
2532 'precommit_hooks' => \@precommit_hooks,
2533 'line_items' => \@cust_bill_pkg,
2534 'setup' => \$total_setup,
2535 'recur' => \$total_recur,
2536 'tax_matrix' => \%taxlisthash,
2538 'options' => \%options,
2541 $dbh->rollback if $oldAutoCommit;
2545 } #foreach my $part_pkg
2547 } #foreach my $cust_pkg
2549 unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2550 #but do commit any package date cycling that happened
2551 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2555 if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2556 !$conf->exists('postal_invoice-recurring_only')
2560 my $postal_pkg = $self->charge_postal_fee();
2561 if ( $postal_pkg && !ref( $postal_pkg ) ) {
2563 $dbh->rollback if $oldAutoCommit;
2564 return "can't charge postal invoice fee for customer ".
2565 $self->custnum. ": $postal_pkg";
2567 } elsif ( $postal_pkg ) {
2569 foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2570 my %postal_options = %options;
2571 delete $postal_options{cancel};
2573 $self->_make_lines( 'part_pkg' => $part_pkg,
2574 'cust_pkg' => $postal_pkg,
2575 'precommit_hooks' => \@precommit_hooks,
2576 'line_items' => \@cust_bill_pkg,
2577 'setup' => \$total_setup,
2578 'recur' => \$total_recur,
2579 'tax_matrix' => \%taxlisthash,
2581 'options' => \%postal_options,
2584 $dbh->rollback if $oldAutoCommit;
2593 warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2595 # keys are tax names (as printed on invoices / itemdesc )
2596 # values are listrefs of taxlisthash keys (internal identifiers)
2599 # keys are taxlisthash keys (internal identifiers)
2600 # values are (cumulative) amounts
2603 # keys are taxlisthash keys (internal identifiers)
2604 # values are listrefs of cust_bill_pkg_tax_location hashrefs
2605 my %tax_location = ();
2607 # keys are taxlisthash keys (internal identifiers)
2608 # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
2609 my %tax_rate_location = ();
2611 foreach my $tax ( keys %taxlisthash ) {
2612 my $tax_object = shift @{ $taxlisthash{$tax} };
2613 warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2614 warn " ". join('/', @{ $taxlisthash{$tax} } ). "\n" if $DEBUG > 2;
2615 my $hashref_or_error =
2616 $tax_object->taxline( $taxlisthash{$tax},
2617 'custnum' => $self->custnum,
2618 'invoice_time' => $invoice_time
2620 unless ( ref($hashref_or_error) ) {
2621 $dbh->rollback if $oldAutoCommit;
2622 return $hashref_or_error;
2624 unshift @{ $taxlisthash{$tax} }, $tax_object;
2626 my $name = $hashref_or_error->{'name'};
2627 my $amount = $hashref_or_error->{'amount'};
2629 #warn "adding $amount as $name\n";
2630 $taxname{ $name } ||= [];
2631 push @{ $taxname{ $name } }, $tax;
2633 $tax{ $tax } += $amount;
2635 $tax_location{ $tax } ||= [];
2636 if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2637 push @{ $tax_location{ $tax } },
2639 'taxnum' => $tax_object->taxnum,
2640 'taxtype' => ref($tax_object),
2641 'pkgnum' => $tax_object->get('pkgnum'),
2642 'locationnum' => $tax_object->get('locationnum'),
2643 'amount' => sprintf('%.2f', $amount ),
2647 $tax_rate_location{ $tax } ||= [];
2648 if ( ref($tax_object) eq 'FS::tax_rate' ) {
2649 my $taxratelocationnum =
2650 $tax_object->tax_rate_location->taxratelocationnum;
2651 push @{ $tax_rate_location{ $tax } },
2653 'taxnum' => $tax_object->taxnum,
2654 'taxtype' => ref($tax_object),
2655 'amount' => sprintf('%.2f', $amount ),
2656 'locationtaxid' => $tax_object->location,
2657 'taxratelocationnum' => $taxratelocationnum,
2663 #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
2664 my %packagemap = map { $_->pkgnum => $_ } @cust_bill_pkg;
2665 foreach my $tax ( keys %taxlisthash ) {
2666 foreach ( @{ $taxlisthash{$tax} }[1 ... scalar(@{ $taxlisthash{$tax} })] ) {
2667 next unless ref($_) eq 'FS::cust_bill_pkg';
2669 push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
2670 splice( @{ $_->_cust_tax_exempt_pkg } );
2674 #consolidate and create tax line items
2675 warn "consolidating and generating...\n" if $DEBUG > 2;
2676 foreach my $taxname ( keys %taxname ) {
2679 my @cust_bill_pkg_tax_location = ();
2680 my @cust_bill_pkg_tax_rate_location = ();
2681 warn "adding $taxname\n" if $DEBUG > 1;
2682 foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2683 next if $seen{$taxitem}++;
2684 warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2685 $tax += $tax{$taxitem};
2686 push @cust_bill_pkg_tax_location,
2687 map { new FS::cust_bill_pkg_tax_location $_ }
2688 @{ $tax_location{ $taxitem } };
2689 push @cust_bill_pkg_tax_rate_location,
2690 map { new FS::cust_bill_pkg_tax_rate_location $_ }
2691 @{ $tax_rate_location{ $taxitem } };
2695 $tax = sprintf('%.2f', $tax );
2696 $total_setup = sprintf('%.2f', $total_setup+$tax );
2698 push @cust_bill_pkg, new FS::cust_bill_pkg {
2704 'itemdesc' => $taxname,
2705 'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2706 'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
2711 #add tax adjustments
2712 warn "adding tax adjustments...\n" if $DEBUG > 2;
2713 foreach my $cust_tax_adjustment (
2714 qsearch('cust_tax_adjustment', { 'custnum' => $self->custnum,
2720 my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
2721 $total_setup = sprintf('%.2f', $total_setup+$tax );
2723 my $itemdesc = $cust_tax_adjustment->taxname;
2724 $itemdesc = '' if $itemdesc eq 'Tax';
2726 push @cust_bill_pkg, new FS::cust_bill_pkg {
2732 'itemdesc' => $itemdesc,
2733 'itemcomment' => $cust_tax_adjustment->comment,
2734 'cust_tax_adjustment' => $cust_tax_adjustment,
2735 #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2740 my $charged = sprintf('%.2f', $total_setup + $total_recur );
2742 #create the new invoice
2743 my $cust_bill = new FS::cust_bill ( {
2744 'custnum' => $self->custnum,
2745 '_date' => ( $invoice_time ),
2746 'charged' => $charged,
2748 my $error = $cust_bill->insert;
2750 $dbh->rollback if $oldAutoCommit;
2751 return "can't create invoice for customer #". $self->custnum. ": $error";
2754 foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2755 $cust_bill_pkg->invnum($cust_bill->invnum);
2756 my $error = $cust_bill_pkg->insert;
2758 $dbh->rollback if $oldAutoCommit;
2759 return "can't create invoice line item: $error";
2764 foreach my $hook ( @precommit_hooks ) {
2766 &{$hook}; #($self) ?
2769 $dbh->rollback if $oldAutoCommit;
2770 return "$@ running precommit hook $hook\n";
2774 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2780 my ($self, %params) = @_;
2782 my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
2783 my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
2784 my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
2785 my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
2786 my $total_setup = $params{setup} or die "no setup accumulator specified";
2787 my $total_recur = $params{recur} or die "no recur accumulator specified";
2788 my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
2789 my $time = $params{'time'} or die "no time specified";
2790 my (%options) = %{$params{options}};
2793 my $real_pkgpart = $cust_pkg->pkgpart;
2794 my %hash = $cust_pkg->hash;
2795 my $old_cust_pkg = new FS::cust_pkg \%hash;
2801 $cust_pkg->pkgpart($part_pkg->pkgpart);
2809 if ( $options{'resetup'}
2810 || ( ! $cust_pkg->setup
2811 && ( ! $cust_pkg->start_date
2812 || $cust_pkg->start_date <= $time
2814 && ( ! $conf->exists('disable_setup_suspended_pkgs')
2815 || ( $conf->exists('disable_setup_suspended_pkgs') &&
2816 ! $cust_pkg->getfield('susp')
2823 warn " bill setup\n" if $DEBUG > 1;
2826 $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2827 return "$@ running calc_setup for $cust_pkg\n"
2830 $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
2832 $cust_pkg->setfield('setup', $time)
2833 unless $cust_pkg->setup;
2834 #do need it, but it won't get written to the db
2835 #|| $cust_pkg->pkgpart != $real_pkgpart;
2837 $cust_pkg->setfield('start_date', '')
2838 if $cust_pkg->start_date;
2843 # bill recurring fee
2846 #XXX unit stuff here too
2850 if ( ! $cust_pkg->getfield('susp') and
2851 ( $part_pkg->getfield('freq') ne '0' &&
2852 ( $cust_pkg->getfield('bill') || 0 ) <= $time
2854 || ( $part_pkg->plan eq 'voip_cdr'
2855 && $part_pkg->option('bill_every_call')
2857 || ( $options{cancel} )
2860 # XXX should this be a package event? probably. events are called
2861 # at collection time at the moment, though...
2862 $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
2863 if $part_pkg->can('reset_usage');
2864 #don't want to reset usage just cause we want a line item??
2865 #&& $part_pkg->pkgpart == $real_pkgpart;
2867 warn " bill recur\n" if $DEBUG > 1;
2870 # XXX shared with $recur_prog
2871 $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
2875 #over two params! lets at least switch to a hashref for the rest...
2876 my $increment_next_bill = ( $part_pkg->freq ne '0'
2877 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
2878 && !$options{cancel}
2880 my %param = ( 'precommit_hooks' => $precommit_hooks,
2881 'increment_next_bill' => $increment_next_bill,
2884 my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
2885 $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
2886 return "$@ running $method for $cust_pkg\n"
2889 if ( $increment_next_bill ) {
2891 my $next_bill = $part_pkg->add_freq($sdate);
2892 return "unparsable frequency: ". $part_pkg->freq
2893 if $next_bill == -1;
2895 #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
2896 # only for figuring next bill date, nothing else, so, reset $sdate again
2898 $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2899 #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
2900 $cust_pkg->last_bill($sdate);
2902 $cust_pkg->setfield('bill', $next_bill );
2908 warn "\$setup is undefined" unless defined($setup);
2909 warn "\$recur is undefined" unless defined($recur);
2910 warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2913 # If there's line items, create em cust_bill_pkg records
2914 # If $cust_pkg has been modified, update it (if we're a real pkgpart)
2919 if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
2920 # hmm.. and if just the options are modified in some weird price plan?
2922 warn " package ". $cust_pkg->pkgnum. " modified; updating\n"
2925 my $error = $cust_pkg->replace( $old_cust_pkg,
2926 'options' => { $cust_pkg->options },
2928 return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
2929 if $error; #just in case
2932 $setup = sprintf( "%.2f", $setup );
2933 $recur = sprintf( "%.2f", $recur );
2934 if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2935 return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2937 if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2938 return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2941 if ( $setup != 0 || $recur != 0 ) {
2943 warn " charges (setup=$setup, recur=$recur); adding line items\n"
2946 my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
2948 warn " adding customer package invoice detail: $_\n"
2949 foreach @cust_pkg_detail;
2951 push @details, @cust_pkg_detail;
2953 my $cust_bill_pkg = new FS::cust_bill_pkg {
2954 'pkgnum' => $cust_pkg->pkgnum,
2956 'unitsetup' => $unitsetup,
2958 'unitrecur' => $unitrecur,
2959 'quantity' => $cust_pkg->quantity,
2960 'details' => \@details,
2963 if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
2964 $cust_bill_pkg->sdate( $hash{last_bill} );
2965 $cust_bill_pkg->edate( $sdate - 86399 ); #60s*60m*24h-1
2966 $cust_bill_pkg->edate( $time ) if $options{cancel};
2967 } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
2968 $cust_bill_pkg->sdate( $sdate );
2969 $cust_bill_pkg->edate( $cust_pkg->bill );
2970 #$cust_bill_pkg->edate( $time ) if $options{cancel};
2973 $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
2974 unless $part_pkg->pkgpart == $real_pkgpart;
2976 $$total_setup += $setup;
2977 $$total_recur += $recur;
2984 $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time});
2985 return $error if $error;
2987 push @$cust_bill_pkgs, $cust_bill_pkg;
2989 } #if $setup != 0 || $recur != 0
2999 my $part_pkg = shift;
3000 my $taxlisthash = shift;
3001 my $cust_bill_pkg = shift;
3002 my $cust_pkg = shift;
3003 my $invoice_time = shift;
3005 my %cust_bill_pkg = ();
3009 #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3010 push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3011 push @classes, 'setup' if $cust_bill_pkg->setup;
3012 push @classes, 'recur' if $cust_bill_pkg->recur;
3014 if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3016 if ( $conf->exists('enable_taxproducts')
3017 && ( scalar($part_pkg->part_pkg_taxoverride)
3018 || $part_pkg->has_taxproduct
3023 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3024 return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3027 foreach my $class (@classes) {
3028 my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3029 return $err_or_ref unless ref($err_or_ref);
3030 $taxes{$class} = $err_or_ref;
3033 unless (exists $taxes{''}) {
3034 my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3035 return $err_or_ref unless ref($err_or_ref);
3036 $taxes{''} = $err_or_ref;
3041 my @loc_keys = qw( state county country );
3043 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3044 my $cust_location = $cust_pkg->cust_location;
3045 %taxhash = map { $_ => $cust_location->$_() } @loc_keys;
3048 ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3051 %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3054 $taxhash{'taxclass'} = $part_pkg->taxclass;
3056 my @taxes = qsearch( 'cust_main_county', \%taxhash );
3058 my %taxhash_elim = %taxhash;
3060 my @elim = qw( taxclass county state );
3061 while ( !scalar(@taxes) && scalar(@elim) ) {
3062 $taxhash_elim{ shift(@elim) } = '';
3063 @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3066 @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3068 if $self->cust_main_exemption; #just to be safe
3070 if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3072 $_->set('pkgnum', $cust_pkg->pkgnum );
3073 $_->set('locationnum', $cust_pkg->locationnum );
3077 $taxes{''} = [ @taxes ];
3078 $taxes{'setup'} = [ @taxes ];
3079 $taxes{'recur'} = [ @taxes ];
3080 $taxes{$_} = [ @taxes ] foreach (@classes);
3082 # # maybe eliminate this entirely, along with all the 0% records
3083 # unless ( @taxes ) {
3085 # "fatal: can't find tax rate for state/county/country/taxclass ".
3086 # join('/', map $taxhash{$_}, qw(state county country taxclass) );
3089 } #if $conf->exists('enable_taxproducts') ...
3094 if ( $conf->exists('separate_usage') ) {
3095 my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
3096 my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
3097 push @display, new FS::cust_bill_pkg_display { type => 'S' };
3098 push @display, new FS::cust_bill_pkg_display { type => 'R' };
3099 push @display, new FS::cust_bill_pkg_display { type => 'U',
3102 if ($section && $summary) {
3103 $display[2]->post_total('Y');
3104 push @display, new FS::cust_bill_pkg_display { type => 'U',
3109 $cust_bill_pkg->set('display', \@display);
3111 my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3112 foreach my $key (keys %tax_cust_bill_pkg) {
3113 my @taxes = @{ $taxes{$key} || [] };
3114 my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3116 my %localtaxlisthash = ();
3117 foreach my $tax ( @taxes ) {
3119 my $taxname = ref( $tax ). ' '. $tax->taxnum;
3120 # $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3121 # ' locationnum'. $cust_pkg->locationnum
3122 # if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3124 $taxlisthash->{ $taxname } ||= [ $tax ];
3125 push @{ $taxlisthash->{ $taxname } }, $tax_cust_bill_pkg;
3127 $localtaxlisthash{ $taxname } ||= [ $tax ];
3128 push @{ $localtaxlisthash{ $taxname } }, $tax_cust_bill_pkg;
3132 warn "finding taxed taxes...\n" if $DEBUG > 2;
3133 foreach my $tax ( keys %localtaxlisthash ) {
3134 my $tax_object = shift @{ $localtaxlisthash{$tax} };
3135 warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3137 next unless $tax_object->can('tax_on_tax');
3139 foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3140 my $totname = ref( $tot ). ' '. $tot->taxnum;
3142 warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3144 next unless exists( $localtaxlisthash{ $totname } ); # only increase
3146 warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3147 my $hashref_or_error =
3148 $tax_object->taxline( $localtaxlisthash{$tax},
3149 'custnum' => $self->custnum,
3150 'invoice_time' => $invoice_time,
3152 return $hashref_or_error
3153 unless ref($hashref_or_error);
3155 $taxlisthash->{ $totname } ||= [ $tot ];
3156 push @{ $taxlisthash->{ $totname } }, $hashref_or_error->{amount};
3168 my $part_pkg = shift;
3172 my $geocode = $self->geocode('cch');
3174 my @taxclassnums = map { $_->taxclassnum }
3175 $part_pkg->part_pkg_taxoverride($class);
3177 unless (@taxclassnums) {
3178 @taxclassnums = map { $_->taxclassnum }
3179 grep { $_->taxable eq 'Y' }
3180 $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3182 warn "Found taxclassnum values of ". join(',', @taxclassnums)
3187 join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3189 @taxes = qsearch({ 'table' => 'tax_rate',
3190 'hashref' => { 'geocode' => $geocode, },
3191 'extra_sql' => $extra_sql,
3193 if scalar(@taxclassnums);
3195 warn "Found taxes ".
3196 join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3203 =item collect OPTIONS
3205 (Attempt to) collect money for this customer's outstanding invoices (see
3206 L<FS::cust_bill>). Usually used after the bill method.
3208 Actions are now triggered by billing events; see L<FS::part_event> and the
3209 billing events web interface. Old-style invoice events (see
3210 L<FS::part_bill_event>) have been deprecated.
3212 If there is an error, returns the error, otherwise returns false.
3214 Options are passed as name-value pairs.
3216 Currently available options are:
3222 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.
3226 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3230 set true to surpress email card/ACH decline notices.
3234 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3238 allows for one time override of normal customer billing method
3242 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)
3250 my( $self, %options ) = @_;
3251 my $invoice_time = $options{'invoice_time'} || time;
3254 local $SIG{HUP} = 'IGNORE';
3255 local $SIG{INT} = 'IGNORE';
3256 local $SIG{QUIT} = 'IGNORE';
3257 local $SIG{TERM} = 'IGNORE';
3258 local $SIG{TSTP} = 'IGNORE';
3259 local $SIG{PIPE} = 'IGNORE';
3261 my $oldAutoCommit = $FS::UID::AutoCommit;
3262 local $FS::UID::AutoCommit = 0;
3265 $self->select_for_update; #mutex
3268 my $balance = $self->balance;
3269 warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3272 if ( exists($options{'retry_card'}) ) {
3273 carp 'retry_card option passed to collect is deprecated; use retry';
3274 $options{'retry'} ||= $options{'retry_card'};
3276 if ( exists($options{'retry'}) && $options{'retry'} ) {
3277 my $error = $self->retry_realtime;
3279 $dbh->rollback if $oldAutoCommit;
3284 # false laziness w/pay_batch::import_results
3286 my $due_cust_event = $self->due_cust_event(
3287 'debug' => ( $options{'debug'} || 0 ),
3288 'time' => $invoice_time,
3289 'check_freq' => $options{'check_freq'},
3291 unless( ref($due_cust_event) ) {
3292 $dbh->rollback if $oldAutoCommit;
3293 return $due_cust_event;
3296 foreach my $cust_event ( @$due_cust_event ) {
3300 #re-eval event conditions (a previous event could have changed things)
3301 unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
3302 #don't leave stray "new/locked" records around
3303 my $error = $cust_event->delete;
3305 #gah, even with transactions
3306 $dbh->commit if $oldAutoCommit; #well.
3313 local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3314 warn " running cust_event ". $cust_event->eventnum. "\n"
3318 #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3319 if ( my $error = $cust_event->do_event() ) {
3320 #XXX wtf is this? figure out a proper dealio with return value
3322 # gah, even with transactions.
3323 $dbh->commit if $oldAutoCommit; #well.
3330 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3335 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3337 Inserts database records for and returns an ordered listref of new events due
3338 for this customer, as FS::cust_event objects (see L<FS::cust_event>). If no
3339 events are due, an empty listref is returned. If there is an error, returns a
3340 scalar error message.
3342 To actually run the events, call each event's test_condition method, and if
3343 still true, call the event's do_event method.
3345 Options are passed as a hashref or as a list of name-value pairs. Available
3352 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.
3356 "Current time" for the events.
3360 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)
3364 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3368 Explicitly pass the objects to be tested (typically used with eventtable).
3372 Set to true to return the objects, but not actually insert them into the
3379 sub due_cust_event {
3381 my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3384 #my $DEBUG = $opt{'debug'}
3385 local($DEBUG) = $opt{'debug'}
3386 if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3388 warn "$me due_cust_event called with options ".
3389 join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3392 $opt{'time'} ||= time;
3394 local $SIG{HUP} = 'IGNORE';
3395 local $SIG{INT} = 'IGNORE';
3396 local $SIG{QUIT} = 'IGNORE';
3397 local $SIG{TERM} = 'IGNORE';
3398 local $SIG{TSTP} = 'IGNORE';
3399 local $SIG{PIPE} = 'IGNORE';
3401 my $oldAutoCommit = $FS::UID::AutoCommit;
3402 local $FS::UID::AutoCommit = 0;
3405 $self->select_for_update #mutex
3406 unless $opt{testonly};
3409 # 1: find possible events (initial search)
3412 my @cust_event = ();
3414 my @eventtable = $opt{'eventtable'}
3415 ? ( $opt{'eventtable'} )
3416 : FS::part_event->eventtables_runorder;
3418 foreach my $eventtable ( @eventtable ) {
3421 if ( $opt{'objects'} ) {
3423 @objects = @{ $opt{'objects'} };
3427 #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3428 @objects = ( $eventtable eq 'cust_main' )
3430 : ( $self->$eventtable() );
3434 my @e_cust_event = ();
3436 my $cross = "CROSS JOIN $eventtable";
3437 $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3438 unless $eventtable eq 'cust_main';
3440 foreach my $object ( @objects ) {
3442 #this first search uses the condition_sql magic for optimization.
3443 #the more possible events we can eliminate in this step the better
3445 my $cross_where = '';
3446 my $pkey = $object->primary_key;
3447 $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3449 my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3451 FS::part_event_condition->where_conditions_sql( $eventtable,
3452 'time'=>$opt{'time'}
3454 my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3456 $extra_sql = "AND $extra_sql" if $extra_sql;
3458 #here is the agent virtualization
3459 $extra_sql .= " AND ( part_event.agentnum IS NULL
3460 OR part_event.agentnum = ". $self->agentnum. ' )';
3462 $extra_sql .= " $order";
3464 warn "searching for events for $eventtable ". $object->$pkey. "\n"
3465 if $opt{'debug'} > 2;
3466 my @part_event = qsearch( {
3467 'debug' => ( $opt{'debug'} > 3 ? 1 : 0 ),
3468 'select' => 'part_event.*',
3469 'table' => 'part_event',
3470 'addl_from' => "$cross $join",
3471 'hashref' => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3472 'eventtable' => $eventtable,
3475 'extra_sql' => "AND $cross_where $extra_sql",
3479 my $pkey = $object->primary_key;
3480 warn " ". scalar(@part_event).
3481 " possible events found for $eventtable ". $object->$pkey(). "\n";
3484 push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3488 warn " ". scalar(@e_cust_event).
3489 " subtotal possible cust events found for $eventtable\n"
3492 push @cust_event, @e_cust_event;
3496 warn " ". scalar(@cust_event).
3497 " total possible cust events found in initial search\n"
3501 # 2: test conditions
3506 @cust_event = grep $_->test_conditions( 'time' => $opt{'time'},
3507 'stats_hashref' => \%unsat ),
3510 warn " ". scalar(@cust_event). " cust events left satisfying conditions\n"
3513 warn " invalid conditions not eliminated with condition_sql:\n".
3514 join('', map " $_: ".$unsat{$_}."\n", keys %unsat )
3521 unless( $opt{testonly} ) {
3522 foreach my $cust_event ( @cust_event ) {
3524 my $error = $cust_event->insert();
3526 $dbh->rollback if $oldAutoCommit;
3533 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3539 warn " returning events: ". Dumper(@cust_event). "\n"
3546 =item retry_realtime
3548 Schedules realtime / batch credit card / electronic check / LEC billing
3549 events for for retry. Useful if card information has changed or manual
3550 retry is desired. The 'collect' method must be called to actually retry
3553 Implementation details: For either this customer, or for each of this
3554 customer's open invoices, changes the status of the first "done" (with
3555 statustext error) realtime processing event to "failed".
3559 sub retry_realtime {
3562 local $SIG{HUP} = 'IGNORE';
3563 local $SIG{INT} = 'IGNORE';
3564 local $SIG{QUIT} = 'IGNORE';
3565 local $SIG{TERM} = 'IGNORE';
3566 local $SIG{TSTP} = 'IGNORE';
3567 local $SIG{PIPE} = 'IGNORE';
3569 my $oldAutoCommit = $FS::UID::AutoCommit;
3570 local $FS::UID::AutoCommit = 0;
3573 #a little false laziness w/due_cust_event (not too bad, really)
3575 my $join = FS::part_event_condition->join_conditions_sql;
3576 my $order = FS::part_event_condition->order_conditions_sql;
3579 . join ( ' OR ' , map {
3580 "( part_event.eventtable = " . dbh->quote($_)
3581 . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3582 } FS::part_event->eventtables)
3585 #here is the agent virtualization
3586 my $agent_virt = " ( part_event.agentnum IS NULL
3587 OR part_event.agentnum = ". $self->agentnum. ' )';
3589 #XXX this shouldn't be hardcoded, actions should declare it...
3590 my @realtime_events = qw(
3591 cust_bill_realtime_card
3592 cust_bill_realtime_check
3593 cust_bill_realtime_lec
3597 my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3602 my @cust_event = qsearchs({
3603 'table' => 'cust_event',
3604 'select' => 'cust_event.*',
3605 'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3606 'hashref' => { 'status' => 'done' },
3607 'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3608 " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3611 my %seen_invnum = ();
3612 foreach my $cust_event (@cust_event) {
3614 #max one for the customer, one for each open invoice
3615 my $cust_X = $cust_event->cust_X;
3616 next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3620 or $cust_event->part_event->eventtable eq 'cust_bill'
3623 my $error = $cust_event->retry;
3625 $dbh->rollback if $oldAutoCommit;
3626 return "error scheduling event for retry: $error";
3631 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3636 # some horrid false laziness here to avoid refactor fallout
3637 # eventually realtime realtime_bop and realtime_refund_bop should go
3638 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
3640 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3642 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3643 via a Business::OnlinePayment realtime gateway. See
3644 L<http://420.am/business-onlinepayment> for supported gateways.
3646 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3648 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3650 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3651 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
3652 if set, will override the value from the customer record.
3654 I<description> is a free-text field passed to the gateway. It defaults to
3655 "Internet services".
3657 If an I<invnum> is specified, this payment (if successful) is applied to the
3658 specified invoice. If you don't specify an I<invnum> you might want to
3659 call the B<apply_payments> method.
3661 I<quiet> can be set true to surpress email decline notices.
3663 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
3664 resulting paynum, if any.
3666 I<payunique> is a unique identifier for this payment.
3668 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
3675 return $self->_new_realtime_bop(@_)
3676 if $self->_new_bop_required();
3678 my( $method, $amount, %options ) = @_;
3680 warn "$me realtime_bop: $method $amount\n";
3681 warn " $_ => $options{$_}\n" foreach keys %options;
3684 $options{'description'} ||= 'Internet services';
3686 return $self->fake_bop($method, $amount, %options) if $options{'fake'};
3688 eval "use Business::OnlinePayment";
3691 my $payinfo = exists($options{'payinfo'})
3692 ? $options{'payinfo'}
3695 my %method2payby = (
3702 # check for banned credit card/ACH
3705 my $ban = qsearchs('banned_pay', {
3706 'payby' => $method2payby{$method},
3707 'payinfo' => md5_base64($payinfo),
3709 return "Banned credit card" if $ban;
3712 # set taxclass and trans_is_recur based on invnum if there is one
3716 my $trans_is_recur = 0;
3717 if ( $options{'invnum'} ) {
3719 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
3720 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
3723 map { $_->part_pkg }
3725 map { $_->cust_pkg }
3726 $cust_bill->cust_bill_pkg;
3728 my @taxclasses = map $_->taxclass, @part_pkg;
3729 $taxclass = $taxclasses[0]
3730 unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
3731 #different taxclasses
3733 if grep { $_->freq ne '0' } @part_pkg;
3741 #look for an agent gateway override first
3743 if ( $method eq 'CC' ) {
3744 $cardtype = cardtype($payinfo);
3745 } elsif ( $method eq 'ECHECK' ) {
3748 $cardtype = $method;
3752 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3753 cardtype => $cardtype,
3754 taxclass => $taxclass, } )
3755 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3757 taxclass => $taxclass, } )
3758 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3759 cardtype => $cardtype,
3761 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3763 taxclass => '', } );
3765 my $payment_gateway = '';
3766 my( $processor, $login, $password, $action, @bop_options );
3767 if ( $override ) { #use a payment gateway override
3769 $payment_gateway = $override->payment_gateway;
3771 $processor = $payment_gateway->gateway_module;
3772 $login = $payment_gateway->gateway_username;
3773 $password = $payment_gateway->gateway_password;
3774 $action = $payment_gateway->gateway_action;
3775 @bop_options = $payment_gateway->options;
3777 } else { #use the standard settings from the config
3779 ( $processor, $login, $password, $action, @bop_options ) =
3780 $self->default_payment_gateway($method);
3788 my $address = exists($options{'address1'})
3789 ? $options{'address1'}
3791 my $address2 = exists($options{'address2'})
3792 ? $options{'address2'}
3794 $address .= ", ". $address2 if length($address2);
3796 my $o_payname = exists($options{'payname'})
3797 ? $options{'payname'}
3799 my($payname, $payfirst, $paylast);
3800 if ( $o_payname && $method ne 'ECHECK' ) {
3801 ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3802 or return "Illegal payname $payname";
3803 ($payfirst, $paylast) = ($1, $2);
3805 $payfirst = $self->getfield('first');
3806 $paylast = $self->getfield('last');
3807 $payname = "$payfirst $paylast";
3810 my @invoicing_list = $self->invoicing_list_emailonly;
3811 if ( $conf->exists('emailinvoiceautoalways')
3812 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3813 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3814 push @invoicing_list, $self->all_emails;
3817 my $email = ($conf->exists('business-onlinepayment-email-override'))
3818 ? $conf->config('business-onlinepayment-email-override')
3819 : $invoicing_list[0];
3823 my $payip = exists($options{'payip'})
3826 $content{customer_ip} = $payip
3829 $content{invoice_number} = $options{'invnum'}
3830 if exists($options{'invnum'}) && length($options{'invnum'});
3832 $content{email_customer} =
3833 ( $conf->exists('business-onlinepayment-email_customer')
3834 || $conf->exists('business-onlinepayment-email-override') );
3837 if ( $method eq 'CC' ) {
3839 $content{card_number} = $payinfo;
3840 $paydate = exists($options{'paydate'})
3841 ? $options{'paydate'}
3843 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3844 $content{expiration} = "$2/$1";
3846 my $paycvv = exists($options{'paycvv'})
3847 ? $options{'paycvv'}
3849 $content{cvv2} = $paycvv
3852 my $paystart_month = exists($options{'paystart_month'})
3853 ? $options{'paystart_month'}
3854 : $self->paystart_month;
3856 my $paystart_year = exists($options{'paystart_year'})
3857 ? $options{'paystart_year'}
3858 : $self->paystart_year;
3860 $content{card_start} = "$paystart_month/$paystart_year"
3861 if $paystart_month && $paystart_year;
3863 my $payissue = exists($options{'payissue'})
3864 ? $options{'payissue'}
3866 $content{issue_number} = $payissue if $payissue;
3868 if ( $self->_bop_recurring_billing( 'payinfo' => $payinfo,
3869 'trans_is_recur' => $trans_is_recur,
3873 $content{recurring_billing} = 'YES';
3874 $content{acct_code} = 'rebill'
3875 if $conf->exists('credit_card-recurring_billing_acct_code');
3878 } elsif ( $method eq 'ECHECK' ) {
3879 ( $content{account_number}, $content{routing_code} ) =
3880 split('@', $payinfo);
3881 $content{bank_name} = $o_payname;
3882 $content{bank_state} = exists($options{'paystate'})
3883 ? $options{'paystate'}
3884 : $self->getfield('paystate');
3885 $content{account_type} = exists($options{'paytype'})
3886 ? uc($options{'paytype'}) || 'CHECKING'
3887 : uc($self->getfield('paytype')) || 'CHECKING';
3888 $content{account_name} = $payname;
3889 $content{customer_org} = $self->company ? 'B' : 'I';
3890 $content{state_id} = exists($options{'stateid'})
3891 ? $options{'stateid'}
3892 : $self->getfield('stateid');
3893 $content{state_id_state} = exists($options{'stateid_state'})
3894 ? $options{'stateid_state'}
3895 : $self->getfield('stateid_state');
3896 $content{customer_ssn} = exists($options{'ss'})
3899 } elsif ( $method eq 'LEC' ) {
3900 $content{phone} = $payinfo;
3904 # run transaction(s)
3907 my $balance = exists( $options{'balance'} )
3908 ? $options{'balance'}
3911 $self->select_for_update; #mutex ... just until we get our pending record in
3913 #the checks here are intended to catch concurrent payments
3914 #double-form-submission prevention is taken care of in cust_pay_pending::check
3917 return "The customer's balance has changed; $method transaction aborted."
3918 if $self->balance < $balance;
3919 #&& $self->balance < $amount; #might as well anyway?
3921 #also check and make sure there aren't *other* pending payments for this cust
3923 my @pending = qsearch('cust_pay_pending', {
3924 'custnum' => $self->custnum,
3925 'status' => { op=>'!=', value=>'done' }
3927 return "A payment is already being processed for this customer (".
3928 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
3929 "); $method transaction aborted."
3930 if scalar(@pending);
3932 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
3934 my $cust_pay_pending = new FS::cust_pay_pending {
3935 'custnum' => $self->custnum,
3936 #'invnum' => $options{'invnum'},
3939 'payby' => $method2payby{$method},
3940 'payinfo' => $payinfo,
3941 'paydate' => $paydate,
3942 'recurring_billing' => $content{recurring_billing},
3944 'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
3946 $cust_pay_pending->payunique( $options{payunique} )
3947 if defined($options{payunique}) && length($options{payunique});
3948 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
3949 return $cpp_new_err if $cpp_new_err;
3951 my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3953 my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3954 $transaction->content(
3957 'password' => $password,
3958 'action' => $action1,
3959 'description' => $options{'description'},
3960 'amount' => $amount,
3961 #'invoice_number' => $options{'invnum'},
3962 'customer_id' => $self->custnum,
3963 'last_name' => $paylast,
3964 'first_name' => $payfirst,
3966 'address' => $address,
3967 'city' => ( exists($options{'city'})
3970 'state' => ( exists($options{'state'})
3973 'zip' => ( exists($options{'zip'})
3976 'country' => ( exists($options{'country'})
3977 ? $options{'country'}
3979 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
3981 'phone' => $self->daytime || $self->night,
3985 $cust_pay_pending->status('pending');
3986 my $cpp_pending_err = $cust_pay_pending->replace;
3987 return $cpp_pending_err if $cpp_pending_err;
3990 my $BOP_TESTING = 0;
3991 my $BOP_TESTING_SUCCESS = 1;
3993 unless ( $BOP_TESTING ) {
3994 $transaction->submit();
3996 if ( $BOP_TESTING_SUCCESS ) {
3997 $transaction->is_success(1);
3998 $transaction->authorization('fake auth');
4000 $transaction->is_success(0);
4001 $transaction->error_message('fake failure');
4005 if ( $transaction->is_success() && $action2 ) {
4007 $cust_pay_pending->status('authorized');
4008 my $cpp_authorized_err = $cust_pay_pending->replace;
4009 return $cpp_authorized_err if $cpp_authorized_err;
4011 my $auth = $transaction->authorization;
4012 my $ordernum = $transaction->can('order_number')
4013 ? $transaction->order_number
4017 new Business::OnlinePayment( $processor, @bop_options );
4024 password => $password,
4025 order_number => $ordernum,
4027 authorization => $auth,
4028 description => $options{'description'},
4031 foreach my $field (qw( authorization_source_code returned_ACI
4032 transaction_identifier validation_code
4033 transaction_sequence_num local_transaction_date
4034 local_transaction_time AVS_result_code )) {
4035 $capture{$field} = $transaction->$field() if $transaction->can($field);
4038 $capture->content( %capture );
4042 unless ( $capture->is_success ) {
4043 my $e = "Authorization successful but capture failed, custnum #".
4044 $self->custnum. ': '. $capture->result_code.
4045 ": ". $capture->error_message;
4052 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4053 my $cpp_captured_err = $cust_pay_pending->replace;
4054 return $cpp_captured_err if $cpp_captured_err;
4057 # remove paycvv after initial transaction
4060 #false laziness w/misc/process/payment.cgi - check both to make sure working
4062 if ( defined $self->dbdef_table->column('paycvv')
4063 && length($self->paycvv)
4064 && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4066 my $error = $self->remove_cvv;
4068 warn "WARNING: error removing cvv: $error\n";
4076 if ( $transaction->is_success() ) {
4079 if ( $payment_gateway ) { # agent override
4080 $paybatch = $payment_gateway->gatewaynum. '-';
4083 $paybatch .= "$processor:". $transaction->authorization;
4085 $paybatch .= ':'. $transaction->order_number
4086 if $transaction->can('order_number')
4087 && length($transaction->order_number);
4089 my $cust_pay = new FS::cust_pay ( {
4090 'custnum' => $self->custnum,
4091 'invnum' => $options{'invnum'},
4094 'payby' => $method2payby{$method},
4095 'payinfo' => $payinfo,
4096 'paybatch' => $paybatch,
4097 'paydate' => $paydate,
4099 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4100 $cust_pay->payunique( $options{payunique} )
4101 if defined($options{payunique}) && length($options{payunique});
4103 my $oldAutoCommit = $FS::UID::AutoCommit;
4104 local $FS::UID::AutoCommit = 0;
4107 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4109 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4112 $cust_pay->invnum(''); #try again with no specific invnum
4113 my $error2 = $cust_pay->insert( $options{'manual'} ?
4114 ( 'manual' => 1 ) : ()
4117 # gah. but at least we have a record of the state we had to abort in
4118 # from cust_pay_pending now.
4119 my $e = "WARNING: $method captured but payment not recorded - ".
4120 "error inserting payment ($processor): $error2".
4121 " (previously tried insert with invnum #$options{'invnum'}" .
4122 ": $error ) - pending payment saved as paypendingnum ".
4123 $cust_pay_pending->paypendingnum. "\n";
4129 if ( $options{'paynum_ref'} ) {
4130 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4133 $cust_pay_pending->status('done');
4134 $cust_pay_pending->statustext('captured');
4135 $cust_pay_pending->paynum($cust_pay->paynum);
4136 my $cpp_done_err = $cust_pay_pending->replace;
4138 if ( $cpp_done_err ) {
4140 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4141 my $e = "WARNING: $method captured but payment not recorded - ".
4142 "error updating status for paypendingnum ".
4143 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4149 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4150 return ''; #no error
4156 my $perror = "$processor error: ". $transaction->error_message;
4158 unless ( $transaction->error_message ) {
4161 if ( $transaction->can('response_page') ) {
4163 'page' => ( $transaction->can('response_page')
4164 ? $transaction->response_page
4167 'code' => ( $transaction->can('response_code')
4168 ? $transaction->response_code
4171 'headers' => ( $transaction->can('response_headers')
4172 ? $transaction->response_headers
4178 "No additional debugging information available for $processor";
4181 $perror .= "No error_message returned from $processor -- ".
4182 ( ref($t_response) ? Dumper($t_response) : $t_response );
4186 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4187 && $conf->exists('emaildecline')
4188 && grep { $_ ne 'POST' } $self->invoicing_list
4189 && ! grep { $transaction->error_message =~ /$_/ }
4190 $conf->config('emaildecline-exclude')
4192 my @templ = $conf->config('declinetemplate');
4193 my $template = new Text::Template (
4195 SOURCE => [ map "$_\n", @templ ],
4196 ) or return "($perror) can't create template: $Text::Template::ERROR";
4197 $template->compile()
4198 or return "($perror) can't compile template: $Text::Template::ERROR";
4200 my $templ_hash = { error => $transaction->error_message };
4202 my $error = send_email(
4203 'from' => $conf->config('invoice_from', $self->agentnum ),
4204 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4205 'subject' => 'Your payment could not be processed',
4206 'body' => [ $template->fill_in(HASH => $templ_hash) ],
4209 $perror .= " (also received error sending decline notification: $error)"
4214 $cust_pay_pending->status('done');
4215 $cust_pay_pending->statustext("declined: $perror");
4216 my $cpp_done_err = $cust_pay_pending->replace;
4217 if ( $cpp_done_err ) {
4218 my $e = "WARNING: $method declined but pending payment not resolved - ".
4219 "error updating status for paypendingnum ".
4220 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4222 $perror = "$e ($perror)";
4230 sub _bop_recurring_billing {
4231 my( $self, %opt ) = @_;
4233 my $method = $conf->config('credit_card-recurring_billing_flag');
4235 if ( $method eq 'transaction_is_recur' ) {
4237 return 1 if $opt{'trans_is_recur'};
4241 my %hash = ( 'custnum' => $self->custnum,
4246 if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4247 || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4258 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4260 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4261 via a Business::OnlinePayment realtime gateway. See
4262 L<http://420.am/business-onlinepayment> for supported gateways.
4264 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4266 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4268 Most gateways require a reference to an original payment transaction to refund,
4269 so you probably need to specify a I<paynum>.
4271 I<amount> defaults to the original amount of the payment if not specified.
4273 I<reason> specifies a reason for the refund.
4275 I<paydate> specifies the expiration date for a credit card overriding the
4276 value from the customer record or the payment record. Specified as yyyy-mm-dd
4278 Implementation note: If I<amount> is unspecified or equal to the amount of the
4279 orignal payment, first an attempt is made to "void" the transaction via
4280 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4281 the normal attempt is made to "refund" ("credit") the transaction via the
4282 gateway is attempted.
4284 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4285 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4286 #if set, will override the value from the customer record.
4288 #If an I<invnum> is specified, this payment (if successful) is applied to the
4289 #specified invoice. If you don't specify an I<invnum> you might want to
4290 #call the B<apply_payments> method.
4294 #some false laziness w/realtime_bop, not enough to make it worth merging
4295 #but some useful small subs should be pulled out
4296 sub realtime_refund_bop {
4299 return $self->_new_realtime_refund_bop(@_)
4300 if $self->_new_bop_required();
4302 my( $method, %options ) = @_;
4304 warn "$me realtime_refund_bop: $method refund\n";
4305 warn " $_ => $options{$_}\n" foreach keys %options;
4308 eval "use Business::OnlinePayment";
4312 # look up the original payment and optionally a gateway for that payment
4316 my $amount = $options{'amount'};
4318 my( $processor, $login, $password, @bop_options ) ;
4319 my( $auth, $order_number ) = ( '', '', '' );
4321 if ( $options{'paynum'} ) {
4323 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
4324 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4325 or return "Unknown paynum $options{'paynum'}";
4326 $amount ||= $cust_pay->paid;
4328 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4329 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4330 $cust_pay->paybatch;
4331 my $gatewaynum = '';
4332 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4334 if ( $gatewaynum ) { #gateway for the payment to be refunded
4336 my $payment_gateway =
4337 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4338 die "payment gateway $gatewaynum not found"
4339 unless $payment_gateway;
4341 $processor = $payment_gateway->gateway_module;
4342 $login = $payment_gateway->gateway_username;
4343 $password = $payment_gateway->gateway_password;
4344 @bop_options = $payment_gateway->options;
4346 } else { #try the default gateway
4348 my( $conf_processor, $unused_action );
4349 ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4350 $self->default_payment_gateway($method);
4352 return "processor of payment $options{'paynum'} $processor does not".
4353 " match default processor $conf_processor"
4354 unless $processor eq $conf_processor;
4359 } else { # didn't specify a paynum, so look for agent gateway overrides
4360 # like a normal transaction
4363 if ( $method eq 'CC' ) {
4364 $cardtype = cardtype($self->payinfo);
4365 } elsif ( $method eq 'ECHECK' ) {
4368 $cardtype = $method;
4371 qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4372 cardtype => $cardtype,
4374 || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4376 taxclass => '', } );
4378 if ( $override ) { #use a payment gateway override
4380 my $payment_gateway = $override->payment_gateway;
4382 $processor = $payment_gateway->gateway_module;
4383 $login = $payment_gateway->gateway_username;
4384 $password = $payment_gateway->gateway_password;
4385 #$action = $payment_gateway->gateway_action;
4386 @bop_options = $payment_gateway->options;
4388 } else { #use the standard settings from the config
4391 ( $processor, $login, $password, $unused_action, @bop_options ) =
4392 $self->default_payment_gateway($method);
4397 return "neither amount nor paynum specified" unless $amount;
4402 'password' => $password,
4403 'order_number' => $order_number,
4404 'amount' => $amount,
4405 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4407 $content{authorization} = $auth
4408 if length($auth); #echeck/ACH transactions have an order # but no auth
4409 #(at least with authorize.net)
4411 my $disable_void_after;
4412 if ($conf->exists('disable_void_after')
4413 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4414 $disable_void_after = $1;
4417 #first try void if applicable
4418 if ( $cust_pay && $cust_pay->paid == $amount
4420 ( not defined($disable_void_after) )
4421 || ( time < ($cust_pay->_date + $disable_void_after ) )
4424 warn " attempting void\n" if $DEBUG > 1;
4425 my $void = new Business::OnlinePayment( $processor, @bop_options );
4426 $void->content( 'action' => 'void', %content );
4428 if ( $void->is_success ) {
4429 my $error = $cust_pay->void($options{'reason'});
4431 # gah, even with transactions.
4432 my $e = 'WARNING: Card/ACH voided but database not updated - '.
4433 "error voiding payment: $error";
4437 warn " void successful\n" if $DEBUG > 1;
4442 warn " void unsuccessful, trying refund\n"
4446 my $address = $self->address1;
4447 $address .= ", ". $self->address2 if $self->address2;
4449 my($payname, $payfirst, $paylast);
4450 if ( $self->payname && $method ne 'ECHECK' ) {
4451 $payname = $self->payname;
4452 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4453 or return "Illegal payname $payname";
4454 ($payfirst, $paylast) = ($1, $2);
4456 $payfirst = $self->getfield('first');
4457 $paylast = $self->getfield('last');
4458 $payname = "$payfirst $paylast";
4461 my @invoicing_list = $self->invoicing_list_emailonly;
4462 if ( $conf->exists('emailinvoiceautoalways')
4463 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4464 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4465 push @invoicing_list, $self->all_emails;
4468 my $email = ($conf->exists('business-onlinepayment-email-override'))
4469 ? $conf->config('business-onlinepayment-email-override')
4470 : $invoicing_list[0];
4472 my $payip = exists($options{'payip'})
4475 $content{customer_ip} = $payip
4479 if ( $method eq 'CC' ) {
4482 $content{card_number} = $payinfo = $cust_pay->payinfo;
4483 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4484 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4485 ($content{expiration} = "$2/$1"); # where available
4487 $content{card_number} = $payinfo = $self->payinfo;
4488 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4489 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4490 $content{expiration} = "$2/$1";
4493 } elsif ( $method eq 'ECHECK' ) {
4496 $payinfo = $cust_pay->payinfo;
4498 $payinfo = $self->payinfo;
4500 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4501 $content{bank_name} = $self->payname;
4502 $content{account_type} = 'CHECKING';
4503 $content{account_name} = $payname;
4504 $content{customer_org} = $self->company ? 'B' : 'I';
4505 $content{customer_ssn} = $self->ss;
4506 } elsif ( $method eq 'LEC' ) {
4507 $content{phone} = $payinfo = $self->payinfo;
4511 my $refund = new Business::OnlinePayment( $processor, @bop_options );
4512 my %sub_content = $refund->content(
4513 'action' => 'credit',
4514 'customer_id' => $self->custnum,
4515 'last_name' => $paylast,
4516 'first_name' => $payfirst,
4518 'address' => $address,
4519 'city' => $self->city,
4520 'state' => $self->state,
4521 'zip' => $self->zip,
4522 'country' => $self->country,
4524 'phone' => $self->daytime || $self->night,
4527 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
4531 return "$processor error: ". $refund->error_message
4532 unless $refund->is_success();
4534 my %method2payby = (
4540 my $paybatch = "$processor:". $refund->authorization;
4541 $paybatch .= ':'. $refund->order_number
4542 if $refund->can('order_number') && $refund->order_number;
4544 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4545 my @cust_bill_pay = $cust_pay->cust_bill_pay;
4546 last unless @cust_bill_pay;
4547 my $cust_bill_pay = pop @cust_bill_pay;
4548 my $error = $cust_bill_pay->delete;
4552 my $cust_refund = new FS::cust_refund ( {
4553 'custnum' => $self->custnum,
4554 'paynum' => $options{'paynum'},
4555 'refund' => $amount,
4557 'payby' => $method2payby{$method},
4558 'payinfo' => $payinfo,
4559 'paybatch' => $paybatch,
4560 'reason' => $options{'reason'} || 'card or ACH refund',
4562 my $error = $cust_refund->insert;
4564 $cust_refund->paynum(''); #try again with no specific paynum
4565 my $error2 = $cust_refund->insert;
4567 # gah, even with transactions.
4568 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4569 "error inserting refund ($processor): $error2".
4570 " (previously tried insert with paynum #$options{'paynum'}" .
4581 # does the configuration indicate the new bop routines are required?
4583 sub _new_bop_required {
4586 my $botpp = 'Business::OnlineThirdPartyPayment';
4589 if ( $conf->config('business-onlinepayment-namespace') eq $botpp ||
4590 scalar( grep { $_->gateway_namespace eq $botpp }
4591 qsearch( 'payment_gateway', { 'disabled' => '' } )
4600 =item realtime_collect [ OPTION => VALUE ... ]
4602 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4603 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4604 gateway. See L<http://420.am/business-onlinepayment> and
4605 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4607 On failure returns an error message.
4609 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.
4611 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4613 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>. If none is specified
4614 then it is deduced from the customer record.
4616 If no I<amount> is specified, then the customer balance is used.
4618 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4619 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4620 if set, will override the value from the customer record.
4622 I<description> is a free-text field passed to the gateway. It defaults to
4623 "Internet services".
4625 If an I<invnum> is specified, this payment (if successful) is applied to the
4626 specified invoice. If you don't specify an I<invnum> you might want to
4627 call the B<apply_payments> method.
4629 I<quiet> can be set true to surpress email decline notices.
4631 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4632 resulting paynum, if any.
4634 I<payunique> is a unique identifier for this payment.
4636 I<session_id> is a session identifier associated with this payment.
4638 I<depend_jobnum> allows payment capture to unlock export jobs
4642 sub realtime_collect {
4643 my( $self, %options ) = @_;
4646 warn "$me realtime_collect:\n";
4647 warn " $_ => $options{$_}\n" foreach keys %options;
4650 $options{amount} = $self->balance unless exists( $options{amount} );
4651 $options{method} = FS::payby->payby2bop($self->payby)
4652 unless exists( $options{method} );
4654 return $self->realtime_bop({%options});
4658 =item _realtime_bop { [ ARG => VALUE ... ] }
4660 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4661 via a Business::OnlinePayment realtime gateway. See
4662 L<http://420.am/business-onlinepayment> for supported gateways.
4664 Required arguments in the hashref are I<method>, and I<amount>
4666 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4668 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4670 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4671 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
4672 if set, will override the value from the customer record.
4674 I<description> is a free-text field passed to the gateway. It defaults to
4675 "Internet services".
4677 If an I<invnum> is specified, this payment (if successful) is applied to the
4678 specified invoice. If you don't specify an I<invnum> you might want to
4679 call the B<apply_payments> method.
4681 I<quiet> can be set true to surpress email decline notices.
4683 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
4684 resulting paynum, if any.
4686 I<payunique> is a unique identifier for this payment.
4688 I<session_id> is a session identifier associated with this payment.
4690 I<depend_jobnum> allows payment capture to unlock export jobs
4692 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4696 # some helper routines
4697 sub _payment_gateway {
4698 my ($self, $options) = @_;
4700 $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
4701 unless exists($options->{payment_gateway});
4703 $options->{payment_gateway};
4707 my ($self, $options) = @_;
4710 'login' => $options->{payment_gateway}->gateway_username,
4711 'password' => $options->{payment_gateway}->gateway_password,
4716 my ($self, $options) = @_;
4718 $options->{payment_gateway}->gatewaynum
4719 ? $options->{payment_gateway}->options
4720 : @{ $options->{payment_gateway}->get('options') };
4724 my ($self, $options) = @_;
4726 $options->{description} ||= 'Internet services';
4727 $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
4728 $options->{invnum} ||= '';
4729 $options->{payname} = $self->payname unless exists( $options->{payname} );
4733 my ($self, $options) = @_;
4736 $content{address} = exists($options->{'address1'})
4737 ? $options->{'address1'}
4739 my $address2 = exists($options->{'address2'})
4740 ? $options->{'address2'}
4742 $content{address} .= ", ". $address2 if length($address2);
4744 my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
4745 $content{customer_ip} = $payip if length($payip);
4747 $content{invoice_number} = $options->{'invnum'}
4748 if exists($options->{'invnum'}) && length($options->{'invnum'});
4750 $content{email_customer} =
4751 ( $conf->exists('business-onlinepayment-email_customer')
4752 || $conf->exists('business-onlinepayment-email-override') );
4754 $content{payfirst} = $self->getfield('first');
4755 $content{paylast} = $self->getfield('last');
4757 $content{account_name} = "$content{payfirst} $content{paylast}"
4758 if $options->{method} eq 'ECHECK';
4760 $content{name} = $options->{payname};
4761 $content{name} = $content{account_name} if exists($content{account_name});
4763 $content{city} = exists($options->{city})
4766 $content{state} = exists($options->{state})
4769 $content{zip} = exists($options->{zip})
4772 $content{country} = exists($options->{country})
4773 ? $options->{country}
4775 $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
4776 $content{phone} = $self->daytime || $self->night;
4781 my %bop_method2payby = (
4787 sub _new_realtime_bop {
4791 if (ref($_[0]) eq 'HASH') {
4792 %options = %{$_[0]};
4794 my ( $method, $amount ) = ( shift, shift );
4796 $options{method} = $method;
4797 $options{amount} = $amount;
4801 warn "$me realtime_bop (new): $options{method} $options{amount}\n";
4802 warn " $_ => $options{$_}\n" foreach keys %options;
4805 return $self->fake_bop(%options) if $options{'fake'};
4807 $self->_bop_defaults(\%options);
4810 # set trans_is_recur based on invnum if there is one
4813 my $trans_is_recur = 0;
4814 if ( $options{'invnum'} ) {
4816 my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4817 die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4820 map { $_->part_pkg }
4822 map { $_->cust_pkg }
4823 $cust_bill->cust_bill_pkg;
4826 if grep { $_->freq ne '0' } @part_pkg;
4834 my $payment_gateway = $self->_payment_gateway( \%options );
4835 my $namespace = $payment_gateway->gateway_namespace;
4837 eval "use $namespace";
4841 # check for banned credit card/ACH
4844 my $ban = qsearchs('banned_pay', {
4845 'payby' => $bop_method2payby{$options{method}},
4846 'payinfo' => md5_base64($options{payinfo}),
4848 return "Banned credit card" if $ban;
4854 my (%bop_content) = $self->_bop_content(\%options);
4856 if ( $options{method} ne 'ECHECK' ) {
4857 $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4858 or return "Illegal payname $options{payname}";
4859 ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
4862 my @invoicing_list = $self->invoicing_list_emailonly;
4863 if ( $conf->exists('emailinvoiceautoalways')
4864 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4865 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4866 push @invoicing_list, $self->all_emails;
4869 my $email = ($conf->exists('business-onlinepayment-email-override'))
4870 ? $conf->config('business-onlinepayment-email-override')
4871 : $invoicing_list[0];
4875 if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
4877 $content{card_number} = $options{payinfo};
4878 $paydate = exists($options{'paydate'})
4879 ? $options{'paydate'}
4881 $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4882 $content{expiration} = "$2/$1";
4884 my $paycvv = exists($options{'paycvv'})
4885 ? $options{'paycvv'}
4887 $content{cvv2} = $paycvv
4890 my $paystart_month = exists($options{'paystart_month'})
4891 ? $options{'paystart_month'}
4892 : $self->paystart_month;
4894 my $paystart_year = exists($options{'paystart_year'})
4895 ? $options{'paystart_year'}
4896 : $self->paystart_year;
4898 $content{card_start} = "$paystart_month/$paystart_year"
4899 if $paystart_month && $paystart_year;
4901 my $payissue = exists($options{'payissue'})
4902 ? $options{'payissue'}
4904 $content{issue_number} = $payissue if $payissue;
4906 if ( $self->_bop_recurring_billing( 'payinfo' => $options{'payinfo'},
4907 'trans_is_recur' => $trans_is_recur,
4911 $content{recurring_billing} = 'YES';
4912 $content{acct_code} = 'rebill'
4913 if $conf->exists('credit_card-recurring_billing_acct_code');
4916 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
4917 ( $content{account_number}, $content{routing_code} ) =
4918 split('@', $options{payinfo});
4919 $content{bank_name} = $options{payname};
4920 $content{bank_state} = exists($options{'paystate'})
4921 ? $options{'paystate'}
4922 : $self->getfield('paystate');
4923 $content{account_type} = exists($options{'paytype'})
4924 ? uc($options{'paytype'}) || 'CHECKING'
4925 : uc($self->getfield('paytype')) || 'CHECKING';
4926 $content{customer_org} = $self->company ? 'B' : 'I';
4927 $content{state_id} = exists($options{'stateid'})
4928 ? $options{'stateid'}
4929 : $self->getfield('stateid');
4930 $content{state_id_state} = exists($options{'stateid_state'})
4931 ? $options{'stateid_state'}
4932 : $self->getfield('stateid_state');
4933 $content{customer_ssn} = exists($options{'ss'})
4936 } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
4937 $content{phone} = $options{payinfo};
4938 } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
4945 # run transaction(s)
4948 my $balance = exists( $options{'balance'} )
4949 ? $options{'balance'}
4952 $self->select_for_update; #mutex ... just until we get our pending record in
4954 #the checks here are intended to catch concurrent payments
4955 #double-form-submission prevention is taken care of in cust_pay_pending::check
4958 return "The customer's balance has changed; $options{method} transaction aborted."
4959 if $self->balance < $balance;
4960 #&& $self->balance < $options{amount}; #might as well anyway?
4962 #also check and make sure there aren't *other* pending payments for this cust
4964 my @pending = qsearch('cust_pay_pending', {
4965 'custnum' => $self->custnum,
4966 'status' => { op=>'!=', value=>'done' }
4968 return "A payment is already being processed for this customer (".
4969 join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4970 "); $options{method} transaction aborted."
4971 if scalar(@pending);
4973 #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4975 my $cust_pay_pending = new FS::cust_pay_pending {
4976 'custnum' => $self->custnum,
4977 #'invnum' => $options{'invnum'},
4978 'paid' => $options{amount},
4980 'payby' => $bop_method2payby{$options{method}},
4981 'payinfo' => $options{payinfo},
4982 'paydate' => $paydate,
4983 'recurring_billing' => $content{recurring_billing},
4985 'gatewaynum' => $payment_gateway->gatewaynum || '',
4986 'session_id' => $options{session_id} || '',
4987 'jobnum' => $options{depend_jobnum} || '',
4989 $cust_pay_pending->payunique( $options{payunique} )
4990 if defined($options{payunique}) && length($options{payunique});
4991 my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4992 return $cpp_new_err if $cpp_new_err;
4994 my( $action1, $action2 ) =
4995 split( /\s*\,\s*/, $payment_gateway->gateway_action );
4997 my $transaction = new $namespace( $payment_gateway->gateway_module,
4998 $self->_bop_options(\%options),
5001 $transaction->content(
5002 'type' => $options{method},
5003 $self->_bop_auth(\%options),
5004 'action' => $action1,
5005 'description' => $options{'description'},
5006 'amount' => $options{amount},
5007 #'invoice_number' => $options{'invnum'},
5008 'customer_id' => $self->custnum,
5010 'reference' => $cust_pay_pending->paypendingnum, #for now
5015 $cust_pay_pending->status('pending');
5016 my $cpp_pending_err = $cust_pay_pending->replace;
5017 return $cpp_pending_err if $cpp_pending_err;
5020 my $BOP_TESTING = 0;
5021 my $BOP_TESTING_SUCCESS = 1;
5023 unless ( $BOP_TESTING ) {
5024 $transaction->submit();
5026 if ( $BOP_TESTING_SUCCESS ) {
5027 $transaction->is_success(1);
5028 $transaction->authorization('fake auth');
5030 $transaction->is_success(0);
5031 $transaction->error_message('fake failure');
5035 if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5037 return { reference => $cust_pay_pending->paypendingnum,
5038 map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5040 } elsif ( $transaction->is_success() && $action2 ) {
5042 $cust_pay_pending->status('authorized');
5043 my $cpp_authorized_err = $cust_pay_pending->replace;
5044 return $cpp_authorized_err if $cpp_authorized_err;
5046 my $auth = $transaction->authorization;
5047 my $ordernum = $transaction->can('order_number')
5048 ? $transaction->order_number
5052 new Business::OnlinePayment( $payment_gateway->gateway_module,
5053 $self->_bop_options(\%options),
5058 type => $options{method},
5060 $self->_bop_auth(\%options),
5061 order_number => $ordernum,
5062 amount => $options{amount},
5063 authorization => $auth,
5064 description => $options{'description'},
5067 foreach my $field (qw( authorization_source_code returned_ACI
5068 transaction_identifier validation_code
5069 transaction_sequence_num local_transaction_date
5070 local_transaction_time AVS_result_code )) {
5071 $capture{$field} = $transaction->$field() if $transaction->can($field);
5074 $capture->content( %capture );
5078 unless ( $capture->is_success ) {
5079 my $e = "Authorization successful but capture failed, custnum #".
5080 $self->custnum. ': '. $capture->result_code.
5081 ": ". $capture->error_message;
5089 # remove paycvv after initial transaction
5092 #false laziness w/misc/process/payment.cgi - check both to make sure working
5094 if ( defined $self->dbdef_table->column('paycvv')
5095 && length($self->paycvv)
5096 && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5098 my $error = $self->remove_cvv;
5100 warn "WARNING: error removing cvv: $error\n";
5108 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5120 if (ref($_[0]) eq 'HASH') {
5121 %options = %{$_[0]};
5123 my ( $method, $amount ) = ( shift, shift );
5125 $options{method} = $method;
5126 $options{amount} = $amount;
5129 if ( $options{'fake_failure'} ) {
5130 return "Error: No error; test failure requested with fake_failure";
5134 #if ( $payment_gateway->gatewaynum ) { # agent override
5135 # $paybatch = $payment_gateway->gatewaynum. '-';
5138 #$paybatch .= "$processor:". $transaction->authorization;
5140 #$paybatch .= ':'. $transaction->order_number
5141 # if $transaction->can('order_number')
5142 # && length($transaction->order_number);
5144 my $paybatch = 'FakeProcessor:54:32';
5146 my $cust_pay = new FS::cust_pay ( {
5147 'custnum' => $self->custnum,
5148 'invnum' => $options{'invnum'},
5149 'paid' => $options{amount},
5151 'payby' => $bop_method2payby{$options{method}},
5152 #'payinfo' => $payinfo,
5153 'payinfo' => '4111111111111111',
5154 'paybatch' => $paybatch,
5155 #'paydate' => $paydate,
5156 'paydate' => '2012-05-01',
5158 $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5160 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5163 $cust_pay->invnum(''); #try again with no specific invnum
5164 my $error2 = $cust_pay->insert( $options{'manual'} ?
5165 ( 'manual' => 1 ) : ()
5168 # gah, even with transactions.
5169 my $e = 'WARNING: Card/ACH debited but database not updated - '.
5170 "error inserting (fake!) payment: $error2".
5171 " (previously tried insert with invnum #$options{'invnum'}" .
5178 if ( $options{'paynum_ref'} ) {
5179 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5182 return ''; #no error
5187 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5189 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5190 # phone bill transaction.
5192 sub _realtime_bop_result {
5193 my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5195 warn "$me _realtime_bop_result: pending transaction ".
5196 $cust_pay_pending->paypendingnum. "\n";
5197 warn " $_ => $options{$_}\n" foreach keys %options;
5200 my $payment_gateway = $options{payment_gateway}
5201 or return "no payment gateway in arguments to _realtime_bop_result";
5203 $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5204 my $cpp_captured_err = $cust_pay_pending->replace;
5205 return $cpp_captured_err if $cpp_captured_err;
5207 if ( $transaction->is_success() ) {
5210 if ( $payment_gateway->gatewaynum ) { # agent override
5211 $paybatch = $payment_gateway->gatewaynum. '-';
5214 $paybatch .= $payment_gateway->gateway_module. ":".
5215 $transaction->authorization;
5217 $paybatch .= ':'. $transaction->order_number
5218 if $transaction->can('order_number')
5219 && length($transaction->order_number);
5221 my $cust_pay = new FS::cust_pay ( {
5222 'custnum' => $self->custnum,
5223 'invnum' => $options{'invnum'},
5224 'paid' => $cust_pay_pending->paid,
5226 'payby' => $cust_pay_pending->payby,
5227 #'payinfo' => $payinfo,
5228 'paybatch' => $paybatch,
5229 'paydate' => $cust_pay_pending->paydate,
5231 #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5232 $cust_pay->payunique( $options{payunique} )
5233 if defined($options{payunique}) && length($options{payunique});
5235 my $oldAutoCommit = $FS::UID::AutoCommit;
5236 local $FS::UID::AutoCommit = 0;
5239 #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5241 my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5244 $cust_pay->invnum(''); #try again with no specific invnum
5245 my $error2 = $cust_pay->insert( $options{'manual'} ?
5246 ( 'manual' => 1 ) : ()
5249 # gah. but at least we have a record of the state we had to abort in
5250 # from cust_pay_pending now.
5251 my $e = "WARNING: $options{method} captured but payment not recorded -".
5252 " error inserting payment (". $payment_gateway->gateway_module.
5254 " (previously tried insert with invnum #$options{'invnum'}" .
5255 ": $error ) - pending payment saved as paypendingnum ".
5256 $cust_pay_pending->paypendingnum. "\n";
5262 my $jobnum = $cust_pay_pending->jobnum;
5264 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5266 unless ( $placeholder ) {
5267 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5268 my $e = "WARNING: $options{method} captured but job $jobnum not ".
5269 "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5274 $error = $placeholder->delete;
5277 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5278 my $e = "WARNING: $options{method} captured but could not delete ".
5279 "job $jobnum for paypendingnum ".
5280 $cust_pay_pending->paypendingnum. ": $error\n";
5287 if ( $options{'paynum_ref'} ) {
5288 ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5291 $cust_pay_pending->status('done');
5292 $cust_pay_pending->statustext('captured');
5293 $cust_pay_pending->paynum($cust_pay->paynum);
5294 my $cpp_done_err = $cust_pay_pending->replace;
5296 if ( $cpp_done_err ) {
5298 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5299 my $e = "WARNING: $options{method} captured but payment not recorded - ".
5300 "error updating status for paypendingnum ".
5301 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5307 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5308 return ''; #no error
5314 my $perror = $payment_gateway->gateway_module. " error: ".
5315 $transaction->error_message;
5317 my $jobnum = $cust_pay_pending->jobnum;
5319 my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5321 if ( $placeholder ) {
5322 my $error = $placeholder->depended_delete;
5323 $error ||= $placeholder->delete;
5324 warn "error removing provisioning jobs after declined paypendingnum ".
5325 $cust_pay_pending->paypendingnum. "\n";
5327 my $e = "error finding job $jobnum for declined paypendingnum ".
5328 $cust_pay_pending->paypendingnum. "\n";
5334 unless ( $transaction->error_message ) {
5337 if ( $transaction->can('response_page') ) {
5339 'page' => ( $transaction->can('response_page')
5340 ? $transaction->response_page
5343 'code' => ( $transaction->can('response_code')
5344 ? $transaction->response_code
5347 'headers' => ( $transaction->can('response_headers')
5348 ? $transaction->response_headers
5354 "No additional debugging information available for ".
5355 $payment_gateway->gateway_module;
5358 $perror .= "No error_message returned from ".
5359 $payment_gateway->gateway_module. " -- ".
5360 ( ref($t_response) ? Dumper($t_response) : $t_response );
5364 if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5365 && $conf->exists('emaildecline')
5366 && grep { $_ ne 'POST' } $self->invoicing_list
5367 && ! grep { $transaction->error_message =~ /$_/ }
5368 $conf->config('emaildecline-exclude')
5370 my @templ = $conf->config('declinetemplate');
5371 my $template = new Text::Template (
5373 SOURCE => [ map "$_\n", @templ ],
5374 ) or return "($perror) can't create template: $Text::Template::ERROR";
5375 $template->compile()
5376 or return "($perror) can't compile template: $Text::Template::ERROR";
5378 my $templ_hash = { error => $transaction->error_message };
5380 my $error = send_email(
5381 'from' => $conf->config('invoice_from', $self->agentnum ),
5382 'to' => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5383 'subject' => 'Your payment could not be processed',
5384 'body' => [ $template->fill_in(HASH => $templ_hash) ],
5387 $perror .= " (also received error sending decline notification: $error)"
5392 $cust_pay_pending->status('done');
5393 $cust_pay_pending->statustext("declined: $perror");
5394 my $cpp_done_err = $cust_pay_pending->replace;
5395 if ( $cpp_done_err ) {
5396 my $e = "WARNING: $options{method} declined but pending payment not ".
5397 "resolved - error updating status for paypendingnum ".
5398 $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5400 $perror = "$e ($perror)";
5408 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5410 Verifies successful third party processing of a realtime credit card,
5411 ACH (electronic check) or phone bill transaction via a
5412 Business::OnlineThirdPartyPayment realtime gateway. See
5413 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5415 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5417 The additional options I<payname>, I<city>, I<state>,
5418 I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5419 if set, will override the value from the customer record.
5421 I<description> is a free-text field passed to the gateway. It defaults to
5422 "Internet services".
5424 If an I<invnum> is specified, this payment (if successful) is applied to the
5425 specified invoice. If you don't specify an I<invnum> you might want to
5426 call the B<apply_payments> method.
5428 I<quiet> can be set true to surpress email decline notices.
5430 I<paynum_ref> can be set to a scalar reference. It will be filled in with the
5431 resulting paynum, if any.
5433 I<payunique> is a unique identifier for this payment.
5435 Returns a hashref containing elements bill_error (which will be undefined
5436 upon success) and session_id of any associated session.
5440 sub realtime_botpp_capture {
5441 my( $self, $cust_pay_pending, %options ) = @_;
5443 warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5444 warn " $_ => $options{$_}\n" foreach keys %options;
5447 eval "use Business::OnlineThirdPartyPayment";
5451 # select the gateway
5454 my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5456 my $payment_gateway = $cust_pay_pending->gatewaynum
5457 ? qsearchs( 'payment_gateway',
5458 { gatewaynum => $cust_pay_pending->gatewaynum }
5460 : $self->agent->payment_gateway( 'method' => $method,
5461 # 'invnum' => $cust_pay_pending->invnum,
5462 # 'payinfo' => $cust_pay_pending->payinfo,
5465 $options{payment_gateway} = $payment_gateway; # for the helper subs
5471 my @invoicing_list = $self->invoicing_list_emailonly;
5472 if ( $conf->exists('emailinvoiceautoalways')
5473 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5474 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5475 push @invoicing_list, $self->all_emails;
5478 my $email = ($conf->exists('business-onlinepayment-email-override'))
5479 ? $conf->config('business-onlinepayment-email-override')
5480 : $invoicing_list[0];
5484 $content{email_customer} =
5485 ( $conf->exists('business-onlinepayment-email_customer')
5486 || $conf->exists('business-onlinepayment-email-override') );
5489 # run transaction(s)
5493 new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5494 $self->_bop_options(\%options),
5497 $transaction->reference({ %options });
5499 $transaction->content(
5501 $self->_bop_auth(\%options),
5502 'action' => 'Post Authorization',
5503 'description' => $options{'description'},
5504 'amount' => $cust_pay_pending->paid,
5505 #'invoice_number' => $options{'invnum'},
5506 'customer_id' => $self->custnum,
5507 'referer' => 'http://cleanwhisker.420.am/',
5508 'reference' => $cust_pay_pending->paypendingnum,
5510 'phone' => $self->daytime || $self->night,
5512 # plus whatever is required for bogus capture avoidance
5515 $transaction->submit();
5518 $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5521 bill_error => $error,
5522 session_id => $cust_pay_pending->session_id,
5527 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5531 sub default_payment_gateway {
5532 my( $self, $method ) = @_;
5534 die "Real-time processing not enabled\n"
5535 unless $conf->exists('business-onlinepayment');
5537 #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5540 my $bop_config = 'business-onlinepayment';
5541 $bop_config .= '-ach'
5542 if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5543 my ( $processor, $login, $password, $action, @bop_options ) =
5544 $conf->config($bop_config);
5545 $action ||= 'normal authorization';
5546 pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5547 die "No real-time processor is enabled - ".
5548 "did you set the business-onlinepayment configuration value?\n"
5551 ( $processor, $login, $password, $action, @bop_options )
5556 Removes the I<paycvv> field from the database directly.
5558 If there is an error, returns the error, otherwise returns false.
5564 my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5565 or return dbh->errstr;
5566 $sth->execute($self->custnum)
5567 or return $sth->errstr;
5572 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5574 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5575 via a Business::OnlinePayment realtime gateway. See
5576 L<http://420.am/business-onlinepayment> for supported gateways.
5578 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5580 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5582 Most gateways require a reference to an original payment transaction to refund,
5583 so you probably need to specify a I<paynum>.
5585 I<amount> defaults to the original amount of the payment if not specified.
5587 I<reason> specifies a reason for the refund.
5589 I<paydate> specifies the expiration date for a credit card overriding the
5590 value from the customer record or the payment record. Specified as yyyy-mm-dd
5592 Implementation note: If I<amount> is unspecified or equal to the amount of the
5593 orignal payment, first an attempt is made to "void" the transaction via
5594 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5595 the normal attempt is made to "refund" ("credit") the transaction via the
5596 gateway is attempted.
5598 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5599 #I<zip>, I<payinfo> and I<paydate> are also available. Any of these options,
5600 #if set, will override the value from the customer record.
5602 #If an I<invnum> is specified, this payment (if successful) is applied to the
5603 #specified invoice. If you don't specify an I<invnum> you might want to
5604 #call the B<apply_payments> method.
5608 #some false laziness w/realtime_bop, not enough to make it worth merging
5609 #but some useful small subs should be pulled out
5610 sub _new_realtime_refund_bop {
5614 if (ref($_[0]) ne 'HASH') {
5615 %options = %{$_[0]};
5619 $options{method} = $method;
5623 warn "$me realtime_refund_bop (new): $options{method} refund\n";
5624 warn " $_ => $options{$_}\n" foreach keys %options;
5628 # look up the original payment and optionally a gateway for that payment
5632 my $amount = $options{'amount'};
5634 my( $processor, $login, $password, @bop_options, $namespace ) ;
5635 my( $auth, $order_number ) = ( '', '', '' );
5637 if ( $options{'paynum'} ) {
5639 warn " paynum: $options{paynum}\n" if $DEBUG > 1;
5640 $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
5641 or return "Unknown paynum $options{'paynum'}";
5642 $amount ||= $cust_pay->paid;
5644 $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
5645 or return "Can't parse paybatch for paynum $options{'paynum'}: ".
5646 $cust_pay->paybatch;
5647 my $gatewaynum = '';
5648 ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
5650 if ( $gatewaynum ) { #gateway for the payment to be refunded
5652 my $payment_gateway =
5653 qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
5654 die "payment gateway $gatewaynum not found"
5655 unless $payment_gateway;
5657 $processor = $payment_gateway->gateway_module;
5658 $login = $payment_gateway->gateway_username;
5659 $password = $payment_gateway->gateway_password;
5660 $namespace = $payment_gateway->gateway_namespace;
5661 @bop_options = $payment_gateway->options;
5663 } else { #try the default gateway
5666 my $payment_gateway =
5667 $self->agent->payment_gateway('method' => $options{method});
5669 ( $conf_processor, $login, $password, $namespace ) =
5670 map { my $method = "gateway_$_"; $payment_gateway->$method }
5671 qw( module username password namespace );
5673 @bop_options = $payment_gateway->gatewaynum
5674 ? $payment_gateway->options
5675 : @{ $payment_gateway->get('options') };
5677 return "processor of payment $options{'paynum'} $processor does not".
5678 " match default processor $conf_processor"
5679 unless $processor eq $conf_processor;
5684 } else { # didn't specify a paynum, so look for agent gateway overrides
5685 # like a normal transaction
5687 my $payment_gateway =
5688 $self->agent->payment_gateway( 'method' => $options{method},
5689 #'payinfo' => $payinfo,
5691 my( $processor, $login, $password, $namespace ) =
5692 map { my $method = "gateway_$_"; $payment_gateway->$method }
5693 qw( module username password namespace );
5695 my @bop_options = $payment_gateway->gatewaynum
5696 ? $payment_gateway->options
5697 : @{ $payment_gateway->get('options') };
5700 return "neither amount nor paynum specified" unless $amount;
5702 eval "use $namespace";
5706 'type' => $options{method},
5708 'password' => $password,
5709 'order_number' => $order_number,
5710 'amount' => $amount,
5711 'referer' => 'http://cleanwhisker.420.am/', #XXX fix referer :/
5713 $content{authorization} = $auth
5714 if length($auth); #echeck/ACH transactions have an order # but no auth
5715 #(at least with authorize.net)
5717 my $disable_void_after;
5718 if ($conf->exists('disable_void_after')
5719 && $conf->config('disable_void_after') =~ /^(\d+)$/) {
5720 $disable_void_after = $1;
5723 #first try void if applicable
5724 if ( $cust_pay && $cust_pay->paid == $amount
5726 ( not defined($disable_void_after) )
5727 || ( time < ($cust_pay->_date + $disable_void_after ) )
5730 warn " attempting void\n" if $DEBUG > 1;
5731 my $void = new Business::OnlinePayment( $processor, @bop_options );
5732 $void->content( 'action' => 'void', %content );
5734 if ( $void->is_success ) {
5735 my $error = $cust_pay->void($options{'reason'});
5737 # gah, even with transactions.
5738 my $e = 'WARNING: Card/ACH voided but database not updated - '.
5739 "error voiding payment: $error";
5743 warn " void successful\n" if $DEBUG > 1;
5748 warn " void unsuccessful, trying refund\n"
5752 my $address = $self->address1;
5753 $address .= ", ". $self->address2 if $self->address2;
5755 my($payname, $payfirst, $paylast);
5756 if ( $self->payname && $options{method} ne 'ECHECK' ) {
5757 $payname = $self->payname;
5758 $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5759 or return "Illegal payname $payname";
5760 ($payfirst, $paylast) = ($1, $2);
5762 $payfirst = $self->getfield('first');
5763 $paylast = $self->getfield('last');
5764 $payname = "$payfirst $paylast";
5767 my @invoicing_list = $self->invoicing_list_emailonly;
5768 if ( $conf->exists('emailinvoiceautoalways')
5769 || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5770 || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5771 push @invoicing_list, $self->all_emails;
5774 my $email = ($conf->exists('business-onlinepayment-email-override'))
5775 ? $conf->config('business-onlinepayment-email-override')
5776 : $invoicing_list[0];
5778 my $payip = exists($options{'payip'})
5781 $content{customer_ip} = $payip
5785 if ( $options{method} eq 'CC' ) {
5788 $content{card_number} = $payinfo = $cust_pay->payinfo;
5789 (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
5790 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
5791 ($content{expiration} = "$2/$1"); # where available
5793 $content{card_number} = $payinfo = $self->payinfo;
5794 (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
5795 =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5796 $content{expiration} = "$2/$1";
5799 } elsif ( $options{method} eq 'ECHECK' ) {
5802 $payinfo = $cust_pay->payinfo;
5804 $payinfo = $self->payinfo;
5806 ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
5807 $content{bank_name} = $self->payname;
5808 $content{account_type} = 'CHECKING';
5809 $content{account_name} = $payname;
5810 $content{customer_org} = $self->company ? 'B' : 'I';
5811 $content{customer_ssn} = $self->ss;
5812 } elsif ( $options{method} eq 'LEC' ) {
5813 $content{phone} = $payinfo = $self->payinfo;
5817 my $refund = new Business::OnlinePayment( $processor, @bop_options );
5818 my %sub_content = $refund->content(
5819 'action' => 'credit',
5820 'customer_id' => $self->custnum,
5821 'last_name' => $paylast,
5822 'first_name' => $payfirst,
5824 'address' => $address,
5825 'city' => $self->city,
5826 'state' => $self->state,
5827 'zip' => $self->zip,
5828 'country' => $self->country,
5830 'phone' => $self->daytime || $self->night,
5833 warn join('', map { " $_ => $sub_content{$_}\n" } keys %sub_content )
5837 return "$processor error: ". $refund->error_message
5838 unless $refund->is_success();
5840 my $paybatch = "$processor:". $refund->authorization;
5841 $paybatch .= ':'. $refund->order_number
5842 if $refund->can('order_number') && $refund->order_number;
5844 while ( $cust_pay && $cust_pay->unapplied < $amount ) {
5845 my @cust_bill_pay = $cust_pay->cust_bill_pay;
5846 last unless @cust_bill_pay;
5847 my $cust_bill_pay = pop @cust_bill_pay;
5848 my $error = $cust_bill_pay->delete;
5852 my $cust_refund = new FS::cust_refund ( {
5853 'custnum' => $self->custnum,
5854 'paynum' => $options{'paynum'},
5855 'refund' => $amount,
5857 'payby' => $bop_method2payby{$options{method}},
5858 'payinfo' => $payinfo,
5859 'paybatch' => $paybatch,
5860 'reason' => $options{'reason'} || 'card or ACH refund',
5862 my $error = $cust_refund->insert;
5864 $cust_refund->paynum(''); #try again with no specific paynum
5865 my $error2 = $cust_refund->insert;
5867 # gah, even with transactions.
5868 my $e = 'WARNING: Card/ACH refunded but database not updated - '.
5869 "error inserting refund ($processor): $error2".
5870 " (previously tried insert with paynum #$options{'paynum'}" .
5881 =item batch_card OPTION => VALUE...
5883 Adds a payment for this invoice to the pending credit card batch (see
5884 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
5885 runs the payment using a realtime gateway.
5890 my ($self, %options) = @_;
5893 if (exists($options{amount})) {
5894 $amount = $options{amount};
5896 $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
5898 return '' unless $amount > 0;
5900 my $invnum = delete $options{invnum};
5901 my $payby = $options{invnum} || $self->payby; #dubious
5903 if ($options{'realtime'}) {
5904 return $self->realtime_bop( FS::payby->payby2bop($self->payby),
5910 my $oldAutoCommit = $FS::UID::AutoCommit;
5911 local $FS::UID::AutoCommit = 0;
5914 #this needs to handle mysql as well as Pg, like svc_acct.pm
5915 #(make it into a common function if folks need to do batching with mysql)
5916 $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
5917 or return "Cannot lock pay_batch: " . $dbh->errstr;
5921 'payby' => FS::payby->payby2payment($payby),
5924 my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
5926 unless ( $pay_batch ) {
5927 $pay_batch = new FS::pay_batch \%pay_batch;
5928 my $error = $pay_batch->insert;
5930 $dbh->rollback if $oldAutoCommit;
5931 die "error creating new batch: $error\n";
5935 my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
5936 'batchnum' => $pay_batch->batchnum,
5937 'custnum' => $self->custnum,
5940 foreach (qw( address1 address2 city state zip country payby payinfo paydate
5942 $options{$_} = '' unless exists($options{$_});
5945 my $cust_pay_batch = new FS::cust_pay_batch ( {
5946 'batchnum' => $pay_batch->batchnum,
5947 'invnum' => $invnum || 0, # is there a better value?
5948 # this field should be
5950 # cust_bill_pay_batch now
5951 'custnum' => $self->custnum,
5952 'last' => $self->getfield('last'),
5953 'first' => $self->getfield('first'),
5954 'address1' => $options{address1} || $self->address1,
5955 'address2' => $options{address2} || $self->address2,
5956 'city' => $options{city} || $self->city,
5957 'state' => $options{state} || $self->state,
5958 'zip' => $options{zip} || $self->zip,
5959 'country' => $options{country} || $self->country,
5960 'payby' => $options{payby} || $self->payby,
5961 'payinfo' => $options{payinfo} || $self->payinfo,
5962 'exp' => $options{paydate} || $self->paydate,
5963 'payname' => $options{payname} || $self->payname,
5964 'amount' => $amount, # consolidating
5967 $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
5968 if $old_cust_pay_batch;
5971 if ($old_cust_pay_batch) {
5972 $error = $cust_pay_batch->replace($old_cust_pay_batch)
5974 $error = $cust_pay_batch->insert;
5978 $dbh->rollback if $oldAutoCommit;
5982 my $unapplied = $self->total_unapplied_credits
5983 + $self->total_unapplied_payments
5984 + $self->in_transit_payments;
5985 foreach my $cust_bill ($self->open_cust_bill) {
5986 #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
5987 my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
5988 'invnum' => $cust_bill->invnum,
5989 'paybatchnum' => $cust_pay_batch->paybatchnum,
5990 'amount' => $cust_bill->owed,
5993 if ($unapplied >= $cust_bill_pay_batch->amount){
5994 $unapplied -= $cust_bill_pay_batch->amount;
5997 $cust_bill_pay_batch->amount(sprintf ( "%.2f",
5998 $cust_bill_pay_batch->amount - $unapplied )); $unapplied = 0;
6000 $error = $cust_bill_pay_batch->insert;
6002 $dbh->rollback if $oldAutoCommit;
6007 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6011 =item apply_payments_and_credits
6013 Applies unapplied payments and credits.
6015 In most cases, this new method should be used in place of sequential
6016 apply_payments and apply_credits methods.
6018 If there is an error, returns the error, otherwise returns false.
6022 sub apply_payments_and_credits {
6025 local $SIG{HUP} = 'IGNORE';
6026 local $SIG{INT} = 'IGNORE';
6027 local $SIG{QUIT} = 'IGNORE';
6028 local $SIG{TERM} = 'IGNORE';
6029 local $SIG{TSTP} = 'IGNORE';
6030 local $SIG{PIPE} = 'IGNORE';
6032 my $oldAutoCommit = $FS::UID::AutoCommit;
6033 local $FS::UID::AutoCommit = 0;
6036 $self->select_for_update; #mutex
6038 foreach my $cust_bill ( $self->open_cust_bill ) {
6039 my $error = $cust_bill->apply_payments_and_credits;
6041 $dbh->rollback if $oldAutoCommit;
6042 return "Error applying: $error";
6046 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6051 =item apply_credits OPTION => VALUE ...
6053 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6054 to outstanding invoice balances in chronological order (or reverse
6055 chronological order if the I<order> option is set to B<newest>) and returns the
6056 value of any remaining unapplied credits available for refund (see
6057 L<FS::cust_refund>).
6059 Dies if there is an error.
6067 local $SIG{HUP} = 'IGNORE';
6068 local $SIG{INT} = 'IGNORE';
6069 local $SIG{QUIT} = 'IGNORE';
6070 local $SIG{TERM} = 'IGNORE';
6071 local $SIG{TSTP} = 'IGNORE';
6072 local $SIG{PIPE} = 'IGNORE';
6074 my $oldAutoCommit = $FS::UID::AutoCommit;
6075 local $FS::UID::AutoCommit = 0;
6078 $self->select_for_update; #mutex
6080 unless ( $self->total_unapplied_credits ) {
6081 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6085 my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6086 qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6088 my @invoices = $self->open_cust_bill;
6089 @invoices = sort { $b->_date <=> $a->_date } @invoices
6090 if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6093 foreach my $cust_bill ( @invoices ) {
6096 if ( !defined($credit) || $credit->credited == 0) {
6097 $credit = pop @credits or last;
6100 if ($cust_bill->owed >= $credit->credited) {
6101 $amount=$credit->credited;
6103 $amount=$cust_bill->owed;
6106 my $cust_credit_bill = new FS::cust_credit_bill ( {
6107 'crednum' => $credit->crednum,
6108 'invnum' => $cust_bill->invnum,
6109 'amount' => $amount,
6111 my $error = $cust_credit_bill->insert;
6113 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6117 redo if ($cust_bill->owed > 0);
6121 my $total_unapplied_credits = $self->total_unapplied_credits;
6123 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6125 return $total_unapplied_credits;
6128 =item apply_payments
6130 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6131 to outstanding invoice balances in chronological order.
6133 #and returns the value of any remaining unapplied payments.
6135 Dies if there is an error.
6139 sub apply_payments {
6142 local $SIG{HUP} = 'IGNORE';
6143 local $SIG{INT} = 'IGNORE';
6144 local $SIG{QUIT} = 'IGNORE';
6145 local $SIG{TERM} = 'IGNORE';
6146 local $SIG{TSTP} = 'IGNORE';
6147 local $SIG{PIPE} = 'IGNORE';
6149 my $oldAutoCommit = $FS::UID::AutoCommit;
6150 local $FS::UID::AutoCommit = 0;
6153 $self->select_for_update; #mutex
6157 my @payments = sort { $b->_date <=> $a->_date }
6158 grep { $_->unapplied > 0 }
6161 my @invoices = sort { $a->_date <=> $b->_date}
6162 grep { $_->owed > 0 }
6167 foreach my $cust_bill ( @invoices ) {
6170 if ( !defined($payment) || $payment->unapplied == 0 ) {
6171 $payment = pop @payments or last;
6174 if ( $cust_bill->owed >= $payment->unapplied ) {
6175 $amount = $payment->unapplied;
6177 $amount = $cust_bill->owed;
6180 my $cust_bill_pay = new FS::cust_bill_pay ( {
6181 'paynum' => $payment->paynum,
6182 'invnum' => $cust_bill->invnum,
6183 'amount' => $amount,
6185 my $error = $cust_bill_pay->insert;
6187 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6191 redo if ( $cust_bill->owed > 0);
6195 my $total_unapplied_payments = $self->total_unapplied_payments;
6197 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6199 return $total_unapplied_payments;
6204 Returns the total owed for this customer on all invoices
6205 (see L<FS::cust_bill/owed>).
6211 $self->total_owed_date(2145859200); #12/31/2037
6214 =item total_owed_date TIME
6216 Returns the total owed for this customer on all invoices with date earlier than
6217 TIME. TIME is specified as a UNIX timestamp; see L<perlfunc/"time">). Also
6218 see L<Time::Local> and L<Date::Parse> for conversion functions.
6222 sub total_owed_date {
6226 # my $custnum = $self->custnum;
6228 # my $owed_sql = FS::cust_bill->owed_sql;
6231 # SELECT SUM($owed_sql) FROM cust_bill
6232 # WHERE custnum = $custnum
6233 # AND _date <= $time
6236 # my $sth = dbh->prepare($sql) or die dbh->errstr;
6237 # $sth->execute() or die $sth->errstr;
6239 # return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6242 foreach my $cust_bill (
6243 grep { $_->_date <= $time }
6244 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6246 $total_bill += $cust_bill->owed;
6248 sprintf( "%.2f", $total_bill );
6254 Returns the total amount of all payments.
6261 $total += $_->paid foreach $self->cust_pay;
6262 sprintf( "%.2f", $total );
6265 =item total_unapplied_credits
6267 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6268 customer. See L<FS::cust_credit/credited>.
6270 =item total_credited
6272 Old name for total_unapplied_credits. Don't use.
6276 sub total_credited {
6277 #carp "total_credited deprecated, use total_unapplied_credits";
6278 shift->total_unapplied_credits(@_);
6281 sub total_unapplied_credits {
6283 my $total_credit = 0;
6284 $total_credit += $_->credited foreach $self->cust_credit;
6285 sprintf( "%.2f", $total_credit );
6288 =item total_unapplied_payments
6290 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6291 See L<FS::cust_pay/unapplied>.
6295 sub total_unapplied_payments {
6297 my $total_unapplied = 0;
6298 $total_unapplied += $_->unapplied foreach $self->cust_pay;
6299 sprintf( "%.2f", $total_unapplied );
6302 =item total_unapplied_refunds
6304 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6305 customer. See L<FS::cust_refund/unapplied>.
6309 sub total_unapplied_refunds {
6311 my $total_unapplied = 0;
6312 $total_unapplied += $_->unapplied foreach $self->cust_refund;
6313 sprintf( "%.2f", $total_unapplied );
6318 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6319 total_unapplied_credits minus total_unapplied_payments).
6327 + $self->total_unapplied_refunds
6328 - $self->total_unapplied_credits
6329 - $self->total_unapplied_payments
6333 =item balance_date TIME
6335 Returns the balance for this customer, only considering invoices with date
6336 earlier than TIME (total_owed_date minus total_credited minus
6337 total_unapplied_payments). TIME is specified as a UNIX timestamp; see
6338 L<perlfunc/"time">). Also see L<Time::Local> and L<Date::Parse> for conversion
6347 $self->total_owed_date($time)
6348 + $self->total_unapplied_refunds
6349 - $self->total_unapplied_credits
6350 - $self->total_unapplied_payments
6354 =item in_transit_payments
6356 Returns the total of requests for payments for this customer pending in
6357 batches in transit to the bank. See L<FS::pay_batch> and L<FS::cust_pay_batch>
6361 sub in_transit_payments {
6363 my $in_transit_payments = 0;
6364 foreach my $pay_batch ( qsearch('pay_batch', {
6367 foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6368 'batchnum' => $pay_batch->batchnum,
6369 'custnum' => $self->custnum,
6371 $in_transit_payments += $cust_pay_batch->amount;
6374 sprintf( "%.2f", $in_transit_payments );
6379 Returns a hash of useful information for making a payment.
6389 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6390 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6391 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6395 For credit card transactions:
6407 For electronic check transactions:
6422 $return{balance} = $self->balance;
6424 $return{payname} = $self->payname
6425 || ( $self->first. ' '. $self->get('last') );
6427 $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6429 $return{payby} = $self->payby;
6430 $return{stateid_state} = $self->stateid_state;
6432 if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6433 $return{card_type} = cardtype($self->payinfo);
6434 $return{payinfo} = $self->paymask;
6436 @return{'month', 'year'} = $self->paydate_monthyear;
6440 if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6441 my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6442 $return{payinfo1} = $payinfo1;
6443 $return{payinfo2} = $payinfo2;
6444 $return{paytype} = $self->paytype;
6445 $return{paystate} = $self->paystate;
6449 #doubleclick protection
6451 $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
6457 =item paydate_monthyear
6459 Returns a two-element list consisting of the month and year of this customer's
6460 paydate (credit card expiration date for CARD customers)
6464 sub paydate_monthyear {
6466 if ( $self->paydate =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
6468 } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
6475 =item tax_exemption TAXNAME
6480 my( $self, $taxname ) = @_;
6482 qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
6483 'taxname' => $taxname,
6488 =item cust_main_exemption
6492 sub cust_main_exemption {
6494 qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
6497 =item invoicing_list [ ARRAYREF ]
6499 If an arguement is given, sets these email addresses as invoice recipients
6500 (see L<FS::cust_main_invoice>). Errors are not fatal and are not reported
6501 (except as warnings), so use check_invoicing_list first.
6503 Returns a list of email addresses (with svcnum entries expanded).
6505 Note: You can clear the invoicing list by passing an empty ARRAYREF. You can
6506 check it without disturbing anything by passing nothing.
6508 This interface may change in the future.
6512 sub invoicing_list {
6513 my( $self, $arrayref ) = @_;
6516 my @cust_main_invoice;
6517 if ( $self->custnum ) {
6518 @cust_main_invoice =
6519 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6521 @cust_main_invoice = ();
6523 foreach my $cust_main_invoice ( @cust_main_invoice ) {
6524 #warn $cust_main_invoice->destnum;
6525 unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
6526 #warn $cust_main_invoice->destnum;
6527 my $error = $cust_main_invoice->delete;
6528 warn $error if $error;
6531 if ( $self->custnum ) {
6532 @cust_main_invoice =
6533 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6535 @cust_main_invoice = ();
6537 my %seen = map { $_->address => 1 } @cust_main_invoice;
6538 foreach my $address ( @{$arrayref} ) {
6539 next if exists $seen{$address} && $seen{$address};
6540 $seen{$address} = 1;
6541 my $cust_main_invoice = new FS::cust_main_invoice ( {
6542 'custnum' => $self->custnum,
6545 my $error = $cust_main_invoice->insert;
6546 warn $error if $error;
6550 if ( $self->custnum ) {
6552 qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6559 =item check_invoicing_list ARRAYREF
6561 Checks these arguements as valid input for the invoicing_list method. If there
6562 is an error, returns the error, otherwise returns false.
6566 sub check_invoicing_list {
6567 my( $self, $arrayref ) = @_;
6569 foreach my $address ( @$arrayref ) {
6571 if ($address eq 'FAX' and $self->getfield('fax') eq '') {
6572 return 'Can\'t add FAX invoice destination with a blank FAX number.';
6575 my $cust_main_invoice = new FS::cust_main_invoice ( {
6576 'custnum' => $self->custnum,
6579 my $error = $self->custnum
6580 ? $cust_main_invoice->check
6581 : $cust_main_invoice->checkdest
6583 return $error if $error;
6587 return "Email address required"
6588 if $conf->exists('cust_main-require_invoicing_list_email')
6589 && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
6594 =item set_default_invoicing_list
6596 Sets the invoicing list to all accounts associated with this customer,
6597 overwriting any previous invoicing list.
6601 sub set_default_invoicing_list {
6603 $self->invoicing_list($self->all_emails);
6608 Returns the email addresses of all accounts provisioned for this customer.
6615 foreach my $cust_pkg ( $self->all_pkgs ) {
6616 my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
6618 map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6619 grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6621 $list{$_}=1 foreach map { $_->email } @svc_acct;
6626 =item invoicing_list_addpost
6628 Adds postal invoicing to this customer. If this customer is already configured
6629 to receive postal invoices, does nothing.
6633 sub invoicing_list_addpost {
6635 return if grep { $_ eq 'POST' } $self->invoicing_list;
6636 my @invoicing_list = $self->invoicing_list;
6637 push @invoicing_list, 'POST';
6638 $self->invoicing_list(\@invoicing_list);
6641 =item invoicing_list_emailonly
6643 Returns the list of email invoice recipients (invoicing_list without non-email
6644 destinations such as POST and FAX).
6648 sub invoicing_list_emailonly {
6650 warn "$me invoicing_list_emailonly called"
6652 grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
6655 =item invoicing_list_emailonly_scalar
6657 Returns the list of email invoice recipients (invoicing_list without non-email
6658 destinations such as POST and FAX) as a comma-separated scalar.
6662 sub invoicing_list_emailonly_scalar {
6664 warn "$me invoicing_list_emailonly_scalar called"
6666 join(', ', $self->invoicing_list_emailonly);
6669 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
6671 Returns an array of customers referred by this customer (referral_custnum set
6672 to this custnum). If DEPTH is given, recurses up to the given depth, returning
6673 customers referred by customers referred by this customer and so on, inclusive.
6674 The default behavior is DEPTH 1 (no recursion).
6678 sub referral_cust_main {
6680 my $depth = @_ ? shift : 1;
6681 my $exclude = @_ ? shift : {};
6684 map { $exclude->{$_->custnum}++; $_; }
6685 grep { ! $exclude->{ $_->custnum } }
6686 qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
6690 map { $_->referral_cust_main($depth-1, $exclude) }
6697 =item referral_cust_main_ncancelled
6699 Same as referral_cust_main, except only returns customers with uncancelled
6704 sub referral_cust_main_ncancelled {
6706 grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
6709 =item referral_cust_pkg [ DEPTH ]
6711 Like referral_cust_main, except returns a flat list of all unsuspended (and
6712 uncancelled) packages for each customer. The number of items in this list may
6713 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
6717 sub referral_cust_pkg {
6719 my $depth = @_ ? shift : 1;
6721 map { $_->unsuspended_pkgs }
6722 grep { $_->unsuspended_pkgs }
6723 $self->referral_cust_main($depth);
6726 =item referring_cust_main
6728 Returns the single cust_main record for the customer who referred this customer
6729 (referral_custnum), or false.
6733 sub referring_cust_main {
6735 return '' unless $self->referral_custnum;
6736 qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
6739 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
6741 Applies a credit to this customer. If there is an error, returns the error,
6742 otherwise returns false.
6744 REASON can be a text string, an FS::reason object, or a scalar reference to
6745 a reasonnum. If a text string, it will be automatically inserted as a new
6746 reason, and a 'reason_type' option must be passed to indicate the
6747 FS::reason_type for the new reason.
6749 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
6751 Any other options are passed to FS::cust_credit::insert.
6756 my( $self, $amount, $reason, %options ) = @_;
6758 my $cust_credit = new FS::cust_credit {
6759 'custnum' => $self->custnum,
6760 'amount' => $amount,
6763 if ( ref($reason) ) {
6765 if ( ref($reason) eq 'SCALAR' ) {
6766 $cust_credit->reasonnum( $$reason );
6768 $cust_credit->reasonnum( $reason->reasonnum );
6772 $cust_credit->set('reason', $reason)
6775 $cust_credit->addlinfo( delete $options{'addlinfo'} )
6776 if exists($options{'addlinfo'});
6778 $cust_credit->insert(%options);
6782 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
6784 Creates a one-time charge for this customer. If there is an error, returns
6785 the error, otherwise returns false.
6787 New-style, with a hashref of options:
6789 my $error = $cust_main->charge(
6793 'start_date' => str2time('7/4/2009'),
6794 'pkg' => 'Description',
6795 'comment' => 'Comment',
6796 'additional' => [], #extra invoice detail
6797 'classnum' => 1, #pkg_class
6799 'setuptax' => '', # or 'Y' for tax exempt
6802 'taxclass' => 'Tax class',
6805 'taxproduct' => 2, #part_pkg_taxproduct
6806 'override' => {}, #XXX describe
6812 my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
6818 my ( $amount, $quantity, $start_date, $classnum );
6819 my ( $pkg, $comment, $additional );
6820 my ( $setuptax, $taxclass ); #internal taxes
6821 my ( $taxproduct, $override ); #vendor (CCH) taxes
6822 if ( ref( $_[0] ) ) {
6823 $amount = $_[0]->{amount};
6824 $quantity = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
6825 $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
6826 $pkg = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
6827 $comment = exists($_[0]->{comment}) ? $_[0]->{comment}
6828 : '$'. sprintf("%.2f",$amount);
6829 $setuptax = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
6830 $taxclass = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
6831 $classnum = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
6832 $additional = $_[0]->{additional} || [];
6833 $taxproduct = $_[0]->{taxproductnum};
6834 $override = { '' => $_[0]->{tax_override} };
6839 $pkg = @_ ? shift : 'One-time charge';
6840 $comment = @_ ? shift : '$'. sprintf("%.2f",$amount);
6842 $taxclass = @_ ? shift : '';
6846 local $SIG{HUP} = 'IGNORE';
6847 local $SIG{INT} = 'IGNORE';
6848 local $SIG{QUIT} = 'IGNORE';
6849 local $SIG{TERM} = 'IGNORE';
6850 local $SIG{TSTP} = 'IGNORE';
6851 local $SIG{PIPE} = 'IGNORE';
6853 my $oldAutoCommit = $FS::UID::AutoCommit;
6854 local $FS::UID::AutoCommit = 0;
6857 my $part_pkg = new FS::part_pkg ( {
6859 'comment' => $comment,
6863 'classnum' => $classnum ? $classnum : '',
6864 'setuptax' => $setuptax,
6865 'taxclass' => $taxclass,
6866 'taxproductnum' => $taxproduct,
6869 my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
6870 ( 0 .. @$additional - 1 )
6872 'additional_count' => scalar(@$additional),
6873 'setup_fee' => $amount,
6876 my $error = $part_pkg->insert( options => \%options,
6877 tax_overrides => $override,
6880 $dbh->rollback if $oldAutoCommit;
6884 my $pkgpart = $part_pkg->pkgpart;
6885 my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
6886 unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
6887 my $type_pkgs = new FS::type_pkgs \%type_pkgs;
6888 $error = $type_pkgs->insert;
6890 $dbh->rollback if $oldAutoCommit;
6895 my $cust_pkg = new FS::cust_pkg ( {
6896 'custnum' => $self->custnum,
6897 'pkgpart' => $pkgpart,
6898 'quantity' => $quantity,
6899 'start_date' => $start_date,
6902 $error = $cust_pkg->insert;
6904 $dbh->rollback if $oldAutoCommit;
6908 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6913 #=item charge_postal_fee
6915 #Applies a one time charge this customer. If there is an error,
6916 #returns the error, returns the cust_pkg charge object or false
6917 #if there was no charge.
6921 # This should be a customer event. For that to work requires that bill
6922 # also be a customer event.
6924 sub charge_postal_fee {
6927 my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
6928 return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
6930 my $cust_pkg = new FS::cust_pkg ( {
6931 'custnum' => $self->custnum,
6932 'pkgpart' => $pkgpart,
6936 my $error = $cust_pkg->insert;
6937 $error ? $error : $cust_pkg;
6942 Returns all the invoices (see L<FS::cust_bill>) for this customer.
6948 sort { $a->_date <=> $b->_date }
6949 qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6952 =item open_cust_bill
6954 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
6959 sub open_cust_bill {
6963 'table' => 'cust_bill',
6964 'hashref' => { 'custnum' => $self->custnum, },
6965 'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
6966 'order_by' => 'ORDER BY _date ASC',
6973 Returns all the credits (see L<FS::cust_credit>) for this customer.
6979 sort { $a->_date <=> $b->_date }
6980 qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
6985 Returns all the payments (see L<FS::cust_pay>) for this customer.
6991 sort { $a->_date <=> $b->_date }
6992 qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
6997 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7003 sort { $a->_date <=> $b->_date }
7004 qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7007 =item cust_pay_batch
7009 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7013 sub cust_pay_batch {
7015 sort { $a->paybatchnum <=> $b->paybatchnum }
7016 qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7019 =item cust_pay_pending
7021 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7022 (without status "done").
7026 sub cust_pay_pending {
7028 return $self->num_cust_pay_pending unless wantarray;
7029 sort { $a->_date <=> $b->_date }
7030 qsearch( 'cust_pay_pending', {
7031 'custnum' => $self->custnum,
7032 'status' => { op=>'!=', value=>'done' },
7037 =item num_cust_pay_pending
7039 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7040 customer (without status "done"). Also called automatically when the
7041 cust_pay_pending method is used in a scalar context.
7045 sub num_cust_pay_pending {
7047 my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7048 " WHERE custnum = ? AND status != 'done' ";
7049 my $sth = dbh->prepare($sql) or die dbh->errstr;
7050 $sth->execute($self->custnum) or die $sth->errstr;
7051 $sth->fetchrow_arrayref->[0];
7056 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7062 sort { $a->_date <=> $b->_date }
7063 qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7066 =item display_custnum
7068 Returns the displayed customer number for this customer: agent_custid if
7069 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7073 sub display_custnum {
7075 if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7076 return $self->agent_custid;
7078 return $self->custnum;
7084 Returns a name string for this customer, either "Company (Last, First)" or
7091 my $name = $self->contact;
7092 $name = $self->company. " ($name)" if $self->company;
7098 Returns a name string for this (service/shipping) contact, either
7099 "Company (Last, First)" or "Last, First".
7105 if ( $self->get('ship_last') ) {
7106 my $name = $self->ship_contact;
7107 $name = $self->ship_company. " ($name)" if $self->ship_company;
7116 Returns a name string for this customer, either "Company" or "First Last".
7122 $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7125 =item ship_name_short
7127 Returns a name string for this (service/shipping) contact, either "Company"
7132 sub ship_name_short {
7134 if ( $self->get('ship_last') ) {
7135 $self->ship_company !~ /^\s*$/
7136 ? $self->ship_company
7137 : $self->ship_contact_firstlast;
7139 $self->name_company_or_firstlast;
7145 Returns this customer's full (billing) contact name only, "Last, First"
7151 $self->get('last'). ', '. $self->first;
7156 Returns this customer's full (shipping) contact name only, "Last, First"
7162 $self->get('ship_last')
7163 ? $self->get('ship_last'). ', '. $self->ship_first
7167 =item contact_firstlast
7169 Returns this customers full (billing) contact name only, "First Last".
7173 sub contact_firstlast {
7175 $self->first. ' '. $self->get('last');
7178 =item ship_contact_firstlast
7180 Returns this customer's full (shipping) contact name only, "First Last".
7184 sub ship_contact_firstlast {
7186 $self->get('ship_last')
7187 ? $self->first. ' '. $self->get('ship_last')
7188 : $self->contact_firstlast;
7193 Returns this customer's full country name
7199 code2country($self->country);
7202 =item geocode DATA_VENDOR
7204 Returns a value for the customer location as encoded by DATA_VENDOR.
7205 Currently this only makes sense for "CCH" as DATA_VENDOR.
7210 my ($self, $data_vendor) = (shift, shift); #always cch for now
7212 my $geocode = $self->get('geocode'); #XXX only one data_vendor for geocode
7213 return $geocode if $geocode;
7215 my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7219 my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7220 if $self->country eq 'US';
7222 #CCH specific location stuff
7223 my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7225 my @cust_tax_location =
7227 'table' => 'cust_tax_location',
7228 'hashref' => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7229 'extra_sql' => $extra_sql,
7230 'order_by' => 'ORDER BY plus4hi',#overlapping with distinct ends
7233 $geocode = $cust_tax_location[0]->geocode
7234 if scalar(@cust_tax_location);
7243 Returns a status string for this customer, currently:
7247 =item prospect - No packages have ever been ordered
7249 =item active - One or more recurring packages is active
7251 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7253 =item suspended - All non-cancelled recurring packages are suspended
7255 =item cancelled - All recurring packages are cancelled
7261 sub status { shift->cust_status(@_); }
7265 for my $status (qw( prospect active inactive suspended cancelled )) {
7266 my $method = $status.'_sql';
7267 my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7268 my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7269 $sth->execute( ($self->custnum) x $numnum )
7270 or die "Error executing 'SELECT $sql': ". $sth->errstr;
7271 return $status if $sth->fetchrow_arrayref->[0];
7275 =item ucfirst_cust_status
7277 =item ucfirst_status
7279 Returns the status with the first character capitalized.
7283 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7285 sub ucfirst_cust_status {
7287 ucfirst($self->cust_status);
7292 Returns a hex triplet color string for this customer's status.
7296 use vars qw(%statuscolor);
7297 tie %statuscolor, 'Tie::IxHash',
7298 'prospect' => '7e0079', #'000000', #black? naw, purple
7299 'active' => '00CC00', #green
7300 'inactive' => '0000CC', #blue
7301 'suspended' => 'FF9900', #yellow
7302 'cancelled' => 'FF0000', #red
7305 sub statuscolor { shift->cust_statuscolor(@_); }
7307 sub cust_statuscolor {
7309 $statuscolor{$self->cust_status};
7314 Returns an array of hashes representing the customer's RT tickets.
7321 my $num = $conf->config('cust_main-max_tickets') || 10;
7324 if ( $conf->config('ticket_system') ) {
7325 unless ( $conf->config('ticket_system-custom_priority_field') ) {
7327 @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
7331 foreach my $priority (
7332 $conf->config('ticket_system-custom_priority_field-values'), ''
7334 last if scalar(@tickets) >= $num;
7336 @{ FS::TicketSystem->customer_tickets( $self->custnum,
7337 $num - scalar(@tickets),
7347 # Return services representing svc_accts in customer support packages
7348 sub support_services {
7350 my %packages = map { $_ => 1 } $conf->config('support_packages');
7352 grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
7353 grep { $_->part_svc->svcdb eq 'svc_acct' }
7354 map { $_->cust_svc }
7355 grep { exists $packages{ $_->pkgpart } }
7356 $self->ncancelled_pkgs;
7362 =head1 CLASS METHODS
7368 Class method that returns the list of possible status strings for customers
7369 (see L<the status method|/status>). For example:
7371 @statuses = FS::cust_main->statuses();
7376 #my $self = shift; #could be class...
7382 Returns an SQL expression identifying prospective cust_main records (customers
7383 with no packages ever ordered)
7387 use vars qw($select_count_pkgs);
7388 $select_count_pkgs =
7389 "SELECT COUNT(*) FROM cust_pkg
7390 WHERE cust_pkg.custnum = cust_main.custnum";
7392 sub select_count_pkgs_sql {
7396 sub prospect_sql { "
7397 0 = ( $select_count_pkgs )
7402 Returns an SQL expression identifying active cust_main records (customers with
7403 active recurring packages).
7408 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
7414 Returns an SQL expression identifying inactive cust_main records (customers with
7415 no active recurring packages, but otherwise unsuspended/uncancelled).
7419 sub inactive_sql { "
7420 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7422 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7428 Returns an SQL expression identifying suspended cust_main records.
7433 sub suspended_sql { susp_sql(@_); }
7435 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
7437 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7443 Returns an SQL expression identifying cancelled cust_main records.
7447 sub cancelled_sql { cancel_sql(@_); }
7450 my $recurring_sql = FS::cust_pkg->recurring_sql;
7451 my $cancelled_sql = FS::cust_pkg->cancelled_sql;
7454 0 < ( $select_count_pkgs )
7455 AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql )
7456 AND 0 = ( $select_count_pkgs AND $recurring_sql
7457 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
7459 AND 0 = ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7465 =item uncancelled_sql
7467 Returns an SQL expression identifying un-cancelled cust_main records.
7471 sub uncancelled_sql { uncancel_sql(@_); }
7472 sub uncancel_sql { "
7473 ( 0 < ( $select_count_pkgs
7474 AND ( cust_pkg.cancel IS NULL
7475 OR cust_pkg.cancel = 0
7478 OR 0 = ( $select_count_pkgs )
7484 Returns an SQL fragment to retreive the balance.
7489 ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
7490 WHERE cust_bill.custnum = cust_main.custnum )
7491 - ( SELECT COALESCE( SUM(paid), 0 ) FROM cust_pay
7492 WHERE cust_pay.custnum = cust_main.custnum )
7493 - ( SELECT COALESCE( SUM(amount), 0 ) FROM cust_credit
7494 WHERE cust_credit.custnum = cust_main.custnum )
7495 + ( SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund
7496 WHERE cust_refund.custnum = cust_main.custnum )
7499 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7501 Returns an SQL fragment to retreive the balance for this customer, only
7502 considering invoices with date earlier than START_TIME, and optionally not
7503 later than END_TIME (total_owed_date minus total_unapplied_credits minus
7504 total_unapplied_payments).
7506 Times are specified as SQL fragments or numeric
7507 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7508 L<Date::Parse> for conversion functions. The empty string can be passed
7509 to disable that time constraint completely.
7511 Available options are:
7515 =item unapplied_date
7517 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)
7522 set to true to remove all customer comparison clauses, for totals
7527 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
7532 JOIN clause (typically used with the total option)
7538 sub balance_date_sql {
7539 my( $class, $start, $end, %opt ) = @_;
7541 my $owed = FS::cust_bill->owed_sql;
7542 my $unapp_refund = FS::cust_refund->unapplied_sql;
7543 my $unapp_credit = FS::cust_credit->unapplied_sql;
7544 my $unapp_pay = FS::cust_pay->unapplied_sql;
7546 my $j = $opt{'join'} || '';
7548 my $owed_wh = $class->_money_table_where( 'cust_bill', $start,$end,%opt );
7549 my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
7550 my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
7551 my $pay_wh = $class->_money_table_where( 'cust_pay', $start,$end,%opt );
7553 " ( SELECT COALESCE(SUM($owed), 0) FROM cust_bill $j $owed_wh )
7554 + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
7555 - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
7556 - ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $j $pay_wh )
7561 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
7563 Returns an SQL fragment to retreive the total unapplied payments for this
7564 customer, only considering invoices with date earlier than START_TIME, and
7565 optionally not later than END_TIME.
7567 Times are specified as SQL fragments or numeric
7568 UNIX timestamps; see L<perlfunc/"time">). Also see L<Time::Local> and
7569 L<Date::Parse> for conversion functions. The empty string can be passed
7570 to disable that time constraint completely.
7572 Available options are:
7576 sub unapplied_payments_date_sql {
7577 my( $class, $start, $end, ) = @_;
7579 my $unapp_pay = FS::cust_pay->unapplied_sql;
7581 my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
7582 'unapplied_date'=>1 );
7584 " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
7587 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7589 Helper method for balance_date_sql; name (and usage) subject to change
7590 (suggestions welcome).
7592 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
7593 cust_refund, cust_credit or cust_pay).
7595 If TABLE is "cust_bill" or the unapplied_date option is true, only
7596 considers records with date earlier than START_TIME, and optionally not
7597 later than END_TIME .
7601 sub _money_table_where {
7602 my( $class, $table, $start, $end, %opt ) = @_;
7605 push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
7606 if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
7607 push @where, "$table._date <= $start" if defined($start) && length($start);
7608 push @where, "$table._date > $end" if defined($end) && length($end);
7610 push @where, @{$opt{'where'}} if $opt{'where'};
7611 my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
7617 =item search_sql HASHREF
7621 Returns a qsearch hash expression to search for parameters specified in HREF.
7622 Valid parameters are
7630 =item cancelled_pkgs
7636 listref of start date, end date
7642 =item current_balance
7644 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
7648 =item flattened_pkgs
7657 my ($class, $params) = @_;
7668 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
7670 "cust_main.agentnum = $1";
7677 #prospect active inactive suspended cancelled
7678 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
7679 my $method = $params->{'status'}. '_sql';
7680 #push @where, $class->$method();
7681 push @where, FS::cust_main->$method();
7685 # parse cancelled package checkbox
7690 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
7691 unless $params->{'cancelled_pkgs'};
7694 # parse without census tract checkbox
7697 push @where, "(censustract = '' or censustract is null)"
7698 if $params->{'no_censustract'};
7704 foreach my $field (qw( signupdate )) {
7706 next unless exists($params->{$field});
7708 my($beginning, $ending) = @{$params->{$field}};
7711 "cust_main.$field IS NOT NULL",
7712 "cust_main.$field >= $beginning",
7713 "cust_main.$field <= $ending";
7715 $orderby ||= "ORDER BY cust_main.$field";
7723 my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
7725 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
7732 #my $balance_sql = $class->balance_sql();
7733 my $balance_sql = FS::cust_main->balance_sql();
7735 push @where, map { s/current_balance/$balance_sql/; $_ }
7736 @{ $params->{'current_balance'} };
7742 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
7744 "cust_main.custbatch = '$1'";
7748 # setup queries, subs, etc. for the search
7751 $orderby ||= 'ORDER BY custnum';
7753 # here is the agent virtualization
7754 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
7756 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
7758 my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum ) ';
7760 my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
7762 my $select = join(', ',
7763 'cust_main.custnum',
7764 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
7767 my(@extra_headers) = ();
7768 my(@extra_fields) = ();
7770 if ($params->{'flattened_pkgs'}) {
7772 if ($dbh->{Driver}->{Name} eq 'Pg') {
7774 $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";
7776 }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
7777 $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
7778 $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
7780 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
7781 "omitting packing information from report.";
7784 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";
7786 my $sth = dbh->prepare($header_query) or die dbh->errstr;
7787 $sth->execute() or die $sth->errstr;
7788 my $headerrow = $sth->fetchrow_arrayref;
7789 my $headercount = $headerrow ? $headerrow->[0] : 0;
7790 while($headercount) {
7791 unshift @extra_headers, "Package ". $headercount;
7792 unshift @extra_fields, eval q!sub {my $c = shift;
7793 my @a = split '\|', $c->magic;
7794 my $p = $a[!.--$headercount. q!];
7802 'table' => 'cust_main',
7803 'select' => $select,
7805 'extra_sql' => $extra_sql,
7806 'order_by' => $orderby,
7807 'count_query' => $count_query,
7808 'extra_headers' => \@extra_headers,
7809 'extra_fields' => \@extra_fields,
7814 =item email_search_sql HASHREF
7818 Emails a notice to the specified customers.
7820 Valid parameters are those of the L<search_sql> method, plus the following:
7842 Optional job queue job for status updates.
7846 Returns an error message, or false for success.
7848 If an error occurs during any email, stops the enture send and returns that
7849 error. Presumably if you're getting SMTP errors aborting is better than
7850 retrying everything.
7854 sub email_search_sql {
7855 my($class, $params) = @_;
7857 my $from = delete $params->{from};
7858 my $subject = delete $params->{subject};
7859 my $html_body = delete $params->{html_body};
7860 my $text_body = delete $params->{text_body};
7862 my $job = delete $params->{'job'};
7864 my $sql_query = $class->search_sql($params);
7866 my $count_query = delete($sql_query->{'count_query'});
7867 my $count_sth = dbh->prepare($count_query)
7868 or die "Error preparing $count_query: ". dbh->errstr;
7870 or die "Error executing $count_query: ". $count_sth->errstr;
7871 my $count_arrayref = $count_sth->fetchrow_arrayref;
7872 my $num_cust = $count_arrayref->[0];
7874 #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
7875 #my @extra_fields = @{ delete($sql_query->{'extra_fields'}) };
7878 my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
7880 #eventually order+limit magic to reduce memory use?
7881 foreach my $cust_main ( qsearch($sql_query) ) {
7883 my $to = $cust_main->invoicing_list_emailonly_scalar;
7886 my $error = send_email(
7890 'subject' => $subject,
7891 'html_body' => $html_body,
7892 'text_body' => $text_body,
7895 return $error if $error;
7897 if ( $job ) { #progressbar foo
7899 if ( time - $min_sec > $last ) {
7900 my $error = $job->update_statustext(
7901 int( 100 * $num / $num_cust )
7903 die $error if $error;
7913 use Storable qw(thaw);
7916 sub process_email_search_sql {
7918 #warn "$me process_re_X $method for job $job\n" if $DEBUG;
7920 my $param = thaw(decode_base64(shift));
7921 warn Dumper($param) if $DEBUG;
7923 $param->{'job'} = $job;
7925 my $error = FS::cust_main->email_search_sql( $param );
7926 die $error if $error;
7930 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
7932 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
7933 records. Currently, I<first>, I<last> and/or I<company> may be specified (the
7934 appropriate ship_ field is also searched).
7936 Additional options are the same as FS::Record::qsearch
7941 my( $self, $fuzzy, $hash, @opt) = @_;
7946 check_and_rebuild_fuzzyfiles();
7947 foreach my $field ( keys %$fuzzy ) {
7949 my $all = $self->all_X($field);
7950 next unless scalar(@$all);
7953 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
7956 foreach ( keys %match ) {
7957 push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
7958 push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
7961 push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
7964 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
7966 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
7974 Returns a masked version of the named field
7979 my ($self,$field) = @_;
7983 'x'x(length($self->getfield($field))-4).
7984 substr($self->getfield($field), (length($self->getfield($field))-4));
7994 =item smart_search OPTION => VALUE ...
7996 Accepts the following options: I<search>, the string to search for. The string
7997 will be searched for as a customer number, phone number, name or company name,
7998 as an exact, or, in some cases, a substring or fuzzy match (see the source code
7999 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8000 skip fuzzy matching when an exact match is found.
8002 Any additional options are treated as an additional qualifier on the search
8005 Returns a (possibly empty) array of FS::cust_main objects.
8012 #here is the agent virtualization
8013 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8017 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8018 my $search = delete $options{'search'};
8019 ( my $alphanum_search = $search ) =~ s/\W//g;
8021 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8023 #false laziness w/Record::ut_phone
8024 my $phonen = "$1-$2-$3";
8025 $phonen .= " x$4" if $4;
8027 push @cust_main, qsearch( {
8028 'table' => 'cust_main',
8029 'hashref' => { %options },
8030 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8032 join(' OR ', map "$_ = '$phonen'",
8033 qw( daytime night fax
8034 ship_daytime ship_night ship_fax )
8037 " AND $agentnums_sql", #agent virtualization
8040 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8041 #try looking for matches with extensions unless one was specified
8043 push @cust_main, qsearch( {
8044 'table' => 'cust_main',
8045 'hashref' => { %options },
8046 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8048 join(' OR ', map "$_ LIKE '$phonen\%'",
8050 ship_daytime ship_night )
8053 " AND $agentnums_sql", #agent virtualization
8058 # custnum search (also try agent_custid), with some tweaking options if your
8059 # legacy cust "numbers" have letters
8062 if ( $search =~ /^\s*(\d+)\s*$/
8063 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8064 && $search =~ /^\s*(\w\w?\d+)\s*$/
8071 if ( $num <= 2147483647 ) { #need a bigint custnum? wow.
8072 push @cust_main, qsearch( {
8073 'table' => 'cust_main',
8074 'hashref' => { 'custnum' => $num, %options },
8075 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8079 push @cust_main, qsearch( {
8080 'table' => 'cust_main',
8081 'hashref' => { 'agent_custid' => $num, %options },
8082 'extra_sql' => " AND $agentnums_sql", #agent virtualization
8085 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8087 my($company, $last, $first) = ( $1, $2, $3 );
8089 # "Company (Last, First)"
8090 #this is probably something a browser remembered,
8091 #so just do an exact search
8093 foreach my $prefix ( '', 'ship_' ) {
8094 push @cust_main, qsearch( {
8095 'table' => 'cust_main',
8096 'hashref' => { $prefix.'first' => $first,
8097 $prefix.'last' => $last,
8098 $prefix.'company' => $company,
8101 'extra_sql' => " AND $agentnums_sql",
8105 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8106 # try (ship_){last,company}
8110 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8111 # # full strings the browser remembers won't work
8112 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8114 use Lingua::EN::NameParse;
8115 my $NameParse = new Lingua::EN::NameParse(
8117 allow_reversed => 1,
8120 my($last, $first) = ( '', '' );
8121 #maybe disable this too and just rely on NameParse?
8122 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8124 ($last, $first) = ( $1, $2 );
8126 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
8127 } elsif ( ! $NameParse->parse($value) ) {
8129 my %name = $NameParse->components;
8130 $first = $name{'given_name_1'};
8131 $last = $name{'surname_1'};
8135 if ( $first && $last ) {
8137 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8140 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8142 ( ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8143 OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8146 push @cust_main, qsearch( {
8147 'table' => 'cust_main',
8148 'hashref' => \%options,
8149 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8152 # or it just be something that was typed in... (try that in a sec)
8156 my $q_value = dbh->quote($value);
8159 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8160 $sql .= " ( LOWER(last) = $q_value
8161 OR LOWER(company) = $q_value
8162 OR LOWER(ship_last) = $q_value
8163 OR LOWER(ship_company) = $q_value
8166 push @cust_main, qsearch( {
8167 'table' => 'cust_main',
8168 'hashref' => \%options,
8169 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8172 #no exact match, trying substring/fuzzy
8173 #always do substring & fuzzy (unless they're explicity config'ed off)
8174 #getting complaints searches are not returning enough
8175 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8177 #still some false laziness w/search_sql (was search/cust_main.cgi)
8182 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
8183 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
8186 if ( $first && $last ) {
8189 { 'first' => { op=>'ILIKE', value=>"%$first%" },
8190 'last' => { op=>'ILIKE', value=>"%$last%" },
8192 { 'ship_first' => { op=>'ILIKE', value=>"%$first%" },
8193 'ship_last' => { op=>'ILIKE', value=>"%$last%" },
8200 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
8201 { 'ship_last' => { op=>'ILIKE', value=>"%$value%" }, },
8205 foreach my $hashref ( @hashrefs ) {
8207 push @cust_main, qsearch( {
8208 'table' => 'cust_main',
8209 'hashref' => { %$hashref,
8212 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
8221 " AND $agentnums_sql", #extra_sql #agent virtualization
8224 if ( $first && $last ) {
8225 push @cust_main, FS::cust_main->fuzzy_search(
8226 { 'last' => $last, #fuzzy hashref
8227 'first' => $first }, #
8231 foreach my $field ( 'last', 'company' ) {
8233 FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
8240 #eliminate duplicates
8242 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8250 Accepts the following options: I<email>, the email address to search for. The
8251 email address will be searched for as an email invoice destination and as an
8254 #Any additional options are treated as an additional qualifier on the search
8255 #(i.e. I<agentnum>).
8257 Returns a (possibly empty) array of FS::cust_main objects (but usually just
8267 my $email = delete $options{'email'};
8269 #we're only being used by RT at the moment... no agent virtualization yet
8270 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8274 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
8276 my ( $user, $domain ) = ( $1, $2 );
8278 warn "$me smart_search: searching for $user in domain $domain"
8284 'table' => 'cust_main_invoice',
8285 'hashref' => { 'dest' => $email },
8292 map $_->cust_svc->cust_pkg,
8294 'table' => 'svc_acct',
8295 'hashref' => { 'username' => $user, },
8297 'AND ( SELECT domain FROM svc_domain
8298 WHERE svc_acct.domsvc = svc_domain.svcnum
8299 ) = '. dbh->quote($domain),
8305 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8307 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
8314 =item check_and_rebuild_fuzzyfiles
8318 use vars qw(@fuzzyfields);
8319 @fuzzyfields = ( 'last', 'first', 'company' );
8321 sub check_and_rebuild_fuzzyfiles {
8322 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8323 rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
8326 =item rebuild_fuzzyfiles
8330 sub rebuild_fuzzyfiles {
8332 use Fcntl qw(:flock);
8334 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8335 mkdir $dir, 0700 unless -d $dir;
8337 foreach my $fuzzy ( @fuzzyfields ) {
8339 open(LOCK,">>$dir/cust_main.$fuzzy")
8340 or die "can't open $dir/cust_main.$fuzzy: $!";
8342 or die "can't lock $dir/cust_main.$fuzzy: $!";
8344 open (CACHE,">$dir/cust_main.$fuzzy.tmp")
8345 or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
8347 foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
8348 my $sth = dbh->prepare("SELECT $field FROM cust_main".
8349 " WHERE $field != '' AND $field IS NOT NULL");
8350 $sth->execute or die $sth->errstr;
8352 while ( my $row = $sth->fetchrow_arrayref ) {
8353 print CACHE $row->[0]. "\n";
8358 close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
8360 rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
8371 my( $self, $field ) = @_;
8372 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8373 open(CACHE,"<$dir/cust_main.$field")
8374 or die "can't open $dir/cust_main.$field: $!";
8375 my @array = map { chomp; $_; } <CACHE>;
8380 =item append_fuzzyfiles LASTNAME COMPANY
8384 sub append_fuzzyfiles {
8385 #my( $first, $last, $company ) = @_;
8387 &check_and_rebuild_fuzzyfiles;
8389 use Fcntl qw(:flock);
8391 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8393 foreach my $field (qw( first last company )) {
8398 open(CACHE,">>$dir/cust_main.$field")
8399 or die "can't open $dir/cust_main.$field: $!";
8400 flock(CACHE,LOCK_EX)
8401 or die "can't lock $dir/cust_main.$field: $!";
8403 print CACHE "$value\n";
8405 flock(CACHE,LOCK_UN)
8406 or die "can't unlock $dir/cust_main.$field: $!";
8421 #warn join('-',keys %$param);
8422 my $fh = $param->{filehandle};
8423 my @fields = @{$param->{fields}};
8425 eval "use Text::CSV_XS;";
8428 my $csv = new Text::CSV_XS;
8435 local $SIG{HUP} = 'IGNORE';
8436 local $SIG{INT} = 'IGNORE';
8437 local $SIG{QUIT} = 'IGNORE';
8438 local $SIG{TERM} = 'IGNORE';
8439 local $SIG{TSTP} = 'IGNORE';
8440 local $SIG{PIPE} = 'IGNORE';
8442 my $oldAutoCommit = $FS::UID::AutoCommit;
8443 local $FS::UID::AutoCommit = 0;
8446 #while ( $columns = $csv->getline($fh) ) {
8448 while ( defined($line=<$fh>) ) {
8450 $csv->parse($line) or do {
8451 $dbh->rollback if $oldAutoCommit;
8452 return "can't parse: ". $csv->error_input();
8455 my @columns = $csv->fields();
8456 #warn join('-',@columns);
8459 foreach my $field ( @fields ) {
8460 $row{$field} = shift @columns;
8463 my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
8464 unless ( $cust_main ) {
8465 $dbh->rollback if $oldAutoCommit;
8466 return "unknown custnum $row{'custnum'}";
8469 if ( $row{'amount'} > 0 ) {
8470 my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
8472 $dbh->rollback if $oldAutoCommit;
8476 } elsif ( $row{'amount'} < 0 ) {
8477 my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
8480 $dbh->rollback if $oldAutoCommit;
8490 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
8492 return "Empty file!" unless $imported;
8498 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8500 Sends a templated email notification to the customer (see L<Text::Template>).
8502 OPTIONS is a hash and may include
8504 I<from> - the email sender (default is invoice_from)
8506 I<to> - comma-separated scalar or arrayref of recipients
8507 (default is invoicing_list)
8509 I<subject> - The subject line of the sent email notification
8510 (default is "Notice from company_name")
8512 I<extra_fields> - a hashref of name/value pairs which will be substituted
8515 The following variables are vavailable in the template.
8517 I<$first> - the customer first name
8518 I<$last> - the customer last name
8519 I<$company> - the customer company
8520 I<$payby> - a description of the method of payment for the customer
8521 # would be nice to use FS::payby::shortname
8522 I<$payinfo> - the account information used to collect for this customer
8523 I<$expdate> - the expiration of the customer payment in seconds from epoch
8528 my ($self, $template, %options) = @_;
8530 return unless $conf->exists($template);
8532 my $from = $conf->config('invoice_from', $self->agentnum)
8533 if $conf->exists('invoice_from', $self->agentnum);
8534 $from = $options{from} if exists($options{from});
8536 my $to = join(',', $self->invoicing_list_emailonly);
8537 $to = $options{to} if exists($options{to});
8539 my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
8540 if $conf->exists('company_name', $self->agentnum);
8541 $subject = $options{subject} if exists($options{subject});
8543 my $notify_template = new Text::Template (TYPE => 'ARRAY',
8544 SOURCE => [ map "$_\n",
8545 $conf->config($template)]
8547 or die "can't create new Text::Template object: Text::Template::ERROR";
8548 $notify_template->compile()
8549 or die "can't compile template: Text::Template::ERROR";
8551 $FS::notify_template::_template::company_name =
8552 $conf->config('company_name', $self->agentnum);
8553 $FS::notify_template::_template::company_address =
8554 join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
8556 my $paydate = $self->paydate || '2037-12-31';
8557 $FS::notify_template::_template::first = $self->first;
8558 $FS::notify_template::_template::last = $self->last;
8559 $FS::notify_template::_template::company = $self->company;
8560 $FS::notify_template::_template::payinfo = $self->mask_payinfo;
8561 my $payby = $self->payby;
8562 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
8563 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
8565 #credit cards expire at the end of the month/year of their exp date
8566 if ($payby eq 'CARD' || $payby eq 'DCRD') {
8567 $FS::notify_template::_template::payby = 'credit card';
8568 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
8569 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
8571 }elsif ($payby eq 'COMP') {
8572 $FS::notify_template::_template::payby = 'complimentary account';
8574 $FS::notify_template::_template::payby = 'current method';
8576 $FS::notify_template::_template::expdate = $expire_time;
8578 for (keys %{$options{extra_fields}}){
8580 ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
8583 send_email(from => $from,
8585 subject => $subject,
8586 body => $notify_template->fill_in( PACKAGE =>
8587 'FS::notify_template::_template' ),
8592 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8594 Generates a templated notification to the customer (see L<Text::Template>).
8596 OPTIONS is a hash and may include
8598 I<extra_fields> - a hashref of name/value pairs which will be substituted
8599 into the template. These values may override values mentioned below
8600 and those from the customer record.
8602 The following variables are available in the template instead of or in addition
8603 to the fields of the customer record.
8605 I<$payby> - a description of the method of payment for the customer
8606 # would be nice to use FS::payby::shortname
8607 I<$payinfo> - the masked account information used to collect for this customer
8608 I<$expdate> - the expiration of the customer payment method in seconds from epoch
8609 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
8613 sub generate_letter {
8614 my ($self, $template, %options) = @_;
8616 return unless $conf->exists($template);
8618 my $letter_template = new Text::Template
8620 SOURCE => [ map "$_\n", $conf->config($template)],
8621 DELIMITERS => [ '[@--', '--@]' ],
8623 or die "can't create new Text::Template object: Text::Template::ERROR";
8625 $letter_template->compile()
8626 or die "can't compile template: Text::Template::ERROR";
8628 my %letter_data = map { $_ => $self->$_ } $self->fields;
8629 $letter_data{payinfo} = $self->mask_payinfo;
8631 #my $paydate = $self->paydate || '2037-12-31';
8632 my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
8634 my $payby = $self->payby;
8635 my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
8636 my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
8638 #credit cards expire at the end of the month/year of their exp date
8639 if ($payby eq 'CARD' || $payby eq 'DCRD') {
8640 $letter_data{payby} = 'credit card';
8641 ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
8642 $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
8644 }elsif ($payby eq 'COMP') {
8645 $letter_data{payby} = 'complimentary account';
8647 $letter_data{payby} = 'current method';
8649 $letter_data{expdate} = $expire_time;
8651 for (keys %{$options{extra_fields}}){
8652 $letter_data{$_} = $options{extra_fields}->{$_};
8655 unless(exists($letter_data{returnaddress})){
8656 my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
8657 $self->agent_template)
8659 if ( length($retadd) ) {
8660 $letter_data{returnaddress} = $retadd;
8661 } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
8662 $letter_data{returnaddress} =
8663 join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
8664 $conf->config('company_address', $self->agentnum)
8667 $letter_data{returnaddress} = '~';
8671 $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
8673 $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
8675 my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
8676 my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
8680 ) or die "can't open temp file: $!\n";
8682 $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
8684 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
8688 =item print_ps TEMPLATE
8690 Returns an postscript letter filled in from TEMPLATE, as a scalar.
8696 my $file = $self->generate_letter(@_);
8697 FS::Misc::generate_ps($file);
8700 =item print TEMPLATE
8702 Prints the filled in template.
8704 TEMPLATE is the name of a L<Text::Template> to fill in and print.
8708 sub queueable_print {
8711 my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
8712 or die "invalid customer number: " . $opt{custvnum};
8714 my $error = $self->print( $opt{template} );
8715 die $error if $error;
8719 my ($self, $template) = (shift, shift);
8720 do_print [ $self->print_ps($template) ];
8723 #these three subs should just go away once agent stuff is all config overrides
8725 sub agent_template {
8727 $self->_agent_plandata('agent_templatename');
8730 sub agent_invoice_from {
8732 $self->_agent_plandata('agent_invoice_from');
8735 sub _agent_plandata {
8736 my( $self, $option ) = @_;
8738 #yuck. this whole thing needs to be reconciled better with 1.9's idea of
8739 #agent-specific Conf
8741 use FS::part_event::Condition;
8743 my $agentnum = $self->agentnum;
8746 if ( driver_name =~ /^Pg/i ) {
8748 } elsif ( driver_name =~ /^mysql/i ) {
8751 die "don't know how to use regular expressions in ". driver_name. " databases";
8754 my $part_event_option =
8756 'select' => 'part_event_option.*',
8757 'table' => 'part_event_option',
8759 LEFT JOIN part_event USING ( eventpart )
8760 LEFT JOIN part_event_option AS peo_agentnum
8761 ON ( part_event.eventpart = peo_agentnum.eventpart
8762 AND peo_agentnum.optionname = 'agentnum'
8763 AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
8765 LEFT JOIN part_event_condition
8766 ON ( part_event.eventpart = part_event_condition.eventpart
8767 AND part_event_condition.conditionname = 'cust_bill_age'
8769 LEFT JOIN part_event_condition_option
8770 ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
8771 AND part_event_condition_option.optionname = 'age'
8774 #'hashref' => { 'optionname' => $option },
8775 #'hashref' => { 'part_event_option.optionname' => $option },
8777 " WHERE part_event_option.optionname = ". dbh->quote($option).
8778 " AND action = 'cust_bill_send_agent' ".
8779 " AND ( disabled IS NULL OR disabled != 'Y' ) ".
8780 " AND peo_agentnum.optionname = 'agentnum' ".
8781 " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
8783 CASE WHEN part_event_condition_option.optionname IS NULL
8785 ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
8787 , part_event.weight".
8791 unless ( $part_event_option ) {
8792 return $self->agent->invoice_template || ''
8793 if $option eq 'agent_templatename';
8797 $part_event_option->optionvalue;
8802 ## actual sub, not a method, designed to be called from the queue.
8803 ## sets up the customer, and calls the bill_and_collect
8804 my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
8805 my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
8806 $cust_main->bill_and_collect(
8811 sub _upgrade_data { #class method
8812 my ($class, %opts) = @_;
8814 my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
8815 my $sth = dbh->prepare($sql) or die dbh->errstr;
8816 $sth->execute or die $sth->errstr;
8826 The delete method should possibly take an FS::cust_main object reference
8827 instead of a scalar customer number.
8829 Bill and collect options should probably be passed as references instead of a
8832 There should probably be a configuration file with a list of allowed credit
8835 No multiple currency support (probably a larger project than just this module).
8837 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
8839 Birthdates rely on negative epoch values.
8841 The payby for card/check batches is broken. With mixed batching, bad
8844 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
8848 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
8849 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
8850 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.