3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
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.
32 * Grateful acknowledgements go to Donald Lobo for invaluable assistance
33 * in creating this payment processor module
37 * Class CRM_Core_Payment_PaymentExpress
39 class CRM_Core_Payment_PaymentExpress
extends CRM_Core_Payment
{
40 const CHARSET
= 'iso-8859-1';
42 protected $_mode = NULL;
45 * We only need one instance of this object. So we use the singleton
46 * pattern and cache the instance in this variable
50 static private $_singleton = NULL;
56 * The mode of operation: live or test.
58 * @param $paymentProcessor
60 * @return \CRM_Core_Payment_PaymentExpress
62 public function __construct($mode, &$paymentProcessor) {
65 $this->_paymentProcessor
= $paymentProcessor;
66 $this->_processorName
= ts('DPS Payment Express');
70 * This function checks to see if we have the right config values.
72 * @internal param string $mode the mode we are operating in (live or test)
75 * the error message if any
77 public function checkConfig() {
78 $config = CRM_Core_Config
::singleton();
82 if (empty($this->_paymentProcessor
['user_name'])) {
83 $error[] = ts('UserID is not set in the Administer » System Settings » Payment Processors');
86 if (empty($this->_paymentProcessor
['password'])) {
87 $error[] = ts('pxAccess / pxPay Key is not set in the Administer » System Settings » Payment Processors');
91 return implode('<p>', $error);
99 * @param array $params
103 public function setExpressCheckOut(&$params) {
104 CRM_Core_Error
::fatal(ts('This function is not implemented'));
112 public function getExpressCheckoutDetails($token) {
113 CRM_Core_Error
::fatal(ts('This function is not implemented'));
117 * @param array $params
121 public function doExpressCheckout(&$params) {
122 CRM_Core_Error
::fatal(ts('This function is not implemented'));
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
129 * @param array $params
130 * Assoc array of input parameters for this transaction.
132 public function doDirectPayment(&$params) {
133 CRM_Core_Error
::fatal(ts('This function is not implemented'));
137 * Main transaction function.
139 * @param array $params
140 * Name value pair of contribution data.
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'));
153 $url = $config->userFrameworkResourceURL
. "extern/pxIPN.php";
155 if ($component == 'event') {
156 $cancelURL = CRM_Utils_System
::url('civicrm/event/register',
157 "_qf_Confirm_display=true&qfKey={$params['qfKey']}",
161 elseif ($component == 'contribute') {
162 $cancelURL = CRM_Utils_System
::url('civicrm/contribute/transact',
163 "_qf_Confirm_display=true&qfKey={$params['qfKey']}",
169 * Build the private data string to pass to DPS, which they will give back to us with the
171 * transaction result. We are building this as a comma-separated list so as to avoid long URLs.
173 * Parameters passed: a=contactID, b=contributionID,c=contributionTypeID,d=invoiceID,e=membershipID,f=participantID,g=eventID
176 $privateData = "a={$params['contactID']},b={$params['contributionID']},c={$params['contributionTypeID']},d={$params['invoiceID']}";
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']}";
182 elseif ($component == 'contribute') {
183 $membershipID = CRM_Utils_Array
::value('membershipID', $params);
185 $privateData .= ",e=$membershipID";
187 $merchantRef = substr($params['contactID'] . "-" . $params['contributionID'] . " " . substr($params['description'], 20, 20), 0, 24);
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
202 'UrlSuccess' => $url,
204 // Allow further manipulation of params via custom hooks
205 CRM_Utils_Hook
::alterPaymentProcessorParams($this, $params, $dpsParams);
208 * determine whether method is pxaccess or pxpay by whether signature (mac key) is defined
211 if (empty($this->_paymentProcessor
['signature'])) {
215 * This contains the XML/Curl functions we'll need to generate the XML request
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);
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']);
228 if ($response = curl_exec($curl)) {
230 $valid = CRM_Core_Payment_PaymentExpressUtils
::_xmlAttribute($response, '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);
237 // redisplay confirmation page
238 CRM_Utils_System
::redirect($cancelURL);
242 // calling DPS failed
243 CRM_Core_Error
::fatal(ts('Unable to establish connection to the payment gateway.'));
247 $processortype = "pxaccess";
248 require_once 'PaymentExpress/pxaccess.inc.php';
250 $PxAccess_Url = $this->_paymentProcessor
['url_site'];
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'];
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);