CRM/Core/Payment/PaymentExpress.php

   1 <?php
   2 /*
   3   +--------------------------------------------------------------------+
   4   | CiviCRM version 4.6                                                |
   5   +--------------------------------------------------------------------+
   6   | This file is a part of CiviCRM.                                    |
   7   |                                                                    |
   8   | CiviCRM is free software; you can copy, modify, and distribute it  |
   9   | under the terms of the GNU Affero General Public License           |
  10   | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  11   |                                                                    |
  12   | CiviCRM is distributed in the hope that it will be useful, but     |
  13   | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  14   | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  15   | See the GNU Affero General Public License for more details.        |
  16   |                                                                    |
  17   | You should have received a copy of the GNU Affero General Public   |
  18   | License and the CiviCRM Licensing Exception along                  |
  19   | with this program; if not, contact CiviCRM LLC                     |
  20   | at info[AT]civicrm[DOT]org. If you have questions about the        |
  21   | GNU Affero General Public License or the licensing of CiviCRM,     |
  22   | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  23   +--------------------------------------------------------------------+
  24 */
  25
  26
  27 /*
  28  * PxPay Functionality Copyright (C) 2008 Lucas Baker, Logistic Information Systems Limited (Logis)
  29  * PxAccess Functionality Copyright (C) 2008 Eileen McNaughton
  30  * Licensed to CiviCRM under the Academic Free License version 3.0.
  31  *
  32  * Grateful acknowledgements go to Donald Lobo for invaluable assistance
  33  * in creating this payment processor module
  34  */
  35
  36 /**
  37  * Class CRM_Core_Payment_PaymentExpress
  38  */
  39 class CRM_Core_Payment_PaymentExpress extends CRM_Core_Payment {
  40   const CHARSET = 'iso-8859-1';
  41
  42   protected $_mode = NULL;
  43
  44   /**
  45    * We only need one instance of this object. So we use the singleton
  46    * pattern and cache the instance in this variable
  47    *
  48    * @var object
  49    * @static
  50    */
  51   static private $_singleton = NULL;
  52
  53   /**
  54    * Constructor
  55    *
  56    * @param string $mode
  57    *   The mode of operation: live or test.
  58    *
  59    * @param $paymentProcessor
  60    *
  61    * @return \CRM_Core_Payment_PaymentExpress
  62    */
  63   public function __construct($mode, &$paymentProcessor) {
  64
  65     $this->_mode = $mode;
  66     $this->_paymentProcessor = $paymentProcessor;
  67     $this->_processorName = ts('DPS Payment Express');
  68   }
  69
  70   /**
  71    * This function checks to see if we have the right config values
  72    *
  73    * @internal param string $mode the mode we are operating in (live or test)
  74    *
  75    * @return string
  76    *   the error message if any
  77    */
  78   public function checkConfig() {
  79     $config = CRM_Core_Config::singleton();
  80
  81     $error = array();
  82
  83     if (empty($this->_paymentProcessor['user_name'])) {
  84       $error[] = ts('UserID is not set in the Administer &raquo; System Settings &raquo; Payment Processors');
  85     }
  86
  87     if (empty($this->_paymentProcessor['password'])) {
  88       $error[] = ts('pxAccess / pxPay Key is not set in the Administer &raquo; System Settings &raquo; Payment Processors');
  89     }
  90
  91     if (!empty($error)) {
  92       return implode('<p>', $error);
  93     }
  94     else {
  95       return NULL;
  96     }
  97   }
  98
  99   /**
 100    * @param array $params
 101    *
 102    * @throws Exception
 103    */
 104   public function setExpressCheckOut(&$params) {
 105     CRM_Core_Error::fatal(ts('This function is not implemented'));
 106   }
 107
 108   /**
 109    * @param $token
 110    *
 111    * @throws Exception
 112    */
 113   public function getExpressCheckoutDetails($token) {
 114     CRM_Core_Error::fatal(ts('This function is not implemented'));
 115   }
 116
 117   /**
 118    * @param array $params
 119    *
 120    * @throws Exception
 121    */
 122   public function doExpressCheckout(&$params) {
 123     CRM_Core_Error::fatal(ts('This function is not implemented'));
 124   }
 125
 126   /**
 127    * This function collects all the information from a web/api form and invokes
 128    * the relevant payment processor specific functions to perform the transaction
 129    *
 130    * @param array $params
 131    *   Assoc array of input parameters for this transaction.
 132    *
 133    * @return array
 134    *   the result in an nice formatted array (or an error object)
 135    * @abstract
 136    */
 137   public function doDirectPayment(&$params) {
 138     CRM_Core_Error::fatal(ts('This function is not implemented'));
 139   }
 140
 141   /**
 142    * Main transaction function
 143    *
 144    * @param array $params
 145    *   Name value pair of contribution data.
 146    *
 147    * @param $component
 148    *
 149    * @return void
 150    */
 151   public function doTransferCheckout(&$params, $component) {
 152     $component = strtolower($component);
 153     $config = CRM_Core_Config::singleton();
 154     if ($component != 'contribute' && $component != 'event') {
 155       CRM_Core_Error::fatal(ts('Component is invalid'));
 156     }
 157
 158     $url = $config->userFrameworkResourceURL . "extern/pxIPN.php";
 159
 160     if ($component == 'event') {
 161       $cancelURL = CRM_Utils_System::url('civicrm/event/register',
 162         "_qf_Confirm_display=true&qfKey={$params['qfKey']}",
 163         FALSE, NULL, FALSE
 164       );
 165     }
 166     elseif ($component == 'contribute') {
 167       $cancelURL = CRM_Utils_System::url('civicrm/contribute/transact',
 168         "_qf_Confirm_display=true&qfKey={$params['qfKey']}",
 169         FALSE, NULL, FALSE
 170       );
 171     }
 172
 173     /*
 174      * Build the private data string to pass to DPS, which they will give back to us with the
 175      *
 176      * transaction result.  We are building this as a comma-separated list so as to avoid long URLs.
 177      *
 178      * Parameters passed: a=contactID, b=contributionID,c=contributionTypeID,d=invoiceID,e=membershipID,f=participantID,g=eventID
 179      */
 180
 181     $privateData = "a={$params['contactID']},b={$params['contributionID']},c={$params['contributionTypeID']},d={$params['invoiceID']}";
 182
 183     if ($component == 'event') {
 184       $merchantRef = substr($params['contactID'] . "-" . $params['contributionID'] . " " . substr($params['description'], 27, 20), 0, 24);
 185       $privateData .= ",f={$params['participantID']},g={$params['eventID']}";
 186     }
 187     elseif ($component == 'contribute') {
 188       $membershipID = CRM_Utils_Array::value('membershipID', $params);
 189       if ($membershipID) {
 190         $privateData .= ",e=$membershipID";
 191       }
 192       $merchantRef = substr($params['contactID'] . "-" . $params['contributionID'] . " " . substr($params['description'], 20, 20), 0, 24);
 193
 194     }
 195
 196     $dpsParams = array(
 197       'AmountInput' => str_replace(",", "", number_format($params['amount'], 2)),
 198       'CurrencyInput' => $params['currencyID'],
 199       'MerchantReference' => $merchantRef,
 200       'TxnData1' => $params['qfKey'],
 201       'TxnData2' => $privateData,
 202       'TxnData3' => $component . "," . $this->_paymentProcessor['id'],
 203       'TxnType' => 'Purchase',
 204       // Leave this empty for now, causes an error with DPS if we populate it
 205       'TxnId' => '',
 206       'UrlFail' => $url,
 207       'UrlSuccess' => $url,
 208     );
 209     // Allow further manipulation of params via custom hooks
 210     CRM_Utils_Hook::alterPaymentProcessorParams($this, $params, $dpsParams);
 211
 212     /*
 213      *  determine whether method is pxaccess or pxpay by whether signature (mac key) is defined
 214      */
 215
 216     if (empty($this->_paymentProcessor['signature'])) {
 217       /*
 218        * Processor is pxpay
 219        *
 220        * This contains the XML/Curl functions we'll need to generate the XML request
 221        */
 222
 223       $dpsParams['PxPayUserId'] = $this->_paymentProcessor['user_name'];
 224       $dpsParams['PxPayKey'] = $this->_paymentProcessor['password'];
 225       // Build a valid XML string to pass to DPS
 226       $generateRequest = CRM_Core_Payment_PaymentExpressUtils::_valueXml($dpsParams);
 227
 228       $generateRequest = CRM_Core_Payment_PaymentExpressUtils::_valueXml('GenerateRequest', $generateRequest);
 229       // Get the special validated URL back from DPS by sending them the XML we've generated
 230       $curl = CRM_Core_Payment_PaymentExpressUtils::_initCURL($generateRequest, $this->_paymentProcessor['url_site']);
 231       $success = FALSE;
 232
 233       if ($response = curl_exec($curl)) {
 234         curl_close($curl);
 235         $valid = CRM_Core_Payment_PaymentExpressUtils::_xmlAttribute($response, 'valid');
 236         if (1 == $valid) {
 237           // the request was validated, so we'll get the URL and redirect to it
 238           $uri = CRM_Core_Payment_PaymentExpressUtils::_xmlElement($response, 'URI');
 239           CRM_Utils_System::redirect($uri);
 240         }
 241         else {
 242           // redisplay confirmation page
 243           CRM_Utils_System::redirect($cancelURL);
 244         }
 245       }
 246       else {
 247         // calling DPS failed
 248         CRM_Core_Error::fatal(ts('Unable to establish connection to the payment gateway.'));
 249       }
 250     }
 251     else {
 252       $processortype = "pxaccess";
 253       require_once 'PaymentExpress/pxaccess.inc.php';
 254       // URL
 255       $PxAccess_Url = $this->_paymentProcessor['url_site'];
 256       // User ID
 257       $PxAccess_Userid = $this->_paymentProcessor['user_name'];
 258       // Your DES Key from DPS
 259       $PxAccess_Key = $this->_paymentProcessor['password'];
 260       // Your MAC key from DPS
 261       $Mac_Key = $this->_paymentProcessor['signature'];
 262
 263       $pxaccess = new PxAccess($PxAccess_Url, $PxAccess_Userid, $PxAccess_Key, $Mac_Key);
 264       $request = new PxPayRequest();
 265       $request->setAmountInput($dpsParams['AmountInput']);
 266       $request->setTxnData1($dpsParams['TxnData1']);
 267       $request->setTxnData2($dpsParams['TxnData2']);
 268       $request->setTxnData3($dpsParams['TxnData3']);
 269       $request->setTxnType($dpsParams['TxnType']);
 270       $request->setInputCurrency($dpsParams['InputCurrency']);
 271       $request->setMerchantReference($dpsParams['MerchantReference']);
 272       $request->setUrlFail($dpsParams['UrlFail']);
 273       $request->setUrlSuccess($dpsParams['UrlSuccess']);
 274       $request_string = $pxaccess->makeRequest($request);
 275       CRM_Utils_System::redirect($request_string);
 276     }
 277   }
 278 }