3 +----------------------------------------------------------------------------+
4 | Elavon (Nova) Virtual Merchant Core Payment Module for CiviCRM version 5 |
5 +----------------------------------------------------------------------------+
6 | Licensed to CiviCRM under the Academic Free License version 3.0 |
8 | Written & Contributed by Eileen McNaughton - Nov March 2008 |
9 +----------------------------------------------------------------------------+
12 use Civi\Payment\Exception\PaymentProcessorException
;
15 * -----------------------------------------------------------------------------------------------
16 * The basic functionality of this processor is that variables from the $params object are transformed
17 * into xml. The xml is submitted to the processor's https site
18 * using curl and the response is translated back into an array using the processor's function.
20 * If an array ($params) is returned to the calling function the values from
21 * the array are merged into the calling functions array.
23 * If an result of class error is returned it is treated as a failure. No error denotes a success. Be
24 * WARY of this when coding
26 * -----------------------------------------------------------------------------------------------
28 class CRM_Core_Payment_Elavon
extends CRM_Core_Payment
{
34 * The mode of operation: live or test.
36 * @param array $paymentProcessor
38 public function __construct($mode, &$paymentProcessor) {
41 $this->_paymentProcessor
= $paymentProcessor;
45 * Map fields to parameters.
47 * This function is set up and put here to make the mapping of fields
48 * from the params object as visually clear as possible for easy editing
50 * @param array $params
54 public function mapProcessorFieldstoParams($params) {
55 $requestFields['ssl_first_name'] = $params['billing_first_name'];
56 $requestFields['ssl_last_name'] = $params['billing_last_name'];
58 $requestFields['ssl_ship_to_first_name'] = $params['first_name'];
60 $requestFields['ssl_ship_to_last_name'] = $params['last_name'];
61 $requestFields['ssl_card_number'] = $params['credit_card_number'];
62 $requestFields['ssl_amount'] = trim($params['amount']);
63 $requestFields['ssl_exp_date'] = sprintf('%02d', (int) $params['month']) . substr($params['year'], 2, 2);
64 $requestFields['ssl_cvv2cvc2'] = $params['cvv2'];
65 // CVV field passed to processor
66 $requestFields['ssl_cvv2cvc2_indicator'] = "1";
67 $requestFields['ssl_avs_address'] = $params['street_address'];
68 $requestFields['ssl_city'] = $params['city'];
69 $requestFields['ssl_state'] = $params['state_province'];
70 $requestFields['ssl_avs_zip'] = $params['postal_code'];
71 $requestFields['ssl_country'] = $params['country'];
72 $requestFields['ssl_email'] = $params['email'];
73 // 32 character string
74 $requestFields['ssl_invoice_number'] = $params['invoiceID'];
75 $requestFields['ssl_transaction_type'] = "CCSALE";
76 $requestFields['ssl_description'] = empty($params['description']) ?
"backoffice payment" : $params['description'];
77 $requestFields['ssl_customer_number'] = substr($params['credit_card_number'], -4);
78 // Added two lines below to allow commercial cards to go through as per page 15 of Elavon developer guide
79 $requestFields['ssl_customer_code'] = '1111';
80 $requestFields['ssl_salestax'] = 0.0;
81 return $requestFields;
85 * This function sends request and receives response from the processor.
87 * @param array $params
91 * @throws \CRM_Core_Exception
93 public function doDirectPayment(&$params) {
94 if (isset($params['is_recur']) && $params['is_recur'] == TRUE) {
95 throw new CRM_Core_Exception(ts('Elavon - recurring payments not implemented'));
98 if (!defined('CURLOPT_SSLCERT')) {
99 throw new CRM_Core_Exception(ts('Elavon / Nova Virtual Merchant Gateway requires curl with SSL support'));
102 //Create the array of variables to be sent to the processor from the $params array
103 // passed into this function
104 $requestFields = $this->mapProcessorFieldstoParams($params);
106 // define variables for connecting with the gateway
107 $requestFields['ssl_merchant_id'] = $this->_paymentProcessor
['user_name'];
108 $requestFields['ssl_user_id'] = $this->_paymentProcessor
['password'] ??
NULL;
109 $requestFields['ssl_pin'] = $this->_paymentProcessor
['signature'] ??
NULL;
110 $host = $this->_paymentProcessor
['url_site'];
112 if ($this->_mode
=== 'test') {
113 $requestFields['ssl_test_mode'] = "TRUE";
116 // Allow further manipulation of the arguments via custom hooks ..
117 CRM_Utils_Hook
::alterPaymentProcessorParams($this, $params, $requestFields);
119 // Check to see if we have a duplicate before we send
120 if ($this->checkDupe($params['invoiceID'], CRM_Utils_Array
::value('contributionID', $params))) {
121 throw new PaymentProcessorException('It appears that this transaction is a duplicate. Have you already submitted the form once? If so there may have been a connection problem. Check your email for a receipt. If you do not receive a receipt within 2 hours you can try your transaction again. If you continue to have problems please contact the site administrator.', 9003);
124 // Convert to XML using function below
125 $xml = $this->buildXML($requestFields);
127 // Send to the payment processor using cURL
129 $chHost = $host . '?xmldata=' . $xml;
131 $ch = curl_init($chHost);
133 throw new PaymentProcessorException('Could not initiate connection to payment gateway', 9004);
136 curl_setopt($ch, CURLOPT_SSL_VERIFYHOST
, Civi
::settings()->get('verifySSL') ?
2 : 0);
137 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER
, Civi
::settings()->get('verifySSL'));
138 // return the result on success, FALSE on failure
139 curl_setopt($ch, CURLOPT_RETURNTRANSFER
, 1);
140 curl_setopt($ch, CURLOPT_TIMEOUT
, 36000);
141 // set this for debugging -look for output in apache error log
142 //curl_setopt ($ch,CURLOPT_VERBOSE,1 );
143 // ensures any Location headers are followed
144 if (ini_get('open_basedir') == '' && ini_get('safe_mode') == 'Off') {
145 curl_setopt($ch, CURLOPT_FOLLOWLOCATION
, 1);
148 // Send the data out over the wire
149 $responseData = curl_exec($ch);
151 // See if we had a curl error - if so tell 'em and bail out
152 // NOTE: curl_error does not return a logical value (see its documentation), but
153 // a string, which is empty when there was no error.
154 if ((curl_errno($ch) > 0) ||
(strlen(curl_error($ch)) > 0)) {
156 $errorNum = curl_errno($ch);
157 $errorDesc = curl_error($ch);
159 // Paranoia - in the unlikley event that 'curl' errno fails
160 if ($errorNum == 0) {
164 // Paranoia - in the unlikley event that 'curl' error fails
165 if (strlen($errorDesc) == 0) {
166 $errorDesc = 'Connection to payment gateway failed';
168 throw new PaymentProcessorException('Curl error - ' . $errorDesc . ' Try this link for more information http://curl.haxx.se/docs/sslcerts.html', $errorNum);
171 // If null data returned - tell 'em and bail out
172 // NOTE: You will not necessarily get a string back, if the request failed for
173 // any reason, the return value will be the boolean false.
174 if (($responseData === FALSE) ||
(strlen($responseData) == 0)) {
176 throw new PaymentProcessorException('Error: Connection to payment gateway failed - no data returned.', 9006);
179 // If gateway returned no data - tell 'em and bail out
180 if (empty($responseData)) {
182 throw new PaymentProcessorException('Error: No data returned from payment gateway.', 9007);
185 // Success so far - close the curl and check the data
188 // Payment successfully sent to gateway - process the response now
190 $processorResponse = $this->decodeXMLresponse($responseData);
191 // success in test mode returns response "APPROVED"
192 // test mode always returns trxn_id = 0
195 if ($processorResponse['errorCode']) {
196 throw new PaymentProcessorException("Error: [" . $processorResponse['errorCode'] . " " . $processorResponse['errorName'] . " " . $processorResponse['errorMessage'] . '] - from payment processor', 9010);
198 if ($processorResponse['ssl_result_message'] === "APPROVED") {
199 if ($this->_mode
=== 'test') {
200 $query = "SELECT MAX(trxn_id) FROM civicrm_contribution WHERE trxn_id LIKE 'test%'";
201 $trxn_id = (string) CRM_Core_DAO
::singleValueQuery($query);
202 $trxn_id = (int) str_replace('test', '', $trxn_id);
204 $params['trxn_id'] = sprintf('test%08d', $trxn_id);
207 throw new PaymentProcessorException('Error: [approval code related to test transaction but mode was ' . $this->_mode
, 9099);
210 // transaction failed, print the reason
211 if ($processorResponse['ssl_result_message'] !== "APPROVAL") {
212 throw new PaymentProcessorException('Error: [' . $processorResponse['ssl_result_message'] . ' ' . $processorResponse['ssl_result'] . '] - from payment processor', 9009);
216 if ($this->_mode
!== 'test') {
217 // 'trxn_id' is varchar(255) field. returned value is length 37
218 $params['trxn_id'] = $processorResponse['ssl_txn_id'];
221 $params['trxn_result_code'] = $processorResponse['ssl_approval_code'] . "-Cvv2:" . $processorResponse['ssl_cvv2_response'] . "-avs:" . $processorResponse['ssl_avs_response'];
228 * This public function checks to see if we have the right processor config values set.
230 * NOTE: Called by Events and Contribute to check config params are set prior to trying
231 * register any credit card details
233 * @return string|null
234 * $errorMsg if any errors found - null if OK
237 public function checkConfig() {
240 if (empty($this->_paymentProcessor
['user_name'])) {
241 $errorMsg[] = ' ' . ts('ssl_merchant_id is not set for this payment processor');
244 if (empty($this->_paymentProcessor
['url_site'])) {
245 $errorMsg[] = ' ' . ts('URL is not set for this payment processor');
248 if (!empty($errorMsg)) {
249 return implode('<p>', $errorMsg);
255 * @param $requestFields
259 public function buildXML($requestFields) {
260 $xmlFieldLength['ssl_first_name'] = 15;
262 $xmlFieldLength['ssl_last_name'] = 15;
264 $xmlFieldLength['ssl_ship_to_first_name'] = 15;
266 $xmlFieldLength['ssl_ship_to_last_name'] = 15;
267 $xmlFieldLength['ssl_card_number'] = 19;
268 $xmlFieldLength['ssl_amount'] = 13;
269 $xmlFieldLength['ssl_exp_date'] = 4;
270 $xmlFieldLength['ssl_cvv2cvc2'] = 4;
271 $xmlFieldLength['ssl_cvv2cvc2_indicator'] = 1;
272 $xmlFieldLength['ssl_avs_address'] = 20;
273 $xmlFieldLength['ssl_city'] = 20;
274 $xmlFieldLength['ssl_state'] = 30;
275 $xmlFieldLength['ssl_avs_zip'] = 9;
276 $xmlFieldLength['ssl_country'] = 50;
277 $xmlFieldLength['ssl_email'] = 100;
278 // 32 character string
279 $xmlFieldLength['ssl_invoice_number'] = 25;
280 $xmlFieldLength['ssl_transaction_type'] = 20;
281 $xmlFieldLength['ssl_description'] = 255;
282 $xmlFieldLength['ssl_merchant_id'] = 15;
283 $xmlFieldLength['ssl_user_id'] = 15;
284 $xmlFieldLength['ssl_pin'] = 128;
285 $xmlFieldLength['ssl_test_mode'] = 5;
286 $xmlFieldLength['ssl_salestax'] = 10;
287 $xmlFieldLength['ssl_customer_code'] = 17;
288 $xmlFieldLength['ssl_customer_number'] = 25;
291 foreach ($requestFields as $key => $value) {
292 //dev/core/966 Don't send email through the urlencode.
293 if ($key == 'ssl_email') {
294 $xml .= '<' . $key . '>' . substr($value, 0, $xmlFieldLength[$key]) . '</' . $key . '>';
297 $xml .= '<' . $key . '>' . self
::tidyStringforXML($value, $xmlFieldLength[$key]) . '</' . $key . '>';
306 * @param $fieldlength
310 public function tidyStringforXML($value, $fieldlength) {
311 // the xml is posted to a url so must not contain spaces etc. It also needs to be cut off at a certain
312 // length to match the processor's field length. The cut needs to be made after spaces etc are
313 // transformed but must not include a partial transformed character e.g. %20 must be in or out not half-way
314 $xmlString = substr(rawurlencode($value), 0, $fieldlength);
315 $lastPercent = strrpos($xmlString, '%');
316 if ($lastPercent > $fieldlength - 3) {
317 $xmlString = substr($xmlString, 0, $lastPercent);
323 * Simple function to use in place of the 'simplexml_load_string' call.
325 * It returns the NodeValue for a given NodeName
326 * or returns an empty string.
328 * @param string $NodeName
329 * @param string $strXML
332 public function GetNodeValue($NodeName, &$strXML) {
333 $OpeningNodeName = "<" . $NodeName . ">";
334 $ClosingNodeName = "</" . $NodeName . ">";
336 $pos1 = stripos($strXML, $OpeningNodeName);
337 $pos2 = stripos($strXML, $ClosingNodeName);
339 if (($pos1 === FALSE) ||
($pos2 === FALSE)) {
345 $pos1 +
= strlen($OpeningNodeName);
346 $len = $pos2 - $pos1;
348 $return = substr($strXML, $pos1, $len);
349 // check out rtn values for debug
350 // echo " $NodeName     $return <br>";
359 public function decodeXMLresponse($Xml) {
360 $processorResponse = [];
362 $processorResponse['ssl_result'] = self
::GetNodeValue("ssl_result", $Xml);
363 $processorResponse['ssl_result_message'] = self
::GetNodeValue("ssl_result_message", $Xml);
364 $processorResponse['ssl_txn_id'] = self
::GetNodeValue("ssl_txn_id", $Xml);
365 $processorResponse['ssl_cvv2_response'] = self
::GetNodeValue("ssl_cvv2_response", $Xml);
366 $processorResponse['ssl_avs_response'] = self
::GetNodeValue("ssl_avs_response", $Xml);
367 $processorResponse['ssl_approval_code'] = self
::GetNodeValue("ssl_approval_code", $Xml);
368 $processorResponse['errorCode'] = self
::GetNodeValue("errorCode", $Xml);
369 $processorResponse['errorName'] = self
::GetNodeValue("errorName", $Xml);
370 $processorResponse['errorMessage'] = self
::GetNodeValue("errorMessage", $Xml);
372 return $processorResponse;