From a647a499efde720891103f38635638daaf2f212e Mon Sep 17 00:00:00 2001 From: plobbes Date: Mon, 12 Mar 2007 06:12:53 +0000 Subject: [PATCH] - rewrite/updates for new B::OP::PayflowPro using HTTP protocol - no longer use PFProAPI.pm from Verisign/PayPal - now using name-value pair transactions - require: CGI to parse name-value pair responses from server - require: Digest::MD5 to generate (hopefully) unique request_id which is required by PayflowPro HTTP protocol - new methods: request_id(), param(), debug(), expdate_mmyy() - renamed internal methods to start with an underscore - removed unused remap_fields() method - if unable to parse expiration given in %content no longer croak, but let PayflowPro servers attempt to deal with the value as-is - submit() now two phased per PFP HTTP protocol - X-VPS-VIT-CLIENT-CERTIFICATION-ID is required (supposedly this is a temporary requirement from PayPal) - request_id() method will generate a hopefully unique id using Digest::MD5 for use in the X-VPS-REQUEST-ID HTTP header. A 'request_id' key may be passed in %content to specify an ID - path() is not used as the PFP HTTP protocol uses two different URLs (step 1) /transaction, (step 2) /commit - patches to B::OP::HTTPS were required to support needed functionality - debug() sets $Business::OnlinePayment::HTTPS::DEBUG to aid in debugging --- PayflowPro.pm | 347 ++++++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 265 insertions(+), 82 deletions(-) diff --git a/PayflowPro.pm b/PayflowPro.pm index 576aabc..dca45ba 100644 --- a/PayflowPro.pm +++ b/PayflowPro.pm @@ -1,30 +1,104 @@ package Business::OnlinePayment::PayflowPro; use strict; -use vars qw($VERSION); -use Carp qw(croak); -use base qw(Business::OnlinePayment); +use vars qw($VERSION $DEBUG); +use Carp qw(carp croak); +use CGI; +use Digest::MD5; -# Payflow Pro SDK -use PFProAPI qw( pfpro ); +use base qw(Business::OnlinePayment::HTTPS); -$VERSION = '0.06'; +$VERSION = '0.07_01'; $VERSION = eval $VERSION; +$DEBUG = 0; -sub set_defaults { +sub request_id { + my $self = shift; + my $md5 = Digest::MD5->new(); + $md5->add( $$, time(), rand(time) ); + return $md5->hexdigest(); +} + +sub param { my $self = shift; + my @args = @_; - $self->server('payflow.verisign.com'); - $self->port('443'); + $self->{__PARAM} ||= {}; + my $param = $self->{__PARAM}; - $self->build_subs( - qw( - vendor partner cert_path order_number avs_code cvv2_code - ) + if (@args) { + if ( @args % 2 == 0 ) { + %$param = ( %$param, @args ); + } + elsif ( @args == 1 ) { + my $arg = shift; + if ( ref($arg) eq "HASH" ) { + %$param = ( %$param, %$arg ); + return keys %$arg; + } + else { + return $param->{$arg}; + } + } + else { + croak("param: invalid arguments: @_\n"); + } + } + else { + return ( keys %$param ); + } +} + +sub debug { + my $self = shift; + + if (@_) { + my $level = shift || 0; + if ( ref($self) ) { + $self->{"__DEBUG"} = $level; + } + else { + $DEBUG = $level; + } + $Business::OnlinePayment::HTTPS::DEBUG = $level; + } + return ref($self) ? ( $self->{"__DEBUG"} || $DEBUG ) : $DEBUG; +} + +sub cert_path { + carp( __PACKAGE__ . " cert_path method is deprecated" ); + return undef; +} + +# maybe get rid of build_subs() someday and use param()? +sub vendor { my $self = shift; return $self->param( "vendor", @_ ); } +sub partner { my $self = shift; return $self->param( "partner", @_ ); } +sub order_number { + my $self = shift; + return $self->param( "order_number", @_ ); +} +sub avs_code { my $self = shift; return $self->param( "avs_code", @_ ); } +sub cvv2_code { my $self = shift; return $self->param( "cvv2_code", @_ ); } + +sub set_defaults { + my $self = shift; + my %opts = @_; + + $self->server("payflow.verisign.com"); + $self->port("443"); + $self->path(""); # PayflowPro uses /transaction and /commit + if ( $opts{debug} ) { + $self->debug( $opts{debug} ); + delete $opts{debug}; + } + $self->param( + "path_transaction" => "/transaction", + "path_commit" => "/commit", + %opts ); } -sub map_fields { +sub _map_fields { my ($self) = @_; my %content = $self->content(); @@ -48,6 +122,7 @@ sub map_fields { 'american express' => 'C', 'discover' => 'C', 'cc' => 'C', + #'check' => 'ECHECK', ); @@ -59,17 +134,7 @@ sub map_fields { $self->content(%content); } -sub remap_fields { - my ( $self, %map ) = @_; - - my %content = $self->content(); - foreach ( keys %map ) { - $content{ $map{$_} } = $content{$_}; - } - $self->content(%content); -} - -sub revmap_fields { +sub _revmap_fields { my ( $self, %map ) = @_; my %content = $self->content(); foreach ( keys %map ) { @@ -81,51 +146,55 @@ sub revmap_fields { $self->content(%content); } +sub expdate_mmyy { + my $self = shift; + my $expiration = shift; + my $expdate_mmyy; + if ( defined($expiration) and $expiration =~ /^(\d+)\D+\d*(\d{2})$/ ) { + my ( $month, $year ) = ( $1, $2 ); + $expdate_mmyy = sprintf( "%02d", $month ) . $year; + } + return defined($expdate_mmyy) ? $expdate_mmyy : $expiration; +} + sub submit { my ($self) = @_; - $self->map_fields(); + $self->_map_fields(); my %content = $self->content; - my ( $month, $year, $zip ); - if ( $self->transaction_type() ne 'C' ) { croak( "PayflowPro can't (yet?) handle transaction type: " . $self->transaction_type() ); } - if ( defined( $content{'expiration'} ) && length( $content{'expiration'} ) ) - { - $content{'expiration'} =~ /^(\d+)\D+\d*(\d{2})$/ - or croak "unparsable expiration $content{expiration}"; - - ( $month, $year ) = ( $1, $2 ); - $month = '0' . $month if $month =~ /^\d$/; - } - - ( $zip = $content{'zip'} ) =~ s/[^[:alnum:]]//g; - - $self->server('test-payflow.verisign.com') if $self->test_transaction; - - $self->revmap_fields( - - # (BUG?) VENDOR B::OP:PayflowPro < 0.05 backward compatibility. If - # vendor not set use login (although test indicate undef vendor is ok) - VENDOR => $self->vendor ? \( $self->vendor ) : 'login', - PARTNER => \( $self->partner ), - USER => 'login', - PWD => 'password', - TRXTYPE => 'action', - TENDER => 'type', - ORIGID => 'order_number', - COMMENT1 => 'description', - COMMENT2 => 'invoice_number', - - ACCT => 'card_number', - CVV2 => 'cvv2', - EXPDATE => \( $month . $year ), # MM/YY from 'expiration' - AMT => 'amount', + my $expdate_mmyy = $self->expdate_mmyy( $content{"expiration"} ); + my $zip = $content{'zip'}; + $zip =~ s/[^[:alnum:]]//g; + + $self->server('pilot-payflowpro.verisign.com') if $self->test_transaction; + + my $vendor = $self->vendor; + my $partner = $self->partner; + $self->_revmap_fields( + + # BUG?: VENDOR B::OP:PayflowPro < 0.05 backward compatibility. If + # vendor not set use login although test indicate undef vendor is ok + VENDOR => $vendor ? \$vendor : 'login', + PARTNER => \$partner, + USER => 'login', + PWD => 'password', + TRXTYPE => 'action', + TENDER => 'type', + ORIGID => 'order_number', + COMMENT1 => 'description', + COMMENT2 => 'invoice_number', + + ACCT => 'card_number', + CVV2 => 'cvv2', + EXPDATE => \$expdate_mmyy, # MM/YY from 'expiration' + AMT => 'amount', FIRSTNAME => 'first_name', LASTNAME => 'last_name', @@ -135,7 +204,7 @@ sub submit { STREET => 'address', CITY => 'city', STATE => 'state', - ZIP => \$zip, # 'zip' with non-alnums removed + ZIP => \$zip, # 'zip' with non-alnums removed COUNTRY => 'country', ); @@ -148,6 +217,7 @@ sub submit { push @required, qw(ORIGID); } else { + # never get here, we croak above if transaction_type ne 'C' push @required, qw(AMT ACCT EXPDATE); } @@ -163,39 +233,86 @@ sub submit { ) ); - $ENV{'PFPRO_CERT_PATH'} = $self->cert_path; - my ( $response, $resultstr ) = - pfpro( \%params, $self->server, $self->port ); + # get header data, get request_id from %content if defined for ease of use + my %req_headers = %{ $self->param("headers") || {} }; + if ( defined $content{"request_id"} ) { + $req_headers{"X-VPS-REQUEST-ID"} = $content{"request_id"}; + } + unless ( defined( $req_headers{"X-VPS-REQUEST-ID"} ) ) { + $req_headers{"X-VPS-REQUEST-ID"} = $self->request_id(); + } + + my %options = ( + "Content-Type" => "text/namevalue", + "headers" => \%req_headers, + ); + + $self->path( $self->param("path_transaction") ); + my ( $tpage, $tresp, %tresp_headers ) = + $self->https_post( \%options, \%params ); + + $self->param( + "transaction_response" => { + page => $tpage, + response => $tresp, + headers => \%tresp_headers, + }, + ); + + # $tpage should contain name=value[[&name=value]...] pairs + my $cgi = CGI->new("$tpage"); + + if ( $cgi->param("RESULT") eq "0" ) { + my $response_id = $tresp_headers{"X-VPS-RESPONSE-ID"}; + $options{headers}->{"X-VPS-RESPONSE-ID"} = $response_id; + $self->path( $self->param("path_commit") ); + my ( $cpage, $cresp, %cresp_headers ) = + $self->https_post( \%options, \%params ); + $self->param( + "commit_response" => { + page => $cpage, + response => $cresp, + headers => \%cresp_headers, + }, + ); + my $comcgi = CGI->new("$cpage"); + + # merge commit results with transaction + foreach my $p ( $comcgi->param() ) { + $cgi->param( $p => $comcgi->param($p) ); + } + } # AVS and CVS values may be set on success or failure my $avs_code; - if ( exists $response->{AVSADDR} || exists $response->{AVSZIP} ) { - if ( $response->{AVSADDR} eq 'Y' && $response->{AVSZIP} eq 'Y' ) { - $avs_code = 'Y'; + if ( defined $cgi->param("AVSADDR") or defined $cgi->param("AVSZIP") ) { + if ( $cgi->param("AVSADDR") eq "Y" && $cgi->param("AVSZIP") eq "Y" ) { + $avs_code = "Y"; } - elsif ( $response->{AVSADDR} eq 'Y' ) { - $avs_code = 'A'; + elsif ( $cgi->param("AVSADDR") eq "Y" ) { + $avs_code = "A"; } - elsif ( $response->{AVSZIP} eq 'Y' ) { - $avs_code = 'Z'; + elsif ( $cgi->param("AVSZIP") eq "Y" ) { + $avs_code = "Z"; } - elsif ( $response->{AVSADDR} eq 'N' || $response->{AVSZIP} eq 'N' ) { - $avs_code = 'N'; + elsif ( $cgi->param("AVSADDR") eq "N" or $cgi->param("AVSZIP") eq "N" ) + { + $avs_code = "N"; } else { - $avs_code = ''; + $avs_code = ""; } } $self->avs_code($avs_code); - $self->cvv2_code( $response->{'CVV2MATCH'} ); - $self->result_code( $response->{'RESULT'} ); - $self->order_number( $response->{'PNREF'} ); - $self->error_message( $response->{'RESPMSG'} ); - $self->authorization( $response->{'AUTHCODE'} ); + $self->cvv2_code( $cgi->param("CVV2MATCH") ); + $self->result_code( $cgi->param("RESULT") ); + $self->order_number( $cgi->param("PNREF") ); + $self->error_message( $cgi->param("RESPMSG") ); + $self->authorization( $cgi->param("AUTHCODE") ); # RESULT must be an explicit zero, not just numerically equal - if ( $response->{'RESULT'} eq '0' ) { + if ( $cgi->param("RESULT") eq "0" ) { $self->is_success(1); } else { @@ -219,7 +336,6 @@ Business::OnlinePayment::PayflowPro - Payflow Pro backend for Business::OnlinePa 'PayflowPro', 'vendor' => 'your_vendor', 'partner' => 'your_partner', - 'cert_path' => '/path/to/your/certificate/file/', # just the dir ); # See the module documentation for details of content() @@ -271,6 +387,20 @@ via the PayPal's Payflow Pro Internet payment solution. See L for details on the interface this modules supports. +=head1 Standard methods + +=over 4 + +=item set_defaults() + +This method sets the 'server' attribute to 'payflow.verisign.com' and +the port attribute to '443'. This method also sets up the +L described below. + +=item submit() + +=back + =head1 Module specific methods This module provides the following methods which are not currently @@ -282,14 +412,26 @@ part of the standard Business::OnlinePayment interface: =item partner() -=item cert_path() - =item L =item L =item L +=item L + +=item L + +=item L + +=item L + +=item cert_path() + +This method is deprecated and will be removed in the next release. +This method was used to support passing a path to PFProAPI.pm (a Perl +module/SDK from Verisign/Paypal) which is no longer used. + =back =head1 Settings @@ -431,6 +573,47 @@ follows: The cvv2_code() method returns the CVV2MATCH field, which is a response message returned with the transaction result. +=head2 expdate_mmyy() + +The expdate_mmyy() method takes a single scalar argument (typically +the value in $content{expiration}) and attempts to parse and format +and put the date in MMYY format as required by PayflowPro +specification. If unable to parse the expiration date simply leave it +as is and let the PayflowPro system attempt to handle it as-is. + +=head2 request_id() + +The request_id() method uses Digest::MD5 to attempt to generate a +request_id for a transaction. It is recommended that you specify your +own unique request_id for each transaction in %content. A request_id +is REQUIRED by the PayflowPro processor. + +=head2 param() + +The param() method is used to get/set object parameters. The param() +method may be called in several different ways: + +Get the value of 'myparam': + + my $value_or_reference = $self->param('myparam'); + +Get a list of all parameters that exist: + + my @params = $self->param(); + +Set multiple parameters at the same time: + + $self->param( + 'key1' => 'val1', + 'key2' => 'val2', + ); + +=head2 debug() + +Enable or disble debugging. The value specified here will also set +$Business::OnlinePayment::HTTPS::DEBUG in submit() to aid in +troubleshooting problems. + =head1 COMPATIBILITY This module implements an interface to the Payflow Pro Perl API, which -- 2.11.0