use FS::cust_pkg;
use FS::reg_code;
use FS::agent_payment_gateway;
+use FS::payment_gateway;
use FS::TicketSystem;
use FS::Conf;
If I<thirdparty> is set and the I<method> is PAYPAL, the defined paypal
gateway will be returned.
-If I<load_gatewaynum> exists, then either the specified gateway or the
-default gateway will be returned. Agent overrides are ignored, and this can
-safely be called as a class method if this option is specified. Not
-compatible with I<thirdparty>.
-
-Exsisting I<$conf> may be passed for efficiency.
+Exisisting I<$conf> may be passed for efficiency.
=cut
sub payment_gateway {
my ( $self, %options ) = @_;
+ $options{'conf'} ||= new FS::Conf;
my $conf = $options{'conf'};
- $conf ||= new FS::Conf;
if ( $options{thirdparty} ) {
}
}
- my ($override, $payment_gateway);
- if (exists $options{'load_gatewaynum'}) { # no agent overrides if this opt is in use
- if ($options{'load_gatewaynum'}) {
- $payment_gateway = qsearchs('payment_gateway', { gatewaynumnum => $options{'load_gatewaynum'} } );
- # always fatal
- die "Could not load payment gateway ".$options{'load_gatewaynum'} unless $payment_gateway;
- } # else use default, loaded below
- } else {
- $override = qsearchs('agent_payment_gateway', { agentnum => $self->agentnum } );
- }
-
- if ( $override ) { #use a payment gateway override
-
- $payment_gateway = $override->payment_gateway;
-
- $payment_gateway->gateway_namespace('Business::OnlinePayment')
- unless $payment_gateway->gateway_namespace;
-
- } elsif (!$payment_gateway) { #use the standard settings from the config
-
- # the standard settings from the config could be moved to a null agent
- # agent_payment_gateway referenced payment_gateway
-
- # remember, this block might be run as a class method if false load_gatewaynum exists
+ my $override = qsearchs('agent_payment_gateway', { agentnum => $self->agentnum } );
- unless ( $conf->exists('business-onlinepayment') ) {
- if ( $options{'nofatal'} ) {
- return '';
- } else {
- die "Real-time processing not enabled\n";
- }
- }
-
- #load up config
- my $bop_config = 'business-onlinepayment';
- $bop_config .= '-ach'
- if ( $options{method}
- && $options{method} =~ /^(ECHECK|CHEK)$/
- && $conf->exists($bop_config. '-ach')
- );
- my ( $processor, $login, $password, $action, @bop_options ) =
- $conf->config($bop_config);
- $action ||= 'normal authorization';
- pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
- die "No real-time processor is enabled - ".
- "did you set the business-onlinepayment configuration value?\n"
- unless $processor;
-
- $payment_gateway = new FS::payment_gateway;
-
- $payment_gateway->gateway_namespace( $conf->config('business-onlinepayment-namespace') ||
- 'Business::OnlinePayment');
- $payment_gateway->gateway_module($processor);
- $payment_gateway->gateway_username($login);
- $payment_gateway->gateway_password($password);
- $payment_gateway->gateway_action($action);
- $payment_gateway->set('options', [ @bop_options ]);
-
- }
-
- unless ( $payment_gateway->gateway_namespace ) {
- $payment_gateway->gateway_namespace(
- scalar($conf->config('business-onlinepayment-namespace'))
- || 'Business::OnlinePayment'
- );
- }
+ my $payment_gateway = FS::payment_gateway->by_key_or_default(
+ gatewaynum => $override ? $override->gatewaynum : '',
+ %options,
+ );
$payment_gateway;
}
use FS::cust_bill_pay;
use FS::cust_refund;
use FS::banned_pay;
+use FS::payment_gateway;
$realtime_bop_decline_quiet = 0;
'type' => 'CC',
_bop_auth(\%options),
'action' => 'Tokenize',
- 'description' => $options{'description'}
+ 'description' => $options{'description'},
%$bop_content,
%content, #after
);
FS::cust_pay->tokenized($payinfo);
}
-=item token_check
+=item token_check [ quiet => 1, queue => 1, daily => 1 ]
NOT A METHOD. Acts on all customers. Placed here because it makes
use of module-internal methods, and to keep everything that uses
Tokenizes all tokenizable card numbers from payinfo in cust_payby and
CARD transactions in cust_pay_pending, cust_pay, cust_pay_void and cust_refund.
-If all configured gateways have the ability to tokenize, then detection of
-an untokenizable record will cause a fatal error.
+If the I<queue> flag is set, newly tokenized records will be immediately
+committed, regardless of AutoCommit, so as to release the mutex on the record.
+
+If all configured gateways have the ability to tokenize, detection of an
+untokenizable record will cause a fatal error. However, if the I<queue> flag
+is set, this will instead cause a critical error to be recorded in the log,
+and any other tokenizable records will still be committed.
+
+If the I<daily> flag is also set, detection of existing untokenized records will
+record a critical error in the system log (because they should have never appeared
+in the first place.) Tokenization will still be attempted.
+
+If any configured gateways do NOT have the ability to tokenize, or if a
+default gateway is not configured, then untokenized records are not considered
+a threat, and no critical errors will be generated in the log.
=cut
sub token_check {
- # no input, acts on all customers
+ #acts on all customers
+ my %opt = @_;
+ my $debug = !$opt{'quiet'} || $DEBUG;
- eval "use FS::Cursor";
- return "Error initializing FS::Cursor: ".$@ if $@;
+ warn "token_check called with opts\n".Dumper(\%opt) if $debug;
- my $dbh = dbh;
+ # force some explicitness when invoking this method
+ die "token_check must run with queue flag if run with daily flag"
+ if $opt{'daily'} && !$opt{'queue'};
+
+ my $conf = FS::Conf->new;
+
+ my $log = FS::Log->new('FS::cust_main::Billing_Realtime::token_check');
- # get list of all gateways in table (not counting default gateway)
my $cache = {}; #cache for module info
- my $sth = $dbh->prepare('SELECT DISTINCT gatewaynum FROM payment_gateway')
- or die $dbh->errstr;
- $sth->execute or die $sth->errstr;
- my @gatewaynums;
- while (my $row = $sth->fetchrow_hashref) {
- push(@gatewaynums,$row->{'gatewaynum'});
- }
- $sth->finish;
# look for a gateway that can't tokenize
- my $disallow_untokenized = 1;
- foreach my $gatewaynum ('',@gatewaynums) {
- my $gateway = FS::agent->payment_gateway( load_gatewaynum => $gatewaynum, nofatal => 1 );
- if (!$gateway) { # already died if $gatewaynum
+ my $require_tokenized = 1;
+ foreach my $gateway (
+ FS::payment_gateway->all_gateways(
+ 'method' => 'CC',
+ 'conf' => $conf,
+ 'nofatal' => 1,
+ )
+ ) {
+ if (!$gateway) {
# no default gateway, no promise to tokenize
# can just load other gateways as-needeed below
- $disallow_untokenized = 0;
+ $require_tokenized = 0;
last;
}
my $info = _token_check_gateway_info($cache,$gateway);
- return $info unless ref($info); # means it's an error message
+ die $info unless ref($info); # means it's an error message
unless ($info->{'can_tokenize'}) {
# a configured gateway can't tokenize, that's all we need to know right now
# can just load other gateways as-needeed below
- $disallow_untokenized = 0;
+ $require_tokenized = 0;
last;
}
}
+ warn "REQUIRE TOKENIZED" if $require_tokenized && $debug;
+
+ # upgrade does not call this with autocommit turned on,
+ # and autocommit will be ignored if opt queue is set,
+ # but might as well be thorough...
my $oldAutoCommit = $FS::UID::AutoCommit;
local $FS::UID::AutoCommit = 0;
+ my $dbh = dbh;
+
+ # for retrieving data in chunks
+ my $step = 500;
+ my $offset = 0;
### Tokenize cust_payby
- my $cust_search = FS::Cursor->new({ table => 'cust_main' },$dbh);
- while (my $cust_main = $cust_search->fetch) {
+ my @recnums;
+
+CUSTLOOP:
+ while (my $custnum = _token_check_next_recnum($dbh,'cust_main',$step,\$offset,\@recnums)) {
+ my $cust_main = FS::cust_main->by_key($custnum);
+ my $payment_gateway;
foreach my $cust_payby ($cust_main->cust_payby('CARD','DCRD')) {
- next if $cust_payby->tokenized;
- # load gateway first, just so we can cache it
- my $payment_gateway = $cust_main->_payment_gateway({
- 'nofatal' => 1, # handle error smoothly below
+
+ # see if it's already tokenized
+ if ($cust_payby->tokenized) {
+ warn "cust_payby ".$cust_payby->get($cust_payby->primary_key)." already tokenized" if $debug;
+ next;
+ }
+
+ if ($require_tokenized && $opt{'daily'}) {
+ $log->critical("Untokenized card number detected in cust_payby ".$cust_payby->custpaybynum);
+ $dbh->commit or die $dbh->errstr; # commit log message
+ }
+
+ # only load gateway if we need to, and only need to load it once
+ my $payment_gateway ||= $cust_main->_payment_gateway({
+ 'method' => 'CC',
+ 'conf' => $conf,
+ 'nofatal' => 1, # handle lack of gateway smoothly below
});
unless ($payment_gateway) {
# no reason to have untokenized card numbers saved if no gateway,
- # but only fatal if we expected everyone to tokenize card numbers
- next unless $disallow_untokenized;
- $cust_search->DESTROY;
+ # but only a problem if we expected everyone to tokenize card numbers
+ unless ($require_tokenized) {
+ warn "Skipping cust_payby for cust_main ".$cust_main->custnum.", no payment gateway" if $debug;
+ next CUSTLOOP; # can skip rest of customer
+ }
+ my $error = "No gateway found for custnum ".$cust_main->custnum;
+ if ($opt{'queue'}) {
+ $log->critical($error);
+ $dbh->commit or die $dbh->errstr; # commit error message
+ next; # not next CUSTLOOP, want to record error for every cust_payby
+ }
$dbh->rollback if $oldAutoCommit;
- return "No gateway found for custnum ".$cust_main->custnum;
+ die $error;
}
+
my $info = _token_check_gateway_info($cache,$payment_gateway);
+ unless (ref($info)) {
+ # only throws error if Business::OnlinePayment won't load,
+ # which is just cause to abort this whole process, even if queue
+ $dbh->rollback if $oldAutoCommit;
+ die $info; # error message
+ }
# no fail here--a configured gateway can't tokenize, so be it
- next unless ref($info) && $info->{'can_tokenize'};
+ unless ($info->{'can_tokenize'}) {
+ warn "Skipping ".$cust_main->custnum." cannot tokenize" if $debug;
+ next;
+ }
+
+ # time to tokenize
+ $cust_payby = $cust_payby->select_for_update;
my %tokenopts = (
'payment_gateway' => $payment_gateway,
'cust_payby' => $cust_payby,
$error ||= 'Unknown error';
}
if ($error) {
- $cust_search->DESTROY;
+ $error = "Error tokenizing cust_payby ".$cust_payby->custpaybynum.": ".$error;
+ if ($opt{'queue'}) {
+ $log->critical($error);
+ $dbh->commit or die $dbh->errstr; # commit log message, release mutex
+ next; # not next CUSTLOOP, want to record error for every cust_payby
+ }
$dbh->rollback if $oldAutoCommit;
- return "Error tokenizing cust_payby ".$cust_payby->custpaybynum.": ".$error;
+ die $error;
}
+ $dbh->commit or die $dbh->errstr if $opt{'queue'}; # release mutex
+ warn "TOKENIZED cust_payby ".$cust_payby->get($cust_payby->primary_key) if $debug;
}
+ warn "cust_payby upgraded for custnum ".$cust_main->custnum if $debug;
+
}
### Tokenize/mask transaction tables
# grep assistance:
# $cust_pay_pending->replace, $cust_pay->replace, $cust_pay_void->replace, $cust_refund->replace all run here
foreach my $table ( qw(cust_pay_pending cust_pay cust_pay_void cust_refund) ) {
- my $search = FS::Cursor->new({
- table => $table,
- hashref => { 'payby' => 'CARD' },
- },$dbh);
- while (my $record = $search->fetch) {
- next if $record->tokenized;
- next if !$record->payinfo; #shouldn't happen, but at least it's not a card number
- next if $record->payinfo =~ /N\/A/; # ??? Not sure why we do this, but it's not a card number
+ warn "Checking $table" if $debug;
+
+ # FS::Cursor does not seem to work over multiple commits (gives cursor not found errors)
+ # loading only record ids, then loading individual records one at a time
+ my $tclass = 'FS::'.$table;
+ $offset = 0;
+ @recnums = ();
+
+ while (my $recnum = _token_check_next_recnum($dbh,$table,$step,\$offset,\@recnums)) {
+ my $record = $tclass->by_key($recnum);
+ if (FS::cust_main::Billing_Realtime->tokenized($record->payinfo)) {
+ warn "Skipping tokenized record for $table ".$record->get($record->primary_key) if $debug;
+ next;
+ }
+ if (!$record->payinfo) { #shouldn't happen, but at least it's not a card number
+ warn "Skipping blank payinfo for $table ".$record->get($record->primary_key) if $debug;
+ next;
+ }
+ if ($record->payinfo =~ /N\/A/) { # ??? Not sure why we do this, but it's not a card number
+ warn "Skipping NA payinfo for $table ".$record->get($record->primary_key) if $debug;
+ next;
+ }
+
+ if ($require_tokenized && $opt{'daily'}) {
+ $log->critical("Untokenized card number detected in $table ".$record->get($record->primary_key));
+ $dbh->commit or die $dbh->errstr; # commit log message
+ }
# don't use customer agent gateway here, use the gatewaynum specified by the record
- my $gatewaynum = $record->gatewaynum || '';
- my $gateway = FS::agent->payment_gateway( load_gatewaynum => $gatewaynum );
- unless ($gateway) { # already died if $gatewaynum
- # only fatal if we expected everyone to tokenize
- next unless $disallow_untokenized;
- $search->DESTROY;
- $dbh->rollback if $oldAutoCommit;
- return "No gateway found for $table ".$record->get($record->primary_key);
+ my $gateway = FS::payment_gateway->by_key_or_default(
+ 'method' => 'CC',
+ 'conf' => $conf,
+ 'nofatal' => 1,
+ 'gatewaynum' => $record->gatewaynum || '',
+ );
+ unless ($gateway) {
+ # means no default gateway, no promise to tokenize, can skip
+ warn "Skipping missing gateway for $table ".$record->get($record->primary_key) if $debug;
+ next;
}
+
my $info = _token_check_gateway_info($cache,$gateway);
unless (ref($info)) {
# only throws error if Business::OnlinePayment won't load,
- # which is just cause to abort this whole process
- $search->DESTROY;
+ # which is just cause to abort this whole process, even if queue
$dbh->rollback if $oldAutoCommit;
- return $info; # error message
+ die $info; # error message
}
# a configured gateway can't tokenize, move along
- next unless $info->{'can_tokenize'};
+ unless ($info->{'can_tokenize'}) {
+ warn "Skipping, cannot tokenize $table ".$record->get($record->primary_key) if $debug;
+ next;
+ }
my $cust_main = $record->cust_main;
- unless ($cust_main || (
+ if (!$cust_main) {
# might happen for cust_pay_pending from failed verify records,
# in which case we attempt tokenization without cust_main
# everything else should absolutely have a cust_main
- $table eq 'cust_pay_pending'
- && $record->{'custnum_pending'}
- && !$disallow_untokenized
- )) {
- $search->DESTROY;
- $dbh->rollback if $oldAutoCommit;
- return "Could not load cust_main for $table ".$record->get($record->primary_key);
+ if ($table eq 'cust_pay_pending' && $record->{'custnum_pending'}) {
+ warn "ATTEMPTING GATEWAY-ONLY TOKENIZE" if $debug;
+ } else {
+ my $error = "Could not load cust_main for $table ".$record->get($record->primary_key);
+ if ($opt{'queue'}) {
+ $log->critical($error);
+ $dbh->commit or die $dbh->errstr; # commit log message
+ next;
+ }
+ $dbh->rollback if $oldAutoCommit;
+ die $error;
+ }
}
+
+ # if we got this far, time to mutex
+ $record = $record->select_for_update;
+
# no clear record of name/address/etc used for transaction,
# but will load name/phone/id from customer if run as an object method,
# so we try that if we can
$error ||= 'Unknown error';
}
if ($error) {
- $search->DESTROY;
+ $error = "Error tokenizing $table ".$record->get($record->primary_key).": ".$error;
+ if ($opt{'queue'}) {
+ $log->critical($error);
+ $dbh->commit or die $dbh->errstr; # commit log message, release mutex
+ next;
+ }
$dbh->rollback if $oldAutoCommit;
- return "Error tokenizing $table ".$record->get($record->primary_key).": ".$error;
+ die $error;
}
+ $dbh->commit or die $dbh->errstr if $opt{'queue'}; # release mutex
+ warn "TOKENIZED $table ".$record->get($record->primary_key) if $debug;
+
} # end record loop
} # end table loop
- $dbh->commit if $oldAutoCommit;
+ $dbh->commit or die $dbh->errstr if $oldAutoCommit;
return '';
}
# not a method!
+sub _token_check_next_recnum {
+ my ($dbh,$table,$step,$offset,$recnums) = @_;
+ my $recnum = shift @$recnums;
+ return $recnum if $recnum;
+ my $tclass = 'FS::'.$table;
+ my $sth = $dbh->prepare('SELECT '.$tclass->primary_key.' FROM '.$table.' ORDER BY '.$tclass->primary_key.' LIMIT '.$step.' OFFSET '.$$offset) or die $dbh->errstr;
+ $sth->execute() or die $sth->errstr;
+ my @recnums;
+ while (my $rec = $sth->fetchrow_hashref) {
+ push @$recnums, $rec->{$tclass->primary_key};
+ }
+ $sth->finish();
+ $$offset += $step;
+ return shift @$recnums;
+}
+
+# not a method!
sub _token_check_gateway_info {
my ($cache,$payment_gateway) = @_;
$info->{'void_requires_card'} = 1
if $transaction->info('CC_void_requires_card');
- $cache->{$payment_gateway->gateway_module} = $info;
-
return $info;
}
}
}
+=item default_gateway OPTIONS
+
+Class method.
+
+Returns default gateway (from business-onlinepayment conf) as a payment_gateway object.
+
+Accepts options
+
+conf - existing conf object
+
+nofatal - return blank instead of dying if no default gateway is configured
+
+method - if set to CHEK or ECHECK, returns object for business-onlinepayment-ach if available
+
+Before using this, be sure you wouldn't rather be using L</by_key_or_default> or,
+more likely, L<FS::agent/payment_gateway>.
+
+=cut
+
+# the standard settings from the config could be moved to a null agent
+# agent_payment_gateway referenced payment_gateway
+
+sub default_gateway {
+ my ($self,%options) = @_;
+
+ $options{'conf'} ||= new FS::Conf;
+ my $conf = $options{'conf'};
+
+ unless ( $conf->exists('business-onlinepayment') ) {
+ if ( $options{'nofatal'} ) {
+ return '';
+ } else {
+ die "Real-time processing not enabled\n";
+ }
+ }
+
+ #load up config
+ my $bop_config = 'business-onlinepayment';
+ $bop_config .= '-ach'
+ if ( $options{method}
+ && $options{method} =~ /^(ECHECK|CHEK)$/
+ && $conf->exists($bop_config. '-ach')
+ );
+ my ( $processor, $login, $password, $action, @bop_options ) =
+ $conf->config($bop_config);
+ $action ||= 'normal authorization';
+ pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
+ die "No real-time processor is enabled - ".
+ "did you set the business-onlinepayment configuration value?\n"
+ unless $processor;
+
+ my $payment_gateway = new FS::payment_gateway;
+ $payment_gateway->gateway_namespace( $conf->config('business-onlinepayment-namespace') ||
+ 'Business::OnlinePayment');
+ $payment_gateway->gateway_module($processor);
+ $payment_gateway->gateway_username($login);
+ $payment_gateway->gateway_password($password);
+ $payment_gateway->gateway_action($action);
+ $payment_gateway->set('options', [ @bop_options ]);
+ return $payment_gateway;
+}
+
+=item by_key_or_default OPTIONS
+
+Either returns the gateway specified by option gatewaynum, or the default gateway.
+
+Accepts the same options as L</default_gateway>.
+
+Also ensures that the gateway_namespace has been set.
+
+=cut
+
+sub by_key_or_default {
+ my ($self,%options) = @_;
+
+ if ($options{'gatewaynum'}) {
+ my $payment_gateway = $self->by_key($options{'gatewaynum'});
+ # regardless of nofatal, which is only meant for handling lack of default gateway
+ die "payment_gateway ".$options{'gatewaynum'}." not found"
+ unless $payment_gateway;
+ $payment_gateway->gateway_namespace('Business::OnlinePayment')
+ unless $payment_gateway->gateway_namespace;
+ return $payment_gateway;
+ } else {
+ return $self->default_gateway(%options);
+ }
+}
+
+# if it weren't for the way gateway_namespace default is set, this method would not be necessary
+# that should really go in check() with an accompanying upgrade, so we could just use qsearch safely,
+# but currently short on time to test deeper changes...
+#
+# if no default gateway is set and nofatal is passed, first value returned is blank string
+sub all_gateways {
+ my ($self,%options) = @_;
+ my @out;
+ foreach my $gatewaynum ('',( map {$_->gatewaynum} qsearch('payment_gateway') )) {
+ push @out, $self->by_key_or_default( %options, gatewaynum => $gatewaynum );
+ }
+ return @out;
+}
+
# _upgrade_data
#
# Used by FS::Upgrade to migrate to a new database.
projects / freeside.git / commitdiff