3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2018
33 class CRM_Core_Payment_PayPalProIPN
extends CRM_Core_Payment_BaseIPN
{
35 static $_paymentProcessor = NULL;
38 * Input parameters from payment processor. Store these so that
39 * the code does not need to keep retrieving from the http request
42 protected $_inputParameters = array();
45 * Store for the variables from the invoice string.
48 protected $_invoiceData = array();
51 * Is this a payment express transaction.
53 protected $_isPaymentExpress = FALSE;
56 * Are we dealing with an event an 'anything else' (contribute)
57 * @var string component
59 protected $_component = 'contribute';
62 * Constructor function.
64 * @param array $inputData
65 * Contents of HTTP REQUEST.
67 * @throws CRM_Core_Exception
69 public function __construct($inputData) {
70 $this->setInputParameters($inputData);
71 $this->setInvoiceData();
72 parent
::__construct();
76 * get the values from the rp_invoice_id string.
79 * E.g. i, values are stored in the string with letter codes.
81 * Throw exception if not found
83 * @throws CRM_Core_Exception
86 public function getValue($name, $abort = TRUE) {
87 if ($abort && empty($this->_invoiceData
[$name])) {
88 throw new CRM_Core_Exception("Failure: Missing Parameter $name");
91 return CRM_Utils_Array
::value($name, $this->_invoiceData
);
96 * Set $this->_invoiceData from the input array
98 public function setInvoiceData() {
99 if (empty($this->_inputParameters
['rp_invoice_id'])) {
100 $this->_isPaymentExpress
= TRUE;
103 $rpInvoiceArray = explode('&', $this->_inputParameters
['rp_invoice_id']);
104 // for clarify let's also store without the single letter unreadable
105 //@todo after more refactoring we might ditch storing the one letter stuff
110 'b' => 'contribution_id',
111 'r' => 'contribution_recur_id',
112 'p' => 'participant_id',
115 foreach ($rpInvoiceArray as $rpInvoiceValue) {
116 $rpValueArray = explode('=', $rpInvoiceValue);
117 $this->_invoiceData
[$rpValueArray[0]] = $rpValueArray[1];
118 $this->_inputParameters
[$mapping[$rpValueArray[0]]] = $rpValueArray[1];
119 // p has been overloaded & could mean contribution page or participant id. Clearly we need an
120 // alphabet with more letters.
121 // the mode will always be resolved before the mystery p is reached
122 if ($rpValueArray[1] == 'contribute') {
123 $mapping['p'] = 'contribution_page_id';
126 if (empty($this->_inputParameters
['component'])) {
127 $this->_isPaymentExpress
= TRUE;
132 * @param string $name
133 * Of variable to return.
134 * @param string $type
138 * @param string $location
143 * @throws CRM_Core_Exception
146 public function retrieve($name, $type, $location = 'POST', $abort = TRUE) {
147 $value = CRM_Utils_Type
::validate(
148 CRM_Utils_Array
::value($name, $this->_inputParameters
),
152 if ($abort && $value === NULL) {
153 throw new CRM_Core_Exception("Could not find an entry for $name in $location");
159 * Process recurring contributions.
160 * @param array $input
162 * @param array $objects
166 public function recur(&$input, &$ids, &$objects, $first) {
167 if (!isset($input['txnType'])) {
168 Civi
::log()->debug('PayPalProIPN: Could not find txn_type in input request.');
169 echo "Failure: Invalid parameters<p>";
173 $recur = &$objects['contributionRecur'];
175 // make sure the invoice ids match
176 // make sure the invoice is valid and matches what we have in
177 // the contribution record
178 if ($recur->invoice_id
!= $input['invoice']) {
179 Civi
::log()->debug('PayPalProIPN: Invoice values dont match between database and IPN request recur is ' . $recur->invoice_id
. ' input is ' . $input['invoice']);
180 echo "Failure: Invoice values dont match between database and IPN request recur is " . $recur->invoice_id
. " input is " . $input['invoice'];
184 $now = date('YmdHis');
186 // fix dates that already exist
187 $dates = array('create', 'start', 'end', 'cancel', 'modified');
188 foreach ($dates as $date) {
189 $name = "{$date}_date";
191 $recur->$name = CRM_Utils_Date
::isoToMysql($recur->$name);
195 $sendNotification = FALSE;
196 $subscriptionPaymentStatus = NULL;
197 //List of Transaction Type
199 recurring_payment_profile_created RP Profile Created
200 recurring_payment RP Successful Payment
201 recurring_payment_failed RP Failed Payment
202 recurring_payment_profile_cancel RP Profile Cancelled
203 recurring_payment_expired RP Profile Expired
204 recurring_payment_skipped RP Profile Skipped
205 recurring_payment_outstanding_payment RP Successful Outstanding Payment
206 recurring_payment_outstanding_payment_failed RP Failed Outstanding Payment
207 recurring_payment_suspended RP Profile Suspended
208 recurring_payment_suspended_due_to_max_failed_payment RP Profile Suspended due to Max Failed Payment
211 //set transaction type
212 $txnType = $this->retrieve('txn_type', 'String');
213 //Changes for paypal pro recurring payment
214 $contributionStatuses = array_flip(CRM_Contribute_BAO_Contribution
::buildOptions('contribution_status_id', 'validate'));
216 case 'recurring_payment_profile_created':
217 if (in_array($recur->contribution_status_id
, array(
218 $contributionStatuses['Pending'],
219 $contributionStatuses['In Progress'],
221 && !empty($recur->processor_id
)
223 echo "already handled";
226 $recur->create_date
= $now;
227 $recur->contribution_status_id
= $contributionStatuses['Pending'];
228 $recur->processor_id
= $this->retrieve('recurring_payment_id', 'String');
229 $recur->trxn_id
= $recur->processor_id
;
230 $subscriptionPaymentStatus = CRM_Core_Payment
::RECURRING_PAYMENT_START
;
231 $sendNotification = TRUE;
234 case 'recurring_payment':
236 $recur->start_date
= $now;
239 if ($input['paymentStatus'] != 'Completed') {
240 throw new CRM_Core_Exception("Ignore all IPN payments that are not completed");
243 // In future moving to create pending & then complete, but this OK for now.
244 // Also consider accepting 'Failed' like other processors.
245 $input['contribution_status_id'] = $contributionStatuses['Completed'];
246 $input['invoice_id'] = md5(uniqid(rand(), TRUE));
247 $input['original_contribution_id'] = $ids['contribution'];
248 $input['contribution_recur_id'] = $ids['contributionRecur'];
250 civicrm_api3('Contribution', 'repeattransaction', $input);
254 //contribution installment is completed
255 if ($this->retrieve('profile_status', 'String') == 'Expired') {
256 if (!empty($recur->end_date
)) {
257 echo "already handled";
260 $recur->contribution_status_id
= $contributionStatuses['Completed'];
261 $recur->end_date
= $now;
262 $sendNotification = TRUE;
263 $subscriptionPaymentStatus = CRM_Core_Payment
::RECURRING_PAYMENT_END
;
266 // make sure the contribution status is not done
267 // since order of ipn's is unknown
268 if ($recur->contribution_status_id
!= $contributionStatuses['Completed']) {
269 $recur->contribution_status_id
= $contributionStatuses['In Progress'];
276 if ($sendNotification) {
277 $autoRenewMembership = FALSE;
279 isset($ids['membership']) && $ids['membership']
281 $autoRenewMembership = TRUE;
283 //send recurring Notification email for user
284 CRM_Contribute_BAO_ContributionPage
::recurringNotify($subscriptionPaymentStatus,
286 $ids['contributionPage'],
292 if ($txnType != 'recurring_payment') {
297 //check if this contribution transaction is already processed
298 //if not create a contribution and then get it processed
299 $contribution = new CRM_Contribute_BAO_Contribution();
300 $contribution->trxn_id
= $input['trxn_id'];
301 if ($contribution->trxn_id
&& $contribution->find()) {
302 Civi
::log()->debug('PayPalProIPN: Returning since contribution has already been handled.');
303 echo "Success: Contribution has already been handled<p>";
307 $contribution->contact_id
= $recur->contact_id
;
308 $contribution->financial_type_id
= $objects['contributionType']->id
;
309 $contribution->contribution_page_id
= $ids['contributionPage'];
310 $contribution->contribution_recur_id
= $ids['contributionRecur'];
311 $contribution->currency
= $objects['contribution']->currency
;
312 $contribution->payment_instrument_id
= $objects['contribution']->payment_instrument_id
;
313 $contribution->amount_level
= $objects['contribution']->amount_level
;
314 $contribution->campaign_id
= $objects['contribution']->campaign_id
;
315 $objects['contribution'] = &$contribution;
316 $contribution->invoice_id
= md5(uniqid(rand(), TRUE));
318 // CRM-13737 - am not aware of any reason why payment_date would not be set - this if is a belt & braces
319 $objects['contribution']->receive_date
= !empty($input['payment_date']) ?
date('YmdHis', strtotime($input['payment_date'])) : $now;
321 $this->single($input, $ids, $objects, TRUE, $first);
325 * @param array $input
327 * @param array $objects
333 public function single(&$input, &$ids, &$objects, $recur = FALSE, $first = FALSE) {
334 $contribution = &$objects['contribution'];
336 // make sure the invoice is valid and matches what we have in the contribution record
337 if ((!$recur) ||
($recur && $first)) {
338 if ($contribution->invoice_id
!= $input['invoice']) {
339 Civi
::log()->debug('PayPalProIPN: Invoice values dont match between database and IPN request.');
340 echo "Failure: Invoice values dont match between database and IPN request<p>contribution is" . $contribution->invoice_id
. " and input is " . $input['invoice'];
345 $contribution->invoice_id
= md5(uniqid(rand(), TRUE));
349 if ($contribution->total_amount
!= $input['amount']) {
350 Civi
::log()->debug('PayPalProIPN: Amount values dont match between database and IPN request.');
351 echo "Failure: Amount values dont match between database and IPN request<p>";
356 $contribution->total_amount
= $input['amount'];
359 $transaction = new CRM_Core_Transaction();
361 $status = $input['paymentStatus'];
362 if ($status == 'Denied' ||
$status == 'Failed' ||
$status == 'Voided') {
363 $this->failed($objects, $transaction);
366 elseif ($status == 'Pending') {
367 $this->pending($objects, $transaction);
370 elseif ($status == 'Refunded' ||
$status == 'Reversed') {
371 $this->cancelled($objects, $transaction);
374 elseif ($status != 'Completed') {
375 $this->unhandled($objects, $transaction);
379 // check if contribution is already completed, if so we ignore this ipn
380 $completedStatusId = CRM_Core_Pseudoconstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
381 if ($contribution->contribution_status_id
== $completedStatusId) {
382 $transaction->commit();
383 Civi
::log()->debug('PayPalProIPN: Returning since contribution has already been handled.');
384 echo "Success: Contribution has already been handled<p>";
388 $this->completeTransaction($input, $ids, $objects, $transaction, $recur);
392 * Gets PaymentProcessorID for PayPal
396 public function getPayPalPaymentProcessorID() {
397 // This is an unreliable method as there could be more than one instance.
398 // Recommended approach is to use the civicrm/payment/ipn/xx url where xx is the payment
399 // processor id & the handleNotification function (which should call the completetransaction api & by-pass this
400 // entirely). The only thing the IPN class should really do is extract data from the request, validate it
401 // & call completetransaction or call fail? (which may not exist yet).
403 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');
405 $paymentProcessorTypeID = CRM_Core_DAO
::getFieldValue('CRM_Financial_DAO_PaymentProcessorType',
406 'PayPal', 'id', 'name'
408 return (int) civicrm_api3('PaymentProcessor', 'getvalue', array(
410 'options' => array('limit' => 1),
411 'payment_processor_type_id' => $paymentProcessorTypeID,
418 * This is the main function to call. It should be sufficient to instantiate the class
419 * (with the input parameters) & call this & all will be done
421 * @todo the references to POST throughout this class need to be removed
424 public function main() {
425 CRM_Core_Error
::debug_var('GET', $_GET, TRUE, TRUE);
426 CRM_Core_Error
::debug_var('POST', $_POST, TRUE, TRUE);
427 if ($this->_isPaymentExpress
) {
428 $this->handlePaymentExpress();
431 $objects = $ids = $input = array();
432 $this->_component
= $input['component'] = self
::getValue('m');
433 $input['invoice'] = self
::getValue('i', TRUE);
434 // get the contribution and contact ids from the GET params
435 $ids['contact'] = self
::getValue('c', TRUE);
436 $ids['contribution'] = self
::getValue('b', TRUE);
438 $this->getInput($input, $ids);
440 if ($this->_component
== 'event') {
441 $ids['event'] = self
::getValue('e', TRUE);
442 $ids['participant'] = self
::getValue('p', TRUE);
443 $ids['contributionRecur'] = self
::getValue('r', FALSE);
446 // get the optional ids
447 //@ how can this not be broken retrieving from GET as we are dealing with a POST request?
448 // copy & paste? Note the retrieve function now uses data from _REQUEST so this will be included
449 $ids['membership'] = self
::retrieve('membershipID', 'Integer', 'GET', FALSE);
450 $ids['contributionRecur'] = self
::getValue('r', FALSE);
451 $ids['contributionPage'] = self
::getValue('p', FALSE);
452 $ids['related_contact'] = self
::retrieve('relatedContactID', 'Integer', 'GET', FALSE);
453 $ids['onbehalf_dupe_alert'] = self
::retrieve('onBehalfDupeAlert', 'Integer', 'GET', FALSE);
456 if (!$ids['membership'] && $ids['contributionRecur']) {
459 FROM civicrm_membership m
460 INNER JOIN civicrm_membership_payment mp ON m.id = mp.membership_id AND mp.contribution_id = %1
461 WHERE m.contribution_recur_id = %2
464 1 => array($ids['contribution'], 'Integer'),
465 2 => array($ids['contributionRecur'], 'Integer'),
467 if ($membershipId = CRM_Core_DAO
::singleValueQuery($sql, $sqlParams)) {
468 $ids['membership'] = $membershipId;
472 $paymentProcessorID = self
::getPayPalPaymentProcessorID();
474 if (!$this->validateData($input, $ids, $objects, TRUE, $paymentProcessorID)) {
478 self
::$_paymentProcessor = &$objects['paymentProcessor'];
479 //?? how on earth would we not have component be one of these?
480 // they are the only valid settings & this IPN file can't even be called without one of them
481 // grepping for this class doesn't find other paths to call this class
482 if ($this->_component
== 'contribute' ||
$this->_component
== 'event') {
483 if ($ids['contributionRecur']) {
484 // check if first contribution is completed, else complete first contribution
486 $completedStatusId = CRM_Core_Pseudoconstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
487 if ($objects['contribution']->contribution_status_id
== $completedStatusId) {
490 $this->recur($input, $ids, $objects, $first);
494 $this->single($input, $ids, $objects, FALSE, FALSE);
498 * @param array $input
502 * @throws CRM_Core_Exception
504 public function getInput(&$input, &$ids) {
505 if (!$this->getBillingID($ids)) {
509 $input['txnType'] = self
::retrieve('txn_type', 'String', 'POST', FALSE);
510 $input['paymentStatus'] = self
::retrieve('payment_status', 'String', 'POST', FALSE);
512 $input['amount'] = self
::retrieve('mc_gross', 'Money', 'POST', FALSE);
513 $input['reasonCode'] = self
::retrieve('ReasonCode', 'String', 'POST', FALSE);
515 $billingID = $ids['billing'];
517 "first_name" => 'first_name',
518 "last_name" => 'last_name',
519 "street_address-{$billingID}" => 'address_street',
520 "city-{$billingID}" => 'address_city',
521 "state-{$billingID}" => 'address_state',
522 "postal_code-{$billingID}" => 'address_zip',
523 "country-{$billingID}" => 'address_country_code',
525 foreach ($lookup as $name => $paypalName) {
526 $value = self
::retrieve($paypalName, 'String', 'POST', FALSE);
527 $input[$name] = $value ?
$value : NULL;
530 $input['is_test'] = self
::retrieve('test_ipn', 'Integer', 'POST', FALSE);
531 $input['fee_amount'] = self
::retrieve('mc_fee', 'Money', 'POST', FALSE);
532 $input['net_amount'] = self
::retrieve('settle_amount', 'Money', 'POST', FALSE);
533 $input['trxn_id'] = self
::retrieve('txn_id', 'String', 'POST', FALSE);
534 $input['payment_date'] = $input['receive_date'] = self
::retrieve('payment_date', 'String', 'POST', FALSE);
535 $input['total_amount'] = $input['amount'];
539 * Handle payment express IPNs.
541 * For one off IPNS no actual response is required
542 * Recurring is more difficult as we have limited confirmation material
543 * lets look up invoice id in recur_contribution & rely on the unique transaction id to ensure no
545 * this may not be acceptable to all sites - e.g. if they are shipping or delivering something in return
546 * then the quasi security of the ids array might be required - although better to
547 * http://stackoverflow.com/questions/4848227/validate-that-ipn-call-is-from-paypal
548 * but let's assume knowledge on invoice id & schedule is enough for now esp for donations
549 * only contribute is handled
551 public function handlePaymentExpress() {
552 //@todo - loads of copy & paste / code duplication but as this not going into core need to try to
554 // also note that a lot of the complexity above could be removed if we used
555 // http://stackoverflow.com/questions/4848227/validate-that-ipn-call-is-from-paypal
556 // as membership id etc can be derived by the load objects fn
557 $objects = $ids = $input = array();
559 $input['invoice'] = self
::getValue('i', FALSE);
560 $input['txnType'] = $this->retrieve('txn_type', 'String');
561 $contributionRecur = civicrm_api3('contribution_recur', 'getsingle', array(
562 'return' => 'contact_id, id, payment_processor_id',
563 'invoice_id' => $input['invoice'],
566 if ($input['txnType'] !== 'recurring_payment' && $input['txnType'] !== 'recurring_payment_profile_created') {
567 throw new CRM_Core_Exception('Paypal IPNS not handled other than recurring_payments');
570 $this->getInput($input, $ids);
571 if ($input['txnType'] === 'recurring_payment' && $this->transactionExists($input['trxn_id'])) {
572 throw new CRM_Core_Exception('This transaction has already been processed');
575 $ids['contact'] = $contributionRecur['contact_id'];
576 $ids['contributionRecur'] = $contributionRecur['id'];
577 $result = civicrm_api3('contribution', 'getsingle', ['invoice_id' => $input['invoice'], 'contribution_test' => '']);
579 $ids['contribution'] = $result['id'];
580 //@todo hardcoding 'pending' for now
581 $pendingStatusId = CRM_Core_Pseudoconstant
::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
582 if ($result['contribution_status_id'] == $pendingStatusId) {
585 // arg api won't get this - fix it
586 $ids['contributionPage'] = CRM_Core_DAO
::singleValueQuery("SELECT contribution_page_id FROM civicrm_contribution WHERE invoice_id = %1", array(
588 $ids['contribution'],
592 // only handle component at this stage - not terribly sure how a recurring event payment would arise
593 // & suspec main function may be a victom of copy & paste
594 // membership would be an easy add - but not relevant to my customer...
595 $this->_component
= $input['component'] = 'contribute';
596 $input['trxn_date'] = date('Y-m-d-H-i-s', strtotime(self
::retrieve('time_created', 'String')));
597 $paymentProcessorID = $contributionRecur['payment_processor_id'];
599 if (!$this->validateData($input, $ids, $objects, TRUE, $paymentProcessorID)) {
600 throw new CRM_Core_Exception('Data did not validate');
602 $this->recur($input, $ids, $objects, $isFirst);
606 * Function check if transaction already exists.
607 * @param string $trxn_id
610 public function transactionExists($trxn_id) {
611 if (CRM_Core_DAO
::singleValueQuery("SELECT count(*) FROM civicrm_contribution WHERE trxn_id = %1",
613 1 => array($trxn_id, 'String'),