/magento/app/code/core/Mage/Centinel/Model/Api.php
PHP | 267 lines | 147 code | 26 blank | 94 comment | 6 complexity | d7055a0c4e4c3658b3d1908558e076e6 MD5 | raw file
Possible License(s): LGPL-3.0
- <?php
- /**
- * Magento
- *
- * NOTICE OF LICENSE
- *
- * This source file is subject to the Open Software License (OSL 3.0)
- * that is bundled with this package in the file LICENSE.txt.
- * It is also available through the world-wide-web at this URL:
- * http://opensource.org/licenses/osl-3.0.php
- * If you did not receive a copy of the license and are unable to
- * obtain it through the world-wide-web, please send an email
- * to license@magentocommerce.com so we can send you a copy immediately.
- *
- * DISCLAIMER
- *
- * Do not edit or add to this file if you wish to upgrade Magento to newer
- * versions in the future. If you wish to customize Magento for your
- * needs please refer to http://www.magentocommerce.com for more information.
- *
- * @category Mage
- * @package Mage_Centinel
- * @copyright Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
- * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
- */
- /**
- * 3D Secure Validation Library for Payment
- */
- include_once '3Dsecure/CentinelClient.php';
- /**
- * 3D Secure Validation Api
- */
- class Mage_Centinel_Model_Api extends Varien_Object
- {
- /**
- * Fields that should be replaced in debug with '***'
- *
- * @var array
- */
- protected $_debugReplacePrivateDataKeys = array('TransactionPwd', 'CardNumber', 'CardExpMonth', 'CardExpYear');
- protected static $_iso4217Currencies = array(
- 'AED' => '784', 'AFN' => '971',
- 'ALL' => '008', 'AMD' => '051', 'ANG' => '532', 'AOA' => '973', 'ARS' => '032', 'AUD' => '036', 'AWG' => '533',
- 'AZN' => '944', 'BAM' => '977', 'BBD' => '052', 'BDT' => '050', 'BGN' => '975', 'BHD' => '048', 'BIF' => '108',
- 'BMD' => '060', 'BND' => '096', 'BOB' => '068', 'BOV' => '984', 'BRL' => '986', 'BSD' => '044', 'BTN' => '064',
- 'BWP' => '072', 'BYR' => '974', 'BZD' => '084', 'CAD' => '124', 'CDF' => '976', 'CHE' => '947', 'CHF' => '756',
- 'CHW' => '948', 'CLF' => '990', 'CLP' => '152', 'CNY' => '156', 'COP' => '170', 'COU' => '970', 'CRC' => '188',
- 'CUC' => '931', 'CUP' => '192', 'CVE' => '132', 'CZK' => '203', 'DJF' => '262', 'DKK' => '208', 'DOP' => '214',
- 'DZD' => '012', 'EEK' => '233', 'EGP' => '818', 'ERN' => '232', 'ETB' => '230', 'EUR' => '978', 'FJD' => '242',
- 'FKP' => '238', 'GBP' => '826', 'GEL' => '981', 'GHS' => '936', 'GIP' => '292', 'GMD' => '270', 'GNF' => '324',
- 'GTQ' => '320', 'GYD' => '328', 'HKD' => '344', 'HNL' => '340', 'HRK' => '191', 'HTG' => '332', 'HUF' => '348',
- 'IDR' => '360', 'ILS' => '376', 'INR' => '356', 'IQD' => '368', 'IRR' => '364', 'ISK' => '352', 'JMD' => '388',
- 'JOD' => '400', 'JPY' => '392', 'KES' => '404', 'KGS' => '417', 'KHR' => '116', 'KMF' => '174', 'KPW' => '408',
- 'KRW' => '410', 'KWD' => '414', 'KYD' => '136', 'KZT' => '398', 'LAK' => '418', 'LBP' => '422', 'LKR' => '144',
- 'LRD' => '430', 'LSL' => '426', 'LTL' => '440', 'LVL' => '428', 'LYD' => '434', 'MAD' => '504', 'MDL' => '498',
- 'MGA' => '969', 'MKD' => '807', 'MMK' => '104', 'MNT' => '496', 'MOP' => '446', 'MRO' => '478', 'MUR' => '480',
- 'MVR' => '462', 'MWK' => '454', 'MXN' => '484', 'MXV' => '979', 'MYR' => '458', 'MZN' => '943', 'NAD' => '516',
- 'NGN' => '566', 'NIO' => '558', 'NOK' => '578', 'NPR' => '524', 'NZD' => '554', 'OMR' => '512', 'PAB' => '590',
- 'PEN' => '604', 'PGK' => '598', 'PHP' => '608', 'PKR' => '586', 'PLN' => '985', 'PYG' => '600', 'QAR' => '634',
- 'RON' => '946', 'RSD' => '941', 'RUB' => '643', 'RWF' => '646', 'SAR' => '682', 'SBD' => '090', 'SCR' => '690',
- 'SDG' => '938', 'SEK' => '752', 'SGD' => '702', 'SHP' => '654', 'SLL' => '694', 'SOS' => '706', 'SRD' => '968',
- 'STD' => '678', 'SYP' => '760', 'SZL' => '748', 'THB' => '764', 'TJS' => '972', 'TMT' => '934', 'TND' => '788',
- 'TOP' => '776', 'TRY' => '949', 'TTD' => '780', 'TWD' => '901', 'TZS' => '834', 'UAH' => '980', 'UGX' => '800',
- 'USD' => '840', 'USN' => '997', 'USS' => '998', 'UYU' => '858', 'UZS' => '860', 'VEF' => '937', 'VND' => '704',
- 'VUV' => '548', 'WST' => '882', 'XAF' => '950', 'XAG' => '961', 'XAU' => '959', 'XBA' => '955', 'XBB' => '956',
- 'XBC' => '957', 'XBD' => '958', 'XCD' => '951', 'XDR' => '960', 'XOF' => '952', 'XPD' => '964', 'XPF' => '953',
- 'XPT' => '962', 'XTS' => '963', 'XXX' => '999', 'YER' => '886', 'ZAR' => '710', 'ZMK' => '894', 'ZWL' => '932',
- );
- /**
- * Centinel validation client
- *
- * @var CentinelClient
- */
- protected $_clientInstance = null;
- /**
- * Return Centinel thin client object
- *
- * @return CentinelClient
- */
- protected function _getClientInstance()
- {
- if (empty($this->_clientInstance)) {
- $this->_clientInstance = new CentinelClient();
- }
- return $this->_clientInstance;
- }
- /**
- * Return Centinel Api version
- *
- * @return string
- */
- protected function _getVersion()
- {
- return '1.7';
- }
- /**
- * Return transaction type. according centinel documetation it should be "C"
- *
- * @return "C"
- */
- protected function _getTransactionType()
- {
- return 'C';
- }
- /**
- * Return Timeout Connect
- *
- * @return int
- */
- protected function _getTimeoutConnect()
- {
- return 100;
- }
- /**
- * Return Timeout Read
- *
- * @return int
- */
- protected function _getTimeoutRead()
- {
- return 100;
- }
- /**
- * Call centinel api methods by given method name and data
- *
- * @param $method string
- * @param $data array
- *
- * @return CentinelClient
- */
- protected function _call($method, $data)
- {
- $client = $this->_getClientInstance();
- $request = array_merge(array(
- 'MsgType' => $method,
- 'Version' => $this->_getVersion(),
- 'ProcessorId' => $this->getProcessorId(),
- 'MerchantId' => $this->getMerchantId(),
- 'TransactionPwd' => $this->getTransactionPwd(),
- 'TransactionType' => $this->_getTransactionType(),
- ), $data);
- $debugData = array('request' => $request);
- try {
- foreach($request as $key => $val) {
- $client->add($key, $val);
- }
- $client->sendHttp($this->_getApiEndpointUrl(), $this->_getTimeoutConnect(), $this->_getTimeoutRead());
- } catch (Exception $e) {
- $debugData['response'] = array('error' => $e->getMessage(), 'code' => $e->getCode());
- $this->_debug($debugData);
- throw $e;
- }
- $debugData['response'] = $client->response;
- $this->_debug($debugData);
- return $client;
- }
- /**
- * Getter for API call URL
- *
- * @return string
- * @throws Exception
- */
- protected function _getApiEndpointUrl()
- {
- if ($this->getIsTestMode()) {
- return 'https://centineltest.cardinalcommerce.com/maps/txns.asp';
- }
- $url = $this->getApiEndpointUrl();
- if (!$url) {
- throw new Exception('Centinel API endpoint URL is not configured properly.');
- }
- return $url;
- }
- /**
- * Call centinel api lookup method
- *
- * @return Mage_Centinel_Model_Api
- */
- public function callLookup($data)
- {
- $result = new Varien_Object();
- $month = strlen($data->getCardExpMonth()) == 1 ? '0' . $data->getCardExpMonth() : $data->getCardExpMonth();
- $currencyCode = $data->getCurrencyCode();
- $currencyNumber = isset(self::$_iso4217Currencies[$currencyCode]) ? self::$_iso4217Currencies[$currencyCode] : '';
- if (!$currencyNumber) {
- return $result->setErrorNo(1)->setErrorDesc(
- Mage::helper('payment')->__('Unsupported currency code: %s.', $currencyCode)
- );
- }
- $clientResponse = $this->_call('cmpi_lookup', array(
- 'Amount' => round($data->getAmount() * 100),
- 'CurrencyCode' => $currencyNumber,
- 'CardNumber' => $data->getCardNumber(),
- 'CardExpMonth'=> $month,
- 'CardExpYear' => $data->getCardExpYear(),
- 'OrderNumber' => $data->getOrderNumber()
- ));
- $result->setErrorNo($clientResponse->getValue('ErrorNo'));
- $result->setErrorDesc($clientResponse->getValue('ErrorDesc'));
- $result->setTransactionId($clientResponse->getValue('TransactionId'));
- $result->setEnrolled($clientResponse->getValue('Enrolled'));
- $result->setAcsUrl($clientResponse->getValue('ACSUrl'));
- $result->setPayload($clientResponse->getValue('Payload'));
- $result->setEciFlag($clientResponse->getValue('EciFlag'));
- return $result;
- }
- /**
- * Call centinel api authentication method
- *
- * @return Mage_Centinel_Model_Api
- */
- public function callAuthentication($data)
- {
- $result = new Varien_Object();
- $clientResponse = $this->_call('cmpi_authenticate', array(
- 'TransactionId' => $data->getTransactionId(),
- 'PAResPayload' => $data->getPaResPayload(),
- ));
- $result->setErrorNo($clientResponse->getValue('ErrorNo'));
- $result->setErrorDesc($clientResponse->getValue('ErrorDesc'));
- $result->setPaResStatus($clientResponse->getValue('PAResStatus'));
- $result->setSignatureVerification($clientResponse->getValue('SignatureVerification'));
- $result->setCavv($clientResponse->getValue('Cavv'));
- $result->setEciFlag($clientResponse->getValue('EciFlag'));
- $result->setXid($clientResponse->getValue('Xid'));
- return $result;
- }
- /**
- * Log debug data to file
- *
- * @param mixed $debugData
- */
- protected function _debug($debugData)
- {
- if ($this->getDebugFlag()) {
- Mage::getModel('core/log_adapter', 'card_validation_3d_secure.log')
- ->setFilterDataKeys($this->_debugReplacePrivateDataKeys)
- ->log($debugData);
- }
- }
- }