CRM/Core/Payment/PayPalProIPN.php

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