4 use vars qw( @ISA $DEBUG %import_info %export_info $conf );
7 use FS::Record qw( dbh qsearch qsearchs );
10 use Date::Parse qw(str2time);
11 use Business::CreditCard qw(cardtype);
13 @ISA = qw(FS::Record);
17 FS::pay_batch - Object methods for pay_batch records
23 $record = new FS::pay_batch \%hash;
24 $record = new FS::pay_batch { 'column' => 'value' };
26 $error = $record->insert;
28 $error = $new_record->replace($old_record);
30 $error = $record->delete;
32 $error = $record->check;
36 An FS::pay_batch object represents an payment batch. FS::pay_batch inherits
37 from FS::Record. The following fields are currently supported:
41 =item batchnum - primary key
43 =item payby - CARD or CHEK
45 =item status - O (Open), I (In-transit), or R (Resolved)
60 Creates a new batch. To add the batch to the database, see L<"insert">.
62 Note that this stores the hash reference, not a distinct copy of the hash it
63 points to. You can ask the object for a copy with the I<hash> method.
67 # the new method can be inherited from FS::Record, if a table method is defined
69 sub table { 'pay_batch'; }
73 Adds this record to the database. If there is an error, returns the error,
74 otherwise returns false.
78 # the insert method can be inherited from FS::Record
82 Delete this record from the database.
86 # the delete method can be inherited from FS::Record
88 =item replace OLD_RECORD
90 Replaces the OLD_RECORD with this one in the database. If there is an error,
91 returns the error, otherwise returns false.
95 # the replace method can be inherited from FS::Record
99 Checks all fields to make sure this is a valid batch. If there is
100 an error, returns the error, otherwise returns false. Called by the insert
105 # the check method should currently be supplied - FS::Record contains some
106 # data checking routines
112 $self->ut_numbern('batchnum')
113 || $self->ut_enum('payby', [ 'CARD', 'CHEK' ])
114 || $self->ut_enum('status', [ 'O', 'I', 'R' ])
116 return $error if $error;
135 $self->status(shift);
136 $self->download(time)
137 if $self->status eq 'I' && ! $self->download;
139 if $self->status eq 'R' && ! $self->upload;
143 # further false laziness
145 %import_info = %export_info = ();
146 foreach my $INC (@INC) {
147 warn "globbing $INC/FS/pay_batch/*.pm\n" if $DEBUG;
148 foreach my $file ( glob("$INC/FS/pay_batch/*.pm")) {
149 warn "attempting to load batch format from $file\n" if $DEBUG;
150 $file =~ /\/(\w+)\.pm$/;
153 my ($import, $export, $name) =
154 eval "use FS::pay_batch::$mod;
155 ( \\%FS::pay_batch::$mod\::import_info,
156 \\%FS::pay_batch::$mod\::export_info,
157 \$FS::pay_batch::$mod\::name)";
158 $name ||= $mod; # in case it's not defined
160 # in FS::cdr this is a die, not a warn. That's probably a bug.
161 warn "error using FS::pay_batch::$mod (skipping): $@\n";
164 if(!keys(%$import)) {
165 warn "no \%import_info found in FS::pay_batch::$mod (skipping)\n";
168 $import_info{$name} = $import;
170 if(!keys(%$export)) {
171 warn "no \%export_info found in FS::pay_batch::$mod (skipping)\n";
174 $export_info{$name} = $export;
179 =item import_results OPTION => VALUE, ...
181 Import batch results.
185 I<filehandle> - open filehandle of results file.
187 I<format> - "csv-td_canada_trust-merchant_pc_batch", "csv-chase_canada-E-xactBatch", "ach-spiritone", or "PAP"
194 my $param = ref($_[0]) ? shift : { @_ };
195 my $fh = $param->{'filehandle'};
196 my $format = $param->{'format'};
197 my $info = $import_info{$format}
198 or die "unknown format $format";
200 my $job = $param->{'job'};
201 $job->update_statustext(0) if $job;
203 my $conf = new FS::Conf;
205 my $filetype = $info->{'filetype'}; # CSV, fixed, variable
206 my @fields = @{ $info->{'fields'}};
207 my $formatre = $info->{'formatre'}; # for fixed
208 my $parse = $info->{'parse'}; # for variable
210 my $begin_condition = $info->{'begin_condition'};
211 my $end_condition = $info->{'end_condition'};
212 my $end_hook = $info->{'end_hook'};
213 my $skip_condition = $info->{'skip_condition'};
214 my $hook = $info->{'hook'};
215 my $approved_condition = $info->{'approved'};
216 my $declined_condition = $info->{'declined'};
217 my $close_condition = $info->{'close_condition'};
219 my $csv = new Text::CSV_XS;
221 local $SIG{HUP} = 'IGNORE';
222 local $SIG{INT} = 'IGNORE';
223 local $SIG{QUIT} = 'IGNORE';
224 local $SIG{TERM} = 'IGNORE';
225 local $SIG{TSTP} = 'IGNORE';
226 local $SIG{PIPE} = 'IGNORE';
228 my $oldAutoCommit = $FS::UID::AutoCommit;
229 local $FS::UID::AutoCommit = 0;
232 my $reself = $self->select_for_update;
234 unless ( $reself->status eq 'I' ) {
235 $dbh->rollback if $oldAutoCommit;
236 return "batchnum ". $self->batchnum. "no longer in transit";
239 my $error = $self->set_status('R');
241 $dbh->rollback if $oldAutoCommit;
248 # Order of operations has been changed here.
249 # We now slurp everything into @all_values, then
250 # process one line at a time.
252 if ($filetype eq 'XML') {
253 eval "use XML::Simple";
255 my @xmlkeys = @{ $info->{'xmlkeys'} }; # for XML
256 my $xmlrow = $info->{'xmlrow'}; # also for XML
258 # Do everything differently.
259 my $data = XML::Simple::XMLin($fh, KeepRoot => 1);
261 # $xmlrow = [ RootKey, FirstLevelKey, SecondLevelKey... ]
262 $rows = $rows->{$_} foreach( @$xmlrow );
263 if(!defined($rows)) {
264 $dbh->rollback if $oldAutoCommit;
265 return "can't find rows in XML file";
267 $rows = [ $rows ] if ref($rows) ne 'ARRAY';
268 foreach my $row (@$rows) {
269 push @all_values, [ @{$row}{@xmlkeys}, $row ];
273 while ( defined($line=<$fh>) ) {
275 next if $line =~ /^\s*$/; #skip blank lines
277 if ($filetype eq "CSV") {
278 $csv->parse($line) or do {
279 $dbh->rollback if $oldAutoCommit;
280 return "can't parse: ". $csv->error_input();
282 push @all_values, [ $csv->fields(), $line ];
283 }elsif ($filetype eq 'fixed'){
284 my @values = ( $line =~ /$formatre/ );
286 $dbh->rollback if $oldAutoCommit;
287 return "can't parse: ". $line;
290 push @all_values, \@values;
292 elsif ($filetype eq 'variable') {
293 my @values = ( eval { $parse->($self, $line) } );
295 $dbh->rollback if $oldAutoCommit;
299 push @all_values, \@values;
302 $dbh->rollback if $oldAutoCommit;
303 return "Unknown file type $filetype";
309 foreach (@all_values) {
312 $job->update_statustext(int(100 * $num/scalar(@all_values)));
317 my $line = pop @values;
318 foreach my $field ( @fields ) {
319 my $value = shift @values;
321 $hash{$field} = $value;
324 if ( defined($begin_condition) ) {
325 if ( &{$begin_condition}(\%hash, $line) ) {
326 undef $begin_condition;
333 if ( defined($end_condition) and &{$end_condition}(\%hash, $line) ) {
335 $error = &{$end_hook}(\%hash, $total, $line) if defined($end_hook);
337 $dbh->rollback if $oldAutoCommit;
343 if ( defined($skip_condition) and &{$skip_condition}(\%hash, $line) ) {
348 qsearchs('cust_pay_batch', { 'paybatchnum' => $hash{'paybatchnum'}+0 } );
349 unless ( $cust_pay_batch ) {
350 return "unknown paybatchnum $hash{'paybatchnum'}\n";
352 my $custnum = $cust_pay_batch->custnum,
353 my $payby = $cust_pay_batch->payby,
355 &{$hook}(\%hash, $cust_pay_batch->hashref);
357 my $new_cust_pay_batch = new FS::cust_pay_batch {
358 $cust_pay_batch->hash,
363 if ( &{$approved_condition}(\%hash) ) {
365 $error = $new_cust_pay_batch->approve($hash{'paybatch'} || $self->batchnum);
366 $total += $hash{'paid'};
368 } elsif ( &{$declined_condition}(\%hash) ) {
370 $error = $new_cust_pay_batch->decline;
375 $dbh->rollback if $oldAutoCommit;
379 # purge CVV when the batch is processed
380 if ( $payby =~ /^(CARD|DCRD)$/ ) {
381 my $payinfo = $hash{'payinfo'} || $cust_pay_batch->payinfo;
382 if ( ! grep { $_ eq cardtype($payinfo) }
383 $conf->config('cvv-save') ) {
384 $new_cust_pay_batch->cust_main->remove_cvv;
389 } # foreach (@all_values)
391 if ( defined($close_condition) ) {
392 # Allow the module to decide whether to close the batch.
393 # $close_condition can also die() to abort the whole import.
394 my $close = eval { $close_condition->($self) };
399 $self->set_status('I') if !$close;
402 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
410 sub process_import_results {
412 my $param = thaw(decode_base64(shift));
413 $param->{'job'} = $job;
414 warn Dumper($param) if $DEBUG;
415 my $batchnum = delete $param->{'batchnum'} or die "no batchnum specified\n";
416 my $batch = FS::pay_batch->by_key($batchnum) or die "batchnum '$batchnum' not found\n";
418 my $file = $param->{'uploaded_files'} or die "no files provided\n";
419 $file =~ s/^(\w+):([\.\w]+)$/$2/;
420 my $dir = '%%%FREESIDE_CACHE%%%/cache.' . $FS::UID::datasrc;
421 open( $param->{'filehandle'},
424 or die "unable to open '$file'.\n";
425 my $error = $batch->import_results($param);
427 die $error if $error;
430 # Formerly httemplate/misc/download-batch.cgi
433 my $conf = new FS::Conf;
434 my $format = shift || $conf->config('batch-default_format')
435 or die "No batch format configured\n";
436 my $info = $export_info{$format} or die "Format not found: '$format'\n";
437 &{$info->{'init'}}($conf) if exists($info->{'init'});
439 my $curuser = $FS::CurrentUser::CurrentUser;
441 my $oldAutoCommit = $FS::UID::AutoCommit;
442 local $FS::UID::AutoCommit = 0;
446 my $status = $self->status;
447 if ($status eq 'O') {
449 my $error = $self->set_status('I');
450 die "error updating pay_batch status: $error\n" if $error;
451 } elsif ($status eq 'I' && $curuser->access_right('Reprocess batches')) {
454 die "No pending batch.\n";
461 my @cust_pay_batch = sort { $a->paybatchnum <=> $b->paybatchnum }
462 qsearch('cust_pay_batch', { batchnum => $self->batchnum } );
464 # handle batch-increment_expiration option
465 if ( $self->payby eq 'CARD' ) {
466 my ($cmon, $cyear) = (localtime(time))[4,5];
467 foreach (@cust_pay_batch) {
468 my $etime = str2time($_->exp) or next;
469 my ($day, $mon, $year) = (localtime($etime))[3,4,5];
470 if( $conf->exists('batch-increment_expiration') ) {
471 $year++ while( $year < $cyear or ($year == $cyear and $mon <= $cmon) );
472 $_->exp( sprintf('%4u-%02u-%02u', $year + 1900, $mon+1, $day) );
474 $_->setfield('expmmyy', sprintf('%02u%02u', $mon+1, $year % 100));
478 my $delim = exists($info->{'delimiter'}) ? $info->{'delimiter'} : "\n";
480 my $h = $info->{'header'};
481 if(ref($h) eq 'CODE') {
482 $batch .= &$h($self, \@cust_pay_batch) . $delim;
485 $batch .= $h . $delim;
487 foreach my $cust_pay_batch (@cust_pay_batch) {
489 if ($first_download) {
490 my $balance = $cust_pay_batch->cust_main->balance;
491 if ($balance <= 0) { # then don't charge this customer
492 my $error = $cust_pay_batch->delete;
494 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
498 } elsif ($balance < $cust_pay_batch->amount) {
499 # reduce the charge to the remaining balance
500 $cust_pay_batch->amount($balance);
501 my $error = $cust_pay_batch->replace;
503 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
507 # else $balance >= $cust_pay_batch->amount
511 $batchtotal += $cust_pay_batch->amount;
512 $batch .= &{$info->{'row'}}($cust_pay_batch, $self, $batchcount, $batchtotal) . $delim;
516 my $f = $info->{'footer'};
517 if(ref($f) eq 'CODE') {
518 $batch .= &$f($self, $batchcount, $batchtotal) . $delim;
521 $batch .= $f . $delim;
524 if ($info->{'autopost'}) {
525 my $error = &{$info->{'autopost'}}($self, $batch);
527 $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
532 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
540 my $paybatch = $opt{'paybatch'} || $self->batchnum;
541 my $conf = FS::Conf->new;
542 return 'manual batch approval disabled'
543 if ( ! $conf->exists('batch-manual_approval') );
544 return 'batch already resolved' if $self->status eq 'R';
545 return 'batch not yet submitted' if $self->status eq 'O';
547 local $SIG{HUP} = 'IGNORE';
548 local $SIG{INT} = 'IGNORE';
549 local $SIG{QUIT} = 'IGNORE';
550 local $SIG{TERM} = 'IGNORE';
551 local $SIG{TSTP} = 'IGNORE';
552 local $SIG{PIPE} = 'IGNORE';
554 my $oldAutoCommit = $FS::UID::AutoCommit;
555 local $FS::UID::AutoCommit = 0;
559 foreach my $cust_pay_batch (
560 qsearch('cust_pay_batch', { batchnum => $self->batchnum,
563 my $new_cust_pay_batch = new FS::cust_pay_batch {
564 $cust_pay_batch->hash,
565 'paid' => $cust_pay_batch->amount,
568 my $error = $new_cust_pay_batch->approve($paybatch);
571 return 'paybatchnum '.$cust_pay_batch->paybatchnum.": $error";
575 return 'no unresolved payments in batch' if $payments == 0;
576 $self->set_status('R');
586 status is somewhat redundant now that download and upload exist
590 L<FS::Record>, schema.html from the base documentation.