Implement changeSubscriptionAmount method.
[trustcommerce.git] / trustcommerce.php
index bd01c13d69042325ebd5c85039315c48057c2b1b..560cae34ff344d1741ee017907c0ea6b06d1031f 100644 (file)
@@ -1,5 +1,20 @@
 <?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
  *
@@ -18,6 +33,7 @@ class org_fsf_payment_trustcommerce extends CRM_Core_Payment {
   CONST AUTH_DECLINED = 'decline';
   CONST AUTH_BADDATA = 'baddata';
   CONST AUTH_ERROR = 'error';
+  CONST AUTH_BLACKLIST = 'blacklisted';
 
   static protected $_mode = NULL;
 
@@ -53,6 +69,7 @@ class org_fsf_payment_trustcommerce extends CRM_Core_Payment {
     srand(time());
     $this->_setParam('sequence', rand(1, 1000));
     $this->logging_level     = TRUSTCOMMERCE_LOGGING_LEVEL;
+
   }
 
   /**
@@ -98,28 +115,37 @@ class org_fsf_payment_trustcommerce extends CRM_Core_Payment {
     }
 
     /* Pass our cooked params to the alter hook, per Core/Payment/Dummy.php */
-    CRM_Utils_Hook::alterPaymentProcessorParams($this,
-      $params,
-      $tc_params
-    );
+    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($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.');
     }
 
-    /* Call the TC API, and grab the reply */
-    $reply = tclink_send($tc_params);
+    /* 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->_getTrustCommerceReply($reply);
+    $result = $this->_getTCReply($reply);
 
     if($result == 0) {
       /* We were successful, congrats. Lets wrap it up:
        * Convert back to dollars
        * Save the transaction ID
        */
+
+      if (CRM_Utils_Array::value('is_recur', $params) && $params['contributionRecurID']) {
+       $params['contributionRecurID'] = $reply['billingid'];
+      } 
       $params['trxn_id'] = $reply['transid'];
+
       $params['gross_amount'] = $tc_params['amount'] / 100;
 
       return $params;
@@ -130,6 +156,68 @@ class org_fsf_payment_trustcommerce extends CRM_Core_Payment {
     }
   }
 
+  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;
+      }
+    }
+    return FALSE;
+  }
+
+  function _sendTCRequest($request) {
+    $this->_logger($request);
+    return tclink_send($request);
+  }
+
+  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);
+  }
+
   /**
    * Gets the recurring billing fields for the TC API
    * @param  array $fields The fields to modify.
@@ -164,6 +252,7 @@ class org_fsf_payment_trustcommerce extends CRM_Core_Payment {
 
     $fields['cycle'] = '1'.$cycle;   /* The billing cycle in years, months, weeks, or days. */
     $fields['payments'] = $payments;
+    $fields['authnow'] = 'y';
     $fields['action'] = 'store';      /* Change our mode to `store' mode. */
 
     return $fields;
@@ -173,14 +262,19 @@ class org_fsf_payment_trustcommerce extends CRM_Core_Payment {
    * @param  $reply array The result of a call to tclink_send().
    * @return mixed self::error() if transaction failed, otherwise returns 0.
    */
-  function _getTrustCommerceReply($reply) {
+  function _getTCReply($reply) {
 
     /* DUPLIATE CODE, please refactor. ~lisa */
     if (!$reply) {
       return self::error(9002, 'Could not initiate connection to payment gateway');
     }
 
+    $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;
@@ -188,11 +282,16 @@ class org_fsf_payment_trustcommerce extends CRM_Core_Payment {
       // 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');
@@ -321,62 +420,47 @@ class org_fsf_payment_trustcommerce extends CRM_Core_Payment {
     }
   }
 
-  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);
+    
+    $result = $this->_sendTCRequest($tc_params);
 
-      return CRM_Utils_System::url('civicrm/contribute/unsubscribe',
-        "reset=1&mid={$entityID}&cs={$checksumValue}", TRUE, NULL, FALSE, FALSE
-      );
+    /* Test if call failed */
+    if(!$result) {
+      return self::error(9002, 'Could not initiate connection to payment gateway');
     }
-
-    return ($this->_mode == 'test') ? 'https://test.authorize.net' : 'https://authorize.net';
+    /* We are done, pass success */
+    return TRUE;
   }
 
-  function cancelSubscription() {
-    $template = CRM_Core_Smarty::singleton();
-
-    $template->assign('subscriptionType', 'cancel');
+  function changeSubscriptionAmount(&$message = '', $params = array()) {
+    $tc_params['custid'] = $this->_getParam('user_name');
+    $tc_params['password'] = $this->_getParam('password');
+    $tc_params['action'] = 'store';
 
-    $template->assign('apiLogin', $this->_getParam('apiLogin'));
-    $template->assign('paymentKey', $this->_getParam('paymentKey'));
-    $template->assign('subscriptionId', $this->_getParam('subscriptionId'));
+    $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;
 
-    $arbXML = $template->fetch('CRM/Contribute/Form/Contribution/AuthorizeNetARB.tpl');
-
-    // submit to authorize.net
-    $submit = curl_init($this->_paymentProcessor['url_recur']);
-    if (!$submit) {
-      return self::error(9002, 'Could not initiate connection to payment gateway');
+    if($tc_params['payments'] == 1) {
+      $tc_params['payments'] = 0;
     }
+    $reply = $this->_sendTCRequest($tc_params);
+    $result = $this->_getTCReply($reply);
 
-    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);
-
-    $response = curl_exec($submit);
-
-    if (!$response) {
-      return self::error(curl_errno($submit), curl_error($submit));
+    /* Test if call failed */
+    if(!$result) {
+      return self::error(9002, 'Could not initiate connection to payment gateway');
     }
 
-    curl_close($submit);
-
-    $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;
   }