ad955a0efc373088f7f6e6c8b0a06499f5a50f80
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 +----------------------------------------------------------------------------+
13 * -----------------------------------------------------------------------------------------------
14 * The basic functionality of this processor is that variables from the $params object are transformed
15 * into xml. The xml is submitted to the processor's https site
16 * using curl and the response is translated back into an array using the processor's function.
18 * If an array ($params) is returned to the calling function the values from
19 * the array are merged into the calling functions array.
21 * If an result of class error is returned it is treated as a failure. No error denotes a success. Be
22 * WARY of this when coding
24 * -----------------------------------------------------------------------------------------------
26 class CRM_Core_Payment_Elavon
extends CRM_Core_Payment
{
27 // (not used, implicit in the API, might need to convert?)
32 * We only need one instance of this object. So we use the singleton
33 * pattern and cache the instance in this variable
35 * @var CRM_Core_Payment_Elavon
37 static private $_singleton = NULL;
43 * The mode of operation: live or test.
45 * @param $paymentProcessor
47 * @return CRM_Core_Payment_Elavon
49 public function __construct($mode, &$paymentProcessor) {
52 $this->_paymentProcessor
= $paymentProcessor;
53 $this->_processorName
= ts('Elavon');
57 * This function is set up and put here to make the mapping of fields
58 * from the params object as visually clear as possible for easy editing
60 * Comment out irrelevant fields
64 public function mapProcessorFieldstoParams($params) {
67 // Payment Processor field name fields from $params array
69 $requestFields['ssl_first_name'] = $params['billing_first_name'];
71 //$requestFields['ssl_middle_name'] = $params['billing_middle_name'];
73 $requestFields['ssl_last_name'] = $params['billing_last_name'];
75 $requestFields['ssl_ship_to_first_name'] = $params['first_name'];
77 $requestFields['ssl_ship_to_last_name'] = $params['last_name'];
78 $requestFields['ssl_card_number'] = $params['credit_card_number'];
79 $requestFields['ssl_amount'] = trim($params['amount']);
80 $requestFields['ssl_exp_date'] = sprintf('%02d', (int) $params['month']) . substr($params['year'], 2, 2);
81 $requestFields['ssl_cvv2cvc2'] = $params['cvv2'];
82 // CVV field passed to processor
83 $requestFields['ssl_cvv2cvc2_indicator'] = "1";
84 $requestFields['ssl_avs_address'] = $params['street_address'];
85 $requestFields['ssl_city'] = $params['city'];
86 $requestFields['ssl_state'] = $params['state_province'];
87 $requestFields['ssl_avs_zip'] = $params['postal_code'];
88 $requestFields['ssl_country'] = $params['country'];
89 $requestFields['ssl_email'] = $params['email'];
90 // 32 character string
91 $requestFields['ssl_invoice_number'] = $params['invoiceID'];
92 $requestFields['ssl_transaction_type'] = "CCSALE";
93 $requestFields['ssl_description'] = empty($params['description']) ?
"backoffice payment" : $params['description'];
94 $requestFields['ssl_customer_number'] = substr($params['credit_card_number'], -4);
95 // Added two lines below to allow commercial cards to go through as per page 15 of Elavon developer guide
96 $requestFields['ssl_customer_code'] = '1111';
97 $requestFields['ssl_salestax'] = 0.0;
99 /************************************************************************************
100 * Fields available from civiCRM not implemented for Elavon
103 * $params['amount_other'];
104 * $params['ip_address'];
105 * $params['contributionType_name' ];
106 * $params['contributionPageID'];
107 * $params['contributionType_accounting_code'];
108 * $params['amount_level'];
109 * $params['credit_card_type'];
110 ************************************************************************************/
111 return $requestFields;
115 * This function sends request and receives response from
117 * @param array $params
118 * @return array|object
121 public function doDirectPayment(&$params) {
122 if (isset($params['is_recur']) && $params['is_recur'] == TRUE) {
123 CRM_Core_Error
::fatal(ts('Elavon - recurring payments not implemented'));
126 if (!defined('CURLOPT_SSLCERT')) {
127 CRM_Core_Error
::fatal(ts('Elavon / Nova Virtual Merchant Gateway requires curl with SSL support'));
130 //Create the array of variables to be sent to the processor from the $params array
131 // passed into this function
132 $requestFields = self
::mapProcessorFieldstoParams($params);
134 // define variables for connecting with the gateway
135 $requestFields['ssl_merchant_id'] = $this->_paymentProcessor
['user_name'];
136 $requestFields['ssl_user_id'] = CRM_Utils_Array
::value('password', $this->_paymentProcessor
);
137 $requestFields['ssl_pin'] = CRM_Utils_Array
::value('signature', $this->_paymentProcessor
);
138 $host = $this->_paymentProcessor
['url_site'];
140 if ($this->_mode
== "test") {
141 $requestFields['ssl_test_mode'] = "TRUE";
144 // Allow further manipulation of the arguments via custom hooks ..
145 CRM_Utils_Hook
::alterPaymentProcessorParams($this, $params, $requestFields);
147 // Check to see if we have a duplicate before we send
148 if ($this->checkDupe($params['invoiceID'], CRM_Utils_Array
::value('contributionID', $params))) {
149 return self
::errorExit(9003, '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.');
152 // Convert to XML using function below
153 $xml = self
::buildXML($requestFields);
155 // Send to the payment processor using cURL
157 $chHost = $host . '?xmldata=' . $xml;
159 $ch = curl_init($chHost);
161 return self
::errorExit(9004, 'Could not initiate connection to payment gateway');
164 curl_setopt($ch, CURLOPT_SSL_VERIFYHOST
, Civi
::settings()->get('verifySSL') ?
2 : 0);
165 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER
, Civi
::settings()->get('verifySSL'));
166 // return the result on success, FALSE on failure
167 curl_setopt($ch, CURLOPT_RETURNTRANSFER
, 1);
168 curl_setopt($ch, CURLOPT_TIMEOUT
, 36000);
169 // set this for debugging -look for output in apache error log
170 //curl_setopt ($ch,CURLOPT_VERBOSE,1 );
171 // ensures any Location headers are followed
172 if (ini_get('open_basedir') == '' && ini_get('safe_mode') == 'Off') {
173 curl_setopt($ch, CURLOPT_FOLLOWLOCATION
, 1);
176 // Send the data out over the wire
177 $responseData = curl_exec($ch);
179 // See if we had a curl error - if so tell 'em and bail out
180 // NOTE: curl_error does not return a logical value (see its documentation), but
181 // a string, which is empty when there was no error.
182 if ((curl_errno($ch) > 0) ||
(strlen(curl_error($ch)) > 0)) {
184 $errorNum = curl_errno($ch);
185 $errorDesc = curl_error($ch);
187 // Paranoia - in the unlikley event that 'curl' errno fails
188 if ($errorNum == 0) {
192 // Paranoia - in the unlikley event that 'curl' error fails
193 if (strlen($errorDesc) == 0) {
194 $errorDesc = "Connection to payment gateway failed";
196 if ($errorNum = 60) {
197 return self
::errorExit($errorNum, "Curl error - " . $errorDesc . " Try this link for more information http://curl.haxx.se/docs/sslcerts.html");
200 return self
::errorExit($errorNum, "Curl error - " . $errorDesc . " your key is located at " . $key . " the url is " . $host . " xml is " . $requestxml . " processor response = " . $processorResponse);
203 // If null data returned - tell 'em and bail out
204 // NOTE: You will not necessarily get a string back, if the request failed for
205 // any reason, the return value will be the boolean false.
206 if (($responseData === FALSE) ||
(strlen($responseData) == 0)) {
208 return self
::errorExit(9006, "Error: Connection to payment gateway failed - no data returned.");
211 // If gateway returned no data - tell 'em and bail out
212 if (empty($responseData)) {
214 return self
::errorExit(9007, "Error: No data returned from payment gateway.");
217 // Success so far - close the curl and check the data
220 // Payment successfully sent to gateway - process the response now
222 $processorResponse = self
::decodeXMLResponse($responseData);
223 // success in test mode returns response "APPROVED"
224 // test mode always returns trxn_id = 0
227 if ($processorResponse['errorCode']) {
228 return self
::errorExit(9010, "Error: [" . $processorResponse['errorCode'] . " " . $processorResponse['errorName'] . " " . $processorResponse['errorMessage'] . "] - from payment processor");
230 if ($processorResponse['ssl_result_message'] == "APPROVED") {
231 if ($this->_mode
== 'test') {
232 $query = "SELECT MAX(trxn_id) FROM civicrm_contribution WHERE trxn_id LIKE 'test%'";
234 $trxn_id = strval(CRM_Core_DAO
::singleValueQuery($query, $p));
235 $trxn_id = str_replace('test', '', $trxn_id);
236 $trxn_id = intval($trxn_id) +
1;
237 $params['trxn_id'] = sprintf('test%08d', $trxn_id);
241 return self
::errorExit(9099, "Error: [approval code related to test transaction but mode was " . $this->_mode
);
245 // transaction failed, print the reason
246 if ($processorResponse['ssl_result_message'] != "APPROVAL") {
247 return self
::errorExit(9009, "Error: [" . $processorResponse['ssl_result_message'] . " " . $processorResponse['ssl_result'] . "] - from payment processor");
251 if ($this->_mode
!= 'test') {
252 // 'trxn_id' is varchar(255) field. returned value is length 37
253 $params['trxn_id'] = $processorResponse['ssl_txn_id'];
256 $params['trxn_result_code'] = $processorResponse['ssl_approval_code'] . "-Cvv2:" . $processorResponse['ssl_cvv2_response'] . "-avs:" . $processorResponse['ssl_avs_response'];
263 * Produces error message and returns from class.
264 * @param string $errorCode
265 * @param string $errorMessage
266 * @return CRM_Core_Error
268 public function &errorExit($errorCode = NULL, $errorMessage = NULL) {
269 $e = CRM_Core_Error
::singleton();
271 $e->push($errorCode, 0, NULL, $errorMessage);
274 $e->push(9000, 0, NULL, 'Unknown System Error.');
280 * This public function checks to see if we have the right processor config values set.
282 * NOTE: Called by Events and Contribute to check config params are set prior to trying
283 * register any credit card details
285 * @return string|null
286 * $errorMsg if any errors found - null if OK
289 public function checkConfig() {
292 if (empty($this->_paymentProcessor
['user_name'])) {
293 $errorMsg[] = ' ' . ts('ssl_merchant_id is not set for this payment processor');
296 if (empty($this->_paymentProcessor
['url_site'])) {
297 $errorMsg[] = ' ' . ts('URL is not set for this payment processor');
300 if (!empty($errorMsg)) {
301 return implode('<p>', $errorMsg);
309 * @param $requestFields
313 public function buildXML($requestFields) {
314 $xmlFieldLength['ssl_first_name'] = 15;
316 $xmlFieldLength['ssl_last_name'] = 15;
318 $xmlFieldLength['ssl_ship_to_first_name'] = 15;
320 $xmlFieldLength['ssl_ship_to_last_name'] = 15;
321 $xmlFieldLength['ssl_card_number'] = 19;
322 $xmlFieldLength['ssl_amount'] = 13;
323 $xmlFieldLength['ssl_exp_date'] = 4;
324 $xmlFieldLength['ssl_cvv2cvc2'] = 4;
325 $xmlFieldLength['ssl_cvv2cvc2_indicator'] = 1;
326 $xmlFieldLength['ssl_avs_address'] = 20;
327 $xmlFieldLength['ssl_city'] = 20;
328 $xmlFieldLength['ssl_state'] = 30;
329 $xmlFieldLength['ssl_avs_zip'] = 9;
330 $xmlFieldLength['ssl_country'] = 50;
331 $xmlFieldLength['ssl_email'] = 100;
332 // 32 character string
333 $xmlFieldLength['ssl_invoice_number'] = 25;
334 $xmlFieldLength['ssl_transaction_type'] = 20;
335 $xmlFieldLength['ssl_description'] = 255;
336 $xmlFieldLength['ssl_merchant_id'] = 15;
337 $xmlFieldLength['ssl_user_id'] = 15;
338 $xmlFieldLength['ssl_pin'] = 128;
339 $xmlFieldLength['ssl_test_mode'] = 5;
340 $xmlFieldLength['ssl_salestax'] = 10;
341 $xmlFieldLength['ssl_customer_code'] = 17;
342 $xmlFieldLength['ssl_customer_number'] = 25;
345 foreach ($requestFields as $key => $value) {
346 //dev/core/966 Don't send email through the urlencode.
347 if ($key == 'ssl_email') {
348 $xml .= '<' . $key . '>' . substr($value, 0, $xmlFieldLength[$key]) . '</' . $key . '>';
351 $xml .= '<' . $key . '>' . self
::tidyStringforXML($value, $xmlFieldLength[$key]) . '</' . $key . '>';
360 * @param $fieldlength
364 public function tidyStringforXML($value, $fieldlength) {
365 // the xml is posted to a url so must not contain spaces etc. It also needs to be cut off at a certain
366 // length to match the processor's field length. The cut needs to be made after spaces etc are
367 // transformed but must not include a partial transformed character e.g. %20 must be in or out not half-way
368 $xmlString = substr(rawurlencode($value), 0, $fieldlength);
369 $lastPercent = strrpos($xmlString, '%');
370 if ($lastPercent > $fieldlength - 3) {
371 $xmlString = substr($xmlString, 0, $lastPercent);
377 * Simple function to use in place of the 'simplexml_load_string' call.
379 * It returns the NodeValue for a given NodeName
380 * or returns an empty string.
382 * @param string $NodeName
383 * @param string $strXML
386 public function GetNodeValue($NodeName, &$strXML) {
387 $OpeningNodeName = "<" . $NodeName . ">";
388 $ClosingNodeName = "</" . $NodeName . ">";
390 $pos1 = stripos($strXML, $OpeningNodeName);
391 $pos2 = stripos($strXML, $ClosingNodeName);
393 if (($pos1 === FALSE) ||
($pos2 === FALSE)) {
399 $pos1 +
= strlen($OpeningNodeName);
400 $len = $pos2 - $pos1;
402 $return = substr($strXML, $pos1, $len);
403 // check out rtn values for debug
404 // echo " $NodeName     $return <br>";
413 public function decodeXMLresponse($Xml) {
414 $processorResponse = [];
416 $processorResponse['ssl_result'] = self
::GetNodeValue("ssl_result", $Xml);
417 $processorResponse['ssl_result_message'] = self
::GetNodeValue("ssl_result_message", $Xml);
418 $processorResponse['ssl_txn_id'] = self
::GetNodeValue("ssl_txn_id", $Xml);
419 $processorResponse['ssl_cvv2_response'] = self
::GetNodeValue("ssl_cvv2_response", $Xml);
420 $processorResponse['ssl_avs_response'] = self
::GetNodeValue("ssl_avs_response", $Xml);
421 $processorResponse['ssl_approval_code'] = self
::GetNodeValue("ssl_approval_code", $Xml);
422 $processorResponse['errorCode'] = self
::GetNodeValue("errorCode", $Xml);
423 $processorResponse['errorName'] = self
::GetNodeValue("errorName", $Xml);
424 $processorResponse['errorMessage'] = self
::GetNodeValue("errorMessage", $Xml);
426 return $processorResponse;