summaryrefslogtreecommitdiff
path: root/FS/FS/pay_batch.pm
diff options
context:
space:
mode:
Diffstat (limited to 'FS/FS/pay_batch.pm')
-rw-r--r--FS/FS/pay_batch.pm589
1 files changed, 0 insertions, 589 deletions
diff --git a/FS/FS/pay_batch.pm b/FS/FS/pay_batch.pm
deleted file mode 100644
index 5cd40cd..0000000
--- a/FS/FS/pay_batch.pm
+++ /dev/null
@@ -1,589 +0,0 @@
-package FS::pay_batch;
-
-use strict;
-use vars qw( @ISA $DEBUG %import_info %export_info $conf );
-use Time::Local;
-use Text::CSV_XS;
-use FS::Record qw( dbh qsearch qsearchs );
-use FS::cust_pay;
-use FS::Conf;
-use Date::Parse qw(str2time);
-use Business::CreditCard qw(cardtype);
-
-@ISA = qw(FS::Record);
-
-=head1 NAME
-
-FS::pay_batch - Object methods for pay_batch records
-
-=head1 SYNOPSIS
-
- use FS::pay_batch;
-
- $record = new FS::pay_batch \%hash;
- $record = new FS::pay_batch { 'column' => 'value' };
-
- $error = $record->insert;
-
- $error = $new_record->replace($old_record);
-
- $error = $record->delete;
-
- $error = $record->check;
-
-=head1 DESCRIPTION
-
-An FS::pay_batch object represents an payment batch. FS::pay_batch inherits
-from FS::Record. The following fields are currently supported:
-
-=over 4
-
-=item batchnum - primary key
-
-=item payby - CARD or CHEK
-
-=item status - O (Open), I (In-transit), or R (Resolved)
-
-=item download -
-
-=item upload -
-
-
-=back
-
-=head1 METHODS
-
-=over 4
-
-=item new HASHREF
-
-Creates a new batch. To add the batch to the database, see L<"insert">.
-
-Note that this stores the hash reference, not a distinct copy of the hash it
-points to. You can ask the object for a copy with the I<hash> method.
-
-=cut
-
-# the new method can be inherited from FS::Record, if a table method is defined
-
-sub table { 'pay_batch'; }
-
-=item insert
-
-Adds this record to the database. If there is an error, returns the error,
-otherwise returns false.
-
-=cut
-
-# the insert method can be inherited from FS::Record
-
-=item delete
-
-Delete this record from the database.
-
-=cut
-
-# the delete method can be inherited from FS::Record
-
-=item replace OLD_RECORD
-
-Replaces the OLD_RECORD with this one in the database. If there is an error,
-returns the error, otherwise returns false.
-
-=cut
-
-# the replace method can be inherited from FS::Record
-
-=item check
-
-Checks all fields to make sure this is a valid batch. If there is
-an error, returns the error, otherwise returns false. Called by the insert
-and replace methods.
-
-=cut
-
-# the check method should currently be supplied - FS::Record contains some
-# data checking routines
-
-sub check {
- my $self = shift;
-
- my $error =
- $self->ut_numbern('batchnum')
- || $self->ut_enum('payby', [ 'CARD', 'CHEK' ])
- || $self->ut_enum('status', [ 'O', 'I', 'R' ])
- ;
- return $error if $error;
-
- $self->SUPER::check;
-}
-
-=item rebalance
-
-=cut
-
-sub rebalance {
- my $self = shift;
-}
-
-=item set_status
-
-=cut
-
-sub set_status {
- my $self = shift;
- $self->status(shift);
- $self->download(time)
- if $self->status eq 'I' && ! $self->download;
- $self->upload(time)
- if $self->status eq 'R' && ! $self->upload;
- $self->replace();
-}
-
-# further false laziness
-
-%import_info = %export_info = ();
-foreach my $INC (@INC) {
- warn "globbing $INC/FS/pay_batch/*.pm\n" if $DEBUG;
- foreach my $file ( glob("$INC/FS/pay_batch/*.pm")) {
- warn "attempting to load batch format from $file\n" if $DEBUG;
- $file =~ /\/(\w+)\.pm$/;
- next if !$1;
- my $mod = $1;
- my ($import, $export, $name) =
- eval "use FS::pay_batch::$mod;
- ( \\%FS::pay_batch::$mod\::import_info,
- \\%FS::pay_batch::$mod\::export_info,
- \$FS::pay_batch::$mod\::name)";
- $name ||= $mod; # in case it's not defined
- 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;
- }
- if(!keys(%$import)) {
- warn "no \%import_info found in FS::pay_batch::$mod (skipping)\n";
- }
- else {
- $import_info{$name} = $import;
- }
- if(!keys(%$export)) {
- warn "no \%export_info found in FS::pay_batch::$mod (skipping)\n";
- }
- else {
- $export_info{$name} = $export;
- }
- }
-}
-
-=item import_results OPTION => VALUE, ...
-
-Import batch results.
-
-Options are:
-
-I<filehandle> - open filehandle of results file.
-
-I<format> - "csv-td_canada_trust-merchant_pc_batch", "csv-chase_canada-E-xactBatch", "ach-spiritone", or "PAP"
-
-=cut
-
-sub import_results {
- my $self = shift;
-
- my $param = ref($_[0]) ? shift : { @_ };
- my $fh = $param->{'filehandle'};
- my $format = $param->{'format'};
- my $info = $import_info{$format}
- or die "unknown format $format";
-
- my $job = $param->{'job'};
- $job->update_statustext(0) if $job;
-
- my $conf = new FS::Conf;
-
- my $filetype = $info->{'filetype'}; # CSV, fixed, variable
- my @fields = @{ $info->{'fields'}};
- my $formatre = $info->{'formatre'}; # for fixed
- my $parse = $info->{'parse'}; # for variable
- my @all_values;
- my $begin_condition = $info->{'begin_condition'};
- my $end_condition = $info->{'end_condition'};
- my $end_hook = $info->{'end_hook'};
- my $skip_condition = $info->{'skip_condition'};
- my $hook = $info->{'hook'};
- my $approved_condition = $info->{'approved'};
- my $declined_condition = $info->{'declined'};
- my $close_condition = $info->{'close_condition'};
-
- my $csv = new Text::CSV_XS;
-
- 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 $oldAutoCommit = $FS::UID::AutoCommit;
- local $FS::UID::AutoCommit = 0;
- my $dbh = dbh;
-
- my $reself = $self->select_for_update;
-
- unless ( $reself->status eq 'I' ) {
- $dbh->rollback if $oldAutoCommit;
- return "batchnum ". $self->batchnum. "no longer in transit";
- }
-
- my $error = $self->set_status('R');
- if ( $error ) {
- $dbh->rollback if $oldAutoCommit;
- return $error;
- }
-
- my $total = 0;
- my $line;
-
- # Order of operations has been changed here.
- # We now slurp everything into @all_values, then
- # process one line at a time.
-
- if ($filetype eq 'XML') {
- eval "use XML::Simple";
- die $@ if $@;
- my @xmlkeys = @{ $info->{'xmlkeys'} }; # for XML
- my $xmlrow = $info->{'xmlrow'}; # also for XML
-
- # Do everything differently.
- my $data = XML::Simple::XMLin($fh, KeepRoot => 1);
- my $rows = $data;
- # $xmlrow = [ RootKey, FirstLevelKey, SecondLevelKey... ]
- $rows = $rows->{$_} foreach( @$xmlrow );
- if(!defined($rows)) {
- $dbh->rollback if $oldAutoCommit;
- return "can't find rows in XML file";
- }
- $rows = [ $rows ] if ref($rows) ne 'ARRAY';
- foreach my $row (@$rows) {
- push @all_values, [ @{$row}{@xmlkeys}, $row ];
- }
- }
- else {
- while ( defined($line=<$fh>) ) {
-
- next if $line =~ /^\s*$/; #skip blank lines
-
- if ($filetype eq "CSV") {
- $csv->parse($line) or do {
- $dbh->rollback if $oldAutoCommit;
- return "can't parse: ". $csv->error_input();
- };
- push @all_values, [ $csv->fields(), $line ];
- }elsif ($filetype eq 'fixed'){
- my @values = ( $line =~ /$formatre/ );
- unless (@values) {
- $dbh->rollback if $oldAutoCommit;
- return "can't parse: ". $line;
- };
- push @values, $line;
- push @all_values, \@values;
- }
- elsif ($filetype eq 'variable') {
- my @values = ( eval { $parse->($self, $line) } );
- if( $@ ) {
- $dbh->rollback if $oldAutoCommit;
- return $@;
- };
- push @values, $line;
- push @all_values, \@values;
- }
- else {
- $dbh->rollback if $oldAutoCommit;
- return "Unknown file type $filetype";
- }
- }
- }
-
- my $num = 0;
- foreach (@all_values) {
- if($job) {
- $num++;
- $job->update_statustext(int(100 * $num/scalar(@all_values)));
- }
- my @values = @$_;
-
- my %hash;
- my $line = pop @values;
- foreach my $field ( @fields ) {
- my $value = shift @values;
- next unless $field;
- $hash{$field} = $value;
- }
-
- if ( defined($begin_condition) ) {
- if ( &{$begin_condition}(\%hash, $line) ) {
- undef $begin_condition;
- }
- else {
- next;
- }
- }
-
- if ( defined($end_condition) and &{$end_condition}(\%hash, $line) ) {
- my $error;
- $error = &{$end_hook}(\%hash, $total, $line) if defined($end_hook);
- if ( $error ) {
- $dbh->rollback if $oldAutoCommit;
- return $error;
- }
- last;
- }
-
- if ( defined($skip_condition) and &{$skip_condition}(\%hash, $line) ) {
- next;
- }
-
- my $cust_pay_batch =
- qsearchs('cust_pay_batch', { 'paybatchnum' => $hash{'paybatchnum'}+0 } );
- unless ( $cust_pay_batch ) {
- return "unknown paybatchnum $hash{'paybatchnum'}\n";
- }
- my $custnum = $cust_pay_batch->custnum,
- my $payby = $cust_pay_batch->payby,
-
- my $new_cust_pay_batch = new FS::cust_pay_batch { $cust_pay_batch->hash };
-
- &{$hook}(\%hash, $cust_pay_batch->hashref);
-
- my $error = '';
- if ( &{$approved_condition}(\%hash) ) {
-
- $error = $new_cust_pay_batch->approve($hash{'paybatch'} || $self->batchnum);
- $total += $hash{'paid'};
-
- } elsif ( &{$declined_condition}(\%hash) ) {
-
- $error = $new_cust_pay_batch->decline;
-
- }
-
- if ( $error ) {
- $dbh->rollback if $oldAutoCommit;
- return $error;
- }
-
- # purge CVV when the batch is processed
- if ( $payby =~ /^(CARD|DCRD)$/ ) {
- my $payinfo = $hash{'payinfo'} || $cust_pay_batch->payinfo;
- if ( ! grep { $_ eq cardtype($payinfo) }
- $conf->config('cvv-save') ) {
- $new_cust_pay_batch->cust_main->remove_cvv;
- }
-
- }
-
- } # foreach (@all_values)
-
- if ( defined($close_condition) ) {
- # Allow the module to decide whether to close the batch.
- # $close_condition can also die() to abort the whole import.
- my $close = eval { $close_condition->($self) };
- if ( $@ ) {
- $dbh->rollback;
- die $@;
- }
- $self->set_status('I') if !$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));
- $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 $file = $param->{'uploaded_files'} or die "no files provided\n";
- $file =~ s/^(\w+):([\.\w]+)$/$2/;
- my $dir = '%%%FREESIDE_CACHE%%%/cache.' . $FS::UID::datasrc;
- open( $param->{'filehandle'},
- '<',
- "$dir/$file" )
- or die "unable to open '$file'.\n";
- my $error = $batch->import_results($param);
- unlink $file;
- die $error if $error;
-}
-
-# Formerly httemplate/misc/download-batch.cgi
-sub export_batch {
- my $self = shift;
- my $conf = new FS::Conf;
- my $format = shift || $conf->config('batch-default_format')
- or die "No batch format configured\n";
- my $info = $export_info{$format} or die "Format not found: '$format'\n";
- &{$info->{'init'}}($conf) if exists($info->{'init'});
-
- my $curuser = $FS::CurrentUser::CurrentUser;
-
- my $oldAutoCommit = $FS::UID::AutoCommit;
- local $FS::UID::AutoCommit = 0;
- my $dbh = dbh;
-
- my $first_download;
- my $status = $self->status;
- if ($status eq 'O') {
- $first_download = 1;
- my $error = $self->set_status('I');
- die "error updating pay_batch status: $error\n" if $error;
- } elsif ($status eq 'I' && $curuser->access_right('Reprocess batches')) {
- $first_download = 0;
- } else {
- die "No pending batch.\n";
- }
-
- my $batch = '';
- my $batchtotal = 0;
- my $batchcount = 0;
-
- my @cust_pay_batch = sort { $a->paybatchnum <=> $b->paybatchnum }
- qsearch('cust_pay_batch', { batchnum => $self->batchnum } );
-
- # handle batch-increment_expiration option
- if ( $self->payby eq 'CARD' ) {
- my ($cmon, $cyear) = (localtime(time))[4,5];
- foreach (@cust_pay_batch) {
- my $etime = str2time($_->exp) or next;
- my ($day, $mon, $year) = (localtime($etime))[3,4,5];
- if( $conf->exists('batch-increment_expiration') ) {
- $year++ while( $year < $cyear or ($year == $cyear and $mon <= $cmon) );
- $_->exp( sprintf('%4u-%02u-%02u', $year + 1900, $mon+1, $day) );
- }
- $_->setfield('expmmyy', sprintf('%02u%02u', $mon+1, $year % 100));
- }
- }
- my $h = $info->{'header'};
- if(ref($h) eq 'CODE') {
- $batch .= &$h($self, \@cust_pay_batch) . "\n";
- }
- else {
- $batch .= $h . "\n";
- }
- foreach my $cust_pay_batch (@cust_pay_batch) {
-
- if ($first_download) {
- my $balance = $cust_pay_batch->cust_main->balance;
- if ($balance <= 0) { # then don't charge this customer
- my $error = $cust_pay_batch->delete;
- if ( $error ) {
- $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
- die $error;
- }
- next;
- } elsif ($balance < $cust_pay_batch->amount) {
- # reduce the charge to the remaining balance
- $cust_pay_batch->amount($balance);
- my $error = $cust_pay_batch->replace;
- if ( $error ) {
- $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
- die $error;
- }
- }
- # else $balance >= $cust_pay_batch->amount
- }
-
- $batchcount++;
- $batchtotal += $cust_pay_batch->amount;
- $batch .= &{$info->{'row'}}($cust_pay_batch, $self, $batchcount, $batchtotal) . "\n";
-
- }
-
- my $f = $info->{'footer'};
- if(ref($f) eq 'CODE') {
- $batch .= &$f($self, $batchcount, $batchtotal) . "\n";
- }
- else {
- $batch .= $f . "\n";
- }
-
- if ($info->{'autopost'}) {
- my $error = &{$info->{'autopost'}}($self, $batch);
- if($error) {
- $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
- die $error;
- }
- }
-
- $dbh->commit or die $dbh->errstr if $oldAutoCommit;
- return $batch;
-}
-
-sub manual_approve {
- my $self = shift;
- my $date = time;
- my %opt = @_;
- my $paybatch = $opt{'paybatch'} || $self->batchnum;
- my $conf = FS::Conf->new;
- return 'manual batch approval disabled'
- if ( ! $conf->exists('batch-manual_approval') );
- return 'batch already resolved' if $self->status eq 'R';
- return 'batch not yet submitted' if $self->status eq 'O';
-
- 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 $oldAutoCommit = $FS::UID::AutoCommit;
- local $FS::UID::AutoCommit = 0;
- my $dbh = dbh;
-
- my $payments = 0;
- foreach my $cust_pay_batch (
- qsearch('cust_pay_batch', { batchnum => $self->batchnum,
- status => '' })
- ) {
- my $new_cust_pay_batch = new FS::cust_pay_batch {
- $cust_pay_batch->hash,
- 'paid' => $cust_pay_batch->amount,
- '_date' => $date,
- };
- my $error = $new_cust_pay_batch->approve($paybatch);
- if ( $error ) {
- $dbh->rollback;
- return 'paybatchnum '.$cust_pay_batch->paybatchnum.": $error";
- }
- $payments++;
- }
- return 'no unresolved payments in batch' if $payments == 0;
- $self->set_status('R');
-
- $dbh->commit;
- return;
-}
-
-=back
-
-=head1 BUGS
-
-status is somewhat redundant now that download and upload exist
-
-=head1 SEE ALSO
-
-L<FS::Record>, schema.html from the base documentation.
-
-=cut
-
-1;
-
generated by cgit v1.1 at 2024-05-24 02:15:42 +0000