<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
- *
- * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
- * $Id$
- *
+ * Class CRM_Core_Payment_BaseIPN.
*/
class CRM_Core_Payment_BaseIPN {
*/
protected $_inputParameters = array();
+ protected $_isRecurring = FALSE;
+
+ protected $_isFirstOrLastRecurringPayment = FALSE;
+
/**
- * Constructor
+ * Constructor.
*/
- function __construct() {
+ public function __construct() {
self::$_now = date('YmdHis');
}
/**
- * Store input array on the class
+ * Store input array on the class.
*
* @param array $parameters
*
* @throws CRM_Core_Exception
*/
- function setInputParameters($parameters) {
- if(!is_array($parameters)) {
+ public function setInputParameters($parameters) {
+ if (!is_array($parameters)) {
throw new CRM_Core_Exception('Invalid input parameters');
}
$this->_inputParameters = $parameters;
}
+
/**
- * Validate incoming data. This function is intended to ensure that incoming data matches
+ * Validate incoming data.
+ *
+ * This function is intended to ensure that incoming data matches
* It provides a form of pseudo-authentication - by checking the calling fn already knows
* the correct contact id & contribution id (this can be problematic when that has changed in
* the meantime for transactions that are delayed & contacts are merged in-between. e.g
* Paypal allows you to resend Instant Payment Notifications if you, for example, moved site
* and didn't update your IPN URL.
*
- * @param array $input interpreted values from the values returned through the IPN
- * @param array $ids more interpreted values (ids) from the values returned through the IPN
- * @param array $objects an empty array that will be populated with loaded object
- * @param boolean $required boolean Return FALSE if the relevant objects don't exist
- * @param integer $paymentProcessorID Id of the payment processor ID in use
- * @return boolean
+ * @param array $input
+ * Interpreted values from the values returned through the IPN.
+ * @param array $ids
+ * More interpreted values (ids) from the values returned through the IPN.
+ * @param array $objects
+ * An empty array that will be populated with loaded object.
+ * @param bool $required
+ * Boolean Return FALSE if the relevant objects don't exist.
+ * @param int $paymentProcessorID
+ * Id of the payment processor ID in use.
+ *
+ * @return bool
*/
- function validateData(&$input, &$ids, &$objects, $required = TRUE, $paymentProcessorID = NULL) {
+ public function validateData(&$input, &$ids, &$objects, $required = TRUE, $paymentProcessorID = NULL) {
// make sure contact exists and is valid
$contact = new CRM_Contact_BAO_Contact();
$contact->id = $ids['contact'];
if (!$contact->find(TRUE)) {
- CRM_Core_Error::debug_log_message("Could not find contact record: {$ids['contact']} in IPN request: ".print_r($input, TRUE));
+ CRM_Core_Error::debug_log_message("Could not find contact record: {$ids['contact']} in IPN request: " . print_r($input, TRUE));
echo "Failure: Could not find contact record: {$ids['contact']}<p>";
return FALSE;
}
$contribution = new CRM_Contribute_BAO_Contribution();
$contribution->id = $ids['contribution'];
if (!$contribution->find(TRUE)) {
- CRM_Core_Error::debug_log_message("Could not find contribution record: {$contribution->id} in IPN request: ".print_r($input, TRUE));
+ CRM_Core_Error::debug_log_message("Could not find contribution record: {$contribution->id} in IPN request: " . print_r($input, TRUE));
echo "Failure: Could not find contribution record for {$contribution->id}<p>";
return FALSE;
}
}
/**
- * Load objects related to contribution
+ * Load objects related to contribution.
*
* @input array information from Payment processor
*
* @param $input
* @param array $ids
* @param array $objects
- * @param boolean $required
- * @param integer $paymentProcessorID
+ * @param bool $required
+ * @param int $paymentProcessorID
* @param array $error_handling
*
- * @return multitype:number NULL |boolean
+ * @return bool
*/
- function loadObjects(&$input, &$ids, &$objects, $required, $paymentProcessorID, $error_handling = NULL) {
+ public function loadObjects(&$input, &$ids, &$objects, $required, $paymentProcessorID, $error_handling = NULL) {
if (empty($error_handling)) {
// default options are that we log an error & echo it out
// note that we should refactor this error handling into error code @ some point
try {
$success = $contribution->loadRelatedObjects($input, $ids, $required);
}
- catch(Exception $e) {
+ catch (Exception $e) {
$success = FALSE;
if (!empty($error_handling['log_error'])) {
CRM_Core_Error::debug_log_message($e->getMessage());
}
if (!empty($error_handling['echo_error'])) {
- echo ($e->getMessage());
+ echo $e->getMessage();
}
if (!empty($error_handling['return_error'])) {
return array(
}
/**
- * Set contribution to failed
+ * Set contribution to failed.
+ *
* @param array $objects
* @param object $transaction
* @param array $input
- * @return boolean
+ *
+ * @return bool
*/
- function failed(&$objects, &$transaction, $input = array()) {
+ public function failed(&$objects, &$transaction, $input = array()) {
$contribution = &$objects['contribution'];
$memberships = array();
if (!empty($objects['membership'])) {
}
$participant = &$objects['participant'];
- $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
+ //CRM-15546
+ $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
+ 'labelColumn' => 'name',
+ 'flip' => 1,
+ ));
$contribution->receive_date = CRM_Utils_Date::isoToMysql($contribution->receive_date);
$contribution->receipt_date = CRM_Utils_Date::isoToMysql($contribution->receipt_date);
$contribution->thankyou_date = CRM_Utils_Date::isoToMysql($contribution->thankyou_date);
- $contribution->contribution_status_id = array_search('Failed', $contributionStatus);
+ $contribution->contribution_status_id = $contributionStatuses['Failed'];
$contribution->save();
- //add lineitems for recurring payments
+ // Add line items for recurring payments.
if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id && $addLineItems) {
- $this->addrecurLineItems($objects['contributionRecur']->id, $contribution->id, CRM_Core_DAO::$_nullArray);
+ CRM_Contribute_BAO_ContributionRecur::addRecurLineItems($objects['contributionRecur']->id, $contribution);
}
//add new soft credit against current contribution id and
//copy initial contribution custom fields for recurring contributions
if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id) {
- $this->addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id);
- $this->copyCustomValues($objects['contributionRecur']->id, $contribution->id);
+ CRM_Contribute_BAO_ContributionRecur::addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id);
+ CRM_Contribute_BAO_ContributionRecur::copyCustomValues($objects['contributionRecur']->id, $contribution->id);
}
if (empty($input['skipComponentSync'])) {
if (!empty($memberships)) {
// if transaction is failed then set "Cancelled" as membership status
- $cancelStatusId = array_search('Cancelled', CRM_Member_PseudoConstant::membershipStatus());
+ $membershipStatuses = CRM_Core_PseudoConstant::get('CRM_Member_DAO_Membership', 'status_id', array(
+ 'labelColumn' => 'name',
+ 'flip' => 1,
+ ));
foreach ($memberships as $membership) {
if ($membership) {
- $membership->status_id = $cancelStatusId;
+ $membership->status_id = $membershipStatuses['Cancelled'];
$membership->save();
//update related Memberships.
- $params = array('status_id' => $cancelStatusId);
+ $params = array('status_id' => $membershipStatuses['Cancelled']);
CRM_Member_BAO_Membership::updateRelatedMemberships($membership->id, $params);
}
}
}
if ($participant) {
- $participant->status_id = 4;
+ $participantStatuses = CRM_Core_PseudoConstant::get('CRM_Event_DAO_Participant', 'status_id', array(
+ 'labelColumn' => 'name',
+ 'flip' => 1,
+ ));
+ $participant->status_id = $participantStatuses['Cancelled'];
$participant->save();
}
}
}
/**
- * Handled pending contribution status
+ * Handled pending contribution status.
+ *
* @param array $objects
* @param object $transaction
- * @return boolean
+ *
+ * @return bool
*/
- function pending(&$objects, &$transaction) {
+ public function pending(&$objects, &$transaction) {
$transaction->commit();
CRM_Core_Error::debug_log_message("returning since contribution status is pending");
echo "Success: Returning since contribution status is pending<p>";
}
/**
+ * Process cancelled payment outcome.
+ *
* @param $objects
* @param $transaction
* @param array $input
*
* @return bool
*/
- function cancelled(&$objects, &$transaction, $input = array()) {
+ public function cancelled(&$objects, &$transaction, $input = array()) {
$contribution = &$objects['contribution'];
$memberships = &$objects['membership'];
if (is_numeric($memberships)) {
if (empty($contribution->id)) {
$addLineItems = TRUE;
}
- $contribution->contribution_status_id = 3;
+ $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
+ 'labelColumn' => 'name',
+ 'flip' => 1,
+ ));
+ $contribution->contribution_status_id = $contributionStatuses['Cancelled'];
$contribution->cancel_date = self::$_now;
$contribution->cancel_reason = CRM_Utils_Array::value('reasonCode', $input);
$contribution->receive_date = CRM_Utils_Date::isoToMysql($contribution->receive_date);
//add lineitems for recurring payments
if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id && $addLineItems) {
- $this->addrecurLineItems($objects['contributionRecur']->id, $contribution->id, CRM_Core_DAO::$_nullArray);
+ CRM_Contribute_BAO_ContributionRecur::addRecurLineItems($objects['contributionRecur']->id, $contribution);
}
//add new soft credit against current $contribution and
//copy initial contribution custom fields for recurring contributions
if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id) {
- $this->addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id);
- $this->copyCustomValues($objects['contributionRecur']->id, $contribution->id);
+ CRM_Contribute_BAO_ContributionRecur::addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id);
+ CRM_Contribute_BAO_ContributionRecur::copyCustomValues($objects['contributionRecur']->id, $contribution->id);
}
if (empty($input['skipComponentSync'])) {
if (!empty($memberships)) {
+ $membershipStatuses = CRM_Core_PseudoConstant::get('CRM_Member_DAO_Membership', 'status_id', array(
+ 'labelColumn' => 'name',
+ 'flip' => 1,
+ ));
foreach ($memberships as $membership) {
if ($membership) {
- $membership->status_id = 6;
+ $membership->status_id = $membershipStatuses['Cancelled'];
$membership->save();
//update related Memberships.
- $params = array('status_id' => 6);
+ $params = array('status_id' => $membershipStatuses['Cancelled']);
CRM_Member_BAO_Membership::updateRelatedMemberships($membership->id, $params);
}
}
}
if ($participant) {
- $participant->status_id = 4;
+ $participantStatuses = CRM_Core_PseudoConstant::get('CRM_Event_DAO_Participant', 'status_id', array(
+ 'labelColumn' => 'name',
+ 'flip' => 1,
+ ));
+ $participant->status_id = $participantStatuses['Cancelled'];
$participant->save();
}
}
}
/**
+ * Rollback unhandled outcomes.
+ *
* @param $objects
* @param $transaction
*
* @return bool
*/
- function unhandled(&$objects, &$transaction) {
+ public function unhandled(&$objects, &$transaction) {
$transaction->rollback();
- // we dont handle this as yet
- CRM_Core_Error::debug_log_message("returning since contribution status: $status is not handled");
- echo "Failure: contribution status $status is not handled<p>";
+ CRM_Core_Error::debug_log_message("returning since contribution status: is not handled");
+ echo "Failure: contribution status is not handled<p>";
return FALSE;
}
/**
- * @param $input
- * @param $ids
- * @param $objects
+ * Jumbled up function.
+ *
+ * The purpose of this function is to transition a pending transaction to Completed including updating any
+ * related entities.
+ *
+ * It has been overloaded to also add recurring transactions to the database, cloning the original transaction and
+ * updating related entities.
+ *
+ * It is recommended to avoid calling this function directly and call the api functions:
+ * - contribution.completetransaction
+ * - contribution.repeattransaction
+ *
+ * These functions are the focus of testing efforts and more accurately reflect the division of roles
+ * (the job of the IPN class is to determine the outcome, transaction id, invoice id & to validate the source
+ * and from there it should be possible to pass off transaction management.)
+ *
+ * This function has been problematic for some time but there are now several tests via the api_v3_Contribution test
+ * and the Paypal & Authorize.net IPN tests so any refactoring should be done in conjunction with those.
+ *
+ * This function needs to have the 'body' moved to the CRM_Contribution_BAO_Contribute class and to undergo
+ * refactoring to separate the complete transaction and repeat transaction functionality into separate functions with
+ * a shared function that updates related components.
+ *
+ * Note that it is not necessary payment processor extension to implement an IPN class now. In general the code on the
+ * IPN class is better accessed through the api which de-jumbles it a bit.
+ *
+ * e.g the payment class can have a function like (based on Omnipay extension):
+ *
+ * public function handlePaymentNotification() {
+ * $response = $this->getValidatedOutcome();
+ * if ($response->isSuccessful()) {
+ * try {
+ * // @todo check if it is a repeat transaction & call repeattransaction instead.
+ * civicrm_api3('contribution', 'completetransaction', array('id' => $this->transaction_id));
+ * }
+ * catch (CiviCRM_API3_Exception $e) {
+ * if (!stristr($e->getMessage(), 'Contribution already completed')) {
+ * $this->handleError('error', $this->transaction_id . $e->getMessage(), 'ipn_completion', 9000, 'An error may
+ * have occurred. Please check your receipt is correct');
+ * $this->redirectOrExit('success');
+ * }
+ * elseif ($this->transaction_id) {
+ * civicrm_api3('contribution', 'create', array('id' => $this->transaction_id, 'contribution_status_id' =>
+ * 'Failed'));
+ * }
+ *
+ * @param array $input
+ * @param array $ids
+ * @param array $objects
* @param $transaction
* @param bool $recur
*/
- function completeTransaction(&$input, &$ids, &$objects, &$transaction, $recur = FALSE) {
+ public function completeTransaction(&$input, &$ids, &$objects, &$transaction, $recur = FALSE) {
+ $isRecurring = $this->_isRecurring;
+ $isFirstOrLastRecurringPayment = $this->_isFirstOrLastRecurringPayment;
$contribution = &$objects['contribution'];
- $primaryContributionID = isset($contribution->id) ? $contribution->id : $objects['first_contribution']->id;
-
- $memberships = &$objects['membership'];
- if (is_numeric($memberships)) {
- $memberships = array($objects['membership']);
- }
- $participant = &$objects['participant'];
- $event = &$objects['event'];
- $changeToday = CRM_Utils_Array::value('trxn_date', $input, self::$_now);
- $recurContrib = &$objects['contributionRecur'];
-
- $values = array();
- $source = NULL;
- if ($input['component'] == 'contribute') {
- if ($contribution->contribution_page_id) {
- CRM_Contribute_BAO_ContributionPage::setValues($contribution->contribution_page_id, $values);
- $source = ts('Online Contribution') . ': ' . $values['title'];
- }
- elseif ($recurContrib && $recurContrib->id) {
- $contribution->contribution_page_id = NULL;
- $values['amount'] = $recurContrib->amount;
- $values['financial_type_id'] = $objects['contributionType']->id;
- $values['title'] = $source = ts('Offline Recurring Contribution');
- $domainValues = CRM_Core_BAO_Domain::getNameAndEmail();
- $values['receipt_from_name'] = $domainValues[0];
- $values['receipt_from_email'] = $domainValues[1];
- }
- if($recurContrib && $recurContrib->id){
- //CRM-13273 - is_email_receipt setting on recurring contribution should take precedence over contribution page setting
- $values['is_email_receipt'] = $recurContrib->is_email_receipt;
- }
-
- $contribution->source = $source;
- if (!empty($values['is_email_receipt'])) {
- $contribution->receipt_date = self::$_now;
- }
-
- if (!empty($memberships)) {
- $membershipsUpdate = array( );
- foreach ($memberships as $membershipTypeIdKey => $membership) {
- if ($membership) {
- $format = '%Y%m%d';
-
- $currentMembership = CRM_Member_BAO_Membership::getContactMembership($membership->contact_id,
- $membership->membership_type_id,
- $membership->is_test, $membership->id
- );
-
- // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
- // this picks up membership type changes during renewals
- $sql = "
-SELECT membership_type_id
-FROM civicrm_membership_log
-WHERE membership_id=$membership->id
-ORDER BY id DESC
-LIMIT 1;";
- $dao = new CRM_Core_DAO;
- $dao->query($sql);
- if ($dao->fetch()) {
- if (!empty($dao->membership_type_id)) {
- $membership->membership_type_id = $dao->membership_type_id;
- $membership->save();
- }
- // else fall back to using current membership type
- }
- // else fall back to using current membership type
- $dao->free();
-
- $num_terms = $contribution->getNumTermsByContributionAndMembershipType($membership->membership_type_id, $primaryContributionID);
- if ($currentMembership) {
- /*
- * Fixed FOR CRM-4433
- * In BAO/Membership.php(renewMembership function), we skip the extend membership date and status
- * when Contribution mode is notify and membership is for renewal )
- */
- CRM_Member_BAO_Membership::fixMembershipStatusBeforeRenew($currentMembership, $changeToday);
-
- // @todo - we should pass membership_type_id instead of null here but not
- // adding as not sure of testing
- $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($membership->id,
- $changeToday, NULL, $num_terms
- );
-
- $dates['join_date'] = CRM_Utils_Date::customFormat($currentMembership['join_date'], $format);
- }
- else {
- $dates = CRM_Member_BAO_MembershipType::getDatesForMembershipType($membership->membership_type_id, NULL, NULL, NULL, $num_terms);
- }
-
- //get the status for membership.
- $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($dates['start_date'],
- $dates['end_date'],
- $dates['join_date'],
- 'today',
- TRUE,
- $membership->membership_type_id,
- (array) $membership
- );
-
- $formatedParams = array('status_id' => CRM_Utils_Array::value('id', $calcStatus, 2),
- 'join_date' => CRM_Utils_Date::customFormat(CRM_Utils_Array::value('join_date', $dates), $format),
- 'start_date' => CRM_Utils_Date::customFormat(CRM_Utils_Array::value('start_date', $dates), $format),
- 'end_date' => CRM_Utils_Date::customFormat(CRM_Utils_Array::value('end_date', $dates), $format),
- );
- //we might be renewing membership,
- //so make status override false.
- $formatedParams['is_override'] = FALSE;
- $membership->copyValues($formatedParams);
- $membership->save();
-
- //updating the membership log
- $membershipLog = array();
- $membershipLog = $formatedParams;
-
- $logStartDate = $formatedParams['start_date'];
- if (!empty($dates['log_start_date'])) {
- $logStartDate = CRM_Utils_Date::customFormat($dates['log_start_date'], $format);
- $logStartDate = CRM_Utils_Date::isoToMysql($logStartDate);
- }
-
- $membershipLog['start_date'] = $logStartDate;
- $membershipLog['membership_id'] = $membership->id;
- $membershipLog['modified_id'] = $membership->contact_id;
- $membershipLog['modified_date'] = date('Ymd');
- $membershipLog['membership_type_id'] = $membership->membership_type_id;
-
- CRM_Member_BAO_MembershipLog::add($membershipLog, CRM_Core_DAO::$_nullArray);
-
- //update related Memberships.
- CRM_Member_BAO_Membership::updateRelatedMemberships($membership->id, $formatedParams);
-
- //update the membership type key of membership relatedObjects array
- //if it has changed after membership update
- if ($membershipTypeIdKey != $membership->membership_type_id) {
- $membershipsUpdate[$membership->membership_type_id] = $membership;
- $contribution->_relatedObjects['membership'][$membership->membership_type_id] = $membership;
- unset($contribution->_relatedObjects['membership'][$membershipTypeIdKey]);
- unset($memberships[$membershipTypeIdKey]);
- }
- }
- }
- //update the memberships object with updated membershipTypeId data
- //if membershipTypeId has changed after membership update
- if (!empty($membershipsUpdate)) {
- $memberships = $memberships + $membershipsUpdate;
- }
- }
- }
- else {
- // event
- $eventParams = array('id' => $objects['event']->id);
- $values['event'] = array();
-
- CRM_Event_BAO_Event::retrieve($eventParams, $values['event']);
-
- //get location details
- $locationParams = array('entity_id' => $objects['event']->id, 'entity_table' => 'civicrm_event');
- $values['location'] = CRM_Core_BAO_Location::getValues($locationParams);
-
- $ufJoinParams = array(
- 'entity_table' => 'civicrm_event',
- 'entity_id' => $ids['event'],
- 'module' => 'CiviEvent',
- );
-
- list($custom_pre_id,
- $custom_post_ids
- ) = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
-
- $values['custom_pre_id'] = $custom_pre_id;
- $values['custom_post_id'] = $custom_post_ids;
- //for tasks 'Change Participant Status' and 'Batch Update Participants Via Profile' case
- //and cases involving status updation through ipn
- $values['totalAmount'] = $input['amount'];
-
- $contribution->source = ts('Online Event Registration') . ': ' . $values['event']['title'];
-
- if ($values['event']['is_email_confirm']) {
- $contribution->receipt_date = self::$_now;
- $values['is_email_receipt'] = 1;
- }
- if (empty($input['skipComponentSync'])) {
- $participant->status_id = 1;
- }
- $participant->save();
- }
-
- if (CRM_Utils_Array::value('net_amount', $input, 0) == 0 &&
- CRM_Utils_Array::value('fee_amount', $input, 0) != 0
- ) {
- $input['net_amount'] = $input['amount'] - $input['fee_amount'];
- }
- $addLineItems = FALSE;
- if (empty($contribution->id)) {
- $addLineItems = TRUE;
- }
-
- $contribution->contribution_status_id = 1;
- $contribution->is_test = $input['is_test'];
- $contribution->fee_amount = CRM_Utils_Array::value('fee_amount', $input, 0);
- $contribution->net_amount = CRM_Utils_Array::value('net_amount', $input, 0);
- $contribution->trxn_id = $input['trxn_id'];
- $contribution->receive_date = CRM_Utils_Date::isoToMysql($contribution->receive_date);
- $contribution->thankyou_date = CRM_Utils_Date::isoToMysql($contribution->thankyou_date);
- $contribution->receipt_date = CRM_Utils_Date::isoToMysql($contribution->receipt_date);
- $contribution->cancel_date = 'null';
-
- if (!empty($input['check_number'])) {
- $contribution->check_number = $input['check_number'];
- }
-
- if (!empty($input['payment_instrument_id'])) {
- $contribution->payment_instrument_id = $input['payment_instrument_id'];
- }
-
- if ($contribution->id) {
- $contributionId['id'] = $contribution->id;
- $input['prevContribution'] = CRM_Contribute_BAO_Contribution::getValues($contributionId, CRM_Core_DAO::$_nullArray, CRM_Core_DAO::$_nullArray);
- }
- $contribution->save();
-
- //add new soft credit against current $contribution and
- if (CRM_Utils_Array::value('contributionRecur', $objects) && $objects['contributionRecur']->id) {
- $this->addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id);
- }
-
- //add lineitems for recurring payments
- if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id && $addLineItems) {
- $this->addrecurLineItems($objects['contributionRecur']->id, $contribution->id, $input);
- }
-
- //copy initial contribution custom fields for recurring contributions
- if ($recurContrib && $recurContrib->id) {
- $this->copyCustomValues($recurContrib->id, $contribution->id);
- }
-
- // next create the transaction record
- $paymentProcessor = $paymentProcessorId = '';
- if (isset($objects['paymentProcessor'])) {
- if (is_array($objects['paymentProcessor'])) {
- $paymentProcessor = $objects['paymentProcessor']['payment_processor_type'];
- $paymentProcessorId = $objects['paymentProcessor']['id'];
- }
- else {
- $paymentProcessor = $objects['paymentProcessor']->payment_processor_type;
- $paymentProcessorId = $objects['paymentProcessor']->id;
- }
- }
- //it's hard to see how it could reach this point without a contributon id as it is saved in line 511 above
- // which raised the question as to whether this check preceded line 511 & if so whether something could be broken
- // From a lot of code reading /debugging I'm still not sure the intent WRT first & subsequent payments in this code
- // it would be good if someone added some comments or refactored this
- if ($contribution->id) {
- $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
- if ((empty($input['prevContribution']) && $paymentProcessorId) || (!$input['prevContribution']->is_pay_later &&
- $input['prevContribution']->contribution_status_id == array_search('Pending', $contributionStatuses))) {
- $input['payment_processor'] = $paymentProcessorId;
- }
- $input['contribution_status_id'] = array_search('Completed', $contributionStatuses);
- $input['total_amount'] = $input['amount'];
- $input['contribution'] = $contribution;
- $input['financial_type_id'] = $contribution->financial_type_id;
-
- if (!empty($contribution->_relatedObjects['participant'])) {
- $input['contribution_mode'] = 'participant';
- $input['participant_id'] = $contribution->_relatedObjects['participant']->id;
- $input['skipLineItem'] = 1;
- }
- elseif (!empty($contribution->_relatedObjects['membership'])) {
- $input['skipLineItem'] = TRUE;
- $input['contribution_mode'] = 'membership';
- }
- //@todo writing a unit test I was unable to create a scenario where this line did not fatal on second
- // and subsequent payments. In this case the line items are created at $this->addrecurLineItems
- // and since the contribution is saved prior to this line there is always a contribution-id,
- // however there is never a prevContribution (which appears to mean original contribution not previous
- // contribution - or preUpdateContributionObject most accurately)
- // so, this is always called & only appears to succeed when prevContribution exists - which appears
- // to mean "are we updating an exisitng pending contribution"
- //I was able to make the unit test complete as fataling here doesn't prevent
- // the contribution being created - but activities would not be created or emails sent
- CRM_Contribute_BAO_Contribution::recordFinancialAccounts($input, NULL);
- }
-
- self::updateRecurLinkedPledge($contribution);
-
- // create an activity record
- if ($input['component'] == 'contribute') {
- //CRM-4027
- $targetContactID = NULL;
- if (!empty($ids['related_contact'])) {
- $targetContactID = $contribution->contact_id;
- $contribution->contact_id = $ids['related_contact'];
- }
- CRM_Activity_BAO_Activity::addActivity($contribution, NULL, $targetContactID);
- // event
- }
- else {
- CRM_Activity_BAO_Activity::addActivity($participant);
- }
-
- CRM_Core_Error::debug_log_message("Contribution record updated successfully");
- $transaction->commit();
-
- // CRM-9132 legacy behaviour was that receipts were sent out in all instances. Still sending
- // when array_key 'is_email_receipt doesn't exist in case some instances where is needs setting haven't been set
- if (!array_key_exists('is_email_receipt', $values) ||
- $values['is_email_receipt'] == 1
- ) {
- self::sendMail($input, $ids, $objects, $values, $recur, FALSE);
- CRM_Core_Error::debug_log_message("Receipt sent");
- }
-
- CRM_Core_Error::debug_log_message("Success: Database updated");
+ CRM_Contribute_BAO_Contribution::completeOrder($input, $ids, $objects, $transaction, $recur, $contribution,
+ $isRecurring, $isFirstOrLastRecurringPayment);
}
/**
- * @param $ids
+ * Get site billing ID.
+ *
+ * @param array $ids
*
* @return bool
*/
- function getBillingID(&$ids) {
+ public function getBillingID(&$ids) {
// get the billing location type
$locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id', array(), 'validate');
- // CRM-8108 remove the ts around the Billing locationtype
+ // CRM-8108 remove the ts around the Billing location type
//$ids['billing'] = array_search( ts('Billing'), $locationTypes );
$ids['billing'] = array_search('Billing', $locationTypes);
if (!$ids['billing']) {
return TRUE;
}
- /*
- * Send receipt from contribution. Note that the compose message part has been moved to contribution
+ /**
+ * Send receipt from contribution.
+ *
+ * @deprecated
+ *
+ * Note that the compose message part has been moved to contribution
* In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it
*
- * @params array $input Incoming data from Payment processor
- * @params array $ids Related object IDs
- * @params array $values values related to objects that have already been loaded
- * @params bool $recur is it part of a recurring contribution
- * @params bool $returnMessageText Should text be returned instead of sent. This
- * is because the function is also used to generate pdfs
- */
- /**
- * @param $input
- * @param $ids
+ * @param array $input
+ * Incoming data from Payment processor.
+ * @param array $ids
+ * Related object IDs.
* @param $objects
- * @param $values
+ * @param array $values
+ * Values related to objects that have already been loaded.
* @param bool $recur
+ * Is it part of a recurring contribution.
* @param bool $returnMessageText
+ * Should text be returned instead of sent. This.
+ * is because the function is also used to generate pdfs
*
- * @return mixed
+ * @return array
*/
- function sendMail(&$input, &$ids, &$objects, &$values, $recur = FALSE, $returnMessageText = FALSE) {
- $contribution = &$objects['contribution'];
- $input['is_recur'] = $recur;
- // set receipt from e-mail and name in value
- if (!$returnMessageText) {
- $session = CRM_Core_Session::singleton();
- $userID = $session->get('userID');
- if (!empty($userID)) {
- list($userName, $userEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($userID);
- $values['receipt_from_email'] = $userEmail;
- $values['receipt_from_name'] = $userName;
- }
- }
- return $contribution->composeMessageArray($input, $ids, $values, $recur, $returnMessageText);
+ public function sendMail(&$input, &$ids, &$objects, &$values, $recur = FALSE, $returnMessageText = FALSE) {
+ return CRM_Contribute_BAO_Contribution::sendMail($input, $ids, $objects, $values, $recur, $returnMessageText);
}
- /**
- * Update contribution status - this is only called from one place in the code &
- * it is unclear whether it is a function on the way in or on the way out
- *
- * @param unknown_type $params
- * @return void|Ambigous <value, unknown, array>
- */
- function updateContributionStatus(&$params) {
- // get minimum required values.
- $statusId = CRM_Utils_Array::value('contribution_status_id', $params);
- $componentId = CRM_Utils_Array::value('component_id', $params);
- $componentName = CRM_Utils_Array::value('componentName', $params);
- $contributionId = CRM_Utils_Array::value('contribution_id', $params);
-
- if (!$contributionId || !$componentId || !$componentName || !$statusId) {
- return;
- }
-
- $input = $ids = $objects = array();
-
- //get the required ids.
- $ids['contribution'] = $contributionId;
-
- if (!$ids['contact'] = CRM_Utils_Array::value('contact_id', $params)) {
- $ids['contact'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
- $contributionId,
- 'contact_id'
- );
- }
-
- if ($componentName == 'Event') {
- $name = 'event';
- $ids['participant'] = $componentId;
-
- if (!$ids['event'] = CRM_Utils_Array::value('event_id', $params)) {
- $ids['event'] = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant',
- $componentId,
- 'event_id'
- );
- }
- }
-
- if ($componentName == 'Membership') {
- $name = 'contribute';
- $ids['membership'] = $componentId;
- }
- $ids['contributionPage'] = NULL;
- $ids['contributionRecur'] = NULL;
- $input['component'] = $name;
-
- $baseIPN = new CRM_Core_Payment_BaseIPN();
- $transaction = new CRM_Core_Transaction();
-
- // reset template values.
- $template = CRM_Core_Smarty::singleton();
- $template->clearTemplateVars();
-
- if (!$baseIPN->validateData($input, $ids, $objects, FALSE)) {
- CRM_Core_Error::fatal();
- }
-
- $contribution = &$objects['contribution'];
-
- $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
- $input['skipComponentSync'] = CRM_Utils_Array::value('skipComponentSync', $params);
- if ($statusId == array_search('Cancelled', $contributionStatuses)) {
- $baseIPN->cancelled($objects, $transaction, $input);
- $transaction->commit();
- return $statusId;
- }
- elseif ($statusId == array_search('Failed', $contributionStatuses)) {
- $baseIPN->failed($objects, $transaction, $input);
- $transaction->commit();
- return $statusId;
- }
-
- // status is not pending
- if ($contribution->contribution_status_id != array_search('Pending', $contributionStatuses)) {
- $transaction->commit();
- return;
- }
-
- //set values for ipn code.
- foreach (array(
- 'fee_amount', 'check_number', 'payment_instrument_id') as $field) {
- if (!$input[$field] = CRM_Utils_Array::value($field, $params)) {
- $input[$field] = $contribution->$field;
- }
- }
- if (!$input['trxn_id'] = CRM_Utils_Array::value('trxn_id', $params)) {
- $input['trxn_id'] = $contribution->invoice_id;
- }
- if (!$input['amount'] = CRM_Utils_Array::value('total_amount', $params)) {
- $input['amount'] = $contribution->total_amount;
- }
- $input['is_test'] = $contribution->is_test;
- $input['net_amount'] = $contribution->net_amount;
- if (!empty($input['fee_amount']) && !empty($input['amount'])) {
- $input['net_amount'] = $input['amount'] - $input['fee_amount'];
- }
-
- //complete the contribution.
- $baseIPN->completeTransaction($input, $ids, $objects, $transaction, FALSE);
-
- // reset template values before processing next transactions
- $template->clearTemplateVars();
-
- return $statusId;
- }
-
- /*
- * Update pledge associated with a recurring contribution
- *
- * If the contribution has a pledge_payment record pledge, then update the pledge_payment record & pledge based on that linkage.
- *
- * If a previous contribution in the recurring contribution sequence is linked with a pledge then we assume this contribution
- * should be linked with the same pledge also. Currently only back-office users can apply a recurring payment to a pledge &
- * it should be assumed they
- * do so with the intention that all payments will be linked
- *
- * The pledge payment record should already exist & will need to be updated with the new contribution ID.
- * If not the contribution will also need to be linked to the pledge
- */
- /**
- * @param $contribution
- */
- function updateRecurLinkedPledge(&$contribution) {
- $returnProperties = array('id', 'pledge_id');
- $paymentDetails = $paymentIDs = array();
-
- if (CRM_Core_DAO::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'contribution_id', $contribution->id,
- $paymentDetails, $returnProperties
- )) {
- foreach ($paymentDetails as $key => $value) {
- $paymentIDs[] = $value['id'];
- $pledgeId = $value['pledge_id'];
- }
- }
- else {
- //payment is not already linked - if it is linked with a pledge we need to create a link.
- // return if it is not recurring contribution
- if (!$contribution->contribution_recur_id) {
- return;
- }
-
- $relatedContributions = new CRM_Contribute_DAO_Contribution();
- $relatedContributions->contribution_recur_id = $contribution->contribution_recur_id;
- $relatedContributions->find();
-
- while ($relatedContributions->fetch()) {
- CRM_Core_DAO::commonRetrieveAll('CRM_Pledge_DAO_PledgePayment', 'contribution_id', $relatedContributions->id,
- $paymentDetails, $returnProperties
- );
- }
-
- if (empty($paymentDetails)) {
- // payment is not linked with a pledge and neither are any other contributions on this
- return;
- }
-
- foreach ($paymentDetails as $key => $value) {
- $pledgeId = $value['pledge_id'];
- }
-
- // we have a pledge now we need to get the oldest unpaid payment
- $paymentDetails = CRM_Pledge_BAO_PledgePayment::getOldestPledgePayment($pledgeId);
- if(empty($paymentDetails['id'])){
- // we can assume this pledge is now completed
- // return now so we don't create a core error & roll back
- return;
- }
- $paymentDetails['contribution_id'] = $contribution->id;
- $paymentDetails['status_id'] = $contribution->contribution_status_id;
- $paymentDetails['actual_amount'] = $contribution->total_amount;
-
- // put contribution against it
- $payment = CRM_Pledge_BAO_PledgePayment::add($paymentDetails);
- $paymentIDs[] = $payment->id;
- }
-
- // update pledge and corresponding payment statuses
- CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeId, $paymentIDs, $contribution->contribution_status_id,
- NULL, $contribution->total_amount
- );
- }
-
- /**
- * @param $recurId
- * @param $contributionId
- * @param $input
- */
- function addrecurLineItems($recurId, $contributionId, &$input) {
- $lineSets = $lineItems = array();
-
- //Get the first contribution id with recur id
- if ($recurId) {
- $contriID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id');
- $lineItems = CRM_Price_BAO_LineItem::getLineItems($contriID, 'contribution');
- if (!empty($lineItems)) {
- foreach ($lineItems as $key => $value) {
- $pricesetID = new CRM_Price_DAO_PriceField();
- $pricesetID->id = $value['price_field_id'];
- $pricesetID->find(TRUE);
- $lineSets[$pricesetID->price_set_id][] = $value;
- }
- }
- if (!empty($input)) {
- $input['line_item'] = $lineSets;
- }
- else {
- CRM_Price_BAO_LineItem::processPriceSet($contributionId, $lineSets);
- }
- }
- }
-
- // function to copy custom data of the
- // initial contribution into its recurring contributions
- /**
- * @param $recurId
- * @param $targetContributionId
- */
- function copyCustomValues($recurId, $targetContributionId) {
- if ($recurId && $targetContributionId) {
- // get the initial contribution id of recur id
- $sourceContributionId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id');
-
- // if the same contribution is being proccessed then return
- if ($sourceContributionId == $targetContributionId) {
- return;
- }
- // check if proper recurring contribution record is being processed
- $targetConRecurId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $targetContributionId, 'contribution_recur_id');
- if ($targetConRecurId != $recurId) {
- return;
- }
-
- // copy custom data
- $extends = array('Contribution');
- $groupTree = CRM_Core_BAO_CustomGroup::getGroupDetail(NULL, NULL, $extends);
- if ($groupTree) {
- foreach ($groupTree as $groupID => $group) {
- $table[$groupTree[$groupID]['table_name']] = array('entity_id');
- foreach ($group['fields'] as $fieldID => $field) {
- $table[$groupTree[$groupID]['table_name']][] = $groupTree[$groupID]['fields'][$fieldID]['column_name'];
- }
- }
-
- foreach ($table as $tableName => $tableColumns) {
- $insert = 'INSERT INTO ' . $tableName . ' (' . implode(', ', $tableColumns) . ') ';
- $tableColumns[0] = $targetContributionId;
- $select = 'SELECT ' . implode(', ', $tableColumns);
- $from = ' FROM ' . $tableName;
- $where = " WHERE {$tableName}.entity_id = {$sourceContributionId}";
- $query = $insert . $select . $from . $where;
- $dao = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
- }
- }
- }
- }
-
- // function to copy soft credit record of first recurring contribution
- // and add new soft credit against $targetContributionId
- /**
- * @param $recurId
- * @param $targetContributionId
- */
- function addrecurSoftCredit($recurId, $targetContributionId) {
- $contriID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id');
-
- $soft_contribution = new CRM_Contribute_DAO_ContributionSoft();
- $soft_contribution->contribution_id = $contriID;
-
- //check if first recurring contribution has any associated soft credit
- if ($soft_contribution->find(TRUE)) {
- $soft_contribution->contribution_id = $targetContributionId;
- unset($soft_contribution->id);
- $soft_contribution->save();
- }
- }
}
projects / civicrm-core.git / blobdiff