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