Merge pull request #6380 from colemanw/CRM-16478
[civicrm-core.git] / CRM / Core / Payment / BaseIPN.php
index b9c52bfd591a67786a37cc634f677a1533fbf651..9192b867d68ab694f4864e666376f399af7253de 100644 (file)
@@ -217,14 +217,14 @@ class CRM_Core_Payment_BaseIPN {
 
     // Add line items for recurring payments.
     if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id && $addLineItems) {
-      $this->addRecurLineItems($objects['contributionRecur']->id, $contribution);
+      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'])) {
@@ -312,14 +312,14 @@ class CRM_Core_Payment_BaseIPN {
 
     //add lineitems for recurring payments
     if (!empty($objects['contributionRecur']) && $objects['contributionRecur']->id && $addLineItems) {
-      $this->addRecurLineItems($objects['contributionRecur']->id, $contribution);
+      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'])) {
@@ -424,361 +424,12 @@ class CRM_Core_Payment_BaseIPN {
    * @param bool $recur
    */
   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'];
-
-    $changeToday = CRM_Utils_Array::value('trxn_date', $input, self::$_now);
-    $recurContrib = &$objects['contributionRecur'];
-
-    $values = array();
-    if (isset($input['is_email_receipt'])) {
-      $values['is_email_receipt'] = $input['is_email_receipt'];
-    }
-    $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 && !isset($input['is_email_receipt'])) {
-        //CRM-13273 - is_email_receipt setting on recurring contribution should take precedence over contribution page setting
-        // but CRM-16124 if $input['is_email_receipt'] is set then that should not be overridden.
-        $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'])) {
-        $participantStatuses = CRM_Core_PseudoConstant::get('CRM_Event_DAO_Participant', 'status_id', array(
-            'labelColumn' => 'name',
-            'flip' => 1,
-          ));
-        $participant->status_id = $participantStatuses['Registered'];
-      }
-      $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'];
-    }
-    // This complete transaction function is being overloaded to create new contributions too.
-    // here we record if it is a new contribution.
-    // @todo separate the 2 more appropriately.
-    $isNewContribution = FALSE;
-    if (empty($contribution->id)) {
-      $isNewContribution = TRUE;
-    }
-    $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
-        'labelColumn' => 'name',
-        'flip' => 1,
-      ));
-
-    // @todo this section should call the api  in order to have hooks called &
-    // because all this 'messiness' setting variables could be avoided
-    // by letting the api resolve pseudoconstants & copy set values and format dates.
-    $contribution->contribution_status_id = $contributionStatuses['Completed'];
-    $contribution->is_test = $input['is_test'];
-
-    // CRM-15960 If we don't have a value we 'want' for the amounts, leave it to the BAO to sort out.
-    if (isset($input['net_amount'])) {
-      $contribution->fee_amount = CRM_Utils_Array::value('fee_amount', $input, 0);
-    }
-    if (isset($input['net_amount'])) {
-      $contribution->net_amount = $input['net_amount'];
-    }
-
-    $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 (!empty($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.
-    if (CRM_Utils_Array::value('contributionRecur', $objects) && $objects['contributionRecur']->id) {
-      $this->addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id);
-    }
-
-    //add line items for recurring payments
-    if (!empty($contribution->contribution_recur_id)) {
-      if ($isNewContribution) {
-        $input['line_item'] = $this->addRecurLineItems($contribution->contribution_recur_id, $contribution);
-      }
-      else {
-        // this is just to prevent e-notices when we call recordFinancialAccounts - per comments on that line - intention is somewhat unclear
-        $input['line_item'] = array();
-      }
-    }
-
-    //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_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
-          'labelColumn' => 'name',
-          'flip' => 1,
-        ));
-      if ((empty($input['prevContribution']) && $paymentProcessorId) || (!$input['prevContribution']->is_pay_later && $input['prevContribution']->contribution_status_id == $contributionStatuses['Pending'])) {
-        $input['payment_processor'] = $paymentProcessorId;
-      }
-      $input['contribution_status_id'] = $contributionStatuses['Completed'];
-      $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");
-    if ($this->_isRecurring) {
-      $this->sendRecurringStartOrEndNotification($ids, $recur);
-    }
+    CRM_Contribute_BAO_Contribution::completeOrder($input, $ids, $objects, $transaction, $recur, $contribution,
+      $isRecurring, $isFirstOrLastRecurringPayment);
   }
 
   /**
@@ -805,6 +456,8 @@ LIMIT 1;";
   /**
    * 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
    *
@@ -824,345 +477,7 @@ LIMIT 1;";
    * @return array
    */
   public 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'] = CRM_Utils_Array::value('receipt_from_email', $input, $userEmail);
