package FS::payment_gateway;
use strict;
-use vars qw( @ISA );
+use vars qw( @ISA $me $DEBUG );
use FS::Record qw( qsearch qsearchs dbh );
use FS::option_Common;
use FS::agent_payment_gateway;
@ISA = qw( FS::option_Common );
+$me = '[ FS::payment_gateway ]';
+$DEBUG=0;
=head1 NAME
=item gatewaynum - primary key
-=item gateway_module - Business::OnlinePayment:: module name
+=item gateway_namespace - Business::OnlinePayment, Business::OnlineThirdPartyPayment, or Business::BatchPayment
+
+=item gateway_module - Business::OnlinePayment:: (or other) module name
=item gateway_username - payment gateway username
=item disabled - Disabled flag, empty or 'Y'
+=item gateway_callback_url - For ThirdPartyPayment only, set to the URL that
+the user should be redirected to on a successful payment. This will be sent
+as a transaction parameter named "return_url".
+
+=item gateway_cancel_url - For ThirdPartyPayment only, set to the URL that
+the user should be redirected to if they cancel the transaction. This will
+be sent as a transaction parameter named "cancel_url".
+
+=item auto_resolve_status - For BatchPayment only, set to 'approve' to
+auto-approve unresolved payments after some number of days, 'reject' to
+auto-decline them, or null to do nothing.
+
+=item auto_resolve_days - For BatchPayment, the number of days to wait before
+auto-resolving the batch.
+
=back
=head1 METHODS
my $error =
$self->ut_numbern('gatewaynum')
|| $self->ut_alpha('gateway_module')
+ || $self->ut_enum('gateway_namespace', ['Business::OnlinePayment',
+ 'Business::OnlineThirdPartyPayment',
+ 'Business::BatchPayment',
+ ] )
|| $self->ut_textn('gateway_username')
|| $self->ut_anything('gateway_password')
+ || $self->ut_textn('gateway_callback_url') # a bit too permissive
+ || $self->ut_textn('gateway_cancel_url')
|| $self->ut_enum('disabled', [ '', 'Y' ] )
+ || $self->ut_enum('auto_resolve_status', [ '', 'approve', 'reject' ])
+ || $self->ut_numbern('auto_resolve_days')
#|| $self->ut_textn('gateway_action')
;
return $error if $error;
- if ( $self->gateway_action ) {
+ if ( $self->gateway_namespace eq 'Business::BatchPayment' ) {
+ $self->gateway_action('Payment');
+ } elsif ( $self->gateway_action ) {
my @actions = split(/,\s*/, $self->gateway_action);
$self->gateway_action(
join( ',', map { /^(Normal Authorization|Authorization Only|Credit|Post Authorization)$/
$self->gateway_action('Normal Authorization');
}
+ # this little kludge mimics FS::CGI::popurl
+ #$self->gateway_callback_url($self->gateway_callback_url. '/')
+ # if ( $self->gateway_callback_url && $self->gateway_callback_url !~ /\/$/ );
+
$self->SUPER::check;
}
}
+=item label
+
+Returns a semi-friendly label for the gateway.
+
+=cut
+
+sub label {
+ my $self = shift;
+ $self->gatewaynum . ': ' .
+ ($self->gateway_username ? $self->gateway_username . '@' : '') .
+ $self->gateway_module
+}
+
+=item namespace_description
+
+returns a friendly name for the namespace
+
+=cut
+
+my %namespace2description = (
+ '' => 'Direct',
+ 'Business::OnlinePayment' => 'Direct',
+ 'Business::OnlineThirdPartyPayment' => 'Hosted',
+ 'Business::BatchPayment' => 'Batch',
+);
+
+sub namespace_description {
+ $namespace2description{shift->gateway_namespace} || 'Unknown';
+}
+
+=item batch_processor OPTIONS
+
+For BatchPayment gateways only. Returns a
+L<Business::BatchPayment::Processor> object to communicate with the
+gateway.
+
+OPTIONS will be passed to the constructor, along with any gateway
+options in the database for this L<FS::payment_gateway>. Useful things
+to include there may include 'input' and 'output' (to direct transport
+to files), 'debug', and 'test_mode'.
+
+If the global 'business-batchpayment-test_transaction' flag is set,
+'test_mode' will be forced on, and gateways that don't support test
+mode will be disabled.
+
+=cut
+
+sub batch_processor {
+ local $@;
+ my $self = shift;
+ my %opt = @_;
+ my $batch = $opt{batch};
+ my $output = $opt{output};
+ die 'gateway '.$self->gatewaynum.' is not a Business::BatchPayment gateway'
+ unless $self->gateway_namespace eq 'Business::BatchPayment';
+ eval "use Business::BatchPayment;";
+ die "couldn't load Business::BatchPayment: $@" if $@;
+
+ my $module = $self->gateway_module;
+ my $processor = eval {
+ Business::BatchPayment->create($module, $self->options, %opt)
+ };
+ die "failed to create Business::BatchPayment::$module object: $@"
+ if $@;
+
+ die "$module does not support test mode"
+ if $opt{'test_mode'}
+ and not $processor->does('Business::BatchPayment::TestMode');
+
+ return $processor;
+}
+
+=item processor OPTIONS
+
+Loads the module for the processor and returns an instance of it.
+
+=cut
+
+sub processor {
+ local $@;
+ my $self = shift;
+ my %opt = @_;
+ foreach (qw(action username password)) {
+ if (length($self->get("gateway_$_"))) {
+ $opt{$_} = $self->get("gateway_$_");
+ }
+ }
+ $opt{'return_url'} = $self->gateway_callback_url;
+ $opt{'cancel_url'} = $self->gateway_cancel_url;
+
+ my $conf = new FS::Conf;
+ my $test_mode = $conf->exists('business-batchpayment-test_transaction');
+ $opt{'test_mode'} = 1 if $test_mode;
+
+ my $namespace = $self->gateway_namespace;
+ eval "use $namespace";
+ die "couldn't load $namespace: $@" if $@;
+
+ if ( $namespace eq 'Business::BatchPayment' ) {
+ # at some point we can merge these, but there's enough special behavior...
+ return $self->batch_processor(%opt);
+ } else {
+ return $namespace->new( $self->gateway_module, $self->options, %opt );
+ }
+}
+
+# _upgrade_data
+#
+# Used by FS::Upgrade to migrate to a new database.
+#
+#
+
+sub _upgrade_data {
+ my ($class, %opts) = @_;
+ my $dbh = dbh;
+
+ warn "$me upgrading $class\n" if $DEBUG;
+
+ foreach ( qsearch( 'payment_gateway', { 'gateway_namespace' => '' } ) ) {
+ $_->gateway_namespace('Business::OnlinePayment'); #defaulting
+ my $error = $_->replace;
+ die "$class had error during upgrade replacement: $error" if $error;
+ }
+}
+
=back
=head1 BUGS
projects / freeside.git / blobdiff