X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fcust_pay.pm;h=e0c99f89882200760e502fd6465e608afdd9e6a3;hp=90a14ea02af052ae5e7c92898bb7b3cd544603d8;hb=74a3083375ccc3a0dc8b74f9b39392989d088656;hpb=c648976f0b7975f2328ebd7ba8c711fad0ca4195 diff --git a/FS/FS/cust_pay.pm b/FS/FS/cust_pay.pm index 90a14ea02..e0c99f898 100644 --- a/FS/FS/cust_pay.pm +++ b/FS/FS/cust_pay.pm @@ -1,7 +1,9 @@ package FS::cust_pay; use strict; -use vars qw( @ISA $DEBUG $me $conf @encrypted_fields +use base qw( FS::otaker_Mixin FS::payinfo_transaction_Mixin FS::cust_main_Mixin + FS::Record ); +use vars qw( $DEBUG $me $conf @encrypted_fields $unsuspendauto $ignore_noapply ); use Date::Format; @@ -10,17 +12,17 @@ use Text::Template; use FS::UID qw( getotaker ); use FS::Misc qw( send_email ); use FS::Record qw( dbh qsearch qsearchs ); +use FS::CurrentUser; use FS::payby; use FS::cust_main_Mixin; -use FS::payinfo_Mixin; +use FS::payinfo_transaction_Mixin; use FS::cust_bill; use FS::cust_bill_pay; use FS::cust_pay_refund; use FS::cust_main; +use FS::cust_pkg; use FS::cust_pay_void; -@ISA = qw(FS::Record FS::cust_main_Mixin FS::payinfo_Mixin ); - $DEBUG = 0; $me = '[FS::cust_pay]'; @@ -62,28 +64,54 @@ currently supported: =over 4 -=item paynum - primary key (assigned automatically for new payments) +=item paynum + +primary key (assigned automatically for new payments) + +=item custnum + +customer (see L) -=item custnum - customer (see L) +=item _date -=item _date - specified as a UNIX timestamp; see L. Also see +specified as a UNIX timestamp; see L. Also see L and L for conversion functions. -=item paid - Amount of this payment +=item paid + +Amount of this payment + +=item usernum + +order taker (see L) + +=item payby -=item otaker - order taker (assigned automatically, see L) +Payment Type (See L for valid payby values) -=item payby - Payment Type (See L for valid payby values) +=item payinfo -=item payinfo - Payment Information (See L for data format) +Payment Information (See L for data format) -=item paymask - Masked payinfo (See L for how this works) +=item paymask -=item paybatch - text field for tracking card processing or other batch grouping +Masked payinfo (See L for how this works) -=item payunique - Optional unique identifer to prevent duplicate transactions. +=item paybatch -=item closed - books closed flag, empty or `Y' +text field for tracking card processing or other batch grouping + +=item payunique + +Optional unique identifer to prevent duplicate transactions. + +=item closed + +books closed flag, empty or `Y' + +=item pkgnum + +Desired pkgnum when using experimental package balances. =back @@ -105,21 +133,26 @@ sub cust_unlinked_msg { ' (cust_pay.paynum '. $self->paynum. ')'; } -=item insert +=item insert [ OPTION => VALUE ... ] Adds this payment to the database. For backwards-compatibility and convenience, if the additional field invnum is defined, an FS::cust_bill_pay record for the full amount of the payment -will be created. In this case, custnum is optional. An hash of optional -arguments may be passed. Currently "manual" is supported. If true, a -payment receipt is sent instead of a statement when 'payment_receipt_email' -configuration option is set. +will be created. In this case, custnum is optional. + +If the additional field discount_term is defined then a prepayment discount +is taken for that length of time. It is an error for the customer to owe +after this payment is made. + +A hash of optional arguments may be passed. Currently "manual" is supported. +If true, a payment receipt is sent instead of a statement when +'payment_receipt_email' configuration option is set. =cut sub insert { - my ($self, %options) = @_; + my($self, %options) = @_; local $SIG{HUP} = 'IGNORE'; local $SIG{INT} = 'IGNORE'; @@ -142,7 +175,6 @@ sub insert { $self->custnum($cust_bill->custnum ); } - my $error = $self->check; return $error if $error; @@ -152,7 +184,52 @@ sub insert { $error = $self->SUPER::insert; if ( $error ) { $dbh->rollback if $oldAutoCommit; - return "error inserting $self: $error"; + return "error inserting cust_pay: $error"; + } + + if ( my $credit_type = $conf->config('prepayment_discounts-credit_type') ) { + if ( my $months = $self->discount_term ) { + #hmmm... error handling + my ($credit, $savings, $total) = + $cust_main->discount_term_values($months); + my $cust_credit = new FS::cust_credit { + 'custnum' => $self->custnum, + 'amount' => $credit, + 'reason' => 'customer chose to prepay for discount', + }; + $error = $cust_credit->insert('reason_type' => $credit_type); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "error inserting cust_pay: $error"; + } + my @pkgs = $cust_main->_discount_pkgs_and_bill; + my $cust_bill = shift(@pkgs); + @pkgs = &FS::cust_main::Billing::_discountable_pkgs_at_term($months, @pkgs); + $_->bill($_->last_bill) foreach @pkgs; + $error = $cust_main->bill( + 'recurring_only' => 1, + 'time' => $cust_bill->invoice_date, + 'no_usage_reset' => 1, + 'pkg_list' => \@pkgs, + 'freq_override' => $months, + ); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "error inserting cust_pay: $error"; + } + $error = $cust_main->apply_payments_and_credits; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "error inserting cust_pay: $error"; + } + my $new_balance = $cust_main->balance; + if ($new_balance > 0) { + $dbh->rollback if $oldAutoCommit; + return "balance after prepay discount attempt: $new_balance"; + } + + } + } if ( $self->invnum ) { @@ -162,14 +239,14 @@ sub insert { 'amount' => $self->paid, '_date' => $self->_date, }; - $error = $cust_bill_pay->insert; + $error = $cust_bill_pay->insert(%options); if ( $error ) { if ( $ignore_noapply ) { - warn "warning: error inserting $cust_bill_pay: $error ". + warn "warning: error inserting cust_bill_pay: $error ". "(ignore_noapply flag set; inserting cust_pay record anyway)\n"; } else { $dbh->rollback if $oldAutoCommit; - return "error inserting $cust_bill_pay: $error"; + return "error inserting cust_bill_pay: $error"; } } } @@ -189,68 +266,15 @@ sub insert { $dbh->commit or die $dbh->errstr if $oldAutoCommit; - #my $cust_main = $self->cust_main; - if ( $conf->exists('payment_receipt_email') - && grep { $_ !~ /^(POST|FAX)$/ } $cust_main->invoicing_list - ) { - - $cust_bill ||= ($cust_main->cust_bill)[-1]; #rather inefficient though? - - my $error; - if ( ( exists($options{'manual'}) && $options{'manual'} ) - || ! $conf->exists('invoice_html_statement') - || ! $cust_bill - ) { - - my $receipt_template = new Text::Template ( - TYPE => 'ARRAY', - SOURCE => [ map "$_\n", $conf->config('payment_receipt_email') ], - ) or do { - warn "can't create payment receipt template: $Text::Template::ERROR"; - return ''; - }; - - my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } - $cust_main->invoicing_list; - - my $payby = $self->payby; - my $payinfo = $self->payinfo; - $payby =~ s/^BILL$/Check/ if $payinfo; - $payinfo = $self->paymask if $payby eq 'CARD' || $payby eq 'CHEK'; - $payby =~ s/^CHEK$/Electronic check/; - - $error = send_email( - 'from' => $conf->config('invoice_from'), #??? well as good as any - 'to' => \@invoicing_list, - 'subject' => 'Payment receipt', - 'body' => [ $receipt_template->fill_in( HASH => { - 'date' => time2str("%a %B %o, %Y", $self->_date), - 'name' => $cust_main->name, - 'paynum' => $self->paynum, - 'paid' => sprintf("%.2f", $self->paid), - 'payby' => ucfirst(lc($payby)), - 'payinfo' => $payinfo, - 'balance' => $cust_main->balance, - } ) ], - ); - - } else { - - my $queue = new FS::queue { - 'paynum' => $self->paynum, - 'job' => 'FS::cust_bill::queueable_email', - }; - $error = $queue->insert( - 'invnum' => $cust_bill->invnum, - 'template' => 'statement', - ); - - } - - if ( $error ) { - warn "can't send payment receipt/statement: $error"; - } - + #payment receipt + my $trigger = $conf->config('payment_receipt-trigger') || 'cust_pay'; + if ( $trigger eq 'cust_pay' ) { + my $error = $self->send_receipt( + 'manual' => $options{'manual'}, + 'cust_bill' => $cust_bill, + 'cust_main' => $cust_main, + ); + warn "can't send payment receipt/statement: $error" if $error; } ''; @@ -339,12 +363,14 @@ sub delete { return $error; } - if ( $conf->config('deletepayments') ne '' ) { + if ( $conf->exists('deletepayments') + && $conf->config('deletepayments') ne '' ) { my $cust_main = $self->cust_main; my $error = send_email( - 'from' => $conf->config('invoice_from'), #??? well as good as any + 'from' => $conf->config('invoice_from', $self->cust_main->agentnum), + #invoice_from??? well as good as any 'to' => $conf->config('deletepayments'), 'subject' => 'FREESIDE NOTIFICATION: Payment deleted', 'body' => [ @@ -398,18 +424,20 @@ returns the error, otherwise returns false. Called by the insert method. sub check { my $self = shift; - $self->otaker(getotaker) unless ($self->otaker); + $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum; my $error = $self->ut_numbern('paynum') || $self->ut_numbern('custnum') || $self->ut_numbern('_date') || $self->ut_money('paid') - || $self->ut_alpha('otaker') + || $self->ut_alphan('otaker') || $self->ut_textn('paybatch') || $self->ut_textn('payunique') || $self->ut_enum('closed', [ '', 'Y' ]) + || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum') || $self->payinfo_check() + || $self->ut_numbern('discount_term') ; return $error if $error; @@ -421,6 +449,9 @@ sub check { $self->_date(time) unless $self->_date; + return "invalid discount_term" + if ($self->discount_term && $self->discount_term < 2); + #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it # # UNIQUE index should catch this too, without race conditions, but this # # should give a better error message the other 99.9% of the time... @@ -432,64 +463,131 @@ sub check { # " already exists"; # } - $self->otaker(getotaker); - $self->SUPER::check; } -=item batch_insert CUST_PAY_OBJECT, ... +=item send_receipt HASHREF | OPTION => VALUE ... -Class method which inserts multiple payments. Takes a list of FS::cust_pay -objects. Returns a list, each element representing the status of inserting the -corresponding payment - empty. If there is an error inserting any payment, the -entire transaction is rolled back, i.e. all payments are inserted or none are. +Sends a payment receipt for this payment.. -For example: +Available options: - my @errors = FS::cust_pay->batch_insert(@cust_pay); - my $num_errors = scalar(grep $_, @errors); - if ( $num_errors == 0 ) { - #success; all payments were inserted - } else { - #failure; no payments were inserted. - } +=over 4 + +=item manual + +Flag indicating the payment is being made manually. + +=item cust_bill + +Invoice (FS::cust_bill) object. If not specified, the most recent invoice +will be assumed. + +=item cust_main + +Customer (FS::cust_main) object (for efficiency). + +=back =cut -sub batch_insert { - my $self = shift; #class method +sub send_receipt { + my $self = shift; + my $opt = ref($_[0]) ? shift : { @_ }; - local $SIG{HUP} = 'IGNORE'; - local $SIG{INT} = 'IGNORE'; - local $SIG{QUIT} = 'IGNORE'; - local $SIG{TERM} = 'IGNORE'; - local $SIG{TSTP} = 'IGNORE'; - local $SIG{PIPE} = 'IGNORE'; + my $cust_bill = $opt->{'cust_bill'}; + my $cust_main = $opt->{'cust_main'} || $self->cust_main; - my $oldAutoCommit = $FS::UID::AutoCommit; - local $FS::UID::AutoCommit = 0; - my $dbh = dbh; + my $conf = new FS::Conf; + + return '' unless $conf->exists('payment_receipt'); + + my @invoicing_list = $cust_main->invoicing_list_emailonly; + return '' unless @invoicing_list; + + $cust_bill ||= ($cust_main->cust_bill)[-1]; #rather inefficient though? + + my $error = ''; + + if ( ( exists($opt->{'manual'}) && $opt->{'manual'} ) + || ! $conf->exists('invoice_html_statement') + || ! $cust_bill + ) + { + + if ( $conf->exists('payment_receipt_msgnum') + && $conf->config('payment_receipt_msgnum') + ) + { + my $msg_template = + FS::msg_template->by_key($conf->config('payment_receipt_msgnum')); + $error = $msg_template->send('cust_main'=> $cust_main, 'object'=> $self); + + } elsif ( $conf->exists('payment_receipt_email') ) { + + my $receipt_template = new Text::Template ( + TYPE => 'ARRAY', + SOURCE => [ map "$_\n", $conf->config('payment_receipt_email') ], + ) or do { + warn "can't create payment receipt template: $Text::Template::ERROR"; + return ''; + }; + + my $payby = $self->payby; + my $payinfo = $self->payinfo; + $payby =~ s/^BILL$/Check/ if $payinfo; + if ( $payby eq 'CARD' || $payby eq 'CHEK' ) { + $payinfo = $self->paymask + } else { + $payinfo = $self->decrypt($payinfo); + } + $payby =~ s/^CHEK$/Electronic check/; + + my %fill_in = ( + 'date' => time2str("%a %B %o, %Y", $self->_date), + 'name' => $cust_main->name, + 'paynum' => $self->paynum, + 'paid' => sprintf("%.2f", $self->paid), + 'payby' => ucfirst(lc($payby)), + 'payinfo' => $payinfo, + 'balance' => $cust_main->balance, + 'company_name' => $conf->config('company_name', $cust_main->agentnum), + ); + + if ( $opt->{'cust_pkg'} ) { + $fill_in{'pkg'} = $opt->{'cust_pkg'}->part_pkg->pkg; + #setup date, other things? + } + + $error = send_email( + 'from' => $conf->config('invoice_from', $cust_main->agentnum), + #invoice_from??? well as good as any + 'to' => \@invoicing_list, + 'subject' => 'Payment receipt', + 'body' => [ $receipt_template->fill_in( HASH => \%fill_in ) ], + ); - my $errors = 0; - - my @errors = map { - my $error = $_->insert( 'manual' => 1 ); - if ( $error ) { - $errors++; } else { - $_->cust_main->apply_payments; + + warn "payment_receipt is on, but no payment_receipt_msgnum or invoice_html_statement is configured\n"; + } - $error; - } @_; - if ( $errors ) { - $dbh->rollback if $oldAutoCommit; - } else { - $dbh->commit or die $dbh->errstr if $oldAutoCommit; - } + } else { #not manual - @errors; + my $queue = new FS::queue { + 'paynum' => $self->paynum, + 'job' => 'FS::cust_bill::queueable_email', + }; + + $error = $queue->insert( + 'invnum' => $cust_bill->invnum, + 'template' => 'statement', + ); + } + + warn "send_receipt: $error\n" if $error; } =item cust_bill_pay @@ -501,6 +599,7 @@ payment. sub cust_bill_pay { my $self = shift; + map { $_ } #return $self->num_cust_bill_pay unless wantarray; sort { $a->_date <=> $b->_date || $a->invnum <=> $b->invnum } qsearch( 'cust_bill_pay', { 'paynum' => $self->paynum } ) @@ -516,6 +615,7 @@ payment. sub cust_pay_refund { my $self = shift; + map { $_ } #return $self->num_cust_pay_refund unless wantarray; sort { $a->_date <=> $b->_date } qsearch( 'cust_pay_refund', { 'paynum' => $self->paynum } ) ; @@ -552,92 +652,78 @@ sub unrefunded { sprintf("%.2f", $amount ); } +=item amount -=item cust_main - -Returns the parent customer object (see L). - -=cut - -sub cust_main { - my $self = shift; - qsearchs( 'cust_main', { 'custnum' => $self->custnum } ); -} - -=item payby_name - -Returns a name for the payby field. +Returns the "paid" field. =cut -sub payby_name { +sub amount { my $self = shift; - FS::payby->shortname( $self->payby ); + $self->paid(); } -=item gatewaynum - -Returns a gatewaynum for the processing gateway. +=back -=item processor +=head1 CLASS METHODS -Returns a name for the processing gateway. +=over 4 -=item authorization +=item batch_insert CUST_PAY_OBJECT, ... -Returns a name for the processing gateway. +Class method which inserts multiple payments. Takes a list of FS::cust_pay +objects. Returns a list, each element representing the status of inserting the +corresponding payment - empty. If there is an error inserting any payment, the +entire transaction is rolled back, i.e. all payments are inserted or none are. -=item order_number +For example: -Returns a name for the processing gateway. + my @errors = FS::cust_pay->batch_insert(@cust_pay); + my $num_errors = scalar(grep $_, @errors); + if ( $num_errors == 0 ) { + #success; all payments were inserted + } else { + #failure; no payments were inserted. + } =cut -sub gatewaynum { shift->_parse_paybatch->{'gatewaynum'}; } -sub processor { shift->_parse_paybatch->{'processor'}; } -sub authorization { shift->_parse_paybatch->{'authorization'}; } -sub order_number { shift->_parse_paybatch->{'order_number'}; } - -#sucks that this stuff is in paybatch like this in the first place, -#but at least other code can start to use new field names -#(code nicked from FS::cust_main::realtime_refund_bop) -sub _parse_paybatch { - my $self = shift; - - $self->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/ - or return {}; - #"Can't parse paybatch for paynum $options{'paynum'}: ". - # $cust_pay->paybatch; - - my( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 ); - - if ( $gatewaynum ) { #gateway for the payment to be refunded +sub batch_insert { + my $self = shift; #class method - my $payment_gateway = - qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } ); + local $SIG{HUP} = 'IGNORE'; + local $SIG{INT} = 'IGNORE'; + local $SIG{QUIT} = 'IGNORE'; + local $SIG{TERM} = 'IGNORE'; + local $SIG{TSTP} = 'IGNORE'; + local $SIG{PIPE} = 'IGNORE'; - die "payment gateway $gatewaynum not found" #? - unless $payment_gateway; + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; - $processor = $payment_gateway->gateway_module; + my $errors = 0; + + my @errors = map { + my $error = $_->insert( 'manual' => 1 ); + if ( $error ) { + $errors++; + } else { + $_->cust_main->apply_payments; + } + $error; + } @_; + if ( $errors ) { + $dbh->rollback if $oldAutoCommit; + } else { + $dbh->commit or die $dbh->errstr if $oldAutoCommit; } - { - 'gatewaynum' => $gatewaynum, - 'processor' => $processor, - 'authorization' => $auth, - 'order_number' => $order_number, - }; + @errors; } -=back - -=head1 CLASS METHODS - -=over 4 - =item unapplied_sql Returns an SQL fragment to retreive the unapplied amount. @@ -645,17 +731,23 @@ Returns an SQL fragment to retreive the unapplied amount. =cut sub unapplied_sql { - #my $class = shift; + my ($class, $start, $end) = @_; + my $bill_start = $start ? "AND cust_bill_pay._date <= $start" : ''; + my $bill_end = $end ? "AND cust_bill_pay._date > $end" : ''; + my $refund_start = $start ? "AND cust_pay_refund._date <= $start" : ''; + my $refund_end = $end ? "AND cust_pay_refund._date > $end" : ''; "paid - COALESCE( ( SELECT SUM(amount) FROM cust_bill_pay - WHERE cust_pay.paynum = cust_bill_pay.paynum ) + WHERE cust_pay.paynum = cust_bill_pay.paynum + $bill_start $bill_end ) ,0 ) - COALESCE( ( SELECT SUM(amount) FROM cust_pay_refund - WHERE cust_pay.paynum = cust_pay_refund.paynum ) + WHERE cust_pay.paynum = cust_pay_refund.paynum + $refund_start $refund_end ) ,0 ) "; @@ -673,32 +765,41 @@ sub _upgrade_data { #class method warn "$me upgrading $class\n" if $DEBUG; + ## + # otaker/ivan upgrade + ## + #not the most efficient, but hey, it only has to run once - my $count_sql = - "SELECT COUNT(*) FROM cust_pay WHERE otaker IS NULL OR otaker = ''"; + my $where = "WHERE ( otaker IS NULL OR otaker = '' OR otaker = 'ivan' ) ". + " AND usernum IS NULL ". + " AND 0 < ( SELECT COUNT(*) FROM cust_main ". + " WHERE cust_main.custnum = cust_pay.custnum ) "; + + my $count_sql = "SELECT COUNT(*) FROM cust_pay $where"; my $sth = dbh->prepare($count_sql) or die dbh->errstr; $sth->execute or die $sth->errstr; my $total = $sth->fetchrow_arrayref->[0]; - + #warn "$total cust_pay records to update\n" + # if $DEBUG; local($DEBUG) = 2 if $total > 1000; #could be a while, force progress info my $count = 0; my $lastprog = 0; - while (1) { - my $cust_pay = qsearchs( { + my @cust_pay = qsearch( { 'table' => 'cust_pay', 'hashref' => {}, - 'extra_sql' => "WHERE otaker IS NULL OR otaker = ''", - 'order_by' => 'ORDER BY paynum LIMIT 1', - } ); + 'extra_sql' => $where, + 'order_by' => 'ORDER BY paynum', + } ); - return unless $cust_pay; + foreach my $cust_pay (@cust_pay) { my $h_cust_pay = $cust_pay->h_search('insert'); if ( $h_cust_pay ) { + next if $cust_pay->otaker eq $h_cust_pay->history_user; $cust_pay->otaker($h_cust_pay->history_user); } else { $cust_pay->otaker('legacy'); @@ -706,7 +807,13 @@ sub _upgrade_data { #class method delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge my $error = $cust_pay->replace; - die $error if $error; + + if ( $error ) { + warn " *** WARNING: Error updating order taker for payment paynum ". + $cust_pay->paynun. ": $error\n"; + next; + } + $FS::payby::hash{'COMP'}->{cust_pay} = ''; #restore it $count++; @@ -717,6 +824,47 @@ sub _upgrade_data { #class method } + ### + # payinfo N/A upgrade + ### + + #XXX remove the 'N/A (tokenized)' part (or just this entire thing) + + my @na_cust_pay = qsearch( { + 'table' => 'cust_pay', + 'hashref' => {}, #could be encrypted# { 'payinfo' => 'N/A' }, + 'extra_sql' => "WHERE ( payinfo = 'N/A' OR paymask = 'N/AA' OR paymask = 'N/A (tokenized)' ) AND payby IN ( 'CARD', 'CHEK' )", + } ); + + foreach my $na ( @na_cust_pay ) { + + next unless $na->payinfo eq 'N/A'; + + my $cust_pay_pending = + qsearchs('cust_pay_pending', { 'paynum' => $na->paynum } ); + unless ( $cust_pay_pending ) { + warn " *** WARNING: not-yet recoverable N/A card for payment ". + $na->paynum. " (no cust_pay_pending)\n"; + next; + } + $na->$_($cust_pay_pending->$_) for qw( payinfo paymask ); + my $error = $na->replace; + if ( $error ) { + warn " *** WARNING: Error updating payinfo for payment paynum ". + $na->paynun. ": $error\n"; + next; + } + + } + + ### + # otaker->usernum upgrade + ### + + delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge + $class->_upgrade_otaker(%opts); + $FS::payby::hash{'COMP'}->{cust_pay} = ''; #restore it + } =back