-        $values['receipt_from_name'] = CRM_Utils_Array::value('receipt_from_name', $input, $userName);
-      }
-    }
-    return $contribution->composeMessageArray($input, $ids, $values, $recur, $returnMessageText);
-  }
-
-  /**
-   * Send start or end notification for recurring payments.
-   *
-   * @param array $ids
-   * @param $recur
-   */
-  public function sendRecurringStartOrEndNotification($ids, $recur) {
-    if ($this->_isFirstOrLastRecurringPayment) {
-      $autoRenewMembership = FALSE;
-      if ($recur->id &&
-        isset($ids['membership']) && $ids['membership']
-      ) {
-        $autoRenewMembership = TRUE;
-      }
-
-      //send recurring Notification email for user
-      CRM_Contribute_BAO_ContributionPage::recurringNotify($this->_isFirstOrLastRecurringPayment,
-        $ids['contact'],
-        $ids['contributionPage'],
-        $recur,
-        $autoRenewMembership
-      );
-    }
-  }
-
-  /**
-   * Update contribution status.
-   *
-   * @deprecated
-   * 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 array $params
-   *
-   * @return void|NULL|int
-   */
-  public 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 NULL;
-    }
-
-    $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_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
-        'labelColumn' => 'name',
-        'flip' => 1,
-      ));
-    $input['skipComponentSync'] = CRM_Utils_Array::value('skipComponentSync', $params);
-    if ($statusId == $contributionStatuses['Cancelled']) {
-      $baseIPN->cancelled($objects, $transaction, $input);
-      $transaction->commit();
-      return $statusId;
-    }
-    elseif ($statusId == $contributionStatuses['Failed']) {
-      $baseIPN->failed($objects, $transaction, $input);
-      $transaction->commit();
-      return $statusId;
-    }
-
-    // status is not pending
-    if ($contribution->contribution_status_id != $contributionStatuses['Pending']) {
-      $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 CRM_Contribute_BAO_Contribution $contribution
-   */
-  public 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
-    );
-  }
-
-  /**
-   * Add line items for recurring contribution.
-   *
-   * @param int $recurId
-   * @param $contribution
-   *
-   * @return array
-   */
-  public function addRecurLineItems($recurId, $contribution) {
-    $lineSets = array();
-
-    $originalContributionID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id');
-    $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($originalContributionID);
-    if (!empty($lineItems)) {
-      foreach ($lineItems as $key => $value) {
-        $priceField = new CRM_Price_DAO_PriceField();
-        $priceField->id = $value['price_field_id'];
-        $priceField->find(TRUE);
-        $lineSets[$priceField->price_set_id][] = $value;
-        if ($value['entity_table'] == 'civicrm_membership') {
-          try {
-            civicrm_api3('membership_payment', 'create', array(
-                'membership_id' => $value['entity_id'],
-                'contribution_id' => $contribution->id,
-              ));
-          }
-          catch (CiviCRM_API3_Exception $e) {
-            // we are catching & ignoring errors as an extra precaution since lost IPNs may be more serious that lost membership_payment data
-            // this fn is unit-tested so risk of changes elsewhere breaking it are otherwise mitigated
-          }
-        }
-      }
-    }
-    else {
-      CRM_Price_BAO_LineItem::processPriceSet($contribution->id, $lineSets, $contribution);
-    }
-    return $lineSets;
-  }
-
-  /**
-   * Copy custom data of the initial contribution into its recurring contributions.
-   *
-   * @param int $recurId
-   * @param int $targetContributionId
-   */
-  public 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);
-        }
-      }
-    }
-  }
-
-  /**
-   * Add soft credit to for recurring payment.
-   *
-   * copy soft credit record of first recurring contribution.
-   * and add new soft credit against $targetContributionId
-   *
-   * @param int $recurId
-   * @param int $targetContributionId
-   */
-  public function addrecurSoftCredit($recurId, $targetContributionId) {
-    $soft_contribution = new CRM_Contribute_DAO_ContributionSoft();
-    $soft_contribution->contribution_id = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $recurId, 'id', 'contribution_recur_id');
-
-    // 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();
-    }
+    return CRM_Contribute_BAO_Contribution::sendMail($input, $ids, $objects, $values, $recur, $returnMessageText);
   }
 
 }