X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fpay_batch.pm;h=c57c554984de1aaa5c0669afb38be5ebf1c2f688;hp=4f223e1137ba6a62291bd2930c30f53642b27c43;hb=f1d04f65cbacc2d5f4a286ef2a4c3f1b6b3943c2;hpb=85e677b86fc37c54e6de2b06340351a28f5a5916 diff --git a/FS/FS/pay_batch.pm b/FS/FS/pay_batch.pm index 4f223e113..c57c55498 100644 --- a/FS/FS/pay_batch.pm +++ b/FS/FS/pay_batch.pm @@ -1,19 +1,20 @@ package FS::pay_batch; +use base qw( FS::Record ); use strict; -use vars qw( @ISA $DEBUG %import_info %export_info $conf ); +use vars qw( $DEBUG %import_info %export_info $conf ); +use Scalar::Util qw(blessed); +use IO::Scalar; +use List::Util qw(sum); use Time::Local; use Text::CSV_XS; +use Date::Parse qw(str2time); +use Business::CreditCard qw( 0.35 cardtype ); use FS::Record qw( dbh qsearch qsearchs ); use FS::Conf; use FS::cust_pay; -use FS::agent; -use Date::Parse qw(str2time); -use Business::CreditCard qw(cardtype); -use Scalar::Util 'blessed'; -use IO::Scalar; - -@ISA = qw(FS::Record); +use FS::Log; +use Try::Tiny; =head1 NAME @@ -49,10 +50,18 @@ from FS::Record. The following fields are currently supported: =item status - O (Open), I (In-transit), or R (Resolved) -=item download - +=item download - time when the batch was first downloaded + +=item upload - time when the batch was first uploaded -=item upload - +=item title - unique batch identifier +=item processor_id - + +=item type - batch type payents (DEBIT), or refunds (CREDIT) + +For incoming batches, the combination of 'title', 'payby', and 'agentnum' +must be unique. =back @@ -118,9 +127,22 @@ sub check { || $self->ut_enum('payby', [ 'CARD', 'CHEK' ]) || $self->ut_enum('status', [ 'O', 'I', 'R' ]) || $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum') + || $self->ut_alphan('title') ; return $error if $error; + if ( $self->title ) { + my @existing = + grep { !$self->batchnum or $_->batchnum != $self->batchnum } + qsearch('pay_batch', { + payby => $self->payby, + agentnum => $self->agentnum, + title => $self->title, + }); + return "Batch already exists as batchnum ".$existing[0]->batchnum + if @existing; + } + $self->SUPER::check; } @@ -128,22 +150,10 @@ sub check { Returns the L object for this batch. -=cut - -sub agent { - qsearchs('agent', { 'agentnum' => $_[0]->agentnum }); -} - =item cust_pay_batch Returns all L objects for this batch. -=cut - -sub cust_pay_batch { - qsearch('cust_pay_batch', { 'batchnum' => $_[0]->batchnum }); -} - =item rebalance =cut @@ -182,7 +192,7 @@ foreach my $INC (@INC) { \\%FS::pay_batch::$mod\::export_info, \$FS::pay_batch::$mod\::name)"; $name ||= $mod; # in case it's not defined - if( $@) { + if ($@) { # in FS::cdr this is a die, not a warn. That's probably a bug. warn "error using FS::pay_batch::$mod (skipping): $@\n"; next; @@ -204,7 +214,9 @@ foreach my $INC (@INC) { =item import_results OPTION => VALUE, ... -Import batch results. +Import batch results. Can be called as an instance method, if you want to +automatically adjust status on a specific batch, or a class method, if you +don't know which batch(es) the results apply to. Options are: @@ -215,6 +227,38 @@ I - an L module I - an L object for a batch gateway. This takes precedence over I. +I - do not try to close batches + +Supported format keys (defined in the specified FS::pay_batch module) are: + +I - required, can be CSV, fixed, variable, XML + +I - required list of field names for each row/line + +I - regular expression for fixed filetype + +I - required for variable filetype + +I - required for XML filetype + +I - required for XML filetype + +I - sub, ignore all lines before this returns true + +I - sub, stop processing lines when this returns true + +I - sub, runs immediately after end_condition returns true + +I - sub, skip lines when this returns true + +I - required, sub, runs before approved/declined conditions are checked + +I - required, sub, returns true when approved + +I - required, sub, returns true when declined + +I - sub, decide whether or not to close the batch + =cut sub import_results { @@ -225,11 +269,6 @@ sub import_results { my $job = $param->{'job'}; $job->update_statustext(0) if $job; - my $gateway = $param->{'gateway'}; - if ( $gateway ) { - return $self->import_from_gateway($gateway, 'file' => $fh, 'job' => $job); - } - my $format = $param->{'format'}; my $info = $import_info{$format} or die "unknown format $format"; @@ -250,6 +289,8 @@ sub import_results { my $declined_condition = $info->{'declined'}; my $close_condition = $info->{'close_condition'}; + my %target_batches; # batches that had at least one payment updated + my $csv = new Text::CSV_XS; local $SIG{HUP} = 'IGNORE'; @@ -263,13 +304,17 @@ sub import_results { local $FS::UID::AutoCommit = 0; my $dbh = dbh; - my $reself = $self->select_for_update; + if ( ref($self) ) { + # if called on a specific pay_batch, check the status of that batch + # before continuing + my $reself = $self->select_for_update; - if ( $reself->status ne 'I' - and !$conf->exists('batch-manual_approval') ) { - $dbh->rollback if $oldAutoCommit; - return "batchnum ". $self->batchnum. "no longer in transit"; - } + if ( $reself->status ne 'I' + and !$conf->exists('batch-manual_approval') ) { + $dbh->rollback if $oldAutoCommit; + return "batchnum ". $self->batchnum. "no longer in transit"; + } + } # otherwise we can't enforce this constraint. sorry. my $total = 0; my $line; @@ -315,6 +360,7 @@ sub import_results { push @all_values, \@values; } elsif ($filetype eq 'variable') { + # no longer used my @values = ( eval { $parse->($self, $line) } ); if( $@ ) { $dbh->rollback if $oldAutoCommit; @@ -374,6 +420,9 @@ sub import_results { unless ( $cust_pay_batch ) { return "unknown paybatchnum $hash{'paybatchnum'}\n"; } + # remember that we've touched this batch + $target_batches{ $cust_pay_batch->batchnum } = 1; + my $custnum = $cust_pay_batch->custnum, my $payby = $cust_pay_batch->payby, @@ -387,12 +436,12 @@ sub import_results { foreach ('paid', '_date', 'payinfo') { $new_cust_pay_batch->$_($hash{$_}) if $hash{$_}; } - $error = $new_cust_pay_batch->approve($hash{'paybatch'} || $self->batchnum); + $error = $new_cust_pay_batch->approve(%hash); $total += $hash{'paid'}; } elsif ( &{$declined_condition}(\%hash) ) { - $error = $new_cust_pay_batch->decline; + $error = $new_cust_pay_batch->decline($hash{'error_message'});; } @@ -413,40 +462,41 @@ sub import_results { } # foreach (@all_values) - my $close = 1; - if ( defined($close_condition) ) { - # Allow the module to decide whether to close the batch. - # $close_condition can also die() to abort the whole import. - $close = eval { $close_condition->($self) }; - if ( $@ ) { - $dbh->rollback; - die $@; - } - } - if ( $close ) { - my $error = $self->set_status('R'); - if ( $error ) { - $dbh->rollback if $oldAutoCommit; - return $error; - } - } + # decide whether to close batches that had payments posted + if ( !$param->{no_close} ) { + foreach my $batchnum (keys %target_batches) { + my $pay_batch = FS::pay_batch->by_key($batchnum); + my $close = 1; + if ( defined($close_condition) ) { + # Allow the module to decide whether to close the batch. + # $close_condition can also die() to abort the whole import. + $close = eval { $close_condition->($pay_batch) }; + if ( $@ ) { + $dbh->rollback; + die $@; + } + } + if ( $close ) { + my $error = $pay_batch->set_status('R'); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + } # foreach $batchnum + } # if (!$param->{no_close}) $dbh->commit or die $dbh->errstr if $oldAutoCommit; ''; } -use MIME::Base64; -use Storable 'thaw'; use Data::Dumper; sub process_import_results { my $job = shift; - my $param = thaw(decode_base64(shift)); + my $param = shift; $param->{'job'} = $job; warn Dumper($param) if $DEBUG; - my $batchnum = delete $param->{'batchnum'} or die "no batchnum specified\n"; - my $batch = FS::pay_batch->by_key($batchnum) or die "batchnum '$batchnum' not found\n"; - my $gatewaynum = delete $param->{'gatewaynum'}; if ( $gatewaynum ) { $param->{'gateway'} = FS::payment_gateway->by_key($gatewaynum) @@ -461,12 +511,20 @@ sub process_import_results { '<', "$dir/$file" ) or die "unable to open '$file'.\n"; - my $error = $batch->import_results($param); + + my $error; + if ( $param->{gateway} ) { + $error = FS::pay_batch->import_from_gateway(%$param); + } else { + my $batchnum = delete $param->{'batchnum'} or die "no batchnum specified\n"; + my $batch = FS::pay_batch->by_key($batchnum) or die "batchnum '$batchnum' not found\n"; + $error = $batch->import_results($param); + } unlink $file; die $error if $error; } -=item import_from_gateway GATEWAY [ OPTIONS ] +=item import_from_gateway [ OPTIONS ] Import results from a L, using Business::BatchPayment, and apply them. GATEWAY must use the Business::BatchPayment namespace. @@ -477,15 +535,16 @@ or declined payment can have its status changed by a later import. OPTIONS may include: -- file: a file name or handle to use as a data source. +- gateway: the L, required +- filehandle: a file name or handle to use as a data source. - job: an L object to update with progress messages. =cut sub import_from_gateway { my $class = shift; - my $gateway = shift; my %opt = @_; + my $gateway = $opt{'gateway'}; my $conf = FS::Conf->new; # unavoidable duplication with import_batch, for now @@ -508,121 +567,260 @@ sub import_from_gateway { unless eval { $gateway->isa('FS::payment_gateway') }; my %proc_opt = ( - 'input' => $opt{'file'}, # will do nothing if it's empty + 'input' => $opt{'filehandle'}, # will do nothing if it's empty # any other constructor options go here ); + my @item_errors; + my $errors_not_fatal = $conf->config('batch-errors_not_fatal'); + if ( $errors_not_fatal ) { + # construct error trap + $proc_opt{'on_parse_error'} = sub { + my ($self, $line, $error) = @_; + push @item_errors, " '$line'\n$error"; + }; + } + my $processor = $gateway->batch_processor(%proc_opt); - my @batches = $processor->receive; - my $error; + my @processor_ids = map { $_->processor_id } + qsearch({ + 'table' => 'pay_batch', + 'hashref' => { 'status' => 'I' }, + 'extra_sql' => q( AND processor_id != '' AND processor_id IS NOT NULL) + }); + + my @batches = $processor->receive(@processor_ids); + my $num = 0; + my $total_items = sum( map{$_->count} @batches); + # whether to allow items to change status my $reconsider = $conf->exists('batch-reconsider'); # mutex all affected batches my %pay_batch_for_update; + my %bop2payby = (CC => 'CARD', ECHECK => 'CHEK'); + BATCH: foreach my $batch (@batches) { + + my %incoming_batch = ( + 'CARD' => {}, + 'CHEK' => {}, + ); + ITEM: foreach my $item ($batch->elements) { - # cust_pay_batch.paybatchnum should be in the 'tid' attribute - my $paybatchnum = $item->tid; - my $cust_pay_batch = FS::cust_pay_batch->by_key($paybatchnum); - if (!$cust_pay_batch) { - # XXX for one-way batch protocol this needs to create new payments - $error = "unknown paybatchnum $paybatchnum"; - last ITEM; - } - my $batchnum = $cust_pay_batch->batchnum; - if ( $batch->batch_id and $batch->batch_id != $batchnum ) { - warn "batch ID ".$batch->batch_id. - " does not match batchnum ".$cust_pay_batch->batchnum."\n"; - } + my $cust_pay_batch; # the new batch entry (with status) + my $pay_batch; # the freeside batch it belongs to + my $payby; # CARD or CHEK + my $error; - # lock the batch and check its status - my $pay_batch = FS::pay_batch->by_key($batchnum); - $pay_batch_for_update{$batchnum} ||= $pay_batch->select_for_update; - if ( $pay_batch->status ne 'I' and !$reconsider ) { - $error = "batch $batchnum no longer in transit"; - last ITEM; - } + my $paybatch = $gateway->gatewaynum . '-' . $gateway->gateway_module . + ':' . ($item->authorization || '') . + ':' . ($item->order_number || ''); + + if ( $batch->incoming ) { + # This is a one-way batch. + # Locate the customer, find an open batch correct for them, + # create a payment. Don't bother creating a cust_pay_batch + # entry. + my $cust_main; + if ( defined($item->customer_id) + and $item->customer_id =~ /^\d+$/ + and $item->customer_id > 0 ) { + + $cust_main = FS::cust_main->by_key($item->customer_id) + || qsearchs('cust_main', + { 'agent_custid' => $item->customer_id } + ); + if ( !$cust_main ) { + push @item_errors, "Unknown customer_id ".$item->customer_id; + next ITEM; + } + } + else { + push @item_errors, "Illegal customer_id '".$item->customer_id."'"; + next ITEM; + } + # it may also make sense to allow selecting the customer by + # invoice_number, but no modules currently work that way + + $payby = $bop2payby{ $item->payment_type }; + my $agentnum = ''; + $agentnum = $cust_main->agentnum if $conf->exists('batch-spoolagent'); + + # create a batch if necessary + $pay_batch = $incoming_batch{$payby}->{$agentnum} ||= + FS::pay_batch->new({ + status => 'R', # pre-resolve it + payby => $payby, + agentnum => $agentnum, + upload => time, + title => $batch->batch_id, + }); + if ( !$pay_batch->batchnum ) { + $error = $pay_batch->insert; + die $error if $error; # can't do anything if this fails + } - if ( $cust_pay_batch->status ) { - my $new_status = $item->approved ? 'approved' : 'declined'; - if ( lc( $cust_pay_batch->status ) eq $new_status ) { - # already imported with this status, so don't touch + if ( !$item->approved ) { + $error ||= "payment rejected - ".$item->error_message; + } + if ( !defined($item->amount) or $item->amount <= 0 ) { + $error ||= "no amount in item $num"; + } + + my $payinfo; + if ( $item->check_number ) { + $payby = 'BILL'; # right? + $payinfo = $item->check_number; + } elsif ( $item->assigned_token ) { + $payinfo = $item->assigned_token; + } + # create the payment + my $cust_pay = FS::cust_pay->new( + { + custnum => $cust_main->custnum, + _date => $item->payment_date->epoch, + paid => sprintf('%.2f',$item->amount), + payby => $payby, + invnum => $item->invoice_number, + batchnum => $pay_batch->batchnum, + payinfo => $payinfo, + gatewaynum => $gateway->gatewaynum, + processor => $gateway->gateway_module, + auth => $item->authorization, + order_number => $item->order_number, + } + ); + $error ||= $cust_pay->insert; + eval { $cust_main->apply_payments }; + $error ||= $@; + + if ( $error ) { + push @item_errors, 'Payment for customer '.$item->customer_id."\n$error"; + } + + } else { + # This is a request/reply batch. + # Locate the request (the 'tid' attribute is the paybatchnum). + my $paybatchnum = $item->tid; + $cust_pay_batch = FS::cust_pay_batch->by_key($paybatchnum); + if (!$cust_pay_batch) { + push @item_errors, "paybatchnum $paybatchnum not found"; next ITEM; } - elsif ( !$reconsider ) { - # then we're not allowed to change its status, so bail out - $error = "paybatchnum ".$item->tid. + $payby = $cust_pay_batch->payby; + + my $batchnum = $cust_pay_batch->batchnum; + if ( $batch->batch_id and $batch->batch_id != $batchnum ) { + warn "batch ID ".$batch->batch_id. + " does not match batchnum ".$cust_pay_batch->batchnum."\n"; + } + + # lock the batch and check its status + $pay_batch = FS::pay_batch->by_key($batchnum); + $pay_batch_for_update{$batchnum} ||= $pay_batch->select_for_update; + if ( $pay_batch->status ne 'I' and !$reconsider ) { + $error = "batch $batchnum no longer in transit"; + } + + if ( $cust_pay_batch->status ) { + my $new_status = $item->approved ? 'approved' : 'declined'; + if ( lc( $cust_pay_batch->status ) eq $new_status ) { + # already imported with this status, so don't touch + next ITEM; + } + elsif ( !$reconsider ) { + # then we're not allowed to change its status, so bail out + $error = "paybatchnum ".$item->tid. " already resolved with status '". $cust_pay_batch->status . "'"; - last ITEM; + } } - } - # create a new cust_pay_batch with whatever information we got back - my $new_cust_pay_batch = new FS::cust_pay_batch { $cust_pay_batch->hash }; - my $new_payinfo; - # update payinfo, if needed - if ( $item->assigned_token ) { - $new_payinfo = $item->assigned_token; - } elsif ( $cust_pay_batch->payby eq 'CARD' ) { - $new_payinfo = $item->card_number if $item->card_number; - } else { #$cust_pay_batch->payby eq 'CHEK' - $new_payinfo = $item->account_number . '@' . $item->routing_code - if $item->account_number; - } - $new_cust_pay_batch->payinfo($new_payinfo) if $new_payinfo; + if ( $error ) { + push @item_errors, "Payment for customer ".$cust_pay_batch->custnum."\n$error"; + next ITEM; + } - # set "paid" pseudo-field (transfers to cust_pay) to the actual amount - # paid, if the batch says it's different from the amount requested - if ( defined $item->amount ) { - $new_cust_pay_batch->paid($item->amount); - } else { - $new_cust_pay_batch->paid($cust_pay_batch->amount); - } + my $new_payinfo; + # update payinfo, if needed + if ( $item->assigned_token ) { + $new_payinfo = $item->assigned_token; + } elsif ( $payby eq 'CARD' ) { + $new_payinfo = $item->card_number if $item->card_number; + } else { #$payby eq 'CHEK' + $new_payinfo = $item->account_number . '@' . $item->routing_code + if $item->account_number; + } + $cust_pay_batch->set('payinfo', $new_payinfo) if $new_payinfo; + + # set "paid" pseudo-field (transfers to cust_pay) to the actual amount + # paid, if the batch says it's different from the amount requested + if ( defined $item->amount ) { + $cust_pay_batch->set('paid', $item->amount); + } else { + $cust_pay_batch->set('paid', $cust_pay_batch->amount); + } + + # set payment date to when it was processed + $cust_pay_batch->_date($item->payment_date->epoch) + if $item->payment_date; + + # approval status + if ( $item->approved ) { + # follow Billing_Realtime format for paybatch + $error = $cust_pay_batch->approve( + 'gatewaynum' => $gateway->gatewaynum, + 'processor' => $gateway->gateway_module, + 'auth' => $item->authorization, + 'order_number' => $item->order_number, + ); + $total += $cust_pay_batch->paid; + } + else { + $error = $cust_pay_batch->decline($item->error_message, + $item->failure_status); + } + + if ( $error ) { + push @item_errors, "Payment for customer ".$cust_pay_batch->custnum."\n$error"; + next ITEM; + } + } # $batch->incoming - # set payment date to when it was processed - $new_cust_pay_batch->_date($item->payment_date->epoch) - if $item->payment_date; - - # approval status - if ( $item->approved ) { - # follow Billing_Realtime format for paybatch - my $paybatch = $gateway->gatewaynum . - '-' . - $gateway->gateway_module . - ':' . - $item->authorization . - ':' . - $item->order_number; - - $error = $new_cust_pay_batch->approve($paybatch); - $total += $new_cust_pay_batch->paid; - } - else { - $error = $new_cust_pay_batch->decline($item->error_message); - } - last ITEM if $error; $num++; - $job->update_statustext(int(100 * $num/( $batch->count + 1 ) ), + $job->update_statustext(int(100 * $num/( $total_items ) ), 'Importing batch items') - if $job; + if $job; + } #foreach $item - if ( $error ) { + } #foreach $batch (input batch, not pay_batch) + + # Format an error message + if ( @item_errors ) { + my $error_text = join("\n\n", + "Errors during batch import: ".scalar(@item_errors), + @item_errors + ); + if ( $errors_not_fatal ) { + my $message = "Import from gateway ".$gateway->label." errors: ".$error_text; + my $log = FS::Log->new('FS::pay_batch::import_from_gateway'); + $log->error($message); + } else { + # Bail out. $dbh->rollback if $oldAutoCommit; - return $error; + die $error_text; } + } - } #foreach $batch (input batch, not pay_batch) - - # Auto-resolve + # Auto-resolve (with brute-force error handling) foreach my $pay_batch (values %pay_batch_for_update) { - $error = $pay_batch->try_to_resolve; + my $error = $pay_batch->try_to_resolve; if ( $error ) { $dbh->rollback if $oldAutoCommit; @@ -637,7 +835,7 @@ sub import_from_gateway { =item try_to_resolve Resolve this batch if possible. A batch can be resolved if all of its -entries have a status. If the system options 'batch-auto_resolve_days' +entries have status. If the system options 'batch-auto_resolve_days' and 'batch-auto_resolve_status' are set, and the batch's download date is at least (batch-auto_resolve_days) before the current time, then it can be auto-resolved; entries with no status will be approved or declined @@ -658,8 +856,8 @@ sub try_to_resolve { } ); - if ( @unresolved ) { - my $days = $conf->config('batch-auto_resolve_days') || ''; + if ( @unresolved and $conf->exists('batch-auto_resolve_days') ) { + my $days = $conf->config('batch-auto_resolve_days'); # can be zero # either 'approve' or 'decline' my $action = $conf->config('batch-auto_resolve_status') || ''; return unless @@ -680,6 +878,9 @@ sub try_to_resolve { } return $error if $error; } + } elsif ( @unresolved ) { + # auto resolve is not enabled, and we're not ready to resolve + return; } $self->set_status('R'); @@ -693,7 +894,8 @@ Prepare the batch to be exported. This will: increment expiration dates that are in the past. - If this is the first download for this batch, adjust payment amounts to not be greater than the customer's current balance. If the customer's - balance is zero, the entry will be removed. + balance is zero, the entry will be removed (caution: all cust_pay_batch + entries might be removed!) Use this within a transaction. @@ -708,10 +910,11 @@ sub prepare_for_export { my $status = $self->status; if ($status eq 'O') { $first_download = 1; - my $error = $self->set_status('I'); - return "error updating pay_batch status: $error\n" if $error; } elsif ($status eq 'I' && $curuser->access_right('Reprocess batches')) { $first_download = 0; + } elsif ($status eq 'R' && + $curuser->access_right('Redownload resolved batches')) { + $first_download = 0; } else { die "No pending batch.\n"; } @@ -740,7 +943,7 @@ sub prepare_for_export { my $balance = $cust_pay_batch->cust_main->balance; if ($balance <= 0) { # then don't charge this customer - my $error = $cust_pay_batch->delete; + my $error = $cust_pay_batch->unbatch_and_delete; return $error if $error; } elsif ($balance < $cust_pay_batch->amount) { # reduce the charge to the remaining balance @@ -750,6 +953,11 @@ sub prepare_for_export { } # else $balance >= $cust_pay_batch->amount } + + #need to do this after unbatch_and_delete + my $error = $self->set_status('I'); + return "error updating pay_batch status: $error\n" if $error; + } #if $first_download ''; @@ -763,6 +971,10 @@ module, in which case the configuration options are in 'batchconfig-FORMAT'. Alternatively, GATEWAY can be an L object set to a L module. +Returns the text of the batch. If batch contains no cust_pay_batch entries +(or has them all removed by L) then the batch will be +resolved and a blank string will be returned. All other errors are fatal. + =cut sub export_batch { @@ -785,7 +997,7 @@ sub export_batch { my $info = $export_info{$format} or die "Format not found: '$format'\n"; - &{$info->{'init'}}($conf) if exists($info->{'init'}); + &{$info->{'init'}}($conf, $self->agentnum) if exists($info->{'init'}); my $oldAutoCommit = $FS::UID::AutoCommit; local $FS::UID::AutoCommit = 0; @@ -798,6 +1010,12 @@ sub export_batch { my $batchcount = 0; my @cust_pay_batch = $self->cust_pay_batch; + unless (@cust_pay_batch) { + # if it's empty, just resolve the batch + $self->set_status('R'); + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + return ''; + } my $delim = exists($info->{'delimiter'}) ? $info->{'delimiter'} : "\n"; @@ -842,6 +1060,10 @@ that gateway via Business::BatchPayment. OPTIONS may include: - file: override the default transport and write to this file (name or handle) +If batch contains no cust_pay_batch entries (or has them all removed by +L) then nothing will be transported (or written to +the override file) and the batch will be resolved. + =cut sub export_to_gateway { @@ -862,11 +1084,28 @@ sub export_to_gateway { my $processor = $gateway->batch_processor(%proc_opt); my @items = map { $_->request_item } $self->cust_pay_batch; - my $batch = Business::BatchPayment->create(Batch => - batch_id => $self->batchnum, - items => \@items - ); - $processor->submit($batch); + unless (@items) { + # if it's empty, just resolve the batch + $self->set_status('R'); + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + return ''; + } + + try { + my $batch = Business::BatchPayment->create(Batch => + batch_id => $self->batchnum, + items => \@items + ); + $processor->submit($batch); + + if ($batch->processor_id) { + $self->set('processor_id',$batch->processor_id); + $self->replace; + } + } catch { + $dbh->rollback if $oldAutoCommit; + die $_; + }; $dbh->commit or die $dbh->errstr if $oldAutoCommit; ''; @@ -876,7 +1115,6 @@ sub manual_approve { my $self = shift; my $date = time; my %opt = @_; - my $paybatch = $opt{'paybatch'} || $self->batchnum; my $usernum = $opt{'usernum'} || die "manual approval requires a usernum"; my $conf = FS::Conf->new; return 'manual batch approval disabled' @@ -906,7 +1144,9 @@ sub manual_approve { '_date' => $date, 'usernum' => $usernum, }; - my $error = $new_cust_pay_batch->approve($paybatch); + my $error = $new_cust_pay_batch->approve(); + # there are no approval options here (authorization, order_number, etc.) + # because the transaction wasn't really approved if ( $error ) { $dbh->rollback; return 'paybatchnum '.$cust_pay_batch->paybatchnum.": $error"; @@ -918,7 +1158,152 @@ sub manual_approve { return; } +=item batch_download_formats + +returns a hash of batch download formats. + +my %download_formats = FS::pay_batch::batch_download_formats; + +=cut + +sub batch_download_formats { + + my @formats = ( + '' => + 'Default batch mode', + 'NACHA' => + '94 byte NACHA', + 'csv-td_canada_trust-merchant_pc_batch' => + 'CSV file for TD Canada Trust Merchant PC Batch', + 'csv-chase_canada-E-xactBatch' => + 'CSV file for Chase Canada E-xactBatch', + 'PAP' => + '80 byte file for TD Canada Trust PAP Batch', + 'BoM' => + 'Bank of Montreal ECA batch', + 'ach-spiritone' => + 'Spiritone ACH batch', + 'paymentech' => + 'XML file for Chase Paymentech', + 'RBC' => + 'Royal Bank of Canada PDS batch', + 'td_eft1464' => + '1464 byte file for TD Commercial Banking EFT', + 'eft_canada' => + 'EFT Canada CSV batch', + 'CIBC' => + '80 byte file for Canadian Imperial Bank of Commerce', + # insert new batch formats here + ); + +} + +=item batch_download_formats + +returns a hash of batch download formats. + +my %download_formats = FS::pay_batch::batch_download_formats; + +=cut + +sub can_handle_electronic_refunds { + + my $self = shift; + my $format = shift; + my $conf = new FS::Conf; + + tie my %download_formats, 'Tie::IxHash', batch_download_formats; + + my %paybatch_mods = ( + 'NACHA' => 'nacha', + 'csv-td_canada_trust-merchant_pc_batch' => 'td_canada_trust', + 'csv-chase_canada-E-xactBatch' => 'chase-canada', + 'PAP' => 'PAP', + 'BoM' => 'BoM', + 'ach-spiritone' => 'ach_spiritone', + 'paymentech' => 'paymentech', + 'RBC' => 'RBC', + 'td_eft1464' => 'td_eft1464', + 'eft_canada' => 'eft_canada', + 'CIBC' => 'CIBC', + ); + + %download_formats = ( $format => $download_formats{$format}, ) if $format; + + foreach my $key (keys %download_formats) { + my $mod = "FS::pay_batch::".$paybatch_mods{$key}; + if ($mod->can('can_handle_credits')) { + return '1' if $conf->exists('batchconfig-'.$key); + } + } + + return; + +} + +use FS::upgrade_journal; sub _upgrade_data { + + # check if there are any pending batch refunds and no download format configured + # that allows electronic refunds. + unless ( FS::upgrade_journal->is_done('removed_refunds_nodownload_format') ) { + + ## get a list of all refunds in batches. + my $extrasql = " LEFT JOIN pay_batch USING ( batchnum ) WHERE cust_pay_batch.paycode = 'C' AND pay_batch.download IS NULL AND pay_batch.type = 'DEBIT' "; + + my @batch_refunds = qsearch({ + 'table' => 'cust_pay_batch', + 'select' => 'cust_pay_batch.*', + 'extra_sql' => $extrasql, + }); + + my $replace_error; + + if (@batch_refunds) { + warn "found ".scalar @batch_refunds." batch refunds.\n"; + warn "Searching for their cust refunds...\n" if (scalar @batch_refunds > 0); + + my $oldAutoCommit = $FS::UID::AutoCommit; + local $FS::UID::AutoCommit = 0; + my $dbh = dbh; + + ## move refund to credit batch. + foreach my $cust_pay_batch (@batch_refunds) { + my $payby = $cust_pay_batch->payby eq "CARD" ? "CARD" : "CHEK"; + + my %pay_batch = ( + 'status' => 'O', + 'payby' => $payby, + 'type' => 'CREDIT', + ); + + my $pay_batch = qsearchs( 'pay_batch', \%pay_batch ); + + unless ( $pay_batch ) { + $pay_batch = new FS::pay_batch \%pay_batch; + my $error = $pay_batch->insert; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + warn "error creating a $payby credit batch: $error\n"; + } + } + + $cust_pay_batch->batchnum($pay_batch->batchnum); + $replace_error = $cust_pay_batch->replace(); + if ( $replace_error ) { + $dbh->rollback if $oldAutoCommit; + warn "Unable to move credit to a credit batch: $replace_error"; + } + else { + warn "Moved cust pay credit ".$cust_pay_batch->paybatchnum." to ".$cust_pay_batch->payby." credit batch ".$cust_pay_batch->batchnum."\n"; + } + } + } #end @batch_refunds + else { warn "No batch refunds found\n"; } + + FS::upgrade_journal->set_done('removed_refunds_nodownload_format') unless $replace_error; + } + # Set up configuration for gateways that have a Business::BatchPayment # module. @@ -931,7 +1316,7 @@ sub _upgrade_data { for my $format (keys %export_info) { my $mod = "FS::pay_batch::$format"; if ( $mod->can('_upgrade_gateway') - and length( $conf->config("batchconfig-$format") ) ) { + and $conf->exists("batchconfig-$format") ) { local $@; my ($module, %gw_options) = $mod->_upgrade_gateway; @@ -960,7 +1345,7 @@ sub _upgrade_data { # and if appropriate, make it the system default for my $payby (qw(CARD CHEK)) { - if ( $conf->config("batch-fixed_format-$payby") eq $format ) { + if ( ($conf->config("batch-fixed_format-$payby") || '') eq $format ) { warn "Setting as default for $payby.\n"; $conf->set("batch-gateway-$payby", $gateway->gatewaynum); $conf->delete("batch-fixed_format-$payby");