CRM/Core/Payment/PayflowPro.php

   1 <?php
   2 /*
   3    +----------------------------------------------------------------------------+
   4    | Payflow Pro Core Payment Module for CiviCRM version 5                      |
   5    +----------------------------------------------------------------------------+
   6    | Licensed to CiviCRM under the Academic Free License version 3.0            |
   7    |                                                                            |
   8    | Written & Contributed by Eileen McNaughton - 2009                          |
   9    +---------------------------------------------------------------------------+
  10   */
  11
  12 /**
  13  * Class CRM_Core_Payment_PayflowPro.
  14  */
  15 class CRM_Core_Payment_PayflowPro extends CRM_Core_Payment {
  16   // (not used, implicit in the API, might need to convert?)
  17   const
  18     CHARSET = 'UFT-8';
  19
  20   /**
  21    * We only need one instance of this object. So we use the singleton
  22    * pattern and cache the instance in this variable
  23    *
  24    * @var object
  25    */
  26   static private $_singleton = NULL;
  27
  28   /**
  29    * Constructor
  30    *
  31    * @param string $mode
  32    *   The mode of operation: live or test.
  33    * @param $paymentProcessor
  34    */
  35   public function __construct($mode, &$paymentProcessor) {
  36     // live or test
  37     $this->_mode = $mode;
  38     $this->_paymentProcessor = $paymentProcessor;
  39     $this->_processorName = ts('Payflow Pro');
  40   }
  41
  42   /*
  43    * This function  sends request and receives response from
  44    * the processor. It is the main function for processing on-server
  45    * credit card transactions
  46    */
  47   /**
  48    * This function collects all the information from a web/api form and invokes
  49    * the relevant payment processor specific functions to perform the transaction
  50    *
  51    * @param array $params
  52    *   Assoc array of input parameters for this transaction.
  53    *
  54    * @return array
  55    *   the result in an nice formatted array (or an error object)
  56    * @abstract
  57    */
  58   public function doDirectPayment(&$params) {
  59     if (!defined('CURLOPT_SSLCERT')) {
  60       CRM_Core_Error::fatal(ts('Payflow Pro requires curl with SSL support'));
  61     }
  62
  63     /*
  64      * define variables for connecting with the gateway
  65      */
  66
  67     // Are you using the Payflow Fraud Protection Service?
  68     // Default is YES, change to NO or blank if not.
  69     //This has not been investigated as part of writing this payment processor
  70     $fraud = 'NO';
  71     //if you have not set up a separate user account the vendor name is used as the username
  72     if (!$this->_paymentProcessor['subject']) {
  73       $user = $this->_paymentProcessor['user_name'];
  74     }
  75     else {
  76       $user = $this->_paymentProcessor['subject'];
  77     }
  78
  79     // ideally this id would be passed through into this class as
  80     // part of the paymentProcessor
  81     //object with the other variables. It seems inefficient to re-query to get it.
  82     //$params['processor_id'] = CRM_Core_DAO::getFieldValue(
  83     // 'CRM_Contribute_DAO_ContributionP
  84     //age',$params['contributionPageID'],  'payment_processor_id' );
  85
  86     /*
  87      *Create the array of variables to be sent to the processor from the $params array
  88      * passed into this function
  89      *
  90      */
  91
  92     $payflow_query_array = array(
  93       'USER' => $user,
  94       'VENDOR' => $this->_paymentProcessor['user_name'],
  95       'PARTNER' => $this->_paymentProcessor['signature'],
  96       'PWD' => $this->_paymentProcessor['password'],
  97       // C - Direct Payment using credit card
  98       'TENDER' => 'C',
  99       // A - Authorization, S - Sale
 100       'TRXTYPE' => 'S',
 101       'ACCT' => urlencode($params['credit_card_number']),
 102       'CVV2' => $params['cvv2'],
 103       'EXPDATE' => urlencode(sprintf('%02d', (int) $params['month']) . substr($params['year'], 2, 2)),
 104       'ACCTTYPE' => urlencode($params['credit_card_type']),
 105       'AMT' => urlencode($this->getAmount($params)),
 106       'CURRENCY' => urlencode($params['currency']),
 107       'FIRSTNAME' => $params['billing_first_name'],
 108       //credit card name
 109       'LASTNAME' => $params['billing_last_name'],
 110       //credit card name
 111       'STREET' => $params['street_address'],
 112       'CITY' => urlencode($params['city']),
 113       'STATE' => urlencode($params['state_province']),
 114       'ZIP' => urlencode($params['postal_code']),
 115       'COUNTRY' => urlencode($params['country']),
 116       'EMAIL' => $params['email'],
 117       'CUSTIP' => urlencode($params['ip_address']),
 118       'COMMENT1' => urlencode($params['contributionType_accounting_code']),
 119       'COMMENT2' => $mode,
 120       'INVNUM' => urlencode($params['invoiceID']),
 121       'ORDERDESC' => urlencode($params['description']),
 122       'VERBOSITY' => 'MEDIUM',
 123       'BILLTOCOUNTRY' => urlencode($params['country']),
 124     );
 125
 126     if ($params['installments'] == 1) {
 127       $params['is_recur'] = FALSE;
 128     }
 129
 130     if ($params['is_recur'] == TRUE) {
 131
 132       $payflow_query_array['TRXTYPE'] = 'R';
 133       $payflow_query_array['OPTIONALTRX'] = 'S';
 134       $payflow_query_array['OPTIONALTRXAMT'] = $this->getAmount($params);
 135       //Amount of the initial Transaction. Required
 136       $payflow_query_array['ACTION'] = 'A';
 137       //A for add recurring (M-modify,C-cancel,R-reactivate,I-inquiry,P-payment
 138       $payflow_query_array['PROFILENAME'] = urlencode('RegularContribution');
 139       //A for add recurring (M-modify,C-cancel,R-reactivate,I-inquiry,P-payment
 140       if ($params['installments'] > 0) {
 141         $payflow_query_array['TERM'] = $params['installments'] - 1;
 142         //ie. in addition to the one happening with this transaction
 143       }
 144       // $payflow_query_array['COMPANYNAME']
 145       // $payflow_query_array['DESC']  =  not set yet  Optional
 146       // description of the goods or
 147       //services being purchased.
 148       //This parameter applies only for ACH_CCD accounts.
 149       // The
 150       // $payflow_query_array['MAXFAILPAYMENTS']   = 0;
 151       // number of payment periods (as s
 152       //pecified by PAYPERIOD) for which the transaction is allowed
 153       //to fail before PayPal cancels a profile.  the default
 154       // value of 0 (zero) specifies no
 155       //limit. Retry
 156       //attempts occur until the term is complete.
 157       // $payflow_query_array['RETRYNUMDAYS'] = (not set as can't assume business rule
 158
 159       switch ($params['frequency_unit']) {
 160         case '1 week':
 161           $params['next_sched_contribution_date'] = mktime(0, 0, 0, date("m"), date("d") + 7,
 162             date("Y")
 163           );
 164           $params['end_date'] = mktime(0, 0, 0, date("m"), date("d") + (7 * $payflow_query_array['TERM']),
 165             date("Y")
 166           );
 167           $payflow_query_array['START'] = date('mdY', $params['next_sched_contribution_date']);
 168           $payflow_query_array['PAYPERIOD'] = "WEEK";
 169           $params['frequency_unit'] = "week";
 170           $params['frequency_interval'] = 1;
 171           break;
 172
 173         case '2 weeks':
 174           $params['next_sched_contribution_date'] = mktime(0, 0, 0, date("m"), date("d") + 14, date("Y"));
 175           $params['end_date'] = mktime(0, 0, 0, date("m"), date("d") + (14 * $payflow_query_array['TERM']), date("Y ")
 176           );
 177           $payflow_query_array['START'] = date('mdY', $params['next_sched_contribution_date']);
 178           $payflow_query_array['PAYPERIOD'] = "BIWK";
 179           $params['frequency_unit'] = "week";
 180           $params['frequency_interval'] = 2;
 181           break;
 182
 183         case '4 weeks':
 184           $params['next_sched_contribution_date'] = mktime(0, 0, 0, date("m"), date("d") + 28, date("Y")
 185           );
 186           $params['end_date'] = mktime(0, 0, 0, date("m"), date("d") + (28 * $payflow_query_array['TERM']), date("Y")
 187           );
 188           $payflow_query_array['START'] = date('mdY', $params['next_sched_contribution_date']);
 189           $payflow_query_array['PAYPERIOD'] = "FRWK";
 190           $params['frequency_unit'] = "week";
 191           $params['frequency_interval'] = 4;
 192           break;
 193
 194         case '1 month':
 195           $params['next_sched_contribution_date'] = mktime(0, 0, 0, date("m") + 1,
 196             date("d"), date("Y")
 197           );
 198           $params['end_date'] = mktime(0, 0, 0, date("m") +
 199             (1 * $payflow_query_array['TERM']),
 200             date("d"), date("Y")
 201           );
 202           $payflow_query_array['START'] = date('mdY', $params['next_sched_contribution_date']);
 203           $payflow_query_array['PAYPERIOD'] = "MONT";
 204           $params['frequency_unit'] = "month";
 205           $params['frequency_interval'] = 1;
 206           break;
 207
 208         case '3 months':
 209           $params['next_sched_contribution_date'] = mktime(0, 0, 0, date("m") + 3, date("d"), date("Y")
 210           );
 211           $params['end_date'] = mktime(0, 0, 0, date("m") +
 212             (3 * $payflow_query_array['TERM']),
 213             date("d"), date("Y")
 214           );
 215           $payflow_query_array['START'] = date('mdY', $params['next_sched_contribution_date']);
 216           $payflow_query_array['PAYPERIOD'] = "QTER";
 217           $params['frequency_unit'] = "month";
 218           $params['frequency_interval'] = 3;
 219           break;
 220
 221         case '6 months':
 222           $params['next_sched_contribution_date'] = mktime(0, 0, 0, date("m") + 6, date("d"),
 223             date("Y")
 224           );
 225           $params['end_date'] = mktime(0, 0, 0, date("m") +
 226             (6 * $payflow_query_array['TERM']),
 227             date("d"), date("Y")
 228           );
 229           $payflow_query_array['START'] = date('mdY', $params['next_sched_contribution_date']
 230           );
 231           $payflow_query_array['PAYPERIOD'] = "SMYR";
 232           $params['frequency_unit'] = "month";
 233           $params['frequency_interval'] = 6;
 234           break;
 235
 236         case '1 year':
 237           $params['next_sched_contribution_date'] = mktime(0, 0, 0, date("m"), date("d"),
 238             date("Y") + 1
 239           );
 240           $params['end_date'] = mktime(0, 0, 0, date("m"), date("d"),
 241             date("Y") +
 242             (1 * $payflow_query_array['TEM'])
 243           );
 244           $payflow_query_array['START'] = date('mdY', $params['next_sched_contribution_date']);
 245           $payflow_query_array['PAYPERIOD'] = "YEAR";
 246           $params['frequency_unit'] = "year";
 247           $params['frequency_interval'] = 1;
 248           break;
 249       }
 250     }
 251
 252     CRM_Utils_Hook::alterPaymentProcessorParams($this, $params, $payflow_query_array);
 253     $payflow_query = $this->convert_to_nvp($payflow_query_array);
 254
 255     /*
 256      * Check to see if we have a duplicate before we send
 257      */
 258     if ($this->checkDupe($params['invoiceID'], CRM_Utils_Array::value('contributionID', $params))) {
 259       return self::errorExit(9003, 'It appears that this transaction is a duplicate.  Have you already submitted the form once?  If so there may have been a connection problem.  Check your email for a receipt.  If you do not receive a receipt within 2 hours you can try your transaction again.  If you continue to have problems please contact the site administrator.');
 260     }
 261
 262     // ie. url at payment processor to submit to.
 263     $submiturl = $this->_paymentProcessor['url_site'];
 264
 265     $responseData = self::submit_transaction($submiturl, $payflow_query);
 266
 267     /*
 268      * Payment successfully sent to gateway - process the response now
 269      */
 270     $result = strstr($responseData, "RESULT");
 271     if (empty($result)) {
 272       return self::errorExit(9016, "No RESULT code from PayPal.");
 273     }
 274
 275     $nvpArray = array();
 276     while (strlen($result)) {
 277       // name
 278       $keypos = strpos($result, '=');
 279       $keyval = substr($result, 0, $keypos);
 280       // value
 281       $valuepos = strpos($result, '&') ? strpos($result, '&') : strlen($result);
 282       $valval = substr($result, $keypos + 1, $valuepos - $keypos - 1);
 283       // decoding the respose
 284       $nvpArray[$keyval] = $valval;
 285       $result = substr($result, $valuepos + 1, strlen($result));
 286     }
 287     // get the result code to validate.
 288     $result_code = $nvpArray['RESULT'];
 289     /*debug
 290     echo "<p>Params array</p><br>";
 291     print_r($params);
 292     echo "<p></p><br>";
 293     echo "<p>Values to Payment Processor</p><br>";
 294     print_r($payflow_query_array);
 295     echo "<p></p><br>";
 296     echo "<p>Results from Payment Processor</p><br>";
 297     print_r($nvpArray);
 298     echo "<p></p><br>";
 299      */
 300
 301     switch ($result_code) {
 302       case 0:
 303
 304         /*******************************************************
 305          * Success !
 306          * This is a successful transaction. Payflow Pro does return further information
 307          * about transactions to help you identify fraud including whether they pass
 308          * the cvv check, the avs check. This is stored in
 309          * CiviCRM as part of the transact
 310          * but not further processing is done. Business rules would need to be defined
 311          *******************************************************/
 312         $params['trxn_id'] = $nvpArray['PNREF'] . $nvpArray['TRXPNREF'];
 313         //'trxn_id' is varchar(255) field. returned value is length 12
 314         $params['trxn_result_code'] = $nvpArray['AUTHCODE'] . "-Cvv2:" . $nvpArray['CVV2MATCH'] . "-avs:" . $nvpArray['AVSADDR'];
 315
 316         if ($params['is_recur'] == TRUE) {
 317           $params['recur_trxn_id'] = $nvpArray['PROFILEID'];
 318           //'trxn_id' is varchar(255) field. returned value is length 12
 319         }
 320         return $params;
 321
 322       case 1:
 323         return self::errorExit(9008, "There is a payment processor configuration problem. This is usually due to invalid account information or ip restrictions on the account.  You can verify ip restriction by logging         // into Manager.  See Service Settings >> Allowed IP Addresses.   ");
 324
 325       case 12:
 326         // Hard decline from bank.
 327         return self::errorExit(9009, "Your transaction was declined   ");
 328
 329       case 13:
 330         // Voice authorization required.
 331         return self::errorExit(9010, "Your Transaction is pending. Contact Customer Service to complete your order.");
 332
 333       case 23:
 334         // Issue with credit card number or expiration date.
 335         return self::errorExit(9011, "Invalid credit card information. Please re-enter.");
 336
 337       case 26:
 338         return self::errorExit(9012, "You have not configured your payment processor with the correct credentials. Make sure you have provided both the <vendor> and the <user> variables ");
 339
 340       default:
 341         return self::errorExit(9013, "Error - from payment processor: [" . $result_code . " " . $nvpArray['RESPMSG'] . "] ");
 342     }
 343
 344     return self::errorExit(9014, "Check the code - all transactions should have been headed off before they got here. Something slipped through the net");
 345   }
 346
 347   /**
 348    * Produces error message and returns from class
 349    *
 350    * @param null $errorCode
 351    * @param null $errorMessage
 352    *
 353    * @return object
 354    */
 355   public function &errorExit($errorCode = NULL, $errorMessage = NULL) {
 356     $e = CRM_Core_Error::singleton();
 357     if ($errorCode) {
 358       $e->push($errorCode, 0, NULL, $errorMessage);
 359     }
 360     else {
 361       $e->push(9000, 0, NULL, 'Unknown System Error.');
 362     }
 363     return $e;
 364   }
 365
 366
 367   /**
 368    * NOTE: 'doTransferCheckout' not implemented
 369    *
 370    * @param array $params
 371    * @param $component
 372    *
 373    * @throws Exception
 374    */
 375   public function doTransferCheckout(&$params, $component) {
 376     CRM_Core_Error::fatal(ts('This function is not implemented'));
 377   }
 378
 379   /**
 380    * This public function checks to see if we have the right processor config values set
 381    *
 382    * NOTE: Called by Events and Contribute to check config params are set prior to trying
 383    *  register any credit card details
 384    *
 385    * @return string|null
 386    *   the error message if any, null if OK
 387    */
 388   public function checkConfig() {
 389     $errorMsg = array();
 390     if (empty($this->_paymentProcessor['user_name'])) {
 391       $errorMsg[] = ' ' . ts('ssl_merchant_id is not set for this payment processor');
 392     }
 393
 394     if (empty($this->_paymentProcessor['url_site'])) {
 395       $errorMsg[] = ' ' . ts('URL is not set for %1', array(1 => $this->_paymentProcessor['name']));
 396     }
 397
 398     if (!empty($errorMsg)) {
 399       return implode('<p>', $errorMsg);
 400     }
 401     else {
 402       return NULL;
 403     }
 404   }
 405
 406   /**
 407    * convert to a name/value pair (nvp) string
 408    *
 409    * @param $payflow_query_array
 410    *
 411    * @return array|string
 412    */
 413   public function convert_to_nvp($payflow_query_array) {
 414     foreach ($payflow_query_array as $key => $value) {
 415       $payflow_query[] = $key . '[' . strlen($value) . ']=' . $value;
 416     }
 417     $payflow_query = implode('&', $payflow_query);
 418
 419     return $payflow_query;
 420   }
 421
 422   /**
 423    * Submit transaction using cURL
 424    *
 425    * @param string $submiturl Url to direct HTTPS GET to
 426    * @param $payflow_query value string to be posted
 427    *
 428    * @return mixed|object
 429    */
 430   public function submit_transaction($submiturl, $payflow_query) {
 431     // get data ready for API
 432     $user_agent = $_SERVER['HTTP_USER_AGENT'];
 433     // Here's your custom headers; adjust appropriately for your setup:
 434     $headers[] = "Content-Type: text/namevalue";
 435     //or text/xml if using XMLPay.
 436     $headers[] = "Content-Length : " . strlen($data);
 437     // Length of data to be passed
 438     // Here the server timeout value is set to 45, but notice
 439     // below in the cURL section, the timeout
 440     // for cURL is 90 seconds.  You want to make sure the server
 441     // timeout is less, then the connection.
 442     $headers[] = "X-VPS-Timeout: 45";
 443     //random unique number  - the transaction is retried using this transaction ID
 444     // in this function but if that doesn't work and it is re- submitted
 445     // it is treated as a new attempt. Payflow Pro doesn't allow
 446     // you to change details (e.g. card no) when you re-submit
 447     // you can only try the same details
 448     $headers[] = "X-VPS-Request-ID: " . rand(1, 1000000000);
 449     // optional header field
 450     $headers[] = "X-VPS-VIT-Integration-Product: CiviCRM";
 451     // other Optional Headers.  If used adjust as necessary.
 452     // Name of your OS
 453     //$headers[] = "X-VPS-VIT-OS-Name: Linux";
 454     // OS Version
 455     //$headers[] = "X-VPS-VIT-OS-Version: RHEL 4";
 456     // What you are using
 457     //$headers[] = "X-VPS-VIT-Client-Type: PHP/cURL";
 458     // For your info
 459     //$headers[] = "X-VPS-VIT-Client-Version: 0.01";
 460     // For your info
 461     //$headers[] = "X-VPS-VIT-Client-Architecture: x86";
 462     // Application version
 463     //$headers[] = "X-VPS-VIT-Integration-Version: 0.01";
 464     $ch = curl_init();
 465     curl_setopt($ch, CURLOPT_URL, $submiturl);
 466     curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
 467     curl_setopt($ch, CURLOPT_USERAGENT, $user_agent);
 468     curl_setopt($ch, CURLOPT_HEADER, 1);
 469     // tells curl to include headers in response
 470     curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
 471     // return into a variable
 472     curl_setopt($ch, CURLOPT_TIMEOUT, 90);
 473     // times out after 90 secs
 474     if (ini_get('open_basedir') == '' && ini_get('safe_mode') == 'Off') {
 475       curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 0);
 476     }
 477     curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, Civi::settings()->get('verifySSL'));
 478     // this line makes it work under https
 479     curl_setopt($ch, CURLOPT_POSTFIELDS, $payflow_query);
 480     //adding POST data
 481     curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, Civi::settings()->get('verifySSL') ? 2 : 0);
 482     //verifies ssl certificate
 483     curl_setopt($ch, CURLOPT_FORBID_REUSE, TRUE);
 484     //forces closure of connection when done
 485     curl_setopt($ch, CURLOPT_POST, 1);
 486     //data sent as POST
 487
 488     // Try to submit the transaction up to 3 times with 5 second delay.  This can be used
 489     // in case of network issues.  The idea here is since you are posting via HTTPS there
 490     // could be general network issues, so try a few times before you tell customer there
 491     // is an issue.
 492
 493     $i = 1;
 494     while ($i++ <= 3) {
 495       $responseData = curl_exec($ch);
 496       $responseHeaders = curl_getinfo($ch);
 497       if ($responseHeaders['http_code'] != 200) {
 498         // Let's wait 5 seconds to see if its a temporary network issue.
 499         sleep(5);
 500       }
 501       elseif ($responseHeaders['http_code'] == 200) {
 502         // we got a good response, drop out of loop.
 503         break;
 504       }
 505     }
 506     if ($responseHeaders['http_code'] != 200) {
 507       return self::errorExit(9015, "Error connecting to the Payflow Pro API server.");
 508     }
 509
 510     /*
 511      * Transaction submitted -
 512      * See if we had a curl error - if so tell 'em and bail out
 513      *
 514      * NOTE: curl_error does not return a logical value (see its documentation), but
 515      *       a string, which is empty when there was no error.
 516      */
 517     if ((curl_errno($ch) > 0) || (strlen(curl_error($ch)) > 0)) {
 518       curl_close($ch);
 519       $errorNum = curl_errno($ch);
 520       $errorDesc = curl_error($ch);
 521
 522       //Paranoia - in the unlikley event that 'curl' errno fails
 523       if ($errorNum == 0) {
 524         $errorNum = 9005;
 525       }
 526
 527       // Paranoia - in the unlikley event that 'curl' error fails
 528       if (strlen($errorDesc) == 0) {
 529         $errorDesc = "Connection to payment gateway failed";
 530       }
 531       if ($errorNum = 60) {
 532         return self::errorExit($errorNum, "Curl error - " . $errorDesc .
 533           " Try this link for more information http://curl.haxx.se/d
 534                                          ocs/sslcerts.html"
 535         );
 536       }
 537
 538       return self::errorExit($errorNum, "Curl error - " . $errorDesc .
 539         "  processor response = " . $processorResponse
 540       );
 541     }
 542
 543     /*
 544      * If null data returned - tell 'em and bail out
 545      *
 546      * NOTE: You will not necessarily get a string back, if the request failed for
 547      *       any reason, the return value will be the boolean false.
 548      */
 549     if (($responseData === FALSE) || (strlen($responseData) == 0)) {
 550       curl_close($ch);
 551       return self::errorExit(9006, "Error: Connection to payment gateway failed - no data
 552                                            returned. Gateway url set to $submiturl");
 553     }
 554
 555     /*
 556      * If gateway returned no data - tell 'em and bail out
 557      */
 558     if (empty($responseData)) {
 559       curl_close($ch);
 560       return self::errorExit(9007, "Error: No data returned from payment gateway.");
 561     }
 562
 563     /*
 564      * Success so far - close the curl and check the data
 565      */
 566     curl_close($ch);
 567     return $responseData;
 568   }
 569
 570 }