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