3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
35 class CRM_Core_Payment_BaseIPN
{
40 * Input parameters from payment processor. Store these so that
41 * the code does not need to keep retrieving from the http request
44 protected $_inputParameters = array();
49 function __construct() {
50 self
::$_now = date('YmdHis');
54 * Store input array on the class
56 * @param array $parameters
58 * @throws CRM_Core_Exception
60 function setInputParameters($parameters) {
61 if(!is_array($parameters)) {
62 throw new CRM_Core_Exception('Invalid input parameters');
64 $this->_inputParameters
= $parameters;
67 * Validate incoming data. This function is intended to ensure that incoming data matches
68 * It provides a form of pseudo-authentication - by checking the calling fn already knows
69 * the correct contact id & contribution id (this can be problematic when that has changed in
70 * the meantime for transactions that are delayed & contacts are merged in-between. e.g
71 * Paypal allows you to resend Instant Payment Notifications if you, for example, moved site
72 * and didn't update your IPN URL.
74 * @param array $input interpreted values from the values returned through the IPN
75 * @param array $ids more interpreted values (ids) from the values returned through the IPN
76 * @param array $objects an empty array that will be populated with loaded object
77 * @param boolean $required boolean Return FALSE if the relevant objects don't exist
78 * @param integer $paymentProcessorID Id of the payment processor ID in use
81 function validateData(&$input, &$ids, &$objects, $required = TRUE, $paymentProcessorID = NULL) {
83 // make sure contact exists and is valid
84 $contact = new CRM_Contact_BAO_Contact();
85 $contact->id
= $ids['contact'];
86 if (!$contact->find(TRUE)) {
87 CRM_Core_Error
::debug_log_message("Could not find contact record: {$ids['contact']} in IPN request: ".print_r($input, TRUE));
88 echo "Failure: Could not find contact record: {$ids['contact']}<p>";
92 // make sure contribution exists and is valid
93 $contribution = new CRM_Contribute_BAO_Contribution();
94 $contribution->id
= $ids['contribution'];
95 if (!$contribution->find(TRUE)) {
96 CRM_Core_Error
::debug_log_message("Could not find contribution record: {$contribution->id} in IPN request: ".print_r($input, TRUE));
97 echo "Failure: Could not find contribution record for {$contribution->id}<p>";
100 $contribution->receive_date
= CRM_Utils_Date
::isoToMysql($contribution->receive_date
);
102 $objects['contact'] = &$contact;
103 $objects['contribution'] = &$contribution;
104 if (!$this->loadObjects($input, $ids, $objects, $required, $paymentProcessorID)) {
107 //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
108 //current contribution. Here we ensure that the original contribution is available to the complete transaction function
109 //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
110 if (isset($objects['contributionRecur'])) {
111 $objects['first_contribution'] = $objects['contribution'];
117 * Load objects related to contribution
119 * @input array information from Payment processor
123 * @param array $objects
124 * @param boolean $required
125 * @param integer $paymentProcessorID
126 * @param array $error_handling
128 * @return multitype:number NULL |boolean
130 function loadObjects(&$input, &$ids, &$objects, $required, $paymentProcessorID, $error_handling = NULL) {
131 if (empty($error_handling)) {
132 // default options are that we log an error & echo it out
133 // note that we should refactor this error handling into error code @ some point
134 // but for now setting up enough separation so we can do unit tests
135 $error_handling = array(
140 $ids['paymentProcessor'] = $paymentProcessorID;
141 if (is_a($objects['contribution'], 'CRM_Contribute_BAO_Contribution')) {
142 $contribution = &$objects['contribution'];
145 //legacy support - functions are 'used' to be able to pass in a DAO
146 $contribution = new CRM_Contribute_BAO_Contribution();
147 $contribution->id
= CRM_Utils_Array
::value('contribution', $ids);
148 $contribution->find(TRUE);
149 $objects['contribution'] = &$contribution;
152 $success = $contribution->loadRelatedObjects($input, $ids, $required);
154 catch(Exception
$e) {
156 if (!empty($error_handling['log_error'])) {
157 CRM_Core_Error
::debug_log_message($e->getMessage());
159 if (!empty($error_handling['echo_error'])) {
160 echo ($e->getMessage());
162 if (!empty($error_handling['return_error'])) {
165 'error_message' => ($e->getMessage()),
169 $objects = array_merge($objects, $contribution->_relatedObjects
);
174 * Set contribution to failed
175 * @param array $objects
176 * @param object $transaction
177 * @param array $input
180 function failed(&$objects, &$transaction, $input = array()) {
181 $contribution = &$objects['contribution'];
182 $memberships = array();
183 if (!empty($objects['membership'])) {
184 $memberships = &$objects['membership'];
185 if (is_numeric($memberships)) {
186 $memberships = array($objects['membership']);
190 $addLineItems = FALSE;
191 if (empty($contribution->id
)) {
192 $addLineItems = TRUE;
194 $participant = &$objects['participant'];
196 $contributionStatus = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
197 $contribution->receive_date
= CRM_Utils_Date
::isoToMysql($contribution->receive_date
);
198 $contribution->receipt_date
= CRM_Utils_Date
::isoToMysql($contribution->receipt_date
);
199 $contribution->thankyou_date
= CRM_Utils_Date
::isoToMysql($contribution->thankyou_date
);
200 $contribution->contribution_status_id
= array_search('Failed', $contributionStatus);
201 $contribution->save();
203 //add lineitems for recurring payments
204 if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id
&& $addLineItems) {
205 $this->addrecurLineItems($objects['contributionRecur']->id
, $contribution->id
, CRM_Core_DAO
::$_nullArray);
208 //add new soft credit against current contribution id and
209 //copy initial contribution custom fields for recurring contributions
210 if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id
) {
211 $this->addrecurSoftCredit($objects['contributionRecur']->id
, $contribution->id
);
212 $this->copyCustomValues($objects['contributionRecur']->id
, $contribution->id
);
215 if (empty($input['skipComponentSync'])) {
216 if (!empty($memberships)) {
217 // if transaction is failed then set "Cancelled" as membership status
218 $cancelStatusId = array_search('Cancelled', CRM_Member_PseudoConstant
::membershipStatus());
219 foreach ($memberships as $membership) {
221 $membership->status_id
= $cancelStatusId;
224 //update related Memberships.
225 $params = array('status_id' => $cancelStatusId);
226 CRM_Member_BAO_Membership
::updateRelatedMemberships($membership->id
, $params);
232 $participant->status_id
= 4;
233 $participant->save();
237 $transaction->commit();
238 CRM_Core_Error
::debug_log_message("Setting contribution status to failed");
239 //echo "Success: Setting contribution status to failed<p>";
244 * Handled pending contribution status
245 * @param array $objects
246 * @param object $transaction
249 function pending(&$objects, &$transaction) {
250 $transaction->commit();
251 CRM_Core_Error
::debug_log_message("returning since contribution status is pending");
252 echo "Success: Returning since contribution status is pending<p>";
258 * @param $transaction
259 * @param array $input
263 function cancelled(&$objects, &$transaction, $input = array()) {
264 $contribution = &$objects['contribution'];
265 $memberships = &$objects['membership'];
266 if (is_numeric($memberships)) {
267 $memberships = array($objects['membership']);
270 $participant = &$objects['participant'];
271 $addLineItems = FALSE;
272 if (empty($contribution->id
)) {
273 $addLineItems = TRUE;
275 $contribution->contribution_status_id
= 3;
276 $contribution->cancel_date
= self
::$_now;
277 $contribution->cancel_reason
= CRM_Utils_Array
::value('reasonCode', $input);
278 $contribution->receive_date
= CRM_Utils_Date
::isoToMysql($contribution->receive_date
);
279 $contribution->receipt_date
= CRM_Utils_Date
::isoToMysql($contribution->receipt_date
);
280 $contribution->thankyou_date
= CRM_Utils_Date
::isoToMysql($contribution->thankyou_date
);
281 $contribution->save();
283 //add lineitems for recurring payments
284 if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id
&& $addLineItems) {
285 $this->addrecurLineItems($objects['contributionRecur']->id
, $contribution->id
, CRM_Core_DAO
::$_nullArray);
288 //add new soft credit against current $contribution and
289 //copy initial contribution custom fields for recurring contributions
290 if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id
) {
291 $this->addrecurSoftCredit($objects['contributionRecur']->id
, $contribution->id
);
292 $this->copyCustomValues($objects['contributionRecur']->id
, $contribution->id
);
295 if (empty($input['skipComponentSync'])) {
296 if (!empty($memberships)) {
297 foreach ($memberships as $membership) {
299 $membership->status_id
= 6;
302 //update related Memberships.
303 $params = array('status_id' => 6);
304 CRM_Member_BAO_Membership
::updateRelatedMemberships($membership->id
, $params);
310 $participant->status_id
= 4;
311 $participant->save();
314 $transaction->commit();
315 CRM_Core_Error
::debug_log_message("Setting contribution status to cancelled");
316 //echo "Success: Setting contribution status to cancelled<p>";
322 * @param $transaction
326 function unhandled(&$objects, &$transaction) {
327 $transaction->rollback();
328 // we dont handle this as yet
329 CRM_Core_Error
::debug_log_message("returning since contribution status: $status is not handled");
330 echo "Failure: contribution status $status is not handled<p>";
338 * @param $transaction
341 function completeTransaction(&$input, &$ids, &$objects, &$transaction, $recur = FALSE) {
342 $contribution = &$objects['contribution'];
344 $primaryContributionID = isset($contribution->id
) ?
$contribution->id
: $objects['first_contribution']->id
;
346 $memberships = &$objects['membership'];
347 if (is_numeric($memberships)) {
348 $memberships = array($objects['membership']);
350 $participant = &$objects['participant'];
351 $event = &$objects['event'];
352 $changeToday = CRM_Utils_Array
::value('trxn_date', $input, self
::$_now);
353 $recurContrib = &$objects['contributionRecur'];
357 if ($input['component'] == 'contribute') {
358 if ($contribution->contribution_page_id
) {
359 CRM_Contribute_BAO_ContributionPage
::setValues($contribution->contribution_page_id
, $values);
360 $source = ts('Online Contribution') . ': ' . $values['title'];
362 elseif ($recurContrib && $recurContrib->id
) {
363 $contribution->contribution_page_id
= NULL;
364 $values['amount'] = $recurContrib->amount
;
365 $values['financial_type_id'] = $objects['contributionType']->id
;
366 $values['title'] = $source = ts('Offline Recurring Contribution');
367 $domainValues = CRM_Core_BAO_Domain
::getNameAndEmail();
368 $values['receipt_from_name'] = $domainValues[0];
369 $values['receipt_from_email'] = $domainValues[1];
371 if($recurContrib && $recurContrib->id
){
372 //CRM-13273 - is_email_receipt setting on recurring contribution should take precedence over contribution page setting
373 $values['is_email_receipt'] = $recurContrib->is_email_receipt
;
376 $contribution->source
= $source;
377 if (!empty($values['is_email_receipt'])) {
378 $contribution->receipt_date
= self
::$_now;
381 if (!empty($memberships)) {
382 $membershipsUpdate = array( );
383 foreach ($memberships as $membershipTypeIdKey => $membership) {
387 $currentMembership = CRM_Member_BAO_Membership
::getContactMembership($membership->contact_id
,
388 $membership->membership_type_id
,
389 $membership->is_test
, $membership->id
392 // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
393 // this picks up membership type changes during renewals
395 SELECT membership_type_id
396 FROM civicrm_membership_log
397 WHERE membership_id=$membership->id
400 $dao = new CRM_Core_DAO
;
403 if (!empty($dao->membership_type_id
)) {
404 $membership->membership_type_id
= $dao->membership_type_id
;
407 // else fall back to using current membership type
409 // else fall back to using current membership type
412 $num_terms = $contribution->getNumTermsByContributionAndMembershipType($membership->membership_type_id
, $primaryContributionID);
413 if ($currentMembership) {
416 * In BAO/Membership.php(renewMembership function), we skip the extend membership date and status
417 * when Contribution mode is notify and membership is for renewal )
419 CRM_Member_BAO_Membership
::fixMembershipStatusBeforeRenew($currentMembership, $changeToday);
421 // @todo - we should pass membership_type_id instead of null here but not
422 // adding as not sure of testing
423 $dates = CRM_Member_BAO_MembershipType
::getRenewalDatesForMembershipType($membership->id
,
424 $changeToday, NULL, $num_terms
427 $dates['join_date'] = CRM_Utils_Date
::customFormat($currentMembership['join_date'], $format);
430 $dates = CRM_Member_BAO_MembershipType
::getDatesForMembershipType($membership->membership_type_id
, NULL, NULL, NULL, $num_terms);
433 //get the status for membership.
434 $calcStatus = CRM_Member_BAO_MembershipStatus
::getMembershipStatusByDate($dates['start_date'],
439 $membership->membership_type_id
,
443 $formatedParams = array('status_id' => CRM_Utils_Array
::value('id', $calcStatus, 2),
444 'join_date' => CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('join_date', $dates), $format),
445 'start_date' => CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('start_date', $dates), $format),
446 'end_date' => CRM_Utils_Date
::customFormat(CRM_Utils_Array
::value('end_date', $dates), $format),
448 //we might be renewing membership,
449 //so make status override false.
450 $formatedParams['is_override'] = FALSE;
451 $membership->copyValues($formatedParams);
454 //updating the membership log
455 $membershipLog = array();
456 $membershipLog = $formatedParams;
458 $logStartDate = $formatedParams['start_date'];
459 if (!empty($dates['log_start_date'])) {
460 $logStartDate = CRM_Utils_Date
::customFormat($dates['log_start_date'], $format);
461 $logStartDate = CRM_Utils_Date
::isoToMysql($logStartDate);
464 $membershipLog['start_date'] = $logStartDate;
465 $membershipLog['membership_id'] = $membership->id
;
466 $membershipLog['modified_id'] = $membership->contact_id
;
467 $membershipLog['modified_date'] = date('Ymd');
468 $membershipLog['membership_type_id'] = $membership->membership_type_id
;
470 CRM_Member_BAO_MembershipLog
::add($membershipLog, CRM_Core_DAO
::$_nullArray);
472 //update related Memberships.
473 CRM_Member_BAO_Membership
::updateRelatedMemberships($membership->id
, $formatedParams);
475 //update the membership type key of membership relatedObjects array
476 //if it has changed after membership update
477 if ($membershipTypeIdKey != $membership->membership_type_id
) {
478 $membershipsUpdate[$membership->membership_type_id
] = $membership;
479 $contribution->_relatedObjects
['membership'][$membership->membership_type_id
] = $membership;
480 unset($contribution->_relatedObjects
['membership'][$membershipTypeIdKey]);
481 unset($memberships[$membershipTypeIdKey]);
485 //update the memberships object with updated membershipTypeId data
486 //if membershipTypeId has changed after membership update
487 if (!empty($membershipsUpdate)) {
488 $memberships = $memberships +
$membershipsUpdate;
494 $eventParams = array('id' => $objects['event']->id
);
495 $values['event'] = array();
497 CRM_Event_BAO_Event
::retrieve($eventParams, $values['event']);
499 //get location details
500 $locationParams = array('entity_id' => $objects['event']->id
, 'entity_table' => 'civicrm_event');
501 $values['location'] = CRM_Core_BAO_Location
::getValues($locationParams);
503 $ufJoinParams = array(
504 'entity_table' => 'civicrm_event',
505 'entity_id' => $ids['event'],
506 'module' => 'CiviEvent',
511 ) = CRM_Core_BAO_UFJoin
::getUFGroupIds($ufJoinParams);
513 $values['custom_pre_id'] = $custom_pre_id;
514 $values['custom_post_id'] = $custom_post_ids;
515 //for tasks 'Change Participant Status' and 'Batch Update Participants Via Profile' case
516 //and cases involving status updation through ipn
517 $values['totalAmount'] = $input['amount'];
519 $contribution->source
= ts('Online Event Registration') . ': ' . $values['event']['title'];
521 if ($values['event']['is_email_confirm']) {
522 $contribution->receipt_date
= self
::$_now;
523 $values['is_email_receipt'] = 1;
525 if (empty($input['skipComponentSync'])) {
526 $participant->status_id
= 1;
528 $participant->save();
531 if (CRM_Utils_Array
::value('net_amount', $input, 0) == 0 &&
532 CRM_Utils_Array
::value('fee_amount', $input, 0) != 0
534 $input['net_amount'] = $input['amount'] - $input['fee_amount'];
536 $addLineItems = FALSE;
537 if (empty($contribution->id
)) {
538 $addLineItems = TRUE;
541 $contribution->contribution_status_id
= 1;
542 $contribution->is_test
= $input['is_test'];
543 $contribution->fee_amount
= CRM_Utils_Array
::value('fee_amount', $input, 0);
544 $contribution->net_amount
= CRM_Utils_Array
::value('net_amount', $input, 0);
545 $contribution->trxn_id
= $input['trxn_id'];
546 $contribution->receive_date
= CRM_Utils_Date
::isoToMysql($contribution->receive_date
);
547 $contribution->thankyou_date
= CRM_Utils_Date
::isoToMysql($contribution->thankyou_date
);
548 $contribution->receipt_date
= CRM_Utils_Date
::isoToMysql($contribution->receipt_date
);
549 $contribution->cancel_date
= 'null';
551 if (!empty($input['check_number'])) {
552 $contribution->check_number
= $input['check_number'];
555 if (!empty($input['payment_instrument_id'])) {
556 $contribution->payment_instrument_id
= $input['payment_instrument_id'];
559 if ($contribution->id
) {
560 $contributionId['id'] = $contribution->id
;
561 $input['prevContribution'] = CRM_Contribute_BAO_Contribution
::getValues($contributionId, CRM_Core_DAO
::$_nullArray, CRM_Core_DAO
::$_nullArray);
563 $contribution->save();
565 //add new soft credit against current $contribution and
566 if (CRM_Utils_Array
::value('contributionRecur', $objects) && $objects['contributionRecur']->id
) {
567 $this->addrecurSoftCredit($objects['contributionRecur']->id
, $contribution->id
);
570 //add lineitems for recurring payments
571 if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id
&& $addLineItems) {
572 $this->addrecurLineItems($objects['contributionRecur']->id
, $contribution->id
, $input);
575 //copy initial contribution custom fields for recurring contributions
576 if ($recurContrib && $recurContrib->id
) {
577 $this->copyCustomValues($recurContrib->id
, $contribution->id
);
580 // next create the transaction record
581 $paymentProcessor = $paymentProcessorId = '';
582 if (isset($objects['paymentProcessor'])) {
583 if (is_array($objects['paymentProcessor'])) {
584 $paymentProcessor = $objects['paymentProcessor']['payment_processor_type'];
585 $paymentProcessorId = $objects['paymentProcessor']['id'];
588 $paymentProcessor = $objects['paymentProcessor']->payment_processor_type
;
589 $paymentProcessorId = $objects['paymentProcessor']->id
;
592 //it's hard to see how it could reach this point without a contributon id as it is saved in line 511 above
593 // which raised the question as to whether this check preceded line 511 & if so whether something could be broken
594 // From a lot of code reading /debugging I'm still not sure the intent WRT first & subsequent payments in this code
595 // it would be good if someone added some comments or refactored this
596 if ($contribution->id
) {
597 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
598 if ((empty($input['prevContribution']) && $paymentProcessorId) ||
(!$input['prevContribution']->is_pay_later
&&
599 - $input['prevContribution']->contribution_status_id
== array_search('Pending', $contributionStatuses))) {
600 $input['payment_processor'] = $paymentProcessorId;
602 $input['contribution_status_id'] = array_search('Completed', $contributionStatuses);
603 $input['total_amount'] = $input['amount'];
604 $input['contribution'] = $contribution;
605 $input['financial_type_id'] = $contribution->financial_type_id
;
607 if (!empty($contribution->_relatedObjects
['participant'])) {
608 $input['contribution_mode'] = 'participant';
609 $input['participant_id'] = $contribution->_relatedObjects
['participant']->id
;
610 $input['skipLineItem'] = 1;
612 elseif (!empty($contribution->_relatedObjects
['membership'])) {
613 $input['skipLineItem'] = TRUE;
614 $input['contribution_mode'] = 'membership';
616 //@todo writing a unit test I was unable to create a scenario where this line did not fatal on second
617 // and subsequent payments. In this case the line items are created at $this->addrecurLineItems
618 // and since the contribution is saved prior to this line there is always a contribution-id,
619 // however there is never a prevContribution (which appears to mean original contribution not previous
620 // contribution - or preUpdateContributionObject most accurately)
621 // so, this is always called & only appears to succeed when prevContribution exists - which appears
622 // to mean "are we updating an exisitng pending contribution"
623 //I was able to make the unit test complete as fataling here doesn't prevent
624 // the contribution being created - but activities would not be created or emails sent
625 CRM_Contribute_BAO_Contribution
::recordFinancialAccounts($input, NULL);
628 self
::updateRecurLinkedPledge($contribution);
630 // create an activity record
631 if ($input['component'] == 'contribute') {
633 $targetContactID = NULL;
634 if (!empty($ids['related_contact'])) {
635 $targetContactID = $contribution->contact_id
;
636 $contribution->contact_id
= $ids['related_contact'];
638 CRM_Activity_BAO_Activity
::addActivity($contribution, NULL, $targetContactID);
642 CRM_Activity_BAO_Activity
::addActivity($participant);
645 CRM_Core_Error
::debug_log_message("Contribution record updated successfully");
646 $transaction->commit();
648 // CRM-9132 legacy behaviour was that receipts were sent out in all instances. Still sending
649 // when array_key 'is_email_receipt doesn't exist in case some instances where is needs setting haven't been set
650 if (!array_key_exists('is_email_receipt', $values) ||
651 $values['is_email_receipt'] == 1
653 self
::sendMail($input, $ids, $objects, $values, $recur, FALSE);
654 CRM_Core_Error
::debug_log_message("Receipt sent");
657 CRM_Core_Error
::debug_log_message("Success: Database updated");
665 function getBillingID(&$ids) {
666 // get the billing location type
667 $locationTypes = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id', array(), 'validate');
668 // CRM-8108 remove the ts around the Billing locationtype
669 //$ids['billing'] = array_search( ts('Billing'), $locationTypes );
670 $ids['billing'] = array_search('Billing', $locationTypes);
671 if (!$ids['billing']) {
672 CRM_Core_Error
::debug_log_message(ts('Please set a location type of %1', array(1 => 'Billing')));
673 echo "Failure: Could not find billing location type<p>";
680 * Send receipt from contribution. Note that the compose message part has been moved to contribution
681 * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it
683 * @params array $input Incoming data from Payment processor
684 * @params array $ids Related object IDs
685 * @params array $values values related to objects that have already been loaded
686 * @params bool $recur is it part of a recurring contribution
687 * @params bool $returnMessageText Should text be returned instead of sent. This
688 * is because the function is also used to generate pdfs
696 * @param bool $returnMessageText
700 function sendMail(&$input, &$ids, &$objects, &$values, $recur = FALSE, $returnMessageText = FALSE) {
701 $contribution = &$objects['contribution'];
702 $input['is_recur'] = $recur;
703 // set receipt from e-mail and name in value
704 if (!$returnMessageText) {
705 $session = CRM_Core_Session
::singleton();
706 $userID = $session->get('userID');
707 if (!empty($userID)) {
708 list($userName, $userEmail) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($userID);
709 $values['receipt_from_email'] = $userEmail;
710 $values['receipt_from_name'] = $userName;
713 return $contribution->composeMessageArray($input, $ids, $values, $recur, $returnMessageText);
717 * Update contribution status - this is only called from one place in the code &
718 * it is unclear whether it is a function on the way in or on the way out
720 * @param unknown_type $params
721 * @return void|Ambigous <value, unknown, array>
723 function updateContributionStatus(&$params) {
724 // get minimum required values.
725 $statusId = CRM_Utils_Array
::value('contribution_status_id', $params);
726 $componentId = CRM_Utils_Array
::value('component_id', $params);
727 $componentName = CRM_Utils_Array
::value('componentName', $params);
728 $contributionId = CRM_Utils_Array
::value('contribution_id', $params);
730 if (!$contributionId ||
!$componentId ||
!$componentName ||
!$statusId) {
734 $input = $ids = $objects = array();
736 //get the required ids.
737 $ids['contribution'] = $contributionId;
739 if (!$ids['contact'] = CRM_Utils_Array
::value('contact_id', $params)) {
740 $ids['contact'] = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution',
746 if ($componentName == 'Event') {
748 $ids['participant'] = $componentId;
750 if (!$ids['event'] = CRM_Utils_Array
::value('event_id', $params)) {
751 $ids['event'] = CRM_Core_DAO
::getFieldValue('CRM_Event_DAO_Participant',
758 if ($componentName == 'Membership') {
759 $name = 'contribute';
760 $ids['membership'] = $componentId;
762 $ids['contributionPage'] = NULL;
763 $ids['contributionRecur'] = NULL;
764 $input['component'] = $name;
766 $baseIPN = new CRM_Core_Payment_BaseIPN();
767 $transaction = new CRM_Core_Transaction();
769 // reset template values.
770 $template = CRM_Core_Smarty
::singleton();
771 $template->clearTemplateVars();
773 if (!$baseIPN->validateData($input, $ids, $objects, FALSE)) {
774 CRM_Core_Error
::fatal();
777 $contribution = &$objects['contribution'];
779 $contributionStatuses = CRM_Contribute_PseudoConstant
::contributionStatus(NULL, 'name');
780 $input['skipComponentSync'] = CRM_Utils_Array
::value('skipComponentSync', $params);
781 if ($statusId == array_search('Cancelled', $contributionStatuses)) {
782 $baseIPN->cancelled($objects, $transaction, $input);
783 $transaction->commit();
786 elseif ($statusId == array_search('Failed', $contributionStatuses)) {
787 $baseIPN->failed($objects, $transaction, $input);
788 $transaction->commit();
792 // status is not pending
793 if ($contribution->contribution_status_id
!= array_search('Pending', $contributionStatuses)) {
794 $transaction->commit();
798 //set values for ipn code.
800 'fee_amount', 'check_number', 'payment_instrument_id') as $field) {
801 if (!$input[$field] = CRM_Utils_Array
::value($field, $params)) {
802 $input[$field] = $contribution->$field;
805 if (!$input['trxn_id'] = CRM_Utils_Array
::value('trxn_id', $params)) {
806 $input['trxn_id'] = $contribution->invoice_id
;
808 if (!$input['amount'] = CRM_Utils_Array
::value('total_amount', $params)) {
809 $input['amount'] = $contribution->total_amount
;
811 $input['is_test'] = $contribution->is_test
;
812 $input['net_amount'] = $contribution->net_amount
;
813 if (!empty($input['fee_amount']) && !empty($input['amount'])) {
814 $input['net_amount'] = $input['amount'] - $input['fee_amount'];
817 //complete the contribution.
818 $baseIPN->completeTransaction($input, $ids, $objects, $transaction, FALSE);
820 // reset template values before processing next transactions
821 $template->clearTemplateVars();
827 * Update pledge associated with a recurring contribution
829 * If the contribution has a pledge_payment record pledge, then update the pledge_payment record & pledge based on that linkage.
831 * If a previous contribution in the recurring contribution sequence is linked with a pledge then we assume this contribution
832 * should be linked with the same pledge also. Currently only back-office users can apply a recurring payment to a pledge &
833 * it should be assumed they
834 * do so with the intention that all payments will be linked
836 * The pledge payment record should already exist & will need to be updated with the new contribution ID.
837 * If not the contribution will also need to be linked to the pledge
840 * @param $contribution
842 function updateRecurLinkedPledge(&$contribution) {
843 $returnProperties = array('id', 'pledge_id');
844 $paymentDetails = $paymentIDs = array();
846 if (CRM_Core_DAO
::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'contribution_id', $contribution->id
,
847 $paymentDetails, $returnProperties
849 foreach ($paymentDetails as $key => $value) {
850 $paymentIDs[] = $value['id'];
851 $pledgeId = $value['pledge_id'];
855 //payment is not already linked - if it is linked with a pledge we need to create a link.
856 // return if it is not recurring contribution
857 if (!$contribution->contribution_recur_id
) {
861 $relatedContributions = new CRM_Contribute_DAO_Contribution();
862 $relatedContributions->contribution_recur_id
= $contribution->contribution_recur_id
;
863 $relatedContributions->find();
865 while ($relatedContributions->fetch()) {
866 CRM_Core_DAO
::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'contribution_id', $relatedContributions->id
,
867 $paymentDetails, $returnProperties
871 if (empty($paymentDetails)) {
872 // payment is not linked with a pledge and neither are any other contributions on this
876 foreach ($paymentDetails as $key => $value) {
877 $pledgeId = $value['pledge_id'];
880 // we have a pledge now we need to get the oldest unpaid payment
881 $paymentDetails = CRM_Pledge_BAO_PledgePayment
::getOldestPledgePayment($pledgeId);
882 if(empty($paymentDetails['id'])){
883 // we can assume this pledge is now completed
884 // return now so we don't create a core error & roll back
887 $paymentDetails['contribution_id'] = $contribution->id
;
888 $paymentDetails['status_id'] = $contribution->contribution_status_id
;
889 $paymentDetails['actual_amount'] = $contribution->total_amount
;
891 // put contribution against it
892 $payment = CRM_Pledge_BAO_PledgePayment
::add($paymentDetails);
893 $paymentIDs[] = $payment->id
;
896 // update pledge and corresponding payment statuses
897 CRM_Pledge_BAO_PledgePayment
::updatePledgePaymentStatus($pledgeId, $paymentIDs, $contribution->contribution_status_id
,
898 NULL, $contribution->total_amount
904 * @param $contributionId
907 function addrecurLineItems($recurId, $contributionId, &$input) {
908 $lineSets = $lineItems = array();
910 //Get the first contribution id with recur id
912 $contriID = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id');
913 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($contriID, 'contribution');
914 if (!empty($lineItems)) {
915 foreach ($lineItems as $key => $value) {
916 $pricesetID = new CRM_Price_DAO_PriceField();
917 $pricesetID->id
= $value['price_field_id'];
918 $pricesetID->find(TRUE);
919 $lineSets[$pricesetID->price_set_id
][] = $value;
922 if (!empty($input)) {
923 $input['line_item'] = $lineSets;
926 CRM_Price_BAO_LineItem
::processPriceSet($contributionId, $lineSets);
931 // function to copy custom data of the
932 // initial contribution into its recurring contributions
935 * @param $targetContributionId
937 function copyCustomValues($recurId, $targetContributionId) {
938 if ($recurId && $targetContributionId) {
939 // get the initial contribution id of recur id
940 $sourceContributionId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id');
942 // if the same contribution is being proccessed then return
943 if ($sourceContributionId == $targetContributionId) {
946 // check if proper recurring contribution record is being processed
947 $targetConRecurId = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $targetContributionId, 'contribution_recur_id');
948 if ($targetConRecurId != $recurId) {
953 $extends = array('Contribution');
954 $groupTree = CRM_Core_BAO_CustomGroup
::getGroupDetail(NULL, NULL, $extends);
956 foreach ($groupTree as $groupID => $group) {
957 $table[$groupTree[$groupID]['table_name']] = array('entity_id');
958 foreach ($group['fields'] as $fieldID => $field) {
959 $table[$groupTree[$groupID]['table_name']][] = $groupTree[$groupID]['fields'][$fieldID]['column_name'];
963 foreach ($table as $tableName => $tableColumns) {
964 $insert = 'INSERT INTO ' . $tableName . ' (' . implode(', ', $tableColumns) . ') ';
965 $tableColumns[0] = $targetContributionId;
966 $select = 'SELECT ' . implode(', ', $tableColumns);
967 $from = ' FROM ' . $tableName;
968 $where = " WHERE {$tableName}.entity_id = {$sourceContributionId}";
969 $query = $insert . $select . $from . $where;
970 $dao = CRM_Core_DAO
::executeQuery($query, CRM_Core_DAO
::$_nullArray);
976 // function to copy soft credit record of first recurring contribution
977 // and add new soft credit against $targetContributionId
980 * @param $targetContributionId
982 function addrecurSoftCredit($recurId, $targetContributionId) {
983 $contriID = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id');
985 $soft_contribution = new CRM_Contribute_DAO_ContributionSoft();
986 $soft_contribution->contribution_id
= $contriID;
988 //check if first recurring contribution has any associated soft credit
989 if ($soft_contribution->find(TRUE)) {
990 $soft_contribution->contribution_id
= $targetContributionId;
991 unset($soft_contribution->id
);
992 $soft_contribution->save();