From e751ae55bc1cc602ac0fe485d2f7c09256bcfb9d Mon Sep 17 00:00:00 2001 From: Andrew Engelbrecht Date: Thu, 18 Jan 2018 14:36:08 -0500 Subject: [PATCH] Ported TrustCommerce extension to CiviCRM 4.7.x This module was created with the help of the civix utility. --- CRM/Core/Payment/TrustCommerce.php | 716 +++++++++++++++++++++++++ LICENSE.txt | 667 +++++++++++++++++++++++ README.md | 40 ++ info.xml | 31 +- trustcommerce.civix.php | 445 ++++++++++++++++ trustcommerce.php | 817 +++++------------------------ 6 files changed, 2015 insertions(+), 701 deletions(-) create mode 100644 CRM/Core/Payment/TrustCommerce.php create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 trustcommerce.civix.php diff --git a/CRM/Core/Payment/TrustCommerce.php b/CRM/Core/Payment/TrustCommerce.php new file mode 100644 index 0000000..4548593 --- /dev/null +++ b/CRM/Core/Payment/TrustCommerce.php @@ -0,0 +1,716 @@ +. + * + * Copyright (C) 2012 + * Licensed to CiviCRM under the GPL v3 or higher + * + * Written and contributed by Ward Vandewege (http://www.fsf.org) + * Modified by Lisa Marie Maginnis (http://www.fsf.org) + * Copyright © 2015 David Thompson + * + */ + +/** + * CiviCRM payment processor module for TrustCommerece. + * + * This module uses the TrustCommerece API via the tc_link module (GPLv3) + * distributed by TrustCommerece.com. For full documentation on the + * TrustCommerece API, please see the TCDevGuide for more information: + * https://vault.trustcommerce.com/downloads/TCDevGuide.htm + * + * This module supports the following features: Single credit/debit card + * transactions, AVS checking, recurring (create, update, and cancel + * subscription) optional blacklist with fail2ban, + * + * @copyright Ward Vandewege (http://www.fsf.org) + * @copyright Lisa Marie Maginnis (http://www.fsf.org) + * @copyright David Thompson + * @version 0.4 + * @package org.fsf.payment.trustcommerce + */ + +/** + * Define logging level (0 = off, 4 = log everything) + */ +define('TRUSTCOMMERCE_LOGGING_LEVEL', 4); + +/** + * Load the CiviCRM core payment class so we can extend it. + */ +require_once 'CRM/Core/Payment.php'; + +/** + * The payment processor object, it extends CRM_Core_Payment. + */ +//class org_fsf_payment_trustcommerce extends CRM_Core_Payment { +class CRM_Core_Payment_TrustCommerce extends CRM_Core_Payment { + + /**#@+ + * Constants + */ + /** + * This is our default charset, currently unused. + */ + CONST CHARSET = 'iso-8859-1'; + /** + * The API response value for transaction approved. + */ + CONST AUTH_APPROVED = 'approve'; + /** + * The API response value for transaction declined. + */ + CONST AUTH_DECLINED = 'decline'; + /** + * The API response value for baddata passed to the TC API. + */ + CONST AUTH_BADDATA = 'baddata'; + /** + * The API response value for an error in the TC API call. + */ + CONST AUTH_ERROR = 'error'; + /** + * The API response value for blacklisted in our local blacklist + */ + CONST AUTH_BLACKLIST = 'blacklisted'; + /** + * The API response value for approved status per the TCDevGuide. + */ + CONST AUTH_ACCEPTED = 'accepted'; + + /** + * The current mode of the payment processor, valid values are: live, demo. + * @static + * @var string + */ + static protected $_mode = 'live'; + /** + * The array of params cooked and passed to the TC API via tc_link(). + * @static + * @var array + */ + static protected $_params = array(); + + /** + * We only need one instance of this object. So we use the singleton + * pattern and cache the instance in this variable + * @static + * @var object + */ + static private $_singleton = NULL; + + /** + * Sets our basic TC API paramaters (username, password). Also sets up: + * logging level, processor name, the mode (live/demo), and creates/copies + * our singleton. + * + * @param string $mode the mode of operation: live or test + * @param CRM_Core_Payment The payment processor object. + * + * @return void + */ + function __construct($mode, &$paymentProcessor) { + self::$_mode = $mode; + + $this->_paymentProcessor = $paymentProcessor; + + $this->_processorName = ts('TrustCommerce'); + + $config = CRM_Core_Config::singleton(); + $this->_setParam('user_name', $paymentProcessor['user_name']); + $this->_setParam('password', $paymentProcessor['password']); + + $this->_setParam('timestamp', time()); + srand(time()); + $this->_setParam('sequence', rand(1, 1000)); + $this->logging_level = TRUSTCOMMERCE_LOGGING_LEVEL; + + } + + /** + * The singleton function used to manage this object + * + * @param string $mode the mode of operation: live or test + * @param CRM_Core_Payment The payment processor object. + * + * @return object + * @static + */ + static function &singleton($mode, &$paymentProcessor) { + $processorName = $paymentProcessor['name']; + if (self::$_singleton[$processorName] === NULL) { + self::$_singleton[$processorName] = new CRM_Core_Payment_TrustCommerce($mode, $paymentProcessor); + } + return self::$_singleton[$processorName]; + } + + /** + * 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) { + if (!extension_loaded("tclink")) { + return self::error(9001, 'TrustCommerce requires that the tclink module is loaded'); + } + + /* Copy our paramaters to ourself */ + foreach ($params as $field => $value) { + $this->_setParam($field, $value); + } + + /* Get our fields to pass to tclink_send() */ + $tc_params = $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; + } + + /* 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($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.'); + } + + /* This implements a local blacklist, and passes us though as a normal failure + * if the luser is on the blacklist. */ + if(!$this->_isBlacklisted($tc_params)) { + /* Call the TC API, and grab the reply */ + $reply = $this->_sendTCRequest($tc_params); + } else { + $this->_logger($tc_params); + $reply['status'] = self::AUTH_BLACKLIST; + usleep(rand(1000000,10000000)); + } + + /* Parse our reply */ + $result = $this->_getTCReply($reply); + + if(!is_object($result)) { + 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; + } + } + + /** + * Hook to update CC info for a recurring contribution + * + * @param string $message The message to dispaly on update success/failure + * @param array $params The paramters to pass to the payment processor + * + * @return bool True if successful, false on failure + */ + function updateSubscriptionBillingInfo(&$message = '', $params = array()) { + $expYear = $params['credit_card_exp_date']['Y']; + $expMonth = $params['credit_card_exp_date']['M']; + + // TODO: This should be our build in params set function, not by hand! + $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) { + // TODO: Respect vaules for $messages passed in from our caller + $message = 'Successfully updated TC billing id ' . $tc_params['billingid']; + + return TRUE; + } else { + return FALSE; + } + } + + // TODO: Use the formatting functions throughout the entire class to + // dedupe the conversions done elsewhere in a less reusable way. + + /** + * Internal routine to convert from CiviCRM amounts to TC amounts. + * + * Multiplies the amount by 100. + * + * @param float $amount The currency value to convert. + * + * @return int The TC amount + */ + private function _formatAmount($amount) { + return $amount * 100; + } + + /** + * Internal routine to format the billing name for TC + * + * @param string $firstName The first name to submit to TC + * @param string $lastName The last name to submit to TC + * + * @return string The TC name format, "$firstName $lastName" + */ + private function _formatBillingName($firstName, $lastName) { + return "$firstName $lastName"; + } + + /** + * Formats the expiration date for TC + * + * @param int $year The credit card expiration year + * @param int $month The credit card expiration year + * + * @return The TC CC expiration date format, "$month$year" + */ + private function _formatExpirationDate($year, $month) { + $exp_month = str_pad($month, 2, '0', STR_PAD_LEFT); + $exp_year = substr($year, -2); + + return "$exp_month$exp_year"; + } + + private function _isParamsBlacklisted($tc_params) { + if($tc_params['amount'] == 101) { + error_log("TrustCommerce: _isParamsBlacklisted() triggered"); + return TRUE; + } else { + return FALSE; + } + } + + /** + * Checks to see if the source IP/USERAGENT are blacklisted. + * + * @return bool TRUE if on the blacklist, FALSE if not. + */ + private function _isBlacklisted($tc_params) { + if($this->_isIPBlacklisted()) { + return TRUE; + } else if($this->_isAgentBlacklisted()) { + return TRUE; + } else if($this->_isParamsBlacklisted($tc_params)) { + return TRUE; + } + return FALSE; + + } + + /** + * Checks to see if the source USERAGENT is blacklisted + * + * @return bool TRUE if on the blacklist, FALSE if not. + */ + private function _isAgentBlacklisted() { + // TODO: fix DB calls to be more the CiviCRM way + $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; + } + + /** + * Checks to see if the source IP is blacklisted + * + * @return bool TRUE if on the blacklist, FALSE if not. + */ + private function _isIPBlacklisted() { + // TODO: fix DB calls to be more the CiviCRM way + $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; + } + + /** + * Sends the API call to TC for processing + * + * @param array $request The array of paramaters to pass the TC API + * + * @return array The response from the TC API + */ + function _sendTCRequest($request) { + $this->_logger($request); + return tclink_send($request); + } + + /** + * Logs paramaters from TC along with the remote address of the client + * + * Will log paramaters via the error_log() routine. For security reasons + * the following values are not logged (skipped): custid, password, cc + * exp, and cvv. + * + * @param array $params The paramaters to log + */ + 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. + * @return array The fields for tclink_send(), modified for recurring billing. + * @public + */ + function _getRecurPaymentFields($fields) { + $payments = $this->_getParam('frequency_interval'); + $cycle = $this->_getParam('frequency_unit'); + + /* Translate billing cycle from CiviCRM -> TC */ + switch($cycle) { + case 'day': + $cycle = 'd'; + break; + case 'week': + $cycle = 'w'; + break; + case 'month': + $cycle = 'm'; + break; + case 'year': + $cycle = 'y'; + break; + } + + /* 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; + } + + $fields['cycle'] = '1'.$cycle; /* The billing cycle in years, months, weeks, or days. */ + $fields['payments'] = $payments; + $fields['action'] = 'store'; /* Change our mode to `store' mode. */ + + return $fields; + } + + /** Parses a response from TC via the tclink_send() command. + * + * @param array $reply The result of a call to tclink_send(). + * + * @return mixed|CRM_Core_Error CRM_Core_Error object if transaction failed, otherwise + * returns 0. + */ + 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 for address verification reasons. If your address was correct please contact us at donate@fsf.org before attempting to retry your transaction."); + break; + case self::AUTH_APPROVED: + break; + case self::AUTH_ACCEPTED: + // 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 + 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. Please check the correctness of your credit card information, including CC number, expiration date and CVV code."); + break; + case self::AUTH_BADDATA: + // 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'); + break; + } + return 0; + } + + /** + * Generate the basic paramaters to send the TC API + * + * @return array The array of paramaters to pass _sendTCRequest() + */ + function _getTrustCommerceFields() { + // Total amount is from the form contribution field + $amount = $this->_getParam('total_amount'); + // CRM-9894 would this ever be the case?? + if (empty($amount)) { + $amount = $this->_getParam('amount'); + } + $fields = array(); + $fields['custid'] = $this->_getParam('user_name'); + $fields['password'] = $this->_getParam('password'); + $fields['action'] = 'sale'; + + // Enable address verification + $fields['avs'] = 'y'; + + $fields['address1'] = $this->_getParam('street_address'); + $fields['zip'] = $this->_getParam('postal_code'); + + $fields['name'] = $this->_getParam('billing_first_name') . ' ' . $this->_getParam('billing_last_name'); + + // This assumes currencies where the . is used as the decimal point, like USD + $amount = preg_replace("/([^0-9\\.])/i", "", $amount); + + // We need to pass the amount to TrustCommerce in dollar cents + $fields['amount'] = $amount * 100; + + // Unique identifier + $fields['ticket'] = substr($this->_getParam('invoiceID'), 0, 20); + + // cc info + $fields['cc'] = $this->_getParam('credit_card_number'); + $fields['cvv'] = $this->_getParam('cvv2'); + $exp_month = str_pad($this->_getParam('month'), 2, '0', STR_PAD_LEFT); + $exp_year = substr($this->_getParam('year'),-2); + $fields['exp'] = "$exp_month$exp_year"; + + if (self::$_mode != 'live') { + $fields['demo'] = 'y'; + } + return $fields; + } + + /** + * 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 + */ + function _checkDupe($invoiceId) { + require_once 'CRM/Contribute/DAO/Contribution.php'; + $contribution = new CRM_Contribute_DAO_Contribution(); + $contribution->invoice_id = $invoiceId; + return $contribution->find(); + } + + /** + * Get the value of a field if set + * + * @param string $field the field + * + * @return mixed value of the field, or empty string if the field is + * not set + */ + function _getParam($field) { + return CRM_Utils_Array::value($field, self::$_params, ''); + } + + /** + * Sets our error message/logging information for CiviCRM + * + * @param int $errorCode The numerical code of the error, defaults to 9001 + * @param string $errorMessage The error message to display/log + * + * @return CRM_Core_Error The error object with message and code. + */ + function &error($errorCode = NULL, $errorMessage = NULL) { + $e = CRM_Core_Error::singleton(); + if ($errorCode) { + $e->push($errorCode, 0, NULL, $errorMessage); + } + else { + $e->push(9001, 0, NULL, 'Unknown System Error.'); + } + return $e; + } + + /** + * Set a field to the specified value. Value must be a scalar (int, + * float, string, or boolean) + * + * @param string $field + * @param mixed $value + * + * @return bool false if value is not a scalar, true if successful + */ + function _setParam($field, $value) { + if (!is_scalar($value)) { + return FALSE; + } + else { + self::$_params[$field] = $value; + } + } + + /** + * Checks to see if we have the manditory config values set. + * + * @return string the error message if any + * @public + */ + function checkConfig() { + $error = array(); + if (empty($this->_paymentProcessor['user_name'])) { + $error[] = ts('Customer ID is not set for this payment processor'); + } + + if (empty($this->_paymentProcessor['password'])) { + $error[] = ts('Password is not set for this payment processor'); + } + + if (!empty($error)) { + return implode('

', $error); + } else { + return NULL; + } + } + + /** + * Hook to cancel a recurring contribution + * + * @param string $message The message to dispaly on update success/failure + * @param array $params The paramters to pass to the payment processor + * + * @return bool True if successful, false on failure + */ + 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('subscriptionId', $params); + + $result = $this->_sendTCRequest($tc_params); + + /* Test if call failed */ + if(!$result) { + return self::error(9002, 'Could not initiate connection to payment gateway'); + } + /* We are done, pass success */ + return TRUE; + } + + /** + * Hook to update amount billed for a recurring contribution + * + * @param string $message The message to dispaly on update success/failure + * @param array $params The paramters to pass to the payment processor + * + * @return bool True if successful, false on failure + */ + function changeSubscriptionAmount(&$message = '', $params = array()) { + $tc_params['custid'] = $this->_paymentProcessor['user_name']; + $tc_params['password'] = $this->_paymentProcessor['password']; + $tc_params['action'] = 'store'; + + $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($tc_params['payments'] == 1) { + $tc_params['payments'] = 0; + } + $reply = $this->_sendTCRequest($tc_params); + $result = $this->_getTCReply($reply); + + /* We are done, pass success */ + return TRUE; + + } + + /** + * Installs the trustcommerce module (currently a dummy) + */ + public function install() { + return TRUE; + } + + /** + * Uninstalls the trustcommerce module (currently a dummy) + */ + public function uninstall() { + return TRUE; + } + +} + diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..982a442 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,667 @@ +Package: org.fsf.payment.trustcommerce +Copyright (C) 2018, FIXME +Licensed under the GNU Affero Public License 3.0 (below). + +------------------------------------------------------------------------------- + + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f127db1 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# org.fsf.payment.trustcommerce + +This extension allows CiviCRM users to use TrustCommerce. + +The extension is licensed under [AGPL-3.0](LICENSE.txt). + +## Requirements + +* PHP 7.0 +* CiviCRM 4.7.x + +## Installation (Web UI) + +This extension has not yet been published for installation via the web UI. + +## Installation + +Intall the module in your custom extensions directory. The name of the top +level directory unpacked by the tarball should be changed to +`org.fsf.payment.trustcommerce`. + +You will need to add rows to `civicrm_payment_processor_type` in your database. + + | id | name | title | description | is_active | is_default | user_name_label | password_label | signature_label | subject_label | class_name | url_site_default | url_api_default | url_recur_default | url_button_default | url_site_test_default | url_api_test_default | url_recur_test_default | url_button_test_default | billing_mode | is_recur | payment_type | payment_instrument_id | + | 19 | TrustCommerce | TrustCommerce (org.fsf.payment.trustcommerce) | TrustCommerce Payment Processor | 1 | NULL | Vendor ID | Password | | | Payment_TrustCommerce | https://vault.trustcommerce.com/trans/ | | https://vault.trustcommerce.com/trans/ | | https://vault.trustcommerce.com/trans/ | https://vault.trustcommerce.com/trans/ | https://vault.trustcommerce.com/trans/ | | 1 | 1 | 1 | 1 | + +## Usage + +Go to Administer -> System Settings -> Payment Processors and add The +TrustCommerce PP. + +## Known Issues + +There are no hooks for installation and uninstallation of plugin, so tables +need to be updated manually. + +If the class names in the `civicrm_payment_processor_type` or +`civicrm_payment_processor` tables are incorrect, then they need to be changed +to `Payment_TrustCommerce`. + diff --git a/info.xml b/info.xml index bcfa747..d77730e 100644 --- a/info.xml +++ b/info.xml @@ -1,23 +1,32 @@ - - - http://agpl.fsf.org/crm.fsf.org/CURRENT/trustcommerce-0.1.zip + + + http://agpl.fsf.org/crm.fsf.org/CURRENT/trustcommerce.tar.gz trustcommerce TrustCommerce TrustCommerce Payment Processor - + http://www.fsf.org - AGPL3 + AGPL-3.0 - Nico Cesar, Ward Vandewege, Lisa Marie Maginnis, David Thompson - sysadmin@fsf.org + Nico Cesar, Ward Vandewege, Lisa Marie Maginnis, David Thompson, Andrew Engelbrecht + sysadmin@gnu.org - 2014-08-29 - 0.4 + + + + + http://www.gnu.org/licenses/agpl-3.0.html + + 2018-01-17 + 0.5 beta - 4.4 + 4.7 + + CRM/TrustCommerce + For support, please contact project team on the forums. Vendor ID @@ -29,7 +38,7 @@ https://vault.trustcommerce.com/trans/ - + https://vault.trustcommerce.com/trans/ https://vault.trustcommerce.com/trans/ https://vault.trustcommerce.com/trans/ diff --git a/trustcommerce.civix.php b/trustcommerce.civix.php new file mode 100644 index 0000000..6e73eae --- /dev/null +++ b/trustcommerce.civix.php @@ -0,0 +1,445 @@ +getUrl(self::LONG_NAME), '/'); + } + return CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME, $file); + } + + /** + * Get the path of a resource file (in this extension). + * + * @param string|NULL $file + * Ex: NULL. + * Ex: 'css/foo.css'. + * @return string + * Ex: '/var/www/example.org/sites/default/ext/org.example.foo'. + * Ex: '/var/www/example.org/sites/default/ext/org.example.foo/css/foo.css'. + */ + public static function path($file = NULL) { + // return CRM_Core_Resources::singleton()->getPath(self::LONG_NAME, $file); + return __DIR__ . ($file === NULL ? '' : (DIRECTORY_SEPARATOR . $file)); + } + + /** + * Get the name of a class within this extension. + * + * @param string $suffix + * Ex: 'Page_HelloWorld' or 'Page\\HelloWorld'. + * @return string + * Ex: 'CRM_Foo_Page_HelloWorld'. + */ + public static function findClass($suffix) { + return self::CLASS_PREFIX . '_' . str_replace('\\', '_', $suffix); + } + +} + +use CRM_TrustCommerce_ExtensionUtil as E; + +/** + * (Delegated) Implements hook_civicrm_config(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config + */ +function _trustcommerce_civix_civicrm_config(&$config = NULL) { + static $configured = FALSE; + if ($configured) { + return; + } + $configured = TRUE; + + $template =& CRM_Core_Smarty::singleton(); + + $extRoot = dirname(__FILE__) . DIRECTORY_SEPARATOR; + $extDir = $extRoot . 'templates'; + + if (is_array($template->template_dir)) { + array_unshift($template->template_dir, $extDir); + } + else { + $template->template_dir = array($extDir, $template->template_dir); + } + + $include_path = $extRoot . PATH_SEPARATOR . get_include_path(); + set_include_path($include_path); +} + +/** + * (Delegated) Implements hook_civicrm_xmlMenu(). + * + * @param $files array(string) + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu + */ +function _trustcommerce_civix_civicrm_xmlMenu(&$files) { + foreach (_trustcommerce_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) { + $files[] = $file; + } +} + +/** + * Implements hook_civicrm_install(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install + */ +function _trustcommerce_civix_civicrm_install() { + _trustcommerce_civix_civicrm_config(); + if ($upgrader = _trustcommerce_civix_upgrader()) { + $upgrader->onInstall(); + } +} + +/** + * Implements hook_civicrm_postInstall(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall + */ +function _trustcommerce_civix_civicrm_postInstall() { + _trustcommerce_civix_civicrm_config(); + if ($upgrader = _trustcommerce_civix_upgrader()) { + if (is_callable(array($upgrader, 'onPostInstall'))) { + $upgrader->onPostInstall(); + } + } +} + +/** + * Implements hook_civicrm_uninstall(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall + */ +function _trustcommerce_civix_civicrm_uninstall() { + _trustcommerce_civix_civicrm_config(); + if ($upgrader = _trustcommerce_civix_upgrader()) { + $upgrader->onUninstall(); + } +} + +/** + * (Delegated) Implements hook_civicrm_enable(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable + */ +function _trustcommerce_civix_civicrm_enable() { + _trustcommerce_civix_civicrm_config(); + if ($upgrader = _trustcommerce_civix_upgrader()) { + if (is_callable(array($upgrader, 'onEnable'))) { + $upgrader->onEnable(); + } + } +} + +/** + * (Delegated) Implements hook_civicrm_disable(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable + * @return mixed + */ +function _trustcommerce_civix_civicrm_disable() { + _trustcommerce_civix_civicrm_config(); + if ($upgrader = _trustcommerce_civix_upgrader()) { + if (is_callable(array($upgrader, 'onDisable'))) { + $upgrader->onDisable(); + } + } +} + +/** + * (Delegated) Implements hook_civicrm_upgrade(). + * + * @param $op string, the type of operation being performed; 'check' or 'enqueue' + * @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks + * + * @return mixed based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending) + * for 'enqueue', returns void + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade + */ +function _trustcommerce_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { + if ($upgrader = _trustcommerce_civix_upgrader()) { + return $upgrader->onUpgrade($op, $queue); + } +} + +/** + * @return CRM_TrustCommerce_Upgrader + */ +function _trustcommerce_civix_upgrader() { + if (!file_exists(__DIR__ . '/CRM/TrustCommerce/Upgrader.php')) { + return NULL; + } + else { + return CRM_TrustCommerce_Upgrader_Base::instance(); + } +} + +/** + * Search directory tree for files which match a glob pattern + * + * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored. + * Note: In Civi 4.3+, delegate to CRM_Utils_File::findFiles() + * + * @param $dir string, base dir + * @param $pattern string, glob pattern, eg "*.txt" + * @return array(string) + */ +function _trustcommerce_civix_find_files($dir, $pattern) { + if (is_callable(array('CRM_Utils_File', 'findFiles'))) { + return CRM_Utils_File::findFiles($dir, $pattern); + } + + $todos = array($dir); + $result = array(); + while (!empty($todos)) { + $subdir = array_shift($todos); + foreach (_trustcommerce_civix_glob("$subdir/$pattern") as $match) { + if (!is_dir($match)) { + $result[] = $match; + } + } + if ($dh = opendir($subdir)) { + while (FALSE !== ($entry = readdir($dh))) { + $path = $subdir . DIRECTORY_SEPARATOR . $entry; + if ($entry{0} == '.') { + } + elseif (is_dir($path)) { + $todos[] = $path; + } + } + closedir($dh); + } + } + return $result; +} +/** + * (Delegated) Implements hook_civicrm_managed(). + * + * Find any *.mgd.php files, merge their content, and return. + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed + */ +function _trustcommerce_civix_civicrm_managed(&$entities) { + $mgdFiles = _trustcommerce_civix_find_files(__DIR__, '*.mgd.php'); + foreach ($mgdFiles as $file) { + $es = include $file; + foreach ($es as $e) { + if (empty($e['module'])) { + $e['module'] = E::LONG_NAME; + } + $entities[] = $e; + if (empty($e['params']['version'])) { + $e['params']['version'] = '3'; + } + } + } +} + +/** + * (Delegated) Implements hook_civicrm_caseTypes(). + * + * Find any and return any files matching "xml/case/*.xml" + * + * Note: This hook only runs in CiviCRM 4.4+. + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes + */ +function _trustcommerce_civix_civicrm_caseTypes(&$caseTypes) { + if (!is_dir(__DIR__ . '/xml/case')) { + return; + } + + foreach (_trustcommerce_civix_glob(__DIR__ . '/xml/case/*.xml') as $file) { + $name = preg_replace('/\.xml$/', '', basename($file)); + if ($name != CRM_Case_XMLProcessor::mungeCaseType($name)) { + $errorMessage = sprintf("Case-type file name is malformed (%s vs %s)", $name, CRM_Case_XMLProcessor::mungeCaseType($name)); + CRM_Core_Error::fatal($errorMessage); + // throw new CRM_Core_Exception($errorMessage); + } + $caseTypes[$name] = array( + 'module' => E::LONG_NAME, + 'name' => $name, + 'file' => $file, + ); + } +} + +/** + * (Delegated) Implements hook_civicrm_angularModules(). + * + * Find any and return any files matching "ang/*.ang.php" + * + * Note: This hook only runs in CiviCRM 4.5+. + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_angularModules + */ +function _trustcommerce_civix_civicrm_angularModules(&$angularModules) { + if (!is_dir(__DIR__ . '/ang')) { + return; + } + + $files = _trustcommerce_civix_glob(__DIR__ . '/ang/*.ang.php'); + foreach ($files as $file) { + $name = preg_replace(':\.ang\.php$:', '', basename($file)); + $module = include $file; + if (empty($module['ext'])) { + $module['ext'] = E::LONG_NAME; + } + $angularModules[$name] = $module; + } +} + +/** + * Glob wrapper which is guaranteed to return an array. + * + * The documentation for glob() says, "On some systems it is impossible to + * distinguish between empty match and an error." Anecdotally, the return + * result for an empty match is sometimes array() and sometimes FALSE. + * This wrapper provides consistency. + * + * @link http://php.net/glob + * @param string $pattern + * @return array, possibly empty + */ +function _trustcommerce_civix_glob($pattern) { + $result = glob($pattern); + return is_array($result) ? $result : array(); +} + +/** + * Inserts a navigation menu item at a given place in the hierarchy. + * + * @param array $menu - menu hierarchy + * @param string $path - path where insertion should happen (ie. Administer/System Settings) + * @param array $item - menu you need to insert (parent/child attributes will be filled for you) + */ +function _trustcommerce_civix_insert_navigation_menu(&$menu, $path, $item) { + // If we are done going down the path, insert menu + if (empty($path)) { + $menu[] = array( + 'attributes' => array_merge(array( + 'label' => CRM_Utils_Array::value('name', $item), + 'active' => 1, + ), $item), + ); + return TRUE; + } + else { + // Find an recurse into the next level down + $found = FALSE; + $path = explode('/', $path); + $first = array_shift($path); + foreach ($menu as $key => &$entry) { + if ($entry['attributes']['name'] == $first) { + if (!isset($entry['child'])) { + $entry['child'] = array(); + } + $found = _trustcommerce_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item, $key); + } + } + return $found; + } +} + +/** + * (Delegated) Implements hook_civicrm_navigationMenu(). + */ +function _trustcommerce_civix_navigationMenu(&$nodes) { + if (!is_callable(array('CRM_Core_BAO_Navigation', 'fixNavigationMenu'))) { + _trustcommerce_civix_fixNavigationMenu($nodes); + } +} + +/** + * Given a navigation menu, generate navIDs for any items which are + * missing them. + */ +function _trustcommerce_civix_fixNavigationMenu(&$nodes) { + $maxNavID = 1; + array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) { + if ($key === 'navID') { + $maxNavID = max($maxNavID, $item); + } + }); + _trustcommerce_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL); +} + +function _trustcommerce_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) { + $origKeys = array_keys($nodes); + foreach ($origKeys as $origKey) { + if (!isset($nodes[$origKey]['attributes']['parentID']) && $parentID !== NULL) { + $nodes[$origKey]['attributes']['parentID'] = $parentID; + } + // If no navID, then assign navID and fix key. + if (!isset($nodes[$origKey]['attributes']['navID'])) { + $newKey = ++$maxNavID; + $nodes[$origKey]['attributes']['navID'] = $newKey; + $nodes[$newKey] = $nodes[$origKey]; + unset($nodes[$origKey]); + $origKey = $newKey; + } + if (isset($nodes[$origKey]['child']) && is_array($nodes[$origKey]['child'])) { + _trustcommerce_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']); + } + } +} + +/** + * (Delegated) Implements hook_civicrm_alterSettingsFolders(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders + */ +function _trustcommerce_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { + static $configured = FALSE; + if ($configured) { + return; + } + $configured = TRUE; + + $settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings'; + if (is_dir($settingsDir) && !in_array($settingsDir, $metaDataFolders)) { + $metaDataFolders[] = $settingsDir; + } +} diff --git a/trustcommerce.php b/trustcommerce.php index e5e4527..9abdcd9 100644 --- a/trustcommerce.php +++ b/trustcommerce.php @@ -1,715 +1,152 @@ . - * - * Copyright (C) 2012 - * Licensed to CiviCRM under the GPL v3 or higher - * - * Written and contributed by Ward Vandewege (http://www.fsf.org) - * Modified by Lisa Marie Maginnis (http://www.fsf.org) - * Copyright © 2015 David Thompson + +require_once 'trustcommerce.civix.php'; +use CRM_TrustCommerce_ExtensionUtil as E; + +/** + * Implements hook_civicrm_config(). * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config */ +function trustcommerce_civicrm_config(&$config) { + _trustcommerce_civix_civicrm_config($config); +} /** - * CiviCRM payment processor module for TrustCommerece. - * - * This module uses the TrustCommerece API via the tc_link module (GPLv3) - * distributed by TrustCommerece.com. For full documentation on the - * TrustCommerece API, please see the TCDevGuide for more information: - * https://vault.trustcommerce.com/downloads/TCDevGuide.htm - * - * This module supports the following features: Single credit/debit card - * transactions, AVS checking, recurring (create, update, and cancel - * subscription) optional blacklist with fail2ban, - * - * @copyright Ward Vandewege (http://www.fsf.org) - * @copyright Lisa Marie Maginnis (http://www.fsf.org) - * @copyright David Thompson - * @version 0.4 - * @package org.fsf.payment.trustcommerce - */ + * Implements hook_civicrm_xmlMenu(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu + */ +function trustcommerce_civicrm_xmlMenu(&$files) { + _trustcommerce_civix_civicrm_xmlMenu($files); +} /** - * Define logging level (0 = off, 4 = log everything) + * Implements hook_civicrm_install(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install */ -define('TRUSTCOMMERCE_LOGGING_LEVEL', 4); +function trustcommerce_civicrm_install() { + _trustcommerce_civix_civicrm_install(); +} /** - * Load the CiviCRM core payment class so we can extend it. + * Implements hook_civicrm_postInstall(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall */ -require_once 'CRM/Core/Payment.php'; +function trustcommerce_civicrm_postInstall() { + _trustcommerce_civix_civicrm_postInstall(); +} /** - * The payment processor object, it extends CRM_Core_Payment. + * Implements hook_civicrm_uninstall(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall */ -class org_fsf_payment_trustcommerce extends CRM_Core_Payment { - - /**#@+ - * Constants - */ - /** - * This is our default charset, currently unused. - */ - CONST CHARSET = 'iso-8859-1'; - /** - * The API response value for transaction approved. - */ - CONST AUTH_APPROVED = 'approve'; - /** - * The API response value for transaction declined. - */ - CONST AUTH_DECLINED = 'decline'; - /** - * The API response value for baddata passed to the TC API. - */ - CONST AUTH_BADDATA = 'baddata'; - /** - * The API response value for an error in the TC API call. - */ - CONST AUTH_ERROR = 'error'; - /** - * The API response value for blacklisted in our local blacklist - */ - CONST AUTH_BLACKLIST = 'blacklisted'; - /** - * The API response value for approved status per the TCDevGuide. - */ - CONST AUTH_ACCEPTED = 'accepted'; - - /** - * The current mode of the payment processor, valid values are: live, demo. - * @static - * @var string - */ - static protected $_mode = NULL; - /** - * The array of params cooked and passed to the TC API via tc_link(). - * @static - * @var array - */ - static protected $_params = array(); - - /** - * We only need one instance of this object. So we use the singleton - * pattern and cache the instance in this variable - * @static - * @var object - */ - static private $_singleton = NULL; - - /** - * Sets our basic TC API paramaters (username, password). Also sets up: - * logging level, processor name, the mode (live/demo), and creates/copies - * our singleton. - * - * @param string $mode the mode of operation: live or test - * @param CRM_Core_Payment The payment processor object. - * - * @return void - */ - function __construct($mode, &$paymentProcessor) { - self::$_mode = $mode; - - $this->_paymentProcessor = $paymentProcessor; - - $this->_processorName = ts('TrustCommerce'); - - $config = CRM_Core_Config::singleton(); - $this->_setParam('user_name', $paymentProcessor['user_name']); - $this->_setParam('password', $paymentProcessor['password']); - - $this->_setParam('timestamp', time()); - srand(time()); - $this->_setParam('sequence', rand(1, 1000)); - $this->logging_level = TRUSTCOMMERCE_LOGGING_LEVEL; - - } - - /** - * The singleton function used to manage this object - * - * @param string $mode the mode of operation: live or test - * @param CRM_Core_Payment The payment processor object. - * - * @return object - * @static - */ - /* static function &singleton($mode, &$paymentProcessor) { - $processorName = $paymentProcessor['name']; - if (self::$_singleton[$processorName] === NULL) { - self::$_singleton[$processorName] = new org_fsf_payment_trustcommerce($mode, $paymentProcessor); - } - return self::$_singleton[$processorName]; - }*/ - - /** - * 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) { - if (!extension_loaded("tclink")) { - return self::error(9001, 'TrustCommerce requires that the tclink module is loaded'); - } - - /* Copy our paramaters to ourself */ - foreach ($params as $field => $value) { - $this->_setParam($field, $value); - } - - /* Get our fields to pass to tclink_send() */ - $tc_params = $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; - } - - /* 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($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.'); - } - - /* This implements a local blacklist, and passes us though as a normal failure - * if the luser is on the blacklist. */ - if(!$this->_isBlacklisted($tc_params)) { - /* Call the TC API, and grab the reply */ - $reply = $this->_sendTCRequest($tc_params); - } else { - $this->_logger($tc_params); - $reply['status'] = self::AUTH_BLACKLIST; - usleep(rand(1000000,10000000)); - } - - /* Parse our reply */ - $result = $this->_getTCReply($reply); - - if(!is_object($result)) { - 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; - } - } - - /** - * Hook to update CC info for a recurring contribution - * - * @param string $message The message to dispaly on update success/failure - * @param array $params The paramters to pass to the payment processor - * - * @return bool True if successful, false on failure - */ - function updateSubscriptionBillingInfo(&$message = '', $params = array()) { - $expYear = $params['credit_card_exp_date']['Y']; - $expMonth = $params['credit_card_exp_date']['M']; - - // TODO: This should be our build in params set function, not by hand! - $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) { - // TODO: Respect vaules for $messages passed in from our caller - $message = 'Successfully updated TC billing id ' . $tc_params['billingid']; - - return TRUE; - } else { - return FALSE; - } - } - - // TODO: Use the formatting functions throughout the entire class to - // dedupe the conversions done elsewhere in a less reusable way. - - /** - * Internal routine to convert from CiviCRM amounts to TC amounts. - * - * Multiplies the amount by 100. - * - * @param float $amount The currency value to convert. - * - * @return int The TC amount - */ - private function _formatAmount($amount) { - return $amount * 100; - } - - /** - * Internal routine to format the billing name for TC - * - * @param string $firstName The first name to submit to TC - * @param string $lastName The last name to submit to TC - * - * @return string The TC name format, "$firstName $lastName" - */ - private function _formatBillingName($firstName, $lastName) { - return "$firstName $lastName"; - } - - /** - * Formats the expiration date for TC - * - * @param int $year The credit card expiration year - * @param int $month The credit card expiration year - * - * @return The TC CC expiration date format, "$month$year" - */ - private function _formatExpirationDate($year, $month) { - $exp_month = str_pad($month, 2, '0', STR_PAD_LEFT); - $exp_year = substr($year, -2); - - return "$exp_month$exp_year"; - } - - private function _isParamsBlacklisted($tc_params) { - if($tc_params['amount'] == 101) { - error_log("TrustCommerce: _isParamsBlacklisted() triggered"); - return TRUE; - } else { - return FALSE; - } - } - - /** - * Checks to see if the source IP/USERAGENT are blacklisted. - * - * @return bool TRUE if on the blacklist, FALSE if not. - */ - private function _isBlacklisted($tc_params) { - if($this->_isIPBlacklisted()) { - return TRUE; - } else if($this->_isAgentBlacklisted()) { - return TRUE; - } else if($this->_isParamsBlacklisted($tc_params)) { - return TRUE; - } - return FALSE; - - } - - /** - * Checks to see if the source USERAGENT is blacklisted - * - * @return bool TRUE if on the blacklist, FALSE if not. - */ - private function _isAgentBlacklisted() { - // TODO: fix DB calls to be more the CiviCRM way - $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; - } - - /** - * Checks to see if the source IP is blacklisted - * - * @return bool TRUE if on the blacklist, FALSE if not. - */ - private function _isIPBlacklisted() { - // TODO: fix DB calls to be more the CiviCRM way - $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; - } - - /** - * Sends the API call to TC for processing - * - * @param array $request The array of paramaters to pass the TC API - * - * @return array The response from the TC API - */ - function _sendTCRequest($request) { - $this->_logger($request); - return tclink_send($request); - } - - /** - * Logs paramaters from TC along with the remote address of the client - * - * Will log paramaters via the error_log() routine. For security reasons - * the following values are not logged (skipped): custid, password, cc - * exp, and cvv. - * - * @param array $params The paramaters to log - */ - 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. - * @return array The fields for tclink_send(), modified for recurring billing. - * @public - */ - function _getRecurPaymentFields($fields) { - $payments = $this->_getParam('frequency_interval'); - $cycle = $this->_getParam('frequency_unit'); - - /* Translate billing cycle from CiviCRM -> TC */ - switch($cycle) { - case 'day': - $cycle = 'd'; - break; - case 'week': - $cycle = 'w'; - break; - case 'month': - $cycle = 'm'; - break; - case 'year': - $cycle = 'y'; - break; - } - - /* 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; - } - - $fields['cycle'] = '1'.$cycle; /* The billing cycle in years, months, weeks, or days. */ - $fields['payments'] = $payments; - $fields['action'] = 'store'; /* Change our mode to `store' mode. */ - - return $fields; - } - - /** Parses a response from TC via the tclink_send() command. - * - * @param array $reply The result of a call to tclink_send(). - * - * @return mixed|CRM_Core_Error CRM_Core_Error object if transaction failed, otherwise - * returns 0. - */ - 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 for address verification reasons. If your address was correct please contact us at donate@fsf.org before attempting to retry your transaction."); - break; - case self::AUTH_APPROVED: - break; - case self::AUTH_ACCEPTED: - // 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 - 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. Please check the correctness of your credit card information, including CC number, expiration date and CVV code."); - break; - case self::AUTH_BADDATA: - // 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'); - break; - } - return 0; - } - - /** - * Generate the basic paramaters to send the TC API - * - * @return array The array of paramaters to pass _sendTCRequest() - */ - function _getTrustCommerceFields() { - // Total amount is from the form contribution field - $amount = $this->_getParam('total_amount'); - // CRM-9894 would this ever be the case?? - if (empty($amount)) { - $amount = $this->_getParam('amount'); - } - $fields = array(); - $fields['custid'] = $this->_getParam('user_name'); - $fields['password'] = $this->_getParam('password'); - $fields['action'] = 'sale'; - - // Enable address verification - $fields['avs'] = 'y'; - - $fields['address1'] = $this->_getParam('street_address'); - $fields['zip'] = $this->_getParam('postal_code'); - - $fields['name'] = $this->_getParam('billing_first_name') . ' ' . $this->_getParam('billing_last_name'); - - // This assumes currencies where the . is used as the decimal point, like USD - $amount = preg_replace("/([^0-9\\.])/i", "", $amount); - - // We need to pass the amount to TrustCommerce in dollar cents - $fields['amount'] = $amount * 100; - - // Unique identifier - $fields['ticket'] = substr($this->_getParam('invoiceID'), 0, 20); - - // cc info - $fields['cc'] = $this->_getParam('credit_card_number'); - $fields['cvv'] = $this->_getParam('cvv2'); - $exp_month = str_pad($this->_getParam('month'), 2, '0', STR_PAD_LEFT); - $exp_year = substr($this->_getParam('year'),-2); - $fields['exp'] = "$exp_month$exp_year"; - - if (self::$_mode != 'live') { - $fields['demo'] = 'y'; - } - return $fields; - } - - /** - * 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 - */ - function _checkDupe($invoiceId) { - require_once 'CRM/Contribute/DAO/Contribution.php'; - $contribution = new CRM_Contribute_DAO_Contribution(); - $contribution->invoice_id = $invoiceId; - return $contribution->find(); - } - - /** - * Get the value of a field if set - * - * @param string $field the field - * - * @return mixed value of the field, or empty string if the field is - * not set - */ - function _getParam($field) { - return CRM_Utils_Array::value($field, self::$_params, ''); - } - - /** - * Sets our error message/logging information for CiviCRM - * - * @param int $errorCode The numerical code of the error, defaults to 9001 - * @param string $errorMessage The error message to display/log - * - * @return CRM_Core_Error The error object with message and code. - */ - function &error($errorCode = NULL, $errorMessage = NULL) { - $e = CRM_Core_Error::singleton(); - if ($errorCode) { - $e->push($errorCode, 0, NULL, $errorMessage); - } - else { - $e->push(9001, 0, NULL, 'Unknown System Error.'); - } - return $e; - } - - /** - * Set a field to the specified value. Value must be a scalar (int, - * float, string, or boolean) - * - * @param string $field - * @param mixed $value - * - * @return bool false if value is not a scalar, true if successful - */ - function _setParam($field, $value) { - if (!is_scalar($value)) { - return FALSE; - } - else { - self::$_params[$field] = $value; - } - } - - /** - * Checks to see if we have the manditory config values set. - * - * @return string the error message if any - * @public - */ - function checkConfig() { - $error = array(); - if (empty($this->_paymentProcessor['user_name'])) { - $error[] = ts('Customer ID is not set for this payment processor'); - } - - if (empty($this->_paymentProcessor['password'])) { - $error[] = ts('Password is not set for this payment processor'); - } - - if (!empty($error)) { - return implode('

', $error); - } else { - return NULL; - } - } - - /** - * Hook to cancel a recurring contribution - * - * @param string $message The message to dispaly on update success/failure - * @param array $params The paramters to pass to the payment processor - * - * @return bool True if successful, false on failure - */ - 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('subscriptionId', $params); +function trustcommerce_civicrm_uninstall() { + _trustcommerce_civix_civicrm_uninstall(); +} - $result = $this->_sendTCRequest($tc_params); +/** + * Implements hook_civicrm_enable(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable + */ +function trustcommerce_civicrm_enable() { + _trustcommerce_civix_civicrm_enable(); +} - /* Test if call failed */ - if(!$result) { - return self::error(9002, 'Could not initiate connection to payment gateway'); - } - /* We are done, pass success */ - return TRUE; - } +/** + * Implements hook_civicrm_disable(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable + */ +function trustcommerce_civicrm_disable() { + _trustcommerce_civix_civicrm_disable(); +} - /** - * Hook to update amount billed for a recurring contribution - * - * @param string $message The message to dispaly on update success/failure - * @param array $params The paramters to pass to the payment processor - * - * @return bool True if successful, false on failure - */ - function changeSubscriptionAmount(&$message = '', $params = array()) { - $tc_params['custid'] = $this->_paymentProcessor['user_name']; - $tc_params['password'] = $this->_paymentProcessor['password']; - $tc_params['action'] = 'store'; +/** + * Implements hook_civicrm_upgrade(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade + */ +function trustcommerce_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { + return _trustcommerce_civix_civicrm_upgrade($op, $queue); +} - $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; +/** + * Implements hook_civicrm_managed(). + * + * Generate a list of entities to create/deactivate/delete when this module + * is installed, disabled, uninstalled. + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed + */ +function trustcommerce_civicrm_managed(&$entities) { + _trustcommerce_civix_civicrm_managed($entities); +} - if($tc_params['payments'] == 1) { - $tc_params['payments'] = 0; - } - $reply = $this->_sendTCRequest($tc_params); - $result = $this->_getTCReply($reply); +/** + * Implements hook_civicrm_caseTypes(). + * + * Generate a list of case-types. + * + * Note: This hook only runs in CiviCRM 4.4+. + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes + */ +function trustcommerce_civicrm_caseTypes(&$caseTypes) { + _trustcommerce_civix_civicrm_caseTypes($caseTypes); +} - /* We are done, pass success */ - return TRUE; +/** + * Implements hook_civicrm_angularModules(). + * + * Generate a list of Angular modules. + * + * Note: This hook only runs in CiviCRM 4.5+. It may + * use features only available in v4.6+. + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_angularModules + */ +function trustcommerce_civicrm_angularModules(&$angularModules) { + _trustcommerce_civix_civicrm_angularModules($angularModules); +} - } +/** + * Implements hook_civicrm_alterSettingsFolders(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders + */ +function trustcommerce_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { + _trustcommerce_civix_civicrm_alterSettingsFolders($metaDataFolders); +} - /** - * Installs the trustcommerce module (currently a dummy) - */ - public function install() { - return TRUE; - } +// --- Functions below this ship commented out. Uncomment as required. --- - /** - * Uninstalls the trustcommerce module (currently a dummy) - */ - public function uninstall() { - return TRUE; - } +/** + * Implements hook_civicrm_preProcess(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_preProcess + * +function trustcommerce_civicrm_preProcess($formName, &$form) { -} +} // */ +/** + * Implements hook_civicrm_navigationMenu(). + * + * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_navigationMenu + * +function trustcommerce_civicrm_navigationMenu(&$menu) { + _trustcommerce_civix_insert_navigation_menu($menu, NULL, array( + 'label' => E::ts('The Page'), + 'name' => 'the_page', + 'url' => 'civicrm/the-page', + 'permission' => 'access CiviReport,access CiviContribute', + 'operator' => 'OR', + 'separator' => 0, + )); + _trustcommerce_civix_navigationMenu($menu); +} // */ -- 2.25.1