_inputParameters = $parameters; } /** * Validate incoming data. * * This function is intended to ensure that incoming data matches * It provides a form of pseudo-authentication - by checking the calling fn already knows * the correct contact id & contribution id (this can be problematic when that has changed in * the meantime for transactions that are delayed & contacts are merged in-between. e.g * Paypal allows you to resend Instant Payment Notifications if you, for example, moved site * and didn't update your IPN URL. * * @param array $input * Interpreted values from the values returned through the IPN. * @param array $ids * More interpreted values (ids) from the values returned through the IPN. * @param array $objects * An empty array that will be populated with loaded object. * @param bool $required * Boolean Return FALSE if the relevant objects don't exist. * @param int $paymentProcessorID * Id of the payment processor ID in use. * * @return bool */ public function validateData(&$input, &$ids, &$objects, $required = TRUE, $paymentProcessorID = NULL) { // Check if the contribution exists // make sure contribution exists and is valid $contribution = new CRM_Contribute_BAO_Contribution(); $contribution->id = $ids['contribution']; if (!$contribution->find(TRUE)) { CRM_Core_Error::debug_log_message("Could not find contribution record: {$contribution->id} in IPN request: " . print_r($input, TRUE)); echo "Failure: Could not find contribution record for {$contribution->id}
"; return FALSE; } // make sure contact exists and is valid // use the contact id from the contribution record as the id in the IPN may not be valid anymore. $contact = new CRM_Contact_BAO_Contact(); $contact->id = $contribution->contact_id; $contact->find(TRUE); if ($contact->id != $ids['contact']) { // 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 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"); echo "WARNING: Could not find contact record: {$ids['contact']}
"; $ids['contact'] = $contribution->contact_id; } if (!empty($ids['contributionRecur'])) { $contributionRecur = new CRM_Contribute_BAO_ContributionRecur(); $contributionRecur->id = $ids['contributionRecur']; if (!$contributionRecur->find(TRUE)) { CRM_Core_Error::debug_log_message("Could not find contribution recur record: {$ids['ContributionRecur']} in IPN request: " . print_r($input, TRUE)); echo "Failure: Could not find contribution recur record: {$ids['ContributionRecur']}
"; return FALSE; } } $contribution->receive_date = CRM_Utils_Date::isoToMysql($contribution->receive_date); $contribution->receipt_date = CRM_Utils_Date::isoToMysql($contribution->receipt_date); $objects['contact'] = &$contact; $objects['contribution'] = &$contribution; // CRM-19478: handle oddity when p=null is set in place of contribution page ID, if (!empty($ids['contributionPage']) && !is_numeric($ids['contributionPage'])) { // We don't need to worry if about removing contribution page id as it will be set later in // CRM_Contribute_BAO_Contribution::loadRelatedObjects(..) using $objects['contribution']->contribution_page_id unset($ids['contributionPage']); } if (!$this->loadObjects($input, $ids, $objects, $required, $paymentProcessorID)) { return FALSE; } //the process is that the loadObjects is kind of hacked by loading the objects for the original contribution and then somewhat inconsistently using them for the //current contribution. Here we ensure that the original contribution is available to the complete transaction function //we don't want to fix this in the payment processor classes because we would have to fix all of them - so better to fix somewhere central if (isset($objects['contributionRecur'])) { $objects['first_contribution'] = $objects['contribution']; } return TRUE; } /** * Load objects related to contribution. * * @input array information from Payment processor * * @param array $input * @param array $ids * @param array $objects * @param bool $required * @param int $paymentProcessorID * @param array $error_handling * * @return bool|array */ public function loadObjects(&$input, &$ids, &$objects, $required, $paymentProcessorID, $error_handling = NULL) { if (empty($error_handling)) { // default options are that we log an error & echo it out // note that we should refactor this error handling into error code @ some point // but for now setting up enough separation so we can do unit tests $error_handling = [ 'log_error' => 1, 'echo_error' => 1, ]; } $ids['paymentProcessor'] = $paymentProcessorID; if (is_a($objects['contribution'], 'CRM_Contribute_BAO_Contribution')) { $contribution = &$objects['contribution']; } else { //legacy support - functions are 'used' to be able to pass in a DAO $contribution = new CRM_Contribute_BAO_Contribution(); $contribution->id = $ids['contribution'] ?? NULL; $contribution->find(TRUE); $objects['contribution'] = &$contribution; } try { $success = $contribution->loadRelatedObjects($input, $ids); if ($required && empty($contribution->_relatedObjects['paymentProcessor'])) { throw new CRM_Core_Exception("Could not find payment processor for contribution record: " . $contribution->id); } } catch (Exception $e) { $success = FALSE; if (!empty($error_handling['log_error'])) { CRM_Core_Error::debug_log_message($e->getMessage()); } if (!empty($error_handling['echo_error'])) { echo $e->getMessage(); } if (!empty($error_handling['return_error'])) { return [ 'is_error' => 1, 'error_message' => ($e->getMessage()), ]; } } $objects = array_merge($objects, $contribution->_relatedObjects); return $success; } /** * Set contribution to failed. * * @param array $objects * @param object $transaction * @param array $input * * @return bool * @throws \CiviCRM_API3_Exception */ public function failed(&$objects, &$transaction, $input = []) { $contribution = &$objects['contribution']; $memberships = []; if (!empty($objects['membership'])) { $memberships = &$objects['membership']; if (is_numeric($memberships)) { $memberships = [$objects['membership']]; } } $addLineItems = FALSE; if (empty($contribution->id)) { $addLineItems = TRUE; } $participant = &$objects['participant']; // CRM-15546 $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', [ 'labelColumn' => 'name', 'flip' => 1, ]); $contribution->contribution_status_id = $contributionStatuses['Failed']; $contribution->receive_date = CRM_Utils_Date::isoToMysql($contribution->receive_date); $contribution->receipt_date = CRM_Utils_Date::isoToMysql($contribution->receipt_date); $contribution->thankyou_date = CRM_Utils_Date::isoToMysql($contribution->thankyou_date); $contribution->save(); // Add line items for recurring payments. if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id && $addLineItems) { CRM_Contribute_BAO_ContributionRecur::addRecurLineItems($objects['contributionRecur']->id, $contribution); } //add new soft credit against current contribution id and //copy initial contribution custom fields for recurring contributions if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id) { CRM_Contribute_BAO_ContributionRecur::addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id); CRM_Contribute_BAO_ContributionRecur::copyCustomValues($objects['contributionRecur']->id, $contribution->id); } if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) { if (!empty($memberships)) { foreach ($memberships as $membership) { // @fixme Should we cancel only Pending memberships? per cancelled() $this->cancelMembership($membership, $membership->status_id, FALSE); } } if ($participant) { $this->cancelParticipant($participant->id); } } $transaction->commit(); Civi::log()->debug("Setting contribution status to Failed"); return TRUE; } /** * Handled pending contribution status. * * @param array $objects * @param object $transaction * * @return bool */ public function pending(&$objects, &$transaction) { $transaction->commit(); Civi::log()->debug("Returning since contribution status is Pending"); echo "Success: Returning since contribution status is pending
"; return TRUE; } /** * Process cancelled payment outcome. * * @param array $objects * @param CRM_Core_Transaction $transaction * @param array $input * * @return bool * @throws \CiviCRM_API3_Exception */ public function cancelled(&$objects, &$transaction, $input = []) { $contribution = &$objects['contribution']; $memberships = []; if (!empty($objects['membership'])) { $memberships = &$objects['membership']; if (is_numeric($memberships)) { $memberships = [$objects['membership']]; } } $addLineItems = FALSE; if (empty($contribution->id)) { $addLineItems = TRUE; } $participant = &$objects['participant']; // CRM-15546 $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', [ 'labelColumn' => 'name', 'flip' => 1, ]); $contribution->contribution_status_id = $contributionStatuses['Cancelled']; $contribution->receive_date = CRM_Utils_Date::isoToMysql($contribution->receive_date); $contribution->receipt_date = CRM_Utils_Date::isoToMysql($contribution->receipt_date); $contribution->thankyou_date = CRM_Utils_Date::isoToMysql($contribution->thankyou_date); $contribution->cancel_date = self::$_now; $contribution->cancel_reason = $input['reasonCode'] ?? NULL; $contribution->save(); // Add line items for recurring payments. if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id && $addLineItems) { CRM_Contribute_BAO_ContributionRecur::addRecurLineItems($objects['contributionRecur']->id, $contribution); } //add new soft credit against current $contribution and //copy initial contribution custom fields for recurring contributions if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id) { CRM_Contribute_BAO_ContributionRecur::addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id); CRM_Contribute_BAO_ContributionRecur::copyCustomValues($objects['contributionRecur']->id, $contribution->id); } if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) { if (!empty($memberships)) { foreach ($memberships as $membership) { if ($membership) { $this->cancelMembership($membership, $membership->status_id); } } } if ($participant) { $this->cancelParticipant($participant->id); } } $transaction->commit(); Civi::log()->debug("Setting contribution status to Cancelled"); return TRUE; } /** * Rollback unhandled outcomes. * * @param array $objects * @param CRM_Core_Transaction $transaction * * @return bool */ public function unhandled(&$objects, &$transaction) { $transaction->rollback(); Civi::log()->debug("Returning since contribution status is not handled"); echo "Failure: contribution status is not handled
"; return FALSE; } /** * Logic to cancel a participant record when the related contribution changes to failed/cancelled. * @todo This is part of a bigger refactor for dev/core/issues/927 - "duplicate" functionality exists in CRM_Contribute_BAO_Contribution::cancel() * * @param $participantID * * @throws \CiviCRM_API3_Exception */ private function cancelParticipant($participantID) { // @fixme https://lab.civicrm.org/dev/core/issues/927 Cancelling membership etc is not desirable for all use-cases and we should be able to disable it $participantParams['id'] = $participantID; $participantParams['status_id'] = 'Cancelled'; civicrm_api3('Participant', 'create', $participantParams); } /** * Logic to cancel a membership record when the related contribution changes to failed/cancelled. * @todo This is part of a bigger refactor for dev/core/issues/927 - "duplicate" functionality exists in CRM_Contribute_BAO_Contribution::cancel() * @param \CRM_Member_BAO_Membership $membership * @param int $membershipStatusID * @param boolean $onlyCancelPendingMembership * Do we only cancel pending memberships? OR memberships in any status? (see CRM-18688) * @fixme Historically failed() cancelled membership in any status, cancelled() cancelled only pending memberships so we retain that behaviour for now. * */ private function cancelMembership($membership, $membershipStatusID, $onlyCancelPendingMembership = TRUE) { // @fixme https://lab.civicrm.org/dev/core/issues/927 Cancelling membership etc is not desirable for all use-cases and we should be able to disable it // Cancel only Pending memberships $pendingMembershipStatusId = CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Pending'); if (($membershipStatusID == $pendingMembershipStatusId) || ($onlyCancelPendingMembership == FALSE)) { $cancelledMembershipStatusId = CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Cancelled'); $membership->status_id = $cancelledMembershipStatusId; $membership->save(); $params = ['status_id' => $cancelledMembershipStatusId]; CRM_Member_BAO_Membership::updateRelatedMemberships($membership->id, $params); // @todo Convert the above to API // $membershipParams = [ // 'id' => $membership->id, // 'status_id' => $cancelledMembershipStatusId, // ]; // civicrm_api3('Membership', 'create', $membershipParams); // CRM_Member_BAO_Membership::updateRelatedMemberships($membershipParams['id'], ['status_id' => $cancelledMembershipStatusId]); } } /** * @deprecated * * Jumbled up function. * * The purpose of this function is to transition a pending transaction to Completed including updating any * related entities. * * It has been overloaded to also add recurring transactions to the database, cloning the original transaction and * updating related entities. * * It is recommended to avoid calling this function directly and call the api functions: * - contribution.completetransaction * - contribution.repeattransaction * * These functions are the focus of testing efforts and more accurately reflect the division of roles * (the job of the IPN class is to determine the outcome, transaction id, invoice id & to validate the source * and from there it should be possible to pass off transaction management.) * * This function has been problematic for some time but there are now several tests via the api_v3_Contribution test * and the Paypal & Authorize.net IPN tests so any refactoring should be done in conjunction with those. * * This function needs to have the 'body' moved to the CRM_Contribute_BAO_Contribute class and to undergo * refactoring to separate the complete transaction and repeat transaction functionality into separate functions with * a shared function that updates related components. * * Note that it is not necessary payment processor extension to implement an IPN class now. In general the code on the * IPN class is better accessed through the api which de-jumbles it a bit. * * e.g the payment class can have a function like (based on Omnipay extension): * * public function handlePaymentNotification() { * $response = $this->getValidatedOutcome(); * if ($response->isSuccessful()) { * try { * // @todo check if it is a repeat transaction & call repeattransaction instead. * civicrm_api3('contribution', 'completetransaction', array('id' => $this->transaction_id)); * } * catch (CiviCRM_API3_Exception $e) { * if (!stristr($e->getMessage(), 'Contribution already completed')) { * $this->handleError('error', $this->transaction_id . $e->getMessage(), 'ipn_completion', 9000, 'An error may * have occurred. Please check your receipt is correct'); * $this->redirectOrExit('success'); * } * elseif ($this->transaction_id) { * civicrm_api3('contribution', 'create', array('id' => $this->transaction_id, 'contribution_status_id' => * 'Failed')); * } * * @param array $input * @param array $ids * @param array $objects * @param CRM_Core_Transaction $transaction * * @throws \CRM_Core_Exception * @throws \CiviCRM_API3_Exception */ public function completeTransaction(&$input, &$ids, &$objects, $transaction = NULL) { CRM_Contribute_BAO_Contribution::completeOrder($input, $ids, $objects, $transaction); } /** * Get site billing ID. * * @param array $ids * * @return bool */ public function getBillingID(&$ids) { $ids['billing'] = CRM_Core_BAO_LocationType::getBilling(); if (!$ids['billing']) { CRM_Core_Error::debug_log_message(ts('Please set a location type of %1', [1 => 'Billing'])); echo "Failure: Could not find billing location type
"; return FALSE; } return TRUE; } /** * @deprecated * * @todo confirm this function is not being used by any payment processor outside core & remove. * * Note that the compose message part has been moved to contribution * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it * * @param array $input * Incoming data from Payment processor. * @param array $ids * Related object IDs. * @param array $objects * @param array $values * Values related to objects that have already been loaded. * @param bool $recur * Is it part of a recurring contribution. * @param bool $returnMessageText * Should text be returned instead of sent. This. * is because the function is also used to generate pdfs * * @return array * @throws \CRM_Core_Exception * @throws \CiviCRM_API3_Exception */ public function sendMail(&$input, &$ids, &$objects, &$values, $recur = FALSE, $returnMessageText = FALSE) { return CRM_Contribute_BAO_Contribution::sendMail($input, $ids, $objects['contribution']->id, $values, $returnMessageText); } }