[civicrm-core.git] / CRM / Core / Payment / FirstData.php

<?php
/*
 +--------------------------------------------------------------------+
 | FirstData Core Payment Module for CiviCRM version 4.6              |
 +--------------------------------------------------------------------+
 | Licensed to CiviCRM under the Academic Free License version 3.0    |
 |                                                                    |
 | Written & Contributed by Eileen McNaughton - Nov March 2008        |
 +--------------------------------------------------------------------+
 |  This processor is based heavily on the Eway processor by Peter    |
 |Barwell                                                             |
 |                                                                    |
 |                                                                    |
 +--------------------------------------------------------------------+
*/

/**
 Note that in order to use FirstData / LinkPoint you need a certificate (.pem) file issued by them
 and a store number. You can configure the path to the certificate and the store number
 through the front end of civiCRM. The path is as seen by the server not the url
 -----------------------------------------------------------------------------------------------
 The basic functionality of this processor is that variables from the $params object are transformed
 into xml using a function provided by the processor. The xml is submitted to the processor's https site
 using curl and the response is translated back into an array using the processor's function.

 If an array ($params) is returned to the calling function it is treated as a success and the values from
 the array are merged into the calling functions array.

 If an result of class error is returned it is treated as a failure

 -----------------------------------------------------------------------------------------------
 **/

/*From Payment processor documentation
For testing purposes, you can use any of the card numbers listed below. The test card numbers
will not result in any charges to the card. Use these card numbers with any expiration date in the
future.
     Visa Level 2 - 4275330012345675 (replies with a referral message)
     JCB - 3566007770003510
     Discover - 6011000993010978
     MasterCard - 5424180279791765
     Visa - 4005550000000019 or 4111111111111111
     MasterCard Level 2 - 5404980000008386
     Diners - 36555565010005
     Amex - 372700997251009
*
***************************
*Lines starting with CRM_Core_Error::debug_log_message output messages to files/upload/civicrm.log - you may with to comment them out once it is working satisfactorily

*For live testing uncomment the result field below and set the value to the response you wish to get from the payment processor
***************************/
class CRM_Core_Payment_FirstData extends CRM_Core_Payment {
  # (not used, implicit in the API, might need to convert?)
  const CHARSET = 'UFT-8';

  /**
   * We only need one instance of this object. So we use the singleton
   * pattern and cache the instance in this variable
   *
   * @var object
   * @static
   */
  static private $_singleton = NULL;

  /**********************************************************
   * Constructor
   *
   * @param string $mode the mode of operation: live or test
   *
   * @param $paymentProcessor
   *
   * @return \CRM_Core_Payment_FirstData *******************************************************
   */
  public function __construct($mode, &$paymentProcessor) {
    // live or test
    $this->_mode = $mode;
    $this->_paymentProcessor = $paymentProcessor;
  }

  /**
   * Singleton function used to manage this object
   *
   * @param string $mode the mode of operation: live or test
   *
   * @param object $paymentProcessor
   *
   * @return object
   * @static
   */
  public static function &singleton($mode, &$paymentProcessor) {
    if (!empty($paymentProcessor['id'])) {
      $cacheKey = $paymentProcessor['id'];
    }
    else {
      //@todo eliminated instances of this in favour of id-specific instances.
      $cacheKey = $mode . '_' . $paymentProcessor['name'];
    }
    if (self::$_singleton[$cacheKey] === NULL) {
      self::$_singleton[$cacheKey] = new CRM_Core_Payment_FirstData($mode, $paymentProcessor);
    }
    return self::$_singleton[$cacheKey];
  }

