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    */
  50   static private $_singleton = NULL;
  51
  52   /**
  53    * Constructor.
  54    *
  55    * @param string $mode
  56    *   The mode of operation: live or test.
  57    *
  58    * @param $paymentProcessor
  59    *
  60    * @return \CRM_Core_Payment_PaymentExpress
  61    */
  62   public function __construct($mode, &$paymentProcessor) {
  63
  64     $this->_mode = $mode;
  65     $this->_paymentProcessor = $paymentProcessor;
  66     $this->_processorName = ts('DPS Payment Express');
  67   }
  68
  69   /**
  70    * This function checks to see if we have the right config values.
  71    *
  72    * @internal param string $mode the mode we are operating in (live or test)
  73    *
  74    * @return string
  75    *   the error message if any
  76    */
  77   public function checkConfig() {
  78     $config = CRM_Core_Config::singleton();
  79
  80     $error = array();
  81
  82     if (empty($this->_paymentProcessor['user_name'])) {
  83       $error[] = ts('UserID is not set in the Administer &raquo; System Settings &raquo; Payment Processors');
  84     }
  85
  86     if (empty($this->_paymentProcessor['password'])) {
  87       $error[] = ts('pxAccess / pxPay Key is not set in the Administer &raquo; System Settings &raquo; Payment Processors');
  88     }
  89
  90     if (!empty($error)) {
  91       return implode('<p>', $error);
  92     }
  93     else {
  94       return NULL;
  95     }
  96   }
  97
  98   /**
  99    * @param array $params
 100    *
 101    * @throws Exception
 102    */
 103   public function setExpressCheckOut(&$params) {
 104     CRM_Core_Error::fatal(ts('This function is not implemented'));
 105   }
 106
 107   /**
 108    * @param $token
 109    *
 110    * @throws Exception
 111    */
 112   public function getExpressCheckoutDetails($token) {
 113     CRM_Core_Error::fatal(ts('This function is not implemented'));
 114   }
 115
 116   /**
 117    * @param array $params
 118    *
 119    * @throws Exception
 120    */
 121   public function doExpressCheckout(&$params) {
 122     CRM_Core_Error::fatal(ts('This function is not implemented'));
 123   }
 124
 125   /**
 126    * This function collects all the information from a web/api form and invokes
 127    * the relevant payment processor specific functions to perform the transaction
 128    *
 129    * @param array $params
 130    *   Assoc array of input parameters for this transaction.
 131    */
 132   public function doDirectPayment(&$params) {
 133     CRM_Core_Error::fatal(ts('This function is not implemented'));
 134   }
 135
 136   /**
 137    * Main transaction function.
 138    *
 139    * @param array $params
 140    *   Name value pair of contribution data.
 141    *
 142    * @param $component
 143    *
 144    * @return void
 145    */
 146   public function doTransferCheckout(&$params, $component) {
 147     $component = strtolower($component);
 148     $config = CRM_Core_Config::singleton();
 149     if ($component != 'contribute' && $component != 'event') {
 150       CRM_Core_Error::fatal(ts('Component is invalid'));
 151     }
 152
 153     $url = $config->userFrameworkResourceURL . "extern/pxIPN.php";
 154
 155     if ($component == 'event') {
 156       $cancelURL = CRM_Utils_System::url('civicrm/event/register',
 157         "_qf_Confirm_display=true&qfKey={$params['qfKey']}",
 158         FALSE, NULL, FALSE
 159       );
 160     }
 161     elseif ($component == 'contribute') {
 162       $cancelURL = CRM_Utils_System::url('civicrm/contribute/transact',
 163         "_qf_Confirm_display=true&qfKey={$params['qfKey']}",
 164         FALSE, NULL, FALSE
 165       );
 166     }
 167
 168     /*
 169      * Build the private data string to pass to DPS, which they will give back to us with the
 170      *
 171      * transaction result.  We are building this as a comma-separated list so as to avoid long URLs.
 172      *
 173      * Parameters passed: a=contactID, b=contributionID,c=contributionTypeID,d=invoiceID,e=membershipID,f=participantID,g=eventID
 174      */
 175
 176     $privateData = "a={$params['contactID']},b={$params['contributionID']},c={$params['contributionTypeID']},d={$params['invoiceID']}";
 177
 178     if ($component == 'event') {
 179       $merchantRef = substr($params['contactID'] . "-" . $params['contributionID'] . " " . substr($params['description'], 27, 20), 0, 24);
 180       $privateData .= ",f={$params['participantID']},g={$params['eventID']}";
 181     }
 182     elseif ($component == 'contribute') {
 183       $membershipID = CRM_Utils_Array::value('membershipID', $params);
 184       if ($membershipID) {
 185         $privateData .= ",e=$membershipID";
 186       }
 187       $merchantRef = substr($params['contactID'] . "-" . $params['contributionID'] . " " . substr($params['description'], 20, 20), 0, 24);
 188
 189     }
 190
 191     $dpsParams = array(
 192       'AmountInput' => str_replace(",", "", number_format($params['amount'], 2)),
 193       'CurrencyInput' => $params['currencyID'],
 194       'MerchantReference' => $merchantRef,
 195       'TxnData1' => $params['qfKey'],
 196       'TxnData2' => $privateData,
 197       'TxnData3' => $component . "," . $this->_paymentProcessor['id'],
 198       'TxnType' => 'Purchase',
 199       // Leave this empty for now, causes an error with DPS if we populate it
 200       'TxnId' => '',
 201       'UrlFail' => $url,
 202       'UrlSuccess' => $url,
 203     );
 204     // Allow further manipulation of params via custom hooks
 205     CRM_Utils_Hook::alterPaymentProcessorParams($this, $params, $dpsParams);
 206
 207     /*
 208      *  determine whether method is pxaccess or pxpay by whether signature (mac key) is defined
 209      */
 210
 211     if (empty($this->_paymentProcessor['signature'])) {
 212       /*
 213        * Processor is pxpay
 214        *
 215        * This contains the XML/Curl functions we'll need to generate the XML request
 216        */
 217
 218       $dpsParams['PxPayUserId'] = $this->_paymentProcessor['user_name'];
 219       $dpsParams['PxPayKey'] = $this->_paymentProcessor['password'];
 220       // Build a valid XML string to pass to DPS
 221       $generateRequest = CRM_Core_Payment_PaymentExpressUtils::_valueXml($dpsParams);
 222
 223       $generateRequest = CRM_Core_Payment_PaymentExpressUtils::_valueXml('GenerateRequest', $generateRequest);
 224       // Get the special validated URL back from DPS by sending them the XML we've generated
 225       $curl = CRM_Core_Payment_PaymentExpressUtils::_initCURL($generateRequest, $this->_paymentProcessor['url_site']);
 226       $success = FALSE;
 227
 228       if ($response = curl_exec($curl)) {
 229         curl_close($curl);
 230         $valid = CRM_Core_Payment_PaymentExpressUtils::_xmlAttribute($response, 'valid');
 231         if (1 == $valid) {
 232           // the request was validated, so we'll get the URL and redirect to it
 233           $uri = CRM_Core_Payment_PaymentExpressUtils::_xmlElement($response, 'URI');
 234           CRM_Utils_System::redirect($uri);
 235         }
 236         else {
 237           // redisplay confirmation page
 238           CRM_Utils_System::redirect($cancelURL);
 239         }
 240       }
 241       else {
 242         // calling DPS failed
 243         CRM_Core_Error::fatal(ts('Unable to establish connection to the payment gateway.'));
 244       }
 245     }
 246     else {
 247       $processortype = "pxaccess";
 248       require_once 'PaymentExpress/pxaccess.inc.php';
 249       // URL
 250       $PxAccess_Url = $this->_paymentProcessor['url_site'];
 251       // User ID
 252       $PxAccess_Userid = $this->_paymentProcessor['user_name'];
 253       // Your DES Key from DPS
 254       $PxAccess_Key = $this->_paymentProcessor['password'];
 255       // Your MAC key from DPS
 256       $Mac_Key = $this->_paymentProcessor['signature'];
 257
 258       $pxaccess = new PxAccess($PxAccess_Url, $PxAccess_Userid, $PxAccess_Key, $Mac_Key);
 259       $request = new PxPayRequest();
 260       $request->setAmountInput($dpsParams['AmountInput']);
 261       $request->setTxnData1($dpsParams['TxnData1']);
 262       $request->setTxnData2($dpsParams['TxnData2']);
 263       $request->setTxnData3($dpsParams['TxnData3']);
 264       $request->setTxnType($dpsParams['TxnType']);
 265       $request->setInputCurrency($dpsParams['InputCurrency']);
 266       $request->setMerchantReference($dpsParams['MerchantReference']);
 267       $request->setUrlFail($dpsParams['UrlFail']);
 268       $request->setUrlSuccess($dpsParams['UrlSuccess']);
 269       $request_string = $pxaccess->makeRequest($request);
 270       CRM_Utils_System::redirect($request_string);
 271     }
 272   }
 273
 274 }