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
51 static private $_singleton = NULL;
56 * @param string $mode 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 * Singleton function used to manage this object
72 * @param string $mode the mode of operation: live or test
74 * @param object $paymentProcessor
75 * @param null $paymentForm
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);
86 return self
::$_singleton[$processorName];
90 * This function checks to see if we have the right config values
92 * @internal param string $mode the mode we are operating in (live or test)
94 * @return string the error message if any
96 public function checkConfig() {
97 $config = CRM_Core_Config
::singleton();
101 if (empty($this->_paymentProcessor
['user_name'])) {
102 $error[] = ts('UserID is not set in the Administer » System Settings » Payment Processors');
105 if (empty($this->_paymentProcessor
['password'])) {
106 $error[] = ts('pxAccess / pxPay Key is not set in the Administer » System Settings » Payment Processors');
109 if (!empty($error)) {
110 return implode('<p>', $error);
118 * @param array $params
122 public function setExpressCheckOut(&$params) {
123 CRM_Core_Error
::fatal(ts('This function is not implemented'));
131 public function getExpressCheckoutDetails($token) {
132 CRM_Core_Error
::fatal(ts('This function is not implemented'));
136 * @param array $params
140 public function doExpressCheckout(&$params) {
141 CRM_Core_Error
::fatal(ts('This function is not implemented'));
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
148 * @param array $params assoc array of input parameters for this transaction
150 * @return array the result in an nice formatted array (or an error object)
153 public function doDirectPayment(&$params) {
154 CRM_Core_Error
::fatal(ts('This function is not implemented'));
158 * Main transaction function
160 * @param array $params name value pair of contribution data
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'));
173 $url = $config->userFrameworkResourceURL
. "extern/pxIPN.php";
175 if ($component == 'event') {
176 $cancelURL = CRM_Utils_System
::url('civicrm/event/register',
177 "_qf_Confirm_display=true&qfKey={$params['qfKey']}",
181 elseif ($component == 'contribute') {
182 $cancelURL = CRM_Utils_System
::url('civicrm/contribute/transact',
183 "_qf_Confirm_display=true&qfKey={$params['qfKey']}",
190 * Build the private data string to pass to DPS, which they will give back to us with the
192 * transaction result. We are building this as a comma-separated list so as to avoid long URLs.
194 * Parameters passed: a=contactID, b=contributionID,c=contributionTypeID,d=invoiceID,e=membershipID,f=participantID,g=eventID
197 $privateData = "a={$params['contactID']},b={$params['contributionID']},c={$params['contributionTypeID']},d={$params['invoiceID']}";
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']}";
203 elseif ($component == 'contribute') {
204 $membershipID = CRM_Utils_Array
::value('membershipID', $params);
206 $privateData .= ",e=$membershipID";
208 $merchantRef = substr($params['contactID'] . "-" . $params['contributionID'] . " " . substr($params['description'], 20, 20), 0, 24);
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
223 'UrlSuccess' => $url,
225 // Allow further manipulation of params via custom hooks
226 CRM_Utils_Hook
::alterPaymentProcessorParams($this, $params, $dpsParams);
229 * determine whether method is pxaccess or pxpay by whether signature (mac key) is defined
233 if (empty($this->_paymentProcessor
['signature'])) {
237 * This contains the XML/Curl functions we'll need to generate the XML request
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);
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']);
250 if ($response = curl_exec($curl)) {
252 $valid = CRM_Core_Payment_PaymentExpressUtils
::_xmlAttribute($response, '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);
259 // redisplay confirmation page
260 CRM_Utils_System
::redirect($cancelURL);
264 // calling DPS failed
265 CRM_Core_Error
::fatal(ts('Unable to establish connection to the payment gateway.'));
269 $processortype = "pxaccess";
270 require_once ('PaymentExpress/pxaccess.inc.php');
272 $PxAccess_Url = $this->_paymentProcessor
['url_site'];
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'];
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);