  /**********************************************************
   * This function is set up and put here to make the mapping of fields
   * from the params object  as visually clear as possible for easy editing
   *
   *  Comment out irrelevant fields
   **********************************************************/
  public function mapProcessorFieldstoParams($params) {
    /*concatenate full customer name first  - code from EWAY gateway
         */

    $credit_card_name = $params['first_name'] . " ";
    if (strlen($params['middle_name']) > 0) {
      $credit_card_name .= $params['middle_name'] . " ";
    }
    $credit_card_name .= $params['last_name'];

    //compile array

    /**********************************************************
     *    Payment Processor field name         **fields from $params array   ***
     *******************************************************************/

    $requestFields['cardnumber'] = $params['credit_card_number'];
    $requestFields['chargetotal'] = $params['amount'];
    $requestFields['cardexpmonth'] = sprintf('%02d', (int) $params['month']);
    $requestFields['cardexpyear'] = substr($params['year'], 2, 2);
    $requestFields['cvmvalue'] = $params['cvv2'];
    $requestFields['cvmindicator'] = "provided";
    $requestFields['name'] = $credit_card_name;
    $requestFields['address1'] = $params['street_address'];
    $requestFields['city'] = $params['city'];
    $requestFields['state'] = $params['state_province'];
    $requestFields['zip'] = $params['postal_code'];
    $requestFields['country'] = $params['country'];
    $requestFields['email'] = $params['email'];
    $requestFields['ip'] = $params['ip_address'];
    $requestFields['transactionorigin'] = "Eci";
    #32 character string
    $requestFields['invoice_number'] = $params['invoiceID'];
    $requestFields['ordertype'] = $params['payment_action'];
    $requestFields['comments'] = $params['description'];
    //**********************set 'result' for live testing **************************
    //  $requestFields[       'result'  ]      =    "";  #set to "Good", "Decline" or "Duplicate"
    //  $requestFields[       ''  ]          =  $params[ 'qfKey'        ];
    //  $requestFields[       ''  ]          =  $params[ 'amount_other'      ];
    //  $requestFields[       ''  ]          =  $params[ 'billing_first_name'    ];
    //  $requestFields[       ''  ]          =  $params[ 'billing_middle_name'    ];
    //  $requestFields[       ''  ]          =  $params[ 'billing_last_name'  ];

    //  $requestFields[       ''  ]          =  $params[ 'contributionType_name'  ];
    //  $requestFields[       ''  ]          =  $params[ 'contributionPageID'  ];
    //  $requestFields[       ''  ]          =  $params[ 'contributionType_accounting_code'  ];
    //  $requestFields[       ''  ]          =  $params['amount_level'  ];
    //  $requestFields[       ''  ]          =  $params['credit_card_type'  ];
    //  $requestFields[       'addrnum'  ]    =  numeric portion of street address - not yet implemented
    //  $requestFields[       'taxexempt'  ]   taxexempt status (Y or N) - not implemented

    return $requestFields;
  }

