CRM/Core/Payment/BaseIPN.php

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