3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
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 +--------------------------------------------------------------------+
12 use Civi\Api4\Contribution
;
17 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 class CRM_Core_Payment_PayPalProIPN
extends CRM_Core_Payment_BaseIPN
{
22 * Input parameters from payment processor. Store these so that
23 * the code does not need to keep retrieving from the http request
26 protected $_inputParameters = [];
29 * Store for the variables from the invoice string.
32 protected $_invoiceData = [];
35 * Is this a payment express transaction.
38 protected $_isPaymentExpress = FALSE;
41 * Recurring contribution ID.
45 protected $contributionRecurID;
48 * Recurring contribution object.
50 * @var \CRM_Contribute_BAO_ContributionRecur
52 protected $contributionRecurObject;
55 * Get the recurring contribution ID, if any.
59 * @throws \CRM_Core_Exception
61 public function getContributionRecurID(): ?
int {
62 if (!$this->contributionRecurID
&& $this->getValue('r', FALSE)) {
63 $this->contributionRecurID
= (int) $this->getValue('r', FALSE);
65 return $this->contributionRecurID
;
69 * @param int|null $contributionRecurID
71 public function setContributionRecurID(?
int $contributionRecurID): void
{
72 $this->contributionRecurID
= $contributionRecurID;
78 * Are we dealing with an event an 'anything else' (contribute).
82 protected $_component = 'contribute';
85 * Constructor function.
87 * @param array $inputData
88 * Contents of HTTP REQUEST.
90 * @throws CRM_Core_Exception
92 public function __construct($inputData) {
93 $this->setInputParameters($inputData);
94 $this->setInvoiceData();
95 parent
::__construct();
99 * get the values from the rp_invoice_id string.
101 * @param string $name
102 * E.g. i, values are stored in the string with letter codes.
104 * Throw exception if not found
106 * @throws CRM_Core_Exception
109 public function getValue($name, $abort = TRUE) {
110 if ($abort && empty($this->_invoiceData
[$name])) {
111 throw new CRM_Core_Exception("Failure: Missing Parameter $name");
114 return $this->_invoiceData
[$name] ??
NULL;
119 * Set $this->_invoiceData from the input array
121 public function setInvoiceData() {
122 if (empty($this->_inputParameters
['rp_invoice_id'])) {
123 $this->_isPaymentExpress
= TRUE;
126 $rpInvoiceArray = explode('&', $this->_inputParameters
['rp_invoice_id']);
127 // for clarify let's also store without the single letter unreadable
128 //@todo after more refactoring we might ditch storing the one letter stuff
133 'b' => 'contribution_id',
134 'r' => 'contribution_recur_id',
135 'p' => 'participant_id',
138 foreach ($rpInvoiceArray as $rpInvoiceValue) {
139 $rpValueArray = explode('=', $rpInvoiceValue);
140 $this->_invoiceData
[$rpValueArray[0]] = $rpValueArray[1];
141 $this->_inputParameters
[$mapping[$rpValueArray[0]]] = $rpValueArray[1];
142 // p has been overloaded & could mean contribution page or participant id. Clearly we need an
143 // alphabet with more letters.
144 // the mode will always be resolved before the mystery p is reached
145 if ($rpValueArray[1] === 'contribute') {
146 $mapping['p'] = 'contribution_page_id';
149 if (empty($this->_inputParameters
['component'])) {
150 $this->_isPaymentExpress
= TRUE;
155 * @param string $name
156 * Of variable to return.
157 * @param string $type
161 * @param string $location
166 * @throws CRM_Core_Exception
169 public function retrieve($name, $type, $location = 'POST', $abort = TRUE) {
170 $value = CRM_Utils_Type
::validate(
171 CRM_Utils_Array
::value($name, $this->_inputParameters
),
175 if ($abort && $value === NULL) {
176 throw new CRM_Core_Exception("Could not find an entry for $name in $location");
182 * Process recurring contributions.
184 * @param array $input
186 * @param \CRM_Contribute_BAO_ContributionRecur $recur
187 * @param \CRM_Contribute_BAO_Contribution $contribution
190 * @throws \API_Exception
191 * @throws \CRM_Core_Exception
192 * @throws \CiviCRM_API3_Exception
193 * @throws \Civi\API\Exception\UnauthorizedException
195 public function recur($input, $ids, $recur, $contribution, $first) {
196 if (!isset($input['txnType'])) {
197 Civi
::log()->debug('PayPalProIPN: Could not find txn_type in input request.');
198 echo 'Failure: Invalid parameters<p>';
202 // make sure the invoice ids match
203 // make sure the invoice is valid and matches what we have in
204 // the contribution record
205 if ($recur->invoice_id
!= $input['invoice']) {
206 Civi
::log()->debug('PayPalProIPN: Invoice values dont match between database and IPN request recur is ' . $recur->invoice_id
. ' input is ' . $input['invoice']);
207 echo 'Failure: Invoice values dont match between database and IPN request recur is ' . $recur->invoice_id
. " input is " . $input['invoice'];
211 $now = date('YmdHis');
213 $sendNotification = FALSE;
214 $subscriptionPaymentStatus = NULL;
215 //List of Transaction Type
217 recurring_payment_profile_created RP Profile Created
218 recurring_payment RP Successful Payment
219 recurring_payment_failed RP Failed Payment
220 recurring_payment_profile_cancel RP Profile Cancelled
221 recurring_payment_expired RP Profile Expired
222 recurring_payment_skipped RP Profile Skipped
223 recurring_payment_outstanding_payment RP Successful Outstanding Payment
224 recurring_payment_outstanding_payment_failed RP Failed Outstanding Payment
225 recurring_payment_suspended RP Profile Suspended
226 recurring_payment_suspended_due_to_max_failed_payment RP Profile Suspended due to Max Failed Payment
229 //set transaction type
230 $txnType = $this->retrieve('txn_type', 'String');
231 //Changes for paypal pro recurring payment
232 $contributionStatuses = array_flip(CRM_Contribute_BAO_Contribution
::buildOptions('contribution_status_id', 'validate'));
234 case 'recurring_payment_profile_created':
235 if (in_array($recur->contribution_status_id
, [
236 $contributionStatuses['Pending'],
237 $contributionStatuses['In Progress'],
239 && !empty($recur->processor_id
)
241 echo "already handled";
244 $recur->create_date
= $now;
245 $recur->contribution_status_id
= $contributionStatuses['Pending'];
246 $recur->processor_id
= $this->retrieve('recurring_payment_id', 'String');
247 $recur->trxn_id
= $recur->processor_id
;
248 $subscriptionPaymentStatus = CRM_Core_Payment
::RECURRING_PAYMENT_START
;
249 $sendNotification = TRUE;
252 case 'recurring_payment':
254 $recur->start_date
= $now;
257 if ($input['paymentStatus'] !== 'Completed') {
258 throw new CRM_Core_Exception("Ignore all IPN payments that are not completed");
261 // In future moving to create pending & then complete, but this OK for now.
262 // Also consider accepting 'Failed' like other processors.
263 $input['contribution_status_id'] = $contributionStatuses['Completed'];
264 $input['invoice_id'] = md5(uniqid(rand(), TRUE));
265 $input['original_contribution_id'] = $ids['contribution'];
266 $input['contribution_recur_id'] = $this->getContributionRecurID();
268 civicrm_api3('Contribution', 'repeattransaction', $input);
272 //contribution installment is completed
273 if ($this->retrieve('profile_status', 'String') == 'Expired') {
274 if (!empty($recur->end_date
)) {
275 echo "already handled";
278 $recur->contribution_status_id
= $contributionStatuses['Completed'];
279 $recur->end_date
= $now;
280 $sendNotification = TRUE;
281 $subscriptionPaymentStatus = CRM_Core_Payment
::RECURRING_PAYMENT_END
;
284 // make sure the contribution status is not done
285 // since order of ipn's is unknown
286 if ($recur->contribution_status_id
!= $contributionStatuses['Completed']) {
287 $recur->contribution_status_id
= $contributionStatuses['In Progress'];
294 if ($sendNotification) {
295 //send recurring Notification email for user
296 CRM_Contribute_BAO_ContributionPage
::recurringNotify(
297 $ids['contribution'],
298 $subscriptionPaymentStatus,
303 if ($txnType !== 'recurring_payment') {
307 // CRM-13737 - am not aware of any reason why payment_date would not be set - this if is a belt & braces
308 $contribution->receive_date
= !empty($input['payment_date']) ?
date('YmdHis', strtotime($input['payment_date'])) : $now;
310 $this->single($input, $contribution, TRUE, $first);
314 * @param array $input
315 * @param \CRM_Contribute_BAO_Contribution $contribution
320 * @throws \API_Exception
321 * @throws \CRM_Core_Exception
322 * @throws \CiviCRM_API3_Exception
323 * @throws \Civi\API\Exception\UnauthorizedException
325 public function single($input, $contribution, $recur = FALSE, $first = FALSE) {
327 // make sure the invoice is valid and matches what we have in the contribution record
328 if ((!$recur) ||
($recur && $first)) {
329 if ($contribution->invoice_id
!= $input['invoice']) {
330 Civi
::log()->debug('PayPalProIPN: Invoice values dont match between database and IPN request.');
331 echo "Failure: Invoice values dont match between database and IPN request<p>contribution is" . $contribution->invoice_id
. " and input is " . $input['invoice'];
336 $contribution->invoice_id
= md5(uniqid(rand(), TRUE));
340 if ($contribution->total_amount
!= $input['amount']) {
341 Civi
::log()->debug('PayPalProIPN: Amount values dont match between database and IPN request.');
342 echo "Failure: Amount values dont match between database and IPN request<p>";
347 $contribution->total_amount
= $input['amount'];
350 $status = $input['paymentStatus'];
351 if ($status === 'Denied' ||
$status === 'Failed' ||
$status === 'Voided') {
352 Contribution
::update(FALSE)->setValues([
353 'cancel_date' => 'now',
354 'contribution_status_id:name' => 'Failed',
355 ])->addWhere('id', '=', $contribution->id
)->execute();
356 Civi
::log()->debug("Setting contribution status to Failed");
359 if ($status === 'Pending') {
360 Civi
::log()->debug('Returning since contribution status is Pending');
363 if ($status === 'Refunded' ||
$status === 'Reversed') {
364 Contribution
::update(FALSE)->setValues([
365 'cancel_date' => 'now',
366 'contribution_status_id:name' => 'Cancelled',
367 ])->addWhere('id', '=', $contribution->id
)->execute();
368 Civi
::log()->debug("Setting contribution status to Cancelled");
371 elseif ($status !== 'Completed') {
372 Civi
::log()->debug('Returning since contribution status is not handled');
376 // check if contribution is already completed, if so we ignore this ipn
377 $completedStatusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
378 if ($contribution->contribution_status_id
== $completedStatusId) {
379 Civi
::log()->debug('PayPalProIPN: Returning since contribution has already been handled.');
380 echo 'Success: Contribution has already been handled<p>';
384 CRM_Contribute_BAO_Contribution
::completeOrder($input, $this->getContributionRecurID(), $contribution->id ??
NULL);
388 * Gets PaymentProcessorID for PayPal
392 public function getPayPalPaymentProcessorID() {
393 // This is an unreliable method as there could be more than one instance.
394 // Recommended approach is to use the civicrm/payment/ipn/xx url where xx is the payment
395 // processor id & the handleNotification function (which should call the completetransaction api & by-pass this
396 // entirely). The only thing the IPN class should really do is extract data from the request, validate it
397 // & call completetransaction or call fail? (which may not exist yet).
399 Civi
::log()->warning('Unreliable method used to get payment_processor_id for PayPal Pro IPN - this will cause problems if you have more than one instance');
401 $paymentProcessorTypeID = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_PaymentProcessorType',
402 'PayPal', 'id', 'name'
404 return (int) civicrm_api3('PaymentProcessor', 'getvalue', [
406 'options' => ['limit' => 1],
407 'payment_processor_type_id' => $paymentProcessorTypeID,
414 * This is the main function to call. It should be sufficient to instantiate the class
415 * (with the input parameters) & call this & all will be done
417 * @todo the references to POST throughout this class need to be removed
420 public function main() {
421 CRM_Core_Error
::debug_var('GET', $_GET, TRUE, TRUE);
422 CRM_Core_Error
::debug_var('POST', $_POST, TRUE, TRUE);
425 if ($this->_isPaymentExpress
) {
426 $this->handlePaymentExpress();
429 $this->_component
= $input['component'] = self
::getValue('m');
430 $input['invoice'] = self
::getValue('i', TRUE);
431 // get the contribution and contact ids from the GET params
432 $ids['contact'] = self
::getValue('c', TRUE);
433 $ids['contribution'] = self
::getValue('b', TRUE);
435 $this->getInput($input);
437 if ($this->_component
== 'event') {
438 $ids['event'] = self
::getValue('e', TRUE);
439 $ids['participant'] = self
::getValue('p', TRUE);
440 $ids['contributionRecur'] = $this->getContributionRecurID();
443 // get the optional ids
444 //@ how can this not be broken retrieving from GET as we are dealing with a POST request?
445 // copy & paste? Note the retrieve function now uses data from _REQUEST so this will be included
446 $ids['membership'] = self
::retrieve('membershipID', 'Integer', 'GET', FALSE);
447 $ids['contributionRecur'] = $this->getContributionRecurID();
448 $ids['contributionPage'] = self
::getValue('p', FALSE);
449 $ids['related_contact'] = self
::retrieve('relatedContactID', 'Integer', 'GET', FALSE);
450 $ids['onbehalf_dupe_alert'] = self
::retrieve('onBehalfDupeAlert', 'Integer', 'GET', FALSE);
453 if (!$ids['membership'] && $this->getContributionRecurID()) {
456 FROM civicrm_membership m
457 INNER JOIN civicrm_membership_payment mp ON m.id = mp.membership_id AND mp.contribution_id = %1
458 WHERE m.contribution_recur_id = %2
461 1 => [$ids['contribution'], 'Integer'],
462 2 => [$this->getContributionRecurID(), 'Integer'],
464 if ($membershipId = CRM_Core_DAO
::singleValueQuery($sql, $sqlParams)) {
465 $ids['membership'] = $membershipId;
469 $paymentProcessorID = CRM_Utils_Array
::value('processor_id', $this->_inputParameters
);
470 if (!$paymentProcessorID) {
471 $paymentProcessorID = self
::getPayPalPaymentProcessorID();
474 // Check if the contribution exists
475 // make sure contribution exists and is valid
476 $contribution = new CRM_Contribute_BAO_Contribution();
477 $contribution->id
= $ids['contribution'];
478 if (!$contribution->find(TRUE)) {
479 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)]);
482 // make sure contact exists and is valid
483 // use the contact id from the contribution record as the id in the IPN may not be valid anymore.
484 $contact = new CRM_Contact_BAO_Contact();
485 $contact->id
= $contribution->contact_id
;
486 $contact->find(TRUE);
487 if ($contact->id
!= $ids['contact']) {
488 // 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
489 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");
490 echo "WARNING: Could not find contact record: {$ids['contact']}<p>";
491 $ids['contact'] = $contribution->contact_id
;
494 // CRM-19478: handle oddity when p=null is set in place of contribution page ID,
495 if (!empty($ids['contributionPage']) && !is_numeric($ids['contributionPage'])) {
496 // We don't need to worry if about removing contribution page id as it will be set later in
497 // CRM_Contribute_BAO_Contribution::loadRelatedObjects(..) using $objects['contribution']->contribution_page_id
498 unset($ids['contributionPage']);
501 $ids['paymentProcessor'] = $paymentProcessorID;
502 $contribution->loadRelatedObjects($input, $ids);
504 $input['payment_processor_id'] = $paymentProcessorID;
506 if ($this->getContributionRecurID()) {
507 $contributionRecur = $this->getContributionRecurObject();
508 // check if first contribution is completed, else complete first contribution
510 $completedStatusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
511 if ($contribution->contribution_status_id
== $completedStatusId) {
514 $this->recur($input, $ids, $contributionRecur, $contribution, $first);
518 $this->single($input, $contribution, FALSE, FALSE);
520 catch (CRM_Core_Exception
$e) {
521 Civi
::log()->debug($e->getMessage() . ' input {input}', ['input' => $input]);
522 echo 'Invalid or missing data';
527 * @param array $input
530 * @throws CRM_Core_Exception
532 public function getInput(&$input) {
533 $billingID = CRM_Core_BAO_LocationType
::getBilling();
535 $input['txnType'] = self
::retrieve('txn_type', 'String', 'POST', FALSE);
536 $input['paymentStatus'] = self
::retrieve('payment_status', 'String', 'POST', FALSE);
538 $input['amount'] = self
::retrieve('mc_gross', 'Money', 'POST', FALSE);
539 $input['reasonCode'] = self
::retrieve('ReasonCode', 'String', 'POST', FALSE);
542 "first_name" => 'first_name',
543 "last_name" => 'last_name',
544 "street_address-{$billingID}" => 'address_street',
545 "city-{$billingID}" => 'address_city',
546 "state-{$billingID}" => 'address_state',
547 "postal_code-{$billingID}" => 'address_zip',
548 "country-{$billingID}" => 'address_country_code',
550 foreach ($lookup as $name => $paypalName) {
551 $value = self
::retrieve($paypalName, 'String', 'POST', FALSE);
552 $input[$name] = $value ?
$value : NULL;
555 $input['is_test'] = self
::retrieve('test_ipn', 'Integer', 'POST', FALSE);
556 $input['fee_amount'] = self
::retrieve('mc_fee', 'Money', 'POST', FALSE);
557 $input['net_amount'] = self
::retrieve('settle_amount', 'Money', 'POST', FALSE);
558 $input['trxn_id'] = self
::retrieve('txn_id', 'String', 'POST', FALSE);
559 $input['payment_date'] = $input['receive_date'] = self
::retrieve('payment_date', 'String', 'POST', FALSE);
560 $input['total_amount'] = $input['amount'];
564 * Handle payment express IPNs.
566 * For one off IPNS no actual response is required
567 * Recurring is more difficult as we have limited confirmation material
568 * lets look up invoice id in recur_contribution & rely on the unique transaction id to ensure no
570 * this may not be acceptable to all sites - e.g. if they are shipping or delivering something in return
571 * then the quasi security of the ids array might be required - although better to
572 * http://stackoverflow.com/questions/4848227/validate-that-ipn-call-is-from-paypal
573 * but let's assume knowledge on invoice id & schedule is enough for now esp for donations
574 * only contribute is handled
576 public function handlePaymentExpress() {
577 //@todo - loads of copy & paste / code duplication but as this not going into core need to try to
579 // also note that a lot of the complexity above could be removed if we used
580 // http://stackoverflow.com/questions/4848227/validate-that-ipn-call-is-from-paypal
581 // as membership id etc can be derived by the load objects fn
582 $objects = $ids = $input = [];
584 $input['invoice'] = self
::getValue('i', FALSE);
585 //Avoid return in case of unit test.
586 if (empty($input['invoice']) && empty($this->_inputParameters
['is_unit_test'])) {
589 $input['txnType'] = $this->retrieve('txn_type', 'String');
590 $contributionRecur = civicrm_api3('contribution_recur', 'getsingle', [
591 'return' => 'contact_id, id, payment_processor_id',
592 'invoice_id' => $input['invoice'],
594 $this->setContributionRecurID((int) $contributionRecur['id']);
596 if ($input['txnType'] !== 'recurring_payment' && $input['txnType'] !== 'recurring_payment_profile_created') {
597 throw new CRM_Core_Exception('Paypal IPNS not handled other than recurring_payments');
600 $this->getInput($input, $ids);
601 if ($input['txnType'] === 'recurring_payment' && $this->transactionExists($input['trxn_id'])) {
602 throw new CRM_Core_Exception('This transaction has already been processed');
605 $ids['contact'] = $contributionRecur['contact_id'];
606 $ids['contributionRecur'] = $this->getContributionRecurID();
607 $result = civicrm_api3('contribution', 'getsingle', ['invoice_id' => $input['invoice'], 'contribution_test' => '']);
609 $ids['contribution'] = $result['id'];
610 //@todo hardcoding 'pending' for now
611 $pendingStatusId = CRM_Core_PseudoConstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
612 if ($result['contribution_status_id'] == $pendingStatusId) {
615 // arg api won't get this - fix it
616 $ids['contributionPage'] = CRM_Core_DAO
::singleValueQuery("SELECT contribution_page_id FROM civicrm_contribution WHERE invoice_id = %1", [
618 $ids['contribution'],
622 // only handle component at this stage - not terribly sure how a recurring event payment would arise
623 // & suspec main function may be a victom of copy & paste
624 // membership would be an easy add - but not relevant to my customer...
625 $this->_component
= $input['component'] = 'contribute';
626 $input['trxn_date'] = date('Y-m-d H:i:s', strtotime(self
::retrieve('time_created', 'String')));
627 $paymentProcessorID = $contributionRecur['payment_processor_id'];
629 // Check if the contribution exists
630 // make sure contribution exists and is valid
631 $contribution = new CRM_Contribute_BAO_Contribution();
632 $contribution->id
= $ids['contribution'];
633 if (!$contribution->find(TRUE)) {
634 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)]);
637 $objects['contribution'] = &$contribution;
639 // CRM-19478: handle oddity when p=null is set in place of contribution page ID,
640 if (!empty($ids['contributionPage']) && !is_numeric($ids['contributionPage'])) {
641 // We don't need to worry if about removing contribution page id as it will be set later in
642 // CRM_Contribute_BAO_Contribution::loadRelatedObjects(..) using $objects['contribution']->contribution_page_id
643 unset($ids['contributionPage']);
646 $contribution = &$objects['contribution'];
647 $ids['paymentProcessor'] = $paymentProcessorID;
648 $contribution->loadRelatedObjects($input, $ids);
649 $objects = array_merge($objects, $contribution->_relatedObjects
);
651 $this->recur($input, $ids, $this->getContributionRecurObject(), $objects['contribution'], $isFirst);
655 * Function check if transaction already exists.
656 * @param string $trxn_id
659 public function transactionExists($trxn_id) {
660 if (CRM_Core_DAO
::singleValueQuery("SELECT count(*) FROM civicrm_contribution WHERE trxn_id = %1",
662 1 => [$trxn_id, 'String'],
670 * Get the recurring contribution object.
672 * @return \CRM_Contribute_BAO_ContributionRecur
673 * @throws \CRM_Core_Exception
675 protected function getContributionRecurObject(): CRM_Contribute_BAO_ContributionRecur
{
676 if (!$this->contributionRecurObject
) {
677 $contributionRecur = new CRM_Contribute_BAO_ContributionRecur();
678 $contributionRecur->id
= $this->getContributionRecurID();
679 if (!$contributionRecur->find(TRUE)) {
680 throw new CRM_Core_Exception('Failure: Could not find contribution recur record');
682 return $this->contributionRecurObject
= $contributionRecur;
684 return $this->contributionRecurObject
;