3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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;
128 if (!$this->loadObjects($input, $ids, $objects, $required, $paymentProcessorID)) {
131 //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
132 //current contribution. Here we ensure that the original contribution is available to the complete transaction function
133 //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
134 if (isset($objects['contributionRecur'])) {
135 $objects['first_contribution'] = $objects['contribution'];
141 * Load objects related to contribution.
143 * @input array information from Payment processor
145 * @param array $input
147 * @param array $objects
148 * @param bool $required
149 * @param int $paymentProcessorID
150 * @param array $error_handling
154 public function loadObjects(&$input, &$ids, &$objects, $required, $paymentProcessorID, $error_handling = NULL) {
155 if (empty($error_handling)) {
156 // default options are that we log an error & echo it out
157 // note that we should refactor this error handling into error code @ some point
158 // but for now setting up enough separation so we can do unit tests
159 $error_handling = array(
164 $ids['paymentProcessor'] = $paymentProcessorID;
165 if (is_a($objects['contribution'], 'CRM_Contribute_BAO_Contribution')) {
166 $contribution = &$objects['contribution'];
169 //legacy support - functions are 'used' to be able to pass in a DAO
170 $contribution = new CRM_Contribute_BAO_Contribution();
171 $contribution->id
= CRM_Utils_Array
::value('contribution', $ids);
172 $contribution->find(TRUE);
173 $objects['contribution'] = &$contribution;
176 $success = $contribution->loadRelatedObjects($input, $ids);
177 if ($required && empty($contribution->_relatedObjects
['paymentProcessor'])) {
178 throw new CRM_Core_Exception("Could not find payment processor for contribution record: " . $contribution->id
);
181 catch (Exception
$e) {
183 if (!empty($error_handling['log_error'])) {
184 CRM_Core_Error
::debug_log_message($e->getMessage());
186 if (!empty($error_handling['echo_error'])) {
187 echo $e->getMessage();
189 if (!empty($error_handling['return_error'])) {
192 'error_message' => ($e->getMessage()),
196 $objects = array_merge($objects, $contribution->_relatedObjects
);
201 * Set contribution to failed.
203 * @param array $objects
204 * @param object $transaction
205 * @param array $input
209 public function failed(&$objects, &$transaction, $input = array()) {
210 $contribution = &$objects['contribution'];
211 $memberships = array();
212 if (!empty($objects['membership'])) {
213 $memberships = &$objects['membership'];
214 if (is_numeric($memberships)) {
215 $memberships = array($objects['membership']);
219 $addLineItems = FALSE;
220 if (empty($contribution->id
)) {
221 $addLineItems = TRUE;
223 $participant = &$objects['participant'];
226 $contributionStatuses = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
227 'labelColumn' => 'name',
230 $contribution->receive_date
= CRM_Utils_Date
::isoToMysql($contribution->receive_date
);
231 $contribution->receipt_date
= CRM_Utils_Date
::isoToMysql($contribution->receipt_date
);
232 $contribution->thankyou_date
= CRM_Utils_Date
::isoToMysql($contribution->thankyou_date
);
233 $contribution->contribution_status_id
= $contributionStatuses['Failed'];
234 $contribution->save();
236 // Add line items for recurring payments.
237 if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id
&& $addLineItems) {
238 CRM_Contribute_BAO_ContributionRecur
::addRecurLineItems($objects['contributionRecur']->id
, $contribution);
241 //add new soft credit against current contribution id and
242 //copy initial contribution custom fields for recurring contributions
243 if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id
) {
244 CRM_Contribute_BAO_ContributionRecur
::addrecurSoftCredit($objects['contributionRecur']->id
, $contribution->id
);
245 CRM_Contribute_BAO_ContributionRecur
::copyCustomValues($objects['contributionRecur']->id
, $contribution->id
);
248 if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
249 if (!empty($memberships)) {
250 // if transaction is failed then set "Cancelled" as membership status
251 $membershipStatuses = CRM_Core_PseudoConstant
::get('CRM_Member_DAO_Membership', 'status_id', array(
252 'labelColumn' => 'name',
255 foreach ($memberships as $membership) {
257 $membership->status_id
= $membershipStatuses['Cancelled'];
260 //update related Memberships.
261 $params = array('status_id' => $membershipStatuses['Cancelled']);
262 CRM_Member_BAO_Membership
::updateRelatedMemberships($membership->id
, $params);
268 $participantStatuses = CRM_Core_PseudoConstant
::get('CRM_Event_DAO_Participant', 'status_id', array(
269 'labelColumn' => 'name',
272 $participant->status_id
= $participantStatuses['Cancelled'];
273 $participant->save();
277 $transaction->commit();
278 CRM_Core_Error
::debug_log_message("Setting contribution status to failed");
279 //echo "Success: Setting contribution status to failed<p>";
284 * Handled pending contribution status.
286 * @param array $objects
287 * @param object $transaction
291 public function pending(&$objects, &$transaction) {
292 $transaction->commit();
293 CRM_Core_Error
::debug_log_message("returning since contribution status is pending");
294 echo "Success: Returning since contribution status is pending<p>";
299 * Process cancelled payment outcome.
301 * @param array $objects
302 * @param CRM_Core_Transaction $transaction
303 * @param array $input
307 public function cancelled(&$objects, &$transaction, $input = array()) {
308 $contribution = &$objects['contribution'];
309 $memberships = &$objects['membership'];
310 if (is_numeric($memberships)) {
311 $memberships = array($objects['membership']);
314 $participant = &$objects['participant'];
315 $addLineItems = FALSE;
316 if (empty($contribution->id
)) {
317 $addLineItems = TRUE;
319 $contributionStatuses = CRM_Core_PseudoConstant
::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
320 'labelColumn' => 'name',
323 $contribution->contribution_status_id
= $contributionStatuses['Cancelled'];
324 $contribution->cancel_date
= self
::$_now;
325 $contribution->cancel_reason
= CRM_Utils_Array
::value('reasonCode', $input);
326 $contribution->receive_date
= CRM_Utils_Date
::isoToMysql($contribution->receive_date
);
327 $contribution->receipt_date
= CRM_Utils_Date
::isoToMysql($contribution->receipt_date
);
328 $contribution->thankyou_date
= CRM_Utils_Date
::isoToMysql($contribution->thankyou_date
);
329 $contribution->save();
331 //add lineitems for recurring payments
332 if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id
&& $addLineItems) {
333 CRM_Contribute_BAO_ContributionRecur
::addRecurLineItems($objects['contributionRecur']->id
, $contribution);
336 //add new soft credit against current $contribution and
337 //copy initial contribution custom fields for recurring contributions
338 if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id
) {
339 CRM_Contribute_BAO_ContributionRecur
::addrecurSoftCredit($objects['contributionRecur']->id
, $contribution->id
);
340 CRM_Contribute_BAO_ContributionRecur
::copyCustomValues($objects['contributionRecur']->id
, $contribution->id
);
343 if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
344 if (!empty($memberships)) {
345 $membershipStatuses = CRM_Core_PseudoConstant
::get('CRM_Member_DAO_Membership', 'status_id', array(
346 'labelColumn' => 'name',
349 foreach ($memberships as $membership) {
351 $membership->status_id
= $membershipStatuses['Cancelled'];
354 //update related Memberships.
355 $params = array('status_id' => $membershipStatuses['Cancelled']);
356 CRM_Member_BAO_Membership
::updateRelatedMemberships($membership->id
, $params);
362 $participantStatuses = CRM_Core_PseudoConstant
::get('CRM_Event_DAO_Participant', 'status_id', array(
363 'labelColumn' => 'name',
366 $participant->status_id
= $participantStatuses['Cancelled'];
367 $participant->save();
370 $transaction->commit();
371 CRM_Core_Error
::debug_log_message("Setting contribution status to cancelled");
372 //echo "Success: Setting contribution status to cancelled<p>";
377 * Rollback unhandled outcomes.
379 * @param array $objects
380 * @param CRM_Core_Transaction $transaction
384 public function unhandled(&$objects, &$transaction) {
385 $transaction->rollback();
386 CRM_Core_Error
::debug_log_message("returning since contribution status: is not handled");
387 echo "Failure: contribution status is not handled<p>";
392 * Jumbled up function.
394 * The purpose of this function is to transition a pending transaction to Completed including updating any
397 * It has been overloaded to also add recurring transactions to the database, cloning the original transaction and
398 * updating related entities.
400 * It is recommended to avoid calling this function directly and call the api functions:
401 * - contribution.completetransaction
402 * - contribution.repeattransaction
404 * These functions are the focus of testing efforts and more accurately reflect the division of roles
405 * (the job of the IPN class is to determine the outcome, transaction id, invoice id & to validate the source
406 * and from there it should be possible to pass off transaction management.)
408 * This function has been problematic for some time but there are now several tests via the api_v3_Contribution test
409 * and the Paypal & Authorize.net IPN tests so any refactoring should be done in conjunction with those.
411 * This function needs to have the 'body' moved to the CRM_Contribution_BAO_Contribute class and to undergo
412 * refactoring to separate the complete transaction and repeat transaction functionality into separate functions with
413 * a shared function that updates related components.
415 * Note that it is not necessary payment processor extension to implement an IPN class now. In general the code on the
416 * IPN class is better accessed through the api which de-jumbles it a bit.
418 * e.g the payment class can have a function like (based on Omnipay extension):
420 * public function handlePaymentNotification() {
421 * $response = $this->getValidatedOutcome();
422 * if ($response->isSuccessful()) {
424 * // @todo check if it is a repeat transaction & call repeattransaction instead.
425 * civicrm_api3('contribution', 'completetransaction', array('id' => $this->transaction_id));
427 * catch (CiviCRM_API3_Exception $e) {
428 * if (!stristr($e->getMessage(), 'Contribution already completed')) {
429 * $this->handleError('error', $this->transaction_id . $e->getMessage(), 'ipn_completion', 9000, 'An error may
430 * have occurred. Please check your receipt is correct');
431 * $this->redirectOrExit('success');
433 * elseif ($this->transaction_id) {
434 * civicrm_api3('contribution', 'create', array('id' => $this->transaction_id, 'contribution_status_id' =>
438 * @param array $input
440 * @param array $objects
441 * @param CRM_Core_Transaction $transaction
444 public function completeTransaction(&$input, &$ids, &$objects, &$transaction, $recur = FALSE) {
445 $isRecurring = $this->_isRecurring
;
446 $isFirstOrLastRecurringPayment = $this->_isFirstOrLastRecurringPayment
;
447 $contribution = &$objects['contribution'];
449 CRM_Contribute_BAO_Contribution
::completeOrder($input, $ids, $objects, $transaction, $recur, $contribution,
450 $isRecurring, $isFirstOrLastRecurringPayment);
454 * Get site billing ID.
460 public function getBillingID(&$ids) {
461 $ids['billing'] = CRM_Core_BAO_LocationType
::getBilling();
462 if (!$ids['billing']) {
463 CRM_Core_Error
::debug_log_message(ts('Please set a location type of %1', array(1 => 'Billing')));
464 echo "Failure: Could not find billing location type<p>";
471 * Send receipt from contribution.
475 * Note that the compose message part has been moved to contribution
476 * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it
478 * @param array $input
479 * Incoming data from Payment processor.
481 * Related object IDs.
482 * @param array $objects
483 * @param array $values
484 * Values related to objects that have already been loaded.
486 * Is it part of a recurring contribution.
487 * @param bool $returnMessageText
488 * Should text be returned instead of sent. This.
489 * is because the function is also used to generate pdfs
493 public function sendMail(&$input, &$ids, &$objects, &$values, $recur = FALSE, $returnMessageText = FALSE) {
494 return CRM_Contribute_BAO_Contribution
::sendMail($input, $ids, $objects['contribution'], $values, $recur,