CRM/Core/Payment/PayPalIPN.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_PayPalIPN 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    * Constructor function.
  30    *
  31    * @param array $inputData
  32    *   Contents of HTTP REQUEST.
  33    *
  34    * @throws CRM_Core_Exception
  35    */
  36   public function __construct($inputData) {
  37     // CRM-19676
  38     $params = (!empty($inputData['custom'])) ?
  39       array_merge($inputData, json_decode($inputData['custom'], TRUE)) :
  40       $inputData;
  41     $this->setInputParameters($params);
  42     parent::__construct();
  43   }
  44
  45   /**
  46    * @param string $name
  47    * @param string $type
  48    * @param bool $abort
  49    *
  50    * @return mixed
  51    * @throws \CRM_Core_Exception
  52    */
  53   public function retrieve($name, $type, $abort = TRUE) {
  54     $value = CRM_Utils_Type::validate(CRM_Utils_Array::value($name, $this->_inputParameters), $type, FALSE);
  55     if ($abort && $value === NULL) {
  56       throw new CRM_Core_Exception("PayPalIPN: Could not find an entry for $name");
  57     }
  58     return $value;
  59   }
  60
  61   /**
  62    * @param array $input
  63    * @param CRM_Contribute_BAO_ContributionRecur $recur
  64    * @param CRM_Contribute_BAO_Contribution $contribution
  65    * @param bool $first
  66    *
  67    * @return void
  68    *
  69    * @throws \CRM_Core_Exception
  70    * @throws \CiviCRM_API3_Exception
  71    */
  72   public function recur($input, $recur, $contribution, $first) {
  73
  74     // make sure the invoice ids match
  75     // make sure the invoice is valid and matches what we have in the contribution record
  76     if ($recur->invoice_id != $input['invoice']) {
  77       Civi::log()->debug('PayPalIPN: Invoice values dont match between database and IPN request (RecurID: ' . $recur->id . ').');
  78       throw new CRM_Core_Exception("Failure: Invoice values dont match between database and IPN request");
  79     }
  80
  81     $now = date('YmdHis');
  82
  83     // set transaction type
  84     $contributionStatuses = array_flip(CRM_Contribute_BAO_Contribution::buildOptions('contribution_status_id', 'validate'));
  85     switch ($this->getTrxnType()) {
  86       case 'subscr_signup':
  87         $recur->create_date = $now;
  88         // sometimes subscr_signup response come after the subscr_payment and set to pending mode.
  89
  90         $statusID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionRecur',
  91           $recur->id, 'contribution_status_id'
  92         );
  93         if ($statusID != $contributionStatuses['In Progress']) {
  94           $recur->contribution_status_id = $contributionStatuses['Pending'];
  95         }
  96         $recur->processor_id = $this->retrieve('subscr_id', 'String');
  97         $recur->trxn_id = $recur->processor_id;
  98         $recur->save();
  99         return;
 100
 101       case 'subscr_eot':
 102         if ($recur->contribution_status_id != $contributionStatuses['Cancelled']) {
 103           $recur->contribution_status_id = $contributionStatuses['Completed'];
 104         }
 105         $recur->end_date = $now;
 106         $recur->save();
 107         return;
 108
 109       case 'subscr_cancel':
 110         $recur->contribution_status_id = $contributionStatuses['Cancelled'];
 111         $recur->cancel_date = $now;
 112         $recur->save();
 113         return;
 114
 115       case 'subscr_failed':
 116         $recur->contribution_status_id = $contributionStatuses['Failed'];
 117         $recur->modified_date = $now;
 118         $recur->save();
 119         break;
 120
 121       case 'subscr_modify':
 122         Civi::log()->debug('PayPalIPN: We do not handle modifications to subscriptions right now  (RecurID: ' . $recur->id . ').');
 123         echo "Failure: We do not handle modifications to subscriptions right now<p>";
 124         return;
 125
 126     }
 127
 128     if ($this->getTrxnType() !== 'subscr_payment') {
 129       return;
 130     }
 131     if ($input['paymentStatus'] !== 'Completed') {
 132       Civi::log()->debug('PayPalIPN: Ignore all IPN payments that are not completed');
 133       echo 'Failure: Invalid parameters<p>';
 134       return;
 135     }
 136
 137     if (!$first) {
 138       // check if this contribution transaction is already processed
 139       // if not create a contribution and then get it processed
 140       $contribution = new CRM_Contribute_BAO_Contribution();
 141       $contribution->trxn_id = $input['trxn_id'];
 142       if ($contribution->trxn_id && $contribution->find()) {
 143         Civi::log()->debug('PayPalIPN: Returning since contribution has already been handled (trxn_id: ' . $contribution->trxn_id . ')');
 144         echo 'Success: Contribution has already been handled<p>';
 145         return;
 146       }
 147
 148       if ($input['paymentStatus'] !== 'Completed') {
 149         throw new CRM_Core_Exception("Ignore all IPN payments that are not completed");
 150       }
 151
 152       // In future moving to create pending & then complete, but this OK for now.
 153       // Also consider accepting 'Failed' like other processors.
 154       $input['contribution_status_id'] = $contributionStatuses['Completed'];
 155       $input['original_contribution_id'] = $contribution->id;
 156       $input['contribution_recur_id'] = $recur->id;
 157
 158       civicrm_api3('Contribution', 'repeattransaction', $input);
 159       return;
 160     }
 161
 162     $this->single($input, $contribution, TRUE);
 163   }
 164
 165   /**
 166    * @param array $input
 167    * @param \CRM_Contribute_BAO_Contribution $contribution
 168    * @param bool $recur
 169    *
 170    * @return void
 171    * @throws \CRM_Core_Exception
 172    * @throws \CiviCRM_API3_Exception
 173    */
 174   public function single($input, $contribution, $recur = FALSE) {
 175
 176     // make sure the invoice is valid and matches what we have in the contribution record
 177     if ($contribution->invoice_id != $input['invoice']) {
 178       Civi::log()->debug('PayPalIPN: Invoice values dont match between database and IPN request. (ID: ' . $contribution->id . ').');
 179       echo "Failure: Invoice values dont match between database and IPN request<p>";
 180       return;
 181     }
 182
 183     if (!$recur) {
 184       if ($contribution->total_amount != $input['amount']) {
 185         Civi::log()->debug('PayPalIPN: Amount values dont match between database and IPN request. (ID: ' . $contribution->id . ').');
 186         echo "Failure: Amount values dont match between database and IPN request<p>";
 187         return;
 188       }
 189     }
 190     else {
 191       $contribution->total_amount = $input['amount'];
 192     }
 193
 194     // check if contribution is already completed, if so we ignore this ipn
 195     $completedStatusId = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
 196     if ($contribution->contribution_status_id == $completedStatusId) {
 197       Civi::log()->debug('PayPalIPN: Returning since contribution has already been handled. (ID: ' . $contribution->id . ').');
 198       echo 'Success: Contribution has already been handled<p>';
 199       return;
 200     }
 201
 202     CRM_Contribute_BAO_Contribution::completeOrder($input, $this->getContributionRecurID(), $contribution->id ?? NULL);
 203   }
 204
 205   /**
 206    * Main function.
 207    *
 208    * @throws \API_Exception
 209    * @throws \CiviCRM_API3_Exception
 210    * @throws \Civi\API\Exception\UnauthorizedException
 211    */
 212   public function main() {
 213     try {
 214       $input = [];
 215       $component = $this->retrieve('module', 'String');
 216       $input['component'] = $component;
 217
 218       $contributionID = $this->getContributionID();
 219       $this->getInput($input);
 220
 221       $paymentProcessorID = $this->getPayPalPaymentProcessorID($input, $this->getContributionRecurID());
 222
 223       Civi::log()->debug('PayPalIPN: Received (ContactID: ' . $this->getContactID() . '; trxn_id: ' . $input['trxn_id'] . ').');
 224       $contribution = $this->getContribution();
 225
 226       $input['payment_processor_id'] = $paymentProcessorID;
 227
 228       if ($this->getContributionRecurID()) {
 229         $contributionRecur = new CRM_Contribute_BAO_ContributionRecur();
 230         $contributionRecur->id = $this->getContributionRecurID();
 231         if (!$contributionRecur->find(TRUE)) {
 232           throw new CRM_Core_Exception('Could not find contribution recur record');
 233         }
 234         // check if first contribution is completed, else complete first contribution
 235         $first = TRUE;
 236         $completedStatusId = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
 237         if ($contribution->contribution_status_id == $completedStatusId) {
 238           $first = FALSE;
 239         }
 240         $this->recur($input, $contributionRecur, $contribution, $first);
 241         if ($this->getFirstOrLastInSeriesStatus()) {
 242           //send recurring Notification email for user
 243           CRM_Contribute_BAO_ContributionPage::recurringNotify(
 244             $contributionID,
 245             $this->getFirstOrLastInSeriesStatus(),
 246             $contributionRecur
 247           );
 248         }
 249         return;
 250       }
 251
 252       $status = $input['paymentStatus'];
 253       if ($status === 'Denied' || $status === 'Failed' || $status === 'Voided') {
 254         Contribution::update(FALSE)->setValues([
 255           'cancel_date' => 'now',
 256           'contribution_status_id:name' => 'Failed',
 257         ])->addWhere('id', '=', $contributionID)->execute();
 258         Civi::log()->debug("Setting contribution status to Failed");
 259         return;
 260       }
 261       if ($status === 'Pending') {
 262         Civi::log()->debug('Returning since contribution status is Pending');
 263         return;
 264       }
 265       if ($status === 'Refunded' || $status === 'Reversed') {
 266         Contribution::update(FALSE)->setValues([
 267           'cancel_date' => 'now',
 268           'contribution_status_id:name' => 'Cancelled',
 269         ])->addWhere('id', '=', $contributionID)->execute();
 270         Civi::log()->debug("Setting contribution status to Cancelled");
 271         return;
 272       }
 273       if ($status !== 'Completed') {
 274         Civi::log()->debug('Returning since contribution status is not handled');
 275         return;
 276       }
 277       $this->single($input, $contribution);
 278     }
 279     catch (CRM_Core_Exception $e) {
 280       Civi::log()->debug($e->getMessage() . ' input {input}', ['input' => $input]);
 281       echo 'Invalid or missing data';
 282     }
 283   }
 284
 285   /**
 286    * @param array $input
 287    *
 288    * @throws \CRM_Core_Exception
 289    */
 290   public function getInput(&$input) {
 291     $billingID = CRM_Core_BAO_LocationType::getBilling();
 292     $input['paymentStatus'] = $this->retrieve('payment_status', 'String', FALSE);
 293     $input['invoice'] = $this->retrieve('invoice', 'String', TRUE);
 294     $input['amount'] = $this->retrieve('mc_gross', 'Money', FALSE);
 295     $input['reasonCode'] = $this->retrieve('ReasonCode', 'String', FALSE);
 296
 297     $lookup = [
 298       "first_name" => 'first_name',
 299       "last_name" => 'last_name',
 300       "street_address-{$billingID}" => 'address_street',
 301       "city-{$billingID}" => 'address_city',
 302       "state-{$billingID}" => 'address_state',
 303       "postal_code-{$billingID}" => 'address_zip',
 304       "country-{$billingID}" => 'address_country_code',
 305     ];
 306     foreach ($lookup as $name => $paypalName) {
 307       $value = $this->retrieve($paypalName, 'String', FALSE);
 308       $input[$name] = $value ? $value : NULL;
 309     }
 310
 311     $input['is_test'] = $this->retrieve('test_ipn', 'Integer', FALSE);
 312     $input['fee_amount'] = $this->retrieve('mc_fee', 'Money', FALSE);
 313     $input['net_amount'] = $this->retrieve('settle_amount', 'Money', FALSE);
 314     $input['trxn_id'] = $this->retrieve('txn_id', 'String', FALSE);
 315
 316     $paymentDate = $this->retrieve('payment_date', 'String', FALSE);
 317     if (!empty($paymentDate)) {
 318       $receiveDateTime = new DateTime($paymentDate);
 319       /**
 320        * The `payment_date` that Paypal sends back is in their timezone. Example return: 08:23:05 Jan 11, 2019 PST
 321        * Subsequently, we need to account for that, otherwise the recieve time will be incorrect for the local system
 322        */
 323       $input['receive_date'] = CRM_Utils_Date::convertDateToLocalTime($receiveDateTime);
 324     }
 325   }
 326
 327   /**
 328    * Get PaymentProcessorID for PayPal
 329    *
 330    * @param array $input
 331    * @param int|null $contributionRecurID
 332    *
 333    * @return int
 334    * @throws \CRM_Core_Exception
 335    * @throws \CiviCRM_API3_Exception
 336    */
 337   public function getPayPalPaymentProcessorID(array $input, ?int $contributionRecurID): int {
 338     // First we try and retrieve from POST params
 339     $paymentProcessorID = $this->retrieve('processor_id', 'Integer', FALSE);
 340     if (!empty($paymentProcessorID)) {
 341       return $paymentProcessorID;
 342     }
 343
 344     // Then we try and get it from recurring contribution ID
 345     if ($contributionRecurID) {
 346       $contributionRecur = civicrm_api3('ContributionRecur', 'getsingle', [
 347         'id' => $contributionRecurID,
 348         'return' => ['payment_processor_id'],
 349       ]);
 350       if (!empty($contributionRecur['payment_processor_id'])) {
 351         return $contributionRecur['payment_processor_id'];
 352       }
 353     }
 354
 355     // This is an unreliable method as there could be more than one instance.
 356     // Recommended approach is to use the civicrm/payment/ipn/xx url where xx is the payment
 357     // processor id & the handleNotification function (which should call the completetransaction api & by-pass this
 358     // entirely). The only thing the IPN class should really do is extract data from the request, validate it
 359     // & call completetransaction or call fail? (which may not exist yet).
 360
 361     Civi::log()->warning('Unreliable method used to get payment_processor_id for PayPal IPN - this will cause problems if you have more than one instance');
 362     // Then we try and retrieve based on business email ID
 363     $paymentProcessorTypeID = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_PaymentProcessorType', 'PayPal_Standard', 'id', 'name');
 364     $processorParams = [
 365       'user_name' => $this->retrieve('business', 'String', FALSE),
 366       'payment_processor_type_id' => $paymentProcessorTypeID,
 367       'is_test' => empty($input['is_test']) ? 0 : 1,
 368       'options' => ['limit' => 1],
 369       'return' => ['id'],
 370     ];
 371     $paymentProcessorID = civicrm_api3('PaymentProcessor', 'getvalue', $processorParams);
 372     if (empty($paymentProcessorID)) {
 373       throw new CRM_Core_Exception('PayPalIPN: Could not get Payment Processor ID');
 374     }
 375     return (int) $paymentProcessorID;
 376   }
 377
 378   /**
 379    * @return mixed
 380    * @throws \CRM_Core_Exception
 381    */
 382   protected function getTrxnType() {
 383     return $this->retrieve('txn_type', 'String');
 384   }
 385
 386   /**
 387    * Get status code for first or last recurring in the series.
 388    *
 389    * If this is the first or last then return the status code, else
 390    * null.
 391    *
 392    * @return string|null
 393    * @throws \CRM_Core_Exception
 394    */
 395   protected function getFirstOrLastInSeriesStatus(): ?string {
 396     $subscriptionPaymentStatus = NULL;
 397     if ($this->getTrxnType() === 'subscr_signup') {
 398       return CRM_Core_Payment::RECURRING_PAYMENT_START;
 399     }
 400     if ($this->getTrxnType() === 'subscr_eot') {
 401       return CRM_Core_Payment::RECURRING_PAYMENT_END;
 402     }
 403     return NULL;
 404   }
 405
 406   /**
 407    * Get the recurring contribution ID.
 408    *
 409    * @return int|null
 410    *
 411    * @throws \CRM_Core_Exception
 412    */
 413   protected function getContributionRecurID(): ?int {
 414     $id = $this->retrieve('contributionRecurID', 'Integer', FALSE);
 415     return $id ? (int) $id : NULL;
 416   }
 417
 418   /**
 419    * Get Contribution ID.
 420    *
 421    * @return int
 422    *
 423    * @throws \CRM_Core_Exception
 424    */
 425   protected function getContributionID(): int {
 426     return (int) $this->retrieve('contributionID', 'Integer', TRUE);
 427   }
 428
 429   /**
 430    * Get contact id from parameters.
 431    *
 432    * @return int
 433    *
 434    * @throws \CRM_Core_Exception
 435    */
 436   protected function getContactID(): int {
 437     return (int) $this->retrieve('contactID', 'Integer', TRUE);
 438   }
 439
 440   /**
 441    * Get the contribution object.
 442    *
 443    * @return \CRM_Contribute_BAO_Contribution
 444    * @throws \CRM_Core_Exception
 445    */
 446   protected function getContribution(): CRM_Contribute_BAO_Contribution {
 447     $contribution = new CRM_Contribute_BAO_Contribution();
 448     $contribution->id = $this->getContributionID();
 449     if (!$contribution->find(TRUE)) {
 450       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: "]);
 451     }
 452     if ($contribution->contact_id !== $this->getContactID()) {
 453       CRM_Core_Error::debug_log_message("Contact ID in IPN not found but contact_id found in contribution.");
 454     }
 455     return $contribution;
 456   }
 457
 458 }