1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
|
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::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);
=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 agentnum - optional agent number for agent batches
=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' ])
|| $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum')
;
return $error if $error;
$self->SUPER::check;
}
=item agent
Returns the L<FS::agent> object for this batch.
=cut
sub agent {
qsearchs('agent', { 'agentnum' => $_[0]->agentnum });
}
=item cust_pay_batch
Returns all L<FS::cust_pay_batch> objects for this batch.
=cut
sub cust_pay_batch {
qsearch('cust_pay_batch', { 'batchnum' => $_[0]->batchnum });
}
=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> - an L<FS::pay_batch> module
I<gateway> - an L<FS::payment_gateway> object for a batch gateway. This
takes precedence over I<format>.
=cut
sub import_results {
my $self = shift;
my $param = ref($_[0]) ? shift : { @_ };
my $fh = $param->{'filehandle'};
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";
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;
if ( $reself->status ne 'I'
and !$conf->exists('batch-manual_approval') ) {
$dbh->rollback if $oldAutoCommit;
return "batchnum ". $self->batchnum. "no longer in transit";
}
my $total = 0;
my $line;
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,
&{$hook}(\%hash, $cust_pay_batch->hashref);
my $new_cust_pay_batch = new FS::cust_pay_batch { $cust_pay_batch->hash };
my $error = '';
if ( &{$approved_condition}(\%hash) ) {
foreach ('paid', '_date', 'payinfo') {
$new_cust_pay_batch->$_($hash{$_}) if $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)
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;
}
}
$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 $gatewaynum = delete $param->{'gatewaynum'};
if ( $gatewaynum ) {
$param->{'gateway'} = FS::payment_gateway->by_key($gatewaynum)
or die "gatewaynum '$gatewaynum' not found\n";
delete $param->{'format'}; # to avoid confusion
}
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;
}
=item import_from_gateway GATEWAY [ OPTIONS ]
Import results from a L<FS::payment_gateway>, using Business::BatchPayment,
and apply them. GATEWAY must use the Business::BatchPayment namespace.
This is a class method, since results can be applied to any batch.
The 'batch-reconsider' option determines whether an already-approved
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.
- job: an L<FS::queue> object to update with progress messages.
=cut
sub import_from_gateway {
my $class = shift;
my $gateway = shift;
my %opt = @_;
my $conf = FS::Conf->new;
# unavoidable duplication with import_batch, for now
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 $job = delete($opt{'job'});
$job->update_statustext(0) if $job;
my $total = 0;
return "import_from_gateway requires a payment_gateway"
unless eval { $gateway->isa('FS::payment_gateway') };
my %proc_opt = (
'input' => $opt{'file'}, # will do nothing if it's empty
# any other constructor options go here
);
my $processor = $gateway->batch_processor(%proc_opt);
my @batches = $processor->receive;
my $error;
my $num = 0;
# whether to allow items to change status
my $reconsider = $conf->exists('batch-reconsider');
# mutex all affected batches
my %pay_batch_for_update;
BATCH: foreach my $batch (@batches) {
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";
}
# 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;
}
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;
# 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);
}
# 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 ) ),
'Importing batch items')
if $job;
} #foreach $item
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
} #foreach $batch (input batch, not pay_batch)
# Auto-resolve
foreach my $pay_batch (values %pay_batch_for_update) {
$error = $pay_batch->try_to_resolve;
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
}
$dbh->commit if $oldAutoCommit;
return;
}
=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'
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
according to the batch-auto_resolve_status setting.
=cut
sub try_to_resolve {
my $self = shift;
my $conf = FS::Conf->new;;
return if $self->status ne 'I';
my @unresolved = qsearch('cust_pay_batch',
{
batchnum => $self->batchnum,
status => ''
}
);
if ( @unresolved ) {
my $days = $conf->config('batch-auto_resolve_days') || '';
# either 'approve' or 'decline'
my $action = $conf->config('batch-auto_resolve_status') || '';
return unless
length($days) and
length($action) and
time > ($self->download + 86400 * $days)
;
my $error;
foreach my $cpb (@unresolved) {
if ( $action eq 'approve' ) {
# approve it for the full amount
$cpb->set('paid', $cpb->amount) unless ($cpb->paid || 0) > 0;
$error = $cpb->approve($self->batchnum);
}
elsif ( $action eq 'decline' ) {
$error = $cpb->decline('No response from processor');
}
return $error if $error;
}
}
$self->set_status('R');
}
=item prepare_for_export
Prepare the batch to be exported. This will:
- Set the status to "in transit".
- If batch-increment_expiration is set and this is a credit card batch,
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.
Use this within a transaction.
=cut
sub prepare_for_export {
my $self = shift;
my $conf = FS::Conf->new;
my $curuser = $FS::CurrentUser::CurrentUser;
my $first_download;
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;
} else {
die "No pending batch.\n";
}
my @cust_pay_batch = sort { $a->paybatchnum <=> $b->paybatchnum }
$self->cust_pay_batch;
# 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) );
}
my $error = $_->replace;
return $error if $error;
}
}
if ($first_download) { #remove or reduce entries if customer's balance changed
foreach my $cust_pay_batch (@cust_pay_batch) {
my $balance = $cust_pay_batch->cust_main->balance;
if ($balance <= 0) { # then don't charge this customer
my $error = $cust_pay_batch->delete;
return $error if $error;
} elsif ($balance < $cust_pay_batch->amount) {
# reduce the charge to the remaining balance
$cust_pay_batch->amount($balance);
my $error = $cust_pay_batch->replace;
return $error if $error;
}
# else $balance >= $cust_pay_batch->amount
}
} #if $first_download
'';
}
=item export_batch [ format => FORMAT | gateway => GATEWAY ]
Export batch for processing. FORMAT is the name of an L<FS::pay_batch>
module, in which case the configuration options are in 'batchconfig-FORMAT'.
Alternatively, GATEWAY can be an L<FS::payment_gateway> object set to a
L<Business::BatchPayment> module.
=cut
sub export_batch {
my $self = shift;
my %opt = @_;
my $conf = new FS::Conf;
my $batch;
my $gateway = $opt{'gateway'};
if ( $gateway ) {
# welcome to the future
my $fh = IO::Scalar->new(\$batch);
$self->export_to_gateway($gateway, 'file' => $fh);
return $batch;
}
my $format = $opt{'format'} || $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 $oldAutoCommit = $FS::UID::AutoCommit;
local $FS::UID::AutoCommit = 0;
my $dbh = dbh;
my $error = $self->prepare_for_export;
die $error if $error;
my $batchtotal = 0;
my $batchcount = 0;
my @cust_pay_batch = $self->cust_pay_batch;
my $delim = exists($info->{'delimiter'}) ? $info->{'delimiter'} : "\n";
my $h = $info->{'header'};
if (ref($h) eq 'CODE') {
$batch .= &$h($self, \@cust_pay_batch). $delim;
} else {
$batch .= $h. $delim;
}
foreach my $cust_pay_batch (@cust_pay_batch) {
$batchcount++;
$batchtotal += $cust_pay_batch->amount;
$batch .=
&{$info->{'row'}}($cust_pay_batch, $self, $batchcount, $batchtotal).
$delim;
}
my $f = $info->{'footer'};
if (ref($f) eq 'CODE') {
$batch .= &$f($self, $batchcount, $batchtotal). $delim;
} else {
$batch .= $f. $delim;
}
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;
}
=item export_to_gateway GATEWAY OPTIONS
Given L<FS::payment_gateway> GATEWAY, export the items in this batch to
that gateway via Business::BatchPayment. OPTIONS may include:
- file: override the default transport and write to this file (name or handle)
=cut
sub export_to_gateway {
my ($self, $gateway, %opt) = @_;
my $oldAutoCommit = $FS::UID::AutoCommit;
local $FS::UID::AutoCommit = 0;
my $dbh = dbh;
my $error = $self->prepare_for_export;
die $error if $error;
my %proc_opt = (
'output' => $opt{'file'}, # will do nothing if it's empty
# any other constructor options go here
);
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);
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
'';
}
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'
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,
'usernum' => $usernum,
};
my $error = $new_cust_pay_batch->approve($paybatch);
if ( $error ) {
$dbh->rollback;
return 'paybatchnum '.$cust_pay_batch->paybatchnum.": $error";
}
$payments++;
}
$self->set_status('R');
$dbh->commit;
return;
}
sub _upgrade_data {
# Set up configuration for gateways that have a Business::BatchPayment
# module.
eval "use Class::MOP;";
if ( $@ ) {
warn "Moose/Class::MOP not available.\n$@\nSkipping pay_batch upgrade.\n";
return;
}
my $conf = FS::Conf->new;
for my $format (keys %export_info) {
my $mod = "FS::pay_batch::$format";
if ( $mod->can('_upgrade_gateway')
and length( $conf->config("batchconfig-$format") ) ) {
local $@;
my ($module, %gw_options) = $mod->_upgrade_gateway;
my $gateway = FS::payment_gateway->new({
gateway_namespace => 'Business::BatchPayment',
gateway_module => $module,
});
my $error = $gateway->insert(%gw_options);
if ( $error ) {
warn "Failed to migrate '$format' to a Business::BatchPayment::$module gateway:\n$error\n";
next;
}
# test whether it loads
my $processor = eval { $gateway->batch_processor };
if ( !$processor ) {
warn "Couldn't load Business::BatchPayment module for '$format'.\n";
# if not, remove it so it doesn't hang around and break things
$gateway->delete;
}
else {
# remove the batchconfig-*
warn "Created Business::BatchPayment gateway '".$gateway->label.
"' for '$format' batch processing.\n";
$conf->delete("batchconfig-$format");
# and if appropriate, make it the system default
for my $payby (qw(CARD CHEK)) {
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");
}
}
} # if $processor
} #if can('_upgrade_gateway') and batchconfig-$format
} #for $format
'';
}
=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;
|