3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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 +--------------------------------------------------------------------+
29 * Class CRM_Core_Payment_BaseIPN.
31 class CRM_Core_Payment_BaseIPN
{
36 * Input parameters from payment processor. Store these so that
37 * the code does not need to keep retrieving from the http request
40 protected $_inputParameters = array();
43 * Only used by AuthorizeNetIPN.
49 protected $_isRecurring = FALSE;
52 * Only used by AuthorizeNetIPN.
58 protected $_isFirstOrLastRecurringPayment = FALSE;
63 public function __construct() {
64 self
::$_now = date('YmdHis');
68 * Store input array on the class.
70 * @param array $parameters
72 * @throws CRM_Core_Exception
74 public function setInputParameters($parameters) {
75 if (!is_array($parameters)) {
76 throw new CRM_Core_Exception('Invalid input parameters');
78 $this->_inputParameters
= $parameters;
82 * Validate incoming data.
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.
92 * Interpreted values from the values returned through the IPN.
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.
104 public function validateData(&$input, &$ids, &$objects, $required = TRUE, $paymentProcessorID = NULL) {
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>";
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>";
123 $contribution->receive_date
= CRM_Utils_Date
::isoToMysql($contribution->receive_date
);
124 $contribution->receipt_date
= CRM_Utils_Date
::isoToMysql($contribution->receipt_date
);
126 $objects['contact'] = &$contact;
127 $objects['contribution'] = &$contribution;
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']);
136 if (!$this->loadObjects($input, $ids, $objects, $required, $paymentProcessorID)) {
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'];
149 * Load objects related to contribution.
151 * @input array information from Payment processor
153 * @param array $input
155 * @param array $objects
156 * @param bool $required
157 * @param int $paymentProcessorID
158 * @param array $error_handling
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 = array(
172 $ids['paymentProcessor'] = $paymentProcessorID;
173 if (is_a($objects['contribution'], 'CRM_Contribute_BAO_Contribution')) {
174 $contribution = &$objects['contribution'];
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;
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
);
189 catch (Exception
$e) {
191 if (!empty($error_handling['log_error'])) {
192 CRM_Core_Error
::debug_log_message($e->getMessage());
194 if (!empty($error_handling['echo_error'])) {
195 echo $e->getMessage();
197 if (!empty($error_handling['return_error'])) {
200 'error_message' => ($e->getMessage()),
204 $objects = array_merge($objects, $contribution->_relatedObjects
);
209 * Set contribution to failed.
211 * @param array $objects
212 * @param object $transaction
213 * @param array $input
217 public function failed(&$objects, &$transaction, $input = array()) {
218 $contribution = &$objects['contribution'];
219 $memberships = array();
220 if (!empty($objects['membership'])) {
221 $memberships = &$objects['membership'];
222 if (is_numeric($memberships)) {
223 $memberships = array($objects['membership']);
227 $addLineItems = FALSE;
228 if (empty($contribution->id
)) {
229 $addLineItems = TRUE;
231 $participant = &$objects['participant'];
234 $contributionStatuses = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
235 'labelColumn' => 'name',
238 $contribution->receive_date
= CRM_Utils_Date
::isoToMysql($contribution->receive_date
);
239 $contribution->receipt_date
= CRM_Utils_Date
::isoToMysql($contribution->receipt_date
);
240 $contribution->thankyou_date
= CRM_Utils_Date
::isoToMysql($contribution->thankyou_date
);
241 $contribution->contribution_status_id
= $contributionStatuses['Failed'];
242 $contribution->save();
244 // Add line items for recurring payments.
245 if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id
&& $addLineItems) {
246 CRM_Contribute_BAO_ContributionRecur
::addRecurLineItems($objects['contributionRecur']->id
, $contribution);
249 //add new soft credit against current contribution id and
250 //copy initial contribution custom fields for recurring contributions
251 if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id
) {
252 CRM_Contribute_BAO_ContributionRecur
::addrecurSoftCredit($objects['contributionRecur']->id
, $contribution->id
);
253 CRM_Contribute_BAO_ContributionRecur
::copyCustomValues($objects['contributionRecur']->id
, $contribution->id
);
256 if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
257 if (!empty($memberships)) {
258 // if transaction is failed then set "Cancelled" as membership status
259 $membershipStatuses = CRM_Core_PseudoConstant
::get('CRM_Member_DAO_Membership', 'status_id', array(
260 'labelColumn' => 'name',
263 foreach ($memberships as $membership) {
265 $membership->status_id
= $membershipStatuses['Cancelled'];
268 //update related Memberships.
269 $params = array('status_id' => $membershipStatuses['Cancelled']);
270 CRM_Member_BAO_Membership
::updateRelatedMemberships($membership->id
, $params);
276 $participantParams['id'] = $participant->id
;
277 $participantParams['status_id'] = 'Cancelled';
278 civicrm_api3('Participant', 'create', $participantParams);
282 $transaction->commit();
283 CRM_Core_Error
::debug_log_message("Setting contribution status to failed");
284 //echo "Success: Setting contribution status to failed<p>";
289 * Handled pending contribution status.
291 * @param array $objects
292 * @param object $transaction
296 public function pending(&$objects, &$transaction) {
297 $transaction->commit();
298 CRM_Core_Error
::debug_log_message("returning since contribution status is pending");
299 echo "Success: Returning since contribution status is pending<p>";
304 * Process cancelled payment outcome.
306 * @param array $objects
307 * @param CRM_Core_Transaction $transaction
308 * @param array $input
312 public function cancelled(&$objects, &$transaction, $input = array()) {
313 $contribution = &$objects['contribution'];
314 $memberships = &$objects['membership'];
315 if (is_numeric($memberships)) {
316 $memberships = array($objects['membership']);
319 $participant = &$objects['participant'];
320 $addLineItems = FALSE;
321 if (empty($contribution->id
)) {
322 $addLineItems = TRUE;
324 $contributionStatuses = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
325 'labelColumn' => 'name',
328 $contribution->contribution_status_id
= $contributionStatuses['Cancelled'];
329 $contribution->cancel_date
= self
::$_now;
330 $contribution->cancel_reason
= CRM_Utils_Array
::value('reasonCode', $input);
331 $contribution->receive_date
= CRM_Utils_Date
::isoToMysql($contribution->receive_date
);
332 $contribution->receipt_date
= CRM_Utils_Date
::isoToMysql($contribution->receipt_date
);
333 $contribution->thankyou_date
= CRM_Utils_Date
::isoToMysql($contribution->thankyou_date
);
334 $contribution->save();
336 //add lineitems for recurring payments
337 if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id
&& $addLineItems) {
338 CRM_Contribute_BAO_ContributionRecur
::addRecurLineItems($objects['contributionRecur']->id
, $contribution);
341 //add new soft credit against current $contribution and
342 //copy initial contribution custom fields for recurring contributions
343 if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id
) {
344 CRM_Contribute_BAO_ContributionRecur
::addrecurSoftCredit($objects['contributionRecur']->id
, $contribution->id
);
345 CRM_Contribute_BAO_ContributionRecur
::copyCustomValues($objects['contributionRecur']->id
, $contribution->id
);
348 if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
349 if (!empty($memberships)) {
350 $membershipStatuses = CRM_Core_PseudoConstant
::get('CRM_Member_DAO_Membership', 'status_id', array(
351 'labelColumn' => 'name',
354 // Cancel only Pending memberships
356 $pendingStatusId = $membershipStatuses['Pending'];
357 foreach ($memberships as $membership) {
358 if ($membership && ($membership->status_id
== $pendingStatusId)) {
359 $membership->status_id
= $membershipStatuses['Cancelled'];
362 //update related Memberships.
363 $params = array('status_id' => $membershipStatuses['Cancelled']);
364 CRM_Member_BAO_Membership
::updateRelatedMemberships($membership->id
, $params);
370 $participantParams['id'] = $participant->id
;
371 $participantParams['status_id'] = 'Cancelled';
372 civicrm_api3('Participant', 'create', $participantParams);
375 $transaction->commit();
376 CRM_Core_Error
::debug_log_message("Setting contribution status to cancelled");
377 //echo "Success: Setting contribution status to cancelled<p>";
382 * Rollback unhandled outcomes.
384 * @param array $objects
385 * @param CRM_Core_Transaction $transaction
389 public function unhandled(&$objects, &$transaction) {
390 $transaction->rollback();
391 CRM_Core_Error
::debug_log_message("returning since contribution status: is not handled");
392 echo "Failure: contribution status is not handled<p>";
399 * Jumbled up function.
401 * The purpose of this function is to transition a pending transaction to Completed including updating any
404 * It has been overloaded to also add recurring transactions to the database, cloning the original transaction and
405 * updating related entities.
407 * It is recommended to avoid calling this function directly and call the api functions:
408 * - contribution.completetransaction
409 * - contribution.repeattransaction
411 * These functions are the focus of testing efforts and more accurately reflect the division of roles
412 * (the job of the IPN class is to determine the outcome, transaction id, invoice id & to validate the source
413 * and from there it should be possible to pass off transaction management.)
415 * This function has been problematic for some time but there are now several tests via the api_v3_Contribution test
416 * and the Paypal & Authorize.net IPN tests so any refactoring should be done in conjunction with those.
418 * This function needs to have the 'body' moved to the CRM_Contribute_BAO_Contribute class and to undergo
419 * refactoring to separate the complete transaction and repeat transaction functionality into separate functions with
420 * a shared function that updates related components.
422 * Note that it is not necessary payment processor extension to implement an IPN class now. In general the code on the
423 * IPN class is better accessed through the api which de-jumbles it a bit.
425 * e.g the payment class can have a function like (based on Omnipay extension):
427 * public function handlePaymentNotification() {
428 * $response = $this->getValidatedOutcome();
429 * if ($response->isSuccessful()) {
431 * // @todo check if it is a repeat transaction & call repeattransaction instead.
432 * civicrm_api3('contribution', 'completetransaction', array('id' => $this->transaction_id));
434 * catch (CiviCRM_API3_Exception $e) {
435 * if (!stristr($e->getMessage(), 'Contribution already completed')) {
436 * $this->handleError('error', $this->transaction_id . $e->getMessage(), 'ipn_completion', 9000, 'An error may
437 * have occurred. Please check your receipt is correct');
438 * $this->redirectOrExit('success');
440 * elseif ($this->transaction_id) {
441 * civicrm_api3('contribution', 'create', array('id' => $this->transaction_id, 'contribution_status_id' =>
445 * @param array $input
447 * @param array $objects
448 * @param CRM_Core_Transaction $transaction
451 public function completeTransaction(&$input, &$ids, &$objects, &$transaction, $recur = FALSE) {
452 $contribution = &$objects['contribution'];
454 CRM_Contribute_BAO_Contribution
::completeOrder($input, $ids, $objects, $transaction, $recur, $contribution);
458 * Get site billing ID.
464 public function getBillingID(&$ids) {
465 $ids['billing'] = CRM_Core_BAO_LocationType
::getBilling();
466 if (!$ids['billing']) {
467 CRM_Core_Error
::debug_log_message(ts('Please set a location type of %1', array(1 => 'Billing')));
468 echo "Failure: Could not find billing location type<p>";
477 * @todo confirm this function is not being used by any payment processor outside core & remove.
479 * Note that the compose message part has been moved to contribution
480 * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it
482 * @param array $input
483 * Incoming data from Payment processor.
485 * Related object IDs.
486 * @param array $objects
487 * @param array $values
488 * Values related to objects that have already been loaded.
490 * Is it part of a recurring contribution.
491 * @param bool $returnMessageText
492 * Should text be returned instead of sent. This.
493 * is because the function is also used to generate pdfs
497 public function sendMail(&$input, &$ids, &$objects, &$values, $recur = FALSE, $returnMessageText = FALSE) {
498 return CRM_Contribute_BAO_Contribution
::sendMail($input, $ids, $objects['contribution']->id
, $values,