CRM/Core/Payment/BaseIPN.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 /**
  13  * Class CRM_Core_Payment_BaseIPN.
  14  */
  15 class CRM_Core_Payment_BaseIPN {
  16
  17   public static $_now = NULL;
  18
  19   /**
  20    * Input parameters from payment processor. Store these so that
  21    * the code does not need to keep retrieving from the http request
  22    * @var array
  23    */
  24   protected $_inputParameters = [];
  25
  26   /**
  27    * Only used by AuthorizeNetIPN.
  28    * @var bool
  29    *
  30    * @deprecated
  31    *
  32    */
  33   protected $_isRecurring = FALSE;
  34
  35   /**
  36    * Only used by AuthorizeNetIPN.
  37    * @var bool
  38    *
  39    * @deprecated
  40    *
  41    */
  42   protected $_isFirstOrLastRecurringPayment = FALSE;
  43
  44   /**
  45    * Constructor.
  46    */
  47   public function __construct() {
  48     self::$_now = date('YmdHis');
  49   }
  50
  51   /**
  52    * Store input array on the class.
  53    *
  54    * @param array $parameters
  55    *
  56    * @throws CRM_Core_Exception
  57    */
  58   public function setInputParameters($parameters) {
  59     if (!is_array($parameters)) {
  60       throw new CRM_Core_Exception('Invalid input parameters');
  61     }
  62     $this->_inputParameters = $parameters;
  63   }
  64
  65   /**
  66    * Validate incoming data.
  67    *
  68    * This function is intended to ensure that incoming data matches
  69    * It provides a form of pseudo-authentication - by checking the calling fn already knows
  70    * the correct contact id & contribution id (this can be problematic when that has changed in
  71    * the meantime for transactions that are delayed & contacts are merged in-between. e.g
  72    * Paypal allows you to resend Instant Payment Notifications if you, for example, moved site
  73    * and didn't update your IPN URL.
  74    *
  75    * @param array $input
  76    *   Interpreted values from the values returned through the IPN.
  77    * @param array $ids
  78    *   More interpreted values (ids) from the values returned through the IPN.
  79    * @param array $objects
  80    *   An empty array that will be populated with loaded object.
  81    * @param bool $required
  82    *   Boolean Return FALSE if the relevant objects don't exist.
  83    * @param int $paymentProcessorID
  84    *   Id of the payment processor ID in use.
  85    *
  86    * @return bool
  87    */
  88   public function validateData($input, &$ids, &$objects, $required = TRUE, $paymentProcessorID = NULL) {
  89
  90     // Check if the contribution exists
  91     // make sure contribution exists and is valid
  92     $contribution = new CRM_Contribute_BAO_Contribution();
  93     $contribution->id = $ids['contribution'];
  94     if (!$contribution->find(TRUE)) {
  95       throw new CRM_Core_Exception('Failure: Could not find contribution record for ' . (int) $contribution->id, NULL, ['context' => "Could not find contribution record: {$contribution->id} in IPN request: " . print_r($input, TRUE)]);
  96     }
  97
  98     // make sure contact exists and is valid
  99     // use the contact id from the contribution record as the id in the IPN may not be valid anymore.
 100     $contact = new CRM_Contact_BAO_Contact();
 101     $contact->id = $contribution->contact_id;
 102     $contact->find(TRUE);
 103     if ($contact->id != $ids['contact']) {
 104       // 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
 105       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");
 106       echo "WARNING: Could not find contact record: {$ids['contact']}<p>";
 107       $ids['contact'] = $contribution->contact_id;
 108     }
 109
 110     if (!empty($ids['contributionRecur'])) {
 111       $contributionRecur = new CRM_Contribute_BAO_ContributionRecur();
 112       $contributionRecur->id = $ids['contributionRecur'];
 113       if (!$contributionRecur->find(TRUE)) {
 114         CRM_Core_Error::debug_log_message("Could not find contribution recur record: {$ids['ContributionRecur']} in IPN request: " . print_r($input, TRUE));
 115         echo "Failure: Could not find contribution recur record: {$ids['ContributionRecur']}<p>";
 116         return FALSE;
 117       }
 118     }
 119
 120     $objects['contact'] = &$contact;
 121     $objects['contribution'] = &$contribution;
 122
 123     // CRM-19478: handle oddity when p=null is set in place of contribution page ID,
 124     if (!empty($ids['contributionPage']) && !is_numeric($ids['contributionPage'])) {
 125       // We don't need to worry if about removing contribution page id as it will be set later in
 126       //  CRM_Contribute_BAO_Contribution::loadRelatedObjects(..) using $objects['contribution']->contribution_page_id
 127       unset($ids['contributionPage']);
 128     }
 129
 130     if (!$this->loadObjects($input, $ids, $objects, $required, $paymentProcessorID)) {
 131       return FALSE;
 132     }
 133     return TRUE;
 134   }
 135
 136   /**
 137    * Load objects related to contribution.
 138    *
 139    * @input array information from Payment processor
 140    *
 141    * @param array $input
 142    * @param array $ids
 143    * @param array $objects
 144    * @param bool $required
 145    * @param int $paymentProcessorID
 146    *
 147    * @return bool|array
 148    * @throws \CRM_Core_Exception
 149    */
 150   public function loadObjects($input, &$ids, &$objects, $required, $paymentProcessorID) {
 151     $contribution = &$objects['contribution'];
 152     $ids['paymentProcessor'] = $paymentProcessorID;
 153     $success = $contribution->loadRelatedObjects($input, $ids);
 154     if ($required && empty($contribution->_relatedObjects['paymentProcessor'])) {
 155       throw new CRM_Core_Exception("Could not find payment processor for contribution record: " . $contribution->id);
 156     }
 157     $objects = array_merge($objects, $contribution->_relatedObjects);
 158     return $success;
 159   }
 160
 161   /**
 162    * Set contribution to failed.
 163    *
 164    * @param array $objects
 165    *
 166    * @return bool
 167    * @throws \CiviCRM_API3_Exception|\CRM_Core_Exception
 168    */
 169   public function failed($objects) {
 170     $contribution = &$objects['contribution'];
 171     $memberships = [];
 172     if (!empty($objects['membership'])) {
 173       $memberships = &$objects['membership'];
 174       if (is_numeric($memberships)) {
 175         $memberships = [$objects['membership']];
 176       }
 177     }
 178
 179     $addLineItems = empty($contribution->id);
 180     $participant = &$objects['participant'];
 181     $contribution->contribution_status_id = CRM_Core_PseudoConstant::getKey('CRM_Contribute_DAO_Contribution', 'contribution_status_id', 'Failed');
 182     $contribution->save();
 183
 184     // Add line items for recurring payments.
 185     if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id && $addLineItems) {
 186       CRM_Contribute_BAO_ContributionRecur::addRecurLineItems($objects['contributionRecur']->id, $contribution);
 187     }
 188
 189     if (!empty($memberships)) {
 190       foreach ($memberships as $membership) {
 191         // @fixme Should we cancel only Pending memberships? per cancelled()
 192         $this->cancelMembership($membership, $membership->status_id, FALSE);
 193       }
 194     }
 195
 196     if ($participant) {
 197       $this->cancelParticipant($participant->id);
 198     }
 199
 200     Civi::log()->debug("Setting contribution status to Failed");
 201     return TRUE;
 202   }
 203
 204   /**
 205    * Handled pending contribution status.
 206    *
 207    * @deprecated
 208    *
 209    * @param array $objects
 210    * @param object $transaction
 211    *
 212    * @return bool
 213    */
 214   public function pending(&$objects, &$transaction) {
 215     CRM_Core_Error::deprecatedFunctionWarning('This function will be removed at some point');
 216     $transaction->commit();
 217     Civi::log()->debug('Returning since contribution status is Pending');
 218     echo 'Success: Returning since contribution status is pending<p>';
 219     return TRUE;
 220   }
 221
 222   /**
 223    * Process cancelled payment outcome.
 224    *
 225    * @param array $objects
 226    *
 227    * @return bool
 228    * @throws \CiviCRM_API3_Exception|\CRM_Core_Exception
 229    */
 230   public function cancelled($objects) {
 231     $contribution = &$objects['contribution'];
 232     $memberships = [];
 233     if (!empty($objects['membership'])) {
 234       $memberships = &$objects['membership'];
 235       if (is_numeric($memberships)) {
 236         $memberships = [$objects['membership']];
 237       }
 238     }
 239
 240     $addLineItems = FALSE;
 241     if (empty($contribution->id)) {
 242       $addLineItems = TRUE;
 243     }
 244     $participant = &$objects['participant'];
 245
 246     // CRM-15546
 247     $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', [
 248       'labelColumn' => 'name',
 249       'flip' => 1,
 250     ]);
 251     $contribution->contribution_status_id = $contributionStatuses['Cancelled'];
 252     $contribution->cancel_date = self::$_now;
 253     $contribution->save();
 254
 255     // Add line items for recurring payments.
 256     if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id && $addLineItems) {
 257       CRM_Contribute_BAO_ContributionRecur::addRecurLineItems($objects['contributionRecur']->id, $contribution);
 258     }
 259
 260     if (!empty($memberships)) {
 261       foreach ($memberships as $membership) {
 262         if ($membership) {
 263           $this->cancelMembership($membership, $membership->status_id);
 264         }
 265       }
 266     }
 267
 268     if ($participant) {
 269       $this->cancelParticipant($participant->id);
 270     }
 271
 272     Civi::log()->debug("Setting contribution status to Cancelled");
 273     return TRUE;
 274   }
 275
 276   /**
 277    * Rollback unhandled outcomes.
 278    *
 279    * @deprecated
 280    *
 281    * @param array $objects
 282    * @param CRM_Core_Transaction $transaction
 283    *
 284    * @return bool
 285    */
 286   public function unhandled(&$objects, &$transaction) {
 287     CRM_Core_Error::deprecatedFunctionWarning('This function will be removed at some point');
 288     $transaction->rollback();
 289     Civi::log()->debug('Returning since contribution status is not handled');
 290     echo 'Failure: contribution status is not handled<p>';
 291     return FALSE;
 292   }
 293
 294   /**
 295    * Logic to cancel a participant record when the related contribution changes to failed/cancelled.
 296    * @todo This is part of a bigger refactor for dev/core/issues/927 - "duplicate" functionality exists in CRM_Contribute_BAO_Contribution::cancel()
 297    *
 298    * @param $participantID
 299    *
 300    * @throws \CiviCRM_API3_Exception
 301    */
 302   private function cancelParticipant($participantID) {
 303     // @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
 304     $participantParams['id'] = $participantID;
 305     $participantParams['status_id'] = 'Cancelled';
 306     civicrm_api3('Participant', 'create', $participantParams);
 307   }
 308
 309   /**
 310    * Logic to cancel a membership record when the related contribution changes to failed/cancelled.
 311    * @todo This is part of a bigger refactor for dev/core/issues/927 - "duplicate" functionality exists in CRM_Contribute_BAO_Contribution::cancel()
 312    * @param \CRM_Member_BAO_Membership $membership
 313    * @param int $membershipStatusID
 314    * @param boolean $onlyCancelPendingMembership
 315    *   Do we only cancel pending memberships? OR memberships in any status? (see CRM-18688)
 316    * @fixme Historically failed() cancelled membership in any status, cancelled() cancelled only pending memberships so we retain that behaviour for now.
 317    *
 318    */
 319   private function cancelMembership($membership, $membershipStatusID, $onlyCancelPendingMembership = TRUE) {
 320     // @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
 321     // Cancel only Pending memberships
 322     $pendingMembershipStatusId = CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Pending');
 323     if (($membershipStatusID == $pendingMembershipStatusId) || ($onlyCancelPendingMembership == FALSE)) {
 324       $cancelledMembershipStatusId = CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Cancelled');
 325
 326       $membership->status_id = $cancelledMembershipStatusId;
 327       $membership->save();
 328
 329       $params = ['status_id' => $cancelledMembershipStatusId];
 330       CRM_Member_BAO_Membership::updateRelatedMemberships($membership->id, $params);
 331
 332       // @todo Convert the above to API
 333       // $membershipParams = [
 334       //   'id' => $membership->id,
 335       //   'status_id' => $cancelledMembershipStatusId,
 336       // ];
 337       // civicrm_api3('Membership', 'create', $membershipParams);
 338       // CRM_Member_BAO_Membership::updateRelatedMemberships($membershipParams['id'], ['status_id' => $cancelledMembershipStatusId]);
 339     }
 340
 341   }
 342
 343   /**
 344    * @deprecated
 345    *
 346    * Jumbled up function.
 347    *
 348    * The purpose of this function is to transition a pending transaction to Completed including updating any
 349    * related entities.
 350    *
 351    * It has been overloaded to also add recurring transactions to the database, cloning the original transaction and
 352    * updating related entities.
 353    *
 354    * It is recommended to avoid calling this function directly and call the api functions:
 355    *  - contribution.completetransaction
 356    *  - contribution.repeattransaction
 357    *
 358    * These functions are the focus of testing efforts and more accurately reflect the division of roles
 359    * (the job of the IPN class is to determine the outcome, transaction id, invoice id & to validate the source
 360    * and from there it should be possible to pass off transaction management.)
 361    *
 362    * This function has been problematic for some time but there are now several tests via the api_v3_Contribution test
 363    * and the Paypal & Authorize.net IPN tests so any refactoring should be done in conjunction with those.
 364    *
 365    * This function needs to have the 'body' moved to the CRM_Contribute_BAO_Contribute class and to undergo
 366    * refactoring to separate the complete transaction and repeat transaction functionality into separate functions with
 367    * a shared function that updates related components.
 368    *
 369    * Note that it is not necessary payment processor extension to implement an IPN class now. In general the code on the
 370    * IPN class is better accessed through the api which de-jumbles it a bit.
 371    *
 372    * e.g the payment class can have a function like (based on Omnipay extension):
 373    *
 374    *   public function handlePaymentNotification() {
 375    *     $response = $this->getValidatedOutcome();
 376    *     if ($response->isSuccessful()) {
 377    *      try {
 378    *        // @todo check if it is a repeat transaction & call repeattransaction instead.
 379    *        civicrm_api3('contribution', 'completetransaction', array('id' => $this->transaction_id));
 380    *      }
 381    *     catch (CiviCRM_API3_Exception $e) {
 382    *     if (!stristr($e->getMessage(), 'Contribution already completed')) {
 383    *       $this->handleError('error', $this->transaction_id  . $e->getMessage(), 'ipn_completion', 9000, 'An error may
 384    *         have occurred. Please check your receipt is correct');
 385    *       $this->redirectOrExit('success');
 386    *     }
 387    *     elseif ($this->transaction_id) {
 388    *        civicrm_api3('contribution', 'create', array('id' => $this->transaction_id, 'contribution_status_id' =>
 389    *        'Failed'));
 390    *     }
 391    *
 392    * @param array $input
 393    * @param array $ids
 394    * @param array $objects
 395    *
 396    * @throws \CRM_Core_Exception
 397    * @throws \CiviCRM_API3_Exception
 398    */
 399   public function completeTransaction($input, $ids, $objects) {
 400     CRM_Core_Error::deprecatedFunctionWarning('Use Payment.create api');
 401     CRM_Contribute_BAO_Contribution::completeOrder($input, [
 402       'related_contact' => $ids['related_contact'] ?? NULL,
 403       'participant' => !empty($objects['participant']) ? $objects['participant']->id : NULL,
 404       'contributionRecur' => !empty($objects['contributionRecur']) ? $objects['contributionRecur']->id : NULL,
 405     ], $objects['contribution']);
 406   }
 407
 408   /**
 409    * @deprecated
 410    * Get site billing ID.
 411    *
 412    * @param array $ids
 413    *
 414    * @return bool
 415    */
 416   public function getBillingID(&$ids) {
 417     CRM_Core_Error::deprecatedFunctionWarning('CRM_Core_BAO_LocationType::getBilling()');
 418     $ids['billing'] = CRM_Core_BAO_LocationType::getBilling();
 419     if (!$ids['billing']) {
 420       CRM_Core_Error::debug_log_message(ts('Please set a location type of %1', [1 => 'Billing']));
 421       echo "Failure: Could not find billing location type<p>";
 422       return FALSE;
 423     }
 424     return TRUE;
 425   }
 426
 427   /**
 428    * @deprecated
 429    *
 430    * @todo confirm this function is not being used by any payment processor outside core & remove.
 431    *
 432    * Note that the compose message part has been moved to contribution
 433    * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it
 434    *
 435    * @param array $input
 436    *   Incoming data from Payment processor.
 437    * @param array $ids
 438    *   Related object IDs.
 439    * @param array $objects
 440    *
 441    * @throws \CiviCRM_API3_Exception
 442    */
 443   public function sendMail($input, $ids, $objects) {
 444     CRM_Core_Error::deprecatedFunctionWarning('this should be done via completetransaction api');
 445     civicrm_api3('Contribution', 'sendconfirmation', [
 446       'id' => $objects['contribution']->id,
 447     ]);
 448   }
 449
 450 }