adjust EFT Canada processing delay based on time of day, and warn the user, #20384
[freeside.git] / FS / FS / pay_batch / eft_canada.pm
1 package FS::pay_batch::eft_canada;
2
3 use strict;
4 use vars qw(@ISA %import_info %export_info $name);
5 use FS::Record 'qsearch';
6 use FS::Conf;
7 use FS::cust_pay_batch;
8 use Date::Format 'time2str';
9 use Time::Local 'timelocal';
10
11 my $conf;
12 my $origid;
13
14 $name = 'eft_canada';
15
16 %import_info = ( filetype  => 'NONE' ); # see FS/bin/freeside-eftca-download
17
18 my ($trans_code, $process_date);
19
20 #ref http://gocanada.about.com/od/canadatravelplanner/a/canada_holidays.htm
21 my %holiday_yearly = (
22    1 => { map {$_=>1}  1 }, #new year's
23   11 => { map {$_=>1} 11 }, #remembrance day
24   12 => { map {$_=>1} 25 }, #christmas
25   12 => { map {$_=>1} 26 }, #boxing day
26 );
27 my %holiday = (
28   2013 => {  2 => { map {$_=>1} 18 }, #family day
29              3 => { map {$_=>1} 29 }, #good friday
30              4 => { map {$_=>1}  1 }, #easter monday
31              5 => { map {$_=>1} 20 }, #victoria day
32              7 => { map {$_=>1}  1 }, #canada day
33              8 => { map {$_=>1}  5 }, #First Monday of August Civic Holiday
34              9 => { map {$_=>1}  2 }, #labour day
35             10 => { map {$_=>1} 14 }, #thanksgiving
36           },
37   2014 => {  2 => { map {$_=>1} 17 }, #family day
38              4 => { map {$_=>1} 18 }, #good friday
39              4 => { map {$_=>1} 21 }, #easter monday
40              5 => { map {$_=>1} 19 }, #victoria day
41              7 => { map {$_=>1}  1 }, #canada day
42              8 => { map {$_=>1}  4 }, #First Monday of August Civic Holiday
43              9 => { map {$_=>1}  1 }, #labour day
44             10 => { map {$_=>1} 13 }, #thanksgiving
45           },
46   2015 => {  2 => { map {$_=>1} 16 }, #family day
47              4 => { map {$_=>1}  3 }, #good friday
48              4 => { map {$_=>1}  6 }, #easter monday
49              5 => { map {$_=>1} 18 }, #victoria day
50              7 => { map {$_=>1}  1 }, #canada day
51              8 => { map {$_=>1}  3 }, #First Monday of August Civic Holiday
52              9 => { map {$_=>1}  7 }, #labour day
53             10 => { map {$_=>1} 12 }, #thanksgiving
54           },
55 );
56
57 %export_info = (
58
59   init => sub {
60     my $conf = shift;
61     my $agentnum = shift;
62     my @config;
63     if ( $conf->exists('batch-spoolagent') ) {
64       @config = $conf->config('batchconfig-eft_canada', $agentnum);
65     } else {
66       @config = $conf->config('batchconfig-eft_canada');
67     }
68     # SFTP login, password, trans code, delay time
69     ($trans_code) = $config[2];
70
71     $process_date = time2str('%D', process_date($conf, $agentnum));
72   },
73
74   delimiter => '', # avoid blank lines for header/footer
75
76   # EFT Upload Specification for .CSV Files, Rev. 2.0
77   # not a true CSV format--strings aren't quoted, so be careful
78   row => sub {
79     my ($cust_pay_batch, $pay_batch) = @_;
80     my @fields;
81     # company + empty or first + last
82     my $company = sprintf('%.64s', $cust_pay_batch->cust_main->company);
83     if ( $company ) {
84       push @fields, $company, ''
85     }
86     else {
87       push @fields, map { sprintf('%.64s', $_) } 
88         $cust_pay_batch->first, $cust_pay_batch->last;
89     }
90     my ($account, $aba) = split('@', $cust_pay_batch->payinfo);
91     my($bankno, $branch);
92     if ( $aba =~ /^0(\d{3})(\d{5})$/ ) { # standard format for Canadian bank ID
93       ($bankno, $branch) = ( $1, $2 );
94     } elsif ( $aba =~ /^(\d{5})\.(\d{3})$/ ) { #how we store branches
95       ($branch, $bankno) = ( $1, $2 );
96     } else {
97       die "invalid branch/routing number '$aba'\n";
98     }
99     push @fields, sprintf('%05s', $branch),
100                   sprintf('%03s', $bankno),
101                   $account,
102                   sprintf('%.02f', $cust_pay_batch->amount);
103     # DB = debit
104     push @fields, 'DB', $trans_code, $process_date;
105     push @fields, $cust_pay_batch->paybatchnum; # reference
106     # strip illegal characters that might occur in customer name
107     s/[,|']//g foreach @fields; # better substitution for these?
108     return join(',', @fields) . "\n";
109   },
110
111 );
112
113 sub download_note { # is a class method
114   my $class = shift;
115   my $pay_batch = shift;
116   my $conf = FS::Conf->new;
117   my $agentnum = $pay_batch->agentnum;
118   my $tomorrow = (localtime(time))[2] >= 10;
119   my $upload_date = time;
120   $upload_date += 86400 if $tomorrow;
121   my $process_date = process_date($conf, $agentnum);
122   my $date_format = $conf->config('date_format') || '%D';
123
124   'Upload this file before 11:00 AM '.
125     ($tomorrow ? 'tomorrow' : 'today') .
126     ' (' . time2str($date_format, $upload_date) . '). '.
127     'Payments will be processed on '.
128     time2str($date_format, $process_date) . '.';
129 }
130
131 sub process_date {
132   my ($conf, $agentnum) = @_;
133   my @config;
134   if ( $conf->exists('batch-spoolagent') ) {
135     @config = $conf->config('batchconfig-eft_canada', $agentnum);
136   } else {
137     @config = $conf->config('batchconfig-eft_canada');
138   }
139
140   my $process_delay = $config[3] || 1;
141
142   if ( (localtime(time))[2] >= 10 ) {
143     # If downloading the batch after 10:00 local time, it likely won't make
144     # the cutoff for next-day turnaround, and EFT will reject it.
145     $process_delay++;
146   }
147
148   my $pt = time + ($process_delay * 86400);
149   my @lt = localtime($pt);
150   while (    $lt[6] == 0 #Sunday
151           || $lt[6] == 6 #Saturday
152           || $holiday_yearly{ $lt[4]+1 }{ $lt[3] }
153           || $holiday{ $lt[5]+1900 }{ $lt[4]+1 }{ $lt[3] }
154         )
155   {
156     $pt += 86400;
157     @lt = localtime($pt);
158   }
159
160   $pt;
161 }
162
163 1;