  /**********************************************************
   * This function sends request and receives response from
   * the processor
   **********************************************************/
  public function doDirectPayment(&$params) {
    if ($params['is_recur'] == TRUE) {
      CRM_Core_Error::fatal(ts('%1 - recurring payments not implemented', array(1 => $paymentProcessor)));
    }

    if (!defined('CURLOPT_SSLCERT')) {
      CRM_Core_Error::fatal(ts('%1 - Gateway requires curl with SSL support', array(1 => $paymentProcessor)));
    }

    /**********************************************************
     * Create the array of variables to be sent to the processor from the $params array
     * passed into this function
     **********************************************************/
    $requestFields = self::mapProcessorFieldstoParams($params);

    /**********************************************************
     * create FirstData request object
     **********************************************************/
    require_once 'FirstData/lphp.php';
    //  $mylphp=new lphp;

    /**********************************************************
     * define variables for connecting with the gateway
     **********************************************************/

    # Name and location of certificate file
    $key = $this->_paymentProcessor['password'];
    # Your store number
    $requestFields["configfile"] = $this->_paymentProcessor['user_name'];
    $port = "1129";
    $host = $this->_paymentProcessor['url_site'] . ":" . $port . "/LSGSXML";


    //----------------------------------------------------------------------------------------------------
    // Check to see if we have a duplicate before we send
    //----------------------------------------------------------------------------------------------------
    if ($this->_checkDupe($params['invoiceID'])) {
      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.');
    }
    //----------------------------------------------------------------------------------------------------
    // Convert to XML using function provided by payment processor
    //----------------------------------------------------------------------------------------------------
    $requestxml = lphp::buildXML($requestFields);


    /*----------------------------------------------------------------------------------------------------
         // Send to the payment information using cURL
         /----------------------------------------------------------------------------------------------------
        */


    $ch = curl_init($host);
    if (!$ch) {
      return self::errorExit(9004, 'Could not initiate connection to payment gateway');
    }


    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $requestxml);
    curl_setopt($ch, CURLOPT_SSLCERT, $key);
    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'verifySSL') ? 2 : 0);
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'verifySSL'));
    // return the result on success, FALSE on failure
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($ch, CURLOPT_TIMEOUT, 36000);
    // ensures any Location headers are followed
    if (ini_get('open_basedir') == '' && ini_get('safe_mode') == 'Off') {
      curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
    }

    // Send the data out over the wire
    //--------------------------------
    $responseData = curl_exec($ch);

    //----------------------------------------------------------------------------------------------------
    // See if we had a curl error - if so tell 'em and bail out
    //
    // NOTE: curl_error does not return a logical value (see its documentation), but
    //       a string, which is empty when there was no error.
    //----------------------------------------------------------------------------------------------------
    if ((curl_errno($ch) > 0) || (strlen(curl_error($ch)) > 0)) {
      $errorNum = curl_errno($ch);
      $errorDesc = curl_error($ch);

      // Paranoia - in the unlikley event that 'curl' errno fails
      if ($errorNum == 0)
      $errorNum = 9005;

      // Paranoia - in the unlikley event that 'curl' error fails
      if (strlen($errorDesc) == 0)
      $errorDesc = "Connection to payment gateway failed";
      if ($errorNum == 60) {
        return self::errorExit($errorNum, "Curl error - " . $errorDesc . " Try this link for more information http://curl.haxx.se/docs/sslcerts.html");
      }

      return self::errorExit($errorNum, "Curl error - " . $errorDesc . " your key is located at " . $key . " the url is " . $host . " xml is " . $requestxml . " processor response = " . $processorResponse);
    }

    //----------------------------------------------------------------------------------------------------
    // If null data returned - tell 'em and bail out
    //
    // NOTE: You will not necessarily get a string back, if the request failed for
    //       any reason, the return value will be the boolean false.
    //----------------------------------------------------------------------------------------------------
    if (($responseData === FALSE) || (strlen($responseData) == 0)) {
      return self::errorExit(9006, "Error: Connection to payment gateway failed - no data returned.");
    }

    //----------------------------------------------------------------------------------------------------
    // If gateway returned no data - tell 'em and bail out
    //----------------------------------------------------------------------------------------------------
    if (empty($responseData)) {
      return self::errorExit(9007, "Error: No data returned from payment gateway.");
    }

    //----------------------------------------------------------------------------------------------------
    // Success so far - close the curl and check the data
    //----------------------------------------------------------------------------------------------------
    curl_close($ch);

    //----------------------------------------------------------------------------------------------------
    // Payment successfully sent to gateway - process the response now
    //----------------------------------------------------------------------------------------------------
    //
    $processorResponse = lphp::decodeXML($responseData);

    // transaction failed, print the reason
    if ($processorResponse["r_approved"] != "APPROVED") {
      return self::errorExit(9009, "Error: [" . $processorResponse['r_error'] . "] - from payment processor");
    }
    else {

      //-----------------------------------------------------------------------------------------------------
      // Cross-Check - the unique 'TrxnReference' we sent out should match the just received 'TrxnReference'
      //
      // this section not used as the processor doesn't appear to pass back our invoice no. Code in eWay model if
      // used later
      //-----------------------------------------------------------------------------------------------------

      //=============
      // Success !
      //=============
      $params['trxn_result_code'] = $processorResponse['r_message'];
      $params['trxn_id'] = $processorResponse['r_ref'];
      CRM_Core_Error::debug_log_message("r_authresponse " . $processorResponse['r_authresponse']);
      CRM_Core_Error::debug_log_message("r_code " . $processorResponse['r_code']);
      CRM_Core_Error::debug_log_message("r_tdate " . $processorResponse['r_tdate']);
      CRM_Core_Error::debug_log_message("r_avs " . $processorResponse['r_avs']);
      CRM_Core_Error::debug_log_message("r_ordernum " . $processorResponse['r_ordernum']);
      CRM_Core_Error::debug_log_message("r_error " . $processorResponse['r_error']);
      CRM_Core_Error::debug_log_message("csp " . $processorResponse['r_csp']);
      CRM_Core_Error::debug_log_message("r_message " . $processorResponse['r_message']);
      CRM_Core_Error::debug_log_message("r_ref " . $processorResponse['r_ref']);
      CRM_Core_Error::debug_log_message("r_time " . $processorResponse['r_time']);
      return $params;
    }
  }
  // end function doDirectPayment

  /**
   * Checks to see if invoice_id already exists in db
   *
   * @param  int     $invoiceId   The ID to check
   *
   * @return bool                  True if ID exists, else false
   */
  public function _checkDupe($invoiceId) {
    $contribution = new CRM_Contribute_DAO_Contribution();
    $contribution->invoice_id = $invoiceId;
    return $contribution->find();
  }

  /**************************************************
   * Produces error message and returns from class
   **************************************************/
  public function &errorExit($errorCode = NULL, $errorMessage = NULL) {
    $e = CRM_Core_Error::singleton();

    if ($errorCode) {
      $e->push($errorCode, 0, NULL, $errorMessage);
    }
    else {
      $e->push(9000, 0, NULL, 'Unknown System Error.');
    }
    return $e;
  }

  /**************************************************
   * NOTE: 'doTransferCheckout' not implemented
   **************************************************/
  public function doTransferCheckout(&$params, $component) {
    CRM_Core_Error::fatal(ts('This function is not implemented'));
  }

  /********************************************************************************************
   * This public function checks to see if we have the right processor config values set
   *
   * NOTE: Called by Events and Contribute to check config params are set prior to trying
   *       register any credit card details
   *
   * @return null|string
   * @internal param string $mode the mode we are operating in (live or test) - not used
   *
   * returns string $errorMsg if any errors found - null if OK
   *
   ******************************************************************************************
   */
  //  function checkConfig( $mode )          // CiviCRM V1.9 Declaration
  // CiviCRM V2.0 Declaration
  public function checkConfig() {
    $errorMsg = array();

    if (empty($this->_paymentProcessor['user_name'])) {
      $errorMsg[] = ts(' Store Name is not set for this payment processor');
    }

    if (empty($this->_paymentProcessor['url_site'])) {
      $errorMsg[] = ts(' URL is not set for this payment processor');
    }

    if (!empty($errorMsg)) {
      return implode('<p>', $errorMsg);
    }
    else {
      return NULL;
    }
  }
}
// end class CRM_Core_Payment_FirstData
Commit	Line	Data
6a488035 TO	1	<?php
	2	/*
	3	+--------------------------------------------------------------------+
39de6fd5	4	\| FirstData Core Payment Module for CiviCRM version 4.6 \|
6a488035 TO	5	+--------------------------------------------------------------------+
	6	\| Licensed to CiviCRM under the Academic Free License version 3.0 \|
	7	\| \|
	8	\| Written & Contributed by Eileen McNaughton - Nov March 2008 \|
	9	+--------------------------------------------------------------------+
	10	\| This processor is based heavily on the Eway processor by Peter \|
	11	\|Barwell \|
	12	\| \|
	13	\| \|
	14	+--------------------------------------------------------------------+
	15	*/
	16
	17	/**
	18	Note that in order to use FirstData / LinkPoint you need a certificate (.pem) file issued by them
	19	and a store number. You can configure the path to the certificate and the store number
	20	through the front end of civiCRM. The path is as seen by the server not the url
	21	-----------------------------------------------------------------------------------------------
	22	The basic functionality of this processor is that variables from the $params object are transformed
	23	into xml using a function provided by the processor. The xml is submitted to the processor's https site
	24	using curl and the response is translated back into an array using the processor's function.
	25
	26	If an array ($params) is returned to the calling function it is treated as a success and the values from
	27	the array are merged into the calling functions array.
	28
	29	If an result of class error is returned it is treated as a failure
	30
	31	-----------------------------------------------------------------------------------------------
	32	**/
	33
	34	/*From Payment processor documentation
	35	For testing purposes, you can use any of the card numbers listed below. The test card numbers
	36	will not result in any charges to the card. Use these card numbers with any expiration date in the
	37	future.
	38	Visa Level 2 - 4275330012345675 (replies with a referral message)
	39	JCB - 3566007770003510
	40	Discover - 6011000993010978
	41	MasterCard - 5424180279791765
	42	Visa - 4005550000000019 or 4111111111111111
	43	MasterCard Level 2 - 5404980000008386
	44	Diners - 36555565010005
	45	Amex - 372700997251009
	46	*
	47	***************************
	48	*Lines starting with CRM_Core_Error::debug_log_message output messages to files/upload/civicrm.log - you may with to comment them out once it is working satisfactorily
	49
	50	*For live testing uncomment the result field below and set the value to the response you wish to get from the payment processor
	51	***************************/
	52	class CRM_Core_Payment_FirstData extends CRM_Core_Payment {
	53	# (not used, implicit in the API, might need to convert?)
7da04cde	54	const CHARSET = 'UFT-8';
6a488035 TO	55
	56	/**
	57	* We only need one instance of this object. So we use the singleton
	58	* pattern and cache the instance in this variable
	59	*
	60	* @var object
	61	* @static
	62	*/
	63	static private $_singleton = NULL;
	64
	65	/**********************************************************
	66	* Constructor
	67	*
	68	* @param string $mode the mode of operation: live or test
	69	*
77b97be7 EM	70	* @param $paymentProcessor
	71	*
	72	* @return \CRM_Core_Payment_FirstData *******************************************************
	73	*/
00be9182	74	public function __construct($mode, &$paymentProcessor) {
6a488035 TO	75	// live or test
	76	$this->_mode = $mode;
	77	$this->_paymentProcessor = $paymentProcessor;
	78	}
	79
	80	/**
100fef9d	81	* Singleton function used to manage this object
6a488035 TO	82	*
	83	* @param string $mode the mode of operation: live or test
	84	*
77b97be7 EM	85	* @param object $paymentProcessor
77b97be7 EM	86	*
6a488035 TO	87	* @return object
6a488035 TO	88	* @static
6a488035	89	*/
00be9182	90	public static function &singleton($mode, &$paymentProcessor) {
52767de0 EM	91	if (!empty($paymentProcessor['id'])) {
52767de0 EM	92	$cacheKey = $paymentProcessor['id'];
6a488035	93	}
52767de0 EM	94	else {
	95	//@todo eliminated instances of this in favour of id-specific instances.
	96	$cacheKey = $mode . '_' . $paymentProcessor['name'];
	97	}
	98	if (self::$_singleton[$cacheKey] === NULL) {
	99	self::$_singleton[$cacheKey] = new CRM_Core_Payment_FirstData($mode, $paymentProcessor);
	100	}
	101	return self::$_singleton[$cacheKey];
6a488035 TO	102	}
	103
	104	/**********************************************************
	105	* This function is set up and put here to make the mapping of fields
	106	* from the params object as visually clear as possible for easy editing
	107	*
	108	* Comment out irrelevant fields
	109	**********************************************************/
00be9182	110	public function mapProcessorFieldstoParams($params) {
6a488035 TO	111	/*concatenate full customer name first - code from EWAY gateway
	112	*/
	113
	114	$credit_card_name = $params['first_name'] . " ";
	115	if (strlen($params['middle_name']) > 0) {
	116	$credit_card_name .= $params['middle_name'] . " ";
	117	}
	118	$credit_card_name .= $params['last_name'];
	119
	120	//compile array
	121
	122	/**********************************************************
	123	* Payment Processor field name fields from $params array *
	124	*******************************************************************/
	125
	126	$requestFields['cardnumber'] = $params['credit_card_number'];
	127	$requestFields['chargetotal'] = $params['amount'];
	128	$requestFields['cardexpmonth'] = sprintf('%02d', (int) $params['month']);
	129	$requestFields['cardexpyear'] = substr($params['year'], 2, 2);
	130	$requestFields['cvmvalue'] = $params['cvv2'];
	131	$requestFields['cvmindicator'] = "provided";
	132	$requestFields['name'] = $credit_card_name;
	133	$requestFields['address1'] = $params['street_address'];
	134	$requestFields['city'] = $params['city'];
	135	$requestFields['state'] = $params['state_province'];
	136	$requestFields['zip'] = $params['postal_code'];
	137	$requestFields['country'] = $params['country'];
	138	$requestFields['email'] = $params['email'];
	139	$requestFields['ip'] = $params['ip_address'];
	140	$requestFields['transactionorigin'] = "Eci";
	141	#32 character string
	142	$requestFields['invoice_number'] = $params['invoiceID'];
	143	$requestFields['ordertype'] = $params['payment_action'];
	144	$requestFields['comments'] = $params['description'];
	145	//********************set 'result' for live testing ************************
	146	// $requestFields[ 'result' ] = ""; #set to "Good", "Decline" or "Duplicate"
	147	// $requestFields[ '' ] = $params[ 'qfKey' ];
	148	// $requestFields[ '' ] = $params[ 'amount_other' ];
	149	// $requestFields[ '' ] = $params[ 'billing_first_name' ];
	150	// $requestFields[ '' ] = $params[ 'billing_middle_name' ];
	151	// $requestFields[ '' ] = $params[ 'billing_last_name' ];
	152
	153	// $requestFields[ '' ] = $params[ 'contributionType_name' ];
	154	// $requestFields[ '' ] = $params[ 'contributionPageID' ];
	155	// $requestFields[ '' ] = $params[ 'contributionType_accounting_code' ];
	156	// $requestFields[ '' ] = $params['amount_level' ];
	157	// $requestFields[ '' ] = $params['credit_card_type' ];
	158	// $requestFields[ 'addrnum' ] = numeric portion of street address - not yet implemented
	159	// $requestFields[ 'taxexempt' ] taxexempt status (Y or N) - not implemented
	160
	161	return $requestFields;
	162	}
	163
	164	/**********************************************************
	165	* This function sends request and receives response from
	166	* the processor
	167	**********************************************************/
00be9182	168	public function doDirectPayment(&$params) {
6a488035 TO	169	if ($params['is_recur'] == TRUE) {
	170	CRM_Core_Error::fatal(ts('%1 - recurring payments not implemented', array(1 => $paymentProcessor)));
	171	}
	172
	173	if (!defined('CURLOPT_SSLCERT')) {
	174	CRM_Core_Error::fatal(ts('%1 - Gateway requires curl with SSL support', array(1 => $paymentProcessor)));
	175	}
	176
	177	/**********************************************************
	178	* Create the array of variables to be sent to the processor from the $params array
	179	* passed into this function
	180	**********************************************************/
	181	$requestFields = self::mapProcessorFieldstoParams($params);
	182
	183	/**********************************************************
	184	* create FirstData request object
	185	**********************************************************/
	186	require_once 'FirstData/lphp.php';
	187	// $mylphp=new lphp;
	188
	189	/**********************************************************
	190	* define variables for connecting with the gateway
	191	**********************************************************/
	192
	193	# Name and location of certificate file
	194	$key = $this->_paymentProcessor['password'];
	195	# Your store number
	196	$requestFields["configfile"] = $this->_paymentProcessor['user_name'];
	197	$port = "1129";
	198	$host = $this->_paymentProcessor['url_site'] . ":" . $port . "/LSGSXML";
	199
	200
	201	//----------------------------------------------------------------------------------------------------
	202	// Check to see if we have a duplicate before we send
	203	//----------------------------------------------------------------------------------------------------
	204	if ($this->_checkDupe($params['invoiceID'])) {
	205	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.');
	206	}
	207	//----------------------------------------------------------------------------------------------------
	208	// Convert to XML using function provided by payment processor
	209	//----------------------------------------------------------------------------------------------------
	210	$requestxml = lphp::buildXML($requestFields);
	211
	212
	213
	214	/*----------------------------------------------------------------------------------------------------
	215	// Send to the payment information using cURL
	216	/----------------------------------------------------------------------------------------------------
	217	*/
	218
	219
	220	$ch = curl_init($host);
	221	if (!$ch) {
	222	return self::errorExit(9004, 'Could not initiate connection to payment gateway');
	223	}
	224
	225
	226	curl_setopt($ch, CURLOPT_POST, 1);
	227	curl_setopt($ch, CURLOPT_POSTFIELDS, $requestxml);
	228	curl_setopt($ch, CURLOPT_SSLCERT, $key);
17c04b52	229	curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'verifySSL') ? 2 : 0);
6a488035 TO	230	curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'verifySSL'));
	231	// return the result on success, FALSE on failure
	232	curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
	233	curl_setopt($ch, CURLOPT_TIMEOUT, 36000);
	234	// ensures any Location headers are followed
