b29408b0e174b04a7313bf4c407dbbc650b84e78
[freeside.git] / FS / FS / cust_main / Billing_Realtime.pm
1 package FS::cust_main::Billing_Realtime;
2
3 use strict;
4 use vars qw( $conf $DEBUG $me );
5 use vars qw( $realtime_bop_decline_quiet ); #ugh
6 use Carp;
7 use Data::Dumper;
8 use Business::CreditCard 0.35;
9 use Business::OnlinePayment;
10 use FS::UID qw( dbh myconnect );
11 use FS::Record qw( qsearch qsearchs );
12 use FS::payby;
13 use FS::cust_pay;
14 use FS::cust_pay_pending;
15 use FS::cust_bill_pay;
16 use FS::cust_refund;
17 use FS::banned_pay;
18 use FS::payment_gateway;
19 use FS::Misc::Savepoint;
20
21 $realtime_bop_decline_quiet = 0;
22
23 # 1 is mostly method/subroutine entry and options
24 # 2 traces progress of some operations
25 # 3 is even more information including possibly sensitive data
26 $DEBUG = 0;
27 $me = '[FS::cust_main::Billing_Realtime]';
28
29 our $BOP_TESTING = 0;
30 our $BOP_TESTING_SUCCESS = 1;
31 our $BOP_TESTING_TIMESTAMP = '';
32
33 install_callback FS::UID sub { 
34   $conf = new FS::Conf;
35   #yes, need it for stuff below (prolly should be cached)
36 };
37
38 =head1 NAME
39
40 FS::cust_main::Billing_Realtime - Realtime billing mixin for cust_main
41
42 =head1 SYNOPSIS
43
44 =head1 DESCRIPTION
45
46 These methods are available on FS::cust_main objects.
47
48 =head1 METHODS
49
50 =over 4
51
52 =item realtime_cust_payby
53
54 =cut
55
56 sub realtime_cust_payby {
57   my( $self, %options ) = @_;
58
59   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
60
61   $options{amount} = $self->balance unless exists( $options{amount} );
62
63   my @cust_payby = $self->cust_payby('CARD','CHEK');
64                                                    
65   my $error;
66   foreach my $cust_payby (@cust_payby) {
67     $error = $cust_payby->realtime_bop( %options, );
68     last unless $error;
69   }
70
71   #XXX what about the earlier errors?
72
73   $error;
74
75 }
76
77 =item realtime_collect [ OPTION => VALUE ... ]
78
79 Attempt to collect the customer's current balance with a realtime credit 
80 card or electronic check transaction (see realtime_bop() below).
81
82 Returns the result of realtime_bop(): nothing, an error message, or a 
83 hashref of state information for a third-party transaction.
84
85 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
86
87 I<method> is one of: I<CC> or I<ECHECK>.  If none is specified
88 then it is deduced from the customer record.
89
90 If no I<amount> is specified, then the customer balance is used.
91
92 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
93 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
94 if set, will override the value from the customer record.
95
96 I<description> is a free-text field passed to the gateway.  It defaults to
97 the value defined by the business-onlinepayment-description configuration
98 option, or "Internet services" if that is unset.
99
100 If an I<invnum> is specified, this payment (if successful) is applied to the
101 specified invoice.
102
103 I<apply> will automatically apply a resulting payment.
104
105 I<quiet> can be set true to suppress email decline notices.
106
107 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
108 resulting paynum, if any.
109
110 I<payunique> is a unique identifier for this payment.
111
112 I<session_id> is a session identifier associated with this payment.
113
114 I<depend_jobnum> allows payment capture to unlock export jobs
115
116 =cut
117
118 # Currently only used by ClientAPI
119 sub realtime_collect {
120   my( $self, %options ) = @_;
121
122   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
123
124   if ( $DEBUG ) {
125     warn "$me realtime_collect:\n";
126     warn "  $_ => $options{$_}\n" foreach keys %options;
127   }
128
129   $options{amount} = $self->balance unless exists( $options{amount} );
130   return '' unless $options{amount} > 0;
131
132   #huh, in v4, realtime_bop no longer will just process a card without passing
133   # payinfo or cust_payby...
134   if ( ! $options{'payinfo'} && ! $options{'cust_payby'} && $self->has_cust_payby_auto ) {
135     my @cust_payby = $self->cust_payby;
136     $options{'cust_payby'} = $cust_payby[0];
137   }
138
139   return $self->realtime_bop({%options});
140
141 }
142
143 =item realtime_bop { [ ARG => VALUE ... ] }
144
145 Runs a realtime credit card or ACH (electronic check) transaction
146 via a Business::OnlinePayment realtime gateway.  See
147 L<http://420.am/business-onlinepayment> for supported gateways.
148
149 Required arguments in the hashref are I<amount> and either
150 I<cust_payby> or I<method>, I<payinfo> and (as applicable for method)
151 I<payname>, I<address1>, I<address2>, I<city>, I<state>, I<zip> and I<paydate>.
152
153 Available methods are: I<CC>, I<ECHECK>, or I<PAYPAL>
154
155 Available optional arguments are: I<description>, I<invnum>, I<apply>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
156
157 I<description> is a free-text field passed to the gateway.  It defaults to
158 the value defined by the business-onlinepayment-description configuration
159 option, or "Internet services" if that is unset.
160
161 If an I<invnum> is specified, this payment (if successful) is applied to the
162 specified invoice.  If the customer has exactly one open invoice, that 
163 invoice number will be assumed.  If you don't specify an I<invnum> you might 
164 want to call the B<apply_payments> method or set the I<apply> option.
165
166 I<no_invnum> can be set to true to prevent that default invnum from being set.
167
168 I<apply> can be set to true to run B<apply_payments_and_credits> on success.
169
170 I<no_auto_apply> can be set to true to set that flag on the resulting payment
171 (prevents payment from being applied by B<apply_payments> or B<apply_payments_and_credits>,
172 but will still be applied if I<invnum> exists...use with I<no_invnum> for intended effect.)
173
174 I<quiet> can be set true to surpress email decline notices.
175
176 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
177 resulting paynum, if any.
178
179 I<payunique> is a unique identifier for this payment.
180
181 I<session_id> is a session identifier associated with this payment.
182
183 I<depend_jobnum> allows payment capture to unlock export jobs
184
185 I<discount_term> attempts to take a discount by prepaying for discount_term.
186 The payment will fail if I<amount> is incorrect for this discount term.
187
188 A direct (Business::OnlinePayment) transaction will return nothing on success,
189 or an error message on failure.
190
191 A third-party transaction will return a hashref containing:
192
193 - popup_url: the URL to which a browser should be redirected to complete 
194   the transaction.
195 - collectitems: an arrayref of name-value pairs to be posted to popup_url.
196 - reference: a reference ID for the transaction, to show the customer.
197
198 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
199
200 =cut
201
202 # some helper routines
203 #
204 # _bop_recurring_billing: Checks whether this payment should have the 
205 # recurring_billing flag used by some B:OP interfaces (IPPay, PlugnPay,
206 # vSecure, etc.). This works in two different modes:
207 # - actual_oncard (default): treat the payment as recurring if the customer
208 #   has made a payment using this card before.
209 # - transaction_is_recur: treat the payment as recurring if the invoice
210 #   being paid has any recurring package charges.
211
212 sub _bop_recurring_billing {
213   my( $self, %opt ) = @_;
214
215   my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
216
217   if ( defined($method) && $method eq 'transaction_is_recur' ) {
218
219     return 1 if $opt{'trans_is_recur'};
220
221   } else {
222
223     # return 1 if the payinfo has been used for another payment
224     return $self->payinfo_used($opt{'payinfo'}); # in payinfo_Mixin
225
226   }
227
228   return 0;
229
230 }
231
232 #can run safely as class method if opt payment_gateway already exists
233 sub _payment_gateway {
234   my ($self, $options) = @_;
235
236   if ( $options->{'fake_gatewaynum'} ) {
237         $options->{payment_gateway} =
238             qsearchs('payment_gateway',
239                       { 'gatewaynum' => $options->{'fake_gatewaynum'}, }
240                     );
241   }
242
243   $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
244     unless exists($options->{payment_gateway});
245
246   $options->{payment_gateway};
247 }
248
249 # not a method!!!
250 sub _bop_auth {
251   my ($options) = @_;
252
253   (
254     'login'    => $options->{payment_gateway}->gateway_username,
255     'password' => $options->{payment_gateway}->gateway_password,
256   );
257 }
258
259 ### not a method!
260 sub _bop_options {
261   my ($options) = @_;
262
263   $options->{payment_gateway}->gatewaynum
264     ? $options->{payment_gateway}->options
265     : @{ $options->{payment_gateway}->get('options') };
266
267 }
268
269 sub _bop_defaults {
270   my ($self, $options) = @_;
271
272   unless ( $options->{'description'} ) {
273     if ( $conf->exists('business-onlinepayment-description') ) {
274       my $dtempl = $conf->config('business-onlinepayment-description');
275
276       my $agent = $self->agent->agent;
277       #$pkgs... not here
278       $options->{'description'} = eval qq("$dtempl");
279     } else {
280       $options->{'description'} = 'Internet services';
281     }
282   }
283
284   # Default invoice number if the customer has exactly one open invoice.
285   unless ( $options->{'invnum'} || $options->{'no_invnum'} ) {
286     $options->{'invnum'} = '';
287     my @open = $self->open_cust_bill;
288     $options->{'invnum'} = $open[0]->invnum if scalar(@open) == 1;
289   }
290
291 }
292
293 # not a method!
294 sub _bop_cust_payby_options {
295   my ($options) = @_;
296   my $cust_payby = $options->{'cust_payby'};
297   if ($cust_payby) {
298
299     $options->{'method'} = FS::payby->payby2bop( $cust_payby->payby );
300
301     if ($cust_payby->payby =~ /^(CARD|DCRD)$/) {
302       # false laziness with cust_payby->check
303       #   which might not have been run yet
304       my( $m, $y );
305       if ( $cust_payby->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
306         ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
307       } elsif ( $cust_payby->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
308         ( $m, $y ) = ( $2, "19$1" );
309       } elsif ( $cust_payby->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
310         ( $m, $y ) = ( $3, "20$2" );
311       } else {
312         return "Illegal expiration date: ". $cust_payby->paydate;
313       }
314       $m = sprintf('%02d',$m);
315       $options->{paydate} = "$y-$m-01";
316     } else {
317       $options->{paydate} = '';
318     }
319
320     $options->{$_} = $cust_payby->$_() 
321       for qw( payinfo paycvv paymask paystart_month paystart_year 
322               payissue payname paystate paytype payip );
323
324     if ( $cust_payby->locationnum ) {
325       my $cust_location = $cust_payby->cust_location;
326       $options->{$_} = $cust_location->$_() for qw( address1 address2 city state zip );
327     }
328   }
329 }
330
331 # can be called as class method,
332 # but can't load default name/phone fields as class method
333 sub _bop_content {
334   my ($self, $options) = @_;
335   my %content = ();
336
337   my $payip = $options->{'payip'};
338   $content{customer_ip} = $payip if length($payip);
339
340   $content{invoice_number} = $options->{'invnum'}
341     if exists($options->{'invnum'}) && length($options->{'invnum'});
342
343   $content{email_customer} = 
344     (    $conf->exists('business-onlinepayment-email_customer')
345       || $conf->exists('business-onlinepayment-email-override') );
346       
347   my ($payname, $payfirst, $paylast);
348   if ( $options->{payname} && $options->{method} ne 'ECHECK' ) {
349     ($payname = $options->{payname}) =~
350       /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
351       or return "Illegal payname $payname";
352     ($payfirst, $paylast) = ($1, $2);
353   } elsif (ref($self)) { # can't set payname if called as class method
354     $payfirst = $self->getfield('first');
355     $paylast = $self->getfield('last');
356     $payname = "$payfirst $paylast";
357   }
358
359   $content{last_name} = $paylast if $paylast;
360   $content{first_name} = $payfirst if $payfirst;
361
362   $content{name} = $payname if $payname;
363
364   $content{address} = $options->{'address1'};
365   my $address2 = $options->{'address2'};
366   $content{address} .= ", ". $address2 if length($address2);
367
368   $content{city} = $options->{'city'};
369   $content{state} = $options->{'state'};
370   $content{zip} = $options->{'zip'};
371   $content{country} = $options->{'country'};
372
373   # can't set phone if called as class method
374   $content{phone} = $self->daytime || $self->night
375     if ref($self);
376
377   my $currency =    $conf->exists('business-onlinepayment-currency')
378                  && $conf->config('business-onlinepayment-currency');
379   $content{currency} = $currency if $currency;
380
381   \%content;
382 }
383
384 # updates payinfo and cust_payby options with token from transaction
385 # can be called as a class method
386 sub _tokenize_card {
387   my ($self,$transaction,$options) = @_;
388   if ( $transaction->can('card_token') 
389        and $transaction->card_token 
390        and !$self->tokenized($options->{'payinfo'})
391   ) {
392     $options->{'payinfo'} = $transaction->card_token;
393     $options->{'cust_payby'}->payinfo($transaction->card_token) if $options->{'cust_payby'};
394     return $transaction->card_token;
395   }
396   return '';
397 }
398
399 my %bop_method2payby = (
400   'CC'     => 'CARD',
401   'ECHECK' => 'CHEK',
402   'PAYPAL' => 'PPAL',
403 );
404
405 sub realtime_bop {
406   my $self = shift;
407
408   confess "Can't call realtime_bop within another transaction ".
409           '($FS::UID::AutoCommit is false)'
410     unless $FS::UID::AutoCommit || $BOP_TESTING;
411
412   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
413
414   my $log = FS::Log->new('FS::cust_main::Billing_Realtime::realtime_bop');
415  
416   my %options = ();
417   if (ref($_[0]) eq 'HASH') {
418     %options = %{$_[0]};
419   } else {
420     my ( $method, $amount ) = ( shift, shift );
421     %options = @_;
422     $options{method} = $method;
423     $options{amount} = $amount;
424   }
425
426   return '' unless $options{amount} > 0;
427
428   # set fields from passed cust_payby
429   _bop_cust_payby_options(\%options);
430
431   # check for banned credit card/ACH
432   my $ban = FS::banned_pay->ban_search(
433     'payby'   => $bop_method2payby{$options{method}},
434     'payinfo' => $options{payinfo},
435   );
436   return "Banned credit card" if $ban && $ban->bantype ne 'warn';
437
438   # possibly run a separate transaction to tokenize card number,
439   #   so that we never store tokenized card info in cust_pay_pending
440   if (($options{method} eq 'CC') && !$self->tokenized($options{'payinfo'})) {
441     my $token_error = $self->realtime_tokenize(\%options);
442     return $token_error if $token_error;
443     # in theory, all cust_payby will be tokenized during original save,
444     # so we shouldn't get here with opt cust_payby...but just in case...
445     if ($options{'cust_payby'} && $self->tokenized($options{'payinfo'})) {
446       $token_error = $options{'cust_payby'}->replace;
447       return $token_error if $token_error;
448     }
449   }
450
451   ### 
452   # optional credit card surcharge
453   ###
454
455   my $cc_surcharge = 0;
456   my $cc_surcharge_pct = 0;
457   $cc_surcharge_pct = $conf->config('credit-card-surcharge-percentage', $self->agentnum) 
458     if $conf->config('credit-card-surcharge-percentage', $self->agentnum)
459     && $options{method} eq 'CC';
460
461   my $cc_surcharge_flat = 0;
462   $cc_surcharge_flat = $conf->config('credit-card-surcharge-flatfee', $self->agentnum)
463     if $conf->config('credit-card-surcharge-flatfee', $self->agentnum)
464     && $options{method} eq 'CC';
465
466   # always add cc surcharge if called from event 
467   if($options{'cc_surcharge_from_event'} && ($cc_surcharge_pct > 0 || $cc_surcharge_flat > 0)) {
468     if ($options{'amount'} > 0) {
469       $cc_surcharge = ($options{'amount'} * ($cc_surcharge_pct / 100)) + $cc_surcharge_flat;
470       $options{'amount'} += $cc_surcharge;
471       $options{'amount'} = sprintf("%.2f", $options{'amount'}); # round (again)?
472     }
473   }
474   elsif($cc_surcharge_pct > 0 || $cc_surcharge_flat > 0) {
475     # we're called not from event (i.e. from a
476     # payment screen), so consider the given
477                 # amount as post-surcharge-processing_fee
478     $cc_surcharge = $options{'amount'} - $options{'processing-fee'} - (($options{'amount'} - ($cc_surcharge_flat + $options{'processing-fee'})) / ( 1 + $cc_surcharge_pct/100 )) if $options{'amount'} > 0;
479   }
480   
481   $cc_surcharge = sprintf("%.2f",$cc_surcharge) if $cc_surcharge > 0;
482   $options{'cc_surcharge'} = $cc_surcharge;
483
484
485   if ( $DEBUG ) {
486     warn "$me realtime_bop (new): $options{method} $options{amount}\n";
487     warn " cc_surcharge = $cc_surcharge\n";
488   }
489   if ( $DEBUG > 2 ) {
490     warn "  $_ => $options{$_}\n" foreach keys %options;
491   }
492
493   return $self->fake_bop(\%options) if $options{'fake'};
494
495   $self->_bop_defaults(\%options);
496
497   return "Missing payinfo"
498     unless $options{'payinfo'};
499
500   ###
501   # set trans_is_recur based on invnum if there is one
502   ###
503
504   my $trans_is_recur = 0;
505   if ( $options{'invnum'} ) {
506
507     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
508     die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
509
510     my @part_pkg =
511       map  { $_->part_pkg }
512       grep { $_ }
513       map  { $_->cust_pkg }
514       $cust_bill->cust_bill_pkg;
515
516     $trans_is_recur = 1
517       if grep { $_->freq ne '0' } @part_pkg;
518
519   }
520
521   ###
522   # select a gateway
523   ###
524
525   my $payment_gateway =  $self->_payment_gateway( \%options );
526   my $namespace = $payment_gateway->gateway_namespace;
527
528   eval "use $namespace";  
529   die $@ if $@;
530
531   ###
532   # check for term discount validity
533   ###
534
535   my $discount_term = $options{discount_term};
536   if ( $discount_term ) {
537     my $bill = ($self->cust_bill)[-1]
538       or return "Can't apply a term discount to an unbilled customer";
539     my $plan = FS::discount_plan->new(
540       cust_bill => $bill,
541       months    => $discount_term
542     ) or return "No discount available for term '$discount_term'";
543     
544     if ( $plan->discounted_total != $options{amount} ) {
545       return "Incorrect term prepayment amount (term $discount_term, amount $options{amount}, requires ".$plan->discounted_total.")";
546     }
547   }
548
549   ###
550   # massage data
551   ###
552
553   my $bop_content = $self->_bop_content(\%options);
554   return $bop_content unless ref($bop_content);
555
556   my @invoicing_list = $self->invoicing_list_emailonly;
557   if ( $conf->exists('emailinvoiceautoalways')
558        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
559        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
560     push @invoicing_list, $self->all_emails;
561   }
562
563   my $email = ($conf->exists('business-onlinepayment-email-override'))
564               ? $conf->config('business-onlinepayment-email-override')
565               : $invoicing_list[0];
566
567   my $paydate = '';
568   my %content = ();
569
570   if ( $namespace eq 'Business::OnlinePayment' ) {
571
572     if ( $options{method} eq 'CC' ) {
573
574       $content{card_number} = $options{payinfo};
575       $paydate = $options{'paydate'};
576       $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
577       $content{expiration} = "$2/$1";
578
579       $content{cvv2} = $options{'paycvv'}
580         if length($options{'paycvv'});
581
582       my $paystart_month = $options{'paystart_month'};
583       my $paystart_year  = $options{'paystart_year'};
584       $content{card_start} = "$paystart_month/$paystart_year"
585         if $paystart_month && $paystart_year;
586
587       my $payissue       = $options{'payissue'};
588       $content{issue_number} = $payissue if $payissue;
589
590       if ( $self->_bop_recurring_billing(
591              'payinfo'        => $options{'payinfo'},
592              'trans_is_recur' => $trans_is_recur,
593            )
594          )
595       {
596         $content{recurring_billing} = 'YES';
597         $content{acct_code} = 'rebill'
598           if $conf->exists('credit_card-recurring_billing_acct_code');
599       }
600
601     } elsif ( $options{method} eq 'ECHECK' ){
602
603       ( $content{account_number}, $content{routing_code} ) =
604         split('@', $options{payinfo});
605       $content{bank_name} = $options{payname};
606       $content{bank_state} = $options{'paystate'};
607       $content{account_type}= uc($options{'paytype'}) || 'PERSONAL CHECKING';
608
609       $content{company} = $self->company if $self->company;
610
611       if ( $content{account_type} =~ /BUSINESS/i && $self->company ) {
612         $content{account_name} = $self->company;
613       } else {
614         $content{account_name} = $self->getfield('first'). ' '.
615                                  $self->getfield('last');
616       }
617
618       $content{customer_org} = $self->company ? 'B' : 'I';
619       $content{state_id}       = exists($options{'stateid'})
620                                    ? $options{'stateid'}
621                                    : $self->getfield('stateid');
622       $content{state_id_state} = exists($options{'stateid_state'})
623                                    ? $options{'stateid_state'}
624                                    : $self->getfield('stateid_state');
625       $content{customer_ssn} = exists($options{'ss'})
626                                  ? $options{'ss'}
627                                  : $self->ss;
628
629     } else {
630       die "unknown method ". $options{method};
631     }
632
633   } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
634     #move along
635   } else {
636     die "unknown namespace $namespace";
637   }
638
639   ###
640   # run transaction(s)
641   ###
642
643   my $balance = exists( $options{'balance'} )
644                   ? $options{'balance'}
645                   : $self->balance;
646
647   warn "claiming mutex on customer ". $self->custnum. "\n" if $DEBUG > 1;
648   $self->select_for_update; #mutex ... just until we get our pending record in
649   warn "obtained mutex on customer ". $self->custnum. "\n" if $DEBUG > 1;
650
651   #the checks here are intended to catch concurrent payments
652   #double-form-submission prevention is taken care of in cust_pay_pending::check
653
654   #check the balance
655   return "The customer's balance has changed; $options{method} transaction aborted."
656     if $self->balance < $balance;
657
658   #also check and make sure there aren't *other* pending payments for this cust
659
660   my @pending = qsearch('cust_pay_pending', {
661     'custnum' => $self->custnum,
662     'status'  => { op=>'!=', value=>'done' } 
663   });
664
665   #for third-party payments only, remove pending payments if they're in the 
666   #'thirdparty' (waiting for customer action) state.
667   if ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
668     foreach ( grep { $_->status eq 'thirdparty' } @pending ) {
669       my $error = $_->delete;
670       warn "error deleting unfinished third-party payment ".
671           $_->paypendingnum . ": $error\n"
672         if $error;
673     }
674     @pending = grep { $_->status ne 'thirdparty' } @pending;
675   }
676
677   return "A payment is already being processed for this customer (".
678          join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
679          "); $options{method} transaction aborted."
680     if scalar(@pending);
681
682   #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
683
684   my $cust_pay_pending = new FS::cust_pay_pending {
685     'custnum'           => $self->custnum,
686     'paid'              => $options{amount},
687     '_date'             => $BOP_TESTING ? $BOP_TESTING_TIMESTAMP : '',
688     'payby'             => $bop_method2payby{$options{method}},
689     'payinfo'           => $options{payinfo},
690     'paymask'           => $options{paymask},
691     'paydate'           => $paydate,
692     'recurring_billing' => $content{recurring_billing},
693     'pkgnum'            => $options{'pkgnum'},
694     'status'            => 'new',
695     'gatewaynum'        => $payment_gateway->gatewaynum || '',
696     'session_id'        => $options{session_id} || '',
697     'jobnum'            => $options{depend_jobnum} || '',
698   };
699   $cust_pay_pending->payunique( $options{payunique} )
700     if defined($options{payunique}) && length($options{payunique});
701
702   warn "inserting cust_pay_pending record for customer ". $self->custnum. "\n"
703     if $DEBUG > 1;
704   my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
705   return $cpp_new_err if $cpp_new_err;
706
707   warn "inserted cust_pay_pending record for customer ". $self->custnum. "\n"
708     if $DEBUG > 1;
709   warn Dumper($cust_pay_pending) if $DEBUG > 2;
710
711   my( $action1, $action2 ) =
712     split( /\s*\,\s*/, $payment_gateway->gateway_action );
713
714   my $transaction = new $namespace( $payment_gateway->gateway_module,
715                                     _bop_options(\%options),
716                                   );
717
718   $transaction->content(
719     'type'           => $options{method},
720     _bop_auth(\%options),          
721     'action'         => $action1,
722     'description'    => $options{'description'},
723     'amount'         => $options{amount},
724     #'invoice_number' => $options{'invnum'},
725     'customer_id'    => $self->custnum,
726     %$bop_content,
727     'reference'      => $cust_pay_pending->paypendingnum, #for now
728     'callback_url'   => $payment_gateway->gateway_callback_url,
729     'cancel_url'     => $payment_gateway->gateway_cancel_url,
730     'email'          => $email,
731     %content, #after
732   );
733
734   $cust_pay_pending->status('pending');
735   my $cpp_pending_err = $cust_pay_pending->replace;
736   return $cpp_pending_err if $cpp_pending_err;
737
738   warn Dumper($transaction) if $DEBUG > 2;
739
740   unless ( $BOP_TESTING ) {
741     $transaction->test_transaction(1)
742       if $conf->exists('business-onlinepayment-test_transaction');
743     $transaction->submit();
744   } else {
745     if ( $BOP_TESTING_SUCCESS ) {
746       $transaction->is_success(1);
747       $transaction->authorization('fake auth');
748     } else {
749       $transaction->is_success(0);
750       $transaction->error_message('fake failure');
751     }
752   }
753
754   if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
755
756     $cust_pay_pending->status('thirdparty');
757     my $cpp_err = $cust_pay_pending->replace;
758     return { error => $cpp_err } if $cpp_err;
759     return { reference => $cust_pay_pending->paypendingnum,
760              map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
761
762   } elsif ( !$BOP_TESTING && $transaction->is_success() && $action2 ) {
763
764     $cust_pay_pending->status('authorized');
765     my $cpp_authorized_err = $cust_pay_pending->replace;
766     return $cpp_authorized_err if $cpp_authorized_err;
767
768     my $auth = $transaction->authorization;
769     my $ordernum = $transaction->can('order_number')
770                    ? $transaction->order_number
771                    : '';
772
773     my $capture =
774       new Business::OnlinePayment( $payment_gateway->gateway_module,
775                                    _bop_options(\%options),
776                                  );
777
778     my %capture = (
779       %content,
780       type           => $options{method},
781       action         => $action2,
782       _bop_auth(\%options),          
783       order_number   => $ordernum,
784       amount         => $options{amount},
785       authorization  => $auth,
786       description    => $options{'description'},
787     );
788
789     foreach my $field (qw( authorization_source_code returned_ACI
790                            transaction_identifier validation_code           
791                            transaction_sequence_num local_transaction_date    
792                            local_transaction_time AVS_result_code          )) {
793       $capture{$field} = $transaction->$field() if $transaction->can($field);
794     }
795
796     $capture->content( %capture );
797
798     $capture->test_transaction(1)
799       if $conf->exists('business-onlinepayment-test_transaction');
800     $capture->submit();
801
802     unless ( $capture->is_success ) {
803       my $e = "Authorization successful but capture failed, custnum #".
804               $self->custnum. ': '.  $capture->result_code.
805               ": ". $capture->error_message;
806       warn $e;
807       return $e;
808     }
809
810   }
811
812   ###
813   # remove paycvv after initial transaction
814   ###
815
816   # compare to FS::cust_main::save_cust_payby - check both to make sure working correctly
817   if ( length($options{'paycvv'})
818        && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
819   ) {
820     my $error = $self->remove_cvv_from_cust_payby($options{payinfo});
821     if ( $error ) {
822       $log->critical('Error removing cvv for cust '.$self->custnum.': '.$error);
823       #not returning error, should at least attempt to handle results of an otherwise valid transaction
824       warn "WARNING: error removing cvv: $error\n";
825     }
826   }
827
828   ###
829   # Tokenize
830   ###
831
832   # This block will only run if the B::OP module supports card_token but not the Tokenize transaction;
833   #   if that never happens, we should get rid of it (as it has the potential to store real card numbers on error)
834   if (my $card_token = $self->_tokenize_card($transaction,\%options)) {
835     # cpp will be replaced in _realtime_bop_result
836     $cust_pay_pending->payinfo($card_token);
837     if ($options{'cust_payby'} and my $error = $options{'cust_payby'}->replace) {
838       $log->critical('Error storing token for cust '.$self->custnum.', cust_payby '.$options{'cust_payby'}->custpaybynum.': '.$error);
839       #not returning error, should at least attempt to handle results of an otherwise valid transaction
840       #this leaves real card number in cust_payby, but can't do much else if cust_payby won't replace
841     }
842   }
843
844   ###
845   # result handling
846   ###
847
848   $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
849
850 }
851
852 =item fake_bop
853
854 =cut
855
856 sub fake_bop {
857   my $self = shift;
858
859   my %options = ();
860   if (ref($_[0]) eq 'HASH') {
861     %options = %{$_[0]};
862   } else {
863     my ( $method, $amount ) = ( shift, shift );
864     %options = @_;
865     $options{method} = $method;
866     $options{amount} = $amount;
867   }
868   
869   if ( $options{'fake_failure'} ) {
870      return "Error: No error; test failure requested with fake_failure";
871   }
872
873   my $cust_pay = new FS::cust_pay ( {
874      'custnum'  => $self->custnum,
875      'invnum'   => $options{'invnum'},
876      'paid'     => $options{amount},
877      '_date'    => '',
878      'payby'    => $bop_method2payby{$options{method}},
879      'payinfo'  => '4111111111111111',
880      'paydate'  => '2012-05-01',
881      'processor'      => 'FakeProcessor',
882      'auth'           => '54',
883      'order_number'   => '32',
884   } );
885   $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
886
887   if ( $DEBUG ) {
888       warn "fake_bop\n cust_pay: ". Dumper($cust_pay) . "\n options: ";
889       warn "  $_ => $options{$_}\n" foreach keys %options;
890   }
891
892   my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
893
894   if ( $error ) {
895     $cust_pay->invnum(''); #try again with no specific invnum
896     my $error2 = $cust_pay->insert( $options{'manual'} ?
897                                     ( 'manual' => 1 ) : ()
898                                   );
899     if ( $error2 ) {
900       # gah, even with transactions.
901       my $e = 'WARNING: Card/ACH debited but database not updated - '.
902               "error inserting (fake!) payment: $error2".
903               " (previously tried insert with invnum #$options{'invnum'}" .
904               ": $error )";
905       warn $e;
906       return $e;
907     }
908   }
909
910   if ( $options{'paynum_ref'} ) {
911     ${ $options{'paynum_ref'} } = $cust_pay->paynum;
912   }
913
914   return ''; #no error
915
916 }
917
918
919 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
920
921 # Wraps up processing of a realtime credit card or ACH (electronic check)
922 # transaction.
923
924 sub _realtime_bop_result {
925   my( $self, $cust_pay_pending, $transaction, %options ) = @_;
926
927   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
928
929   if ( $DEBUG ) {
930     warn "$me _realtime_bop_result: pending transaction ".
931       $cust_pay_pending->paypendingnum. "\n";
932     warn "  $_ => $options{$_}\n" foreach keys %options;
933   }
934
935   my $payment_gateway = $options{payment_gateway}
936     or return "no payment gateway in arguments to _realtime_bop_result";
937
938   $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
939   my $cpp_captured_err = $cust_pay_pending->replace; #also saves post-transaction tokenization, if that happens
940   return $cpp_captured_err if $cpp_captured_err;
941
942   if ( $transaction->is_success() ) {
943
944     my $order_number = $transaction->order_number
945       if $transaction->can('order_number');
946
947     my $cust_pay = new FS::cust_pay ( {
948        'custnum'  => $self->custnum,
949        'invnum'   => $options{'invnum'},
950        'paid'     => $cust_pay_pending->paid,
951        '_date'    => $BOP_TESTING ? $BOP_TESTING_TIMESTAMP : '',
952        'payby'    => $cust_pay_pending->payby,
953        'payinfo'  => $options{'payinfo'},
954        'paymask'  => $options{'paymask'} || $cust_pay_pending->paymask,
955        'paydate'  => $cust_pay_pending->paydate,
956        'pkgnum'   => $cust_pay_pending->pkgnum,
957        'discount_term'  => $options{'discount_term'},
958        'gatewaynum'     => ($payment_gateway->gatewaynum || ''),
959        'processor'      => $payment_gateway->gateway_module,
960        'auth'           => $transaction->authorization,
961        'order_number'   => $order_number || '',
962        'no_auto_apply'  => $options{'no_auto_apply'} ? 'Y' : '',
963     } );
964     #doesn't hurt to know, even though the dup check is in cust_pay_pending now
965     $cust_pay->payunique( $options{payunique} )
966       if defined($options{payunique}) && length($options{payunique});
967
968     my $oldAutoCommit = $FS::UID::AutoCommit;
969     local $FS::UID::AutoCommit = 0;
970     my $dbh = dbh;
971
972     my $savepoint_label = '_realtime_bop_result';
973     savepoint_create( $savepoint_label );
974
975     #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
976
977     my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
978
979     if ( $error ) {
980       savepoint_rollback( $savepoint_label );
981
982       $cust_pay->invnum(''); #try again with no specific invnum
983       $cust_pay->paynum('');
984       my $error2 = $cust_pay->insert( $options{'manual'} ?
985                                       ( 'manual' => 1 ) : ()
986                                     );
987       if ( $error2 ) {
988         # gah.  but at least we have a record of the state we had to abort in
989         # from cust_pay_pending now.
990         savepoint_rollback_and_release( $savepoint_label );
991
992         my $e = "WARNING: $options{method} captured but payment not recorded -".
993                 " error inserting payment (". $payment_gateway->gateway_module.
994                 "): $error2".
995                 " (previously tried insert with invnum #$options{'invnum'}" .
996                 ": $error ) - pending payment saved as paypendingnum ".
997                 $cust_pay_pending->paypendingnum. "\n";
998         warn $e;
999         return $e;
1000       }
1001     }
1002
1003     my $jobnum = $cust_pay_pending->jobnum;
1004     if ( $jobnum ) {
1005        my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
1006
1007        unless ( $placeholder ) {
1008          savepoint_rollback_and_release( $savepoint_label );
1009
1010          my $e = "WARNING: $options{method} captured but job $jobnum not ".
1011              "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
1012          warn $e;
1013          return $e;
1014        }
1015
1016        $error = $placeholder->delete;
1017
1018        if ( $error ) {
1019         savepoint_rollback_and_release( $savepoint_label );
1020
1021          my $e = "WARNING: $options{method} captured but could not delete ".
1022               "job $jobnum for paypendingnum ".
1023               $cust_pay_pending->paypendingnum. ": $error\n";
1024          warn $e;
1025          return $e;
1026        }
1027
1028        $cust_pay_pending->set('jobnum','');
1029
1030     }
1031     
1032     if ( $options{'paynum_ref'} ) {
1033       ${ $options{'paynum_ref'} } = $cust_pay->paynum;
1034     }
1035
1036     $cust_pay_pending->status('done');
1037     $cust_pay_pending->statustext('captured');
1038     $cust_pay_pending->paynum($cust_pay->paynum);
1039     my $cpp_done_err = $cust_pay_pending->replace;
1040
1041     if ( $cpp_done_err ) {
1042       savepoint_rollback_and_release( $savepoint_label );
1043
1044       my $e = "WARNING: $options{method} captured but payment not recorded - ".
1045               "error updating status for paypendingnum ".
1046               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
1047       warn $e;
1048       return $e;
1049
1050     } else {
1051       savepoint_release( $savepoint_label );
1052       $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1053
1054       if ( $options{'apply'} ) {
1055         my $apply_error = $self->apply_payments_and_credits;
1056         if ( $apply_error ) {
1057           warn "WARNING: error applying payment: $apply_error\n";
1058           #but we still should return no error cause the payment otherwise went
1059           #through...
1060         }
1061       }
1062
1063       # have a CC surcharge portion --> one-time charge
1064       if ( $options{'cc_surcharge'} > 0 || $options{'processing-fee'} > 0) {
1065             # XXX: this whole block needs to be in a transaction?
1066
1067           my $invnum;
1068           $invnum = $options{'invnum'} if $options{'invnum'};
1069           unless ( $invnum ) { # probably from a payment screen
1070              # do we have any open invoices? pick earliest
1071              # uses the fact that cust_main->cust_bill sorts by date ascending
1072              my @open = $self->open_cust_bill;
1073              $invnum = $open[0]->invnum if scalar(@open);
1074           }
1075             
1076           unless ( $invnum ) {  # still nothing? pick last closed invoice
1077              # again uses fact that cust_main->cust_bill sorts by date ascending
1078              my @closed = $self->cust_bill;
1079              $invnum = $closed[$#closed]->invnum if scalar(@closed);
1080           }
1081
1082           unless ( $invnum ) {
1083             # XXX: unlikely case - pre-paying before any invoices generated
1084             # what it should do is create a new invoice and pick it
1085                 warn 'CC SURCHARGE OR PROCESS FEE AND NO INVOICES PICKED TO APPLY IT!';
1086                 return '';
1087           }
1088
1089     if ($options{'cc_surcharge'} > 0) {
1090             my $cust_pkg;
1091       my $cc_surcharge_text = 'Credit Card Surcharge';
1092       $cc_surcharge_text = $conf->config('credit-card-surcharge-text', $self->agentnum) if $conf->exists('credit-card-surcharge-text', $self->agentnum);
1093             my $charge_error = $self->charge({
1094                                     'amount'    => $options{'cc_surcharge'},
1095                                     'pkg'       => $cc_surcharge_text,
1096                                     'setuptax'  => 'Y',
1097                                     'cust_pkg_ref' => \$cust_pkg,
1098                         });
1099
1100             if($charge_error) {
1101                     warn 'Unable to add CC surcharge cust_pkg';
1102                     return '';
1103             }
1104
1105       $cust_pkg->setup(time);
1106       my $cp_error = $cust_pkg->replace;
1107       if($cp_error) {
1108         warn 'Unable to set setup time on cust_pkg for cc surcharge';
1109         # but keep going...
1110       }
1111
1112       my $cust_bill = qsearchs('cust_bill', { 'invnum' => $invnum });
1113       unless ( $cust_bill ) {
1114         warn "race condition + invoice deletion just happened";
1115         return '';
1116       }
1117
1118       my $grand_error =
1119         $cust_bill->add_cc_surcharge($cust_pkg->pkgnum,$options{'cc_surcharge'});
1120
1121       warn "cannot add CC surcharge to invoice #$invnum: $grand_error"
1122         if $grand_error;
1123     } # end if $options{'cc_surcharge'}
1124
1125     if ($options{'processing-fee'} > 0) {
1126       my $pf_cust_pkg;
1127       my $processing_fee_text = 'Payment Processing Fee';
1128       my $pf_change_error = $self->charge({
1129             'amount'  => $options{'processing-fee'},
1130             'pkg'   => $processing_fee_text,
1131             'setuptax'  => 'Y',
1132             'cust_pkg_ref' => \$pf_cust_pkg,
1133       });
1134
1135       if($pf_change_error) {
1136         warn 'Unable to add payment processing fee';
1137         return '';
1138       }
1139
1140       $pf_cust_pkg->setup(time);
1141       my $pf_error = $pf_cust_pkg->replace;
1142       if($pf_error) {
1143         warn 'Unable to set setup time on cust_pkg for processing fee';
1144         # but keep going...
1145       }
1146
1147       my $cust_bill = qsearchs('cust_bill', { 'invnum' => $invnum });
1148       unless ( $cust_bill ) {
1149         warn "race condition + invoice deletion just happened";
1150         return '';
1151       }
1152
1153       my $grand_pf_error =
1154         $cust_bill->add_cc_surcharge($pf_cust_pkg->pkgnum,$options{'processing-fee'});
1155
1156       warn "cannot add Processing fee to invoice #$invnum: $grand_pf_error"
1157         if $grand_pf_error;
1158     } #end if $options{'processing-fee'}
1159
1160       } #end if ( $options{'cc_surcharge'} > 0 || $options{'processing-fee'} > 0)
1161
1162       return ''; #no error
1163
1164     }
1165
1166   } else {
1167
1168     my $perror = $transaction->error_message;
1169     #$payment_gateway->gateway_module. " error: ".
1170     # removed for conciseness
1171
1172     my $jobnum = $cust_pay_pending->jobnum;
1173     if ( $jobnum ) {
1174        my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
1175       
1176        if ( $placeholder ) {
1177          my $error = $placeholder->depended_delete;
1178          $error ||= $placeholder->delete;
1179          $cust_pay_pending->set('jobnum','');
1180          warn "error removing provisioning jobs after declined paypendingnum ".
1181            $cust_pay_pending->paypendingnum. ": $error\n" if $error;
1182        } else {
1183          my $e = "error finding job $jobnum for declined paypendingnum ".
1184               $cust_pay_pending->paypendingnum. "\n";
1185          warn $e;
1186        }
1187
1188     }
1189     
1190     unless ( $transaction->error_message ) {
1191
1192       my $t_response;
1193       if ( $transaction->can('response_page') ) {
1194         $t_response = {
1195                         'page'    => ( $transaction->can('response_page')
1196                                          ? $transaction->response_page
1197                                          : ''
1198                                      ),
1199                         'code'    => ( $transaction->can('response_code')
1200                                          ? $transaction->response_code
1201                                          : ''
1202                                      ),
1203                         'headers' => ( $transaction->can('response_headers')
1204                                          ? $transaction->response_headers
1205                                          : ''
1206                                      ),
1207                       };
1208       } else {
1209         $t_response .=
1210           "No additional debugging information available for ".
1211             $payment_gateway->gateway_module;
1212       }
1213
1214       $perror .= "No error_message returned from ".
1215                    $payment_gateway->gateway_module. " -- ".
1216                  ( ref($t_response) ? Dumper($t_response) : $t_response );
1217
1218     }
1219
1220     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
1221          && $conf->exists('emaildecline', $self->agentnum)
1222          && grep { $_ ne 'POST' } $self->invoicing_list
1223          && ! grep { $transaction->error_message =~ /$_/ }
1224                    $conf->config('emaildecline-exclude', $self->agentnum)
1225     ) {
1226
1227       # Send a decline alert to the customer.
1228       my $msgnum = $conf->config('decline_msgnum', $self->agentnum);
1229       my $error = '';
1230       if ( $msgnum ) {
1231         # include the raw error message in the transaction state
1232         $cust_pay_pending->setfield('error', $transaction->error_message);
1233         my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
1234         $error = $msg_template->send( 'cust_main' => $self,
1235                                       'object'    => $cust_pay_pending );
1236       }
1237
1238
1239       $perror .= " (also received error sending decline notification: $error)"
1240         if $error;
1241
1242     }
1243
1244     $cust_pay_pending->status('done');
1245     $cust_pay_pending->statustext($perror);
1246     #'declined:': no, that's failure_status
1247     if ( $transaction->can('failure_status') ) {
1248       $cust_pay_pending->failure_status( $transaction->failure_status );
1249     }
1250     my $cpp_done_err = $cust_pay_pending->replace;
1251     if ( $cpp_done_err ) {
1252       my $e = "WARNING: $options{method} declined but pending payment not ".
1253               "resolved - error updating status for paypendingnum ".
1254               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
1255       warn $e;
1256       #XXX internal system log $e (what's going on?)
1257       $perror = "$e ($perror)";
1258     }
1259
1260     return $perror;
1261   }
1262
1263 }
1264
1265 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
1266
1267 Verifies successful third party processing of a realtime credit card or
1268 ACH (electronic check) transaction via a
1269 Business::OnlineThirdPartyPayment realtime gateway.  See
1270 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
1271
1272 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
1273
1274 The additional options I<payname>, I<city>, I<state>,
1275 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
1276 if set, will override the value from the customer record.
1277
1278 I<description> is a free-text field passed to the gateway.  It defaults to
1279 "Internet services".
1280
1281 If an I<invnum> is specified, this payment (if successful) is applied to the
1282 specified invoice.  If you don't specify an I<invnum> you might want to
1283 call the B<apply_payments> method.
1284
1285 I<quiet> can be set true to surpress email decline notices.
1286
1287 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
1288 resulting paynum, if any.
1289
1290 I<payunique> is a unique identifier for this payment.
1291
1292 Returns a hashref containing elements bill_error (which will be undefined
1293 upon success) and session_id of any associated session.
1294
1295 =cut
1296
1297 sub realtime_botpp_capture {
1298   my( $self, $cust_pay_pending, %options ) = @_;
1299
1300   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1301
1302   if ( $DEBUG ) {
1303     warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
1304     warn "  $_ => $options{$_}\n" foreach keys %options;
1305   }
1306
1307   eval "use Business::OnlineThirdPartyPayment";  
1308   die $@ if $@;
1309
1310   ###
1311   # select the gateway
1312   ###
1313
1314   my $method = FS::payby->payby2bop($cust_pay_pending->payby);
1315
1316   my $payment_gateway;
1317   my $gatewaynum = $cust_pay_pending->getfield('gatewaynum');
1318   $payment_gateway = $gatewaynum ? qsearchs( 'payment_gateway',
1319                 { gatewaynum => $gatewaynum }
1320               )
1321     : $self->agent->payment_gateway( 'method' => $method,
1322                                      # 'invnum'  => $cust_pay_pending->invnum,
1323                                      # 'payinfo' => $cust_pay_pending->payinfo,
1324                                    );
1325
1326   $options{payment_gateway} = $payment_gateway; # for the helper subs
1327
1328   ###
1329   # massage data
1330   ###
1331
1332   my @invoicing_list = $self->invoicing_list_emailonly;
1333   if ( $conf->exists('emailinvoiceautoalways')
1334        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
1335        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
1336     push @invoicing_list, $self->all_emails;
1337   }
1338
1339   my $email = ($conf->exists('business-onlinepayment-email-override'))
1340               ? $conf->config('business-onlinepayment-email-override')
1341               : $invoicing_list[0];
1342
1343   my %content = ();
1344
1345   $content{email_customer} = 
1346     (    $conf->exists('business-onlinepayment-email_customer')
1347       || $conf->exists('business-onlinepayment-email-override') );
1348       
1349   ###
1350   # run transaction(s)
1351   ###
1352
1353   my $transaction =
1354     new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
1355                                            _bop_options(\%options),
1356                                          );
1357
1358   $transaction->reference({ %options }); 
1359
1360   $transaction->content(
1361     'type'           => $method,
1362     _bop_auth(\%options),
1363     'action'         => 'Post Authorization',
1364     'description'    => $options{'description'},
1365     'amount'         => $cust_pay_pending->paid,
1366     #'invoice_number' => $options{'invnum'},
1367     'customer_id'    => $self->custnum,
1368     'reference'      => $cust_pay_pending->paypendingnum,
1369     'email'          => $email,
1370     'phone'          => $self->daytime || $self->night,
1371     %content, #after
1372     # plus whatever is required for bogus capture avoidance
1373   );
1374
1375   $transaction->submit();
1376
1377   my $error =
1378     $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
1379
1380   if ( $options{'apply'} ) {
1381     my $apply_error = $self->apply_payments_and_credits;
1382     if ( $apply_error ) {
1383       warn "WARNING: error applying payment: $apply_error\n";
1384     }
1385   }
1386
1387   return {
1388     bill_error => $error,
1389     session_id => $cust_pay_pending->session_id,
1390   }
1391
1392 }
1393
1394 =item default_payment_gateway
1395
1396 DEPRECATED -- use agent->payment_gateway
1397
1398 =cut
1399
1400 sub default_payment_gateway {
1401   my( $self, $method ) = @_;
1402
1403   die "Real-time processing not enabled\n"
1404     unless $conf->exists('business-onlinepayment');
1405
1406   #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
1407
1408   #load up config
1409   my $bop_config = 'business-onlinepayment';
1410   $bop_config .= '-ach'
1411     if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
1412   my ( $processor, $login, $password, $action, @bop_options ) =
1413     $conf->config($bop_config);
1414   $action ||= 'normal authorization';
1415   pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
1416   die "No real-time processor is enabled - ".
1417       "did you set the business-onlinepayment configuration value?\n"
1418     unless $processor;
1419
1420   ( $processor, $login, $password, $action, @bop_options )
1421 }
1422
1423 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
1424
1425 Refunds a realtime credit card or ACH (electronic check) transaction
1426 via a Business::OnlinePayment realtime gateway.  See
1427 L<http://420.am/business-onlinepayment> for supported gateways.
1428
1429 Available methods are: I<CC> or I<ECHECK>
1430
1431 Available options are: I<amount>, I<reasonnum>, I<paynum>, I<paydate>
1432
1433 Most gateways require a reference to an original payment transaction to refund,
1434 so you probably need to specify a I<paynum>.
1435
1436 I<amount> defaults to the original amount of the payment if not specified.
1437
1438 I<reasonnum> specified an existing refund reason for the refund
1439
1440 I<paydate> specifies the expiration date for a credit card overriding the
1441 value from the customer record or the payment record. Specified as yyyy-mm-dd
1442
1443 Implementation note: If I<amount> is unspecified or equal to the amount of the
1444 orignal payment, first an attempt is made to "void" the transaction via
1445 the gateway (to cancel a not-yet settled transaction) and then if that fails,
1446 the normal attempt is made to "refund" ("credit") the transaction via the
1447 gateway is attempted. No attempt to "void" the transaction is made if the 
1448 gateway has introspection data and doesn't support void.
1449
1450 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
1451 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
1452 #if set, will override the value from the customer record.
1453
1454 #If an I<invnum> is specified, this payment (if successful) is applied to the
1455 #specified invoice.  If you don't specify an I<invnum> you might want to
1456 #call the B<apply_payments> method.
1457
1458 =cut
1459
1460 #some false laziness w/realtime_bop, not enough to make it worth merging
1461 #but some useful small subs should be pulled out
1462 sub realtime_refund_bop {
1463   my $self = shift;
1464
1465   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1466
1467   my %options = ();
1468   if (ref($_[0]) eq 'HASH') {
1469     %options = %{$_[0]};
1470   } else {
1471     my $method = shift;
1472     %options = @_;
1473     $options{method} = $method;
1474   }
1475
1476   if ( $DEBUG ) {
1477     warn "$me realtime_refund_bop (new): $options{method} refund\n";
1478     warn "  $_ => $options{$_}\n" foreach keys %options;
1479   }
1480
1481   return "No reason specified" unless $options{'reasonnum'} =~ /^\d+$/;
1482
1483   my %content = ();
1484
1485   ###
1486   # look up the original payment and optionally a gateway for that payment
1487   ###
1488
1489   my $cust_pay = '';
1490   my $amount = $options{'amount'};
1491
1492   my( $processor, $login, $password, @bop_options, $namespace ) ;
1493   my( $auth, $order_number ) = ( '', '', '' );
1494   my $gatewaynum = '';
1495
1496   if ( $options{'paynum'} ) {
1497
1498     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
1499     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
1500       or return "Unknown paynum $options{'paynum'}";
1501     $amount ||= $cust_pay->paid;
1502
1503     my @cust_bill_pay = qsearch('cust_bill_pay', { paynum=>$cust_pay->paynum });
1504     $content{'invoice_number'} = $cust_bill_pay[0]->invnum if @cust_bill_pay;
1505
1506     if ( $cust_pay->get('processor') ) {
1507       ($gatewaynum, $processor, $auth, $order_number) =
1508       (
1509         $cust_pay->gatewaynum,
1510         $cust_pay->processor,
1511         $cust_pay->auth,
1512         $cust_pay->order_number,
1513       );
1514     } else {
1515       # this payment wasn't upgraded, which probably means this won't work,
1516       # but try it anyway
1517       $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
1518         or return "Can't parse paybatch for paynum $options{'paynum'}: ".
1519                   $cust_pay->paybatch;
1520       ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
1521     }
1522
1523     my $payment_gateway;
1524     if ( $gatewaynum ) { #gateway for the payment to be refunded
1525
1526       $payment_gateway =
1527         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
1528       die "payment gateway $gatewaynum not found"
1529         unless $payment_gateway;
1530
1531       $processor   = $payment_gateway->gateway_module;
1532       $login       = $payment_gateway->gateway_username;
1533       $password    = $payment_gateway->gateway_password;
1534       $namespace   = $payment_gateway->gateway_namespace;
1535       @bop_options = $payment_gateway->options;
1536
1537     } else { #try the default gateway
1538
1539       my $conf_processor;
1540       $payment_gateway =
1541         $self->agent->payment_gateway('method' => $options{method});
1542
1543       ( $conf_processor, $login, $password, $namespace ) =
1544         map { my $method = "gateway_$_"; $payment_gateway->$method }
1545           qw( module username password namespace );
1546
1547       @bop_options = $payment_gateway->gatewaynum
1548                        ? $payment_gateway->options
1549                        : @{ $payment_gateway->get('options') };
1550       my %bop_options = @bop_options;
1551
1552       return "processor of payment $options{'paynum'} $processor does not".
1553              " match default processor $conf_processor"
1554         unless ($processor eq $conf_processor)
1555             || (($conf_processor eq 'CardFortress') && ($processor eq $bop_options{'gateway'}));
1556
1557       $processor = $conf_processor;
1558
1559     }
1560
1561     # if gateway has switched to CardFortress but token_check hasn't run yet,
1562     # tokenize just this record now, so that token gets passed/set appropriately
1563     if ($cust_pay->payby eq 'CARD' && !$cust_pay->tokenized) {
1564       my %tokenopts = (
1565         'payment_gateway' => $payment_gateway,
1566         'method'          => 'CC',
1567         'payinfo'         => $cust_pay->payinfo,
1568         'paydate'         => $cust_pay->paydate,
1569       );
1570       my $error = $self->realtime_tokenize(\%tokenopts); # no-op unless gateway can tokenize
1571       if ($self->tokenized($tokenopts{'payinfo'})) { # implies no error
1572         warn "  tokenizing cust_pay\n" if $DEBUG > 1;
1573         $cust_pay->payinfo($tokenopts{'payinfo'});
1574         $error = $cust_pay->replace;
1575       }
1576       return $error if $error;
1577     }
1578
1579   } else { # didn't specify a paynum, so look for agent gateway overrides
1580            # like a normal transaction 
1581  
1582     my $payment_gateway =
1583       $self->agent->payment_gateway( 'method'  => $options{method} );
1584     ( $processor, $login, $password, $namespace ) =
1585       map { my $method = "gateway_$_"; $payment_gateway->$method }
1586         qw( module username password namespace );
1587
1588     my @bop_options = $payment_gateway->gatewaynum
1589                         ? $payment_gateway->options
1590                         : @{ $payment_gateway->get('options') };
1591
1592   }
1593   return "neither amount nor paynum specified" unless $amount;
1594
1595   eval "use $namespace";  
1596   die $@ if $@;
1597
1598   %content = (
1599     %content,
1600     'type'           => $options{method},
1601     'login'          => $login,
1602     'password'       => $password,
1603     'order_number'   => $order_number,
1604     'amount'         => $amount,
1605   );
1606   $content{authorization} = $auth
1607     if length($auth); #echeck/ACH transactions have an order # but no auth
1608                       #(at least with authorize.net)
1609
1610   my $currency =    $conf->exists('business-onlinepayment-currency')
1611                  && $conf->config('business-onlinepayment-currency');
1612   $content{currency} = $currency if $currency;
1613
1614   my $disable_void_after;
1615   if ($conf->exists('disable_void_after')
1616       && $conf->config('disable_void_after') =~ /^(\d+)$/) {
1617     $disable_void_after = $1;
1618   }
1619
1620   #first try void if applicable
1621   my $void = new Business::OnlinePayment( $processor, @bop_options );
1622
1623   my $tryvoid = 1;
1624   if ($void->can('info')) {
1625       my $paytype = '';
1626       $paytype = 'ECHECK' if $cust_pay && $cust_pay->payby eq 'CHEK';
1627       $paytype = 'CC' if $cust_pay && $cust_pay->payby eq 'CARD';
1628       my %supported_actions = $void->info('supported_actions');
1629       $tryvoid = 0 
1630         if ( %supported_actions && $paytype 
1631                 && defined($supported_actions{$paytype}) 
1632                 && !grep{ $_ eq 'Void' } @{$supported_actions{$paytype}} );
1633   }
1634
1635   if ( $cust_pay && $cust_pay->paid == $amount
1636     && (
1637       ( not defined($disable_void_after) )
1638       || ( time < ($cust_pay->_date + $disable_void_after ) )
1639     )
1640     && $tryvoid
1641   ) {
1642     warn "  attempting void\n" if $DEBUG > 1;
1643     if ( $void->can('info') ) {
1644       if ( $cust_pay->payby eq 'CARD'
1645            && $void->info('CC_void_requires_card') )
1646       {
1647         $content{'card_number'} = $cust_pay->payinfo;
1648       } elsif ( $cust_pay->payby eq 'CHEK'
1649                 && $void->info('ECHECK_void_requires_account') )
1650       {
1651         ( $content{'account_number'}, $content{'routing_code'} ) =
1652           split('@', $cust_pay->payinfo);
1653         $content{'name'} = $self->get('first'). ' '. $self->get('last');
1654       }
1655     }
1656     $void->content( 'action' => 'void', %content );
1657     $void->test_transaction(1)
1658       if $conf->exists('business-onlinepayment-test_transaction');
1659     $void->submit();
1660     if ( $void->is_success ) {
1661       # specified as a refund reason, but now we want a payment void reason
1662       # extract just the reason text, let cust_pay::void handle new_or_existing
1663       my $reason = qsearchs('reason',{ 'reasonnum' => $options{'reasonnum'} });
1664       my $error;
1665       $error = 'Reason could not be loaded' unless $reason;      
1666       $error = $cust_pay->void($reason->reason) unless $error;
1667       if ( $error ) {
1668         # gah, even with transactions.
1669         my $e = 'WARNING: Card/ACH voided but database not updated - '.
1670                 "error voiding payment: $error";
1671         warn $e;
1672         return $e;
1673       }
1674       warn "  void successful\n" if $DEBUG > 1;
1675       return '';
1676     }
1677   }
1678
1679   warn "  void unsuccessful, trying refund\n"
1680     if $DEBUG > 1;
1681
1682   #massage data
1683   my $address = $self->address1;
1684   $address .= ", ". $self->address2 if $self->address2;
1685
1686   my($payname, $payfirst, $paylast);
1687   if ( $self->payname && $options{method} ne 'ECHECK' ) {
1688     $payname = $self->payname;
1689     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
1690       or return "Illegal payname $payname";
1691     ($payfirst, $paylast) = ($1, $2);
1692   } else {
1693     $payfirst = $self->getfield('first');
1694     $paylast = $self->getfield('last');
1695     $payname =  "$payfirst $paylast";
1696   }
1697
1698   my @invoicing_list = $self->invoicing_list_emailonly;
1699   if ( $conf->exists('emailinvoiceautoalways')
1700        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
1701        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
1702     push @invoicing_list, $self->all_emails;
1703   }
1704
1705   my $email = ($conf->exists('business-onlinepayment-email-override'))
1706               ? $conf->config('business-onlinepayment-email-override')
1707               : $invoicing_list[0];
1708
1709   my $payip = exists($options{'payip'})
1710                 ? $options{'payip'}
1711                 : $self->payip;
1712   $content{customer_ip} = $payip
1713     if length($payip);
1714
1715   my $payinfo = '';
1716   my $paymask = ''; # for refund record
1717   if ( $options{method} eq 'CC' ) {
1718
1719     if ( $cust_pay ) {
1720       $content{card_number} = $payinfo = $cust_pay->payinfo;
1721       $paymask = $cust_pay->paymask;
1722       (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
1723         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
1724         ($content{expiration} = "$2/$1");  # where available
1725     } else {
1726       # this really needs a better cleanup
1727       die "Refund without paynum not supported";
1728 #      $content{card_number} = $payinfo = $self->payinfo;
1729 #      (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
1730 #        =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
1731 #      $content{expiration} = "$2/$1";
1732     }
1733
1734   } elsif ( $options{method} eq 'ECHECK' ) {
1735
1736     if ( $cust_pay ) {
1737       $payinfo = $cust_pay->payinfo;
1738     } else {
1739       $payinfo = $self->payinfo;
1740     } 
1741     ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
1742     $content{bank_name} = $self->payname;
1743     $content{account_type} = 'CHECKING';
1744     $content{account_name} = $payname;
1745     $content{customer_org} = $self->company ? 'B' : 'I';
1746     $content{customer_ssn} = $self->ss;
1747
1748   }
1749
1750   #then try refund
1751   my $refund = new Business::OnlinePayment( $processor, @bop_options );
1752   my %sub_content = $refund->content(
1753     'action'         => 'credit',
1754     'customer_id'    => $self->custnum,
1755     'last_name'      => $paylast,
1756     'first_name'     => $payfirst,
1757     'name'           => $payname,
1758     'address'        => $address,
1759     'city'           => $self->city,
1760     'state'          => $self->state,
1761     'zip'            => $self->zip,
1762     'country'        => $self->country,
1763     'email'          => $email,
1764     'phone'          => $self->daytime || $self->night,
1765     %content, #after
1766   );
1767   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
1768     if $DEBUG > 1;
1769   $refund->test_transaction(1)
1770     if $conf->exists('business-onlinepayment-test_transaction');
1771   $refund->submit();
1772
1773   return "$processor error: ". $refund->error_message
1774     unless $refund->is_success();
1775
1776   $order_number = $refund->order_number if $refund->can('order_number');
1777
1778   # change this to just use $cust_pay->delete_cust_bill_pay?
1779   while ( $cust_pay && $cust_pay->unapplied < $amount ) {
1780     my @cust_bill_pay = $cust_pay->cust_bill_pay;
1781     last unless @cust_bill_pay;
1782     my $cust_bill_pay = pop @cust_bill_pay;
1783     my $error = $cust_bill_pay->delete;
1784     last if $error;
1785   }
1786
1787   my $cust_refund = new FS::cust_refund ( {
1788     'custnum'  => $self->custnum,
1789     'paynum'   => $options{'paynum'},
1790     'source_paynum' => $options{'paynum'},
1791     'refund'   => $amount,
1792     '_date'    => '',
1793     'payby'    => $bop_method2payby{$options{method}},
1794     'payinfo'  => $payinfo,
1795     'paymask'  => $paymask,
1796     'reasonnum'     => $options{'reasonnum'},
1797     'gatewaynum'    => $gatewaynum, # may be null
1798     'processor'     => $processor,
1799     'auth'          => $refund->authorization,
1800     'order_number'  => $order_number,
1801   } );
1802   my $error = $cust_refund->insert;
1803   if ( $error ) {
1804     $cust_refund->paynum(''); #try again with no specific paynum
1805     $cust_refund->source_paynum('');
1806     my $error2 = $cust_refund->insert;
1807     if ( $error2 ) {
1808       # gah, even with transactions.
1809       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
1810               "error inserting refund ($processor): $error2".
1811               " (previously tried insert with paynum #$options{'paynum'}" .
1812               ": $error )";
1813       warn $e;
1814       return $e;
1815     }
1816   }
1817
1818   ''; #no error
1819
1820 }
1821
1822 =item realtime_verify_bop [ OPTION => VALUE ... ]
1823
1824 Runs an authorization-only transaction for $1 against this credit card (if
1825 successful, immediatly reverses the authorization).
1826
1827 Returns the empty string if the authorization was sucessful, or an error
1828 message otherwise.
1829
1830 Option I<cust_payby> should be passed, even if it's not yet been inserted.
1831 Object will be tokenized if possible, but that change will not be
1832 updated in database (must be inserted/replaced afterwards.)
1833
1834 Currently only succeeds for Business::OnlinePayment CC transactions.
1835
1836 =cut
1837
1838 #some false laziness w/realtime_bop and realtime_refund_bop, not enough to make
1839 #it worth merging but some useful small subs should be pulled out
1840 sub realtime_verify_bop {
1841   my $self = shift;
1842
1843   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1844   my $log = FS::Log->new('FS::cust_main::Billing_Realtime::realtime_verify_bop');
1845
1846   my %options = ();
1847   if (ref($_[0]) eq 'HASH') {
1848     %options = %{$_[0]};
1849   } else {
1850     %options = @_;
1851   }
1852
1853   if ( $DEBUG ) {
1854     warn "$me realtime_verify_bop\n";
1855     warn "  $_ => $options{$_}\n" foreach keys %options;
1856   }
1857
1858   # set fields from passed cust_payby
1859   return "No cust_payby" unless $options{'cust_payby'};
1860   _bop_cust_payby_options(\%options);
1861
1862   # check for banned credit card/ACH
1863   my $ban = FS::banned_pay->ban_search(
1864     'payby'   => $bop_method2payby{'CC'},
1865     'payinfo' => $options{payinfo},
1866   );
1867   return "Banned credit card" if $ban && $ban->bantype ne 'warn';
1868
1869   # possibly run a separate transaction to tokenize card number,
1870   #   so that we never store tokenized card info in cust_pay_pending
1871   if (($options{method} eq 'CC') && !$self->tokenized($options{'payinfo'})) {
1872     my $token_error = $self->realtime_tokenize(\%options);
1873     return $token_error if $token_error;
1874     #important that we not replace cust_payby here,
1875     #because cust_payby->replace uses realtime_verify_bop!
1876   }
1877
1878   ###
1879   # select a gateway
1880   ###
1881
1882   my $payment_gateway =  $self->_payment_gateway( \%options );
1883   my $namespace = $payment_gateway->gateway_namespace;
1884
1885   eval "use $namespace";  
1886   die $@ if $@;
1887
1888   ###
1889   # massage data
1890   ###
1891
1892   my $bop_content = $self->_bop_content(\%options);
1893   return $bop_content unless ref($bop_content);
1894
1895   my @invoicing_list = $self->invoicing_list_emailonly;
1896   if ( $conf->exists('emailinvoiceautoalways')
1897        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
1898        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
1899     push @invoicing_list, $self->all_emails;
1900   }
1901
1902   my $email = ($conf->exists('business-onlinepayment-email-override'))
1903               ? $conf->config('business-onlinepayment-email-override')
1904               : $invoicing_list[0];
1905
1906   my $paydate = '';
1907   my %content = ();
1908
1909   if ( $namespace eq 'Business::OnlinePayment' ) {
1910
1911     if ( $options{method} eq 'CC' ) {
1912
1913       $content{card_number} = $options{payinfo};
1914       $paydate = $options{'paydate'};
1915       $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
1916       $content{expiration} = "$2/$1";
1917
1918       $content{cvv2} = $options{'paycvv'}
1919         if length($options{'paycvv'});
1920
1921       my $paystart_month = $options{'paystart_month'};
1922       my $paystart_year  = $options{'paystart_year'};
1923
1924       $content{card_start} = "$paystart_month/$paystart_year"
1925         if $paystart_month && $paystart_year;
1926
1927       my $payissue       = $options{'payissue'};
1928       $content{issue_number} = $payissue if $payissue;
1929
1930     } elsif ( $options{method} eq 'ECHECK' ){
1931       #cannot verify, move along (though it shouldn't be called...)
1932       return '';
1933     } else {
1934       return "unknown method ". $options{method};
1935     }
1936   } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
1937     #cannot verify, move along
1938     return '';
1939   } else {
1940     return "unknown namespace $namespace";
1941   }
1942
1943   ###
1944   # run transaction(s)
1945   ###
1946
1947   my $error;
1948   my $transaction; #need this back so we can do _tokenize_card
1949
1950   # don't mutex the customer here, because they might be uncommitted. and
1951   # this is only verification. it doesn't matter if they have other
1952   # unfinished verifications.
1953
1954   my $cust_pay_pending = new FS::cust_pay_pending {
1955     'custnum_pending'   => 1,
1956     'paid'              => '1.00',
1957     '_date'             => '',
1958     'payby'             => $bop_method2payby{'CC'},
1959     'payinfo'           => $options{payinfo},
1960     'paymask'           => $options{paymask},
1961     'paydate'           => $paydate,
1962     'pkgnum'            => $options{'pkgnum'},
1963     'status'            => 'new',
1964     'gatewaynum'        => $payment_gateway->gatewaynum || '',
1965     'session_id'        => $options{session_id} || '',
1966   };
1967   $cust_pay_pending->payunique( $options{payunique} )
1968     if defined($options{payunique}) && length($options{payunique});
1969
1970   IMMEDIATE: {
1971     # open a separate handle for creating/updating the cust_pay_pending
1972     # record
1973     local $FS::UID::dbh = myconnect();
1974     local $FS::UID::AutoCommit = 1;
1975
1976     # if this is an existing customer (and we can tell now because
1977     # this is a fresh transaction), it's safe to assign their custnum
1978     # to the cust_pay_pending record, and then the verification attempt
1979     # will remain linked to them even if it fails.
1980     if ( FS::cust_main->by_key($self->custnum) ) {
1981       $cust_pay_pending->set('custnum', $self->custnum);
1982     }
1983
1984     warn "inserting cust_pay_pending record for customer ". $self->custnum. "\n"
1985       if $DEBUG > 1;
1986
1987     # if this fails, just return; everything else will still allow the
1988     # cust_pay_pending to have its custnum set later
1989     my $cpp_new_err = $cust_pay_pending->insert;
1990     return $cpp_new_err if $cpp_new_err;
1991
1992     warn "inserted cust_pay_pending record for customer ". $self->custnum. "\n"
1993       if $DEBUG > 1;
1994     warn Dumper($cust_pay_pending) if $DEBUG > 2;
1995
1996     $transaction = new $namespace( $payment_gateway->gateway_module,
1997                                    _bop_options(\%options),
1998                                     );
1999
2000     $transaction->content(
2001       'type'           => 'CC',
2002       _bop_auth(\%options),          
2003       'action'         => 'Authorization Only',
2004       'description'    => $options{'description'},
2005       'amount'         => '1.00',
2006       'customer_id'    => $self->custnum,
2007       %$bop_content,
2008       'reference'      => $cust_pay_pending->paypendingnum, #for now
2009       'email'          => $email,
2010       %content, #after
2011     );
2012
2013     $cust_pay_pending->status('pending');
2014     my $cpp_pending_err = $cust_pay_pending->replace;
2015     return $cpp_pending_err if $cpp_pending_err;
2016
2017     warn Dumper($transaction) if $DEBUG > 2;
2018
2019     unless ( $BOP_TESTING ) {
2020       $transaction->test_transaction(1)
2021         if $conf->exists('business-onlinepayment-test_transaction');
2022       $transaction->submit();
2023     } else {
2024       if ( $BOP_TESTING_SUCCESS ) {
2025         $transaction->is_success(1);
2026         $transaction->authorization('fake auth');
2027       } else {
2028         $transaction->is_success(0);
2029         $transaction->error_message('fake failure');
2030       }
2031     }
2032
2033     if ( $transaction->is_success() ) {
2034
2035       $cust_pay_pending->status('authorized');
2036       my $cpp_authorized_err = $cust_pay_pending->replace;
2037       return $cpp_authorized_err if $cpp_authorized_err;
2038
2039       my $auth = $transaction->authorization;
2040       my $ordernum = $transaction->can('order_number')
2041                      ? $transaction->order_number
2042                      : '';
2043
2044       my $reverse = new $namespace( $payment_gateway->gateway_module,
2045                                     _bop_options(\%options),
2046                                   );
2047
2048       $reverse->content( 'action'        => 'Reverse Authorization',
2049                          _bop_auth(\%options),          
2050
2051                          # B:OP
2052                          'amount'        => '1.00',
2053                          'authorization' => $transaction->authorization,
2054                          'order_number'  => $ordernum,
2055
2056                          # vsecure
2057                          'result_code'   => $transaction->result_code,
2058                          'txn_date'      => $transaction->txn_date,
2059
2060                          %content,
2061                        );
2062       $reverse->test_transaction(1)
2063         if $conf->exists('business-onlinepayment-test_transaction');
2064       $reverse->submit();
2065
2066       if ( $reverse->is_success ) {
2067
2068         $cust_pay_pending->status('done');
2069         $cust_pay_pending->statustext('reversed');
2070         my $cpp_reversed_err = $cust_pay_pending->replace;
2071         return $cpp_reversed_err if $cpp_reversed_err;
2072
2073       } else {
2074
2075         my $e = "Authorization successful but reversal failed, custnum #".
2076                 $self->custnum. ': '.  $reverse->result_code.
2077                 ": ". $reverse->error_message;
2078         $log->warning($e);
2079         warn $e;
2080         return $e;
2081
2082       }
2083
2084       ### Address Verification ###
2085       #
2086       # Single-letter codes vary by cardtype.
2087       #
2088       # Erring on the side of accepting cards if avs is not available,
2089       # only rejecting if avs occurred and there's been an explicit mismatch
2090       #
2091       # Charts below taken from vSecure documentation,
2092       #    shows codes for Amex/Dscv/MC/Visa
2093       #
2094       # ACCEPTABLE AVS RESPONSES:
2095       # Both Address and 5-digit postal code match Y A Y Y
2096       # Both address and 9-digit postal code match Y A X Y
2097       # United Kingdom – Address and postal code match _ _ _ F
2098       # International transaction – Address and postal code match _ _ _ D/M
2099       #
2100       # ACCEPTABLE, BUT ISSUE A WARNING:
2101       # Ineligible transaction; or message contains a content error _ _ _ E
2102       # System unavailable; retry R U R R
2103       # Information unavailable U W U U
2104       # Issuer does not support AVS S U S S
2105       # AVS is not applicable _ _ _ S
2106       # Incompatible formats – Not verified _ _ _ C
2107       # Incompatible formats – Address not verified; postal code matches _ _ _ P
2108       # International transaction – address not verified _ G _ G/I
2109       #
2110       # UNACCEPTABLE AVS RESPONSES:
2111       # Only Address matches A Y A A
2112       # Only 5-digit postal code matches Z Z Z Z
2113       # Only 9-digit postal code matches Z Z W W
2114       # Neither address nor postal code matches N N N N
2115
2116       if (my $avscode = uc($transaction->avs_code)) {
2117
2118         # map codes to accept/warn/reject
2119         my $avs = {
2120           'American Express card' => {
2121             'A' => 'r',
2122             'N' => 'r',
2123             'R' => 'w',
2124             'S' => 'w',
2125             'U' => 'w',
2126             'Y' => 'a',
2127             'Z' => 'r',
2128           },
2129           'Discover card' => {
2130             'A' => 'a',
2131             'G' => 'w',
2132             'N' => 'r',
2133             'U' => 'w',
2134             'W' => 'w',
2135             'Y' => 'r',
2136             'Z' => 'r',
2137           },
2138           'MasterCard' => {
2139             'A' => 'r',
2140             'N' => 'r',
2141             'R' => 'w',
2142             'S' => 'w',
2143             'U' => 'w',
2144             'W' => 'r',
2145             'X' => 'a',
2146             'Y' => 'a',
2147             'Z' => 'r',
2148           },
2149           'VISA card' => {
2150             'A' => 'r',
2151             'C' => 'w',
2152             'D' => 'a',
2153             'E' => 'w',
2154             'F' => 'a',
2155             'G' => 'w',
2156             'I' => 'w',
2157             'M' => 'a',
2158             'N' => 'r',
2159             'P' => 'w',
2160             'R' => 'w',
2161             'S' => 'w',
2162             'U' => 'w',
2163             'W' => 'r',
2164             'Y' => 'a',
2165             'Z' => 'r',
2166           },
2167         };
2168         my $cardtype = cardtype($content{card_number});
2169         if ($avs->{$cardtype}) {
2170           my $avsact = $avs->{$cardtype}->{$avscode};
2171           my $warning = '';
2172           if ($avsact eq 'r') {
2173             return "AVS code verification failed, cardtype $cardtype, code $avscode";
2174           } elsif ($avsact eq 'w') {
2175             $warning = "AVS did not occur, cardtype $cardtype, code $avscode";
2176           } elsif (!$avsact) {
2177             $warning = "AVS code unknown, cardtype $cardtype, code $avscode";
2178           } # else $avsact eq 'a'
2179           if ($warning) {
2180             $log->warning($warning);
2181             warn $warning;
2182           }
2183         } # else $cardtype avs handling not implemented
2184       } # else !$transaction->avs_code
2185
2186     } else { # is not success
2187
2188       # status is 'done' not 'declined', as in _realtime_bop_result
2189       $cust_pay_pending->status('done');
2190       $error = $transaction->error_message || 'Unknown error';
2191       $cust_pay_pending->statustext($error);
2192       # could also record failure_status here,
2193       #   but it's not supported by B::OP::vSecureProcessing...
2194       #   need a B::OP module with (reverse) auth only to test it with
2195       my $cpp_declined_err = $cust_pay_pending->replace;
2196       return $cpp_declined_err if $cpp_declined_err;
2197
2198     }
2199
2200   } # end of IMMEDIATE; we now have our $error and $transaction
2201
2202   ###
2203   # Save the custnum (as part of the main transaction, so it can reference
2204   # the cust_main)
2205   ###
2206
2207   if (!$cust_pay_pending->custnum) {
2208     $cust_pay_pending->set('custnum', $self->custnum);
2209     my $set_custnum_err = $cust_pay_pending->replace;
2210     if ($set_custnum_err) {
2211       $log->error($set_custnum_err);
2212       $error ||= $set_custnum_err;
2213       # but if there was a real verification error also, return that one
2214     }
2215   }
2216
2217   ###
2218   # remove paycvv here?  need to find out if a reversed auth
2219   #   counts as an initial transaction for paycvv retention requirements
2220   ###
2221
2222   ###
2223   # Tokenize
2224   ###
2225
2226   # This block will only run if the B::OP module supports card_token but not the Tokenize transaction;
2227   #   if that never happens, we should get rid of it (as it has the potential to store real card numbers on error)
2228   if (my $card_token = $self->_tokenize_card($transaction,\%options)) {
2229     $cust_pay_pending->payinfo($card_token);
2230     my $cpp_token_err = $cust_pay_pending->replace;
2231     #this leaves real card number in cust_pay_pending, but can't do much else if cpp won't replace
2232     return $cpp_token_err if $cpp_token_err;
2233     #important that we not replace cust_payby here,
2234     #because cust_payby->replace uses realtime_verify_bop!
2235   }
2236
2237   ###
2238   # result handling
2239   ###
2240
2241   # $error contains the transaction error_message, if is_success was false.
2242  
2243   return $error;
2244
2245 }
2246
2247 =item realtime_tokenize [ OPTION => VALUE ... ]
2248
2249 If possible and necessary, runs a tokenize transaction.
2250 In order to be possible, a credit card cust_payby record
2251 must be passed and a Business::OnlinePayment gateway capable
2252 of Tokenize transactions must be configured for this user.
2253 Is only necessary if payinfo is not yet tokenized.
2254
2255 Returns the empty string if the authorization was sucessful
2256 or was not possible/necessary (thus allowing this to be safely called with
2257 non-tokenizable records/gateways, without having to perform separate tests),
2258 or an error message otherwise.
2259
2260 Option I<cust_payby> may be passed, even if it's not yet been inserted.
2261 Object will be tokenized if possible, but that change will not be
2262 updated in database (must be inserted/replaced afterwards.)
2263
2264 Otherwise, options I<method>, I<payinfo> and other cust_payby fields
2265 may be passed.  If options are passed as a hashref, I<payinfo>
2266 will be updated as appropriate in the passed hashref.
2267
2268 Can be run as a class method if option I<payment_gateway> is passed,
2269 but default customer id/name/phone can't be set in that case.  This
2270 is really only intended for tokenizing old records on upgrade.
2271
2272 =cut
2273
2274 # careful--might be run as a class method
2275 sub realtime_tokenize {
2276   my $self = shift;
2277
2278   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
2279   my $log = FS::Log->new('FS::cust_main::Billing_Realtime::realtime_tokenize');
2280
2281   my %options = ();
2282   my $outoptions; #for returning cust_payby/payinfo
2283   if (ref($_[0]) eq 'HASH') {
2284     %options = %{$_[0]};
2285     $outoptions = $_[0];
2286   } else {
2287     %options = @_;
2288     $outoptions = \%options;
2289   }
2290
2291   # set fields from passed cust_payby
2292   _bop_cust_payby_options(\%options);
2293   return '' unless $options{method} eq 'CC';
2294   return '' if $self->tokenized($options{payinfo}); #already tokenized
2295
2296   # check for banned credit card/ACH
2297   my $ban = FS::banned_pay->ban_search(
2298     'payby'   => $bop_method2payby{'CC'},
2299     'payinfo' => $options{payinfo},
2300   );
2301   return "Banned credit card" if $ban && $ban->bantype ne 'warn';
2302
2303   ###
2304   # select a gateway
2305   ###
2306
2307   $options{'nofatal'} = 1;
2308   my $payment_gateway =  $self->_payment_gateway( \%options );
2309   return '' unless $payment_gateway;
2310   my $namespace = $payment_gateway->gateway_namespace;
2311   return '' unless $namespace eq 'Business::OnlinePayment';
2312
2313   eval "use $namespace";  
2314   return $@ if $@;
2315
2316   ###
2317   # check for tokenize ability
2318   ###
2319
2320   my $transaction = new $namespace( $payment_gateway->gateway_module,
2321                                     _bop_options(\%options),
2322                                   );
2323
2324   return '' unless $transaction->can('info');
2325
2326   my %supported_actions = $transaction->info('supported_actions');
2327   return '' unless $supported_actions{'CC'}
2328                 && grep /^Tokenize$/, @{$supported_actions{'CC'}};
2329
2330   ###
2331   # massage data
2332   ###
2333
2334   ### Currently, cardfortress only keys in on card number and exp date.
2335   ### We pass everything we'd pass to a normal transaction,
2336   ### for ease of current and future development,
2337   ### but note, when tokenizing old records, we may only have access to payinfo/paydate
2338
2339   my $bop_content = $self->_bop_content(\%options);
2340   return $bop_content unless ref($bop_content);
2341
2342   my $paydate = '';
2343   my %content = ();
2344
2345   $content{card_number} = $options{payinfo};
2346   $paydate = $options{'paydate'};
2347   $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2348   $content{expiration} = "$2/$1";
2349
2350   $content{cvv2} = $options{'paycvv'}
2351     if length($options{'paycvv'});
2352
2353   my $paystart_month = $options{'paystart_month'};
2354   my $paystart_year  = $options{'paystart_year'};
2355
2356   $content{card_start} = "$paystart_month/$paystart_year"
2357     if $paystart_month && $paystart_year;
2358
2359   my $payissue       = $options{'payissue'};
2360   $content{issue_number} = $payissue if $payissue;
2361
2362   $content{customer_id} = $self->custnum
2363     if ref($self);
2364
2365   ###
2366   # run transaction
2367   ###
2368
2369   my $error;
2370
2371   # no cust_pay_pending---this is not a financial transaction
2372
2373   $transaction->content(
2374     'type'           => 'CC',
2375     _bop_auth(\%options),          
2376     'action'         => 'Tokenize',
2377     'description'    => $options{'description'},
2378     %$bop_content,
2379     %content, #after
2380   );
2381
2382   # no $BOP_TESTING handling for this
2383   $transaction->test_transaction(1)
2384     if $conf->exists('business-onlinepayment-test_transaction');
2385   $transaction->submit();
2386
2387   if ( $transaction->card_token() ) { # no is_success flag
2388
2389     # realtime_tokenize should not clear paycvv at this time.  it might be
2390     # needed for the first transaction, and a tokenize isn't actually a
2391     # transaction that hits the gateway.  at some point in the future, card
2392     # fortress should take on the "store paycvv until first transaction"
2393     # functionality and we should fix this in freeside, but i that's a bigger
2394     # project for another time.
2395
2396     #important that we not replace cust_payby here, 
2397     #because cust_payby->replace uses realtime_tokenize!
2398     $self->_tokenize_card($transaction,$outoptions);
2399
2400   } else {
2401
2402     $error = $transaction->error_message || 'Unknown error when tokenizing card';
2403
2404   }
2405
2406   return $error;
2407
2408 }
2409
2410
2411 =item tokenized PAYINFO
2412
2413 Convenience wrapper for L<FS::payinfo_Mixin/tokenized>
2414
2415 PAYINFO is required.
2416
2417 Can be run as class or object method, never loads from object.
2418
2419 =cut
2420
2421 sub tokenized {
2422   my $this = shift;
2423   my $payinfo = shift;
2424   FS::cust_pay->tokenized($payinfo);
2425 }
2426
2427 =item token_check [ quiet => 1, queue => 1, daily => 1 ]
2428
2429 NOT A METHOD.  Acts on all customers.  Placed here because it makes
2430 use of module-internal methods, and to keep everything that uses
2431 Billing::OnlinePayment all in one place.
2432
2433 Tokenizes all tokenizable card numbers from payinfo in cust_payby and 
2434 CARD transactions in cust_pay_pending, cust_pay, cust_pay_void and cust_refund.
2435
2436 If the I<queue> flag is set, newly tokenized records will be immediately
2437 committed, regardless of AutoCommit, so as to release the mutex on the record.
2438
2439 If all configured gateways have the ability to tokenize, detection of an 
2440 untokenizable record will cause a fatal error.  However, if the I<queue> flag 
2441 is set, this will instead cause a critical error to be recorded in the log, 
2442 and any other tokenizable records will still be committed.
2443
2444 If the I<daily> flag is also set, detection of existing untokenized records will 
2445 record an info message in the system log (because they should have never appeared 
2446 in the first place.)  Tokenization will still be attempted.
2447
2448 If any configured gateways do NOT have the ability to tokenize, or if a
2449 default gateway is not configured, then untokenized records are not considered 
2450 a threat, and no critical errors will be generated in the log.
2451
2452 =cut
2453
2454 sub token_check {
2455   #acts on all customers
2456   my %opt = @_;
2457   my $debug = !$opt{'quiet'} || $DEBUG;
2458   my $hascritical = 0;
2459
2460   warn "token_check called with opts\n".Dumper(\%opt) if $debug;
2461
2462   # force some explicitness when invoking this method
2463   die "token_check must run with queue flag if run with daily flag"
2464     if $opt{'daily'} && !$opt{'queue'};
2465
2466   my $conf = FS::Conf->new;
2467
2468   my $log = FS::Log->new('FS::cust_main::Billing_Realtime::token_check');
2469
2470   my $cache = {}; #cache for module info
2471
2472   # look for a gateway that can and can't tokenize
2473   my $require_tokenized = 1;
2474   my $someone_tokenizing = 0;
2475   foreach my $gateway (
2476     FS::payment_gateway->all_gateways(
2477       'method'  => 'CC',
2478       'conf'    => $conf,
2479       'nofatal' => 1,
2480     )
2481   ) {
2482     if (!$gateway) {
2483       # no default gateway, no promise to tokenize
2484       # can just load other gateways as-needeed below
2485       $require_tokenized = 0;
2486       last if $someone_tokenizing;
2487       next;
2488     }
2489     my $info = _token_check_gateway_info($cache,$gateway);
2490     die $info unless ref($info); # means it's an error message
2491     if ($info->{'can_tokenize'}) {
2492       $someone_tokenizing = 1;
2493     } else {
2494       # a configured gateway can't tokenize, that's all we need to know right now
2495       # can just load other gateways as-needeed below
2496       $require_tokenized = 0;
2497       last if $someone_tokenizing;
2498     }
2499   }
2500
2501   unless ($someone_tokenizing) { #no need to check, if no one can tokenize
2502     warn "no gateways tokenize\n" if $debug;
2503     return;
2504   }
2505
2506   warn "REQUIRE TOKENIZED" if $require_tokenized && $debug;
2507
2508   # upgrade does not call this with autocommit turned on,
2509   # and autocommit will be ignored if opt queue is set,
2510   # but might as well be thorough...
2511   my $oldAutoCommit = $FS::UID::AutoCommit;
2512   local $FS::UID::AutoCommit = 0;
2513   my $dbh = dbh;
2514
2515   # for retrieving data in chunks
2516   my $step = 500;
2517   my $offset = 0;
2518
2519   ### Tokenize cust_payby
2520
2521   my @recnums;
2522
2523 CUSTLOOP:
2524   while (my $custnum = _token_check_next_recnum($dbh,'cust_main',$step,\$offset,\@recnums)) {
2525     my $cust_main = FS::cust_main->by_key($custnum);
2526     my $payment_gateway;
2527     foreach my $cust_payby ($cust_main->cust_payby('CARD','DCRD')) {
2528
2529       # see if it's already tokenized
2530       if ($cust_payby->tokenized) {
2531         warn "cust_payby ".$cust_payby->get($cust_payby->primary_key)." already tokenized" if $debug;
2532         next;
2533       }
2534
2535       if ($require_tokenized && $opt{'daily'}) {
2536         $log->info("Untokenized card number detected in cust_payby ".$cust_payby->custpaybynum. '; tokenizing');
2537         $dbh->commit or die $dbh->errstr; # commit log message
2538       }
2539
2540       # only load gateway if we need to, and only need to load it once
2541       $payment_gateway ||= $cust_main->_payment_gateway({
2542         'method'  => 'CC',
2543         'conf'    => $conf,
2544         'nofatal' => 1, # handle lack of gateway smoothly below
2545       });
2546       unless ($payment_gateway) {
2547         # no reason to have untokenized card numbers saved if no gateway,
2548         #   but only a problem if we expected everyone to tokenize card numbers
2549         unless ($require_tokenized) {
2550           warn "Skipping cust_payby for cust_main ".$cust_main->custnum.", no payment gateway" if $debug;
2551           next CUSTLOOP; # can skip rest of customer
2552         }
2553         my $error = "No gateway found for custnum ".$cust_main->custnum;
2554         if ($opt{'queue'}) {
2555           $hascritical = 1;
2556           $log->critical($error);
2557           $dbh->commit or die $dbh->errstr; # commit error message
2558           next; # not next CUSTLOOP, want to record error for every cust_payby
2559         }
2560         $dbh->rollback if $oldAutoCommit;
2561         die $error;
2562       }
2563
2564       my $info = _token_check_gateway_info($cache,$payment_gateway);
2565       unless (ref($info)) {
2566         # only throws error if Business::OnlinePayment won't load,
2567         #   which is just cause to abort this whole process, even if queue
2568         $dbh->rollback if $oldAutoCommit;
2569         die $info; # error message
2570       }
2571       # no fail here--a configured gateway can't tokenize, so be it
2572       unless ($info->{'can_tokenize'}) {
2573         warn "Skipping ".$cust_main->custnum." cannot tokenize" if $debug;
2574         next;
2575       }
2576
2577       # time to tokenize
2578       $cust_payby = $cust_payby->select_for_update;
2579       my %tokenopts = (
2580         'payment_gateway' => $payment_gateway,
2581         'cust_payby'      => $cust_payby,
2582       );
2583       my $error = $cust_main->realtime_tokenize(\%tokenopts);
2584       if ($cust_payby->tokenized) { # implies no error
2585         $error = $cust_payby->replace;
2586       } else {
2587         $error ||= 'Unknown error';
2588       }
2589       if ($error) {
2590         $error = "Error tokenizing cust_payby ".$cust_payby->custpaybynum.": ".$error;
2591         if ($opt{'queue'}) {
2592           $hascritical = 1;
2593           $log->critical($error);
2594           $dbh->commit or die $dbh->errstr; # commit log message, release mutex
2595           next; # not next CUSTLOOP, want to record error for every cust_payby
2596         }
2597         $dbh->rollback if $oldAutoCommit;
2598         die $error;
2599       }
2600       $dbh->commit or die $dbh->errstr if $opt{'queue'}; # release mutex
2601       warn "TOKENIZED cust_payby ".$cust_payby->get($cust_payby->primary_key) if $debug;
2602     }
2603     warn "cust_payby upgraded for custnum ".$cust_main->custnum if $debug;
2604
2605   }
2606
2607   ### Tokenize/mask transaction tables
2608
2609   # allow tokenization of closed cust_pay/cust_refund records
2610   local $FS::payinfo_Mixin::allow_closed_replace = 1;
2611
2612   # grep assistance:
2613   #   $cust_pay_pending->replace, $cust_pay->replace, $cust_pay_void->replace, $cust_refund->replace all run here
2614   foreach my $table ( qw(cust_pay_pending cust_pay cust_pay_void cust_refund) ) {
2615     warn "Checking $table" if $debug;
2616
2617     # FS::Cursor does not seem to work over multiple commits (gives cursor not found errors)
2618     # loading only record ids, then loading individual records one at a time
2619     my $tclass = 'FS::'.$table;
2620     $offset = 0;
2621     @recnums = ();
2622
2623     while (my $recnum = _token_check_next_recnum($dbh,$table,$step,\$offset,\@recnums)) {
2624       my $record = $tclass->by_key($recnum);
2625       unless ($record->payby eq 'CARD') {
2626         warn "Skipping non-card record for $table ".$record->get($record->primary_key) if $debug;
2627         next;
2628       }
2629       if (FS::cust_main::Billing_Realtime->tokenized($record->payinfo)) {
2630         warn "Skipping tokenized record for $table ".$record->get($record->primary_key) if $debug;
2631         next;
2632       }
2633       if (!$record->payinfo) { #shouldn't happen, but at least it's not a card number
2634         warn "Skipping blank payinfo for $table ".$record->get($record->primary_key) if $debug;
2635         next;
2636       }
2637       if ($record->payinfo =~ /N\/A/) { # ??? Not sure why we do this, but it's not a card number
2638         warn "Skipping NA payinfo for $table ".$record->get($record->primary_key) if $debug;
2639         next;
2640       }
2641
2642       if ($require_tokenized && $opt{'daily'}) {
2643         $log->info("Untokenized card number detected in $table ".$record->get($record->primary_key). ';tokenizing');
2644         $dbh->commit or die $dbh->errstr; # commit log message
2645       }
2646
2647       my $cust_main = $record->cust_main;
2648       if (!$cust_main) {
2649         # might happen for cust_pay_pending from failed verify records,
2650         #   in which case we attempt tokenization without cust_main
2651         # everything else should absolutely have a cust_main
2652         if ($table eq 'cust_pay_pending' and !$record->custnum ) {
2653           # override the usual safety check and allow the record to be
2654           # updated even without a custnum.
2655           $record->set('custnum_pending', 1);
2656         } else {
2657           my $error = "Could not load cust_main for $table ".$record->get($record->primary_key);
2658           if ($opt{'queue'}) {
2659             $hascritical = 1;
2660             $log->critical($error);
2661             $dbh->commit or die $dbh->errstr; # commit log message
2662             next;
2663           }
2664           $dbh->rollback if $oldAutoCommit;
2665           die $error;
2666         }
2667       }
2668
2669       my $gateway;
2670
2671       # use the gatewaynum specified by the record if possible
2672       $gateway = FS::payment_gateway->by_key_with_namespace(
2673         'gatewaynum' => $record->gatewaynum,
2674       ) if $record->gateway;
2675
2676       # otherwise use the cust agent gateway if possible (which realtime_refund_bop would do)
2677       # otherwise just use default gateway
2678       unless ($gateway) {
2679
2680         $gateway = $cust_main 
2681                  ? $cust_main->agent->payment_gateway
2682                  : FS::payment_gateway->default_gateway;
2683
2684         # check for processor mismatch
2685         unless ($table eq 'cust_pay_pending') { # has no processor table
2686           if (my $processor = $record->processor) {
2687
2688             my $conf_processor = $gateway->gateway_module;
2689             my %bop_options = $gateway->gatewaynum
2690                             ? $gateway->options
2691                             : @{ $gateway->get('options') };
2692
2693             # this is the same standard used by realtime_refund_bop
2694             unless (
2695               ($processor eq $conf_processor) ||
2696               (($conf_processor eq 'CardFortress') && ($processor eq $bop_options{'gateway'}))
2697             ) {
2698
2699               # processors don't match, so refund already cannot be run on this object,
2700               # regardless of what we do now...
2701               # but unless we gotta tokenize everything, just leave well enough alone
2702               unless ($require_tokenized) {
2703                 warn "Skipping mismatched processor for $table ".$record->get($record->primary_key) if $debug;
2704                 next;
2705               }
2706               ### no error--we'll tokenize using the new gateway, just to remove stored payinfo,
2707               ### because refunds are already impossible for this record, anyway
2708
2709             } # end processor mismatch
2710
2711           } # end record has processor
2712         } # end not cust_pay_pending
2713
2714       }
2715
2716       # means no default gateway, no promise to tokenize, can skip
2717       unless ($gateway) {
2718         warn "Skipping missing gateway for $table ".$record->get($record->primary_key) if $debug;
2719         next;
2720       }
2721
2722       my $info = _token_check_gateway_info($cache,$gateway);
2723       unless (ref($info)) {
2724         # only throws error if Business::OnlinePayment won't load,
2725         #   which is just cause to abort this whole process, even if queue
2726         $dbh->rollback if $oldAutoCommit;
2727         die $info; # error message
2728       }
2729
2730       # a configured gateway can't tokenize, move along
2731       unless ($info->{'can_tokenize'}) {
2732         warn "Skipping, cannot tokenize $table ".$record->get($record->primary_key) if $debug;
2733         next;
2734       }
2735
2736       warn "ATTEMPTING GATEWAY-ONLY TOKENIZE" if $debug && !$cust_main;
2737
2738       # if we got this far, time to mutex
2739       $record->select_for_update;
2740
2741       # no clear record of name/address/etc used for transaction,
2742       # but will load name/phone/id from customer if run as an object method,
2743       # so we try that if we can
2744       my %tokenopts = (
2745         'payment_gateway' => $gateway,
2746         'method'          => 'CC',
2747         'payinfo'         => $record->payinfo,
2748         'paydate'         => $record->paydate,
2749       );
2750       my $error = $cust_main
2751                 ? $cust_main->realtime_tokenize(\%tokenopts)
2752                 : FS::cust_main::Billing_Realtime->realtime_tokenize(\%tokenopts);
2753       if (FS::cust_main::Billing_Realtime->tokenized($tokenopts{'payinfo'})) { # implies no error
2754         $record->payinfo($tokenopts{'payinfo'});
2755         $error = $record->replace;
2756       } else {
2757         $error ||= 'Unknown error';
2758       }
2759       if ($error) {
2760         $error = "Error tokenizing $table ".$record->get($record->primary_key).": ".$error;
2761         if ($opt{'queue'}) {
2762           $hascritical = 1;
2763           $log->critical($error);
2764           $dbh->commit or die $dbh->errstr; # commit log message, release mutex
2765           next;
2766         }
2767         $dbh->rollback if $oldAutoCommit;
2768         die $error;
2769       }
2770       $dbh->commit or die $dbh->errstr if $opt{'queue'}; # release mutex
2771       warn "TOKENIZED $table ".$record->get($record->primary_key) if $debug;
2772
2773     } # end record loop
2774   } # end table loop
2775
2776   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2777
2778   return $hascritical ? 'Critical errors occurred on some records, see system log' : '';
2779 }
2780
2781 # not a method!
2782 sub _token_check_next_recnum {
2783   my ($dbh,$table,$step,$offset,$recnums) = @_;
2784   my $recnum = shift @$recnums;
2785   return $recnum if $recnum;
2786   my $tclass = 'FS::'.$table;
2787   my $sth = $dbh->prepare(
2788     'SELECT '.$tclass->primary_key.
2789     ' FROM '.$table.
2790     " WHERE ( is_tokenized IS NULL OR is_tokenized = '' ) ".
2791     ' ORDER BY '.$tclass->primary_key.
2792     ' LIMIT '.$step.
2793     ' OFFSET '.$$offset
2794   ) or die $dbh->errstr;
2795   $sth->execute() or die $sth->errstr;
2796   my @recnums;
2797   while (my $rec = $sth->fetchrow_hashref) {
2798     push @$recnums, $rec->{$tclass->primary_key};
2799   }
2800   $sth->finish();
2801   $$offset += $step;
2802   return shift @$recnums;
2803 }
2804
2805 # not a method!
2806 sub _token_check_gateway_info {
2807   my ($cache,$payment_gateway) = @_;
2808
2809   return $cache->{$payment_gateway->gateway_module}
2810     if $cache->{$payment_gateway->gateway_module};
2811
2812   my $info = {};
2813   $cache->{$payment_gateway->gateway_module} = $info;
2814
2815   my $namespace = $payment_gateway->gateway_namespace;
2816   return $info unless $namespace eq 'Business::OnlinePayment';
2817   $info->{'is_bop'} = 1;
2818
2819   # only need to load this once,
2820   # don't want to load if nothing is_bop
2821   unless ($cache->{'Business::OnlinePayment'}) {
2822     eval "use $namespace";  
2823     return "Error initializing Business:OnlinePayment: ".$@ if $@;
2824     $cache->{'Business::OnlinePayment'} = 1;
2825   }
2826
2827   my $transaction = new $namespace( $payment_gateway->gateway_module,
2828                                     _bop_options({ 'payment_gateway' => $payment_gateway }),
2829                                   );
2830
2831   return $info unless $transaction->can('info');
2832   $info->{'can_info'} = 1;
2833
2834   my %supported_actions = $transaction->info('supported_actions');
2835   $info->{'can_tokenize'} = 1
2836     if $supported_actions{'CC'}
2837       && grep /^Tokenize$/, @{$supported_actions{'CC'}};
2838
2839   # not using this any more, but for future reference...
2840   $info->{'void_requires_card'} = 1
2841     if $transaction->info('CC_void_requires_card');
2842
2843   return $info;
2844 }
2845
2846 =back
2847
2848 =head1 BUGS
2849
2850 =head1 SEE ALSO
2851
2852 L<FS::cust_main>, L<FS::cust_main::Billing>
2853
2854 =cut
2855
2856 1;