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       CRM_Core_Error::debug_log_message("Could not find contribution record: {$contribution->id} in IPN request: " . print_r($input, TRUE));
  96       echo "Failure: Could not find contribution record for {$contribution->id}<p>";
  97       return FALSE;
  98     }
  99
 100     // make sure contact exists and is valid
 101     // use the contact id from the contribution record as the id in the IPN may not be valid anymore.
 102     $contact = new CRM_Contact_BAO_Contact();
 103     $contact->id = $contribution->contact_id;
 104     $contact->find(TRUE);
 105     if ($contact->id != $ids['contact']) {
 106       // 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
 107       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");
 108       echo "WARNING: Could not find contact record: {$ids['contact']}<p>";
 109       $ids['contact'] = $contribution->contact_id;
 110     }
 111
 112     if (!empty($ids['contributionRecur'])) {
 113       $contributionRecur = new CRM_Contribute_BAO_ContributionRecur();
 114       $contributionRecur->id = $ids['contributionRecur'];
 115       if (!$contributionRecur->find(TRUE)) {
 116         CRM_Core_Error::debug_log_message("Could not find contribution recur record: {$ids['ContributionRecur']} in IPN request: " . print_r($input, TRUE));
 117         echo "Failure: Could not find contribution recur record: {$ids['ContributionRecur']}<p>";
 118         return FALSE;
 119       }
 120     }
 121
 122     $objects['contact'] = &$contact;
 123     $objects['contribution'] = &$contribution;
 124
 125     // CRM-19478: handle oddity when p=null is set in place of contribution page ID,
 126     if (!empty($ids['contributionPage']) && !is_numeric($ids['contributionPage'])) {
 127       // We don't need to worry if about removing contribution page id as it will be set later in
 128       //  CRM_Contribute_BAO_Contribution::loadRelatedObjects(..) using $objects['contribution']->contribution_page_id
 129       unset($ids['contributionPage']);
 130     }
 131
 132     if (!$this->loadObjects($input, $ids, $objects, $required, $paymentProcessorID)) {
 133       return FALSE;
 134     }
 135     return TRUE;
 136   }
 137
 138   /**
 139    * Load objects related to contribution.
 140    *
 141    * @input array information from Payment processor
 142    *
 143    * @param array $input
 144    * @param array $ids
 145    * @param array $objects
 146    * @param bool $required
 147    * @param int $paymentProcessorID
 148    * @param array $error_handling
 149    *
 150    * @return bool|array
 151    */
 152   public function loadObjects($input, &$ids, &$objects, $required, $paymentProcessorID, $error_handling = NULL) {
 153     if (empty($error_handling)) {
 154       // default options are that we log an error & echo it out
 155       // note that we should refactor this error handling into error code @ some point
 156       // but for now setting up enough separation so we can do unit tests
 157       $error_handling = [
 158         'log_error' => 1,
 159         'echo_error' => 1,
 160       ];
 161     }
 162     $ids['paymentProcessor'] = $paymentProcessorID;
 163     if (is_a($objects['contribution'], 'CRM_Contribute_BAO_Contribution')) {
 164       $contribution = &$objects['contribution'];
 165     }
 166     else {
 167       //legacy support - functions are 'used' to be able to pass in a DAO
 168       $contribution = new CRM_Contribute_BAO_Contribution();
 169       $contribution->id = $ids['contribution'] ?? NULL;
 170       $contribution->find(TRUE);
 171       $objects['contribution'] = &$contribution;
 172     }
 173     try {
 174       $success = $contribution->loadRelatedObjects($input, $ids);
 175       if ($required && empty($contribution->_relatedObjects['paymentProcessor'])) {
 176         throw new CRM_Core_Exception("Could not find payment processor for contribution record: " . $contribution->id);
 177       }
 178     }
 179     catch (Exception $e) {
 180       $success = FALSE;
 181       if (!empty($error_handling['log_error'])) {
 182         CRM_Core_Error::debug_log_message($e->getMessage());
 183       }
 184       if (!empty($error_handling['echo_error'])) {
 185         echo $e->getMessage();
 186       }
 187       if (!empty($error_handling['return_error'])) {
 188         return [
 189           'is_error' => 1,
 190           'error_message' => ($e->getMessage()),
 191         ];
 192       }
 193     }
 194     $objects = array_merge($objects, $contribution->_relatedObjects);
 195     return $success;
 196   }
 197
 198   /**
 199    * Set contribution to failed.
 200    *
 201    * @param array $objects
 202    * @param object $transaction
 203    * @param array $input
 204    *
 205    * @return bool
 206    * @throws \CiviCRM_API3_Exception
 207    */
 208   public function failed(&$objects, $transaction = NULL, $input = []) {
 209     $contribution = &$objects['contribution'];
 210     $memberships = [];
 211     if (!empty($objects['membership'])) {
 212       $memberships = &$objects['membership'];
 213       if (is_numeric($memberships)) {
 214         $memberships = [$objects['membership']];
 215       }
 216     }
 217
 218     $addLineItems = empty($contribution->id);
 219     $participant = &$objects['participant'];
 220     $contribution->contribution_status_id = CRM_Core_PseudoConstant::getKey('CRM_Contribute_DAO_Contribution', 'contribution_status_id', 'Failed');
 221     $contribution->save();
 222
 223     // Add line items for recurring payments.
 224     if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id && $addLineItems) {
 225       CRM_Contribute_BAO_ContributionRecur::addRecurLineItems($objects['contributionRecur']->id, $contribution);
 226     }
 227
 228     //add new soft credit against current contribution id and
 229     //copy initial contribution custom fields for recurring contributions
 230     if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id) {
 231       CRM_Contribute_BAO_ContributionRecur::addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id);
 232       CRM_Contribute_BAO_ContributionRecur::copyCustomValues($objects['contributionRecur']->id, $contribution->id);
 233     }
 234
 235     if (!empty($memberships)) {
 236       foreach ($memberships as $membership) {
 237         // @fixme Should we cancel only Pending memberships? per cancelled()
 238         $this->cancelMembership($membership, $membership->status_id, FALSE);
 239       }
 240     }
 241
 242     if ($participant) {
 243       $this->cancelParticipant($participant->id);
 244     }
 245
 246     if ($transaction) {
 247       $transaction->commit();
 248     }
 249     Civi::log()->debug("Setting contribution status to Failed");
 250     return TRUE;
 251   }
 252
 253   /**
 254    * Handled pending contribution status.
 255    *
 256    * @deprecated
 257    *
 258    * @param array $objects
 259    * @param object $transaction
 260    *
 261    * @return bool
 262    */
 263   public function pending(&$objects, &$transaction) {
 264     CRM_Core_Error::deprecatedFunctionWarning('This function will be removed at some point');
 265     $transaction->commit();
 266     Civi::log()->debug('Returning since contribution status is Pending');
 267     echo 'Success: Returning since contribution status is pending<p>';
 268     return TRUE;
 269   }
 270
 271   /**
 272    * Process cancelled payment outcome.
 273    *
 274    * @param array $objects
 275    * @param CRM_Core_Transaction $transaction
 276    * @param array $input
 277    *
 278    * @return bool
 279    * @throws \CiviCRM_API3_Exception
 280    */
 281   public function cancelled(&$objects, $transaction = NULL, $input = []) {
 282     $contribution = &$objects['contribution'];
 283     $memberships = [];
 284     if (!empty($objects['membership'])) {
 285       $memberships = &$objects['membership'];
 286       if (is_numeric($memberships)) {
 287         $memberships = [$objects['membership']];
 288       }
 289     }
 290
 291     $addLineItems = FALSE;
 292     if (empty($contribution->id)) {
 293       $addLineItems = TRUE;
 294     }
 295     $participant = &$objects['participant'];
 296
 297     // CRM-15546
 298     $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', [
 299       'labelColumn' => 'name',
 300       'flip' => 1,
 301     ]);
 302     $contribution->contribution_status_id = $contributionStatuses['Cancelled'];
 303     $contribution->cancel_date = self::$_now;
 304     $contribution->cancel_reason = $input['reasonCode'] ?? NULL;
 305     $contribution->save();
 306
 307     // Add line items for recurring payments.
 308     if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id && $addLineItems) {
 309       CRM_Contribute_BAO_ContributionRecur::addRecurLineItems($objects['contributionRecur']->id, $contribution);
 310     }
 311
 312     //add new soft credit against current $contribution and
 313     //copy initial contribution custom fields for recurring contributions
 314     if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id) {
 315       CRM_Contribute_BAO_ContributionRecur::addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id);
 316       CRM_Contribute_BAO_ContributionRecur::copyCustomValues($objects['contributionRecur']->id, $contribution->id);
 317     }
 318
 319     if (!empty($memberships)) {
 320       foreach ($memberships as $membership) {
 321         if ($membership) {
 322           $this->cancelMembership($membership, $membership->status_id);
 323         }
 324       }
 325     }
 326
 327     if ($participant) {
 328       $this->cancelParticipant($participant->id);
 329     }
 330
 331     if ($transaction) {
 332       $transaction->commit();
 333     }
 334     Civi::log()->debug("Setting contribution status to Cancelled");
 335     return TRUE;
 336   }
 337
 338   /**
 339    * Rollback unhandled outcomes.
 340    *
 341    * @deprecated
 342    *
 343    * @param array $objects
 344    * @param CRM_Core_Transaction $transaction
 345    *
 346    * @return bool
 347    */
 348   public function unhandled(&$objects, &$transaction) {
 349     CRM_Core_Error::deprecatedFunctionWarning('This function will be removed at some point');
 350     $transaction->rollback();
 351     Civi::log()->debug('Returning since contribution status is not handled');
 352     echo 'Failure: contribution status is not handled<p>';
 353     return FALSE;
 354   }
 355
 356   /**
 357    * Logic to cancel a participant record when the related contribution changes to failed/cancelled.
 358    * @todo This is part of a bigger refactor for dev/core/issues/927 - "duplicate" functionality exists in CRM_Contribute_BAO_Contribution::cancel()
 359    *
 360    * @param $participantID
 361    *
 362    * @throws \CiviCRM_API3_Exception
 363    */
 364   private function cancelParticipant($participantID) {
 365     // @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
 366     $participantParams['id'] = $participantID;
 367     $participantParams['status_id'] = 'Cancelled';
 368     civicrm_api3('Participant', 'create', $participantParams);
 369   }
 370
 371   /**
 372    * Logic to cancel a membership record when the related contribution changes to failed/cancelled.
 373    * @todo This is part of a bigger refactor for dev/core/issues/927 - "duplicate" functionality exists in CRM_Contribute_BAO_Contribution::cancel()
 374    * @param \CRM_Member_BAO_Membership $membership
 375    * @param int $membershipStatusID
 376    * @param boolean $onlyCancelPendingMembership
 377    *   Do we only cancel pending memberships? OR memberships in any status? (see CRM-18688)
 378    * @fixme Historically failed() cancelled membership in any status, cancelled() cancelled only pending memberships so we retain that behaviour for now.
 379    *
 380    */
 381   private function cancelMembership($membership, $membershipStatusID, $onlyCancelPendingMembership = TRUE) {
 382     // @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
 383     // Cancel only Pending memberships
 384     $pendingMembershipStatusId = CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Pending');
 385     if (($membershipStatusID == $pendingMembershipStatusId) || ($onlyCancelPendingMembership == FALSE)) {
 386       $cancelledMembershipStatusId = CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Cancelled');
 387
 388       $membership->status_id = $cancelledMembershipStatusId;
 389       $membership->save();
 390
 391       $params = ['status_id' => $cancelledMembershipStatusId];
 392       CRM_Member_BAO_Membership::updateRelatedMemberships($membership->id, $params);
 393
 394       // @todo Convert the above to API
 395       // $membershipParams = [
 396       //   'id' => $membership->id,
 397       //   'status_id' => $cancelledMembershipStatusId,
 398       // ];
 399       // civicrm_api3('Membership', 'create', $membershipParams);
 400       // CRM_Member_BAO_Membership::updateRelatedMemberships($membershipParams['id'], ['status_id' => $cancelledMembershipStatusId]);
 401     }
 402
 403   }
 404
 405   /**
 406    * @deprecated
 407    *
 408    * Jumbled up function.
 409    *
 410    * The purpose of this function is to transition a pending transaction to Completed including updating any
 411    * related entities.
 412    *
 413    * It has been overloaded to also add recurring transactions to the database, cloning the original transaction and
 414    * updating related entities.
 415    *
 416    * It is recommended to avoid calling this function directly and call the api functions:
 417    *  - contribution.completetransaction
 418    *  - contribution.repeattransaction
 419    *
 420    * These functions are the focus of testing efforts and more accurately reflect the division of roles
 421    * (the job of the IPN class is to determine the outcome, transaction id, invoice id & to validate the source
 422    * and from there it should be possible to pass off transaction management.)
 423    *
 424    * This function has been problematic for some time but there are now several tests via the api_v3_Contribution test
 425    * and the Paypal & Authorize.net IPN tests so any refactoring should be done in conjunction with those.
 426    *
 427    * This function needs to have the 'body' moved to the CRM_Contribute_BAO_Contribute class and to undergo
 428    * refactoring to separate the complete transaction and repeat transaction functionality into separate functions with
 429    * a shared function that updates related components.
 430    *
 431    * Note that it is not necessary payment processor extension to implement an IPN class now. In general the code on the
 432    * IPN class is better accessed through the api which de-jumbles it a bit.
 433    *
 434    * e.g the payment class can have a function like (based on Omnipay extension):
 435    *
 436    *   public function handlePaymentNotification() {
 437    *     $response = $this->getValidatedOutcome();
 438    *     if ($response->isSuccessful()) {
 439    *      try {
 440    *        // @todo check if it is a repeat transaction & call repeattransaction instead.
 441    *        civicrm_api3('contribution', 'completetransaction', array('id' => $this->transaction_id));
 442    *      }
 443    *     catch (CiviCRM_API3_Exception $e) {
 444    *     if (!stristr($e->getMessage(), 'Contribution already completed')) {
 445    *       $this->handleError('error', $this->transaction_id  . $e->getMessage(), 'ipn_completion', 9000, 'An error may
 446    *         have occurred. Please check your receipt is correct');
 447    *       $this->redirectOrExit('success');
 448    *     }
 449    *     elseif ($this->transaction_id) {
 450    *        civicrm_api3('contribution', 'create', array('id' => $this->transaction_id, 'contribution_status_id' =>
 451    *        'Failed'));
 452    *     }
 453    *
 454    * @param array $input
 455    * @param array $ids
 456    * @param array $objects
 457    *
 458    * @throws \CRM_Core_Exception
 459    * @throws \CiviCRM_API3_Exception
 460    */
 461   public function completeTransaction($input, $ids, $objects) {
 462     CRM_Contribute_BAO_Contribution::completeOrder($input, [
 463       'related_contact' => $ids['related_contact'] ?? NULL,
 464       'participant' => !empty($objects['participant']) ? $objects['participant']->id : NULL,
 465       'contributionRecur' => !empty($objects['contributionRecur']) ? $objects['contributionRecur']->id : NULL,
 466     ], $objects);
 467   }
 468
 469   /**
 470    * @deprecated
 471    * Get site billing ID.
 472    *
 473    * @param array $ids
 474    *
 475    * @return bool
 476    */
 477   public function getBillingID(&$ids) {
 478     CRM_Core_Error::deprecatedFunctionWarning('CRM_Core_BAO_LocationType::getBilling()');
 479     $ids['billing'] = CRM_Core_BAO_LocationType::getBilling();
 480     if (!$ids['billing']) {
 481       CRM_Core_Error::debug_log_message(ts('Please set a location type of %1', [1 => 'Billing']));
 482       echo "Failure: Could not find billing location type<p>";
 483       return FALSE;
 484     }
 485     return TRUE;
 486   }
 487
 488   /**
 489    * @deprecated
 490    *
 491    * @todo confirm this function is not being used by any payment processor outside core & remove.
 492    *
 493    * Note that the compose message part has been moved to contribution
 494    * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it
 495    *
 496    * @param array $input
 497    *   Incoming data from Payment processor.
 498    * @param array $ids
 499    *   Related object IDs.
 500    * @param array $objects
 501    *
 502    * @throws \CiviCRM_API3_Exception
 503    */
 504   public function sendMail($input, $ids, $objects) {
 505     CRM_Core_Error::deprecatedFunctionWarning('this should be done via completetransaction api');
 506     civicrm_api3('Contribution', 'sendconfirmation', [
 507       'id' => $objects['contribution']->id,
 508     ]);
 509   }
 510
 511 }