439b9688 LS	235	if (ini_get('open_basedir') == '' && ini_get('safe_mode') == 'Off') {
	236	curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
	237	}
6a488035 TO	238
	239	// Send the data out over the wire
	240	//--------------------------------
	241	$responseData = curl_exec($ch);
	242
	243	//----------------------------------------------------------------------------------------------------
	244	// See if we had a curl error - if so tell 'em and bail out
	245	//
	246	// NOTE: curl_error does not return a logical value (see its documentation), but
	247	// a string, which is empty when there was no error.
	248	//----------------------------------------------------------------------------------------------------
	249	if ((curl_errno($ch) > 0) \|\| (strlen(curl_error($ch)) > 0)) {
	250	$errorNum = curl_errno($ch);
	251	$errorDesc = curl_error($ch);
	252
	253	// Paranoia - in the unlikley event that 'curl' errno fails
	254	if ($errorNum == 0)
	255	$errorNum = 9005;
	256
	257	// Paranoia - in the unlikley event that 'curl' error fails
	258	if (strlen($errorDesc) == 0)
	259	$errorDesc = "Connection to payment gateway failed";
	260	if ($errorNum == 60) {
	261	return self::errorExit($errorNum, "Curl error - " . $errorDesc . " Try this link for more information http://curl.haxx.se/docs/sslcerts.html");
	262	}
	263
	264	return self::errorExit($errorNum, "Curl error - " . $errorDesc . " your key is located at " . $key . " the url is " . $host . " xml is " . $requestxml . " processor response = " . $processorResponse);
	265	}
	266
	267	//----------------------------------------------------------------------------------------------------
	268	// If null data returned - tell 'em and bail out
	269	//
	270	// NOTE: You will not necessarily get a string back, if the request failed for
	271	// any reason, the return value will be the boolean false.
	272	//----------------------------------------------------------------------------------------------------
	273	if (($responseData === FALSE) \|\| (strlen($responseData) == 0)) {
	274	return self::errorExit(9006, "Error: Connection to payment gateway failed - no data returned.");
	275	}
	276
	277	//----------------------------------------------------------------------------------------------------
	278	// If gateway returned no data - tell 'em and bail out
	279	//----------------------------------------------------------------------------------------------------
	280	if (empty($responseData)) {
	281	return self::errorExit(9007, "Error: No data returned from payment gateway.");
	282	}
	283
	284	//----------------------------------------------------------------------------------------------------
	285	// Success so far - close the curl and check the data
	286	//----------------------------------------------------------------------------------------------------
	287	curl_close($ch);
	288
	289	//----------------------------------------------------------------------------------------------------
