CRM/Core/Payment/TrustCommerce.php

   1 <?php
   2 /*
   3  * This file is part of CiviCRM.
   4  *
   5  * CiviCRM is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * CiviCRM is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with CiviCRM.  If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Copyright (C) 2012
  19  * Licensed to CiviCRM under the GPL v3 or higher
  20  *
  21  * Written and contributed by Ward Vandewege <ward@fsf.org> (http://www.fsf.org)
  22  * Modified by Lisa Marie Maginnis <lisa@fsf.org> (http://www.fsf.org)
  23  * Copyright © 2015 David Thompson <davet@gnu.org>
  24  *
  25  */
  26
  27 /**
  28   * CiviCRM payment processor module for TrustCommerece.
  29   *
  30   * This module uses the TrustCommerece API via the tc_link module (GPLv3)
  31   * distributed by TrustCommerece.com. For full documentation on the
  32   * TrustCommerece API, please see the TCDevGuide for more information:
  33   * https://vault.trustcommerce.com/downloads/TCDevGuide.htm
  34   *
  35   * This module supports the following features: Single credit/debit card
  36   * transactions, AVS checking, recurring (create, update, and cancel
  37   * subscription) optional blacklist with fail2ban,
  38   *
  39   * @copyright Ward Vandewege <ward@fsf.org> (http://www.fsf.org)
  40   * @copyright Lisa Marie Maginnis <lisa@fsf.org> (http://www.fsf.org)
  41   * @copyright David Thompson <davet@gnu.org>
  42   * @version   0.4
  43   * @package   org.fsf.payment.trustcommerce
  44   */
  45
  46 /**
  47  * Define logging level (0 = off, 4 = log everything)
  48  */
  49 define('TRUSTCOMMERCE_LOGGING_LEVEL', 4);
  50
  51 /**
  52  * Load the CiviCRM core payment class so we can extend it.
  53  */
  54 require_once 'CRM/Core/Payment.php';
  55
  56 /**
  57  * The payment processor object, it extends CRM_Core_Payment.
  58  */
  59 //class org_fsf_payment_trustcommerce extends CRM_Core_Payment {
  60 class CRM_Core_Payment_TrustCommerce extends CRM_Core_Payment {
  61
  62   /**#@+
  63    * Constants
  64    */
  65   /**
  66    * This is our default charset, currently unused.
  67    */
  68   CONST CHARSET = 'iso-8859-1';
  69   /**
  70    * The API response value for transaction approved.
  71    */
  72   CONST AUTH_APPROVED = 'approve';
  73   /**
  74    * The API response value for transaction declined.
  75    */
  76   CONST AUTH_DECLINED = 'decline';
  77   /**
  78    * The API response value for baddata passed to the TC API.
  79    */
  80   CONST AUTH_BADDATA = 'baddata';
  81   /**
  82    * The API response value for an error in the TC API call.
  83    */
  84   CONST AUTH_ERROR = 'error';
  85   /**
  86    * The API response value for blacklisted in our local blacklist
  87    */
  88   CONST AUTH_BLACKLIST = 'blacklisted';
  89   /**
  90    * The API response value for approved status per the TCDevGuide.
  91    */
  92   CONST AUTH_ACCEPTED = 'accepted';
  93
  94   /**
  95    * The current mode of the payment processor, valid values are: live, demo.
  96    * @static
  97    * @var string
  98    */
  99   protected $_mode = NULL;
 100   /**
 101    * The array of params cooked and passed to the TC API via tc_link().
 102    * @static
 103    * @var array
 104    */
 105   protected $_params = array();
 106
 107   /**
 108    * We only need one instance of this object. So we use the singleton
 109    * pattern and cache the instance in this variable
 110    * @static
 111    * @var object
 112    */
 113   static private $_singleton = NULL;
 114
 115   /**
 116    * Sets our basic TC API paramaters (username, password). Also sets up:
 117    * logging level, processor name, the mode (live/demo), and creates/copies
 118    * our singleton.
 119    *
 120    * @param string $mode the mode of operation: live or test
 121    * @param CRM_Core_Payment The payment processor object.
 122    *
 123    * @return void
 124    */
 125   function __construct($mode, &$paymentProcessor) {
 126     $this->_mode = $mode;
 127
 128     $this->_paymentProcessor = $paymentProcessor;
 129
 130     $this->_processorName = ts('TrustCommerce');
 131
 132     $config = CRM_Core_Config::singleton();
 133     $this->_setParam('user_name', $paymentProcessor['user_name']);
 134     $this->_setParam('password', $paymentProcessor['password']);
 135
 136     $this->_setParam('timestamp', time());
 137     srand(time());
 138     $this->_setParam('sequence', rand(1, 1000));
 139     $this->logging_level     = TRUSTCOMMERCE_LOGGING_LEVEL;
 140
 141   }
 142
 143   /**
 144    * The singleton function used to manage this object
 145    *
 146    * @param string $mode the mode of operation: live or test
 147    * @param CRM_Core_Payment The payment processor object.
 148    *
 149    * @return object
 150    * @static
 151    */
 152     static function &singleton($mode, &$paymentProcessor) {
 153     $processorName = $paymentProcessor['name'];
 154     if (self::$_singleton[$processorName] === NULL) {
 155       self::$_singleton[$processorName] = new CRM_Core_Payment_TrustCommerce($mode, $paymentProcessor);
 156     }
 157     return self::$_singleton[$processorName];
 158     }
 159
 160   /**
 161    * Submit a payment using the TC API
 162    *
 163    * @param  array $params The params we will be sending to tclink_send()
 164    * @return mixed An array of our results, or an error object if the transaction fails.
 165    * @public
 166    */
 167   function doDirectPayment(&$params) {
 168     if (!extension_loaded("tclink")) {
 169       return self::error(9001, 'TrustCommerce requires that the tclink module is loaded');
 170     }
 171
 172     /* Copy our paramaters to ourself */
 173     foreach ($params as $field => $value) {
 174       $this->_setParam($field, $value);
 175     }
 176
 177     /* Get our fields to pass to tclink_send() */
 178     $tc_params = $this->_getTrustCommerceFields();
 179
 180     /* Are we recurring? If so add the extra API fields. */
 181     if (CRM_Utils_Array::value('is_recur', $params) == 1) {
 182       $tc_params = $this->_getRecurPaymentFields($tc_params);
 183       $recur=1;
 184     }
 185
 186     /* Pass our cooked params to the alter hook, per Core/Payment/Dummy.php */
 187     CRM_Utils_Hook::alterPaymentProcessorParams($this, $params, $tc_params);
 188
 189     // TrustCommerce will not refuse duplicates, so we should check if the user already submitted this transaction
 190     if ($this->_checkDupe($tc_params['ticket'])) {
 191       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.');
 192     }
 193
 194     /* This implements a local blacklist, and passes us though as a normal failure
 195      * if the luser is on the blacklist. */
 196     if(!$this->_isBlacklisted($tc_params)) {
 197       /* Call the TC API, and grab the reply */
 198       $reply = $this->_sendTCRequest($tc_params);
 199     } else {
 200       $this->_logger($tc_params);
 201       $reply['status'] = self::AUTH_BLACKLIST;
 202       usleep(rand(1000000,10000000));
 203     }
 204
 205     /* Parse our reply */
 206     $result = $this->_getTCReply($reply);
 207
 208     if(!is_object($result)) {
 209       if($result == 0) {
 210         /* We were successful, congrats. Lets wrap it up:
 211          * Convert back to dollars
 212          * Save the transaction ID
 213          */
 214
 215         if (array_key_exists('billingid', $reply)) {
 216           $params['recurr_profile_id'] = $reply['billingid'];
 217           CRM_Core_DAO::setFieldValue(
 218                                       'CRM_Contribute_DAO_ContributionRecur',
 219                                       $this->_getParam('contributionRecurID'),
 220                                       'processor_id', $reply['billingid']
 221                                       );
 222         }
 223         $params['trxn_id'] = $reply['transid'];
 224
 225         $params['gross_amount'] = $tc_params['amount'] / 100;
 226
 227         return $params;
 228       }
 229     } else {
 230       /* Otherwise we return the error object */
 231       return $result;
 232     }
 233   }
 234
 235   /**
 236    * Hook to update CC info for a recurring contribution
 237    *
 238    * @param string $message The message to dispaly on update success/failure
 239    * @param array  $params  The paramters to pass to the payment processor
 240    *
 241    * @return bool True if successful, false on failure
 242    */
 243   function updateSubscriptionBillingInfo(&$message = '', $params = array()) {
 244     $expYear = $params['credit_card_exp_date']['Y'];
 245     $expMonth = $params['credit_card_exp_date']['M'];
 246
 247     // TODO: This should be our build in params set function, not by hand!
 248     $tc_params = array(
 249       'custid' => $this->_paymentProcessor['user_name'],
 250       'password' => $this->_paymentProcessor['password'],
 251       'action' => 'store',
 252       'billingid' => $params['subscriptionId'],
 253       'avs' => 'y', // Enable address verification
 254       'address1' => $params['street_address'],
 255       'zip' => $params['postal_code'],
 256       'name' => $this->_formatBillingName($params['first_name'],
 257                                           $params['last_name']),
 258       'cc' => $params['credit_card_number'],
 259       'cvv' => $params['cvv2'],
 260       'exp' => $this->_formatExpirationDate($expYear, $expMonth),
 261       'amount' => $this->_formatAmount($params['amount']),
 262     );
 263
 264     CRM_Utils_Hook::alterPaymentProcessorParams($this, $params, $tc_params);
 265
 266     $reply = $this->_sendTCRequest($tc_params);
 267     $result = $this->_getTCReply($reply);
 268
 269     if($result === 0) {
 270       // TODO: Respect vaules for $messages passed in from our caller
 271       $message = 'Successfully updated TC billing id ' . $tc_params['billingid'];
 272
 273       return TRUE;
 274     } else {
 275       return FALSE;
 276     }
 277   }
 278
 279   // TODO: Use the formatting functions throughout the entire class to
 280   // dedupe the conversions done elsewhere in a less reusable way.
 281
 282   /**
 283    * Internal routine to convert from CiviCRM amounts to TC amounts.
 284    *
 285    * Multiplies the amount by 100.
 286    *
 287    * @param float $amount The currency value to convert.
 288    *
 289    * @return int The TC amount
 290    */
 291   private function _formatAmount($amount) {
 292     return $amount * 100;
 293   }
 294
 295   /**
 296    * Internal routine to format the billing name for TC
 297    *
 298    * @param string $firstName The first name to submit to TC
 299    * @param string $lastName The last name to submit to TC
 300    *
 301    * @return string The TC name format, "$firstName $lastName"
 302    */
 303   private function _formatBillingName($firstName, $lastName) {
 304     return "$firstName $lastName";
 305   }
 306
 307   /**
 308    * Formats the expiration date for TC
 309    *
 310    * @param int $year  The credit card expiration year
 311    * @param int $month The credit card expiration year
 312    *
 313    * @return The TC CC expiration date format, "$month$year"
 314    */
 315   private function _formatExpirationDate($year, $month) {
 316     $exp_month = str_pad($month, 2, '0', STR_PAD_LEFT);
 317     $exp_year = substr($year, -2);
 318
 319     return "$exp_month$exp_year";
 320   }
 321
 322   private function _isParamsBlacklisted($tc_params) {
 323
 324     ///// debug help
 325     //
 326     //if ($_SERVER['REMOTE_ADDR'] === '74.94.156.211') {
 327     //  $test-tc-log = fopen("/tmp/test-tc-log", "a");
 328     //
 329     //  fwrite($test-tc-log, $_SERVER['REMOTE_ADDR']."\n");
 330     //  fwrite($test-tc-log, print_r($this->_params[contributionPageID], true)."\n");
 331     //  //fwrite($test-tc-log, print_r($tc_params, true)."\n");
 332     //  //fwrite($test-tc-log, print_r($this, true)."\n");
 333     //
 334     //  fclose("$test-tc-log");
 335     //}
 336
 337     $file=__DIR__ .'/ParamsBlacklist.php';
 338     if(file_exists($file)){
 339       require_once $file;
 340
 341       $result=externalParametersBlacklist($tc_params);
 342       if ($result[0] == TRUE){
 343         error_log("TrustCommerce: _isParamsBlacklisted() " . $result[1]);
 344         return TRUE;
 345       }
 346     }else
 347       error_log("TrustCommerce: missing ParamsBlacklist.php");
 348
 349     return FALSE;
 350   }
 351
 352   /**
 353    * Checks to see if the source IP/USERAGENT are blacklisted.
 354    *
 355    * @return bool TRUE if on the blacklist, FALSE if not.
 356    */
 357   private function _isBlacklisted($tc_params) {
 358     if($this->_isIPBlacklisted()) {
 359       return TRUE;
 360     } else if($this->_isAgentBlacklisted()) {
 361       return TRUE;
 362     } else if($this->_isParamsBlacklisted($tc_params)) {
 363       return TRUE;
 364     }
 365     return FALSE;
 366
 367   }
 368
 369   /**
 370    * Checks to see if the source USERAGENT is blacklisted
 371    *
 372    * @return bool TRUE if on the blacklist, FALSE if not.
 373    */
 374   private function _isAgentBlacklisted() {
 375     // TODO: fix DB calls to be more the CiviCRM way
 376     $ip = $_SERVER['REMOTE_ADDR'];
 377     $agent = $_SERVER['HTTP_USER_AGENT'];
 378     $dao = CRM_Core_DAO::executeQuery('SELECT * FROM `trustcommerce_useragent_blacklist`');
 379     while($dao->fetch()) {
 380       if(preg_match('/'.$dao->name.'/', $agent) === 1) {
 381         error_log(' [client '.$ip.'] [agent '.$agent.'] - Blacklisted by USER_AGENT rule #'.$dao->id);
 382         return TRUE;
 383       }
 384     }
 385     return FALSE;
 386   }
 387
 388   /**
 389    * Checks to see if the source IP is blacklisted
 390    *
 391    * @return bool TRUE if on the blacklist, FALSE if not.
 392    */
 393   private function _isIPBlacklisted() {
 394     // TODO: fix DB calls to be more the CiviCRM way
 395     $ip = $_SERVER['REMOTE_ADDR'];
 396     $agent = $_SERVER['HTTP_USER_AGENT'];
 397     $blacklist = array();
 398     $dao = CRM_Core_DAO::executeQuery('SELECT * FROM `trustcommerce_blacklist`');
 399     while($dao->fetch()) {
 400       if($ip == $dao->ip) {
 401         error_log('[client '.$ip.'] [agent '.$agent.'] Blacklisted by IP rule #'.$dao->id);
 402         return TRUE;
 403       }
 404     }
 405     return FALSE;
 406   }
 407
 408   /**
 409    * Sends the API call to TC for processing
 410    *
 411    * @param array $request The array of paramaters to pass the TC API
 412    *
 413    * @return array The response from the TC API
 414    */
 415   function _sendTCRequest($request) {
 416     $this->_logger($request);
 417     return tclink_send($request);
 418   }
 419
 420   /**
 421    * Logs paramaters from TC along with the remote address of the client
 422    *
 423    * Will log paramaters via the error_log() routine. For security reasons
 424    * the following values are not logged (skipped): custid, password, cc
 425    * exp, and cvv.
 426    *
 427    * @param array $params The paramaters to log
 428    */
 429   function _logger($params) {
 430     $msg = '';
 431     foreach ($params as $key => $data) {
 432       /* Delete any data we should not be writing to disk. This includes:
 433        * custid, password, cc, exp, and cvv
 434        */
 435       switch($key) {
 436       case 'custid':
 437       case 'password':
 438       case 'cc':
 439       case 'exp':
 440       case 'cvv':
 441         break;
 442       default:
 443         $msg .= ' '.$key.' => '.$data;
 444       }
 445     }
 446     error_log('[client '.$_SERVER['REMOTE_ADDR'].'] TrustCommerce:'.$msg);
 447   }
 448
 449   /**
 450    * Gets the recurring billing fields for the TC API
 451    *
 452    * @param  array $fields The fields to modify.
 453    * @return array The fields for tclink_send(), modified for recurring billing.
 454    * @public
 455    */
 456   function _getRecurPaymentFields($fields) {
 457     $payments = $this->_getParam('frequency_interval');
 458     $cycle = $this->_getParam('frequency_unit');
 459
 460     /* Translate billing cycle from CiviCRM -> TC */
 461     switch($cycle) {
 462     case 'day':
 463       $cycle = 'd';
 464       break;
 465     case 'week':
 466       $cycle = 'w';
 467       break;
 468     case 'month':
 469       $cycle = 'm';
 470       break;
 471     case 'year':
 472       $cycle = 'y';
 473       break;
 474     }
 475
 476     /* Translate frequency interval from CiviCRM -> TC
 477      * Payments are the same, HOWEVER a payment of 1 (forever) should be 0 in TC */
 478     if($payments == 1) {
 479       $payments = 0;
 480     }
 481
 482     $fields['cycle'] = '1'.$cycle;   /* The billing cycle in years, months, weeks, or days. */
 483     $fields['payments'] = $payments;
 484     $fields['action'] = 'store';      /* Change our mode to `store' mode. */
 485
 486     return $fields;
 487   }
 488
 489   /** Parses a response from TC via the tclink_send() command.
 490    *
 491    * @param array $reply The result of a call to tclink_send().
 492    *
 493    * @return mixed|CRM_Core_Error CRM_Core_Error object if transaction failed, otherwise
 494    * returns 0.
 495    */
 496   function _getTCReply($reply) {
 497
 498     /* DUPLIATE CODE, please refactor. ~lisa */
 499     if (!$reply) {
 500       return self::error(9002, 'Could not initiate connection to payment gateway.');
 501     }
 502
 503     $this->_logger($reply);
 504
 505     switch($reply['status']) {
 506     case self::AUTH_BLACKLIST:
 507       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.  ");
 508       break;
 509     case self::AUTH_APPROVED:
 510       break;
 511     case self::AUTH_ACCEPTED:
 512       // It's all good
 513       break;
 514     case self::AUTH_DECLINED:
 515       // TODO FIXME be more or less specific?
 516       // declinetype can be: decline, avs, cvv, call, expiredcard, carderror, authexpired, fraud, blacklist, velocity
 517       // See TC documentation for more info
 518       switch($reply['declinetype']) {
 519       case 'avs':
 520         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.");
 521         break;
 522       }
 523       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.");
 524       break;
 525     case self::AUTH_BADDATA:
 526       // TODO FIXME do something with $reply['error'] and $reply['offender']
 527       return self::error(9011, "Invalid credit card information. The following fields were invalid: {$reply['offenders']}.");
 528       break;
 529     case self::AUTH_ERROR:
 530       return self::error(9002, 'Could not initiate connection to payment gateway');
 531       break;
 532     }
 533     return 0;
 534   }
 535
 536   /**
 537    * Generate the basic paramaters to send the TC API
 538    *
 539    * @return array The array of paramaters to pass _sendTCRequest()
 540    */
 541   function _getTrustCommerceFields() {
 542     // Total amount is from the form contribution field
 543     $amount = $this->_getParam('total_amount');
 544     // CRM-9894 would this ever be the case??
 545     if (empty($amount)) {
 546       $amount = $this->_getParam('amount');
 547     }
 548     $fields = array();
 549
 550     $fields['custid'] = $this->_paymentProcessor['user_name'];
 551     $fields['password'] = $this->_paymentProcessor['password'];
 552
 553     $fields['action'] = 'sale';
 554
 555     // Enable address verification
 556     $fields['avs'] = 'y';
 557
 558     $fields['address1'] = $this->_getParam('street_address');
 559     $fields['zip'] = $this->_getParam('postal_code');
 560     $fields['country'] = $this->_getParam('country');
 561
 562     /**
 563      * Fix AVS problem when a non-US country, has address1 and zip both starting
 564      * with a letter.
 565      */
 566     if( ($fields['country'] !== '840' && $fields['country'] !== 840)
 567      && (preg_match("/^\D/", $fields['zip']) === 1)
 568      && (preg_match("/^\D/", $fields['address1']) === 1) ) {
 569       // Add a number to the beginning of the address.
 570       $fields['address1'] = preg_replace("/^/", "1 ", $fields['address1']);
 571     }
 572
 573     $fields['name'] = $this->_getParam('billing_first_name') . ' ' . $this->_getParam('billing_last_name');
 574
 575     // This assumes currencies where the . is used as the decimal point, like USD
 576     $amount = preg_replace("/([^0-9\\.])/i", "", $amount);
 577
 578     // We need to pass the amount to TrustCommerce in dollar cents
 579     $fields['amount'] = $amount * 100;
 580
 581     // Unique identifier
 582     $fields['ticket'] = substr($this->_getParam('invoiceID'), 0, 20);
 583
 584     // cc info
 585     $fields['cc'] = $this->_getParam('credit_card_number');
 586     $fields['cvv'] = $this->_getParam('cvv2');
 587     $exp_month = str_pad($this->_getParam('month'), 2, '0', STR_PAD_LEFT);
 588     $exp_year = substr($this->_getParam('year'),-2);
 589     $fields['exp'] = "$exp_month$exp_year";
 590
 591     if ($this->_mode != 'live') {
 592       $fields['demo'] = 'y';
 593     }
 594     return $fields;
 595   }
 596
 597   /**
 598    * Checks to see if invoice_id already exists in db
 599    *
 600    * @param  int     $invoiceId   The ID to check
 601    *
 602    * @return bool                 True if ID exists, else false
 603    */
 604   function _checkDupe($invoiceId) {
 605     require_once 'CRM/Contribute/DAO/Contribution.php';
 606     $contribution = new CRM_Contribute_DAO_Contribution();
 607     $contribution->invoice_id = $invoiceId;
 608     return $contribution->find();
 609   }
 610
 611   /**
 612    * Get the value of a field if set
 613    *
 614    * @param string $field the field
 615    *
 616    * @return mixed value of the field, or empty string if the field is
 617    * not set
 618    */
 619   function _getParam($field) {
 620     $value = CRM_Utils_Array::value($field, $this->_params, '');
 621     if ($xmlSafe) {
 622       $value = str_replace(array('&', '"', "'", '<', '>'), '', $value);
 623     }
 624     return $value;
 625   }
 626
 627   /**
 628    * Sets our error message/logging information for CiviCRM
 629    *
 630    * @param int $errorCode The numerical code of the error, defaults to 9001
 631    * @param string $errorMessage The error message to display/log
 632    *
 633    * @return CRM_Core_Error The error object with message and code.
 634    */
 635   function &error($errorCode = NULL, $errorMessage = NULL) {
 636     $e = CRM_Core_Error::singleton();
 637     if ($errorCode) {
 638       $e->push($errorCode, 0, NULL, $errorMessage);
 639     }
 640     else {
 641       $e->push(9001, 0, NULL, 'Unknown System Error.');
 642     }
 643     return $e;
 644   }
 645
 646   /**
 647    * Set a field to the specified value.  Value must be a scalar (int,
 648    * float, string, or boolean)
 649    *
 650    * @param string $field
 651    * @param mixed $value
 652    *
 653    * @return bool false if value is not a scalar, true if successful
 654    */
 655   function _setParam($field, $value) {
 656     if (!is_scalar($value)) {
 657       return FALSE;
 658     }
 659     else {
 660       $this->_params[$field] = $value;
 661     }
 662   }
 663
 664   /**
 665    * Checks to see if we have the manditory config values set.
 666    *
 667    * @return string the error message if any
 668    * @public
 669    */
 670   function checkConfig() {
 671     $error = array();
 672     if (empty($this->_paymentProcessor['user_name'])) {
 673       $error[] = ts('Customer ID is not set for this payment processor');
 674     }
 675
 676     if (empty($this->_paymentProcessor['password'])) {
 677       $error[] = ts('Password is not set for this payment processor');
 678     }
 679
 680     if (!empty($error)) {
 681       return implode('<p>', $error);
 682     } else {
 683       return NULL;
 684     }
 685   }
 686
 687   /**
 688    * Hook to cancel a recurring contribution
 689    *
 690    * @param string $message The message to dispaly on update success/failure
 691    * @param array  $params  The paramters to pass to the payment processor
 692    *
 693    * @return bool True if successful, false on failure
 694    */
 695   function cancelSubscription(&$message = '', $params = array()) {
 696     $tc_params['custid'] = $this->_getParam('user_name');
 697     $tc_params['password'] = $this->_getParam('password');
 698     $tc_params['action'] = 'unstore';
 699     $tc_params['billingid'] = CRM_Utils_Array::value('subscriptionId', $params);
 700
 701     $result = $this->_sendTCRequest($tc_params);
 702
 703     /* Test if call failed */
 704     if(!$result) {
 705       return self::error(9002, 'Could not initiate connection to payment gateway');
 706     }
 707     /* We are done, pass success */
 708     return TRUE;
 709   }
 710
 711   /**
 712    * Hook to update amount billed for a recurring contribution
 713    *
 714    * @param string $message The message to dispaly on update success/failure
 715    * @param array  $params  The paramters to pass to the payment processor
 716    *
 717    * @return bool True if successful, false on failure
 718    */
 719   function changeSubscriptionAmount(&$message = '', $params = array()) {
 720     $tc_params['custid'] = $this->_paymentProcessor['user_name'];
 721     $tc_params['password'] = $this->_paymentProcessor['password'];
 722     $tc_params['action'] = 'store';
 723
 724     $tc_params['billingid'] = CRM_Utils_Array::value('subscriptionId', $params);
 725     $tc_params['payments'] = CRM_Utils_Array::value('installments', $params);
 726     $tc_params['amount'] = CRM_Utils_Array::value('amount', $params) * 100;
 727
 728     if($tc_params['payments'] == 1) {
 729       $tc_params['payments'] = 0;
 730     }
 731     $reply = $this->_sendTCRequest($tc_params);
 732     $result = $this->_getTCReply($reply);
 733
 734     /* We are done, pass success */
 735     return TRUE;
 736
 737     }
 738
 739   /**
 740    * Installs the trustcommerce module (currently a dummy)
 741    */
 742   public function install() {
 743     return TRUE;
 744   }
 745
 746   /**
 747    * Uninstalls the trustcommerce module (currently a dummy)
 748    */
 749   public function uninstall() {
 750     return TRUE;
 751   }
 752
 753 }
 754