CRM/Core/Payment/Realex.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    * Copyright (C) 2009
  29    * Licensed to CiviCRM under the Academic Free License version 3.0.
  30    *
  31    * Written and contributed by Kirkdesigns (http://www.kirkdesigns.co.uk)
  32    *
  33    */
  34
  35 /**
  36  *
  37  * @package CRM
  38  * @author Tom Kirkpatrick <tkp@kirkdesigns.co.uk>
  39  * $Id$
  40  */
  41 class CRM_Core_Payment_Realex extends CRM_Core_Payment {
  42   const AUTH_APPROVED = '00';
  43
  44   protected $_mode = NULL;
  45
  46   protected $_params = array();
  47
  48   /**
  49    * We only need one instance of this object. So we use the singleton
  50    * pattern and cache the instance in this variable
  51    *
  52    * @var object
  53    * @static
  54    */
  55   static private $_singleton = NULL;
  56
  57   /**
  58    * Constructor
  59    *
  60    * @param string $mode
  61    *   The mode of operation: live or test.
  62    *
  63    * @param $paymentProcessor
  64    *
  65    * @return \CRM_Core_Payment_Realex
  66    */
  67   public function __construct($mode, &$paymentProcessor) {
  68     $this->_mode = $mode;
  69     $this->_paymentProcessor = $paymentProcessor;
  70     $this->_processorName = ts('Realex');
  71
  72     $this->_setParam('merchant_ref', $paymentProcessor['user_name']);
  73     $this->_setParam('secret', $paymentProcessor['password']);
  74     $this->_setParam('account', $paymentProcessor['subject']);
  75
  76     $this->_setParam('emailCustomer', 'TRUE');
  77     srand(time());
  78     $this->_setParam('sequence', rand(1, 1000));
  79   }
  80
  81   /**
  82    * @param array $params
  83    *
  84    * @throws Exception
  85    */
  86   public function setExpressCheckOut(&$params) {
  87     CRM_Core_Error::fatal(ts('This function is not implemented'));
  88   }
  89
  90   /**
  91    * @param $token
  92    *
  93    * @throws Exception
  94    */
  95   public function getExpressCheckoutDetails($token) {
  96     CRM_Core_Error::fatal(ts('This function is not implemented'));
  97   }
  98
  99   /**
 100    * @param array $params
 101    *
 102    * @throws Exception
 103    */
 104   public function doExpressCheckout(&$params) {
 105     CRM_Core_Error::fatal(ts('This function is not implemented'));
 106   }
 107
 108   /**
 109    * @param array $params
 110    *
 111    * @throws Exception
 112    */
 113   public function doTransferCheckout(&$params) {
 114     CRM_Core_Error::fatal(ts('This function is not implemented'));
 115   }
 116
 117   /**
 118    * Submit a payment using Advanced Integration Method
 119    *
 120    * @param array $params
 121    *   Assoc array of input parameters for this transaction.
 122    *
 123    * @return array the result in a nice formatted array (or an error object)
 124    */
 125   public function doDirectPayment(&$params) {
 126
 127     if (!defined('CURLOPT_SSLCERT')) {
 128       return self::error(9001, ts('RealAuth requires curl with SSL support'));
 129     }
 130
 131     $result = $this->setRealexFields($params);
 132
 133     if ($result !== TRUE) {
 134       return $result;
 135     }
 136
 137     /**********************************************************
 138      * Check to see if we have a duplicate before we send
 139      **********************************************************/
 140     if ($this->_checkDupe($this->_getParam('order_id'))) {
 141       return self::error(9004, ts('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 Authorize.net.  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.'));
 142     }
 143
 144     // Create sha1 hash for request
 145     $hashme   = "{$this->_getParam('timestamp')}.{$this->_getParam('merchant_ref')}.{$this->_getParam('order_id')}.{$this->_getParam('amount')}.{$this->_getParam('currency')}.{$this->_getParam('card_number')}";
 146     $sha1hash = sha1($hashme);
 147     $hashme   = "$sha1hash.{$this->_getParam('secret')}";
 148     $sha1hash = sha1($hashme);
 149
 150     // Generate the request xml that is send to Realex Payments.
 151     $request_xml = "<request type='auth' timestamp='{$this->_getParam('timestamp')}'>
 152           <merchantid>{$this->_getParam('merchant_ref')}</merchantid>
 153           <account>{$this->_getParam('account')}</account>
 154           <orderid>{$this->_getParam('order_id')}</orderid>
 155           <amount currency='{$this->_getParam('currency')}'>{$this->_getParam('amount')}</amount>
 156           <card>
 157         <number>{$this->_getParam('card_number')}</number>
 158         <expdate>{$this->_getParam('exp_date')}</expdate>
 159         <type>{$this->_getParam('card_type')}</type>
 160         <chname>{$this->_getParam('card_name')}</chname>
 161         <issueno>{$this->_getParam('issue_number')}</issueno>
 162         <cvn>
 163             <number>{$this->_getParam('cvn')}</number>
 164             <presind>1</presind>
 165         </cvn>
 166           </card>
 167           <autosettle flag='1'/>
 168           <sha1hash>$sha1hash</sha1hash>
 169           <comments>
 170             <comment id='1'>{$this->_getParam('comments')}</comment>
 171           </comments>
 172           <tssinfo>
 173             <varref>{$this->_getParam('varref')}</varref>
 174           </tssinfo>
 175       </request>";
 176
 177     /**********************************************************
 178      * Send to the payment processor using cURL
 179      **********************************************************/
 180
 181     $submit = curl_init($this->_paymentProcessor['url_site']);
 182
 183     if (!$submit) {
 184       return self::error(9002, ts('Could not initiate connection to payment gateway'));
 185     }
 186
 187     curl_setopt($submit, CURLOPT_HTTPHEADER, array('SOAPAction: ""'));
 188     curl_setopt($submit, CURLOPT_RETURNTRANSFER, 1);
 189     curl_setopt($submit, CURLOPT_TIMEOUT, 60);
 190     curl_setopt($submit, CURLOPT_SSL_VERIFYPEER, CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'verifySSL'));
 191     curl_setopt($submit, CURLOPT_HEADER, 0);
 192
 193     // take caching out of the picture
 194     curl_setopt($submit, CURLOPT_FORBID_REUSE, 1);
 195     curl_setopt($submit, CURLOPT_FRESH_CONNECT, 1);
 196
 197     // Apply the XML to our curl call
 198     curl_setopt($submit, CURLOPT_POST, 1);
 199     curl_setopt($submit, CURLOPT_POSTFIELDS, $request_xml);
 200
 201     $response_xml = curl_exec($submit);
 202
 203     if (!$response_xml) {
 204       return self::error(curl_errno($submit), curl_error($submit));
 205     }
 206
 207     curl_close($submit);
 208
 209     // Tidy up the responce xml
 210     $response_xml = preg_replace("/[\s\t]/", " ", $response_xml);
 211     $response_xml = preg_replace("/[\n\r]/", "", $response_xml);
 212
 213     // Parse the response xml
 214     $xml_parser = xml_parser_create();
 215     if (!xml_parse($xml_parser, $response_xml)) {
 216       return self::error(9003, 'XML Error');
 217     }
 218
 219     $response = $this->xml_parse_into_assoc($response_xml);
 220     $response = $response['#return']['RESPONSE'];
 221
 222     // Log the Realex response for debugging
 223     // CRM_Core_Error::debug_var('REALEX --------- Response from Realex: ', $response, TRUE);
 224
 225     // Return an error if authentication was not successful
 226     if ($response['RESULT'] !== self::AUTH_APPROVED) {
 227       return self::error($response['RESULT'], ' ' . $response['MESSAGE']);
 228     }
 229
 230     // Check the response hash
 231     $hashme   = "{$this->_getParam('timestamp')}.{$this->_getParam('merchant_ref')}.{$this->_getParam('order_id')}.{$response['RESULT']}.{$response['MESSAGE']}.{$response['PASREF']}.{$response['AUTHCODE']}";
 232     $sha1hash = sha1($hashme);
 233     $hashme   = "$sha1hash.{$this->_getParam('secret')}";
 234     $sha1hash = sha1($hashme);
 235
 236     if ($response['SHA1HASH'] != $sha1hash) {
 237       // FIXME: Need to actually check this - I couldn't get the
 238       // hashes to match so I'm commenting out for now'
 239       // return self::error( 9001, "Hash error, please report this to the webmaster" );
 240     }
 241
 242     // FIXME: We are using the trxn_result_code column to store all these extra details since there
 243     // seems to be nowhere else to put them. This is THE WRONG THING TO DO!
 244     $extras = array(
 245       'authcode' => $response['AUTHCODE'],
 246       'batch_id' => $response['BATCHID'],
 247       'message' => $response['MESSAGE'],
 248       'trxn_result_code' => $response['RESULT'],
 249     );
 250
 251     $params['trxn_id'] = $response['PASREF'];
 252     $params['trxn_result_code'] = serialize($extras);
 253     $params['currencyID'] = $this->_getParam('currency');
 254     $params['gross_amount'] = $this->_getParam('amount');
 255     $params['fee_amount'] = 0;
 256
 257     return $params;
 258   }
 259
 260   /**
 261    * Helper function to convert XML string to multi-dimension array.
 262    *
 263    * @param $xml
 264    *   an XML string.
 265    *
 266    * @return array An array of the result with following keys:
 267    */
 268   public function xml_parse_into_assoc($xml) {
 269     $input = array();
 270     $result = array();
 271
 272     $result['#error'] = FALSE;
 273     $result['#return'] = NULL;
 274
 275     $xmlparser = xml_parser_create();
 276     $ret = xml_parse_into_struct($xmlparser, $xml, $input);
 277
 278     xml_parser_free($xmlparser);
 279
 280     if (empty($input)) {
 281       $result['#return'] = $xml;
 282     }
 283     else {
 284       if ($ret > 0) {
 285         $result['#return'] = $this->_xml_parse($input);
 286       }
 287       else {
 288         $result['#error'] = ts('Error parsing XML result - error code = %1 at line %2 char %3',
 289           array(
 290             1 => xml_get_error_code($xmlparser),
 291             2 => xml_get_current_line_number($xmlparser),
 292             3 => xml_get_current_column_number($xmlparser),
 293           )
 294         );
 295       }
 296     }
 297     return $result;
 298   }
 299
 300   // private helper for  xml_parse_into_assoc, to recusively parsing the result
 301   /**
 302    * @param $input
 303    * @param int $depth
 304    *
 305    * @return array
 306    */
 307   public function _xml_parse($input, $depth = 1) {
 308     $output = array();
 309     $children = array();
 310
 311     foreach ($input as $data) {
 312       if ($data['level'] == $depth) {
 313         switch ($data['type']) {
 314           case 'complete':
 315             $output[$data['tag']] = isset($data['value']) ? $data['value'] : '';
 316             break;
 317
 318           case 'open':
 319             $children = array();
 320             break;
 321
 322           case 'close':
 323             $output[$data['tag']] = $this->_xml_parse($children, $depth + 1);
 324             break;
 325         }
 326       }
 327       else {
 328         $children[] = $data;
 329       }
 330     }
 331     return $output;
 332   }
 333
 334   /**
 335    *  Format the params from the form ready for sending to Realex.  Also perform some validation
 336    */
 337   public function setRealexFields(&$params) {
 338     if ((int) $params['amount'] <= 0) {
 339       return self::error(9001, ts('Amount must be positive'));
 340     }
 341
 342     // format amount to be in smallest possible units
 343     //list($bills, $pennies) = explode('.', $params['amount']);
 344     $this->_setParam('amount', 100 * $params['amount']);
 345
 346     switch (strtolower($params['credit_card_type'])) {
 347       case 'mastercard':
 348         $this->_setParam('card_type', 'MC');
 349         $this->_setParam('requiresIssueNumber', FALSE);
 350         break;
 351
 352       case 'visa':
 353         $this->_setParam('card_type', 'VISA');
 354         $this->_setParam('requiresIssueNumber', FALSE);
 355         break;
 356
 357       case 'amex':
 358         $this->_setParam('card_type', 'AMEX');
 359         $this->_setParam('requiresIssueNumber', FALSE);
 360         break;
 361
 362       case 'laser':
 363         $this->_setParam('card_type', 'LASER');
 364         $this->_setParam('requiresIssueNumber', FALSE);
 365         break;
 366
 367       case 'maestro':
 368       case 'switch':
 369       case 'maestro/switch':
 370       case 'solo':
 371         $this->_setParam('card_type', 'SWITCH');
 372         $this->_setParam('requiresIssueNumber', TRUE);
 373         break;
 374
 375       default:
 376         return self::error(9001, ts('Credit card type not supported by Realex:') . ' ' . $params['credit_card_type']);
 377     }
 378
 379     // get the card holder name - cater cor customized billing forms
 380     if (isset($params['cardholder_name'])) {
 381       $credit_card_name = $params['cardholder_name'];
 382     }
 383     else {
 384       $credit_card_name = $params['first_name'] . " ";
 385       if (!empty($params['middle_name'])) {
 386         $credit_card_name .= $params['middle_name'] . " ";
 387       }
 388       $credit_card_name .= $params['last_name'];
 389     }
 390
 391     $this->_setParam('card_name', $credit_card_name);
 392     $this->_setParam('card_number', str_replace(' ', '', $params['credit_card_number']));
 393     $this->_setParam('cvn', $params['cvv2']);
 394     $this->_setParam('country', $params['country']);
 395     $this->_setParam('post_code', $params['postal_code']);
 396     $this->_setParam('order_id', $params['invoiceID']);
 397     $params['issue_number'] = (isset($params['issue_number']) ? $params['issue_number'] : '');
 398     $this->_setParam('issue_number', $params['issue_number']);
 399     $this->_setParam('varref', $params['contributionType_name']);
 400     $comment = $params['description'] . ' (page id:' . $params['contributionPageID'] . ')';
 401     $this->_setParam('comments', $comment);
 402     //$this->_setParam('currency',      $params['currencyID']);
 403
 404     // set the currency to the default which can be overrided.
 405     $config = CRM_Core_Config::singleton();
 406     $this->_setParam('currency', $config->defaultCurrency);
 407
 408     // Format the expiry date to MMYY
 409     $expmonth = (string) $params['month'];
 410     $expmonth = (strlen($expmonth) === 1) ? '0' . $expmonth : $expmonth;
 411     $expyear  = substr((string) $params['year'], 2, 2);
 412     $this->_setParam('exp_date', $expmonth . $expyear);
 413
 414     if (isset($params['credit_card_start_date']) && (strlen($params['credit_card_start_date']['M']) !== 0) &&
 415       (strlen($params['credit_card_start_date']['Y']) !== 0)
 416     ) {
 417       $startmonth = (string) $params['credit_card_start_date']['M'];
 418       $startmonth = (strlen($startmonth) === 1) ? '0' . $startmonth : $startmonth;
 419       $startyear  = substr((string) $params['credit_card_start_date']['Y'], 2, 2);
 420       $this->_setParam('start_date', $startmonth . $startyear);
 421     }
 422
 423     // Create timestamp
 424     $timestamp = strftime("%Y%m%d%H%M%S");
 425     $this->_setParam('timestamp', $timestamp);
 426
 427     return TRUE;
 428   }
 429
 430   /**
 431    * Checks to see if invoice_id already exists in db
 432    *
 433    * @param int $invoiceId
 434    *   The ID to check.
 435    *
 436    * @return bool                  True if ID exists, else false
 437    */
 438   public function _checkDupe($invoiceId) {
 439     $contribution = new CRM_Contribute_DAO_Contribution();
 440     $contribution->invoice_id = $invoiceId;
 441     return $contribution->find();
 442   }
 443
 444   /**
 445    * Get the value of a field if set
 446    *
 447    * @param string $field
 448    *   The field.
 449    *
 450    * @return mixed value of the field, or empty string if the field is
 451    * not set
 452    */
 453   public function _getParam($field) {
 454     if (isset($this->_params[$field])) {
 455       return $this->_params[$field];
 456     }
 457     else {
 458       return '';
 459     }
 460   }
 461
 462   /**
 463    * Set a field to the specified value.  Value must be a scalar (int,
 464    * float, string, or boolean)
 465    *
 466    * @param string $field
 467    * @param mixed $value
 468    *
 469    * @return bool false if value is not a scalar, true if successful
 470    */
 471   public function _setParam($field, $value) {
 472     if (!is_scalar($value)) {
 473       return FALSE;
 474     }
 475     else {
 476       $this->_params[$field] = $value;
 477     }
 478   }
 479
 480   /**
 481    * @param null $errorCode
 482    * @param null $errorMessage
 483    *
 484    * @return object
 485    */
 486   public function &error($errorCode = NULL, $errorMessage = NULL) {
 487     $e = CRM_Core_Error::singleton();
 488
 489     if ($errorCode) {
 490       if ($errorCode == '101' || $errorCode == '102') {
 491         $display_error = ts('Card declined by bank. Please try with a different card.');
 492       }
 493       elseif ($errorCode == '103') {
 494         $display_error = ts('Card reported lost or stolen. This incident will be reported.');
 495       }
 496       elseif ($errorCode == '501') {
 497         $display_error = ts("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 for this transaction.  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.");
 498       }
 499       elseif ($errorCode == '509') {
 500         $display_error = $errorMessage;
 501       }
 502       else {
 503         $display_error = ts('We were unable to process your payment at this time. Please try again later.');
 504       }
 505       $e->push($errorCode, 0, NULL, $display_error);
 506     }
 507     else {
 508       $e->push(9001, 0, NULL, ts('We were unable to process your payment at this time. Please try again later.'));
 509     }
 510     return $e;
 511   }
 512
 513   /**
 514    * This function checks to see if we have the right config values
 515    *
 516    * @return string the error message if any
 517    */
 518   public function checkConfig() {
 519     $error = array();
 520     if (empty($this->_paymentProcessor['user_name'])) {
 521       $error[] = ts('Merchant ID is not set for this payment processor');
 522     }
 523
 524     if (empty($this->_paymentProcessor['password'])) {
 525       $error[] = ts('Secret is not set for this payment processor');
 526     }
 527
 528     if (!empty($error)) {
 529       return implode('<p>', $error);
 530     }
 531     else {
 532       return NULL;
 533     }
 534   }
 535 }