CRM/Core/Payment/PayPalProIPN.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2018
  32  */
  33 class CRM_Core_Payment_PayPalProIPN extends CRM_Core_Payment_BaseIPN {
  34
  35   static $_paymentProcessor = NULL;
  36
  37   /**
  38    * Input parameters from payment processor. Store these so that
  39    * the code does not need to keep retrieving from the http request
  40    * @var array
  41    */
  42   protected $_inputParameters = array();
  43
  44   /**
  45    * Store for the variables from the invoice string.
  46    * @var array
  47    */
  48   protected $_invoiceData = array();
  49
  50   /**
  51    * Is this a payment express transaction.
  52    */
  53   protected $_isPaymentExpress = FALSE;
  54
  55   /**
  56    * Are we dealing with an event an 'anything else' (contribute)
  57    * @var string component
  58    */
  59   protected $_component = 'contribute';
  60
  61   /**
  62    * Constructor function.
  63    *
  64    * @param array $inputData
  65    *   Contents of HTTP REQUEST.
  66    *
  67    * @throws CRM_Core_Exception
  68    */
  69   public function __construct($inputData) {
  70     $this->setInputParameters($inputData);
  71     $this->setInvoiceData();
  72     parent::__construct();
  73   }
  74
  75   /**
  76    * get the values from the rp_invoice_id string.
  77    *
  78    * @param string $name
  79    *   E.g. i, values are stored in the string with letter codes.
  80    * @param bool $abort
  81    *   Throw exception if not found
  82    *
  83    * @throws CRM_Core_Exception
  84    * @return mixed
  85    */
  86   public function getValue($name, $abort = TRUE) {
  87     if ($abort && empty($this->_invoiceData[$name])) {
  88       throw new CRM_Core_Exception("Failure: Missing Parameter $name");
  89     }
  90     else {
  91       return CRM_Utils_Array::value($name, $this->_invoiceData);
  92     }
  93   }
  94
  95   /**
  96    * Set $this->_invoiceData from the input array
  97    */
  98   public function setInvoiceData() {
  99     if (empty($this->_inputParameters['rp_invoice_id'])) {
 100       $this->_isPaymentExpress = TRUE;
 101       return;
 102     }
 103     $rpInvoiceArray = explode('&', $this->_inputParameters['rp_invoice_id']);
 104     // for clarify let's also store without the single letter unreadable
 105     //@todo after more refactoring we might ditch storing the one letter stuff
 106     $mapping = array(
 107       'i' => 'invoice_id',
 108       'm' => 'component',
 109       'c' => 'contact_id',
 110       'b' => 'contribution_id',
 111       'r' => 'contribution_recur_id',
 112       'p' => 'participant_id',
 113       'e' => 'event_id',
 114     );
 115     foreach ($rpInvoiceArray as $rpInvoiceValue) {
 116       $rpValueArray = explode('=', $rpInvoiceValue);
 117       $this->_invoiceData[$rpValueArray[0]] = $rpValueArray[1];
 118       $this->_inputParameters[$mapping[$rpValueArray[0]]] = $rpValueArray[1];
 119       // p has been overloaded & could mean contribution page or participant id. Clearly we need an
 120       // alphabet with more letters.
 121       // the mode will always be resolved before the mystery p is reached
 122       if ($rpValueArray[1] == 'contribute') {
 123         $mapping['p'] = 'contribution_page_id';
 124       }
 125     }
 126     if (empty($this->_inputParameters['component'])) {
 127       $this->_isPaymentExpress = TRUE;
 128     }
 129   }
 130
 131   /**
 132    * @param string $name
 133    *   Of variable to return.
 134    * @param string $type
 135    *   Data type.
 136    *   - String
 137    *   - Integer
 138    * @param string $location
 139    *   Deprecated.
 140    * @param bool $abort
 141    *   Abort if empty.
 142    *
 143    * @throws CRM_Core_Exception
 144    * @return mixed
 145    */
 146   public function retrieve($name, $type, $location = 'POST', $abort = TRUE) {
 147     $value = CRM_Utils_Type::validate(
 148       CRM_Utils_Array::value($name, $this->_inputParameters),
 149       $type,
 150       FALSE
 151     );
 152     if ($abort && $value === NULL) {
 153       throw new CRM_Core_Exception("Could not find an entry for $name in $location");
 154     }
 155     return $value;
 156   }
 157
 158   /**
 159    * Process recurring contributions.
 160    * @param array $input
 161    * @param array $ids
 162    * @param array $objects
 163    * @param bool $first
 164    * @return bool
 165    */
 166   public function recur(&$input, &$ids, &$objects, $first) {
 167     if (!isset($input['txnType'])) {
 168       CRM_Core_Error::debug_log_message("Could not find txn_type in input request");
 169       echo "Failure: Invalid parameters<p>";
 170       return FALSE;
 171     }
 172
 173     $recur = &$objects['contributionRecur'];
 174
 175     // make sure the invoice ids match
 176     // make sure the invoice is valid and matches what we have in
 177     // the contribution record
 178     if ($recur->invoice_id != $input['invoice']) {
 179       CRM_Core_Error::debug_log_message("Invoice values dont match between database and IPN request recur is " . $recur->invoice_id . " input is " . $input['invoice']);
 180       echo "Failure: Invoice values dont match between database and IPN request recur is " . $recur->invoice_id . " input is " . $input['invoice'];
 181       return FALSE;
 182     }
 183
 184     $now = date('YmdHis');
 185
 186     // fix dates that already exist
 187     $dates = array('create', 'start', 'end', 'cancel', 'modified');
 188     foreach ($dates as $date) {
 189       $name = "{$date}_date";
 190       if ($recur->$name) {
 191         $recur->$name = CRM_Utils_Date::isoToMysql($recur->$name);
 192       }
 193     }
 194
 195     $sendNotification = FALSE;
 196     $subscriptionPaymentStatus = NULL;
 197     //List of Transaction Type
 198     /*
 199     recurring_payment_profile_created          RP Profile Created
 200     recurring_payment           RP Successful Payment
 201     recurring_payment_failed                               RP Failed Payment
 202     recurring_payment_profile_cancel           RP Profile Cancelled
 203     recurring_payment_expired         RP Profile Expired
 204     recurring_payment_skipped        RP Profile Skipped
 205     recurring_payment_outstanding_payment      RP Successful Outstanding Payment
 206     recurring_payment_outstanding_payment_failed          RP Failed Outstanding Payment
 207     recurring_payment_suspended        RP Profile Suspended
 208     recurring_payment_suspended_due_to_max_failed_payment  RP Profile Suspended due to Max Failed Payment
 209      */
 210
 211     //set transaction type
 212     $txnType = $this->retrieve('txn_type', 'String');
 213     //Changes for paypal pro recurring payment
 214     $contributionStatuses = civicrm_api3('contribution', 'getoptions', array('field' => 'contribution_status_id'));
 215     $contributionStatuses = $contributionStatuses['values'];
 216     switch ($txnType) {
 217       case 'recurring_payment_profile_created':
 218         if (in_array($recur->contribution_status_id, array(
 219               array_search('Pending', $contributionStatuses),
 220               array_search('In Progress', $contributionStatuses),
 221             ))
 222           && !empty($recur->processor_id)
 223         ) {
 224           echo "already handled";
 225           return FALSE;
 226         }
 227         $recur->create_date = $now;
 228         $recur->contribution_status_id = 2;
 229         $recur->processor_id = $this->retrieve('recurring_payment_id', 'String');
 230         $recur->trxn_id = $recur->processor_id;
 231         $subscriptionPaymentStatus = CRM_Core_Payment::RECURRING_PAYMENT_START;
 232         $sendNotification = TRUE;
 233         break;
 234
 235       case 'recurring_payment':
 236         if ($first) {
 237           $recur->start_date = $now;
 238         }
 239         else {
 240           $input['invoice_id'] = md5(uniqid(rand(), TRUE));
 241           $input['original_contribution_id'] = $ids['contribution'];
 242           $input['contribution_recur_id'] = $ids['contributionRecur'];
 243
 244           if ($input['paymentStatus'] != 'Completed') {
 245             throw new CRM_Core_Exception("Ignore all IPN payments that are not completed");
 246           }
 247           // In future moving to create pending & then complete, but this OK for now.
 248           // Also consider accepting 'Failed' like other processors.
 249           $input['contribution_status_id'] = 1;
 250
 251           civicrm_api3('Contribution', 'repeattransaction', $input);
 252           return;
 253         }
 254
 255         //contribution installment is completed
 256         if ($this->retrieve('profile_status', 'String') == 'Expired') {
 257           if (!empty($recur->end_date)) {
 258             echo "already handled";
 259             return FALSE;
 260           }
 261           $recur->contribution_status_id = 1;
 262           $recur->end_date = $now;
 263           $sendNotification = TRUE;
 264           $subscriptionPaymentStatus = CRM_Core_Payment::RECURRING_PAYMENT_END;
 265         }
 266
 267         // make sure the contribution status is not done
 268         // since order of ipn's is unknown
 269         if ($recur->contribution_status_id != 1) {
 270           $recur->contribution_status_id = 5;
 271         }
 272         break;
 273     }
 274
 275     $recur->save();
 276
 277     if ($sendNotification) {
 278       $autoRenewMembership = FALSE;
 279       if ($recur->id &&
 280         isset($ids['membership']) && $ids['membership']
 281       ) {
 282         $autoRenewMembership = TRUE;
 283       }
 284       //send recurring Notification email for user
 285       CRM_Contribute_BAO_ContributionPage::recurringNotify($subscriptionPaymentStatus,
 286         $ids['contact'],
 287         $ids['contributionPage'],
 288         $recur,
 289         $autoRenewMembership
 290       );
 291     }
 292
 293     if ($txnType != 'recurring_payment') {
 294       return TRUE;
 295     }
 296
 297     if (!$first) {
 298       //check if this contribution transaction is already processed
 299       //if not create a contribution and then get it processed
 300       $contribution = new CRM_Contribute_BAO_Contribution();
 301       $contribution->trxn_id = $input['trxn_id'];
 302       if ($contribution->trxn_id && $contribution->find()) {
 303         CRM_Core_Error::debug_log_message("returning since contribution has already been handled");
 304         echo "Success: Contribution has already been handled<p>";
 305         return TRUE;
 306       }
 307
 308       $contribution->contact_id = $recur->contact_id;
 309       $contribution->financial_type_id = $objects['contributionType']->id;
 310       $contribution->contribution_page_id = $ids['contributionPage'];
 311       $contribution->contribution_recur_id = $ids['contributionRecur'];
 312       $contribution->currency = $objects['contribution']->currency;
 313       $contribution->payment_instrument_id = $objects['contribution']->payment_instrument_id;
 314       $contribution->amount_level = $objects['contribution']->amount_level;
 315       $contribution->campaign_id = $objects['contribution']->campaign_id;
 316       $objects['contribution'] = &$contribution;
 317       $contribution->invoice_id = md5(uniqid(rand(), TRUE));
 318     }
 319     // CRM-13737 - am not aware of any reason why payment_date would not be set - this if is a belt & braces
 320     $objects['contribution']->receive_date = !empty($input['payment_date']) ? date('YmdHis', strtotime($input['payment_date'])) : $now;
 321
 322     $this->single($input, $ids, $objects,
 323       TRUE, $first
 324     );
 325   }
 326
 327   /**
 328    * @param $input
 329    * @param $ids
 330    * @param $objects
 331    * @param bool $recur
 332    * @param bool $first
 333    *
 334    * @return bool
 335    */
 336   public function single(&$input, &$ids, &$objects, $recur = FALSE, $first = FALSE) {
 337     $contribution = &$objects['contribution'];
 338
 339     // make sure the invoice is valid and matches what we have in the contribution record
 340     if ((!$recur) || ($recur && $first)) {
 341       if ($contribution->invoice_id != $input['invoice']) {
 342         CRM_Core_Error::debug_log_message("Invoice values dont match between database and IPN request");
 343         echo "Failure: Invoice values dont match between database and IPN request<p>contribution is" . $contribution->invoice_id . " and input is " . $input['invoice'];
 344         return FALSE;
 345       }
 346     }
 347     else {
 348       $contribution->invoice_id = md5(uniqid(rand(), TRUE));
 349     }
 350
 351     if (!$recur) {
 352       if ($contribution->total_amount != $input['amount']) {
 353         CRM_Core_Error::debug_log_message("Amount values dont match between database and IPN request");
 354         echo "Failure: Amount values dont match between database and IPN request<p>";
 355         return FALSE;
 356       }
 357     }
 358     else {
 359       $contribution->total_amount = $input['amount'];
 360     }
 361
 362     $transaction = new CRM_Core_Transaction();
 363
 364     $status = $input['paymentStatus'];
 365     if ($status == 'Denied' || $status == 'Failed' || $status == 'Voided') {
 366       return $this->failed($objects, $transaction);
 367     }
 368     elseif ($status == 'Pending') {
 369       return $this->pending($objects, $transaction);
 370     }
 371     elseif ($status == 'Refunded' || $status == 'Reversed') {
 372       return $this->cancelled($objects, $transaction);
 373     }
 374     elseif ($status != 'Completed') {
 375       return $this->unhandled($objects, $transaction);
 376     }
 377
 378     // check if contribution is already completed, if so we ignore this ipn
 379     if ($contribution->contribution_status_id == 1) {
 380       $transaction->commit();
 381       CRM_Core_Error::debug_log_message("returning since contribution has already been handled");
 382       echo "Success: Contribution has already been handled<p>";
 383       return TRUE;
 384     }
 385
 386     $this->completeTransaction($input, $ids, $objects, $transaction, $recur);
 387   }
 388
 389   /**
 390    * Gets PaymentProcessorID for PayPal
 391    *
 392    * @return int
 393    */
 394   public function getPayPalPaymentProcessorID() {
 395     // This is an unreliable method as there could be more than one instance.
 396     // Recommended approach is to use the civicrm/payment/ipn/xx url where xx is the payment
 397     // processor id & the handleNotification function (which should call the completetransaction api & by-pass this
 398     // entirely). The only thing the IPN class should really do is extract data from the request, validate it
 399     // & call completetransaction or call fail? (which may not exist yet).
 400     $paymentProcessorTypeID = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType',
 401       'PayPal', 'id', 'name'
 402     );
 403     return (int) civicrm_api3('PaymentProcessor', 'getvalue', array(
 404       'is_test' => 0,
 405       'options' => array('limit' => 1),
 406       'payment_processor_type_id' => $paymentProcessorTypeID,
 407       'return' => 'id',
 408     ));
 409
 410   }
 411
 412   /**
 413    * This is the main function to call. It should be sufficient to instantiate the class
 414    * (with the input parameters) & call this & all will be done
 415    *
 416    * @todo the references to POST throughout this class need to be removed
 417    * @return bool
 418    */
 419   public function main() {
 420     CRM_Core_Error::debug_var('GET', $_GET, TRUE, TRUE);
 421     CRM_Core_Error::debug_var('POST', $_POST, TRUE, TRUE);
 422     if ($this->_isPaymentExpress) {
 423       $this->handlePaymentExpress();
 424       return FALSE;
 425     }
 426     $objects = $ids = $input = array();
 427     $this->_component = $input['component'] = self::getValue('m');
 428     $input['invoice'] = self::getValue('i', TRUE);
 429     // get the contribution and contact ids from the GET params
 430     $ids['contact'] = self::getValue('c', TRUE);
 431     $ids['contribution'] = self::getValue('b', TRUE);
 432
 433     $this->getInput($input, $ids);
 434
 435     if ($this->_component == 'event') {
 436       $ids['event'] = self::getValue('e', TRUE);
 437       $ids['participant'] = self::getValue('p', TRUE);
 438       $ids['contributionRecur'] = self::getValue('r', FALSE);
 439     }
 440     else {
 441       // get the optional ids
 442       //@ how can this not be broken retrieving from GET as we are dealing with a POST request?
 443       // copy & paste? Note the retrieve function now uses data from _REQUEST so this will be included
 444       $ids['membership'] = self::retrieve('membershipID', 'Integer', 'GET', FALSE);
 445       $ids['contributionRecur'] = self::getValue('r', FALSE);
 446       $ids['contributionPage'] = self::getValue('p', FALSE);
 447       $ids['related_contact'] = self::retrieve('relatedContactID', 'Integer', 'GET', FALSE);
 448       $ids['onbehalf_dupe_alert'] = self::retrieve('onBehalfDupeAlert', 'Integer', 'GET', FALSE);
 449     }
 450
 451     if (!$ids['membership'] && $ids['contributionRecur']) {
 452       $sql = "
 453     SELECT m.id
 454       FROM civicrm_membership m
 455 INNER JOIN civicrm_membership_payment mp ON m.id = mp.membership_id AND mp.contribution_id = %1
 456      WHERE m.contribution_recur_id = %2
 457      LIMIT 1";
 458       $sqlParams = array(
 459         1 => array($ids['contribution'], 'Integer'),
 460         2 => array($ids['contributionRecur'], 'Integer'),
 461       );
 462       if ($membershipId = CRM_Core_DAO::singleValueQuery($sql, $sqlParams)) {
 463         $ids['membership'] = $membershipId;
 464       }
 465     }
 466
 467     // This is an unreliable method as there could be more than one instance.
 468     // Recommended approach is to use the civicrm/payment/ipn/xx url where xx is the payment
 469     // processor id & the handleNotification function (which should call the completetransaction api & by-pass this
 470     // entirely). The only thing the IPN class should really do is extract data from the request, validate it
 471     // & call completetransaction or call fail? (which may not exist yet).
 472
 473     $paymentProcessorID = self::getPayPalPaymentProcessorID();
 474
 475     if (!$this->validateData($input, $ids, $objects, TRUE, $paymentProcessorID)) {
 476       return FALSE;
 477     }
 478
 479     self::$_paymentProcessor = &$objects['paymentProcessor'];
 480     //?? how on earth would we not have component be one of these?
 481     // they are the only valid settings & this IPN file can't even be called without one of them
 482     // grepping for this class doesn't find other paths to call this class
 483     if ($this->_component == 'contribute' || $this->_component == 'event') {
 484       if ($ids['contributionRecur']) {
 485         // check if first contribution is completed, else complete first contribution
 486         $first = TRUE;
 487         if ($objects['contribution']->contribution_status_id == 1) {
 488           $first = FALSE;
 489         }
 490         return $this->recur($input, $ids, $objects, $first);
 491       }
 492       else {
 493         return $this->single($input, $ids, $objects, FALSE, FALSE);
 494       }
 495     }
 496     else {
 497       return $this->single($input, $ids, $objects, FALSE, FALSE);
 498     }
 499   }
 500
 501   /**
 502    * @param $input
 503    * @param $ids
 504    *
 505    * @return bool
 506    * @throws CRM_Core_Exception
 507    */
 508   public function getInput(&$input, &$ids) {
 509
 510     if (!$this->getBillingID($ids)) {
 511       return FALSE;
 512     }
 513
 514     $input['txnType'] = self::retrieve('txn_type', 'String', 'POST', FALSE);
 515     $input['paymentStatus'] = self::retrieve('payment_status', 'String', 'POST', FALSE);
 516
 517     $input['amount'] = self::retrieve('mc_gross', 'Money', 'POST', FALSE);
 518     $input['reasonCode'] = self::retrieve('ReasonCode', 'String', 'POST', FALSE);
 519
 520     $billingID = $ids['billing'];
 521     $lookup = array(
 522       "first_name" => 'first_name',
 523       "last_name" => 'last_name',
 524       "street_address-{$billingID}" => 'address_street',
 525       "city-{$billingID}" => 'address_city',
 526       "state-{$billingID}" => 'address_state',
 527       "postal_code-{$billingID}" => 'address_zip',
 528       "country-{$billingID}" => 'address_country_code',
 529     );
 530     foreach ($lookup as $name => $paypalName) {
 531       $value = self::retrieve($paypalName, 'String', 'POST', FALSE);
 532       $input[$name] = $value ? $value : NULL;
 533     }
 534
 535     $input['is_test'] = self::retrieve('test_ipn', 'Integer', 'POST', FALSE);
 536     $input['fee_amount'] = self::retrieve('mc_fee', 'Money', 'POST', FALSE);
 537     $input['net_amount'] = self::retrieve('settle_amount', 'Money', 'POST', FALSE);
 538     $input['trxn_id'] = self::retrieve('txn_id', 'String', 'POST', FALSE);
 539     $input['payment_date'] = $input['receive_date'] = self::retrieve('payment_date', 'String', 'POST', FALSE);
 540     $input['total_amount'] = $input['amount'];
 541   }
 542
 543   /**
 544    * Handle payment express IPNs.
 545    *
 546    * For one off IPNS no actual response is required
 547    * Recurring is more difficult as we have limited confirmation material
 548    * lets look up invoice id in recur_contribution & rely on the unique transaction id to ensure no
 549    * duplicated
 550    * this may not be acceptable to all sites - e.g. if they are shipping or delivering something in return
 551    * then the quasi security of the ids array might be required - although better to
 552    * http://stackoverflow.com/questions/4848227/validate-that-ipn-call-is-from-paypal
 553    * but let's assume knowledge on invoice id & schedule is enough for now esp for donations
 554    * only contribute is handled
 555    */
 556   public function handlePaymentExpress() {
 557     //@todo - loads of copy & paste / code duplication but as this not going into core need to try to
 558     // keep discreet
 559     // also note that a lot of the complexity above could be removed if we used
 560     // http://stackoverflow.com/questions/4848227/validate-that-ipn-call-is-from-paypal
 561     // as membership id etc can be derived by the load objects fn
 562     $objects = $ids = $input = array();
 563     $isFirst = FALSE;
 564     $input['invoice'] = self::getValue('i', FALSE);
 565     $input['txnType'] = $this->retrieve('txn_type', 'String');
 566     $contributionRecur = civicrm_api3('contribution_recur', 'getsingle', array(
 567       'return' => 'contact_id, id, payment_processor_id',
 568       'invoice_id' => $input['invoice'],
 569     ));
 570
 571     if ($input['txnType'] !== 'recurring_payment' && $input['txnType'] !== 'recurring_payment_profile_created') {
 572       throw new CRM_Core_Exception('Paypal IPNS not handled other than recurring_payments');
 573     }
 574
 575     $this->getInput($input, $ids);
 576     if ($input['txnType'] === 'recurring_payment' && $this->transactionExists($input['trxn_id'])) {
 577       throw new CRM_Core_Exception('This transaction has already been processed');
 578     }
 579
 580     $ids['contact'] = $contributionRecur['contact_id'];
 581     $ids['contributionRecur'] = $contributionRecur['id'];
 582     $result = civicrm_api3('contribution', 'getsingle', ['invoice_id' => $input['invoice'], 'contribution_test' => '']);
 583
 584     $ids['contribution'] = $result['id'];
 585     //@todo hard - coding 'pending' for now
 586     if ($result['contribution_status_id'] == 2) {
 587       $isFirst = TRUE;
 588     }
 589     // arg api won't get this - fix it
 590     $ids['contributionPage'] = CRM_Core_DAO::singleValueQuery("SELECT contribution_page_id FROM civicrm_contribution WHERE invoice_id = %1", array(
 591         1 => array(
 592           $ids['contribution'],
 593           'Integer',
 594         ),
 595       ));
 596     // only handle component at this stage - not terribly sure how a recurring event payment would arise
 597     // & suspec main function may be a victom of copy & paste
 598     // membership would be an easy add - but not relevant to my customer...
 599     $this->_component = $input['component'] = 'contribute';
 600     $input['trxn_date'] = date('Y-m-d-H-i-s', strtotime(self::retrieve('time_created', 'String')));
 601     $paymentProcessorID = $contributionRecur['payment_processor_id'];
 602
 603     if (!$this->validateData($input, $ids, $objects, TRUE, $paymentProcessorID)) {
 604       throw new CRM_Core_Exception('Data did not validate');
 605     }
 606     $this->recur($input, $ids, $objects, $isFirst);
 607   }
 608
 609   /**
 610    * Function check if transaction already exists.
 611    * @param string $trxn_id
 612    * @return bool|void
 613    */
 614   public function transactionExists($trxn_id) {
 615     if (CRM_Core_DAO::singleValueQuery("SELECT count(*) FROM civicrm_contribution WHERE trxn_id = %1",
 616       array(
 617         1 => array($trxn_id, 'String'),
 618       ))
 619     ) {
 620       return TRUE;
 621     }
 622   }
 623
 624 }