ceb10dc7	290	// Payment successfully sent to gateway - process the response now
6a488035 TO	291	//----------------------------------------------------------------------------------------------------
	292	//
	293	$processorResponse = lphp::decodeXML($responseData);
	294
	295	// transaction failed, print the reason
	296	if ($processorResponse["r_approved"] != "APPROVED") {
	297	return self::errorExit(9009, "Error: [" . $processorResponse['r_error'] . "] - from payment processor");
	298	}
	299	else {
	300
	301	//-----------------------------------------------------------------------------------------------------
	302	// Cross-Check - the unique 'TrxnReference' we sent out should match the just received 'TrxnReference'
	303	//
	304	// this section not used as the processor doesn't appear to pass back our invoice no. Code in eWay model if
	305	// used later
	306	//-----------------------------------------------------------------------------------------------------
	307
	308	//=============
	309	// Success !
	310	//=============
	311	$params['trxn_result_code'] = $processorResponse['r_message'];
	312	$params['trxn_id'] = $processorResponse['r_ref'];
	313	CRM_Core_Error::debug_log_message("r_authresponse " . $processorResponse['r_authresponse']);
	314	CRM_Core_Error::debug_log_message("r_code " . $processorResponse['r_code']);
	315	CRM_Core_Error::debug_log_message("r_tdate " . $processorResponse['r_tdate']);
	316	CRM_Core_Error::debug_log_message("r_avs " . $processorResponse['r_avs']);
	317	CRM_Core_Error::debug_log_message("r_ordernum " . $processorResponse['r_ordernum']);
	318	CRM_Core_Error::debug_log_message("r_error " . $processorResponse['r_error']);
	319	CRM_Core_Error::debug_log_message("csp " . $processorResponse['r_csp']);
	320	CRM_Core_Error::debug_log_message("r_message " . $processorResponse['r_message']);
	321	CRM_Core_Error::debug_log_message("r_ref " . $processorResponse['r_ref']);
	322	CRM_Core_Error::debug_log_message("r_time " . $processorResponse['r_time']);
	323	return $params;
	324	}
	325	}
	326	// end function doDirectPayment
	327
	328	/**
	329	* Checks to see if invoice_id already exists in db
	330	*
	331	* @param int $invoiceId The ID to check
	332	*
	333	* @return bool True if ID exists, else false
	334	*/
