<?php
/*
+ * This file is part of CiviCRM.
+ *
+ * CiviCRM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * CiviCRM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with CiviCRM. If not, see <http://www.gnu.org/licenses/>.
+ *
* Copyright (C) 2012
* Licensed to CiviCRM under the GPL v3 or higher
*
* Written and contributed by Ward Vandewege <ward@fsf.org> (http://www.fsf.org)
+ * Modified by Lisa Marie Maginnis <lisa@fsf.org> (http://www.fsf.org)
+ * Copyright © 2015 David Thompson <davet@gnu.org>
*
*/
CONST AUTH_DECLINED = 'decline';
CONST AUTH_BADDATA = 'baddata';
CONST AUTH_ERROR = 'error';
+ CONST AUTH_BLACKLIST = 'blacklisted';
static protected $_mode = NULL;
srand(time());
$this->_setParam('sequence', rand(1, 1000));
$this->logging_level = TRUSTCOMMERCE_LOGGING_LEVEL;
+
}
/**
}
/**
- * Submit a payment using Advanced Integration Method
- *
- * @param array $params assoc array of input parameters for this transaction
- *
- * @return array the result in a nice formatted array (or an error object)
+ * Submit a payment using the TC API
+ * @param array $params The params we will be sending to tclink_send()
+ * @return mixed An array of our results, or an error object if the transaction fails.
* @public
*/
function doDirectPayment(&$params) {
return self::error(9001, 'TrustCommerce requires that the tclink module is loaded');
}
- /*
- * recurpayment function does not compile an array & then proces it -
- * - the tpl does the transformation so adding call to hook here
- * & giving it a change to act on the params array
- */
-
- $newParams = $params;
- if (CRM_Utils_Array::value('is_recur', $params) &&
- $params['contributionRecurID']
- ) {
- CRM_Utils_Hook::alterPaymentProcessorParams($this,
- $params,
- $newParams
- );
- }
- foreach ($newParams as $field => $value) {
+ /* Copy our paramaters to ourself */
+ foreach ($params as $field => $value) {
$this->_setParam($field, $value);
}
- if (CRM_Utils_Array::value('is_recur', $params) &&
- $params['contributionRecurID']
- ) {
- return $this->doRecurPayment($params);
- }
+ /* Get our fields to pass to tclink_send() */
+ $tc_params = $this->_getTrustCommerceFields();
- $postFields = array();
- $tclink = $this->_getTrustCommerceFields();
+ /* Are we recurring? If so add the extra API fields. */
+ if (CRM_Utils_Array::value('is_recur', $params) == 1) {
+ $tc_params = $this->_getRecurPaymentFields($tc_params);
+ $recur=1;
+ }
- // Set up our call for hook_civicrm_paymentProcessor,
- // since we now have our parameters as assigned for the AIM back end.
- CRM_Utils_Hook::alterPaymentProcessorParams($this,
- $params,
- $tclink
- );
+ /* Pass our cooked params to the alter hook, per Core/Payment/Dummy.php */
+ CRM_Utils_Hook::alterPaymentProcessorParams($this, $params, $tc_params);
// TrustCommerce will not refuse duplicates, so we should check if the user already submitted this transaction
- if ($this->_checkDupe($tclink['ticket'])) {
+ if ($this->_checkDupe($tc_params['ticket'])) {
return self::error(9004, 'It appears that this transaction is a duplicate. Have you already submitted the form once? If so there may have been a connection problem. You can try your transaction again. If you continue to have problems please contact the site administrator.');
}
- $result = tclink_send($tclink);
+ /* This implements a local blacklist, and passes us though as a normal failure
+ * if the luser is on the blacklist. */
+ if(!$this->_isBlacklisted()) {
+ /* Call the TC API, and grab the reply */
+ $reply = $this->_sendTCRequest($tc_params);
+ } else {
+ $this->_logger($tc_params);
+ $reply['status'] = self::AUTH_BLACKLIST;
+ }
+
+ /* Parse our reply */
+ $result = $this->_getTCReply($reply);
- if (!$result) {
- return self::error(9002, 'Could not initiate connection to payment gateway');
+ if($result == 0) {
+ /* We were successful, congrats. Lets wrap it up:
+ * Convert back to dollars
+ * Save the transaction ID
+ */
+
+ if (array_key_exists('billingid', $reply)) {
+ $params['recurr_profile_id'] = $reply['billingid'];
+ CRM_Core_DAO::setFieldValue(
+ 'CRM_Contribute_DAO_ContributionRecur',
+ $this->_getParam('contributionRecurID'),
+ 'processor_id', $reply['billingid']
+ );
+ }
+ $params['trxn_id'] = $reply['transid'];
+
+ $params['gross_amount'] = $tc_params['amount'] / 100;
+
+ return $params;
+
+ } else {
+ /* Otherwise we return the error object */
+ return $result;
}
+ }
- foreach ($result as $field => $value) {
- error_log("result: $field => $value");
+ /**
+ * Update CC info for a recurring contribution
+ */
+ function updateSubscriptionBillingInfo(&$message = '', $params = array()) {
+ $expYear = $params['credit_card_exp_date']['Y'];
+ $expMonth = $params['credit_card_exp_date']['M'];
+
+ $tc_params = array(
+ 'custid' => $this->_paymentProcessor['user_name'],
+ 'password' => $this->_paymentProcessor['password'],
+ 'action' => 'store',
+ 'billingid' => $params['subscriptionId'],
+ 'avs' => 'y', // Enable address verification
+ 'address1' => $params['street_address'],
+ 'zip' => $params['postal_code'],
+ 'name' => $this->_formatBillingName($params['first_name'],
+ $params['last_name']),
+ 'cc' => $params['credit_card_number'],
+ 'cvv' => $params['cvv2'],
+ 'exp' => $this->_formatExpirationDate($expYear, $expMonth),
+ 'amount' => $this->_formatAmount($params['amount']),
+ );
+
+ CRM_Utils_Hook::alterPaymentProcessorParams($this, $params, $tc_params);
+
+ $reply = $this->_sendTCRequest($tc_params);
+ $result = $this->_getTCReply($reply);
+
+ if($result === 0) {
+ $message = 'Successfully updated TC billing id ' . $tc_params['billingid'];
+
+ return TRUE;
+ } else {
+ return FALSE;
}
+ }
- switch($result['status']) {
- case self::AUTH_APPROVED:
- // It's all good
- break;
- case self::AUTH_DECLINED:
- // TODO FIXME be more or less specific?
- // declinetype can be: decline, avs, cvv, call, expiredcard, carderror, authexpired, fraud, blacklist, velocity
- // See TC documentation for more info
- return self::error(9009, "Your transaction was declined: {$result['declinetype']}");
- break;
- case self::AUTH_BADDATA:
- // TODO FIXME do something with $result['error'] and $result['offender']
- return self::error(9011, "Invalid credit card information. Please re-enter.");
- break;
- case self::AUTH_ERROR:
- return self::error(9002, 'Could not initiate connection to payment gateway');
- break;
+ // TODO: Use the formatting functions throughout the entire class to
+ // dedupe the conversions done elsewhere in a less reusable way.
+ function _formatAmount($amount) {
+ return $amount * 100;
+ }
+
+ function _formatBillingName($firstName, $lastName) {
+ return "$firstName $lastName";
+ }
+
+ function _formatExpirationDate($year, $month) {
+ $exp_month = str_pad($month, 2, '0', STR_PAD_LEFT);
+ $exp_year = substr($year, -2);
+
+ return "$exp_month$exp_year";
+ }
+
+ function _isBlacklisted() {
+ if($this->_isIPBlacklisted()) {
+ return TRUE;
+ } else if($this->_IsAgentBlacklisted()) {
+ return TRUE;
+ }
+ return FALSE;
+ }
+
+ function _isAgentBlacklisted() {
+ $ip = $_SERVER['REMOTE_ADDR'];
+ $agent = $_SERVER['HTTP_USER_AGENT'];
+ $dao = CRM_Core_DAO::executeQuery('SELECT * FROM `trustcommerce_useragent_blacklist`');
+ while($dao->fetch()) {
+ if(preg_match('/'.$dao->name.'/', $agent) === 1) {
+ error_log(' [client '.$ip.'] [agent '.$agent.'] - Blacklisted by USER_AGENT rule #'.$dao->id);
+ return TRUE;
+ }
+ }
+ return FALSE;
+ }
+
+ function _isIPBlacklisted() {
+ $ip = $_SERVER['REMOTE_ADDR'];
+ $agent = $_SERVER['HTTP_USER_AGENT'];
+ $ip = ip2long($ip);
+ $blacklist = array();
+ $dao = CRM_Core_DAO::executeQuery('SELECT * FROM `trustcommerce_blacklist`');
+ while($dao->fetch()) {
+ if($ip >= $dao->start && $ip <= $dao->end) {
+ error_log('[client '.long2ip($ip).'] [agent '.$agent.'] Blacklisted by IP rule #'.$dao->id);
+ return TRUE;
+ }
}
-
- // Success
+ return FALSE;
+ }
- $params['trxn_id'] = $result['transid'];
- $params['gross_amount'] = $tclink['amount'] / 100;
+ function _sendTCRequest($request) {
+ $this->_logger($request);
+ return tclink_send($request);
+ }
- return $params;
+ function _logger($params) {
+ $msg = '';
+ foreach ($params as $key => $data) {
+ /* Delete any data we should not be writing to disk. This includes:
+ * custid, password, cc, exp, and cvv
+ */
+ switch($key) {
+ case 'custid':
+ case 'password':
+ case 'cc':
+ case 'exp':
+ case 'cvv':
+ break;
+ default:
+ $msg .= ' '.$key.' => '.$data;
+ }
+ }
+ error_log('[client '.$_SERVER['REMOTE_ADDR'].'] TrustCommerce:'.$msg);
}
/**
- * Submit an Automated Recurring Billing subscription
- *
- * @param array $params assoc array of input parameters for this transaction
- *
- * @return array the result in a nice formatted array (or an error object)
+ * Gets the recurring billing fields for the TC API
+ * @param array $fields The fields to modify.
+ * @return array The fields for tclink_send(), modified for recurring billing.
* @public
*/
- function doRecurPayment(&$params) {
+ function _getRecurPaymentFields($fields) {
$payments = $this->_getParam('frequency_interval');
$cycle = $this->_getParam('frequency_unit');
- /* Sort out our billing scheme */
+ /* Translate billing cycle from CiviCRM -> TC */
switch($cycle) {
case 'day':
$cycle = 'd';
case 'year':
$cycle = 'y';
break;
- default:
- return self::error(9001, 'Payment interval not set! Unable to process payment.');
- break;
}
-
- $params['authnow'] = 'y'; /* Process this payment `now' */
- $params['cycle'] = $cycle; /* The billing cycle in years, months, weeks, or days. */
- $params['payments'] = $payments;
-
-
- $tclink = $this->_getTrustCommerceFields();
-
- // Set up our call for hook_civicrm_paymentProcessor,
- // since we now have our parameters as assigned for the AIM back end.
- CRM_Utils_Hook::alterPaymentProcessorParams($this,
- $params,
- $tclink
- );
-
- // TrustCommerce will not refuse duplicates, so we should check if the user already submitted this transaction
- if ($this->_checkDupe($tclink['ticket'])) {
- return self::error(9004, 'It appears that this transaction is a duplicate. Have you already submitted the form once? If so there may have been a connection problem. You can try your transaction again. If you continue to have problems please contact the site administrator.');
+ /* Translate frequency interval from CiviCRM -> TC
+ * Payments are the same, HOWEVER a payment of 1 (forever) should be 0 in TC */
+ if($payments == 1) {
+ $payments = 0;
}
- $result = tclink_send($tclink);
+ $fields['cycle'] = '1'.$cycle; /* The billing cycle in years, months, weeks, or days. */
+ $fields['payments'] = $payments;
+ $fields['authnow'] = 'y';
+ $fields['start'] = date("Y-m-d"); /* Start date is required when 'authnow' is used. */
+ $fields['action'] = 'store'; /* Change our mode to `store' mode. */
- $result = _getTrustCommereceResponse($result);
-
- if($result == 0) {
- /* Transaction was sucessful */
- $params['trxn_id'] = $result['transid']; /* Get our transaction ID */
- $params['gross_amount'] = $tclink['amount']/100; /* Convert from cents to dollars */
- return $params;
- } else {
- /* Transaction was *not* successful */
- return $result;
- }
+ return $fields;
}
/* Parses a response from TC via the tclink_send() command.
* @param $reply array The result of a call to tclink_send().
* @return mixed self::error() if transaction failed, otherwise returns 0.
*/
- function _getTrustCommerceResponse($reply) {
+ function _getTCReply($reply) {
/* DUPLIATE CODE, please refactor. ~lisa */
- if (!$result) {
+ if (!$reply) {
return self::error(9002, 'Could not initiate connection to payment gateway');
}
- switch($result['status']) {
+ $this->_logger($reply);
+
+ switch($reply['status']) {
+ case self::AUTH_BLACKLIST:
+ return self::error(9001, "Your transaction was declined: error #90210");
+ break;
case self::AUTH_APPROVED:
// It's all good
break;
case self::AUTH_DECLINED:
- // TODO FIXME be more or less specific?
+ // TODO FIXME be more or less specific?
// declinetype can be: decline, avs, cvv, call, expiredcard, carderror, authexpired, fraud, blacklist, velocity
// See TC documentation for more info
- return self::error(9009, "Your transaction was declined: {$result['declinetype']}");
+ switch($reply['declinetype']) {
+ case 'avs':
+ return self::error(9009, "Your transaction was declined for address verification reasons. If your address was correct please contact us at donate@fsf.org before attempting to retry your transaction.");
+ break;
+ }
+ return self::error(9009, "Your transaction was declined: {$reply['declinetype']}");
break;
case self::AUTH_BADDATA:
- // TODO FIXME do something with $result['error'] and $result['offender']
- return self::error(9011, "Invalid credit card information. Please re-enter.");
+ // TODO FIXME do something with $reply['error'] and $reply['offender']
+ return self::error(9011, "Invalid credit card information. The following fields were invalid: {$reply['offenders']}.");
break;
case self::AUTH_ERROR:
return self::error(9002, 'Could not initiate connection to payment gateway');
}
}
- function cancelSubscriptionURL($entityID = NULL, $entity = NULL) {
- if ($entityID && $entity == 'membership') {
- require_once 'CRM/Contact/BAO/Contact/Utils.php';
- $contactID = CRM_Core_DAO::getFieldValue("CRM_Member_DAO_Membership", $entityID, "contact_id");
- $checksumValue = CRM_Contact_BAO_Contact_Utils::generateChecksum($contactID, NULL, 'inf');
+ function cancelSubscription(&$message = '', $params = array()) {
+ $tc_params['custid'] = $this->_getParam('user_name');
+ $tc_params['password'] = $this->_getParam('password');
+ $tc_params['action'] = 'unstore';
+ $tc_params['billingid'] = CRM_Utils_Array::value('trxn_id', $params);
- return CRM_Utils_System::url('civicrm/contribute/unsubscribe',
- "reset=1&mid={$entityID}&cs={$checksumValue}", TRUE, NULL, FALSE, FALSE
- );
- }
-
- return ($this->_mode == 'test') ? 'https://test.authorize.net' : 'https://authorize.net';
- }
+ $result = $this->_sendTCRequest($tc_params);
- function cancelSubscription() {
- $template = CRM_Core_Smarty::singleton();
-
- $template->assign('subscriptionType', 'cancel');
-
- $template->assign('apiLogin', $this->_getParam('apiLogin'));
- $template->assign('paymentKey', $this->_getParam('paymentKey'));
- $template->assign('subscriptionId', $this->_getParam('subscriptionId'));
-
- $arbXML = $template->fetch('CRM/Contribute/Form/Contribution/AuthorizeNetARB.tpl');
-
- // submit to authorize.net
- $submit = curl_init($this->_paymentProcessor['url_recur']);
- if (!$submit) {
+ /* Test if call failed */
+ if(!$result) {
return self::error(9002, 'Could not initiate connection to payment gateway');
}
+ /* We are done, pass success */
+ return TRUE;
+ }
- curl_setopt($submit, CURLOPT_RETURNTRANSFER, 1);
- curl_setopt($submit, CURLOPT_HTTPHEADER, array("Content-Type: text/xml"));
- curl_setopt($submit, CURLOPT_HEADER, 1);
- curl_setopt($submit, CURLOPT_POSTFIELDS, $arbXML);
- curl_setopt($submit, CURLOPT_POST, 1);
- curl_setopt($submit, CURLOPT_SSL_VERIFYPEER, 0);
+ function changeSubscriptionAmount(&$message = '', $params = array()) {
+ $tc_params['custid'] = $this->_paymentProcessor['user_name'];
+ $tc_params['password'] = $this->_paymentProcessor['password'];
+ $tc_params['action'] = 'store';
- $response = curl_exec($submit);
+ $tc_params['billingid'] = CRM_Utils_Array::value('subscriptionId', $params);
+ $tc_params['payments'] = CRM_Utils_Array::value('installments', $params);
+ $tc_params['amount'] = CRM_Utils_Array::value('amount', $params) * 100;
- if (!$response) {
- return self::error(curl_errno($submit), curl_error($submit));
+ if($tc_params['payments'] == 1) {
+ $tc_params['payments'] = 0;
}
+ $reply = $this->_sendTCRequest($tc_params);
+ $result = $this->_getTCReply($reply);
- curl_close($submit);
+ /* Test if call failed */
+ if(!$result) {
+ return self::error(9002, 'Could not initiate connection to payment gateway');
+ }
- $responseFields = $this->_ParseArbReturn($response);
+ /* We are done, pass success */
+ return TRUE;
- if ($responseFields['resultCode'] == 'Error') {
- return self::error($responseFields['code'], $responseFields['text']);
}
- // carry on cancelation procedure
- return TRUE;
- }
-
public function install() {
return TRUE;
}
projects / trustcommerce.git / blobdiff