Merge pull request #4822 from kurund/indentation-fixes
[civicrm-core.git] / CRM / Core / Payment / eWAY.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 +--------------------------------------------------------------------+
29 | eWAY Core Payment Module for CiviCRM version 4.6 & 1.9 |
30 +--------------------------------------------------------------------+
31 | Licensed to CiviCRM under the Academic Free License version 3.0 |
32 | |
33 | Written & Contributed by Dolphin Software P/L - March 2008 |
34 +--------------------------------------------------------------------+
35 | |
36 | This file is a part of CiviCRM. |
37 | |
38 | This code was initially based on the recent PayJunction module |
39 | contributed by Phase2 Technology, and then plundered bits from |
40 | the AuthorizeNet module contributed by Ideal Solution, and |
41 | referenced the eWAY code in Drupal 5.7's ecommerce-5.x-3.4 and |
42 | ecommerce-5.x-4.x-dev modules. |
43 | |
44 | Plus a bit of our own code of course - Peter Barwell |
45 | contact PB@DolphinSoftware.com.au if required. |
46 | |
47 | NOTE: This initial eWAY module does not yet allow for recuring |
48 | payments - contact Peter Barwell or add yourself (or both) |
49 | |
50 | NOTE: The eWAY gateway only allows a single currency per account |
51 | (per eWAY CustomerID) ie you can only have one currency per |
52 | added Payment Processor. |
53 | The only way to add multi-currency is to code it so that a |
54 | different CustomerID is used per currency. |
55 | |
56 +--------------------------------------------------------------------+
57 */
58
59 /**
60 -----------------------------------------------------------------------------------------------
61 From the eWAY supplied 'Web.config' dated 25-Sep-2006 - check date and update links if required
62 -----------------------------------------------------------------------------------------------
63
64 LIVE gateway with CVN
65 https://www.eway.com.au/gateway_cvn/xmlpayment.asp
66
67 LIVE gateway without CVN
68 https://www.eway.com.au/gateway/xmlpayment.asp
69
70
71 Test gateway with CVN
72 https://www.eway.com.au/gateway_cvn/xmltest/TestPage.asp
73
74 Test gateway without CVN
75 https://www.eway.com.au/gateway/xmltest/TestPage.asp
76
77
78 LIVE gateway for Stored Transactions
79 https://www.eway.com.au/gateway/xmlstored.asp
80
81
82 -----------------------------------------------------------------------------------------------
83 From the eWAY web-site - http://www.eway.com.au/Support/Developer/PaymentsRealTime.aspx
84 -----------------------------------------------------------------------------------------------
85 The test Customer ID is 87654321 - this is the only ID that will work on the test gateway.
86 The test Credit Card number is 4444333322221111
87 - this is the only credit card number that will work on the test gateway.
88 The test Total Amount should end in 00 or 08 to get a successful response (e.g. $10.00 or $10.08)
89 ie - all other amounts will return a failed response.
90
91 -----------------------------------------------------------------------------------------------
92 **/
93 class CRM_Core_Payment_eWAY extends CRM_Core_Payment {
94 # (not used, implicit in the API, might need to convert?)
95 const CHARSET = 'UTF-8';
96
97 /**
98 * We only need one instance of this object. So we use the singleton
99 * pattern and cache the instance in this variable
100 *
101 * @var object
102 * @static
103 */
104 static private $_singleton = NULL;
105
106 /**********************************************************
107 * Constructor
108 *
109 * @param string $mode the mode of operation: live or test
110 *
111 * @param $paymentProcessor
112 *
113 * @return \CRM_Core_Payment_eWAY *******************************************************
114 */
115 public function __construct($mode, &$paymentProcessor) {
116 // require Standaard eWAY API libraries
117 require_once 'eWAY/eWAY_GatewayRequest.php';
118 require_once 'eWAY/eWAY_GatewayResponse.php';
119
120 // live or test
121 $this->_mode = $mode;
122 $this->_paymentProcessor = $paymentProcessor;
123 $this->_processorName = ts('eWay');
124 }
125
126 /**
127 * Singleton function used to manage this object
128 *
129 * @param string $mode the mode of operation: live or test
130 *
131 * @param object $paymentProcessor
132 * @param null $paymentForm
133 * @param bool $force
134 *
135 * @return object
136 * @static
137 */
138 public static function &singleton($mode, &$paymentProcessor, &$paymentForm = NULL, $force = false) {
139 $processorName = $paymentProcessor['name'];
140 if (self::$_singleton[$processorName] === NULL) {
141 self::$_singleton[$processorName] = new CRM_Core_Payment_eWAY($mode, $paymentProcessor);
142 }
143 return self::$_singleton[$processorName];
144 }
145
146 /**********************************************************
147 * This function sends request and receives response from
148 * eWAY payment process
149 **********************************************************/
150 public function doDirectPayment(&$params) {
151 if (CRM_Utils_Array::value('is_recur', $params) == TRUE) {
152 CRM_Core_Error::fatal(ts('eWAY - recurring payments not implemented'));
153 }
154
155 if (!defined('CURLOPT_SSLCERT')) {
156 CRM_Core_Error::fatal(ts('eWAY - Gateway requires curl with SSL support'));
157 }
158
159 // eWAY Client ID
160 $ewayCustomerID = $this->_paymentProcessor['user_name'];
161 // eWAY Gateway URL
162 $gateway_URL = $this->_paymentProcessor['url_site'];
163
164 //------------------------------------
165 // create eWAY gateway objects
166 //------------------------------------
167 $eWAYRequest = new GatewayRequest;
168
169 if (($eWAYRequest == NULL) || (!($eWAYRequest instanceof GatewayRequest))) {
170 return self::errorExit(9001, "Error: Unable to create eWAY Request object.");
171 }
172
173 $eWAYResponse = new GatewayResponse;
174
175 if (($eWAYResponse == NULL) || (!($eWAYResponse instanceof GatewayResponse))) {
176 return self::errorExit(9002, "Error: Unable to create eWAY Response object.");
177 }
178
179 /*
180 //-------------------------------------------------------------
181 // NOTE: eWAY Doesn't use the following at the moment:
182 //-------------------------------------------------------------
183 $creditCardType = $params['credit_card_type'];
184 $currentcyID = $params['currencyID'];
185 $country = $params['country'];
186 */
187
188
189 //-------------------------------------------------------------
190 // Prepare some composite data from _paymentProcessor fields
191 //-------------------------------------------------------------
192 $fullAddress = $params['street_address'] . ", " . $params['city'] . ", " . $params['state_province'] . ".";
193 $expireYear = substr($params['year'], 2, 2);
194 $expireMonth = sprintf('%02d', (int) $params['month']);
195 // CiviCRM V1.9 - Picks up reasonable description
196 //$description = $params['amount_level'];
197 // CiviCRM V2.0 - Picks up description
198 $description = $params['description'];
199 $txtOptions = "";
200
201 $amountInCents = round(((float) $params['amount']) * 100);
202
203 $credit_card_name = $params['first_name'] . " ";
204 if (strlen($params['middle_name']) > 0) {
205 $credit_card_name .= $params['middle_name'] . " ";
206 }
207 $credit_card_name .= $params['last_name'];
208
209 //----------------------------------------------------------------------------------------------------
210 // We use CiviCRM's param's 'invoiceID' as the unique transaction token to feed to eWAY
211 // Trouble is that eWAY only accepts 16 chars for the token, while CiviCRM's invoiceID is an 32.
212 // As its made from a "$invoiceID = md5(uniqid(rand(), true));" then using the fierst 16 chars
213 // should be alright
214 //----------------------------------------------------------------------------------------------------
215 $uniqueTrnxNum = substr($params['invoiceID'], 0, 16);
216
217 //----------------------------------------------------------------------------------------------------
218 // OPTIONAL: If TEST Card Number force an Override of URL and CutomerID.
219 // During testing CiviCRM once used the LIVE URL.
220 // This code can be uncommented to override the LIVE URL that if CiviCRM does that again.
221 //----------------------------------------------------------------------------------------------------
222 // if ( ( $gateway_URL == "https://www.eway.com.au/gateway_cvn/xmlpayment.asp")
223 // && ( $params['credit_card_number'] == "4444333322221111" ) ) {
224 // $ewayCustomerID = "87654321";
225 // $gateway_URL = "https://www.eway.com.au/gateway_cvn/xmltest/testpage.asp";
226 // }
227
228 //----------------------------------------------------------------------------------------------------
229 // Now set the payment details - see http://www.eway.com.au/Support/Developer/PaymentsRealTime.aspx
230 //----------------------------------------------------------------------------------------------------
231 // 8 Chars - ewayCustomerID - Required
232 $eWAYRequest->EwayCustomerID($ewayCustomerID);
233 // 12 Chars - ewayTotalAmount (in cents) - Required
234 $eWAYRequest->InvoiceAmount($amountInCents);
235 // 50 Chars - ewayCustomerFirstName
236 $eWAYRequest->PurchaserFirstName($params['first_name']);
237 // 50 Chars - ewayCustomerLastName
238 $eWAYRequest->PurchaserLastName($params['last_name']);
239 // 50 Chars - ewayCustomerEmail
240 $eWAYRequest->PurchaserEmailAddress($params['email']);
241 // 255 Chars - ewayCustomerAddress
242 $eWAYRequest->PurchaserAddress($fullAddress);
243 // 6 Chars - ewayCustomerPostcode
244 $eWAYRequest->PurchaserPostalCode($params['postal_code']);
245 // 1000 Chars - ewayCustomerInvoiceDescription
246 $eWAYRequest->InvoiceDescription($description);
247 // 50 Chars - ewayCustomerInvoiceRef
248 $eWAYRequest->InvoiceReference($params['invoiceID']);
249 // 50 Chars - ewayCardHoldersName - Required
250 $eWAYRequest->CardHolderName($credit_card_name);
251 // 20 Chars - ewayCardNumber - Required
252 $eWAYRequest->CardNumber($params['credit_card_number']);
253 // 2 Chars - ewayCardExpiryMonth - Required
254 $eWAYRequest->CardExpiryMonth($expireMonth);
255 // 2 Chars - ewayCardExpiryYear - Required
256 $eWAYRequest->CardExpiryYear($expireYear);
257 // 4 Chars - ewayCVN - Required if CVN Gateway used
258 $eWAYRequest->CVN($params['cvv2']);
259 // 16 Chars - ewayTrxnNumber
260 $eWAYRequest->TransactionNumber($uniqueTrnxNum);
261 // 255 Chars - ewayOption1
262 $eWAYRequest->EwayOption1($txtOptions);
263 // 255 Chars - ewayOption2
264 $eWAYRequest->EwayOption2($txtOptions);
265 // 255 Chars - ewayOption3
266 $eWAYRequest->EwayOption3($txtOptions);
267
268 $eWAYRequest->CustomerIPAddress($params['ip_address']);
269 $eWAYRequest->CustomerBillingCountry($params['country']);
270
271 // Allow further manipulation of the arguments via custom hooks ..
272 CRM_Utils_Hook::alterPaymentProcessorParams($this, $params, $eWAYRequest);
273
274 //----------------------------------------------------------------------------------------------------
275 // Check to see if we have a duplicate before we send
276 //----------------------------------------------------------------------------------------------------
277 if ($this->_checkDupe($params['invoiceID'])) {
278 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 from eWAY. 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.');
279 }
280
281 //----------------------------------------------------------------------------------------------------
282 // Convert to XML and send the payment information
283 //----------------------------------------------------------------------------------------------------
284 $requestxml = $eWAYRequest->ToXML();
285
286 $submit = curl_init($gateway_URL);
287
288 if (!$submit) {
289 return self::errorExit(9004, 'Could not initiate connection to payment gateway');
290 }
291
292 curl_setopt($submit, CURLOPT_POST, TRUE);
293 // return the result on success, FALSE on failure
294 curl_setopt($submit, CURLOPT_RETURNTRANSFER, TRUE);
295 curl_setopt($submit, CURLOPT_POSTFIELDS, $requestxml);
296 curl_setopt($submit, CURLOPT_TIMEOUT, 36000);
297 // if open_basedir or safe_mode are enabled in PHP settings CURLOPT_FOLLOWLOCATION won't work so don't apply it
298 // it's not really required CRM-5841
299 if (ini_get('open_basedir') == '' && ini_get('safe_mode' == 'Off')) {
300 // ensures any Location headers are followed
301 curl_setopt($submit, CURLOPT_FOLLOWLOCATION, 1);
302 }
303
304 // Send the data out over the wire
305 //--------------------------------
306 $responseData = curl_exec($submit);
307
308 //----------------------------------------------------------------------------------------------------
309 // See if we had a curl error - if so tell 'em and bail out
310 //
311 // NOTE: curl_error does not return a logical value (see its documentation), but
312 // a string, which is empty when there was no error.
313 //----------------------------------------------------------------------------------------------------
314 if ((curl_errno($submit) > 0) || (strlen(curl_error($submit)) > 0)) {
315 $errorNum = curl_errno($submit);
316 $errorDesc = curl_error($submit);
317
318 // Paranoia - in the unlikley event that 'curl' errno fails
319 if ($errorNum == 0)
320 $errorNum = 9005;
321
322 // Paranoia - in the unlikley event that 'curl' error fails
323 if (strlen($errorDesc) == 0)
324 $errorDesc = "Connection to eWAY payment gateway failed";
325
326 return self::errorExit($errorNum, $errorDesc);
327 }
328
329 //----------------------------------------------------------------------------------------------------
330 // If null data returned - tell 'em and bail out
331 //
332 // NOTE: You will not necessarily get a string back, if the request failed for
333 // any reason, the return value will be the boolean false.
334 //----------------------------------------------------------------------------------------------------
335 if (($responseData === FALSE) || (strlen($responseData) == 0)) {
336 return self::errorExit(9006, "Error: Connection to payment gateway failed - no data returned.");
337 }
338
339 //----------------------------------------------------------------------------------------------------
340 // If gateway returned no data - tell 'em and bail out
341 //----------------------------------------------------------------------------------------------------
342 if (empty($responseData)) {
343 return self::errorExit(9007, "Error: No data returned from payment gateway.");
344 }
345
346 //----------------------------------------------------------------------------------------------------
347 // Success so far - close the curl and check the data
348 //----------------------------------------------------------------------------------------------------
349 curl_close($submit);
350
351 //----------------------------------------------------------------------------------------------------
352 // Payment successfully sent to gateway - process the response now
353 //----------------------------------------------------------------------------------------------------
354 $eWAYResponse->ProcessResponse($responseData);
355
356 //----------------------------------------------------------------------------------------------------
357 // See if we got an OK result - if not tell 'em and bail out
358 //----------------------------------------------------------------------------------------------------
359 if (self::isError($eWAYResponse)) {
360 $eWayTrxnError = $eWAYResponse->Error();
361 CRM_Core_Error::debug_var('eWay Error', $eWayTrxnError, TRUE, TRUE);
362 if (substr($eWayTrxnError, 0, 6) == "Error:") {
363 return self::errorExit(9008, $eWayTrxnError);
364 }
365 $eWayErrorCode = substr($eWayTrxnError, 0, 2);
366 $eWayErrorDesc = substr($eWayTrxnError, 3);
367
368 return self::errorExit(9008, "Error: [" . $eWayErrorCode . "] - " . $eWayErrorDesc . ".");
369 }
370
371 //-----------------------------------------------------------------------------------------------------
372 // Cross-Check - the unique 'TrxnReference' we sent out should match the just received 'TrxnReference'
373 //
374 // PLEASE NOTE: If this occurs (which is highly unlikely) its a serious error as it would mean we have
375 // received an OK status from eWAY, but their Gateway has not returned the correct unique
376 // token - ie something is broken, BUT money has been taken from the client's account,
377 // so we can't very well error-out as CiviCRM will then not process the registration.
378 // There is an error message commented out here but my prefered response to this unlikley
379 // possibility is to email 'support@eWAY.com.au'
380 //-----------------------------------------------------------------------------------------------------
381 $eWayTrxnReference_OUT = $eWAYRequest->GetTransactionNumber();
382 $eWayTrxnReference_IN = $eWAYResponse->InvoiceReference();
383
384 if ($eWayTrxnReference_IN != $eWayTrxnReference_OUT) {
385 // return self::errorExit( 9009, "Error: Unique Trxn code was not returned by eWAY Gateway. This is extremely unusual! Please contact the administrator of this site immediately with details of this transaction.");
386
387 self::send_alert_email($eWAYResponse->TransactionNumber(),
388 $eWayTrxnReference_OUT, $eWayTrxnReference_IN, $requestxml, $responseData
389 );
390 }
391
392 /*
393 //----------------------------------------------------------------------------------------------------
394 // Test mode always returns trxn_id = 0 - so we fix that here
395 //
396 // NOTE: This code was taken from the AuthorizeNet payment processor, however it now appears
397 // unecessary for the eWAY gateway - Left here in case it proves useful
398 //----------------------------------------------------------------------------------------------------
399 if ( $this->_mode == 'test' ) {
400 $query = "SELECT MAX(trxn_id) FROM civicrm_contribution WHERE trxn_id LIKE 'test%'";
401 $p = array( );
402 $trxn_id = strval( CRM_Core_Dao::singleValueQuery( $query, $p ) );
403 $trxn_id = str_replace( 'test', '', $trxn_id );
404 $trxn_id = intval($trxn_id) + 1;
405 $params['trxn_id'] = sprintf('test%08d', $trxn_id);
406 } else {
407 $params['trxn_id'] = $eWAYResponse->TransactionNumber();
408 }
409 */
410
411
412 //=============
413 // Success !
414 //=============
415 $beaglestatus = $eWAYResponse->BeagleScore();
416 if (!empty($beaglestatus)) {
417 $beaglestatus = ": " . $beaglestatus;
418 }
419 $params['trxn_result_code'] = $eWAYResponse->Status() . $beaglestatus;
420 $params['gross_amount'] = $eWAYResponse->Amount();
421 $params['trxn_id'] = $eWAYResponse->TransactionNumber();
422
423 return $params;
424 }
425 // end function doDirectPayment
426
427 /**
428 * Checks to see if invoice_id already exists in db
429 *
430 * @param int $invoiceId The ID to check
431 *
432 * @return bool True if ID exists, else false
433 */
434 public function _checkDupe($invoiceId) {
435 $contribution = new CRM_Contribute_DAO_Contribution();
436 $contribution->invoice_id = $invoiceId;
437 return $contribution->find();
438 }
439
440 /*************************************************************************************************
441 * This function checks the eWAY response status - returning a boolean false if status != 'true'
442 *************************************************************************************************/
443 public function isError(&$response) {
444 $status = $response->Status();
445
446 if ((stripos($status, "true")) === FALSE) {
447 return TRUE;
448 }
449 return FALSE;
450 }
451
452 /**************************************************
453 * Produces error message and returns from class
454 **************************************************/
455 public function &errorExit($errorCode = NULL, $errorMessage = NULL) {
456 $e = CRM_Core_Error::singleton();
457
458 if ($errorCode) {
459 $e->push($errorCode, 0, NULL, $errorMessage);
460 }
461 else {
462 $e->push(9000, 0, NULL, 'Unknown System Error.');
463 }
464 return $e;
465 }
466
467 /**************************************************
468 * NOTE: 'doTransferCheckout' not implemented
469 **************************************************/
470 public function doTransferCheckout(&$params, $component) {
471 CRM_Core_Error::fatal(ts('This function is not implemented'));
472 }
473
474 /********************************************************************************************
475 * This public function checks to see if we have the right processor config values set
476 *
477 * NOTE: Called by Events and Contribute to check config params are set prior to trying
478 * register any credit card details
479 *
480 * @return null|string
481 * @internal param string $mode the mode we are operating in (live or test) - not used but could be
482 * to check that the 'test' mode CustomerID was equal to '87654321' and that the URL was
483 * set to https://www.eway.com.au/gateway_cvn/xmltest/TestPage.asp
484 *
485 * returns string $errorMsg if any errors found - null if OK
486 *
487 ******************************************************************************************
488 */
489 //function checkConfig( $mode ) // CiviCRM V1.9 Declaration
490 // CiviCRM V2.0 Declaration
491 public function checkConfig() {
492 $errorMsg = array();
493
494 if (empty($this->_paymentProcessor['user_name'])) {
495 $errorMsg[] = ts('eWAY CustomerID is not set for this payment processor');
496 }
497
498 if (empty($this->_paymentProcessor['url_site'])) {
499 $errorMsg[] = ts('eWAY Gateway URL is not set for this payment processor');
500 }
501
502 if (!empty($errorMsg)) {
503 return implode('<p>', $errorMsg);
504 }
505 else {
506 return NULL;
507 }
508 }
509
510 /**
511 * @param $p_eWAY_tran_num
512 * @param $p_trxn_out
513 * @param $p_trxn_back
514 * @param $p_request
515 * @param $p_response
516 */
517 public function send_alert_email($p_eWAY_tran_num, $p_trxn_out, $p_trxn_back, $p_request, $p_response) {
518 // Initialization call is required to use CiviCRM APIs.
519 civicrm_initialize(TRUE);
520
521
522 list($fromName, $fromEmail) = CRM_Core_BAO_Domain::getNameAndEmail();
523 $from = "$fromName <$fromEmail>";
524
525 $toName = 'Support at eWAY';
526 $toEmail = 'Support@eWAY.com.au';
527
528 $subject = "ALERT: Unique Trxn Number Failure : eWAY Transaction # = [" . $p_eWAY_tran_num . "]";
529
530 $message = "
531 TRXN sent out with request = '$p_trxn_out'.
532 TRXN sent back with response = '$p_trxn_back'.
533
534 This is a ['$this->_mode'] transaction.
535
536
537 Request XML =
538 ---------------------------------------------------------------------------
539 $p_request
540 ---------------------------------------------------------------------------
541
542
543 Response XML =
544 ---------------------------------------------------------------------------
545 $p_response
546 ---------------------------------------------------------------------------
547
548
549 Regards
550
551 The CiviCRM eWAY Payment Processor Module
552 ";
553 //$cc = 'Name@Domain';
554
555 // create the params array
556 $params = array();
557
558 $params['groupName'] = 'eWay Email Sender';
559 $params['from'] = $from;
560 $params['toName'] = $toName;
561 $params['toEmail'] = $toEmail;
562 $params['subject'] = $subject;
563 $params['cc'] = $cc;
564 $params['text'] = $message;
565
566 CRM_Utils_Mail::send($params);
567 }
568 }
569 // end class CRM_Core_Payment_eWAY