00be9182	335	public function _checkDupe($invoiceId) {
6a488035 TO	336	$contribution = new CRM_Contribute_DAO_Contribution();
	337	$contribution->invoice_id = $invoiceId;
	338	return $contribution->find();
	339	}
	340
	341	/**************************************************
	342	* Produces error message and returns from class
	343	**************************************************/
00be9182	344	public function &errorExit($errorCode = NULL, $errorMessage = NULL) {
6a488035 TO	345	$e = CRM_Core_Error::singleton();
	346
	347	if ($errorCode) {
	348	$e->push($errorCode, 0, NULL, $errorMessage);
	349	}
	350	else {
	351	$e->push(9000, 0, NULL, 'Unknown System Error.');
	352	}
	353	return $e;
	354	}
	355
	356	/**************************************************
	357	* NOTE: 'doTransferCheckout' not implemented
	358	**************************************************/
00be9182	359	public function doTransferCheckout(&$params, $component) {
6a488035 TO	360	CRM_Core_Error::fatal(ts('This function is not implemented'));
	361	}
	362
	363	/********************************************************************************************
	364	* This public function checks to see if we have the right processor config values set
	365	*
	366	* NOTE: Called by Events and Contribute to check config params are set prior to trying
	367	* register any credit card details
	368	*
77b97be7 EM	369	* @return null\|string
77b97be7 EM	370	* @internal param string $mode the mode we are operating in (live or test) - not used
6a488035 TO	371	*
	372	* returns string $errorMsg if any errors found - null if OK
	373	*
77b97be7 EM	374	******************************************************************************************
77b97be7 EM	375	*/
6a488035 TO	376	// function checkConfig( $mode ) // CiviCRM V1.9 Declaration
6a488035 TO	377	// CiviCRM V2.0 Declaration
00be9182	378	public function checkConfig() {
6a488035 TO	379	$errorMsg = array();
	380
	381	if (empty($this->_paymentProcessor['user_name'])) {
	382	$errorMsg[] = ts(' Store Name is not set for this payment processor');
	383	}
	384
	385	if (empty($this->_paymentProcessor['url_site'])) {
	386	$errorMsg[] = ts(' URL is not set for this payment processor');
	387	}
	388
	389	if (!empty($errorMsg)) {
	390	return implode('<p>', $errorMsg);
	391	}
	392	else {
	393	return NULL;
	394	}
	395	}
	396	}
	397	// end class CRM_Core_Payment_FirstData