CRM/Contribute/BAO/Contribution.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33 class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution {
  34
  35   /**
  36    * Static field for all the contribution information that we can potentially import
  37    *
  38    * @var array
  39    */
  40   public static $_importableFields = NULL;
  41
  42   /**
  43    * Static field for all the contribution information that we can potentially export
  44    *
  45    * @var array
  46    */
  47   public static $_exportableFields = NULL;
  48
  49   /**
  50    * Static field to hold financial trxn id's.
  51    *
  52    * @var array
  53    */
  54   public static $_trxnIDs = NULL;
  55
  56   /**
  57    * Field for all the objects related to this contribution
  58    *
  59    * @var \CRM_Member_BAO_Membership|\CRM_Event_BAO_Participant[]
  60    */
  61   public $_relatedObjects = [];
  62
  63   /**
  64    * Field for the component - either 'event' (participant) or 'contribute'
  65    * (any item related to a contribution page e.g. membership, pledge, contribution)
  66    * This is used for composing messages because they have dependency on the
  67    * contribution_page or event page - although over time we may eliminate that
  68    *
  69    * @var "contribution"\"event"
  70    */
  71   public $_component = NULL;
  72
  73   /**
  74    * Possibly obsolete variable.
  75    *
  76    * If you use it please explain why it is set in the create function here.
  77    *
  78    * @var string
  79    */
  80   public $trxn_result_code;
  81
  82   /**
  83    * Class constructor.
  84    */
  85   public function __construct() {
  86     parent::__construct();
  87   }
  88
  89   /**
  90    * Takes an associative array and creates a contribution object.
  91    *
  92    * the function extract all the params it needs to initialize the create a
  93    * contribution object. the params array could contain additional unused name/value
  94    * pairs
  95    *
  96    * @param array $params
  97    *   (reference ) an assoc array of name/value pairs.
  98    * @param array $ids
  99    *   The array that holds all the db ids.
 100    *
 101    * @return \CRM_Contribute_BAO_Contribution
 102    * @throws \CRM_Core_Exception
 103    * @throws \CiviCRM_API3_Exception
 104    */
 105   public static function add(&$params, $ids = []) {
 106     if (empty($params)) {
 107       return NULL;
 108     }
 109     //per http://wiki.civicrm.org/confluence/display/CRM/Database+layer we are moving away from $ids array
 110     $contributionID = CRM_Utils_Array::value('contribution', $ids, CRM_Utils_Array::value('id', $params));
 111     $duplicates = [];
 112     if (self::checkDuplicate($params, $duplicates, $contributionID)) {
 113       $message = ts("Duplicate error - existing contribution record(s) have a matching Transaction ID or Invoice ID. Contribution record ID(s) are: %1", [1 => implode(', ', $duplicates)]);
 114       throw new CRM_Core_Exception($message);
 115     }
 116
 117     // first clean up all the money fields
 118     $moneyFields = [
 119       'total_amount',
 120       'net_amount',
 121       'fee_amount',
 122       'non_deductible_amount',
 123     ];
 124
 125     //if priceset is used, no need to cleanup money
 126     if (!empty($params['skipCleanMoney'])) {
 127       $moneyFields = [];
 128     }
 129     else {
 130       // @todo put a deprecated here - this should be done in the form layer.
 131       $params['skipCleanMoney'] = FALSE;
 132       Civi::log()->warning('Deprecated code path. Money should always be clean before it hits the BAO.', array('civi.tag' => 'deprecated'));
 133     }
 134
 135     foreach ($moneyFields as $field) {
 136       if (isset($params[$field])) {
 137         $params[$field] = CRM_Utils_Rule::cleanMoney($params[$field]);
 138       }
 139     }
 140
 141     //set defaults in create mode
 142     if (!$contributionID) {
 143       CRM_Core_DAO::setCreateDefaults($params, self::getDefaults());
 144
 145       if (empty($params['invoice_number'])) {
 146         $nextContributionID = CRM_Core_DAO::singleValueQuery("SELECT COALESCE(MAX(id) + 1, 1) FROM civicrm_contribution");
 147         $params['invoice_number'] = self::getInvoiceNumber($nextContributionID);
 148       }
 149     }
 150
 151     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 152     //if contribution is created with cancelled or refunded status, add credit note id
 153     if (!empty($params['contribution_status_id'])) {
 154       // @todo - should we include Chargeback? If so use self::isContributionStatusNegative($params['contribution_status_id'])
 155       if (($params['contribution_status_id'] == array_search('Refunded', $contributionStatus)
 156         || $params['contribution_status_id'] == array_search('Cancelled', $contributionStatus))
 157       ) {
 158         if (empty($params['creditnote_id']) || $params['creditnote_id'] == "null") {
 159           $params['creditnote_id'] = self::createCreditNoteId();
 160         }
 161       }
 162     }
 163     else {
 164       // Since the fee amount is expecting this (later on) ensure it is always set.
 165       // It would only not be set for an update where it is unchanged.
 166       $params['contribution_status_id'] = civicrm_api3('Contribution', 'getvalue', [
 167         'id' => $contributionID,
 168         'return' => 'contribution_status_id',
 169       ]);
 170     }
 171
 172     if (!$contributionID
 173       && CRM_Utils_Array::value('membership_id', $params)
 174       && Civi::settings()->get('deferred_revenue_enabled')
 175     ) {
 176       $memberStartDate = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $params['membership_id'], 'start_date');
 177       if ($memberStartDate) {
 178         $params['revenue_recognition_date'] = date('Ymd', strtotime($memberStartDate));
 179       }
 180     }
 181     self::calculateMissingAmountParams($params, $contributionID);
 182
 183     if (!empty($params['payment_instrument_id'])) {
 184       $paymentInstruments = CRM_Contribute_PseudoConstant::paymentInstrument('name');
 185       if ($params['payment_instrument_id'] != array_search('Check', $paymentInstruments)) {
 186         $params['check_number'] = 'null';
 187       }
 188     }
 189
 190     $setPrevContribution = TRUE;
 191     // CRM-13964 partial payment
 192     if (!empty($params['partial_payment_total']) && !empty($params['partial_amount_to_pay'])) {
 193       $partialAmtTotal = $params['partial_payment_total'];
 194       $partialAmtPay = $params['partial_amount_to_pay'];
 195       $params['total_amount'] = $partialAmtTotal;
 196       if ($partialAmtPay < $partialAmtTotal) {
 197         $params['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Partially paid');
 198         $params['is_pay_later'] = 0;
 199         $setPrevContribution = FALSE;
 200       }
 201     }
 202     if ($contributionID && $setPrevContribution) {
 203       $params['prevContribution'] = self::getOriginalContribution($contributionID);
 204     }
 205
 206     if ($contributionID && !empty($params['revenue_recognition_date']) && !empty($params['prevContribution'])
 207       && !($contributionStatus[$params['prevContribution']->contribution_status_id] == 'Pending')
 208       && !self::allowUpdateRevenueRecognitionDate($contributionID)
 209     ) {
 210       unset($params['revenue_recognition_date']);
 211     }
 212
 213     if (!isset($params['tax_amount']) && $setPrevContribution && (isset($params['total_amount']) ||
 214      isset($params['financial_type_id']))) {
 215       $params = CRM_Contribute_BAO_Contribution::checkTaxAmount($params);
 216     }
 217
 218     if ($contributionID) {
 219       CRM_Utils_Hook::pre('edit', 'Contribution', $contributionID, $params);
 220     }
 221     else {
 222       CRM_Utils_Hook::pre('create', 'Contribution', NULL, $params);
 223     }
 224     $contribution = new CRM_Contribute_BAO_Contribution();
 225     $contribution->copyValues($params);
 226
 227     $contribution->id = $contributionID;
 228
 229     if (empty($contribution->id)) {
 230       // (only) on 'create', make sure that a valid currency is set (CRM-16845)
 231       if (!CRM_Utils_Rule::currencyCode($contribution->currency)) {
 232         $contribution->currency = CRM_Core_Config::singleton()->defaultCurrency;
 233       }
 234     }
 235
 236     $result = $contribution->save();
 237
 238     // Add financial_trxn details as part of fix for CRM-4724
 239     $contribution->trxn_result_code = CRM_Utils_Array::value('trxn_result_code', $params);
 240     $contribution->payment_processor = CRM_Utils_Array::value('payment_processor', $params);
 241
 242     //add Account details
 243     $params['contribution'] = $contribution;
 244     self::recordFinancialAccounts($params);
 245
 246     if (self::isUpdateToRecurringContribution($params)) {
 247       CRM_Contribute_BAO_ContributionRecur::updateOnNewPayment(
 248         (!empty($params['contribution_recur_id']) ? $params['contribution_recur_id'] : $params['prevContribution']->contribution_recur_id),
 249         $contributionStatus[$params['contribution_status_id']],
 250         CRM_Utils_Array::value('receive_date', $params)
 251       );
 252     }
 253
 254     CRM_Contact_BAO_GroupContactCache::opportunisticCacheFlush();
 255
 256     if ($contributionID) {
 257       CRM_Utils_Hook::post('edit', 'Contribution', $contribution->id, $contribution);
 258     }
 259     else {
 260       CRM_Utils_Hook::post('create', 'Contribution', $contribution->id, $contribution);
 261     }
 262
 263     return $result;
 264   }
 265
 266   /**
 267    * Is this contribution updating an existing recurring contribution.
 268    *
 269    * We need to upd the status of the linked recurring contribution if we have a new payment against it, or the initial
 270    * pending payment is being confirmed (or failing).
 271    *
 272    * @param array $params
 273    *
 274    * @return bool
 275    */
 276   public static function isUpdateToRecurringContribution($params) {
 277     if (!empty($params['contribution_recur_id']) && empty($params['id'])) {
 278       return TRUE;
 279     }
 280     if (empty($params['prevContribution']) || empty($params['contribution_status_id'])) {
 281       return FALSE;
 282     }
 283     if (empty($params['contribution_recur_id']) && empty($params['prevContribution']->contribution_recur_id)) {
 284       return FALSE;
 285     }
 286     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 287     if ($params['prevContribution']->contribution_status_id == array_search('Pending', $contributionStatus)) {
 288       return TRUE;
 289     }
 290     return FALSE;
 291   }
 292
 293   /**
 294    * Get defaults for new entity.
 295    *
 296    * @return array
 297    */
 298   public static function getDefaults() {
 299     return [
 300       'payment_instrument_id' => key(CRM_Core_OptionGroup::values('payment_instrument',
 301         FALSE, FALSE, FALSE, 'AND is_default = 1')
 302       ),
 303       'contribution_status_id' => CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed'),
 304       'receive_date' => date('Y-m-d H:i:s'),
 305     ];
 306   }
 307
 308   /**
 309    * Fetch the object and store the values in the values array.
 310    *
 311    * @param array $params
 312    *   Input parameters to find object.
 313    * @param array $values
 314    *   Output values of the object.
 315    * @param array $ids
 316    *   The array that holds all the db ids.
 317    *
 318    * @return CRM_Contribute_BAO_Contribution|null
 319    *   The found object or null
 320    */
 321   public static function getValues($params, &$values = [], &$ids = []) {
 322     if (empty($params)) {
 323       return NULL;
 324     }
 325     $contribution = new CRM_Contribute_BAO_Contribution();
 326
 327     $contribution->copyValues($params);
 328
 329     if ($contribution->find(TRUE)) {
 330       $ids['contribution'] = $contribution->id;
 331
 332       CRM_Core_DAO::storeValues($contribution, $values);
 333
 334       return $contribution;
 335     }
 336     // return by reference
 337     $null = NULL;
 338     return $null;
 339   }
 340
 341   /**
 342    * Get the values and resolve the most common mappings.
 343    *
 344    * Since contribution status is resolved in almost every function that calls getValues it makes
 345    * sense to have an extra function to resolve it rather than repeat the code.
 346    *
 347    * Think carefully before adding more mappings to be resolved as there could be performance implications
 348    * if this function starts to be called from more iterative functions.
 349    *
 350    * @param array $params
 351    *   Input parameters to find object.
 352    *
 353    * @return array
 354    *   Array of the found contribution.
 355    * @throws CRM_Core_Exception
 356    */
 357   public static function getValuesWithMappings($params) {
 358     $values = $ids = [];
 359     $contribution = self::getValues($params, $values, $ids);
 360     if (is_null($contribution)) {
 361       throw new CRM_Core_Exception('No contribution found');
 362     }
 363     $values['contribution_status'] = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $values['contribution_status_id']);
 364     return $values;
 365   }
 366
 367   /**
 368    * Calculate net_amount & fee_amount if they are not set.
 369    *
 370    * Net amount should be total - fee.
 371    * This should only be called for new contributions.
 372    *
 373    * @param array $params
 374    *   Params for a new contribution before they are saved.
 375    * @param int|null $contributionID
 376    *   Contribution ID if we are dealing with an update.
 377    *
 378    * @throws \CiviCRM_API3_Exception
 379    */
 380   public static function calculateMissingAmountParams(&$params, $contributionID) {
 381     if (!$contributionID && !isset($params['fee_amount'])) {
 382       if (isset($params['total_amount']) && isset($params['net_amount'])) {
 383         $params['fee_amount'] = $params['total_amount'] - $params['net_amount'];
 384       }
 385       else {
 386         $params['fee_amount'] = 0;
 387       }
 388     }
 389     if (!isset($params['net_amount'])) {
 390       if (!$contributionID) {
 391         $params['net_amount'] = $params['total_amount'] - $params['fee_amount'];
 392       }
 393       else {
 394         if (isset($params['fee_amount']) || isset($params['total_amount'])) {
 395           // We have an existing contribution and fee_amount or total_amount has been passed in but not net_amount.
 396           // net_amount may need adjusting.
 397           $contribution = civicrm_api3('Contribution', 'getsingle', [
 398             'id' => $contributionID,
 399             'return' => ['total_amount', 'net_amount', 'fee_amount'],
 400           ]);
 401           $totalAmount = (isset($params['total_amount']) ? (float) $params['total_amount'] : (float) CRM_Utils_Array::value('total_amount', $contribution));
 402           $feeAmount = (isset($params['fee_amount']) ? (float) $params['fee_amount'] : (float) CRM_Utils_Array::value('fee_amount', $contribution));
 403           $params['net_amount'] = $totalAmount - $feeAmount;
 404         }
 405       }
 406     }
 407   }
 408
 409   /**
 410    * @param $params
 411    * @param $billingLocationTypeID
 412    *
 413    * @return array
 414    */
 415   protected static function getBillingAddressParams($params, $billingLocationTypeID) {
 416     $hasBillingField = FALSE;
 417     $billingFields = [
 418       'street_address',
 419       'city',
 420       'state_province_id',
 421       'postal_code',
 422       'country_id',
 423     ];
 424
 425     //build address array
 426     $addressParams = [];
 427     $addressParams['location_type_id'] = $billingLocationTypeID;
 428     $addressParams['is_billing'] = 1;
 429
 430     $billingFirstName = CRM_Utils_Array::value('billing_first_name', $params);
 431     $billingMiddleName = CRM_Utils_Array::value('billing_middle_name', $params);
 432     $billingLastName = CRM_Utils_Array::value('billing_last_name', $params);
 433     $addressParams['address_name'] = "{$billingFirstName}" . CRM_Core_DAO::VALUE_SEPARATOR . "{$billingMiddleName}" . CRM_Core_DAO::VALUE_SEPARATOR . "{$billingLastName}";
 434
 435     foreach ($billingFields as $value) {
 436       $addressParams[$value] = CRM_Utils_Array::value("billing_{$value}-{$billingLocationTypeID}", $params);
 437       if (!empty($addressParams[$value])) {
 438         $hasBillingField = TRUE;
 439       }
 440     }
 441     return [$hasBillingField, $addressParams];
 442   }
 443
 444   /**
 445    * Get address params ready to be passed to the payment processor.
 446    *
 447    * We need address params in a couple of formats. For the payment processor we wan state_province_id-5.
 448    * To create an address we need state_province_id.
 449    *
 450    * @param array $params
 451    * @param int $billingLocationTypeID
 452    *
 453    * @return array
 454    */
 455   public static function getPaymentProcessorReadyAddressParams($params, $billingLocationTypeID) {
 456     list($hasBillingField, $addressParams) = self::getBillingAddressParams($params, $billingLocationTypeID);
 457     foreach ($addressParams as $name => $field) {
 458       if (substr($name, 0, 8) == 'billing_') {
 459         $addressParams[substr($name, 9)] = $addressParams[$field];
 460       }
 461     }
 462     return [$hasBillingField, $addressParams];
 463   }
 464
 465   /**
 466    * Get the number of terms for this contribution for a given membership type
 467    * based on querying the line item table and relevant price field values
 468    * Note that any one contribution should only be able to have one line item relating to a particular membership
 469    * type
 470    *
 471    * @param int $membershipTypeID
 472    *
 473    * @param int $contributionID
 474    *
 475    * @return int
 476    */
 477   public function getNumTermsByContributionAndMembershipType($membershipTypeID, $contributionID) {
 478     $numTerms = CRM_Core_DAO::singleValueQuery("
 479       SELECT membership_num_terms FROM civicrm_line_item li
 480       LEFT JOIN civicrm_price_field_value v ON li.price_field_value_id = v.id
 481       WHERE contribution_id = %1 AND membership_type_id = %2",
 482       [1 => [$contributionID, 'Integer'], 2 => [$membershipTypeID, 'Integer']]
 483     );
 484     // default of 1 is precautionary
 485     return empty($numTerms) ? 1 : $numTerms;
 486   }
 487
 488   /**
 489    * Takes an associative array and creates a contribution object.
 490    *
 491    * @param array $params
 492    *   (reference ) an assoc array of name/value pairs.
 493    * @param array $ids
 494    *   The array that holds all the db ids.
 495    *
 496    * @return CRM_Contribute_BAO_Contribution
 497    */
 498   public static function create(&$params, $ids = []) {
 499     $contributionID = CRM_Utils_Array::value('contribution', $ids, CRM_Utils_Array::value('id', $params));
 500     $action = $contributionID ? 'edit' : 'create';
 501
 502     $dateFields = [
 503       'receive_date',
 504       'cancel_date',
 505       'receipt_date',
 506       'thankyou_date',
 507       'revenue_recognition_date',
 508     ];
 509     foreach ($dateFields as $df) {
 510       if (isset($params[$df])) {
 511         $params[$df] = CRM_Utils_Date::isoToMysql($params[$df]);
 512       }
 513     }
 514
 515     $transaction = new CRM_Core_Transaction();
 516
 517     try {
 518       $contribution = self::add($params, $ids);
 519     }
 520     catch (CRM_Core_Exception $e) {
 521       $transaction->rollback();
 522       throw $e;
 523     }
 524
 525     $params['contribution_id'] = $contribution->id;
 526
 527     if (!empty($params['custom']) &&
 528       is_array($params['custom'])
 529     ) {
 530       CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_contribution', $contribution->id, $action);
 531     }
 532
 533     $session = CRM_Core_Session::singleton();
 534
 535     if (!empty($params['note'])) {
 536       $noteParams = [
 537         'entity_table' => 'civicrm_contribution',
 538         'note' => $params['note'],
 539         'entity_id' => $contribution->id,
 540         'contact_id' => $session->get('userID'),
 541         'modified_date' => date('Ymd'),
 542       ];
 543       if (!$noteParams['contact_id']) {
 544         $noteParams['contact_id'] = $params['contact_id'];
 545       }
 546       CRM_Core_BAO_Note::add($noteParams);
 547     }
 548
 549     // make entry in batch entity batch table
 550     if (!empty($params['batch_id'])) {
 551       // in some update cases we need to get extra fields - ie an update that doesn't pass in all these params
 552       $titleFields = [
 553         'contact_id',
 554         'total_amount',
 555         'currency',
 556         'financial_type_id',
 557       ];
 558       $retrieveRequired = 0;
 559       foreach ($titleFields as $titleField) {
 560         if (!isset($contribution->$titleField)) {
 561           $retrieveRequired = 1;
 562           break;
 563         }
 564       }
 565       if ($retrieveRequired == 1) {
 566         $contribution->find(TRUE);
 567       }
 568     }
 569
 570     CRM_Contribute_BAO_ContributionSoft::processSoftContribution($params, $contribution);
 571
 572     $transaction->commit();
 573
 574     $activity = civicrm_api3('Activity', 'get', [
 575       'source_record_id' => $contribution->id,
 576       'options' => ['limit' => 1],
 577       'sequential' => 1,
 578       'activity_type_id' => 'Contribution',
 579       'return' => ['id', 'campaign'],
 580     ]);
 581
 582     //CRM-18406: Update activity when edit contribution.
 583     if ($activity['count']) {
 584       // CRM-13237 : if activity record found, update it with campaign id of contribution
 585       // @todo compare campaign ids first.
 586       CRM_Core_DAO::setFieldValue('CRM_Activity_BAO_Activity', $activity['id'], 'campaign_id', $contribution->campaign_id);
 587       $contribution->activity_id = $activity['id'];
 588     }
 589
 590     if (empty($contribution->contact_id)) {
 591       $contribution->find(TRUE);
 592     }
 593     CRM_Activity_BAO_Activity::addActivity($contribution, 'Contribution');
 594
 595     // do not add to recent items for import, CRM-4399
 596     if (empty($params['skipRecentView'])) {
 597       $url = CRM_Utils_System::url('civicrm/contact/view/contribution',
 598         "action=view&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
 599       );
 600       // in some update cases we need to get extra fields - ie an update that doesn't pass in all these params
 601       $titleFields = [
 602         'contact_id',
 603         'total_amount',
 604         'currency',
 605         'financial_type_id',
 606       ];
 607       $retrieveRequired = 0;
 608       foreach ($titleFields as $titleField) {
 609         if (!isset($contribution->$titleField)) {
 610           $retrieveRequired = 1;
 611           break;
 612         }
 613       }
 614       if ($retrieveRequired == 1) {
 615         $contribution->find(TRUE);
 616       }
 617       $financialType = CRM_Contribute_PseudoConstant::financialType($contribution->financial_type_id);
 618       $title = CRM_Contact_BAO_Contact::displayName($contribution->contact_id) . ' - (' . CRM_Utils_Money::format($contribution->total_amount, $contribution->currency) . ' ' . ' - ' . $financialType . ')';
 619
 620       $recentOther = [];
 621       if (CRM_Core_Permission::checkActionPermission('CiviContribute', CRM_Core_Action::UPDATE)) {
 622         $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/view/contribution',
 623           "action=update&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
 624         );
 625       }
 626
 627       if (CRM_Core_Permission::checkActionPermission('CiviContribute', CRM_Core_Action::DELETE)) {
 628         $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/contribution',
 629           "action=delete&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
 630         );
 631       }
 632
 633       // add the recently created Contribution
 634       CRM_Utils_Recent::add($title,
 635         $url,
 636         $contribution->id,
 637         'Contribution',
 638         $contribution->contact_id,
 639         NULL,
 640         $recentOther
 641       );
 642     }
 643
 644     return $contribution;
 645   }
 646
 647   /**
 648    * Get the values for pseudoconstants for name->value and reverse.
 649    *
 650    * @param array $defaults
 651    *   (reference) the default values, some of which need to be resolved.
 652    * @param bool $reverse
 653    *   True if we want to resolve the values in the reverse direction (value -> name).
 654    */
 655   public static function resolveDefaults(&$defaults, $reverse = FALSE) {
 656     self::lookupValue($defaults, 'financial_type', CRM_Contribute_PseudoConstant::financialType(), $reverse);
 657     self::lookupValue($defaults, 'payment_instrument', CRM_Contribute_PseudoConstant::paymentInstrument(), $reverse);
 658     self::lookupValue($defaults, 'contribution_status', CRM_Contribute_PseudoConstant::contributionStatus(), $reverse);
 659     self::lookupValue($defaults, 'pcp', CRM_Contribute_PseudoConstant::pcPage(), $reverse);
 660   }
 661
 662   /**
 663    * Convert associative array names to values and vice-versa.
 664    *
 665    * This function is used by both the web form layer and the api. Note that
 666    * the api needs the name => value conversion, also the view layer typically
 667    * requires value => name conversion
 668    *
 669    * @param array $defaults
 670    * @param string $property
 671    * @param array $lookup
 672    * @param bool $reverse
 673    *
 674    * @return bool
 675    */
 676   public static function lookupValue(&$defaults, $property, &$lookup, $reverse) {
 677     $id = $property . '_id';
 678
 679     $src = $reverse ? $property : $id;
 680     $dst = $reverse ? $id : $property;
 681
 682     if (!array_key_exists($src, $defaults)) {
 683       return FALSE;
 684     }
 685
 686     $look = $reverse ? array_flip($lookup) : $lookup;
 687
 688     if (is_array($look)) {
 689       if (!array_key_exists($defaults[$src], $look)) {
 690         return FALSE;
 691       }
 692     }
 693     $defaults[$dst] = $look[$defaults[$src]];
 694     return TRUE;
 695   }
 696
 697   /**
 698    * Retrieve DB object based on input parameters.
 699    *
 700    * It also stores all the retrieved values in the default array.
 701    *
 702    * @param array $params
 703    *   (reference ) an assoc array of name/value pairs.
 704    * @param array $defaults
 705    *   (reference ) an assoc array to hold the name / value pairs.
 706    *                        in a hierarchical manner
 707    * @param array $ids
 708    *   (reference) the array that holds all the db ids.
 709    *
 710    * @return CRM_Contribute_BAO_Contribution
 711    */
 712   public static function retrieve(&$params, &$defaults = [], &$ids = []) {
 713     $contribution = CRM_Contribute_BAO_Contribution::getValues($params, $defaults, $ids);
 714     return $contribution;
 715   }
 716
 717   /**
 718    * Combine all the importable fields from the lower levels object.
 719    *
 720    * The ordering is important, since currently we do not have a weight
 721    * scheme. Adding weight is super important and should be done in the
 722    * next week or so, before this can be called complete.
 723    *
 724    * @param string $contactType
 725    * @param bool $status
 726    *
 727    * @return array
 728    *   array of importable Fields
 729    */
 730   public static function &importableFields($contactType = 'Individual', $status = TRUE) {
 731     if (!self::$_importableFields) {
 732       if (!self::$_importableFields) {
 733         self::$_importableFields = [];
 734       }
 735
 736       if (!$status) {
 737         $fields = ['' => ['title' => ts('- do not import -')]];
 738       }
 739       else {
 740         $fields = ['' => ['title' => ts('- Contribution Fields -')]];
 741       }
 742
 743       $note = CRM_Core_DAO_Note::import();
 744       $tmpFields = CRM_Contribute_DAO_Contribution::import();
 745       unset($tmpFields['option_value']);
 746       $optionFields = CRM_Core_OptionValue::getFields($mode = 'contribute');
 747       $contactFields = CRM_Contact_BAO_Contact::importableFields($contactType, NULL);
 748
 749       // Using new Dedupe rule.
 750       $ruleParams = [
 751         'contact_type' => $contactType,
 752         'used' => 'Unsupervised',
 753       ];
 754       $fieldsArray = CRM_Dedupe_BAO_Rule::dedupeRuleFields($ruleParams);
 755       $tmpContactField = [];
 756       if (is_array($fieldsArray)) {
 757         foreach ($fieldsArray as $value) {
 758           //skip if there is no dupe rule
 759           if ($value == 'none') {
 760             continue;
 761           }
 762           $customFieldId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
 763             $value,
 764             'id',
 765             'column_name'
 766           );
 767           $value = $customFieldId ? 'custom_' . $customFieldId : $value;
 768           $tmpContactField[trim($value)] = $contactFields[trim($value)];
 769           if (!$status) {
 770             $title = $tmpContactField[trim($value)]['title'] . ' ' . ts('(match to contact)');
 771           }
 772           else {
 773             $title = $tmpContactField[trim($value)]['title'];
 774           }
 775           $tmpContactField[trim($value)]['title'] = $title;
 776         }
 777       }
 778
 779       $tmpContactField['external_identifier'] = $contactFields['external_identifier'];
 780       $tmpContactField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . ' ' . ts('(match to contact)');
 781       $tmpFields['contribution_contact_id']['title'] = $tmpFields['contribution_contact_id']['title'] . ' ' . ts('(match to contact)');
 782       $fields = array_merge($fields, $tmpContactField);
 783       $fields = array_merge($fields, $tmpFields);
 784       $fields = array_merge($fields, $note);
 785       $fields = array_merge($fields, $optionFields);
 786       $fields = array_merge($fields, CRM_Financial_DAO_FinancialType::export());
 787       $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Contribution'));
 788       self::$_importableFields = $fields;
 789     }
 790     return self::$_importableFields;
 791   }
 792
 793   /**
 794    * Combine all the exportable fields from the lower level objects.
 795    *
 796    * @param bool $checkPermission
 797    *
 798    * @return array
 799    *   array of exportable Fields
 800    */
 801   public static function &exportableFields($checkPermission = TRUE) {
 802     if (!self::$_exportableFields) {
 803       if (!self::$_exportableFields) {
 804         self::$_exportableFields = [];
 805       }
 806
 807       $fields = CRM_Contribute_DAO_Contribution::export();
 808       if (CRM_Contribute_BAO_Query::isSiteHasProducts()) {
 809         $fields = array_merge(
 810           $fields,
 811           CRM_Contribute_DAO_Product::export(),
 812           CRM_Contribute_DAO_ContributionProduct::export(),
 813           // CRM-16713 - contribution search by Premiums on 'Find Contribution' form.
 814           [
 815             'contribution_product_id' => [
 816               'title' => ts('Premium'),
 817               'name' => 'contribution_product_id',
 818               'where' => 'civicrm_product.id',
 819               'data_type' => CRM_Utils_Type::T_INT,
 820             ],
 821           ]
 822         );
 823       }
 824
 825       $financialAccount = CRM_Financial_DAO_FinancialAccount::export();
 826
 827       $contributionPage = [
 828         'contribution_page' => [
 829           'title' => ts('Contribution Page'),
 830           'name' => 'contribution_page',
 831           'where' => 'civicrm_contribution_page.title',
 832           'data_type' => CRM_Utils_Type::T_STRING,
 833         ],
 834       ];
 835
 836       $contributionNote = [
 837         'contribution_note' => [
 838           'title' => ts('Contribution Note'),
 839           'name' => 'contribution_note',
 840           'data_type' => CRM_Utils_Type::T_TEXT,
 841         ],
 842       ];
 843
 844       $extraFields = [
 845         'contribution_batch' => [
 846           'title' => ts('Batch Name'),
 847         ],
 848       ];
 849
 850       // CRM-17787
 851       $campaignTitle = [
 852         'contribution_campaign_title' => [
 853           'title' => ts('Campaign Title'),
 854           'name' => 'campaign_title',
 855           'where' => 'civicrm_campaign.title',
 856           'data_type' => CRM_Utils_Type::T_STRING,
 857         ],
 858       ];
 859       $softCreditFields = [
 860         'contribution_soft_credit_name' => [
 861           'name' => 'contribution_soft_credit_name',
 862           'title' => ts('Soft Credit For'),
 863           'where' => 'civicrm_contact_d.display_name',
 864           'data_type' => CRM_Utils_Type::T_STRING,
 865         ],
 866         'contribution_soft_credit_amount' => [
 867           'name' => 'contribution_soft_credit_amount',
 868           'title' => ts('Soft Credit Amount'),
 869           'where' => 'civicrm_contribution_soft.amount',
 870           'data_type' => CRM_Utils_Type::T_MONEY,
 871         ],
 872         'contribution_soft_credit_type' => [
 873           'name' => 'contribution_soft_credit_type',
 874           'title' => ts('Soft Credit Type'),
 875           'where' => 'contribution_softcredit_type.label',
 876           'data_type' => CRM_Utils_Type::T_STRING,
 877         ],
 878         'contribution_soft_credit_contribution_id' => [
 879           'name' => 'contribution_soft_credit_contribution_id',
 880           'title' => ts('Soft Credit For Contribution ID'),
 881           'where' => 'civicrm_contribution_soft.contribution_id',
 882           'data_type' => CRM_Utils_Type::T_INT,
 883         ],
 884         'contribution_soft_credit_contact_id' => [
 885           'name' => 'contribution_soft_credit_contact_id',
 886           'title' => ts('Soft Credit For Contact ID'),
 887           'where' => 'civicrm_contact_d.id',
 888           'data_type' => CRM_Utils_Type::T_INT,
 889         ],
 890       ];
 891
 892       $fields = array_merge($fields, $contributionPage,
 893         $contributionNote, $extraFields, $softCreditFields, $financialAccount, $campaignTitle,
 894         CRM_Core_BAO_CustomField::getFieldsForImport('Contribution', FALSE, FALSE, FALSE, $checkPermission)
 895       );
 896
 897       self::$_exportableFields = $fields;
 898     }
 899
 900     return self::$_exportableFields;
 901   }
 902
 903   /**
 904    * Record an activity when a payment is received.
 905    *
 906    * @todo this is intended to be moved to payment BAO class as a protected function
 907    * on that class. Currently being cleaned up. The addActivityForPayment doesn't really
 908    * merit it's own function as it makes the code less rather than more readable.
 909    *
 910    * @param int $contributionId
 911    * @param int $participantId
 912    * @param string $totalAmount
 913    * @param string $currency
 914    * @param string $trxnDate
 915    *
 916    * @throws \CRM_Core_Exception
 917    * @throws \CiviCRM_API3_Exception
 918    */
 919   public static function recordPaymentActivity($contributionId, $participantId, $totalAmount, $currency, $trxnDate) {
 920     $activityType = ($totalAmount < 0) ? 'Refund' : 'Payment';
 921
 922     if ($participantId) {
 923       $inputParams['id'] = $participantId;
 924       $values = [];
 925       $ids = [];
 926       $entityObj = CRM_Event_BAO_Participant::getValues($inputParams, $values, $ids);
 927       $entityObj = $entityObj[$participantId];
 928       $title = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Event', $entityObj->event_id, 'title');
 929     }
 930     else {
 931       $entityObj = new CRM_Contribute_BAO_Contribution();
 932       $entityObj->id = $contributionId;
 933       $entityObj->find(TRUE);
 934       $title = ts('Contribution');
 935     }
 936     // @todo per block above this is not a logical splitting off of functionality.
 937     self::addActivityForPayment($entityObj->contact_id, $activityType, $title, $contributionId, $totalAmount, $currency, $trxnDate);
 938   }
 939
 940   /**
 941    * Get the value for the To Financial Account.
 942    *
 943    * @param $contribution
 944    * @param $params
 945    *
 946    * @return int
 947    */
 948   public static function getToFinancialAccount($contribution, $params) {
 949     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 950     CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 951     $pendingStatus = [
 952       array_search('Pending', $contributionStatuses),
 953       array_search('In Progress', $contributionStatuses),
 954     ];
 955     if (in_array(CRM_Utils_Array::value('contribution_status_id', $contribution), $pendingStatus)) {
 956       return CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($contribution['financial_type_id'], 'Accounts Receivable Account is');
 957     }
 958     elseif (!empty($params['payment_processor'])) {
 959       return CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($contribution['payment_processor'], NULL, 'civicrm_payment_processor');
 960     }
 961     elseif (!empty($params['payment_instrument_id'])) {
 962       return CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($contribution['payment_instrument_id']);
 963     }
 964     else {
 965       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
 966       $queryParams = [1 => [$relationTypeId, 'Integer']];
 967       return CRM_Core_DAO::singleValueQuery("SELECT id FROM civicrm_financial_account WHERE is_default = 1 AND financial_account_type_id = %1", $queryParams);
 968     }
 969   }
 970
 971   /**
 972    * Get memberships realted to the contribution.
 973    *
 974    * @param int $contributionID
 975    *
 976    * @return array
 977    */
 978   protected static function getRelatedMemberships($contributionID) {
 979     $membershipPayments = civicrm_api3('MembershipPayment', 'get', [
 980       'return' => 'membership_id',
 981       'contribution_id' => (int) $contributionID,
 982     ])['values'];
 983     $membershipIDs = [];
 984     foreach ($membershipPayments as $membershipPayment) {
 985       $membershipIDs[] = $membershipPayment['membership_id'];
 986     }
 987     if (empty($membershipIDs)) {
 988       return [];
 989     }
 990     // We could combine this with the MembershipPayment.get - we'd
 991     // need to re-wrangle the params (here or in the calling function)
 992     // as they would then me membership.contact_id, membership.is_test etc
 993     return civicrm_api3('Membership', 'get', [
 994       'id' => ['IN' => $membershipIDs],
 995       'return' => ['id', 'contact_id', 'membership_type_id', 'is_test', 'status_id', 'end_date'],
 996     ])['values'];
 997   }
 998
 999   /**
1000    * Cancel contribution.
1001    *
1002    * This function should only be called from transitioncomponents - it is an interim step in refactoring.
1003    *
1004    * @param $processContributionObject
1005    * @param $memberships
1006    * @param $contributionId
1007    * @param $membershipStatuses
1008    * @param $updateResult
1009    * @param $participant
1010    * @param $oldStatus
1011    * @param $pledgePayment
1012    * @param $pledgeID
1013    * @param $pledgePaymentIDs
1014    * @param $contributionStatusId
1015    *
1016    * @return array
1017    */
1018   protected static function cancel($processContributionObject, $memberships, $contributionId, $membershipStatuses, $updateResult, $participant, $oldStatus, $pledgePayment, $pledgeID, $pledgePaymentIDs, $contributionStatusId) {
1019     $processContribution = FALSE;
1020     $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
1021     if (is_array($memberships)) {
1022       foreach ($memberships as $membership) {
1023         $update = TRUE;
1024         //Update Membership status if there is no other completed contribution associated with the membership.
1025         $relatedContributions = CRM_Member_BAO_Membership::getMembershipContributionId($membership->id, TRUE);
1026         foreach ($relatedContributions as $contriId) {
1027           if ($contriId == $contributionId) {
1028             continue;
1029           }
1030           $statusId = CRM_Core_DAO::getFieldValue('CRM_Contribute_BAO_Contribution', $contriId, 'contribution_status_id');
1031           if (CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $statusId) === 'Completed') {
1032             $update = FALSE;
1033           }
1034         }
1035         if ($membership && $update) {
1036           $newStatus = array_search('Cancelled', $membershipStatuses);
1037
1038           // Create activity
1039           $allStatus = CRM_Member_BAO_Membership::buildOptions('status_id', 'get');
1040           $activityParam = [
1041             'subject' => "Status changed from {$allStatus[$membership->status_id]} to {$allStatus[$newStatus]}",
1042             'source_contact_id' => CRM_Core_Session::singleton()->get('userID'),
1043             'target_contact_id' => $membership->contact_id,
1044             'source_record_id' => $membership->id,
1045             'activity_type_id' => 'Change Membership Status',
1046             'status_id' => 'Completed',
1047             'priority_id' => 'Normal',
1048             'activity_date_time' => 'now',
1049           ];
1050
1051           $membership->status_id = $newStatus;
1052           $membership->is_override = TRUE;
1053           $membership->status_override_end_date = 'null';
1054           $membership->save();
1055           civicrm_api3('activity', 'create', $activityParam);
1056
1057           $updateResult['updatedComponents']['CiviMember'] = $membership->status_id;
1058           if ($processContributionObject) {
1059             $processContribution = TRUE;
1060           }
1061         }
1062       }
1063     }
1064
1065     if ($participant) {
1066       $updatedStatusId = array_search('Cancelled', $participantStatuses);
1067       CRM_Event_BAO_Participant::updateParticipantStatus($participant->id, $oldStatus, $updatedStatusId, TRUE);
1068
1069       $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1070       if ($processContributionObject) {
1071         $processContribution = TRUE;
1072       }
1073     }
1074
1075     if ($pledgePayment) {
1076       CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1077
1078       $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1079       if ($processContributionObject) {
1080         $processContribution = TRUE;
1081       }
1082     }
1083     return [$updateResult, $processContribution];
1084   }
1085
1086   /**
1087    * Do any accounting updates required as a result of a contribution status change.
1088    *
1089    * Currently we have a bit of a roundabout where adding a payment results in this being called &
1090    * this may attempt to add a payment. We need to resolve that....
1091    *
1092    * The 'right' way to add payments or refunds is through the Payment.create api. That api
1093    * then updates the contribution but this process should not also record another financial trxn.
1094    * Currently we have weak detection fot that scenario & where it is detected the first returned
1095    * value is FALSE - meaning 'do not continue'.
1096    *
1097    * We should also look at the fact that the calling function - updateFinancialAccounts
1098    * bunches together some disparate processes rather than having separate appropriate
1099    * functions.
1100    *
1101    * @param array $params
1102    * @param string $context
1103    * @param array $previousContributionStatus
1104    * @param string $currentContributionStatus
1105    *
1106    * @return bool[]
1107    *   Return indicates whether the updateFinancialAccounts function should continue & whether this is a refund.
1108    */
1109   private static function updateFinancialAccountsOnContributionStatusChange(&$params, $context, $previousContributionStatus, $currentContributionStatus) {
1110     $isARefund = FALSE;
1111     if ((($previousContributionStatus == 'Partially paid' && $currentContributionStatus == 'Completed')
1112         || ($previousContributionStatus == 'Pending refund' && $currentContributionStatus == 'Completed')
1113         // This concept of pay_later as different to any other sort of pending is deprecated & it's unclear
1114         // why it is here or where it is handled instead.
1115         || ($previousContributionStatus == 'Pending' && $params['prevContribution']->is_pay_later == TRUE
1116           && $currentContributionStatus == 'Partially paid'))
1117     ) {
1118       return [FALSE, $isARefund];
1119     }
1120     if ($context == 'changedStatus') {
1121       if ($previousContributionStatus == 'Completed'
1122         && (self::isContributionStatusNegative($params['contribution']->contribution_status_id))
1123       ) {
1124         $isARefund = TRUE;
1125         // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
1126         $params['trxnParams']['total_amount'] = -$params['total_amount'];
1127         if (empty($params['contribution']->creditnote_id) || $params['contribution']->creditnote_id == "null") {
1128           $creditNoteId = self::createCreditNoteId();
1129           CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution']->id, 'creditnote_id', $creditNoteId);
1130         }
1131       }
1132       elseif (($previousContributionStatus == 'Pending'
1133           && $params['prevContribution']->is_pay_later) || $previousContributionStatus == 'In Progress'
1134       ) {
1135         $financialTypeID = CRM_Utils_Array::value('financial_type_id', $params) ? $params['financial_type_id'] : $params['prevContribution']->financial_type_id;
1136         $arAccountId = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
1137
1138         if ($currentContributionStatus == 'Cancelled') {
1139           // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
1140           $params['trxnParams']['to_financial_account_id'] = $arAccountId;
1141           $params['trxnParams']['total_amount'] = -$params['total_amount'];
1142           if (is_null($params['contribution']->creditnote_id) || $params['contribution']->creditnote_id == "null") {
1143             $creditNoteId = self::createCreditNoteId();
1144             CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution']->id, 'creditnote_id', $creditNoteId);
1145           }
1146         }
1147         else {
1148           // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
1149           $params['trxnParams']['from_financial_account_id'] = $arAccountId;
1150         }
1151       }
1152
1153       if (($previousContributionStatus == 'Pending'
1154           || $previousContributionStatus == 'In Progress')
1155         && ($currentContributionStatus == 'Completed')
1156       ) {
1157         if (empty($params['line_item'])) {
1158           //CRM-15296
1159           //@todo - check with Joe regarding this situation - payment processors create pending transactions with no line items
1160           // when creating recurring membership payment - there are 2 lines to comment out in contributonPageTest if fixed
1161           // & this can be removed
1162           return [FALSE, $isARefund];
1163         }
1164         // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
1165         // This is an update so original currency if none passed in.
1166         $params['trxnParams']['currency'] = CRM_Utils_Array::value('currency', $params, $params['prevContribution']->currency);
1167
1168         self::recordAlwaysAccountsReceivable($params['trxnParams'], $params);
1169         $trxn = CRM_Core_BAO_FinancialTrxn::create($params['trxnParams']);
1170         // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
1171         $params['entity_id'] = self::$_trxnIDs[] = $trxn->id;
1172         $query = "UPDATE civicrm_financial_item SET status_id = %1 WHERE entity_id = %2 and entity_table = 'civicrm_line_item'";
1173         $sql = "SELECT id, amount FROM civicrm_financial_item WHERE entity_id = %1 and entity_table = 'civicrm_line_item'";
1174
1175         $entityParams = [
1176           'entity_table' => 'civicrm_financial_item',
1177         ];
1178         foreach ($params['line_item'] as $fieldId => $fields) {
1179           foreach ($fields as $fieldValueId => $lineItemDetails) {
1180             $fparams = [
1181               1 => [
1182                 CRM_Core_PseudoConstant::getKey('CRM_Financial_BAO_FinancialItem', 'status_id', 'Paid'),
1183                 'Integer',
1184               ],
1185               2 => [$lineItemDetails['id'], 'Integer'],
1186             ];
1187             CRM_Core_DAO::executeQuery($query, $fparams);
1188             $fparams = [
1189               1 => [$lineItemDetails['id'], 'Integer'],
1190             ];
1191             $financialItem = CRM_Core_DAO::executeQuery($sql, $fparams);
1192             while ($financialItem->fetch()) {
1193               $entityParams['entity_id'] = $financialItem->id;
1194               $entityParams['amount'] = $financialItem->amount;
1195               foreach (self::$_trxnIDs as $tID) {
1196                 $entityParams['financial_trxn_id'] = $tID;
1197                 CRM_Financial_BAO_FinancialItem::createEntityTrxn($entityParams);
1198               }
1199             }
1200           }
1201         }
1202         return [FALSE, $isARefund];
1203       }
1204     }
1205     return [TRUE, $isARefund];
1206   }
1207
1208   /**
1209    * @inheritDoc
1210    */
1211   public function addSelectWhereClause() {
1212     $whereClauses = parent::addSelectWhereClause();
1213     if ($whereClauses !== []) {
1214       // In this case permisssions have been applied & we assume the
1215       // financialaclreport is applying these
1216       // https://github.com/JMAConsulting/biz.jmaconsulting.financialaclreport/blob/master/financialaclreport.php#L107
1217       return $whereClauses;
1218     }
1219
1220     if (!CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
1221       return $whereClauses;
1222     }
1223     $types = CRM_Financial_BAO_FinancialType::getAllEnabledAvailableFinancialTypes();
1224     if (empty($types)) {
1225       $whereClauses['financial_type_id'] = 'IN (0)';
1226     }
1227     else {
1228       $whereClauses['financial_type_id'] = [
1229         'IN (' . implode(',', array_keys($types)) . ')',
1230       ];
1231     }
1232     return $whereClauses;
1233   }
1234
1235   /**
1236    * @param null $status
1237    * @param null $startDate
1238    * @param null $endDate
1239    *
1240    * @return array|null
1241    */
1242   public static function getTotalAmountAndCount($status = NULL, $startDate = NULL, $endDate = NULL) {
1243     $where = [];
1244     switch ($status) {
1245       case 'Valid':
1246         $where[] = 'contribution_status_id = 1';
1247         break;
1248
1249       case 'Cancelled':
1250         $where[] = 'contribution_status_id = 3';
1251         break;
1252     }
1253
1254     if ($startDate) {
1255       $where[] = "receive_date >= '" . CRM_Utils_Type::escape($startDate, 'Timestamp') . "'";
1256     }
1257     if ($endDate) {
1258       $where[] = "receive_date <= '" . CRM_Utils_Type::escape($endDate, 'Timestamp') . "'";
1259     }
1260     $financialTypeACLJoin = '';
1261     if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()) {
1262       $financialTypeACLJoin = " LEFT JOIN civicrm_line_item i ON (i.contribution_id = c.id AND i.entity_table = 'civicrm_contribution') ";
1263       $financialTypes = CRM_Contribute_PseudoConstant::financialType();
1264       CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes);
1265       if ($financialTypes) {
1266         $where[] = "c.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
1267         $where[] = "i.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
1268       }
1269       else {
1270         $where[] = "c.financial_type_id IN (0)";
1271       }
1272     }
1273
1274     $whereCond = implode(' AND ', $where);
1275
1276     $query = "
1277     SELECT  sum( total_amount ) as total_amount,
1278             count( c.id ) as total_count,
1279             currency
1280       FROM  civicrm_contribution c
1281 INNER JOIN  civicrm_contact contact ON ( contact.id = c.contact_id )
1282      $financialTypeACLJoin
1283      WHERE  $whereCond
1284        AND  ( is_test = 0 OR is_test IS NULL )
1285        AND  contact.is_deleted = 0
1286   GROUP BY  currency
1287 ";
1288
1289     $dao = CRM_Core_DAO::executeQuery($query);
1290     $amount = [];
1291     $count = 0;
1292     while ($dao->fetch()) {
1293       $count += $dao->total_count;
1294       $amount[] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
1295     }
1296     if ($count) {
1297       return [
1298         'amount' => implode(', ', $amount),
1299         'count' => $count,
1300       ];
1301     }
1302     return NULL;
1303   }
1304
1305   /**
1306    * Delete the indirect records associated with this contribution first.
1307    *
1308    * @param int $id
1309    *
1310    * @return mixed|null
1311    *   $results no of deleted Contribution on success, false otherwise
1312    */
1313   public static function deleteContribution($id) {
1314     CRM_Utils_Hook::pre('delete', 'Contribution', $id, CRM_Core_DAO::$_nullArray);
1315
1316     $transaction = new CRM_Core_Transaction();
1317
1318     $results = NULL;
1319     //delete activity record
1320     $params = [
1321       'source_record_id' => $id,
1322       // activity type id for contribution
1323       'activity_type_id' => 6,
1324     ];
1325
1326     CRM_Activity_BAO_Activity::deleteActivity($params);
1327
1328     //delete billing address if exists for this contribution.
1329     self::deleteAddress($id);
1330
1331     //update pledge and pledge payment, CRM-3961
1332     CRM_Pledge_BAO_PledgePayment::resetPledgePayment($id);
1333
1334     // remove entry from civicrm_price_set_entity, CRM-5095
1335     if (CRM_Price_BAO_PriceSet::getFor('civicrm_contribution', $id)) {
1336       CRM_Price_BAO_PriceSet::removeFrom('civicrm_contribution', $id);
1337     }
1338     // cleanup line items.
1339     $participantId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment', $id, 'participant_id', 'contribution_id');
1340
1341     // delete any related entity_financial_trxn, financial_trxn and financial_item records.
1342     CRM_Core_BAO_FinancialTrxn::deleteFinancialTrxn($id);
1343
1344     if ($participantId) {
1345       CRM_Price_BAO_LineItem::deleteLineItems($participantId, 'civicrm_participant');
1346     }
1347     else {
1348       CRM_Price_BAO_LineItem::deleteLineItems($id, 'civicrm_contribution');
1349     }
1350
1351     //delete note.
1352     $note = CRM_Core_BAO_Note::getNote($id, 'civicrm_contribution');
1353     $noteId = key($note);
1354     if ($noteId) {
1355       CRM_Core_BAO_Note::del($noteId, FALSE);
1356     }
1357
1358     $dao = new CRM_Contribute_DAO_Contribution();
1359     $dao->id = $id;
1360
1361     $results = $dao->delete();
1362
1363     $transaction->commit();
1364
1365     CRM_Utils_Hook::post('delete', 'Contribution', $dao->id, $dao);
1366
1367     // delete the recently created Contribution
1368     $contributionRecent = [
1369       'id' => $id,
1370       'type' => 'Contribution',
1371     ];
1372     CRM_Utils_Recent::del($contributionRecent);
1373
1374     return $results;
1375   }
1376
1377   /**
1378    * React to a financial transaction (payment) failure.
1379    *
1380    * Prior to CRM-16417 these were simply removed from the database but it has been agreed that seeing attempted
1381    * payments is important for forensic and outreach reasons.
1382    *
1383    * @param int $contributionID
1384    * @param int $contactID
1385    * @param string $message
1386    *
1387    * @throws \CiviCRM_API3_Exception
1388    */
1389   public static function failPayment($contributionID, $contactID, $message) {
1390     civicrm_api3('activity', 'create', [
1391       'activity_type_id' => 'Failed Payment',
1392       'details' => $message,
1393       'subject' => ts('Payment failed at payment processor'),
1394       'source_record_id' => $contributionID,
1395       'source_contact_id' => CRM_Core_Session::getLoggedInContactID() ? CRM_Core_Session::getLoggedInContactID() : $contactID,
1396     ]);
1397
1398     // CRM-20336 Make sure that the contribution status is Failed, not Pending.
1399     civicrm_api3('contribution', 'create', [
1400       'id' => $contributionID,
1401       'contribution_status_id' => 'Failed',
1402     ]);
1403   }
1404
1405   /**
1406    * Check if there is a contribution with the same trxn_id or invoice_id.
1407    *
1408    * @param array $input
1409    *   An assoc array of name/value pairs.
1410    * @param array $duplicates
1411    *   (reference) store ids of duplicate contribs.
1412    * @param int $id
1413    *
1414    * @return bool
1415    *   true if duplicate, false otherwise
1416    */
1417   public static function checkDuplicate($input, &$duplicates, $id = NULL) {
1418     if (!$id) {
1419       $id = CRM_Utils_Array::value('id', $input);
1420     }
1421     $trxn_id = CRM_Utils_Array::value('trxn_id', $input);
1422     $invoice_id = CRM_Utils_Array::value('invoice_id', $input);
1423
1424     $clause = [];
1425     $input = [];
1426
1427     if ($trxn_id) {
1428       $clause[] = "trxn_id = %1";
1429       $input[1] = [$trxn_id, 'String'];
1430     }
1431
1432     if ($invoice_id) {
1433       $clause[] = "invoice_id = %2";
1434       $input[2] = [$invoice_id, 'String'];
1435     }
1436
1437     if (empty($clause)) {
1438       return FALSE;
1439     }
1440
1441     $clause = implode(' OR ', $clause);
1442     if ($id) {
1443       $clause = "( $clause ) AND id != %3";
1444       $input[3] = [$id, 'Integer'];
1445     }
1446
1447     $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1448     $dao = CRM_Core_DAO::executeQuery($query, $input);
1449     $result = FALSE;
1450     while ($dao->fetch()) {
1451       $duplicates[] = $dao->id;
1452       $result = TRUE;
1453     }
1454     return $result;
1455   }
1456
1457   /**
1458    * Takes an associative array and creates a contribution_product object.
1459    *
1460    * the function extract all the params it needs to initialize the create a
1461    * contribution_product object. the params array could contain additional unused name/value
1462    * pairs
1463    *
1464    * @param array $params
1465    *   (reference) an assoc array of name/value pairs.
1466    *
1467    * @return CRM_Contribute_DAO_ContributionProduct
1468    */
1469   public static function addPremium(&$params) {
1470     $contributionProduct = new CRM_Contribute_DAO_ContributionProduct();
1471     $contributionProduct->copyValues($params);
1472     return $contributionProduct->save();
1473   }
1474
1475   /**
1476    * Get list of contribution fields for profile.
1477    * For now we only allow custom contribution fields to be in
1478    * profile
1479    *
1480    * @param bool $addExtraFields
1481    *   True if special fields needs to be added.
1482    *
1483    * @return array
1484    *   the list of contribution fields
1485    */
1486   public static function getContributionFields($addExtraFields = TRUE) {
1487     $contributionFields = CRM_Contribute_DAO_Contribution::export();
1488     // @todo remove this - this line was added because payment_instrument_id was not
1489     // set to exportable - but now it is.
1490     $contributionFields = array_merge($contributionFields, CRM_Core_OptionValue::getFields($mode = 'contribute'));
1491
1492     if ($addExtraFields) {
1493       $contributionFields = array_merge($contributionFields, self::getSpecialContributionFields());
1494     }
1495
1496     $contributionFields = array_merge($contributionFields, CRM_Financial_DAO_FinancialType::export());
1497
1498     foreach ($contributionFields as $key => $var) {
1499       if ($key == 'contribution_contact_id') {
1500         continue;
1501       }
1502       elseif ($key == 'contribution_campaign_id') {
1503         $var['title'] = ts('Campaign');
1504       }
1505       $fields[$key] = $var;
1506     }
1507
1508     $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Contribution'));
1509     return $fields;
1510   }
1511
1512   /**
1513    * Add extra fields specific to contribution.
1514    */
1515   public static function getSpecialContributionFields() {
1516     $extraFields = [
1517       'contribution_soft_credit_name' => [
1518         'name' => 'contribution_soft_credit_name',
1519         'title' => ts('Soft Credit Name'),
1520         'headerPattern' => '/^soft_credit_name$/i',
1521         'where' => 'civicrm_contact_d.display_name',
1522       ],
1523       'contribution_soft_credit_email' => [
1524         'name' => 'contribution_soft_credit_email',
1525         'title' => ts('Soft Credit Email'),
1526         'headerPattern' => '/^soft_credit_email$/i',
1527         'where' => 'soft_email.email',
1528       ],
1529       'contribution_soft_credit_phone' => [
1530         'name' => 'contribution_soft_credit_phone',
1531         'title' => ts('Soft Credit Phone'),
1532         'headerPattern' => '/^soft_credit_phone$/i',
1533         'where' => 'soft_phone.phone',
1534       ],
1535       'contribution_soft_credit_contact_id' => [
1536         'name' => 'contribution_soft_credit_contact_id',
1537         'title' => ts('Soft Credit Contact ID'),
1538         'headerPattern' => '/^soft_credit_contact_id$/i',
1539         'where' => 'civicrm_contribution_soft.contact_id',
1540       ],
1541       'contribution_pcp_title' => [
1542         'name' => 'contribution_pcp_title',
1543         'title' => ts('Personal Campaign Page Title'),
1544         'headerPattern' => '/^contribution_pcp_title$/i',
1545         'where' => 'contribution_pcp.title',
1546       ],
1547     ];
1548
1549     return $extraFields;
1550   }
1551
1552   /**
1553    * @param int $pageID
1554    *
1555    * @return array
1556    */
1557   public static function getCurrentandGoalAmount($pageID) {
1558     $query = "
1559 SELECT p.goal_amount as goal, sum( c.total_amount ) as total
1560   FROM civicrm_contribution_page p,
1561        civicrm_contribution      c
1562  WHERE p.id = c.contribution_page_id
1563    AND p.id = %1
1564    AND c.cancel_date is null
1565 GROUP BY p.id
1566 ";
1567
1568     $config = CRM_Core_Config::singleton();
1569     $params = [1 => [$pageID, 'Integer']];
1570     $dao = CRM_Core_DAO::executeQuery($query, $params);
1571
1572     if ($dao->fetch()) {
1573       return [$dao->goal, $dao->total];
1574     }
1575     else {
1576       return [NULL, NULL];
1577     }
1578   }
1579
1580   /**
1581    * Get list of contributions which credit the passed in contact ID.
1582    *
1583    * The returned array provides details about the original contribution & donor.
1584    *
1585    * @param int $honorId
1586    *   In Honor of Contact ID.
1587    *
1588    * @return array
1589    *   list of contribution fields
1590    * @todo - this is a confusing function called from one place. It has a test. It would be
1591    * nice to deprecate it.
1592    *
1593    */
1594   public static function getHonorContacts($honorId) {
1595     $params = [];
1596     $honorDAO = new CRM_Contribute_DAO_ContributionSoft();
1597     $honorDAO->contact_id = $honorId;
1598     $honorDAO->find();
1599
1600     $type = CRM_Contribute_PseudoConstant::financialType();
1601
1602     while ($honorDAO->fetch()) {
1603       $contributionDAO = new CRM_Contribute_DAO_Contribution();
1604       $contributionDAO->id = $honorDAO->contribution_id;
1605
1606       if ($contributionDAO->find(TRUE)) {
1607         $params[$contributionDAO->id]['honor_type'] = CRM_Core_PseudoConstant::getLabel('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', $honorDAO->soft_credit_type_id);
1608         $params[$contributionDAO->id]['honorId'] = $contributionDAO->contact_id;
1609         $params[$contributionDAO->id]['display_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contributionDAO->contact_id, 'display_name');
1610         $params[$contributionDAO->id]['type'] = $type[$contributionDAO->financial_type_id];
1611         $params[$contributionDAO->id]['type_id'] = $contributionDAO->financial_type_id;
1612         $params[$contributionDAO->id]['amount'] = CRM_Utils_Money::format($contributionDAO->total_amount, $contributionDAO->currency);
1613         $params[$contributionDAO->id]['source'] = $contributionDAO->source;
1614         $params[$contributionDAO->id]['receive_date'] = $contributionDAO->receive_date;
1615         $params[$contributionDAO->id]['contribution_status'] = CRM_Contribute_PseudoConstant::contributionStatus($contributionDAO->contribution_status_id);
1616       }
1617     }
1618
1619     return $params;
1620   }
1621
1622   /**
1623    * Get the sort name of a contact for a particular contribution.
1624    *
1625    * @param int $id
1626    *   Id of the contribution.
1627    *
1628    * @return null|string
1629    *   sort name of the contact if found
1630    */
1631   public static function sortName($id) {
1632     $id = CRM_Utils_Type::escape($id, 'Integer');
1633
1634     $query = "
1635 SELECT civicrm_contact.sort_name
1636 FROM   civicrm_contribution, civicrm_contact
1637 WHERE  civicrm_contribution.contact_id = civicrm_contact.id
1638   AND  civicrm_contribution.id = {$id}
1639 ";
1640     return CRM_Core_DAO::singleValueQuery($query);
1641   }
1642
1643   /**
1644    * Generate summary of amount received in the current fiscal year to date from the contact or contacts.
1645    *
1646    * @param int|array $contactIDs
1647    *
1648    * @return array
1649    */
1650   public static function annual($contactIDs) {
1651     if (!is_array($contactIDs)) {
1652       // In practice I can't fine any evidence that this function is ever called with
1653       // anything other than a single contact id, but left like this due to .... fear.
1654       $contactIDs = explode(',', $contactIDs);
1655     }
1656
1657     $query = self::getAnnualQuery($contactIDs);
1658     $dao = CRM_Core_DAO::executeQuery($query);
1659     $count = 0;
1660     $amount = $average = [];
1661     while ($dao->fetch()) {
1662       if ($dao->count > 0 && $dao->amount > 0) {
1663         $count += $dao->count;
1664         $amount[] = CRM_Utils_Money::format($dao->amount, $dao->currency);
1665         $average[] = CRM_Utils_Money::format($dao->average, $dao->currency);
1666       }
1667     }
1668     if ($count > 0) {
1669       return [
1670         $count,
1671         implode(',&nbsp;', $amount),
1672         implode(',&nbsp;', $average),
1673       ];
1674     }
1675     return [0, 0, 0];
1676   }
1677
1678   /**
1679    * Check if there is a contribution with the params passed in.
1680    *
1681    * Used for trxn_id,invoice_id and contribution_id
1682    *
1683    * @param array $params
1684    *   An assoc array of name/value pairs.
1685    *
1686    * @return array
1687    *   contribution id if success else NULL
1688    */
1689   public static function checkDuplicateIds($params) {
1690     $dao = new CRM_Contribute_DAO_Contribution();
1691
1692     $clause = [];
1693     $input = [];
1694     foreach ($params as $k => $v) {
1695       if ($v) {
1696         $clause[] = "$k = '$v'";
1697       }
1698     }
1699     $clause = implode(' AND ', $clause);
1700     $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1701     $dao = CRM_Core_DAO::executeQuery($query, $input);
1702
1703     while ($dao->fetch()) {
1704       $result = $dao->id;
1705       return $result;
1706     }
1707     return NULL;
1708   }
1709
1710   /**
1711    * Get the contribution details for component export.
1712    *
1713    * @param int $exportMode
1714    *   Export mode.
1715    * @param array $componentIds
1716    *   Component ids.
1717    *
1718    * @return array
1719    *   associated array
1720    */
1721   public static function getContributionDetails($exportMode, $componentIds) {
1722     $paymentDetails = [];
1723     $componentClause = ' IN ( ' . implode(',', $componentIds) . ' ) ';
1724
1725     if ($exportMode == CRM_Export_Form_Select::EVENT_EXPORT) {
1726       $componentSelect = " civicrm_participant_payment.participant_id id";
1727       $additionalClause = "
1728 INNER JOIN civicrm_participant_payment ON (civicrm_contribution.id = civicrm_participant_payment.contribution_id
1729 AND civicrm_participant_payment.participant_id {$componentClause} )
1730 ";
1731     }
1732     elseif ($exportMode == CRM_Export_Form_Select::MEMBER_EXPORT) {
1733       $componentSelect = " civicrm_membership_payment.membership_id id";
1734       $additionalClause = "
1735 INNER JOIN civicrm_membership_payment ON (civicrm_contribution.id = civicrm_membership_payment.contribution_id
1736 AND civicrm_membership_payment.membership_id {$componentClause} )
1737 ";
1738     }
1739     elseif ($exportMode == CRM_Export_Form_Select::PLEDGE_EXPORT) {
1740       $componentSelect = " civicrm_pledge_payment.id id";
1741       $additionalClause = "
1742 INNER JOIN civicrm_pledge_payment ON (civicrm_contribution.id = civicrm_pledge_payment.contribution_id
1743 AND civicrm_pledge_payment.pledge_id {$componentClause} )
1744 ";
1745     }
1746
1747     $query = " SELECT total_amount, contribution_status.name as status_id, contribution_status.label as status, payment_instrument.name as payment_instrument, receive_date,
1748                           trxn_id, {$componentSelect}
1749 FROM civicrm_contribution
1750 LEFT JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')
1751 LEFT JOIN civicrm_option_value payment_instrument ON (civicrm_contribution.payment_instrument_id = payment_instrument.value
1752      AND option_group_payment_instrument.id = payment_instrument.option_group_id )
1753 LEFT JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')
1754 LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
1755                                AND option_group_contribution_status.id = contribution_status.option_group_id )
1756 {$additionalClause}
1757 ";
1758
1759     $dao = CRM_Core_DAO::executeQuery($query);
1760
1761     while ($dao->fetch()) {
1762       $paymentDetails[$dao->id] = [
1763         'total_amount' => $dao->total_amount,
1764         'contribution_status' => $dao->status,
1765         'receive_date' => $dao->receive_date,
1766         'pay_instru' => $dao->payment_instrument,
1767         'trxn_id' => $dao->trxn_id,
1768       ];
1769     }
1770
1771     return $paymentDetails;
1772   }
1773
1774   /**
1775    * Create address associated with contribution record.
1776    *
1777    * As long as there is one or more billing field in the parameters we will create the address.
1778    *
1779    * (historically the decision to create or not was based on the payment 'type' but these lines are greyer than once
1780    * thought).
1781    *
1782    * @param array $params
1783    * @param int $billingLocationTypeID
1784    *
1785    * @return int
1786    *   address id
1787    */
1788   public static function createAddress($params, $billingLocationTypeID) {
1789     list($hasBillingField, $addressParams) = self::getBillingAddressParams($params, $billingLocationTypeID);
1790     if ($hasBillingField) {
1791       $address = CRM_Core_BAO_Address::add($addressParams, FALSE);
1792       return $address->id;
1793     }
1794     return NULL;
1795
1796   }
1797
1798   /**
1799    * Delete billing address record related contribution.
1800    *
1801    * @param int $contributionId
1802    * @param int $contactId
1803    */
1804   public static function deleteAddress($contributionId = NULL, $contactId = NULL) {
1805     $clauses = [];
1806     $contactJoin = NULL;
1807
1808     if ($contributionId) {
1809       $clauses[] = "cc.id = {$contributionId}";
1810     }
1811
1812     if ($contactId) {
1813       $clauses[] = "cco.id = {$contactId}";
1814       $contactJoin = "INNER JOIN civicrm_contact cco ON cc.contact_id = cco.id";
1815     }
1816
1817     if (empty($clauses)) {
1818       CRM_Core_Error::fatal();
1819     }
1820
1821     $condition = implode(' OR ', $clauses);
1822
1823     $query = "
1824 SELECT     ca.id
1825 FROM       civicrm_address ca
1826 INNER JOIN civicrm_contribution cc ON cc.address_id = ca.id
1827            $contactJoin
1828 WHERE      $condition
1829 ";
1830     $dao = CRM_Core_DAO::executeQuery($query);
1831
1832     while ($dao->fetch()) {
1833       $params = ['id' => $dao->id];
1834       CRM_Core_BAO_Block::blockDelete('Address', $params);
1835     }
1836   }
1837
1838   /**
1839    * This function check online pending contribution associated w/
1840    * Online Event Registration or Online Membership signup.
1841    *
1842    * @param int $componentId
1843    *   Participant/membership id.
1844    * @param string $componentName
1845    *   Event/Membership.
1846    *
1847    * @return int
1848    *   pending contribution id.
1849    */
1850   public static function checkOnlinePendingContribution($componentId, $componentName) {
1851     $contributionId = NULL;
1852     if (!$componentId ||
1853       !in_array($componentName, ['Event', 'Membership'])
1854     ) {
1855       return $contributionId;
1856     }
1857
1858     if ($componentName == 'Event') {
1859       $idName = 'participant_id';
1860       $componentTable = 'civicrm_participant';
1861       $paymentTable = 'civicrm_participant_payment';
1862       $source = ts('Online Event Registration');
1863     }
1864
1865     if ($componentName == 'Membership') {
1866       $idName = 'membership_id';
1867       $componentTable = 'civicrm_membership';
1868       $paymentTable = 'civicrm_membership_payment';
1869       $source = ts('Online Contribution');
1870     }
1871
1872     $pendingStatusId = array_search('Pending', CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'));
1873
1874     $query = "
1875    SELECT  component.id as {$idName},
1876            componentPayment.contribution_id as contribution_id,
1877            contribution.source source,
1878            contribution.contribution_status_id as contribution_status_id,
1879            contribution.is_pay_later as is_pay_later
1880      FROM  $componentTable component
1881 LEFT JOIN  $paymentTable componentPayment    ON ( componentPayment.{$idName} = component.id )
1882 LEFT JOIN  civicrm_contribution contribution ON ( componentPayment.contribution_id = contribution.id )
1883     WHERE  component.id = {$componentId}";
1884
1885     $dao = CRM_Core_DAO::executeQuery($query);
1886
1887     while ($dao->fetch()) {
1888       if ($dao->contribution_id &&
1889         $dao->is_pay_later &&
1890         $dao->contribution_status_id == $pendingStatusId &&
1891         strpos($dao->source, $source) !== FALSE
1892       ) {
1893         $contributionId = $dao->contribution_id;
1894       }
1895     }
1896
1897     return $contributionId;
1898   }
1899
1900   /**
1901    * Update contribution as well as related objects.
1902    *
1903    * This function by-passes hooks - to address this - don't use this function.
1904    *
1905    * @param array $params
1906    * @param bool $processContributionObject
1907    *
1908    * @return array
1909    * @throws \Exception
1910    * @deprecated
1911    *
1912    * Use api contribute.completetransaction
1913    * For failures use failPayment (preferably exposing by api in the process).
1914    *
1915    */
1916   public static function transitionComponents($params, $processContributionObject = FALSE) {
1917     // get minimum required values.
1918     $contactId = CRM_Utils_Array::value('contact_id', $params);
1919     $componentId = CRM_Utils_Array::value('component_id', $params);
1920     $componentName = CRM_Utils_Array::value('componentName', $params);
1921     $contributionId = CRM_Utils_Array::value('contribution_id', $params);
1922     $contributionStatusId = CRM_Utils_Array::value('contribution_status_id', $params);
1923
1924     // if we already processed contribution object pass previous status id.
1925     $previousContriStatusId = CRM_Utils_Array::value('previous_contribution_status_id', $params);
1926
1927     $updateResult = [];
1928
1929     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
1930
1931     // we process only ( Completed, Cancelled, or Failed ) contributions.
1932     if (!$contributionId ||
1933       !in_array($contributionStatusId, [
1934         array_search('Completed', $contributionStatuses),
1935         array_search('Cancelled', $contributionStatuses),
1936         array_search('Failed', $contributionStatuses),
1937       ])
1938     ) {
1939       return $updateResult;
1940     }
1941
1942     if (!$componentName || !$componentId) {
1943       // get the related component details.
1944       $componentDetails = self::getComponentDetails($contributionId);
1945     }
1946     else {
1947       $componentDetails['contact_id'] = $contactId;
1948       $componentDetails['component'] = $componentName;
1949
1950       if ($componentName == 'event') {
1951         $componentDetails['participant'] = $componentId;
1952       }
1953       else {
1954         $componentDetails['membership'] = $componentId;
1955       }
1956     }
1957
1958     if (!empty($componentDetails['contact_id'])) {
1959       $componentDetails['contact_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
1960         $contributionId,
1961         'contact_id'
1962       );
1963     }
1964
1965     // do check for required ids.
1966     if (empty($componentDetails['membership']) && empty($componentDetails['participant']) && empty($componentDetails['pledge_payment']) || empty($componentDetails['contact_id'])) {
1967       return $updateResult;
1968     }
1969
1970     //now we are ready w/ required ids, start processing.
1971
1972     $baseIPN = new CRM_Core_Payment_BaseIPN();
1973
1974     $input = $ids = $objects = [];
1975
1976     $input['component'] = CRM_Utils_Array::value('component', $componentDetails);
1977     $ids['contribution'] = $contributionId;
1978     $ids['contact'] = CRM_Utils_Array::value('contact_id', $componentDetails);
1979     $ids['membership'] = CRM_Utils_Array::value('membership', $componentDetails);
1980     $ids['participant'] = CRM_Utils_Array::value('participant', $componentDetails);
1981     $ids['event'] = CRM_Utils_Array::value('event', $componentDetails);
1982     $ids['pledge_payment'] = CRM_Utils_Array::value('pledge_payment', $componentDetails);
1983     $ids['contributionRecur'] = NULL;
1984     $ids['contributionPage'] = NULL;
1985
1986     if (!$baseIPN->validateData($input, $ids, $objects, FALSE)) {
1987       CRM_Core_Error::fatal();
1988     }
1989
1990     $memberships = &$objects['membership'];
1991     $participant = &$objects['participant'];
1992     $pledgePayment = &$objects['pledge_payment'];
1993     $contribution = &$objects['contribution'];
1994     $pledgeID = $oldStatus = NULL;
1995     $pledgePaymentIDs = [];
1996     if ($pledgePayment) {
1997       foreach ($pledgePayment as $key => $object) {
1998         $pledgePaymentIDs[] = $object->id;
1999       }
2000       $pledgeID = $pledgePayment[0]->pledge_id;
2001     }
2002
2003     $membershipStatuses = CRM_Member_PseudoConstant::membershipStatus();
2004
2005     if ($participant) {
2006       $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
2007       $oldStatus = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant',
2008         $participant->id,
2009         'status_id'
2010       );
2011     }
2012     // we might want to process contribution object.
2013     $processContribution = FALSE;
2014     if ($contributionStatusId == array_search('Cancelled', $contributionStatuses)) {
2015       // Call interim cancel function - with a goal to cleaning up the signature on it and switching to a tested api Contribution.cancel function.
2016       list($updateResult, $processContribution) = self::cancel($processContributionObject, $memberships, $contributionId, $membershipStatuses, $updateResult, $participant, $oldStatus, $pledgePayment, $pledgeID, $pledgePaymentIDs, $contributionStatusId);
2017     }
2018     elseif ($contributionStatusId == array_search('Failed', $contributionStatuses)) {
2019       if (is_array($memberships)) {
2020         foreach ($memberships as $membership) {
2021           $update = TRUE;
2022           //Update Membership status if there is no other completed contribution associated with the membership.
2023           $relatedContributions = CRM_Member_BAO_Membership::getMembershipContributionId($membership->id, TRUE);
2024           foreach ($relatedContributions as $contriId) {
2025             if ($contriId == $contributionId) {
2026               continue;
2027             }
2028             $statusId = CRM_Core_DAO::getFieldValue('CRM_Contribute_BAO_Contribution', $contriId, 'contribution_status_id');
2029             if (CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $statusId) === 'Completed') {
2030               $update = FALSE;
2031             }
2032           }
2033           if ($membership && $update) {
2034             $membership->status_id = array_search('Expired', $membershipStatuses);
2035             $membership->is_override = TRUE;
2036             $membership->status_override_end_date = 'null';
2037             $membership->save();
2038
2039             $updateResult['updatedComponents']['CiviMember'] = $membership->status_id;
2040             if ($processContributionObject) {
2041               $processContribution = TRUE;
2042             }
2043           }
2044         }
2045       }
2046       if ($participant) {
2047         $updatedStatusId = array_search('Cancelled', $participantStatuses);
2048         CRM_Event_BAO_Participant::updateParticipantStatus($participant->id, $oldStatus, $updatedStatusId, TRUE);
2049
2050         $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
2051         if ($processContributionObject) {
2052           $processContribution = TRUE;
2053         }
2054       }
2055
2056       if ($pledgePayment) {
2057         CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
2058
2059         $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
2060         if ($processContributionObject) {
2061           $processContribution = TRUE;
2062         }
2063       }
2064     }
2065     elseif ($contributionStatusId == array_search('Completed', $contributionStatuses)) {
2066
2067       // only pending contribution related object processed.
2068       if ($previousContriStatusId &&
2069         !in_array($contributionStatuses[$previousContriStatusId], [
2070           'Pending',
2071           'Partially paid',
2072         ])
2073       ) {
2074         // this is case when we already processed contribution object.
2075         return $updateResult;
2076       }
2077       elseif (!$previousContriStatusId &&
2078         !in_array($contributionStatuses[$contribution->contribution_status_id], [
2079           'Pending',
2080           'Partially paid',
2081         ])
2082       ) {
2083         // this is case when we are going to process contribution object later.
2084         return $updateResult;
2085       }
2086
2087       if (is_array($memberships)) {
2088         foreach ($memberships as $membership) {
2089           if ($membership) {
2090             $format = '%Y%m%d';
2091
2092             //CRM-4523
2093             $currentMembership = CRM_Member_BAO_Membership::getContactMembership($membership->contact_id,
2094               $membership->membership_type_id,
2095               $membership->is_test, $membership->id
2096             );
2097
2098             // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
2099             // this picks up membership type changes during renewals
2100             $sql = "
2101               SELECT    membership_type_id
2102               FROM      civicrm_membership_log
2103               WHERE     membership_id=$membership->id
2104               ORDER BY  id DESC
2105               LIMIT     1;";
2106             $dao = new CRM_Core_DAO();
2107             $dao->query($sql);
2108             if ($dao->fetch()) {
2109               if (!empty($dao->membership_type_id)) {
2110                 $membership->membership_type_id = $dao->membership_type_id;
2111                 $membership->save();
2112               }
2113             }
2114             // else fall back to using current membership type
2115             // Figure out number of terms
2116             $numterms = 1;
2117             $lineitems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($contributionId);
2118             foreach ($lineitems as $lineitem) {
2119               if ($membership->membership_type_id == CRM_Utils_Array::value('membership_type_id', $lineitem)) {
2120                 $numterms = CRM_Utils_Array::value('membership_num_terms', $lineitem);
2121
2122                 // in case membership_num_terms comes through as null or zero
2123                 $numterms = $numterms >= 1 ? $numterms : 1;
2124                 break;
2125               }
2126             }
2127
2128             // CRM-15735-to update the membership status as per the contribution receive date
2129             $joinDate = NULL;
2130             $oldStatus = $membership->status_id;
2131             if (!empty($params['receive_date'])) {
2132               $joinDate = $params['receive_date'];
2133               $status = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($membership->start_date,
2134                 $membership->end_date,
2135                 $membership->join_date,
2136                 $params['receive_date'],
2137                 FALSE,
2138                 $membership->membership_type_id,
2139                 (array) $membership
2140               );
2141               $membership->status_id = CRM_Utils_Array::value('id', $status, $membership->status_id);
2142               $membership->save();
2143             }
2144
2145             if ($currentMembership) {
2146               CRM_Member_BAO_Membership::fixMembershipStatusBeforeRenew($currentMembership, NULL);
2147               $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($membership->id, NULL, NULL, $numterms);
2148               $dates['join_date'] = CRM_Utils_Date::customFormat($currentMembership['join_date'], $format);
2149             }
2150             else {
2151               $dates = CRM_Member_BAO_MembershipType::getDatesForMembershipType($membership->membership_type_id, $joinDate, NULL, NULL, $numterms);
2152             }
2153
2154             //get the status for membership.
2155             $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($dates['start_date'],
2156               $dates['end_date'],
2157               $dates['join_date'],
2158               'today',
2159               TRUE,
2160               $membership->membership_type_id,
2161               (array) $membership
2162             );
2163
2164             $formattedParams = [
2165               'status_id' => CRM_Utils_Array::value('id', $calcStatus,
2166                 array_search('Current', $membershipStatuses)
2167               ),
2168               'join_date' => CRM_Utils_Date::customFormat($dates['join_date'], $format),
2169               'start_date' => CRM_Utils_Date::customFormat($dates['start_date'], $format),
2170               'end_date' => CRM_Utils_Date::customFormat($dates['end_date'], $format),
2171             ];
2172
2173             CRM_Utils_Hook::pre('edit', 'Membership', $membership->id, $formattedParams);
2174
2175             $membership->copyValues($formattedParams);
2176             $membership->save();
2177
2178             //updating the membership log
2179             $membershipLog = [];
2180             $membershipLog = $formattedParams;
2181             $logStartDate = CRM_Utils_Date::customFormat(CRM_Utils_Array::value('log_start_date', $dates), $format);
2182             $logStartDate = ($logStartDate) ? CRM_Utils_Date::isoToMysql($logStartDate) : $formattedParams['start_date'];
2183
2184             $membershipLog['start_date'] = $logStartDate;
2185             $membershipLog['membership_id'] = $membership->id;
2186             $membershipLog['modified_id'] = $membership->contact_id;
2187             $membershipLog['modified_date'] = date('Ymd');
2188             $membershipLog['membership_type_id'] = $membership->membership_type_id;
2189
2190             CRM_Member_BAO_MembershipLog::add($membershipLog);
2191
2192             //update related Memberships.
2193             CRM_Member_BAO_Membership::updateRelatedMemberships($membership->id, $formattedParams);
2194
2195             foreach (['Membership Signup', 'Membership Renewal'] as $activityType) {
2196               $scheduledActivityID = CRM_Utils_Array::value('id',
2197                 civicrm_api3('Activity', 'Get',
2198                   [
2199                     'source_record_id' => $membership->id,
2200                     'activity_type_id' => $activityType,
2201                     'status_id' => 'Scheduled',
2202                     'options' => [
2203                       'limit' => 1,
2204                       'sort' => 'id DESC',
2205                     ],
2206                   ]
2207                 )
2208               );
2209               // 1. Update Schedule Membership Signup/Renewal activity to completed on successful payment of pending membership
2210               // 2. OR Create renewal activity scheduled if its membership renewal will be paid later
2211               if ($scheduledActivityID) {
2212                 CRM_Activity_BAO_Activity::addActivity($membership, $activityType, $membership->contact_id, ['id' => $scheduledActivityID]);
2213                 break;
2214               }
2215             }
2216
2217             // track membership status change if any
2218             if (!empty($oldStatus) && $membership->status_id != $oldStatus) {
2219               $allStatus = CRM_Member_BAO_Membership::buildOptions('status_id', 'get');
2220               CRM_Activity_BAO_Activity::addActivity($membership,
2221                 'Change Membership Status',
2222                 NULL,
2223                 [
2224                   'subject' => "Status changed from {$allStatus[$oldStatus]} to {$allStatus[$membership->status_id]}",
2225                   'source_contact_id' => $membershipLog['modified_id'],
2226                   'priority_id' => 'Normal',
2227                 ]
2228               );
2229             }
2230
2231             $updateResult['updatedComponents']['CiviMember'] = $membership->status_id;
2232             if ($processContributionObject) {
2233               $processContribution = TRUE;
2234             }
2235
2236             CRM_Utils_Hook::post('edit', 'Membership', $membership->id, $membership);
2237           }
2238         }
2239       }
2240
2241       if ($participant) {
2242         $updatedStatusId = array_search('Registered', $participantStatuses);
2243         CRM_Event_BAO_Participant::updateParticipantStatus($participant->id, $oldStatus, $updatedStatusId, TRUE);
2244
2245         $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
2246         if ($processContributionObject) {
2247           $processContribution = TRUE;
2248         }
2249       }
2250
2251       if ($pledgePayment) {
2252         CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
2253
2254         $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
2255         if ($processContributionObject) {
2256           $processContribution = TRUE;
2257         }
2258       }
2259     }
2260
2261     // process contribution object.
2262     if ($processContribution) {
2263       $contributionParams = [];
2264       $fields = [
2265         'contact_id',
2266         'total_amount',
2267         'receive_date',
2268         'is_test',
2269         'campaign_id',
2270         'payment_instrument_id',
2271         'trxn_id',
2272         'invoice_id',
2273         'financial_type_id',
2274         'contribution_status_id',
2275         'non_deductible_amount',
2276         'receipt_date',
2277         'check_number',
2278       ];
2279       foreach ($fields as $field) {
2280         if (empty($params[$field])) {
2281           continue;
2282         }
2283         $contributionParams[$field] = $params[$field];
2284       }
2285
2286       $ids = ['contribution' => $contributionId];
2287       $contribution = CRM_Contribute_BAO_Contribution::create($contributionParams, $ids);
2288     }
2289
2290     return $updateResult;
2291   }
2292
2293   /**
2294    * Returns all contribution related object ids.
2295    *
2296    * @param $contributionId
2297    *
2298    * @return array
2299    */
2300   public static function getComponentDetails($contributionId) {
2301     $componentDetails = $pledgePayment = [];
2302     if (!$contributionId) {
2303       return $componentDetails;
2304     }
2305
2306     $query = "
2307       SELECT    c.id                 as contribution_id,
2308                 c.contact_id         as contact_id,
2309                 c.contribution_recur_id,
2310                 mp.membership_id     as membership_id,
2311                 m.membership_type_id as membership_type_id,
2312                 pp.participant_id    as participant_id,
2313                 p.event_id           as event_id,
2314                 pgp.id               as pledge_payment_id
2315       FROM      civicrm_contribution c
2316       LEFT JOIN civicrm_membership_payment  mp   ON mp.contribution_id = c.id
2317       LEFT JOIN civicrm_participant_payment pp   ON pp.contribution_id = c.id
2318       LEFT JOIN civicrm_participant         p    ON pp.participant_id  = p.id
2319       LEFT JOIN civicrm_membership          m    ON m.id  = mp.membership_id
2320       LEFT JOIN civicrm_pledge_payment      pgp  ON pgp.contribution_id  = c.id
2321       WHERE     c.id = $contributionId";
2322
2323     $dao = CRM_Core_DAO::executeQuery($query);
2324     $componentDetails = [];
2325
2326     while ($dao->fetch()) {
2327       $componentDetails['component'] = $dao->participant_id ? 'event' : 'contribute';
2328       $componentDetails['contact_id'] = $dao->contact_id;
2329       if ($dao->event_id) {
2330         $componentDetails['event'] = $dao->event_id;
2331       }
2332       if ($dao->participant_id) {
2333         $componentDetails['participant'] = $dao->participant_id;
2334       }
2335       if ($dao->membership_id) {
2336         if (!isset($componentDetails['membership'])) {
2337           $componentDetails['membership'] = $componentDetails['membership_type'] = [];
2338         }
2339         $componentDetails['membership'][] = $dao->membership_id;
2340         $componentDetails['membership_type'][] = $dao->membership_type_id;
2341       }
2342       if ($dao->pledge_payment_id) {
2343         $pledgePayment[] = $dao->pledge_payment_id;
2344       }
2345       if ($dao->contribution_recur_id) {
2346         $componentDetails['contributionRecur'] = $dao->contribution_recur_id;
2347       }
2348     }
2349
2350     if ($pledgePayment) {
2351       $componentDetails['pledge_payment'] = $pledgePayment;
2352     }
2353
2354     return $componentDetails;
2355   }
2356
2357   /**
2358    * @param int $contactId
2359    * @param bool $includeSoftCredit
2360    *
2361    * @return null|string
2362    */
2363   public static function contributionCount($contactId, $includeSoftCredit = TRUE) {
2364     if (!$contactId) {
2365       return 0;
2366     }
2367     $financialTypes = CRM_Financial_BAO_FinancialType::getAllAvailableFinancialTypes();
2368     $additionalWhere = " AND contribution.financial_type_id IN (0)";
2369     $liWhere = " AND i.financial_type_id IN (0)";
2370     if (!empty($financialTypes)) {
2371       $additionalWhere = " AND contribution.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
2372       $liWhere = " AND i.financial_type_id NOT IN (" . implode(',', array_keys($financialTypes)) . ")";
2373     }
2374     $contactContributionsSQL = "
2375       SELECT contribution.id AS id
2376       FROM civicrm_contribution contribution
2377       LEFT JOIN civicrm_line_item i ON i.contribution_id = contribution.id AND i.entity_table = 'civicrm_contribution' $liWhere
2378       WHERE contribution.is_test = 0 AND contribution.contact_id = {$contactId}
2379       $additionalWhere
2380       AND i.id IS NULL";
2381
2382     $contactSoftCreditContributionsSQL = "
2383       SELECT contribution.id
2384       FROM civicrm_contribution contribution INNER JOIN civicrm_contribution_soft softContribution
2385       ON ( contribution.id = softContribution.contribution_id )
2386       WHERE contribution.is_test = 0 AND softContribution.contact_id = {$contactId} ";
2387     $query = "SELECT count( x.id ) count FROM ( ";
2388     $query .= $contactContributionsSQL;
2389
2390     if ($includeSoftCredit) {
2391       $query .= " UNION ";
2392       $query .= $contactSoftCreditContributionsSQL;
2393     }
2394
2395     $query .= ") x";
2396
2397     return CRM_Core_DAO::singleValueQuery($query);
2398   }
2399
2400   /**
2401    * Repeat a transaction as part of a recurring series.
2402    *
2403    * Only call this via the api as it is being refactored. The intention is that the repeatTransaction function
2404    * (possibly living on the ContributionRecur BAO) would be called first to create a pending contribution with a
2405    * subsequent call to the contribution.completetransaction api.
2406    *
2407    * The completeTransaction functionality has historically been overloaded to both complete and repeat payments.
2408    *
2409    * @param CRM_Contribute_BAO_Contribution $contribution
2410    * @param array $input
2411    * @param array $contributionParams
2412    * @param int $paymentProcessorID
2413    *
2414    * @return bool
2415    * @throws CiviCRM_API3_Exception
2416    */
2417   protected static function repeatTransaction(&$contribution, &$input, $contributionParams, $paymentProcessorID) {
2418     if (!empty($contribution->id)) {
2419       return FALSE;
2420     }
2421     if (empty($contribution->id)) {
2422       // Unclear why this would only be set for repeats.
2423       if (!empty($input['amount'])) {
2424         $contribution->total_amount = $contributionParams['total_amount'] = $input['amount'];
2425       }
2426
2427       if (!empty($contributionParams['contribution_recur_id'])) {
2428         $recurringContribution = civicrm_api3('ContributionRecur', 'getsingle', [
2429           'id' => $contributionParams['contribution_recur_id'],
2430         ]);
2431         if (!empty($recurringContribution['campaign_id'])) {
2432           // CRM-17718 the campaign id on the contribution recur record should get precedence.
2433           $contributionParams['campaign_id'] = $recurringContribution['campaign_id'];
2434         }
2435         if (!empty($recurringContribution['financial_type_id'])) {
2436           // CRM-17718 the campaign id on the contribution recur record should get precedence.
2437           $contributionParams['financial_type_id'] = $recurringContribution['financial_type_id'];
2438         }
2439       }
2440       $templateContribution = CRM_Contribute_BAO_ContributionRecur::getTemplateContribution(
2441         $contributionParams['contribution_recur_id'],
2442         array_intersect_key($contributionParams, [
2443           'total_amount' => TRUE,
2444           'financial_type_id' => TRUE,
2445         ])
2446       );
2447       $input['line_item'] = $contributionParams['line_item'] = $templateContribution['line_item'];
2448
2449       $contributionParams['status_id'] = 'Pending';
2450       if (isset($contributionParams['financial_type_id'])) {
2451         // Give precedence to passed in type.
2452         $contribution->financial_type_id = $contributionParams['financial_type_id'];
2453       }
2454       else {
2455         $contributionParams['financial_type_id'] = $templateContribution['financial_type_id'];
2456       }
2457       $contributionParams['contact_id'] = $templateContribution['contact_id'];
2458       $contributionParams['source'] = empty($templateContribution['source']) ? ts('Recurring contribution') : $templateContribution['source'];
2459
2460       //CRM-18805 -- Contribution page not recorded on recurring transactions, Recurring contribution payments
2461       //do not create CC or BCC emails or profile notifications.
2462       //The if is just to be safe. Not sure if we can ever arrive with this unset
2463       // but per CRM-19478 it seems it can be 'null'
2464       if (isset($contribution->contribution_page_id) && is_numeric($contribution->contribution_page_id)) {
2465         $contributionParams['contribution_page_id'] = $contribution->contribution_page_id;
2466       }
2467
2468       $createContribution = civicrm_api3('Contribution', 'create', $contributionParams);
2469       $contribution->id = $createContribution['id'];
2470       CRM_Contribute_BAO_ContributionRecur::copyCustomValues($contributionParams['contribution_recur_id'], $contribution->id);
2471       return TRUE;
2472     }
2473   }
2474
2475   /**
2476    * Get individual id for onbehalf contribution.
2477    *
2478    * @param int $contributionId
2479    *   Contribution id.
2480    * @param int $contributorId
2481    *   Contributor id.
2482    *
2483    * @return array
2484    *   containing organization id and individual id
2485    */
2486   public static function getOnbehalfIds($contributionId, $contributorId = NULL) {
2487
2488     $ids = [];
2489
2490     if (!$contributionId) {
2491       return $ids;
2492     }
2493
2494     // fetch contributor id if null
2495     if (!$contributorId) {
2496       $contributorId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
2497         $contributionId, 'contact_id'
2498       );
2499     }
2500
2501     $activityTypeIds = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
2502     $activityTypeId = array_search('Contribution', $activityTypeIds);
2503
2504     if ($activityTypeId && $contributorId) {
2505       $activityQuery = "
2506 SELECT     civicrm_activity_contact.contact_id
2507   FROM     civicrm_activity_contact
2508 INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_activity.id
2509  WHERE     civicrm_activity.activity_type_id   = %1
2510    AND     civicrm_activity.source_record_id   = %2
2511    AND     civicrm_activity_contact.record_type_id = %3
2512 ";
2513
2514       $activityContacts = CRM_Activity_BAO_ActivityContact::buildOptions('record_type_id', 'validate');
2515       $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
2516
2517       $params = [
2518         1 => [$activityTypeId, 'Integer'],
2519         2 => [$contributionId, 'Integer'],
2520         3 => [$sourceID, 'Integer'],
2521       ];
2522
2523       $sourceContactId = CRM_Core_DAO::singleValueQuery($activityQuery, $params);
2524
2525       // for on behalf contribution source is individual and contributor is organization
2526       if ($sourceContactId && $sourceContactId != $contributorId) {
2527         $relationshipTypeIds = CRM_Core_PseudoConstant::relationshipType('name');
2528         // get rel type id for employee of relation
2529         foreach ($relationshipTypeIds as $id => $typeVals) {
2530           if ($typeVals['name_a_b'] == 'Employee of') {
2531             $relationshipTypeId = $id;
2532             break;
2533           }
2534         }
2535
2536         $rel = new CRM_Contact_DAO_Relationship();
2537         $rel->relationship_type_id = $relationshipTypeId;
2538         $rel->contact_id_a = $sourceContactId;
2539         $rel->contact_id_b = $contributorId;
2540         if ($rel->find(TRUE)) {
2541           $ids['individual_id'] = $rel->contact_id_a;
2542           $ids['organization_id'] = $rel->contact_id_b;
2543         }
2544       }
2545     }
2546
2547     return $ids;
2548   }
2549
2550   /**
2551    * @return array
2552    */
2553   public static function getContributionDates() {
2554     $config = CRM_Core_Config::singleton();
2555     $currentMonth = date('m');
2556     $currentDay = date('d');
2557     if ((int ) $config->fiscalYearStart['M'] > $currentMonth ||
2558       ((int ) $config->fiscalYearStart['M'] == $currentMonth &&
2559         (int ) $config->fiscalYearStart['d'] > $currentDay
2560       )
2561     ) {
2562       $year = date('Y') - 1;
2563     }
2564     else {
2565       $year = date('Y');
2566     }
2567     $year = ['Y' => $year];
2568     $yearDate = $config->fiscalYearStart;
2569     $yearDate = array_merge($year, $yearDate);
2570     $yearDate = CRM_Utils_Date::format($yearDate);
2571
2572     $monthDate = date('Ym') . '01';
2573
2574     $now = date('Ymd');
2575
2576     return [
2577       'now' => $now,
2578       'yearDate' => $yearDate,
2579       'monthDate' => $monthDate,
2580     ];
2581   }
2582
2583   /**
2584    * Load objects relations to contribution object.
2585    * Objects are stored in the $_relatedObjects property
2586    * In the first instance we are just moving functionality from BASEIpn -
2587    *
2588    * @see http://issues.civicrm.org/jira/browse/CRM-9996
2589    *
2590    * Note that the unit test for the BaseIPN class tests this function
2591    *
2592    * @param array $input
2593    *   Input as delivered from Payment Processor.
2594    * @param array $ids
2595    *   Ids as Loaded by Payment Processor.
2596    * @param bool $loadAll
2597    *   Load all related objects - even where id not passed in? (allows API to call this).
2598    *
2599    * @return bool
2600    * @throws Exception
2601    */
2602   public function loadRelatedObjects(&$input, &$ids, $loadAll = FALSE) {
2603     // @todo deprecate this function - the steps should be
2604     // 1) add additional functions like 'getRelatedMemberships'
2605     // 2) switch all calls that refer to ->_relatedObjects to
2606     // using the helper functions
2607     // 3) make ->_relatedObjects noisy in some way (deprecation won't work for properties - hmm
2608     // 4) make ->_relatedObjects protected
2609     // 5) hone up the individual functions to not use rely on this having been called
2610     // 6) deprecate like mad
2611     if ($loadAll) {
2612       $ids = array_merge($this->getComponentDetails($this->id), $ids);
2613       if (empty($ids['contact']) && isset($this->contact_id)) {
2614         $ids['contact'] = $this->contact_id;
2615       }
2616     }
2617     if (empty($this->_component)) {
2618       if (!empty($ids['event'])) {
2619         $this->_component = 'event';
2620       }
2621       else {
2622         $this->_component = strtolower(CRM_Utils_Array::value('component', $input, 'contribute'));
2623       }
2624     }
2625
2626     // If the object is not fully populated then make sure it is - this is a more about legacy paths & cautious
2627     // refactoring than anything else, and has unit test coverage.
2628     if (empty($this->financial_type_id)) {
2629       $this->find(TRUE);
2630     }
2631
2632     $paymentProcessorID = CRM_Utils_Array::value('payment_processor_id', $input, CRM_Utils_Array::value(
2633       'paymentProcessor',
2634       $ids
2635     ));
2636
2637     if (!isset($input['payment_processor_id']) && !$paymentProcessorID && $this->contribution_page_id) {
2638       $paymentProcessorID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage',
2639         $this->contribution_page_id,
2640         'payment_processor'
2641       );
2642       if ($paymentProcessorID) {
2643         $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromContributionPage;
2644       }
2645     }
2646
2647     $ids['contributionType'] = $this->financial_type_id;
2648     $ids['financialType'] = $this->financial_type_id;
2649     if ($this->contribution_page_id) {
2650       $ids['contributionPage'] = $this->contribution_page_id;
2651     }
2652
2653     $this->loadRelatedEntitiesByID($ids);
2654
2655     if (!empty($ids['contributionRecur']) && !$paymentProcessorID) {
2656       $paymentProcessorID = $this->_relatedObjects['contributionRecur']->payment_processor_id;
2657     }
2658
2659     if (!empty($ids['pledge_payment'])) {
2660       foreach ($ids['pledge_payment'] as $key => $paymentID) {
2661         if (empty($paymentID)) {
2662           continue;
2663         }
2664         $payment = new CRM_Pledge_BAO_PledgePayment();
2665         $payment->id = $paymentID;
2666         if (!$payment->find(TRUE)) {
2667           throw new Exception("Could not find pledge payment record: " . $paymentID);
2668         }
2669         $this->_relatedObjects['pledge_payment'][] = $payment;
2670       }
2671     }
2672
2673     // These are probably no longer accessed from anywhere
2674     // @todo remove this line, after ensuring not used.
2675     $ids = $this->loadRelatedMembershipObjects($ids);
2676
2677     if ($this->_component != 'contribute') {
2678       // we are in event mode
2679       // make sure event exists and is valid
2680       $event = new CRM_Event_BAO_Event();
2681       $event->id = $ids['event'];
2682       if ($ids['event'] &&
2683         !$event->find(TRUE)
2684       ) {
2685         throw new Exception("Could not find event: " . $ids['event']);
2686       }
2687
2688       $this->_relatedObjects['event'] = &$event;
2689
2690       $participant = new CRM_Event_BAO_Participant();
2691       $participant->id = $ids['participant'];
2692       if ($ids['participant'] &&
2693         !$participant->find(TRUE)
2694       ) {
2695         throw new Exception("Could not find participant: " . $ids['participant']);
2696       }
2697       $participant->register_date = CRM_Utils_Date::isoToMysql($participant->register_date);
2698
2699       $this->_relatedObjects['participant'] = &$participant;
2700
2701       // get the payment processor id from event - this is inaccurate see CRM-16923
2702       // in future we should look at throwing an exception here rather than an dubious guess.
2703       if (!$paymentProcessorID) {
2704         $paymentProcessorID = $this->_relatedObjects['event']->payment_processor;
2705         if ($paymentProcessorID) {
2706           $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromEvent;
2707         }
2708       }
2709     }
2710
2711     if ($paymentProcessorID) {
2712       $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($paymentProcessorID,
2713         $this->is_test ? 'test' : 'live'
2714       );
2715       $ids['paymentProcessor'] = $paymentProcessorID;
2716       $this->_relatedObjects['paymentProcessor'] = $paymentProcessor;
2717     }
2718
2719     // Add contribution id to $ids. CRM-20401
2720     $ids['contribution'] = $this->id;
2721     return TRUE;
2722   }
2723
2724   /**
2725    * Create array of message information - ie. return html version, txt version, to field
2726    *
2727    * @param array $input
2728    *   Incoming information.
2729    *   - is_recur - should this be treated as recurring (not sure why you wouldn't
2730    *    just check presence of recur object but maintaining legacy approach
2731    *    to be careful)
2732    * @param array $ids
2733    *   IDs of related objects.
2734    * @param array $values
2735    *   Any values that may have already been compiled by calling process.
2736    *   This is augmented by values 'gathered' by gatherMessageValues
2737    * @param bool $returnMessageText
2738    *   Distinguishes between whether to send message or return.
2739    *   message text. We are working towards this function ALWAYS returning message text & calling
2740    *   function doing emails / pdfs with it
2741    *
2742    * @return array
2743    *   messages
2744    * @throws Exception
2745    */
2746   public function composeMessageArray(&$input, &$ids, &$values, $returnMessageText = TRUE) {
2747     $this->loadRelatedObjects($input, $ids);
2748
2749     if (empty($this->_component)) {
2750       $this->_component = CRM_Utils_Array::value('component', $input);
2751     }
2752
2753     //not really sure what params might be passed in but lets merge em into values
2754     $values = array_merge($this->_gatherMessageValues($input, $values, $ids), $values);
2755     $values['is_email_receipt'] = $this->isEmailReceipt($input, $values);
2756     if (!empty($input['receipt_date'])) {
2757       $values['receipt_date'] = $input['receipt_date'];
2758     }
2759
2760     $template = $this->_assignMessageVariablesToTemplate($values, $input, $returnMessageText);
2761     //what does recur 'mean here - to do with payment processor return functionality but
2762     // what is the importance
2763     if (!empty($this->contribution_recur_id) && !empty($this->_relatedObjects['paymentProcessor'])) {
2764       $paymentObject = Civi\Payment\System::singleton()->getByProcessor($this->_relatedObjects['paymentProcessor']);
2765
2766       $entityID = $entity = NULL;
2767       if (isset($ids['contribution'])) {
2768         $entity = 'contribution';
2769         $entityID = $ids['contribution'];
2770       }
2771       if (!empty($ids['membership'])) {
2772         //not sure whether is is possible for this not to be an array - load related contacts loads an array but this code was expecting a string
2773         // the addition of the casting is in case it could get here & be a string. Added in 4.6 - maybe remove later? This AuthorizeNetIPN & PaypalIPN tests hit this
2774         // line having loaded an array
2775         $ids['membership'] = (array) $ids['membership'];
2776         $entity = 'membership';
2777         $entityID = $ids['membership'][0];
2778       }
2779
2780       $template->assign('cancelSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'cancel'));
2781       $template->assign('updateSubscriptionBillingUrl', $paymentObject->subscriptionURL($entityID, $entity, 'billing'));
2782       $template->assign('updateSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'update'));
2783
2784       if ($this->_relatedObjects['paymentProcessor']['billing_mode'] & CRM_Core_Payment::BILLING_MODE_FORM) {
2785         //direct mode showing billing block, so use directIPN for temporary
2786         $template->assign('contributeMode', 'directIPN');
2787       }
2788     }
2789     // todo remove strtolower - check consistency
2790     if (strtolower($this->_component) == 'event') {
2791       $eventParams = ['id' => $this->_relatedObjects['participant']->event_id];
2792       $values['event'] = [];
2793
2794       CRM_Event_BAO_Event::retrieve($eventParams, $values['event']);
2795
2796       //get location details
2797       $locationParams = [
2798         'entity_id' => $this->_relatedObjects['participant']->event_id,
2799         'entity_table' => 'civicrm_event',
2800       ];
2801       $values['location'] = CRM_Core_BAO_Location::getValues($locationParams);
2802
2803       $ufJoinParams = [
2804         'entity_table' => 'civicrm_event',
2805         'entity_id' => $ids['event'],
2806         'module' => 'CiviEvent',
2807       ];
2808
2809       list($custom_pre_id,
2810         $custom_post_ids
2811         ) = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
2812
2813       $values['custom_pre_id'] = $custom_pre_id;
2814       $values['custom_post_id'] = $custom_post_ids;
2815       //for tasks 'Change Participant Status' and 'Update multiple Contributions' case
2816       //and cases involving status updation through ipn
2817       // whatever that means!
2818       // total_amount appears to be the preferred input param & it is unclear why we support amount here
2819       // perhaps we should throw an e-notice if amount is set & force total_amount?
2820       if (!empty($input['amount'])) {
2821         $values['totalAmount'] = $input['amount'];
2822       }
2823       // @todo set this in is_email_receipt, based on $this->_relatedObjects.
2824       if ($values['event']['is_email_confirm']) {
2825         $values['is_email_receipt'] = 1;
2826       }
2827
2828       if (!empty($ids['contribution'])) {
2829         $values['contributionId'] = $ids['contribution'];
2830       }
2831
2832       return CRM_Event_BAO_Event::sendMail($ids['contact'], $values,
2833         $this->_relatedObjects['participant']->id, $this->is_test, $returnMessageText
2834       );
2835     }
2836     else {
2837       $values['contribution_id'] = $this->id;
2838       if (!empty($ids['related_contact'])) {
2839         $values['related_contact'] = $ids['related_contact'];
2840         if (isset($ids['onbehalf_dupe_alert'])) {
2841           $values['onbehalf_dupe_alert'] = $ids['onbehalf_dupe_alert'];
2842         }
2843         $entityBlock = [
2844           'contact_id' => $ids['contact'],
2845           'location_type_id' => CRM_Core_DAO::getFieldValue('CRM_Core_DAO_LocationType',
2846             'Home', 'id', 'name'
2847           ),
2848         ];
2849         $address = CRM_Core_BAO_Address::getValues($entityBlock);
2850         $template->assign('onBehalfAddress', $address[$entityBlock['location_type_id']]['display']);
2851       }
2852       $isTest = FALSE;
2853       if ($this->is_test) {
2854         $isTest = TRUE;
2855       }
2856       if (!empty($this->_relatedObjects['membership'])) {
2857         foreach ($this->_relatedObjects['membership'] as $membership) {
2858           if ($membership->id) {
2859             $values['membership_id'] = $membership->id;
2860             $values['isMembership'] = TRUE;
2861             $values['membership_assign'] = TRUE;
2862
2863             // need to set the membership values here
2864             $template->assign('membership_name',
2865               CRM_Member_PseudoConstant::membershipType($membership->membership_type_id)
2866             );
2867             $template->assign('mem_start_date', $membership->start_date);
2868             $template->assign('mem_join_date', $membership->join_date);
2869             $template->assign('mem_end_date', $membership->end_date);
2870             $membership_status = CRM_Member_PseudoConstant::membershipStatus($membership->status_id, NULL, 'label');
2871             $template->assign('mem_status', $membership_status);
2872             if ($membership_status == 'Pending' && $membership->is_pay_later == 1) {
2873               $values['is_pay_later'] = 1;
2874             }
2875             // Pass amount to floatval as string '0.00' is considered a
2876             // valid amount and includes Fee section in the mail.
2877             if (isset($values['amount'])) {
2878               $values['amount'] = floatval($values['amount']);
2879             }
2880
2881             if (!empty($this->contribution_recur_id) && $paymentObject) {
2882               $url = $paymentObject->subscriptionURL($membership->id, 'membership', 'cancel');
2883               $template->assign('cancelSubscriptionUrl', $url);
2884               $url = $paymentObject->subscriptionURL($membership->id, 'membership', 'billing');
2885               $template->assign('updateSubscriptionBillingUrl', $url);
2886               $url = $paymentObject->subscriptionURL($entityID, $entity, 'update');
2887               $template->assign('updateSubscriptionUrl', $url);
2888             }
2889
2890             $result = CRM_Contribute_BAO_ContributionPage::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
2891
2892             return $result;
2893             // otherwise if its about sending emails, continue sending without return, as we
2894             // don't want to exit the loop.
2895           }
2896         }
2897       }
2898       else {
2899         return CRM_Contribute_BAO_ContributionPage::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
2900       }
2901     }
2902   }
2903
2904   /**
2905    * Gather values for contribution mail - this function has been created
2906    * as part of CRM-9996 refactoring as a step towards simplifying the composeMessage function
2907    * Values related to the contribution in question are gathered
2908    *
2909    * @param array $input
2910    *   Input into function (probably from payment processor).
2911    * @param array $values
2912    * @param array $ids
2913    *   The set of ids related to the input.
2914    *
2915    * @return array
2916    * @throws \CRM_Core_Exception
2917    */
2918   public function _gatherMessageValues($input, &$values, $ids = []) {
2919     // set display address of contributor
2920     if ($this->address_id) {
2921       $addressParams = ['id' => $this->address_id];
2922       $addressDetails = CRM_Core_BAO_Address::getValues($addressParams, FALSE, 'id');
2923       $addressDetails = array_values($addressDetails);
2924     }
2925     // Else we assign the billing address of the contribution contact.
2926     else {
2927       $addressParams = ['contact_id' => $this->contact_id, 'is_billing' => 1];
2928       $addressDetails = (array) CRM_Core_BAO_Address::getValues($addressParams);
2929       $addressDetails = array_values($addressDetails);
2930     }
2931
2932     if (!empty($addressDetails[0]['display'])) {
2933       $values['address'] = $addressDetails[0]['display'];
2934     }
2935
2936     if ($this->_component == 'contribute') {
2937       //get soft contributions
2938       $softContributions = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($this->id, TRUE);
2939       if (!empty($softContributions)) {
2940         $values['softContributions'] = $softContributions['soft_credit'];
2941       }
2942       if (isset($this->contribution_page_id)) {
2943         // This is a call we want to use less, in favour of loading related objects.
2944         $values = $this->addContributionPageValuesToValuesHeavyHandedly($values);
2945         if ($this->contribution_page_id) {
2946           // This is precautionary as there are some legacy flows, but it should really be
2947           // loaded by now.
2948           if (!isset($this->_relatedObjects['contributionPage'])) {
2949             $this->loadRelatedEntitiesByID(['contributionPage' => $this->contribution_page_id]);
2950           }
2951           CRM_Contribute_BAO_Contribution_Utils::overrideDefaultCurrency($values);
2952         }
2953       }
2954       // no contribution page -probably back office
2955       else {
2956         // Handle re-print receipt for offline contributions (call from PDF.php - no contribution_page_id)
2957         $values['title'] = 'Contribution';
2958       }
2959       // set lineItem for contribution
2960       if ($this->id) {
2961         $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($this->id);
2962         if (!empty($lineItems)) {
2963           $firstLineItem = reset($lineItems);
2964           $priceSet = [];
2965           if (CRM_Utils_Array::value('price_set_id', $firstLineItem)) {
2966             $priceSet = civicrm_api3('PriceSet', 'getsingle', [
2967               'id' => $firstLineItem['price_set_id'],
2968               'return' => 'is_quick_config, id',
2969             ]);
2970             $values['priceSetID'] = $priceSet['id'];
2971           }
2972           foreach ($lineItems as &$eachItem) {
2973             if (isset($this->_relatedObjects['membership'])
2974               && is_array($this->_relatedObjects['membership'])
2975               && array_key_exists($eachItem['membership_type_id'], $this->_relatedObjects['membership'])) {
2976               $eachItem['join_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->join_date);
2977               $eachItem['start_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->start_date);
2978               $eachItem['end_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->end_date);
2979             }
2980             // This is actually used in conjunction with is_quick_config in the template & we should deprecate it.
2981             // However, that does create upgrade pain so would be better to be phased in.
2982             $values['useForMember'] = empty($priceSet['is_quick_config']);
2983           }
2984           $values['lineItem'][0] = $lineItems;
2985         }
2986       }
2987
2988       $relatedContact = CRM_Contribute_BAO_Contribution::getOnbehalfIds(
2989         $this->id,
2990         $this->contact_id
2991       );
2992       // if this is onbehalf of contribution then set related contact
2993       if (!empty($relatedContact['individual_id'])) {
2994         $values['related_contact'] = $ids['related_contact'] = $relatedContact['individual_id'];
2995       }
2996     }
2997     else {
2998       $values = array_merge($values, $this->loadEventMessageTemplateParams((int) $ids['event'], (int) $this->_relatedObjects['participant']->id, $this->id));
2999     }
3000
3001     $groupTree = CRM_Core_BAO_CustomGroup::getTree('Contribution', NULL, $this->id);
3002
3003     $customGroup = [];
3004     foreach ($groupTree as $key => $group) {
3005       if ($key === 'info') {
3006         continue;
3007       }
3008
3009       foreach ($group['fields'] as $k => $customField) {
3010         $groupLabel = $group['title'];
3011         if (!empty($customField['customValue'])) {
3012           foreach ($customField['customValue'] as $customFieldValues) {
3013             $customGroup[$groupLabel][$customField['label']] = CRM_Utils_Array::value('data', $customFieldValues);
3014           }
3015         }
3016       }
3017     }
3018     $values['customGroup'] = $customGroup;
3019
3020     $values['is_pay_later'] = $this->is_pay_later;
3021
3022     return $values;
3023   }
3024
3025   /**
3026    * Assign message variables to template but try to break the habit.
3027    *
3028    * In order to get away from leaky variables it is better to ensure variables are set in values and assign them
3029    * from the send function. Otherwise smarty variables can leak if this is called more than once - e.g. processing
3030    * multiple recurring payments for processors like IATS that use tokens.
3031    *
3032    * Apply variables for message to smarty template - this function is part of analysing what is in the huge
3033    * function & breaking it down into manageable chunks. Eventually it will be refactored into something else
3034    * Note we send directly from this function in some cases because it is only partly refactored.
3035    *
3036    * Don't call this function directly as the signature will change.
3037    *
3038    * @param $values
3039    * @param $input
3040    * @param bool $returnMessageText
3041    *
3042    * @return mixed
3043    */
3044   public function _assignMessageVariablesToTemplate(&$values, $input, $returnMessageText = TRUE) {
3045     // @todo - this should have a better separation of concerns - ie.
3046     // gatherMessageValues should build an array of values to be assigned to the template
3047     // and this function should assign them (assigning null if not set).
3048     // the way the pcpParams & honor Params section works is a baby-step towards this.
3049     $template = CRM_Core_Smarty::singleton();
3050     $template->assign('first_name', $this->_relatedObjects['contact']->first_name);
3051     $template->assign('last_name', $this->_relatedObjects['contact']->last_name);
3052     $template->assign('displayName', $this->_relatedObjects['contact']->display_name);
3053
3054     // For some unit tests contribution cannot contain paymentProcessor information
3055     $billingMode = empty($this->_relatedObjects['paymentProcessor']) ? CRM_Core_Payment::BILLING_MODE_NOTIFY : $this->_relatedObjects['paymentProcessor']['billing_mode'];
3056     $template->assign('contributeMode', CRM_Utils_Array::value($billingMode, CRM_Core_SelectValues::contributeMode()));
3057
3058     //assign honor information to receipt message
3059     $softRecord = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($this->id);
3060
3061     $honorParams = [
3062       'soft_credit_type' => NULL,
3063       'honor_block_is_active' => NULL,
3064     ];
3065     if (isset($softRecord['soft_credit'])) {
3066       //if id of contribution page is present
3067       if (!empty($values['id'])) {
3068         $values['honor'] = [
3069           'honor_profile_values' => [],
3070           'honor_profile_id' => CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'uf_group_id', 'entity_id'),
3071           'honor_id' => $softRecord['soft_credit'][1]['contact_id'],
3072         ];
3073
3074         $honorParams['soft_credit_type'] = $softRecord['soft_credit'][1]['soft_credit_type_label'];
3075         $honorParams['honor_block_is_active'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'is_active', 'entity_id');
3076       }
3077       else {
3078         //offline contribution
3079         $softCreditTypes = $softCredits = [];
3080         foreach ($softRecord['soft_credit'] as $key => $softCredit) {
3081           $softCreditTypes[$key] = $softCredit['soft_credit_type_label'];
3082           $softCredits[$key] = [
3083             'Name' => $softCredit['contact_name'],
3084             'Amount' => CRM_Utils_Money::format($softCredit['amount'], $softCredit['currency']),
3085           ];
3086         }
3087         $template->assign('softCreditTypes', $softCreditTypes);
3088         $template->assign('softCredits', $softCredits);
3089       }
3090     }
3091
3092     $dao = new CRM_Contribute_DAO_ContributionProduct();
3093     $dao->contribution_id = $this->id;
3094     if ($dao->find(TRUE)) {
3095       $premiumId = $dao->product_id;
3096       $template->assign('option', $dao->product_option);
3097
3098       $productDAO = new CRM_Contribute_DAO_Product();
3099       $productDAO->id = $premiumId;
3100       $productDAO->find(TRUE);
3101       $template->assign('selectPremium', TRUE);
3102       $template->assign('product_name', $productDAO->name);
3103       $template->assign('price', $productDAO->price);
3104       $template->assign('sku', $productDAO->sku);
3105     }
3106     $template->assign('title', CRM_Utils_Array::value('title', $values));
3107     $values['amount'] = CRM_Utils_Array::value('total_amount', $input, (CRM_Utils_Array::value('amount', $input)), NULL);
3108     if (!$values['amount'] && isset($this->total_amount)) {
3109       $values['amount'] = $this->total_amount;
3110     }
3111
3112     $pcpParams = [
3113       'pcpBlock' => NULL,
3114       'pcp_display_in_roll' => NULL,
3115       'pcp_roll_nickname' => NULL,
3116       'pcp_personal_note' => NULL,
3117       'title' => NULL,
3118     ];
3119
3120     if (strtolower($this->_component) == 'contribute') {
3121       //PCP Info
3122       $softDAO = new CRM_Contribute_DAO_ContributionSoft();
3123       $softDAO->contribution_id = $this->id;
3124       if ($softDAO->find(TRUE)) {
3125         $pcpParams['pcpBlock'] = TRUE;
3126         $pcpParams['pcp_display_in_roll'] = $softDAO->pcp_display_in_roll;
3127         $pcpParams['pcp_roll_nickname'] = $softDAO->pcp_roll_nickname;
3128         $pcpParams['pcp_personal_note'] = $softDAO->pcp_personal_note;
3129
3130         //assign the pcp page title for email subject
3131         $pcpDAO = new CRM_PCP_DAO_PCP();
3132         $pcpDAO->id = $softDAO->pcp_id;
3133         if ($pcpDAO->find(TRUE)) {
3134           $pcpParams['title'] = $pcpDAO->title;
3135         }
3136       }
3137     }
3138     foreach (array_merge($honorParams, $pcpParams) as $templateKey => $templateValue) {
3139       $template->assign($templateKey, $templateValue);
3140     }
3141
3142     if ($this->financial_type_id) {
3143       $values['financial_type_id'] = $this->financial_type_id;
3144     }
3145
3146     $template->assign('trxn_id', $this->trxn_id);
3147     $template->assign('receive_date',
3148       CRM_Utils_Date::processDate($this->receive_date)
3149     );
3150     $values['receipt_date'] = (empty($this->receipt_date) ? NULL : $this->receipt_date);
3151     $template->assign('action', $this->is_test ? 1024 : 1);
3152     $template->assign('receipt_text',
3153       CRM_Utils_Array::value('receipt_text',
3154         $values
3155       )
3156     );
3157     $template->assign('is_monetary', 1);
3158     $template->assign('is_recur', !empty($this->contribution_recur_id));
3159     $template->assign('currency', $this->currency);
3160     $template->assign('address', CRM_Utils_Address::format($input));
3161     if (!empty($values['customGroup'])) {
3162       $template->assign('customGroup', $values['customGroup']);
3163     }
3164     if (!empty($values['softContributions'])) {
3165       $template->assign('softContributions', $values['softContributions']);
3166     }
3167     if ($this->_component == 'event') {
3168       $template->assign('title', $values['event']['title']);
3169       $participantRoles = CRM_Event_PseudoConstant::participantRole();
3170       $viewRoles = [];
3171       foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $this->_relatedObjects['participant']->role_id) as $k => $v) {
3172         $viewRoles[] = $participantRoles[$v];
3173       }
3174       $values['event']['participant_role'] = implode(', ', $viewRoles);
3175       $template->assign('event', $values['event']);
3176       $template->assign('participant', $values['participant']);
3177       $template->assign('location', $values['location']);
3178       $template->assign('customPre', $values['custom_pre_id']);
3179       $template->assign('customPost', $values['custom_post_id']);
3180
3181       $isTest = FALSE;
3182       if ($this->_relatedObjects['participant']->is_test) {
3183         $isTest = TRUE;
3184       }
3185
3186       $values['params'] = [];
3187       //to get email of primary participant.
3188       $primaryEmail = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Email', $this->_relatedObjects['participant']->contact_id, 'email', 'contact_id');
3189       $primaryAmount[] = [
3190         'label' => $this->_relatedObjects['participant']->fee_level . ' - ' . $primaryEmail,
3191         'amount' => $this->_relatedObjects['participant']->fee_amount,
3192       ];
3193       //build an array of cId/pId of participants
3194       $additionalIDs = CRM_Event_BAO_Event::buildCustomProfile($this->_relatedObjects['participant']->id, NULL, $this->_relatedObjects['contact']->id, $isTest, TRUE);
3195       unset($additionalIDs[$this->_relatedObjects['participant']->id]);
3196       //send receipt to additional participant if exists
3197       if (count($additionalIDs)) {
3198         $template->assign('isPrimary', 0);
3199         $template->assign('customProfile', NULL);
3200         //set additionalParticipant true
3201         $values['params']['additionalParticipant'] = TRUE;
3202         foreach ($additionalIDs as $pId => $cId) {
3203           $amount = [];
3204           //to change the status pending to completed
3205           $additional = new CRM_Event_DAO_Participant();
3206           $additional->id = $pId;
3207           $additional->contact_id = $cId;
3208           $additional->find(TRUE);
3209           $additional->register_date = $this->_relatedObjects['participant']->register_date;
3210           $additional->status_id = 1;
3211           $additionalParticipantInfo = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Email', $additional->contact_id, 'email', 'contact_id');
3212           //if additional participant dont have email
3213           //use display name.
3214           if (!$additionalParticipantInfo) {
3215             $additionalParticipantInfo = CRM_Contact_BAO_Contact::displayName($additional->contact_id);
3216           }
3217           $amount[0] = [
3218             'label' => $additional->fee_level,
3219             'amount' => $additional->fee_amount,
3220           ];
3221           $primaryAmount[] = [
3222             'label' => $additional->fee_level . ' - ' . $additionalParticipantInfo,
3223             'amount' => $additional->fee_amount,
3224           ];
3225           $additional->save();
3226           $template->assign('amount', $amount);
3227           CRM_Event_BAO_Event::sendMail($cId, $values, $pId, $isTest, $returnMessageText);
3228         }
3229       }
3230
3231       //build an array of custom profile and assigning it to template
3232       $customProfile = CRM_Event_BAO_Event::buildCustomProfile($this->_relatedObjects['participant']->id, $values, NULL, $isTest);
3233
3234       if (count($customProfile)) {
3235         $template->assign('customProfile', $customProfile);
3236       }
3237
3238       // for primary contact
3239       $values['params']['additionalParticipant'] = FALSE;
3240       $template->assign('isPrimary', 1);
3241       $template->assign('amount', $primaryAmount);
3242       $template->assign('register_date', CRM_Utils_Date::isoToMysql($this->_relatedObjects['participant']->register_date));
3243       if ($this->payment_instrument_id) {
3244         $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
3245         $template->assign('paidBy', $paymentInstrument[$this->payment_instrument_id]);
3246       }
3247       // carry paylater, since we did not created billing,
3248       // so need to pull email from primary location, CRM-4395
3249       $values['params']['is_pay_later'] = $this->_relatedObjects['participant']->is_pay_later;
3250     }
3251     return $template;
3252   }
3253
3254   /**
3255    * Check whether payment processor supports
3256    * cancellation of contribution subscription
3257    *
3258    * @param int $contributionId
3259    *   Contribution id.
3260    *
3261    * @param bool $isNotCancelled
3262    *
3263    * @return bool
3264    */
3265   public static function isCancelSubscriptionSupported($contributionId, $isNotCancelled = TRUE) {
3266     $cacheKeyString = "$contributionId";
3267     $cacheKeyString .= $isNotCancelled ? '_1' : '_0';
3268
3269     static $supportsCancel = [];
3270
3271     if (!array_key_exists($cacheKeyString, $supportsCancel)) {
3272       $supportsCancel[$cacheKeyString] = FALSE;
3273       $isCancelled = FALSE;
3274
3275       if ($isNotCancelled) {
3276         $isCancelled = self::isSubscriptionCancelled($contributionId);
3277       }
3278
3279       $paymentObject = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($contributionId, 'contribute', 'obj');
3280       if (!empty($paymentObject)) {
3281         $supportsCancel[$cacheKeyString] = $paymentObject->supports('cancelRecurring') && !$isCancelled;
3282       }
3283     }
3284     return $supportsCancel[$cacheKeyString];
3285   }
3286
3287   /**
3288    * Check whether subscription is already cancelled.
3289    *
3290    * @param int $contributionId
3291    *   Contribution id.
3292    *
3293    * @return string
3294    *   contribution status
3295    */
3296   public static function isSubscriptionCancelled($contributionId) {
3297     $sql = "
3298        SELECT cr.contribution_status_id
3299          FROM civicrm_contribution_recur cr
3300     LEFT JOIN civicrm_contribution con ON ( cr.id = con.contribution_recur_id )
3301         WHERE con.id = %1 LIMIT 1";
3302     $params = [1 => [$contributionId, 'Integer']];
3303     $statusId = CRM_Core_DAO::singleValueQuery($sql, $params);
3304     $status = CRM_Contribute_PseudoConstant::contributionStatus($statusId);
3305     if ($status == 'Cancelled') {
3306       return TRUE;
3307     }
3308     return FALSE;
3309   }
3310
3311   /**
3312    * Create all financial accounts entry.
3313    *
3314    * @param array $params
3315    *   Contribution object, line item array and params for trxn.
3316    *
3317    *
3318    * @param array $financialTrxnValues
3319    *
3320    * @return null|\CRM_Core_BAO_FinancialTrxn
3321    */
3322   public static function recordFinancialAccounts(&$params, $financialTrxnValues = NULL) {
3323     $skipRecords = $update = $return = $isRelatedId = FALSE;
3324
3325     $additionalParticipantId = [];
3326     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
3327     $contributionStatus = empty($params['contribution_status_id']) ? NULL : $contributionStatuses[$params['contribution_status_id']];
3328
3329     if (CRM_Utils_Array::value('contribution_mode', $params) == 'participant') {
3330       $entityId = $params['participant_id'];
3331       $entityTable = 'civicrm_participant';
3332       $additionalParticipantId = CRM_Event_BAO_Participant::getAdditionalParticipantIds($entityId);
3333     }
3334     elseif (!empty($params['membership_id'])) {
3335       //so far $params['membership_id'] should only be set coming in from membershipBAO::create so the situation where multiple memberships
3336       // are created off one contribution should be handled elsewhere
3337       $entityId = $params['membership_id'];
3338       $entityTable = 'civicrm_membership';
3339     }
3340     else {
3341       $entityId = $params['contribution']->id;
3342       $entityTable = 'civicrm_contribution';
3343     }
3344
3345     if (CRM_Utils_Array::value('contribution_mode', $params) == 'membership') {
3346       $isRelatedId = TRUE;
3347     }
3348
3349     $entityID[] = $entityId;
3350     if (!empty($additionalParticipantId)) {
3351       $entityID += $additionalParticipantId;
3352     }
3353     // prevContribution appears to mean - original contribution object- ie copy of contribution from before the update started that is being updated
3354     if (empty($params['prevContribution'])) {
3355       $entityID = NULL;
3356     }
3357     else {
3358       $update = TRUE;
3359     }
3360
3361     $statusId = $params['contribution']->contribution_status_id;
3362     // CRM-13964 partial payment
3363     if ($contributionStatus == 'Partially paid'
3364       && !empty($params['partial_payment_total']) && !empty($params['partial_amount_to_pay'])
3365     ) {
3366       $partialAmtPay = CRM_Utils_Rule::cleanMoney($params['partial_amount_to_pay']);
3367       $partialAmtTotal = CRM_Utils_Rule::cleanMoney($params['partial_payment_total']);
3368
3369       $fromFinancialAccountId = CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], 'Accounts Receivable Account is');
3370       $statusId = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
3371       $params['total_amount'] = $partialAmtPay;
3372
3373       $balanceTrxnInfo = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($params['contribution']->id, $params['financial_type_id']);
3374       if (empty($balanceTrxnInfo['trxn_id'])) {
3375         // create new balance transaction record
3376         $toFinancialAccount = CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], 'Accounts Receivable Account is');
3377
3378         $balanceTrxnParams['total_amount'] = $partialAmtTotal;
3379         $balanceTrxnParams['to_financial_account_id'] = $toFinancialAccount;
3380         $balanceTrxnParams['contribution_id'] = $params['contribution']->id;
3381         $balanceTrxnParams['trxn_date'] = !empty($params['contribution']->receive_date) ? $params['contribution']->receive_date : date('YmdHis');
3382         $balanceTrxnParams['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
3383         $balanceTrxnParams['net_amount'] = CRM_Utils_Array::value('net_amount', $params);
3384         $balanceTrxnParams['currency'] = $params['contribution']->currency;
3385         $balanceTrxnParams['trxn_id'] = $params['contribution']->trxn_id;
3386         $balanceTrxnParams['status_id'] = $statusId;
3387         $balanceTrxnParams['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
3388         $balanceTrxnParams['check_number'] = CRM_Utils_Array::value('check_number', $params);
3389         $balanceTrxnParams['pan_truncation'] = CRM_Utils_Array::value('pan_truncation', $params);
3390         $balanceTrxnParams['card_type_id'] = CRM_Utils_Array::value('card_type_id', $params);
3391         if (!empty($balanceTrxnParams['from_financial_account_id']) &&
3392           ($statusId == array_search('Completed', $contributionStatuses) || $statusId == array_search('Partially paid', $contributionStatuses))
3393         ) {
3394           $balanceTrxnParams['is_payment'] = 1;
3395         }
3396         if (!empty($params['payment_processor'])) {
3397           $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
3398         }
3399         $financialTxn = CRM_Core_BAO_FinancialTrxn::create($balanceTrxnParams);
3400       }
3401     }
3402
3403     // build line item array if its not set in $params
3404     if (empty($params['line_item']) || $additionalParticipantId) {
3405       CRM_Price_BAO_LineItem::getLineItemArray($params, $entityID, str_replace('civicrm_', '', $entityTable), $isRelatedId);
3406     }
3407
3408     if ($contributionStatus != 'Failed' &&
3409       !($contributionStatus == 'Pending' && !$params['contribution']->is_pay_later)
3410     ) {
3411       $skipRecords = TRUE;
3412       $pendingStatus = [
3413         'Pending',
3414         'In Progress',
3415       ];
3416       if (in_array($contributionStatus, $pendingStatus)) {
3417         $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship(
3418           $params['financial_type_id'],
3419           'Accounts Receivable Account is'
3420         );
3421       }
3422       elseif (!empty($params['payment_processor'])) {
3423         $params['to_financial_account_id'] = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($params['payment_processor'], NULL, 'civicrm_payment_processor');
3424         $params['payment_instrument_id'] = civicrm_api3('PaymentProcessor', 'getvalue', [
3425           'id' => $params['payment_processor'],
3426           'return' => 'payment_instrument_id',
3427         ]);
3428       }
3429       elseif (!empty($params['payment_instrument_id'])) {
3430         $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($params['payment_instrument_id']);
3431       }
3432       else {
3433         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
3434         $queryParams = [1 => [$relationTypeId, 'Integer']];
3435         $params['to_financial_account_id'] = CRM_Core_DAO::singleValueQuery("SELECT id FROM civicrm_financial_account WHERE is_default = 1 AND financial_account_type_id = %1", $queryParams);
3436       }
3437
3438       $totalAmount = CRM_Utils_Array::value('total_amount', $params);
3439       if (!isset($totalAmount) && !empty($params['prevContribution'])) {
3440         $totalAmount = $params['total_amount'] = $params['prevContribution']->total_amount;
3441       }
3442       //build financial transaction params
3443       $trxnParams = [
3444         'contribution_id' => $params['contribution']->id,
3445         'to_financial_account_id' => $params['to_financial_account_id'],
3446         'trxn_date' => !empty($params['contribution']->receive_date) ? $params['contribution']->receive_date : date('YmdHis'),
3447         'total_amount' => $totalAmount,
3448         'fee_amount' => CRM_Utils_Array::value('fee_amount', $params),
3449         'net_amount' => CRM_Utils_Array::value('net_amount', $params, $totalAmount),
3450         'currency' => $params['contribution']->currency,
3451         'trxn_id' => $params['contribution']->trxn_id,
3452         // @todo - this is getting the status id from the contribution - that is BAD - ie the contribution could be partially
3453         // paid but each payment is completed. The work around is to pass in the status_id in the trxn_params but
3454         // this should really default to completed (after discussion).
3455         'status_id' => $statusId,
3456         'payment_instrument_id' => CRM_Utils_Array::value('payment_instrument_id', $params, $params['contribution']->payment_instrument_id),
3457         'check_number' => CRM_Utils_Array::value('check_number', $params),
3458         'pan_truncation' => CRM_Utils_Array::value('pan_truncation', $params),
3459         'card_type_id' => CRM_Utils_Array::value('card_type_id', $params),
3460       ];
3461       if ($contributionStatus == 'Refunded' || $contributionStatus == 'Chargeback' || $contributionStatus == 'Cancelled') {
3462         $trxnParams['trxn_date'] = !empty($params['contribution']->cancel_date) ? $params['contribution']->cancel_date : date('YmdHis');
3463         if (isset($params['refund_trxn_id'])) {
3464           // CRM-17751 allow a separate trxn_id for the refund to be passed in via api & form.
3465           $trxnParams['trxn_id'] = $params['refund_trxn_id'];
3466         }
3467       }
3468       //CRM-16259, set is_payment flag for non pending status
3469       if (!in_array($contributionStatus, $pendingStatus)) {
3470         $trxnParams['is_payment'] = 1;
3471       }
3472       if (!empty($params['payment_processor'])) {
3473         $trxnParams['payment_processor_id'] = $params['payment_processor'];
3474       }
3475
3476       if (isset($fromFinancialAccountId)) {
3477         $trxnParams['from_financial_account_id'] = $fromFinancialAccountId;
3478       }
3479
3480       // consider external values passed for recording transaction entry
3481       if (!empty($financialTrxnValues)) {
3482         $trxnParams = array_merge($trxnParams, $financialTrxnValues);
3483       }
3484       if (empty($trxnParams['payment_processor_id'])) {
3485         unset($trxnParams['payment_processor_id']);
3486       }
3487
3488       $params['trxnParams'] = $trxnParams;
3489
3490       if (!empty($params['prevContribution'])) {
3491         $updated = FALSE;
3492         $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $params['prevContribution']->total_amount;
3493         $params['trxnParams']['fee_amount'] = $params['prevContribution']->fee_amount;
3494         $params['trxnParams']['net_amount'] = $params['prevContribution']->net_amount;
3495         if (!isset($params['trxnParams']['trxn_id'])) {
3496           // Actually I have no idea why we are overwriting any values from the previous contribution.
3497           // (filling makes sense to me). However, only protecting this value as I really really know we
3498           // don't want this one overwritten.
3499           // CRM-17751.
3500           $params['trxnParams']['trxn_id'] = $params['prevContribution']->trxn_id;
3501         }
3502         $params['trxnParams']['status_id'] = $params['prevContribution']->contribution_status_id;
3503
3504         if (!(($params['prevContribution']->contribution_status_id == array_search('Pending', $contributionStatuses)
3505             || $params['prevContribution']->contribution_status_id == array_search('In Progress', $contributionStatuses))
3506           && $params['contribution']->contribution_status_id == array_search('Completed', $contributionStatuses))
3507         ) {
3508           $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id;
3509           $params['trxnParams']['check_number'] = $params['prevContribution']->check_number;
3510         }
3511
3512         //if financial type is changed
3513         if (!empty($params['financial_type_id']) &&
3514           $params['contribution']->financial_type_id != $params['prevContribution']->financial_type_id
3515         ) {
3516           $accountRelationship = 'Income Account is';
3517           if (!empty($params['revenue_recognition_date']) || $params['prevContribution']->revenue_recognition_date) {
3518             $accountRelationship = 'Deferred Revenue Account is';
3519           }
3520           $oldFinancialAccount = CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship($params['prevContribution']->financial_type_id, $accountRelationship);
3521           $newFinancialAccount = CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship($params['financial_type_id'], $accountRelationship);
3522           if ($oldFinancialAccount != $newFinancialAccount) {
3523             $params['total_amount'] = 0;
3524             if (in_array($params['contribution']->contribution_status_id, $pendingStatus)) {
3525               $params['trxnParams']['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship(
3526                 $params['prevContribution']->financial_type_id, $accountRelationship);
3527             }
3528             else {
3529               $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['prevContribution']->id, 'DESC');
3530               if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
3531                 $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
3532               }
3533             }
3534             self::updateFinancialAccounts($params, 'changeFinancialType');
3535             /* $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id']; */
3536             $params['financial_account_id'] = $newFinancialAccount;
3537             $params['total_amount'] = $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = $trxnParams['total_amount'];
3538             self::updateFinancialAccounts($params);
3539             $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id'];
3540             $updated = TRUE;
3541             $params['deferred_financial_account_id'] = $newFinancialAccount;
3542           }
3543         }
3544
3545         //Update contribution status
3546         $params['trxnParams']['status_id'] = $params['contribution']->contribution_status_id;
3547         if (!isset($params['refund_trxn_id'])) {
3548           // CRM-17751 This has previously been deliberately set. No explanation as to why one variant
3549           // gets preference over another so I am only 'protecting' a very specific tested flow
3550           // and letting natural justice take care of the rest.
3551           $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id;
3552         }
3553         if (!empty($params['contribution_status_id']) &&
3554           $params['prevContribution']->contribution_status_id != $params['contribution']->contribution_status_id
3555         ) {
3556           //Update Financial Records
3557           self::updateFinancialAccounts($params, 'changedStatus');
3558           $updated = TRUE;
3559         }
3560
3561         // change Payment Instrument for a Completed contribution
3562         // first handle special case when contribution is changed from Pending to Completed status when initial payment
3563         // instrument is null and now new payment instrument is added along with the payment
3564         if (!$params['contribution']->payment_instrument_id) {
3565           $params['contribution']->find(TRUE);
3566         }
3567         $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
3568         $params['trxnParams']['check_number'] = CRM_Utils_Array::value('check_number', $params);
3569
3570         if (self::isPaymentInstrumentChange($params, $pendingStatus)) {
3571           $updated = CRM_Core_BAO_FinancialTrxn::updateFinancialAccountsOnPaymentInstrumentChange($params);
3572         }
3573
3574         //if Change contribution amount
3575         $params['trxnParams']['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
3576         $params['trxnParams']['net_amount'] = CRM_Utils_Array::value('net_amount', $params);
3577         $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $totalAmount;
3578         $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id;
3579         if (isset($totalAmount) &&
3580           $totalAmount != $params['prevContribution']->total_amount
3581         ) {
3582           //Update Financial Records
3583           $params['trxnParams']['from_financial_account_id'] = NULL;
3584           self::updateFinancialAccounts($params, 'changedAmount');
3585           $updated = TRUE;
3586         }
3587
3588         if (!$updated) {
3589           // Looks like we might have a data correction update.
3590           // This would be a case where a transaction id has been entered but it is incorrect &
3591           // the person goes back in & fixes it, as opposed to a new transaction.
3592           // Currently the UI doesn't support multiple refunds against a single transaction & we are only supporting
3593           // the data fix scenario.
3594           // CRM-17751.
3595           if (isset($params['refund_trxn_id'])) {
3596             $refundIDs = CRM_Core_BAO_FinancialTrxn::getRefundTransactionIDs($params['id']);
3597             if (!empty($refundIDs['financialTrxnId']) && $refundIDs['trxn_id'] != $params['refund_trxn_id']) {
3598               civicrm_api3('FinancialTrxn', 'create', [
3599                 'id' => $refundIDs['financialTrxnId'],
3600                 'trxn_id' => $params['refund_trxn_id'],
3601               ]);
3602             }
3603           }
3604           $cardType = CRM_Utils_Array::value('card_type_id', $params);
3605           $panTruncation = CRM_Utils_Array::value('pan_truncation', $params);
3606           CRM_Core_BAO_FinancialTrxn::updateCreditCardDetails($params['contribution']->id, $panTruncation, $cardType);
3607         }
3608       }
3609
3610       if (!$update) {
3611         // records finanical trxn and entity financial trxn
3612         // also make it available as return value
3613         self::recordAlwaysAccountsReceivable($trxnParams, $params);
3614         $trxnParams['pan_truncation'] = CRM_Utils_Array::value('pan_truncation', $params);
3615         $trxnParams['card_type_id'] = CRM_Utils_Array::value('card_type_id', $params);
3616         $return = $financialTxn = CRM_Core_BAO_FinancialTrxn::create($trxnParams);
3617         $params['entity_id'] = $financialTxn->id;
3618         if (empty($params['partial_payment_total']) && empty($params['partial_amount_to_pay'])) {
3619           self::$_trxnIDs[] = $financialTxn->id;
3620         }
3621       }
3622     }
3623     // record line items and financial items
3624     if (empty($params['skipLineItem'])) {
3625       CRM_Price_BAO_LineItem::processPriceSet($entityId, CRM_Utils_Array::value('line_item', $params), $params['contribution'], $entityTable, $update);
3626     }
3627
3628     // create batch entry if batch_id is passed and
3629     // ensure no batch entry is been made on 'Pending' or 'Failed' contribution, CRM-16611
3630     if (!empty($params['batch_id']) && !empty($financialTxn)) {
3631       $entityParams = [
3632         'batch_id' => $params['batch_id'],
3633         'entity_table' => 'civicrm_financial_trxn',
3634         'entity_id' => $financialTxn->id,
3635       ];
3636       CRM_Batch_BAO_EntityBatch::create($entityParams);
3637     }
3638
3639     // when a fee is charged
3640     if (!empty($params['fee_amount']) && (empty($params['prevContribution']) || $params['contribution']->fee_amount != $params['prevContribution']->fee_amount) && $skipRecords) {
3641       CRM_Core_BAO_FinancialTrxn::recordFees($params);
3642     }
3643
3644     if (!empty($params['prevContribution']) && $entityTable == 'civicrm_participant'
3645       && $params['prevContribution']->contribution_status_id != $params['contribution']->contribution_status_id
3646     ) {
3647       $eventID = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $entityId, 'event_id');
3648       $feeLevel[] = str_replace('\ 1', '', $params['prevContribution']->amount_level);
3649       CRM_Event_BAO_Participant::createDiscountTrxn($eventID, $params, $feeLevel);
3650     }
3651     unset($params['line_item']);
3652     self::$_trxnIDs = NULL;
3653     return $return;
3654   }
3655
3656   /**
3657    * Update all financial accounts entry.
3658    *
3659    * @param array $params
3660    *   Contribution object, line item array and params for trxn.
3661    *
3662    * @param string $context
3663    *   Update scenarios.
3664    *
3665    * @todo stop passing $params by reference. It is unclear the purpose of doing this &
3666    * adds unpredictability.
3667    *
3668    */
3669   public static function updateFinancialAccounts(&$params, $context = NULL) {
3670     $trxnID = NULL;
3671     $inputParams = $params;
3672     $isARefund = FALSE;
3673     $currentContributionStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id);
3674     $previousContributionStatus = CRM_Contribute_PseudoConstant::contributionStatus($params['prevContribution']->contribution_status_id, 'name');
3675
3676     if ($context == 'changedStatus') {
3677       list($continue, $isARefund) = self::updateFinancialAccountsOnContributionStatusChange($params, $context, $previousContributionStatus, $currentContributionStatus);
3678       // @todo - it may be that this is always false & the parent function is just a confusing wrapper for the child fn.
3679       if (!$continue) {
3680         return;
3681       }
3682     }
3683
3684     if ($context == 'changedAmount' || $context == 'changeFinancialType') {
3685       // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3686       $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = ($params['total_amount'] - $params['prevContribution']->total_amount);
3687     }
3688
3689     $trxn = CRM_Core_BAO_FinancialTrxn::create($params['trxnParams']);
3690     // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3691     $params['entity_id'] = $trxn->id;
3692
3693     $itemParams['entity_table'] = 'civicrm_line_item';
3694     $trxnIds['id'] = $params['entity_id'];
3695     $previousLineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($params['contribution']->id);
3696     foreach ($params['line_item'] as $fieldId => $fields) {
3697       foreach ($fields as $fieldValueId => $lineItemDetails) {
3698         $prevFinancialItem = CRM_Financial_BAO_FinancialItem::getPreviousFinancialItem($lineItemDetails['id']);
3699         $receiveDate = CRM_Utils_Date::isoToMysql($params['prevContribution']->receive_date);
3700         if ($params['contribution']->receive_date) {
3701           $receiveDate = CRM_Utils_Date::isoToMysql($params['contribution']->receive_date);
3702         }
3703
3704         $financialAccount = self::getFinancialAccountForStatusChangeTrxn($params, CRM_Utils_Array::value('financial_account_id', $prevFinancialItem));
3705
3706         $currency = $params['prevContribution']->currency;
3707         // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3708         if ($params['contribution']->currency) {
3709           $currency = $params['contribution']->currency;
3710         }
3711         $previousLineItemTotal = CRM_Utils_Array::value('line_total', CRM_Utils_Array::value($fieldValueId, $previousLineItems), 0);
3712         $itemParams = [
3713           'transaction_date' => $receiveDate,
3714           'contact_id' => $params['prevContribution']->contact_id,
3715           'currency' => $currency,
3716           'amount' => self::getFinancialItemAmountFromParams($inputParams, $context, $lineItemDetails, $isARefund, $previousLineItemTotal),
3717           'description' => CRM_Utils_Array::value('description', $prevFinancialItem),
3718           'status_id' => $prevFinancialItem['status_id'],
3719           'financial_account_id' => $financialAccount,
3720           'entity_table' => 'civicrm_line_item',
3721           'entity_id' => $lineItemDetails['id'],
3722         ];
3723         $financialItem = CRM_Financial_BAO_FinancialItem::create($itemParams, NULL, $trxnIds);
3724         // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3725         $params['line_item'][$fieldId][$fieldValueId]['deferred_line_total'] = $itemParams['amount'];
3726         $params['line_item'][$fieldId][$fieldValueId]['financial_item_id'] = $financialItem->id;
3727
3728         if (($lineItemDetails['tax_amount'] && $lineItemDetails['tax_amount'] !== 'null') || ($context == 'changeFinancialType')) {
3729           $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
3730           $taxTerm = CRM_Utils_Array::value('tax_term', $invoiceSettings);
3731           $taxAmount = (float) $lineItemDetails['tax_amount'];
3732           if ($context == 'changeFinancialType' && $lineItemDetails['tax_amount'] === 'null') {
3733             // reverse the Sale Tax amount if there is no tax rate associated with new Financial Type
3734             $taxAmount = CRM_Utils_Array::value('tax_amount', CRM_Utils_Array::value($fieldValueId, $previousLineItems), 0);
3735           }
3736           elseif ($previousLineItemTotal != $lineItemDetails['line_total']) {
3737             $taxAmount -= CRM_Utils_Array::value('tax_amount', CRM_Utils_Array::value($fieldValueId, $previousLineItems), 0);
3738           }
3739           if ($taxAmount != 0) {
3740             $itemParams['amount'] = self::getMultiplier($params['contribution']->contribution_status_id, $context) * $taxAmount;
3741             $itemParams['description'] = $taxTerm;
3742             if ($lineItemDetails['financial_type_id']) {
3743               $itemParams['financial_account_id'] = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount(
3744                 $lineItemDetails['financial_type_id'],
3745                 'Sales Tax Account is'
3746               );
3747             }
3748             CRM_Financial_BAO_FinancialItem::create($itemParams, NULL, $trxnIds);
3749           }
3750         }
3751       }
3752     }
3753
3754     if ($context == 'changeFinancialType') {
3755       // @todo we should stop passing $params by reference - splitting this out would be a step towards that.
3756       $params['skipLineItem'] = FALSE;
3757       foreach ($params['line_item'] as &$lineItems) {
3758         foreach ($lineItems as &$line) {
3759           $line['financial_type_id'] = $params['financial_type_id'];
3760         }
3761       }
3762     }
3763
3764     CRM_Core_BAO_FinancialTrxn::createDeferredTrxn(CRM_Utils_Array::value('line_item', $params), $params['contribution'], TRUE, $context);
3765   }
3766
3767   /**
3768    * Is this contribution status a reversal.
3769    *
3770    * If so we would expect to record a negative value in the financial_trxn table.
3771    *
3772    * @param int $status_id
3773    *
3774    * @return bool
3775    */
3776   public static function isContributionStatusNegative($status_id) {
3777     $reversalStatuses = ['Cancelled', 'Chargeback', 'Refunded'];
3778     return in_array(CRM_Contribute_PseudoConstant::contributionStatus($status_id, 'name'), $reversalStatuses);
3779   }
3780
3781   /**
3782    * Check status validation on update of a contribution.
3783    *
3784    * @param array $values
3785    *   Previous form values before submit.
3786    *
3787    * @param array $fields
3788    *   The input form values.
3789    *
3790    * @param array $errors
3791    *   List of errors.
3792    *
3793    * @return bool
3794    */
3795   public static function checkStatusValidation($values, &$fields, &$errors) {
3796     if (CRM_Utils_System::isNull($values) && !empty($fields['id'])) {
3797       $values['contribution_status_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $fields['id'], 'contribution_status_id');
3798       if ($values['contribution_status_id'] == $fields['contribution_status_id']) {
3799         return FALSE;
3800       }
3801     }
3802     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
3803     $checkStatus = [
3804       'Cancelled' => ['Completed', 'Refunded'],
3805       'Completed' => ['Cancelled', 'Refunded', 'Chargeback'],
3806       'Pending' => ['Cancelled', 'Completed', 'Failed', 'Partially paid'],
3807       'In Progress' => ['Cancelled', 'Completed', 'Failed'],
3808       'Refunded' => ['Cancelled', 'Completed'],
3809       'Partially paid' => ['Completed'],
3810       'Pending refund' => ['Completed', 'Refunded'],
3811     ];
3812
3813     if (!in_array($contributionStatuses[$fields['contribution_status_id']],
3814       CRM_Utils_Array::value($contributionStatuses[$values['contribution_status_id']], $checkStatus, []))
3815     ) {
3816       $errors['contribution_status_id'] = ts("Cannot change contribution status from %1 to %2.", [
3817         1 => $contributionStatuses[$values['contribution_status_id']],
3818         2 => $contributionStatuses[$fields['contribution_status_id']],
3819       ]);
3820     }
3821   }
3822
3823   /**
3824    * Delete contribution of contact.
3825    *
3826    * CRM-12155
3827    *
3828    * @param int $contactId
3829    *   Contact id.
3830    *
3831    */
3832   public static function deleteContactContribution($contactId) {
3833     $contribution = new CRM_Contribute_DAO_Contribution();
3834     $contribution->contact_id = $contactId;
3835     $contribution->find();
3836     while ($contribution->fetch()) {
3837       self::deleteContribution($contribution->id);
3838     }
3839   }
3840
3841   /**
3842    * Get options for a given contribution field.
3843    *
3844    * @param string $fieldName
3845    * @param string $context see CRM_Core_DAO::buildOptionsContext.
3846    * @param array $props whatever is known about this dao object.
3847    *
3848    * @return array|bool
3849    * @see CRM_Core_DAO::buildOptions
3850    *
3851    */
3852   public static function buildOptions($fieldName, $context = NULL, $props = []) {
3853     $className = __CLASS__;
3854     $params = [];
3855     if (isset($props['orderColumn'])) {
3856       $params['orderColumn'] = $props['orderColumn'];
3857     }
3858     switch ($fieldName) {
3859       // This field is not part of this object but the api supports it
3860       case 'payment_processor':
3861         $className = 'CRM_Contribute_BAO_ContributionPage';
3862         // Filter results by contribution page
3863         if (!empty($props['contribution_page_id'])) {
3864           $page = civicrm_api('contribution_page', 'getsingle', [
3865             'version' => 3,
3866             'id' => ($props['contribution_page_id']),
3867           ]);
3868           $types = (array) CRM_Utils_Array::value('payment_processor', $page, 0);
3869           $params['condition'] = 'id IN (' . implode(',', $types) . ')';
3870         }
3871         break;
3872
3873       // CRM-13981 This field was combined with soft_credits in 4.5 but the api still supports it
3874       case 'honor_type_id':
3875         $className = 'CRM_Contribute_BAO_ContributionSoft';
3876         $fieldName = 'soft_credit_type_id';
3877         $params['condition'] = "v.name IN ('in_honor_of','in_memory_of')";
3878         break;
3879     }
3880     return CRM_Core_PseudoConstant::get($className, $fieldName, $params, $context);
3881   }
3882
3883   /**
3884    * Validate financial type.
3885    *
3886    * CRM-13231
3887    *
3888    * @param int $financialTypeId
3889    *   Financial Type id.
3890    *
3891    * @param string $relationName
3892    *
3893    * @return array|bool
3894    */
3895   public static function validateFinancialType($financialTypeId, $relationName = 'Expense Account is') {
3896     $financialAccount = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($financialTypeId, $relationName);
3897
3898     if (!$financialAccount) {
3899       return CRM_Contribute_PseudoConstant::financialType($financialTypeId);
3900     }
3901     return FALSE;
3902   }
3903
3904   /**
3905    * Function to record additional payment for partial and refund contributions.
3906    *
3907    * @param int $contributionId
3908    *   is the invoice contribution id (got created after processing participant payment).
3909    * @param array $trxnsData
3910    *   to take user provided input of transaction details.
3911    * @param string $paymentType
3912    *   'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments.
3913    * @param int $participantId
3914    * @param bool $updateStatus
3915    *
3916    * @return int
3917    *
3918    * @throws \CRM_Core_Exception
3919    * @throws \CiviCRM_API3_Exception
3920    */
3921   public static function recordAdditionalPayment($contributionId, $trxnsData, $paymentType = 'owed', $participantId = NULL, $updateStatus = TRUE) {
3922
3923     if ($paymentType == 'owed') {
3924       $financialTrxn = CRM_Financial_BAO_Payment::recordPayment($contributionId, $trxnsData, $participantId);
3925       if (!empty($financialTrxn)) {
3926         self::recordPaymentActivity($contributionId, $participantId, $financialTrxn->total_amount, $financialTrxn->currency, $financialTrxn->trxn_date);
3927         return $financialTrxn->id;
3928       }
3929     }
3930     elseif ($paymentType == 'refund') {
3931       $trxnsData['total_amount'] = -$trxnsData['total_amount'];
3932       $trxnsData['participant_id'] = $participantId;
3933       $trxnsData['contribution_id'] = $contributionId;
3934       return civicrm_api3('Payment', 'create', $trxnsData)['id'];
3935     }
3936   }
3937
3938   /**
3939    * @param int $targetCid
3940    * @param $activityType
3941    * @param string $title
3942    * @param int $contributionId
3943    * @param string $totalAmount
3944    * @param string $currency
3945    * @param string $trxn_date
3946    *
3947    * @throws \CRM_Core_Exception
3948    * @throws \CiviCRM_API3_Exception
3949    */
3950   public static function addActivityForPayment($targetCid, $activityType, $title, $contributionId, $totalAmount, $currency, $trxn_date) {
3951     $paymentAmount = CRM_Utils_Money::format($totalAmount, $currency);
3952     $subject = "{$paymentAmount} - Offline {$activityType} for {$title}";
3953     $date = CRM_Utils_Date::isoToMysql($trxn_date);
3954     // source record id would be the contribution id
3955     $srcRecId = $contributionId;
3956
3957     // activity params
3958     $activityParams = [
3959       'source_contact_id' => $targetCid,
3960       'source_record_id' => $srcRecId,
3961       'activity_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', $activityType),
3962       'subject' => $subject,
3963       'activity_date_time' => $date,
3964       'status_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
3965       'skipRecentView' => TRUE,
3966     ];
3967
3968     // create activity with target contacts
3969     $session = CRM_Core_Session::singleton();
3970     $id = $session->get('userID');
3971     if ($id) {
3972       $activityParams['source_contact_id'] = $id;
3973       $activityParams['target_contact_id'][] = $targetCid;
3974     }
3975     civicrm_api3('Activity', 'create', $activityParams);
3976   }
3977
3978   /**
3979    * Get list of payments displayed by Contribute_Page_PaymentInfo.
3980    *
3981    * @param int $id
3982    * @param $component
3983    * @param bool $getTrxnInfo
3984    * @param bool $usingLineTotal
3985    *
3986    * @return mixed
3987    */
3988   public static function getPaymentInfo($id, $component = 'contribution', $getTrxnInfo = FALSE, $usingLineTotal = FALSE) {
3989     // @todo deprecate passing in component - always call with contribution.
3990     if ($component == 'event') {
3991       $contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'contribution_id', 'participant_id');
3992
3993       if (!$contributionId) {
3994         if ($primaryParticipantId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Participant', $id, 'registered_by_id')) {
3995           $contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $primaryParticipantId, 'contribution_id', 'participant_id');
3996           $id = $primaryParticipantId;
3997         }
3998         if (!$contributionId) {
3999           return;
4000         }
4001       }
4002     }
4003     elseif ($component == 'membership') {
4004       $contributionId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipPayment', $id, 'contribution_id', 'membership_id');
4005     }
4006     else {
4007       $contributionId = $id;
4008     }
4009
4010     $total = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($contributionId);
4011     $baseTrxnId = !empty($total['trxn_id']) ? $total['trxn_id'] : NULL;
4012     if (!$baseTrxnId) {
4013       $baseTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($contributionId);
4014       $baseTrxnId = $baseTrxnId['financialTrxnId'];
4015     }
4016     if (!CRM_Utils_Array::value('total_amount', $total) || $usingLineTotal) {
4017       $total = CRM_Price_BAO_LineItem::getLineTotal($contributionId);
4018     }
4019     else {
4020       $baseTrxnId = $total['trxn_id'];
4021       $total = $total['total_amount'];
4022     }
4023
4024     $paymentBalance = CRM_Contribute_BAO_Contribution::getContributionBalance($contributionId, $total);
4025
4026     $contribution = civicrm_api3('Contribution', 'getsingle', [
4027       'id' => $contributionId,
4028       'return' => [
4029         'currency',
4030         'is_pay_later',
4031         'contribution_status_id',
4032         'financial_type_id',
4033       ],
4034     ]);
4035
4036     $info['payLater'] = $contribution['is_pay_later'];
4037     $info['contribution_status'] = $contribution['contribution_status'];
4038     $info['currency'] = $contribution['currency'];
4039
4040     $financialTypeId = $contribution['financial_type_id'];
4041     $feeFinancialAccount = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($financialTypeId, 'Expense Account is');
4042
4043     if ($paymentBalance == 0 && $info['payLater']) {
4044       // @todo - review - this looks very unlikely to be correct.
4045       // the balance should be correct based on payment transactions not
4046       // assumptions.
4047       $paymentBalance = $total;
4048     }
4049
4050     $info['total'] = $total;
4051     $info['paid'] = $total - $paymentBalance;
4052     $info['balance'] = $paymentBalance;
4053     $info['id'] = $id;
4054     $info['component'] = $component;
4055     $rows = [];
4056     if ($getTrxnInfo && $baseTrxnId) {
4057       // Need to exclude fee trxn rows so filter out rows where TO FINANCIAL ACCOUNT is expense account
4058       $sql = "
4059         SELECT GROUP_CONCAT(fa.`name`) as financial_account,
4060           ft.total_amount,
4061           ft.payment_instrument_id,
4062           ft.trxn_date, ft.trxn_id, ft.status_id, ft.check_number, ft.currency, ft.pan_truncation, ft.card_type_id, ft.id
4063
4064         FROM civicrm_contribution con
4065           LEFT JOIN civicrm_entity_financial_trxn eft ON (eft.entity_id = con.id AND eft.entity_table = 'civicrm_contribution')
4066           INNER JOIN civicrm_financial_trxn ft ON ft.id = eft.financial_trxn_id
4067             AND ft.to_financial_account_id != %2
4068           LEFT JOIN civicrm_entity_financial_trxn ef ON (ef.financial_trxn_id = ft.id AND ef.entity_table = 'civicrm_financial_item')
4069           LEFT JOIN civicrm_financial_item fi ON fi.id = ef.entity_id
4070           LEFT JOIN civicrm_financial_account fa ON fa.id = fi.financial_account_id
4071
4072         WHERE con.id = %1 AND ft.is_payment = 1
4073         GROUP BY ft.id";
4074       $queryParams = [
4075         1 => [$contributionId, 'Integer'],
4076         2 => [$feeFinancialAccount, 'Integer'],
4077       ];
4078       $resultDAO = CRM_Core_DAO::executeQuery($sql, $queryParams);
4079       $statuses = CRM_Contribute_PseudoConstant::contributionStatus();
4080
4081       while ($resultDAO->fetch()) {
4082         $paidByLabel = CRM_Core_PseudoConstant::getLabel('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id);
4083         $paidByName = CRM_Core_PseudoConstant::getName('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id);
4084         if ($resultDAO->card_type_id) {
4085           $creditCardType = CRM_Core_PseudoConstant::getLabel('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $resultDAO->card_type_id);
4086           $pantruncation = '';
4087           if ($resultDAO->pan_truncation) {
4088             $pantruncation = ": {$resultDAO->pan_truncation}";
4089           }
4090           $paidByLabel .= " ({$creditCardType}{$pantruncation})";
4091         }
4092
4093         // show payment edit link only for payments done via backoffice form
4094         $paymentEditLink = '';
4095         if (empty($resultDAO->payment_processor_id) && CRM_Core_Permission::check('edit contributions')) {
4096           $links = [
4097             CRM_Core_Action::UPDATE => [
4098               'name' => "<i class='crm-i fa-pencil'></i>",
4099               'url' => 'civicrm/payment/edit',
4100               'class' => 'medium-popup',
4101               'qs' => "reset=1&id=%%id%%&contribution_id=%%contribution_id%%",
4102               'title' => ts('Edit Payment'),
4103             ],
4104           ];
4105           $paymentEditLink = CRM_Core_Action::formLink(
4106             $links,
4107             CRM_Core_Action::mask([CRM_Core_Permission::EDIT]),
4108             [
4109               'id' => $resultDAO->id,
4110               'contribution_id' => $contributionId,
4111             ]
4112           );
4113         }
4114
4115         $val = [
4116           'id' => $resultDAO->id,
4117           'total_amount' => $resultDAO->total_amount,
4118           'financial_type' => $resultDAO->financial_account,
4119           'payment_instrument' => $paidByLabel,
4120           'receive_date' => $resultDAO->trxn_date,
4121           'trxn_id' => $resultDAO->trxn_id,
4122           'status' => $statuses[$resultDAO->status_id],
4123           'currency' => $resultDAO->currency,
4124           'action' => $paymentEditLink,
4125         ];
4126         if ($paidByName == 'Check') {
4127           $val['check_number'] = $resultDAO->check_number;
4128         }
4129         $rows[] = $val;
4130       }
4131       $info['transaction'] = $rows;
4132     }
4133
4134     $info['payment_links'] = self::getContributionPaymentLinks($id, $paymentBalance, $info['contribution_status']);
4135     return $info;
4136   }
4137
4138   /**
4139    * Get the outstanding balance on a contribution.
4140    *
4141    * @param int $contributionId
4142    * @param float $contributionTotal
4143    *   Optional amount to override the saved amount paid (e.g if calculating what it WILL be).
4144    *
4145    * @return float
4146    */
4147   public static function getContributionBalance($contributionId, $contributionTotal = NULL) {
4148     if ($contributionTotal === NULL) {
4149       $contributionTotal = CRM_Price_BAO_LineItem::getLineTotal($contributionId);
4150     }
4151
4152     return CRM_Utils_Money::subtractCurrencies(
4153       $contributionTotal,
4154       CRM_Core_BAO_FinancialTrxn::getTotalPayments($contributionId, TRUE) ?: 0,
4155       CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'currency')
4156     );
4157   }
4158
4159   /**
4160    * Get the tax amount (misnamed function).
4161    *
4162    * @param array $params
4163    * @param bool $isLineItem
4164    *
4165    * @return array
4166    */
4167   public static function checkTaxAmount($params, $isLineItem = FALSE) {
4168     $taxRates = CRM_Core_PseudoConstant::getTaxRates();
4169
4170     // This function should be only called after standardisation (removal of
4171     // thousand separator & using a decimal point for cents separator.
4172     // However, we don't know if that is always true :-(
4173     // There is a deprecation notice tho :-)
4174     $unknownIfMoneyIsClean = empty($params['skipCleanMoney']) && !$isLineItem;
4175     // Update contribution.
4176     if (!empty($params['id'])) {
4177       // CRM-19126 and CRM-19152 If neither total or financial_type_id are set on an update
4178       // there are no tax implications - early return.
4179       if (!isset($params['total_amount']) && !isset($params['financial_type_id'])) {
4180         return $params;
4181       }
4182       if (empty($params['prevContribution'])) {
4183         $params['prevContribution'] = self::getOriginalContribution($params['id']);
4184       }
4185
4186       foreach (['total_amount', 'financial_type_id', 'fee_amount'] as $field) {
4187         if (!isset($params[$field])) {
4188           if ($field == 'total_amount' && $params['prevContribution']->tax_amount) {
4189             // Tax amount gets added back on later....
4190             $params['total_amount'] = $params['prevContribution']->total_amount -
4191               $params['prevContribution']->tax_amount;
4192           }
4193           else {
4194             $params[$field] = $params['prevContribution']->$field;
4195             if ($params[$field] != $params['prevContribution']->$field) {
4196             }
4197           }
4198         }
4199       }
4200
4201       self::calculateMissingAmountParams($params, $params['id']);
4202       if (!array_key_exists($params['financial_type_id'], $taxRates)) {
4203         // Assign tax Amount on update of contribution
4204         if (!empty($params['prevContribution']->tax_amount)) {
4205           $params['tax_amount'] = 'null';
4206           CRM_Price_BAO_LineItem::getLineItemArray($params, [$params['id']]);
4207           foreach ($params['line_item'] as $setID => $priceField) {
4208             foreach ($priceField as $priceFieldID => $priceFieldValue) {
4209               $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4210             }
4211           }
4212         }
4213       }
4214     }
4215
4216     // New Contribution and update of contribution with tax rate financial type
4217     if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) &&
4218       empty($params['skipLineItem']) && !$isLineItem
4219     ) {
4220       $taxRateParams = $taxRates[$params['financial_type_id']];
4221       $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount(CRM_Utils_Array::value('total_amount', $params), $taxRateParams, $unknownIfMoneyIsClean);
4222       $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4223
4224       // Get Line Item on update of contribution
4225       if (isset($params['id'])) {
4226         CRM_Price_BAO_LineItem::getLineItemArray($params, [$params['id']]);
4227       }
4228       else {
4229         CRM_Price_BAO_LineItem::getLineItemArray($params);
4230       }
4231       foreach ($params['line_item'] as $setID => $priceField) {
4232         foreach ($priceField as $priceFieldID => $priceFieldValue) {
4233           $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4234         }
4235       }
4236       $params['total_amount'] = CRM_Utils_Array::value('total_amount', $params) + $params['tax_amount'];
4237     }
4238     elseif (isset($params['api.line_item.create'])) {
4239       // Update total amount of contribution using lineItem
4240       $taxAmountArray = [];
4241       foreach ($params['api.line_item.create'] as $key => $value) {
4242         if (isset($value['financial_type_id']) && array_key_exists($value['financial_type_id'], $taxRates)) {
4243           $taxRate = $taxRates[$value['financial_type_id']];
4244           $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount($value['line_total'], $taxRate);
4245           $taxAmountArray[] = round($taxAmount['tax_amount'], 2);
4246         }
4247       }
4248       $params['tax_amount'] = array_sum($taxAmountArray);
4249       $params['total_amount'] = $params['total_amount'] + $params['tax_amount'];
4250     }
4251     else {
4252       // update line item of contrbution
4253       if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) && $isLineItem) {
4254         $taxRate = $taxRates[$params['financial_type_id']];
4255         $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount($params['line_total'], $taxRate, $unknownIfMoneyIsClean);
4256         $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4257       }
4258     }
4259     return $params;
4260   }
4261
4262   /**
4263    * Check financial type validation on update of a contribution.
4264    *
4265    * @param int $financialTypeId
4266    *   Value of latest Financial Type.
4267    *
4268    * @param int $contributionId
4269    *   Contribution Id.
4270    *
4271    * @param array $errors
4272    *   List of errors.
4273    *
4274    * @return void
4275    */
4276   public static function checkFinancialTypeChange($financialTypeId, $contributionId, &$errors) {
4277     if (!empty($financialTypeId)) {
4278       $oldFinancialTypeId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id');
4279       if ($oldFinancialTypeId == $financialTypeId) {
4280         return;
4281       }
4282     }
4283     $sql = 'SELECT financial_type_id FROM civicrm_line_item WHERE contribution_id = %1 GROUP BY financial_type_id;';
4284     $params = [
4285       '1' => [$contributionId, 'Integer'],
4286     ];
4287     $result = CRM_Core_DAO::executeQuery($sql, $params);
4288     if ($result->N > 1) {
4289       $errors['financial_type_id'] = ts('One or more line items have a different financial type than the contribution. Editing the financial type is not yet supported in this situation.');
4290     }
4291   }
4292
4293   /**
4294    * Update related pledge payment payments.
4295    *
4296    * This function has been refactored out of the back office contribution form and may
4297    * still overlap with other functions.
4298    *
4299    * @param string $action
4300    * @param int $pledgePaymentID
4301    * @param int $contributionID
4302    * @param bool $adjustTotalAmount
4303    * @param float $total_amount
4304    * @param float $original_total_amount
4305    * @param int $contribution_status_id
4306    * @param int $original_contribution_status_id
4307    */
4308   public static function updateRelatedPledge(
4309     $action,
4310     $pledgePaymentID,
4311     $contributionID,
4312     $adjustTotalAmount,
4313     $total_amount,
4314     $original_total_amount,
4315     $contribution_status_id,
4316     $original_contribution_status_id
4317   ) {
4318     if (!$pledgePaymentID && $action & CRM_Core_Action::ADD && !$contributionID) {
4319       return;
4320     }
4321
4322     if ($pledgePaymentID) {
4323       //store contribution id in payment record.
4324       CRM_Core_DAO::setFieldValue('CRM_Pledge_DAO_PledgePayment', $pledgePaymentID, 'contribution_id', $contributionID);
4325     }
4326     else {
4327       $pledgePaymentID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4328         $contributionID,
4329         'id',
4330         'contribution_id'
4331       );
4332     }
4333
4334     if (!$pledgePaymentID) {
4335       return;
4336     }
4337     $pledgeID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4338       $contributionID,
4339       'pledge_id',
4340       'contribution_id'
4341     );
4342
4343     $updatePledgePaymentStatus = FALSE;
4344
4345     // If either the status or the amount has changed we update the pledge status.
4346     if ($action & CRM_Core_Action::ADD) {
4347       $updatePledgePaymentStatus = TRUE;
4348     }
4349     elseif ($action & CRM_Core_Action::UPDATE && (($original_contribution_status_id != $contribution_status_id) ||
4350         ($original_total_amount != $total_amount))
4351     ) {
4352       $updatePledgePaymentStatus = TRUE;
4353     }
4354
4355     if ($updatePledgePaymentStatus) {
4356       CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID,
4357         [$pledgePaymentID],
4358         $contribution_status_id,
4359         NULL,
4360         $total_amount,
4361         $adjustTotalAmount
4362       );
4363     }
4364   }
4365
4366   /**
4367    * Compute the stats values
4368    *
4369    * @param string $stat either 'mode' or 'median'
4370    * @param string $sql
4371    * @param string $alias of civicrm_contribution
4372    *
4373    * @return array|null
4374    * @deprecated
4375    *
4376    */
4377   public static function computeStats($stat, $sql, $alias = NULL) {
4378     CRM_Core_Error::deprecatedFunctionWarning('computeStats is now deprecated');
4379     return [];
4380   }
4381
4382   /**
4383    * Is there only one line item attached to the contribution.
4384    *
4385    * @param int $id
4386    *   Contribution ID.
4387    *
4388    * @return bool
4389    * @throws \CiviCRM_API3_Exception
4390    */
4391   public static function isSingleLineItem($id) {
4392     $lineItemCount = civicrm_api3('LineItem', 'getcount', ['contribution_id' => $id]);
4393     return ($lineItemCount == 1);
4394   }
4395
4396   /**
4397    * Complete an order.
4398    *
4399    * Do not call this directly - use the contribution.completetransaction api as this function is being refactored.
4400    *
4401    * Currently overloaded to complete a transaction & repeat a transaction - fix!
4402    *
4403    * Moving it out of the BaseIPN class is just the first step.
4404    *
4405    * @param array $input
4406    * @param array $ids
4407    * @param array $objects
4408    * @param CRM_Core_Transaction $transaction
4409    * @param int $recur
4410    * @param CRM_Contribute_BAO_Contribution $contribution
4411    *
4412    * @return array
4413    */
4414   public static function completeOrder(&$input, &$ids, $objects, $transaction, $recur, $contribution) {
4415     $primaryContributionID = isset($contribution->id) ? $contribution->id : $objects['first_contribution']->id;
4416     // The previous details are used when calculating line items so keep it before any code that 'does something'
4417     if (!empty($contribution->id)) {
4418       $input['prevContribution'] = CRM_Contribute_BAO_Contribution::getValues(['id' => $contribution->id]);
4419     }
4420     $inputContributionWhiteList = [
4421       'fee_amount',
4422       'net_amount',
4423       'trxn_id',
4424       'check_number',
4425       'payment_instrument_id',
4426       'is_test',
4427       'campaign_id',
4428       'receive_date',
4429       'receipt_date',
4430       'contribution_status_id',
4431       'card_type_id',
4432       'pan_truncation',
4433     ];
4434     if (self::isSingleLineItem($primaryContributionID)) {
4435       $inputContributionWhiteList[] = 'financial_type_id';
4436     }
4437
4438     $participant = CRM_Utils_Array::value('participant', $objects);
4439     $recurContrib = CRM_Utils_Array::value('contributionRecur', $objects);
4440     $recurringContributionID = (empty($recurContrib->id)) ? NULL : $recurContrib->id;
4441     $event = CRM_Utils_Array::value('event', $objects);
4442
4443     $paymentProcessorId = '';
4444     if (isset($objects['paymentProcessor'])) {
4445       if (is_array($objects['paymentProcessor'])) {
4446         $paymentProcessorId = $objects['paymentProcessor']['id'];
4447       }
4448       else {
4449         $paymentProcessorId = $objects['paymentProcessor']->id;
4450       }
4451     }
4452
4453     $completedContributionStatusID = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
4454
4455     $contributionParams = array_merge([
4456       'contribution_status_id' => $completedContributionStatusID,
4457       'source' => self::getRecurringContributionDescription($contribution, $event),
4458     ], array_intersect_key($input, array_fill_keys($inputContributionWhiteList, 1)
4459     ));
4460
4461     // CRM-20678 Ensure that the currency is correct in subseqent transcations.
4462     if (empty($contributionParams['currency']) && isset($objects['first_contribution']->currency)) {
4463       $contributionParams['currency'] = $objects['first_contribution']->currency;
4464     }
4465
4466     $contributionParams['payment_processor'] = $input['payment_processor'] = $paymentProcessorId;
4467
4468     // If paymentProcessor is not set then the payment_instrument_id would not be correct.
4469     // not clear when or if this would occur if you encounter this please fix here & add a unit test.
4470     if (empty($contributionParams['payment_instrument_id']) && isset($contribution->_relatedObjects['paymentProcessor']['payment_instrument_id'])) {
4471       $contributionParams['payment_instrument_id'] = $contribution->_relatedObjects['paymentProcessor']['payment_instrument_id'];
4472     }
4473
4474     if ($recurringContributionID) {
4475       $contributionParams['contribution_recur_id'] = $recurringContributionID;
4476     }
4477     $changeDate = CRM_Utils_Array::value('trxn_date', $input, date('YmdHis'));
4478
4479     if (empty($contributionParams['receive_date']) && $changeDate) {
4480       $contributionParams['receive_date'] = $changeDate;
4481     }
4482
4483     self::repeatTransaction($contribution, $input, $contributionParams, $paymentProcessorId);
4484     $contributionParams['financial_type_id'] = $contribution->financial_type_id;
4485
4486     $values = [];
4487     if (isset($input['is_email_receipt'])) {
4488       $values['is_email_receipt'] = $input['is_email_receipt'];
4489     }
4490
4491     if ($input['component'] == 'contribute') {
4492       if ($contribution->contribution_page_id) {
4493         // Figure out what we gain from this.
4494         // Note that we may have overwritten the is_email_receipt input, fix that below.
4495         CRM_Contribute_BAO_ContributionPage::setValues($contribution->contribution_page_id, $values);
4496       }
4497       elseif ($recurContrib && $recurringContributionID) {
4498         $values['amount'] = $recurContrib->amount;
4499         $values['financial_type_id'] = $objects['contributionType']->id;
4500         $values['title'] = $source = ts('Offline Recurring Contribution');
4501       }
4502
4503       if (isset($input['is_email_receipt'])) {
4504         // CRM-19601 - we may have overwritten this above.
4505         $values['is_email_receipt'] = $input['is_email_receipt'];
4506       }
4507       elseif ($recurContrib && $recurringContributionID) {
4508         //CRM-13273 - is_email_receipt setting on recurring contribution should take precedence over contribution page setting
4509         // but CRM-16124 if $input['is_email_receipt'] is set then that should not be overridden.
4510         $values['is_email_receipt'] = $recurContrib->is_email_receipt;
4511       }
4512
4513       if ($contributionParams['contribution_status_id'] === $completedContributionStatusID) {
4514         self::updateMembershipBasedOnCompletionOfContribution(
4515           $contribution,
4516           $primaryContributionID,
4517           $changeDate
4518         );
4519       }
4520     }
4521     else {
4522       if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
4523         if ($event->is_email_confirm) {
4524           // @todo this should be set by the function that sends the mail after sending.
4525           $contributionParams['receipt_date'] = $changeDate;
4526         }
4527         $participantParams['id'] = $participant->id;
4528         $participantParams['status_id'] = 'Registered';
4529         civicrm_api3('Participant', 'create', $participantParams);
4530       }
4531     }
4532
4533     $contributionParams['id'] = $contribution->id;
4534
4535     // CRM-19309 - if you update the contribution here with financial_type_id it can/will mess with $lineItem
4536     // unsetting it here does NOT cause any other contribution test to fail!
4537     unset($contributionParams['financial_type_id']);
4538     $contributionResult = civicrm_api3('Contribution', 'create', $contributionParams);
4539
4540     // Add new soft credit against current $contribution.
4541     if (CRM_Utils_Array::value('contributionRecur', $objects) && $objects['contributionRecur']->id) {
4542       CRM_Contribute_BAO_ContributionRecur::addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id);
4543     }
4544
4545     $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', [
4546       'labelColumn' => 'name',
4547       'flip' => 1,
4548     ]);
4549     if (isset($input['prevContribution']) && (!$input['prevContribution']->is_pay_later && $input['prevContribution']->contribution_status_id == $contributionStatuses['Pending'])) {
4550       $input['payment_processor'] = $paymentProcessorId;
4551     }
4552
4553     if (!empty($contribution->_relatedObjects['participant'])) {
4554       $input['contribution_mode'] = 'participant';
4555       $input['participant_id'] = $contribution->_relatedObjects['participant']->id;
4556     }
4557     elseif (!empty($contribution->_relatedObjects['membership'])) {
4558       // @todo - use getRelatedMemberships instead
4559       $input['contribution_mode'] = 'membership';
4560       $contribution->contribution_status_id = $contributionParams['contribution_status_id'];
4561       $contribution->trxn_id = CRM_Utils_Array::value('trxn_id', $input);
4562       $contribution->receive_date = CRM_Utils_Date::isoToMysql($contribution->receive_date);
4563     }
4564
4565     CRM_Core_Error::debug_log_message("Contribution record updated successfully");
4566     $transaction->commit();
4567
4568     CRM_Contribute_BAO_ContributionRecur::updateRecurLinkedPledge($contribution->id, $recurringContributionID,
4569       $contributionParams['contribution_status_id'], $input['amount']);
4570
4571     // create an activity record
4572     if ($input['component'] == 'contribute') {
4573       //CRM-4027
4574       $targetContactID = NULL;
4575       if (!empty($ids['related_contact'])) {
4576         $targetContactID = $contribution->contact_id;
4577         $contribution->contact_id = $ids['related_contact'];
4578       }
4579       CRM_Activity_BAO_Activity::addActivity($contribution, NULL, $targetContactID);
4580     }
4581
4582     // CRM-9132 legacy behaviour was that receipts were sent out in all instances. Still sending
4583     // when array_key 'is_email_receipt doesn't exist in case some instances where is needs setting haven't been set
4584     if (!array_key_exists('is_email_receipt', $values) ||
4585       $values['is_email_receipt'] == 1
4586     ) {
4587       civicrm_api3('Contribution', 'sendconfirmation', [
4588         'id' => $contribution->id,
4589         'payment_processor_id' => $paymentProcessorId,
4590       ]);
4591       CRM_Core_Error::debug_log_message("Receipt sent");
4592     }
4593
4594     CRM_Core_Error::debug_log_message("Success: Database updated");
4595     return $contributionResult;
4596   }
4597
4598   /**
4599    * Send receipt from contribution.
4600    *
4601    * Do not call this directly - it is being refactored. use contribution.sendmessage api call.
4602    *
4603    * Note that the compose message part has been moved to contribution
4604    * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it.
4605    *
4606    * @param array $input
4607    *   Incoming data from Payment processor.
4608    * @param array $ids
4609    *   Related object IDs.
4610    * @param int $contributionID
4611    * @param array $values
4612    *   Values related to objects that have already been loaded.
4613    * @param bool $returnMessageText
4614    *   Should text be returned instead of sent. This.
4615    *   is because the function is also used to generate pdfs
4616    *
4617    * @return array
4618    * @throws \CRM_Core_Exception
4619    * @throws \CiviCRM_API3_Exception
4620    */
4621   public static function sendMail(&$input, &$ids, $contributionID, &$values,
4622                                   $returnMessageText = FALSE) {
4623
4624     $contribution = new CRM_Contribute_BAO_Contribution();
4625     $contribution->id = $contributionID;
4626     if (!$contribution->find(TRUE)) {
4627       throw new CRM_Core_Exception('Contribution does not exist');
4628     }
4629     $contribution->loadRelatedObjects($input, $ids, TRUE);
4630     // set receipt from e-mail and name in value
4631     if (!$returnMessageText) {
4632       list($values['receipt_from_name'], $values['receipt_from_email']) = self::generateFromEmailAndName($input, $contribution);
4633     }
4634     $values['contribution_status'] = CRM_Core_PseudoConstant::getLabel('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $contribution->contribution_status_id);
4635     $return = $contribution->composeMessageArray($input, $ids, $values, $returnMessageText);
4636     if ((!isset($input['receipt_update']) || $input['receipt_update']) && empty($contribution->receipt_date)) {
4637       civicrm_api3('Contribution', 'create', [
4638         'receipt_date' => 'now',
4639         'id' => $contribution->id,
4640       ]);
4641     }
4642     return $return;
4643   }
4644
4645   /**
4646    * Generate From email and from name in an array values
4647    *
4648    * @param array $input
4649    * @param \CRM_Contribute_BAO_Contribution $contribution
4650    *
4651    * @return array
4652    */
4653   public static function generateFromEmailAndName($input, $contribution) {
4654     // Use input value if supplied.
4655     if (!empty($input['receipt_from_email'])) {
4656       return [
4657         CRM_Utils_Array::value('receipt_from_name', $input, ''),
4658         $input['receipt_from_email'],
4659       ];
4660     }
4661     // if we are still empty see if we can use anything from a contribution page.
4662     $pageValues = [];
4663     if (!empty($contribution->contribution_page_id)) {
4664       $pageValues = civicrm_api3('ContributionPage', 'getsingle', ['id' => $contribution->contribution_page_id]);
4665     }
4666     // if we are still empty see if we can use anything from a contribution page.
4667     if (!empty($pageValues['receipt_from_email'])) {
4668       return [
4669         $pageValues['receipt_from_name'],
4670         $pageValues['receipt_from_email'],
4671       ];
4672     }
4673     // If we are still empty fall back to the domain or logged in user information.
4674     return CRM_Core_BAO_Domain::getDefaultReceiptFrom();
4675   }
4676
4677   /**
4678    * Generate credit note id with next avaible number
4679    *
4680    * @return string
4681    *   Credit Note Id.
4682    */
4683   public static function createCreditNoteId() {
4684     $prefixValue = Civi::settings()->get('contribution_invoice_settings');
4685
4686     $creditNoteNum = CRM_Core_DAO::singleValueQuery("SELECT count(creditnote_id) as creditnote_number FROM civicrm_contribution WHERE creditnote_id IS NOT NULL");
4687     $creditNoteId = NULL;
4688
4689     do {
4690       $creditNoteNum++;
4691       $creditNoteId = CRM_Utils_Array::value('credit_notes_prefix', $prefixValue) . "" . $creditNoteNum;
4692       $result = civicrm_api3('Contribution', 'getcount', [
4693         'sequential' => 1,
4694         'creditnote_id' => $creditNoteId,
4695       ]);
4696     } while ($result > 0);
4697
4698     return $creditNoteId;
4699   }
4700
4701   /**
4702    * Load related memberships.
4703    *
4704    * @param array $ids
4705    *
4706    * @return array $ids
4707    *
4708    * @throws Exception
4709    * @deprecated
4710    *
4711    * Note that in theory it should be possible to retrieve these from the line_item table
4712    * with the membership_payment table being deprecated. Attempting to do this here causes tests to fail
4713    * as it seems the api is not correctly linking the line items when the contribution is created in the flow
4714    * where the contribution is created in the API, followed by the membership (using the api) followed by the membership
4715    * payment. The membership payment BAO does have code to address this but it doesn't appear to be working.
4716    *
4717    * I don't know if it never worked or broke as a result of https://issues.civicrm.org/jira/browse/CRM-14918.
4718    *
4719    */
4720   public function loadRelatedMembershipObjects($ids = []) {
4721     $query = "
4722       SELECT membership_id
4723       FROM   civicrm_membership_payment
4724       WHERE  contribution_id = %1 ";
4725     $params = [1 => [$this->id, 'Integer']];
4726     $ids['membership'] = (array) CRM_Utils_Array::value('membership', $ids, []);
4727
4728     $dao = CRM_Core_DAO::executeQuery($query, $params);
4729     while ($dao->fetch()) {
4730       if ($dao->membership_id && !in_array($dao->membership_id, $ids['membership'])) {
4731         $ids['membership'][$dao->membership_id] = $dao->membership_id;
4732       }
4733     }
4734
4735     if (array_key_exists('membership', $ids) && is_array($ids['membership'])) {
4736       foreach ($ids['membership'] as $id) {
4737         if (!empty($id)) {
4738           $membership = new CRM_Member_BAO_Membership();
4739           $membership->id = $id;
4740           if (!$membership->find(TRUE)) {
4741             throw new Exception("Could not find membership record: $id");
4742           }
4743           $membership->join_date = CRM_Utils_Date::isoToMysql($membership->join_date);
4744           $membership->start_date = CRM_Utils_Date::isoToMysql($membership->start_date);
4745           $membership->end_date = CRM_Utils_Date::isoToMysql($membership->end_date);
4746           $this->_relatedObjects['membership'][$membership->membership_type_id] = $membership;
4747         }
4748       }
4749     }
4750     return $ids;
4751   }
4752
4753   /**
4754    * This function is used to record partial payments for contribution
4755    *
4756    * @param array $contribution
4757    *
4758    * @param array $params
4759    *
4760    * @return CRM_Financial_DAO_FinancialTrxn
4761    */
4762   public static function recordPartialPayment($contribution, $params) {
4763     CRM_Core_Error::deprecatedFunctionWarning('use payment create api');
4764     $balanceTrxnParams['to_financial_account_id'] = self::getToFinancialAccount($contribution, $params);
4765     $balanceTrxnParams['from_financial_account_id'] = CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship($contribution['financial_type_id'], 'Accounts Receivable Account is');
4766     $balanceTrxnParams['total_amount'] = $params['total_amount'];
4767     $balanceTrxnParams['contribution_id'] = $params['contribution_id'];
4768     $balanceTrxnParams['trxn_date'] = CRM_Utils_Array::value('trxn_date', $params, CRM_Utils_Array::value('contribution_receive_date', $params, date('YmdHis')));
4769     $balanceTrxnParams['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
4770     $balanceTrxnParams['net_amount'] = CRM_Utils_Array::value('total_amount', $params);
4771     $balanceTrxnParams['currency'] = $contribution['currency'];
4772     $balanceTrxnParams['trxn_id'] = CRM_Utils_Array::value('contribution_trxn_id', $params, NULL);
4773     $balanceTrxnParams['status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Core_BAO_FinancialTrxn', 'status_id', 'Completed');
4774     $balanceTrxnParams['payment_instrument_id'] = CRM_Utils_Array::value('payment_instrument_id', $params, $contribution['payment_instrument_id']);
4775     $balanceTrxnParams['check_number'] = CRM_Utils_Array::value('check_number', $params);
4776     $balanceTrxnParams['is_payment'] = 1;
4777
4778     if (!empty($params['payment_processor'])) {
4779       // I can't find evidence this is passed in - I was gonna just remove it but decided to deprecate  as I see self::getToFinancialAccount
4780       // also anticipates it.
4781       CRM_Core_Error::deprecatedFunctionWarning('passing payment_processor is deprecated - use payment_processor_id');
4782       $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
4783     }
4784     return CRM_Core_BAO_FinancialTrxn::create($balanceTrxnParams);
4785   }
4786
4787   /**
4788    * Get the description (source field) for the recurring contribution.
4789    *
4790    * @param CRM_Contribute_BAO_Contribution $contribution
4791    * @param CRM_Event_DAO_Event|null $event
4792    *
4793    * @return string
4794    * @throws \CiviCRM_API3_Exception
4795    */
4796   protected static function getRecurringContributionDescription($contribution, $event) {
4797     if (!empty($contribution->source)) {
4798       return $contribution->source;
4799     }
4800     elseif (!empty($contribution->contribution_page_id) && is_numeric($contribution->contribution_page_id)) {
4801       $contributionPageTitle = civicrm_api3('ContributionPage', 'getvalue', [
4802         'id' => $contribution->contribution_page_id,
4803         'return' => 'title',
4804       ]);
4805       return ts('Online Contribution') . ': ' . $contributionPageTitle;
4806     }
4807     elseif ($event) {
4808       return ts('Online Event Registration') . ': ' . $event->title;
4809     }
4810     elseif (!empty($contribution->contribution_recur_id)) {
4811       return 'recurring contribution';
4812     }
4813     return '';
4814   }
4815
4816   /**
4817    * Function to add payments for contribution
4818    * for Partially Paid status
4819    *
4820    * @param array $contributions
4821    * @param string $contributionStatusId
4822    *
4823    */
4824   public static function addPayments($contributions, $contributionStatusId = NULL) {
4825     // get financial trxn which is a payment
4826     $ftSql = "SELECT ft.id, ft.total_amount
4827       FROM civicrm_financial_trxn ft
4828       INNER JOIN civicrm_entity_financial_trxn eft ON eft.financial_trxn_id = ft.id AND eft.entity_table = 'civicrm_contribution'
4829       WHERE eft.entity_id = %1 AND ft.is_payment = 1 ORDER BY ft.id DESC LIMIT 1";
4830     $contributionStatus = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', [
4831       'labelColumn' => 'name',
4832     ]);
4833     foreach ($contributions as $contribution) {
4834       if (!($contributionStatus[$contribution->contribution_status_id] == 'Partially paid'
4835         || CRM_Utils_Array::value($contributionStatusId, $contributionStatus) == 'Partially paid')
4836       ) {
4837         continue;
4838       }
4839       $ftDao = CRM_Core_DAO::executeQuery($ftSql, [
4840         1 => [
4841           $contribution->id,
4842           'Integer',
4843         ],
4844       ]);
4845       $ftDao->fetch();
4846
4847       // store financial item Proportionaly.
4848       $trxnParams = [
4849         'total_amount' => $ftDao->total_amount,
4850         'contribution_id' => $contribution->id,
4851       ];
4852       self::assignProportionalLineItems($trxnParams, $ftDao->id, $contribution->total_amount);
4853     }
4854   }
4855
4856   /**
4857    * Function use to store line item proportionally in in entity financial trxn table
4858    *
4859    * @param array $trxnParams
4860    *
4861    * @param int $trxnId
4862    *
4863    * @param float $contributionTotalAmount
4864    *
4865    * @throws \CiviCRM_API3_Exception
4866    */
4867   public static function assignProportionalLineItems($trxnParams, $trxnId, $contributionTotalAmount) {
4868     $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($trxnParams['contribution_id']);
4869     if (!empty($lineItems)) {
4870       // get financial item
4871       list($ftIds, $taxItems) = self::getLastFinancialItemIds($trxnParams['contribution_id']);
4872       $entityParams = [
4873         'contribution_total_amount' => $contributionTotalAmount,
4874         'trxn_total_amount' => $trxnParams['total_amount'],
4875         'trxn_id' => $trxnId,
4876       ];
4877       self::createProportionalFinancialEntries($entityParams, $lineItems, $ftIds, $taxItems);
4878     }
4879   }
4880
4881   /**
4882    * Checks if line items total amounts
4883    * match the contribution total amount.
4884    *
4885    * @param array $params
4886    *  array of order params.
4887    *
4888    * @throws \API_Exception
4889    */
4890   public static function checkLineItems(&$params) {
4891     $totalAmount = CRM_Utils_Array::value('total_amount', $params);
4892     $lineItemAmount = 0;
4893
4894     foreach ($params['line_items'] as &$lineItems) {
4895       foreach ($lineItems['line_item'] as &$item) {
4896         if (empty($item['financial_type_id'])) {
4897           $item['financial_type_id'] = $params['financial_type_id'];
4898         }
4899         $lineItemAmount += $item['line_total'] + CRM_Utils_Array::value('tax_amount', $item, 0.00);
4900       }
4901     }
4902
4903     if (!isset($totalAmount)) {
4904       $params['total_amount'] = $lineItemAmount;
4905     }
4906     else {
4907       $currency = CRM_Utils_Array::value('currency', $params, '');
4908
4909       if (empty($currency)) {
4910         $currency = CRM_Core_Config::singleton()->defaultCurrency;
4911       }
4912
4913       if (!CRM_Utils_Money::equals($totalAmount, $lineItemAmount, $currency)) {
4914         throw new CRM_Contribute_Exception_CheckLineItemsException();
4915       }
4916     }
4917   }
4918
4919   /**
4920    * Get the financial account for the item associated with the new transaction.
4921    *
4922    * @param array $params
4923    * @param int $default
4924    *
4925    * @return int
4926    */
4927   public static function getFinancialAccountForStatusChangeTrxn($params, $default) {
4928
4929     if (!empty($params['financial_account_id'])) {
4930       return $params['financial_account_id'];
4931     }
4932
4933     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus($params['contribution_status_id'], 'name');
4934     $preferredAccountsRelationships = [
4935       'Refunded' => 'Credit/Contra Revenue Account is',
4936       'Chargeback' => 'Chargeback Account is',
4937     ];
4938
4939     if (in_array($contributionStatus, array_keys($preferredAccountsRelationships))) {
4940       $financialTypeID = !empty($params['financial_type_id']) ? $params['financial_type_id'] : $params['prevContribution']->financial_type_id;
4941       return CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship(
4942         $financialTypeID,
4943         $preferredAccountsRelationships[$contributionStatus]
4944       );
4945     }
4946
4947     return $default;
4948   }
4949
4950   /**
4951    * ContributionPage values were being imposed onto values.
4952    *
4953    * I have made this explicit and removed the couple (is_recur, is_pay_later) we
4954    * REALLY didn't want superimposed. The rest are left there in their overkill out
4955    * of cautiousness.
4956    *
4957    * The rationale for making this explicit is that it was a case of carefully set values being
4958    * seemingly randonly overwritten without much care. In general I think array randomly setting
4959    * variables en mass is risky.
4960    *
4961    * @param array $values
4962    *
4963    * @return array
4964    */
4965   protected function addContributionPageValuesToValuesHeavyHandedly(&$values) {
4966     $contributionPageValues = [];
4967     CRM_Contribute_BAO_ContributionPage::setValues(
4968       $this->contribution_page_id,
4969       $contributionPageValues
4970     );
4971     $valuesToCopy = [
4972       // These are the values that I believe to be useful.
4973       'id',
4974       'title',
4975       'pay_later_receipt',
4976       'pay_later_text',
4977       'receipt_from_email',
4978       'receipt_from_name',
4979       'receipt_text',
4980       'custom_pre_id',
4981       'custom_post_id',
4982       'honoree_profile_id',
4983       'onbehalf_profile_id',
4984       'honor_block_is_active',
4985       // Kinda might be - but would be on the contribution...
4986       'campaign_id',
4987       'currency',
4988       // Included for 'fear of regression' but can't justify any use for these....
4989       'intro_text',
4990       'payment_processor',
4991       'financial_type_id',
4992       'amount_block_is_active',
4993       'bcc_receipt',
4994       'cc_receipt',
4995       'created_date',
4996       'created_id',
4997       'default_amount_id',
4998       'end_date',
4999       'footer_text',
5000       'goal_amount',
5001       'initial_amount_help_text',
5002       'initial_amount_label',
5003       'intro_text',
5004       'is_allow_other_amount',
5005       'is_billing_required',
5006       'is_confirm_enabled',
5007       'is_credit_card_only',
5008       'is_monetary',
5009       'is_partial_payment',
5010       'is_recur_installments',
5011       'is_recur_interval',
5012       'is_share',
5013       'max_amount',
5014       'min_amount',
5015       'min_initial_amount',
5016       'recur_frequency_unit',
5017       'start_date',
5018       'thankyou_footer',
5019       'thankyou_text',
5020       'thankyou_title',
5021
5022     ];
5023     foreach ($valuesToCopy as $valueToCopy) {
5024       if (isset($contributionPageValues[$valueToCopy])) {
5025         $values[$valueToCopy] = $contributionPageValues[$valueToCopy];
5026       }
5027     }
5028     return $values;
5029   }
5030
5031   /**
5032    * Get values of CiviContribute Settings
5033    * and check if its enabled or not.
5034    * Note: The CiviContribute settings are stored as single entry in civicrm_setting
5035    * in serialized form. Usually this should be stored as flat settings for each form fields
5036    * as per CiviCRM standards. Since this would take more effort to change the current behaviour of CiviContribute
5037    * settings we will live with an inconsistency because it's too hard to change for now.
5038    * https://github.com/civicrm/civicrm-core/pull/8562#issuecomment-227874245
5039    *
5040    *
5041    * @param string $name
5042    * @param bool $checkInvoicing
5043    * @return string
5044    *
5045    */
5046   public static function checkContributeSettings($name = NULL, $checkInvoicing = FALSE) {
5047     $contributeSettings = Civi::settings()->get('contribution_invoice_settings');
5048
5049     if ($checkInvoicing && !CRM_Utils_Array::value('invoicing', $contributeSettings)) {
5050       return NULL;
5051     }
5052
5053     if ($name) {
5054       return CRM_Utils_Array::value($name, $contributeSettings);
5055     }
5056     return $contributeSettings;
5057   }
5058
5059   /**
5060    * This function process contribution related objects.
5061    *
5062    * @param int $contributionId
5063    * @param int $statusId
5064    * @param int|null $previousStatusId
5065    *
5066    * @param string $receiveDate
5067    *
5068    * @return null|string
5069    */
5070   public static function transitionComponentWithReturnMessage($contributionId, $statusId, $previousStatusId = NULL, $receiveDate = NULL) {
5071     $statusMsg = NULL;
5072     if (!$contributionId || !$statusId) {
5073       return $statusMsg;
5074     }
5075
5076     $params = [
5077       'contribution_id' => $contributionId,
5078       'contribution_status_id' => $statusId,
5079       'previous_contribution_status_id' => $previousStatusId,
5080       'receive_date' => $receiveDate,
5081     ];
5082
5083     $updateResult = CRM_Contribute_BAO_Contribution::transitionComponents($params);
5084
5085     if (!is_array($updateResult) ||
5086       !($updatedComponents = CRM_Utils_Array::value('updatedComponents', $updateResult)) ||
5087       !is_array($updatedComponents) ||
5088       empty($updatedComponents)
5089     ) {
5090       return $statusMsg;
5091     }
5092
5093     // get the user display name.
5094     $sql = "
5095    SELECT  display_name as displayName
5096      FROM  civicrm_contact
5097 LEFT JOIN  civicrm_contribution on (civicrm_contribution.contact_id = civicrm_contact.id )
5098     WHERE  civicrm_contribution.id = {$contributionId}";
5099     $userDisplayName = CRM_Core_DAO::singleValueQuery($sql);
5100
5101     // get the status message for user.
5102     foreach ($updatedComponents as $componentName => $updatedStatusId) {
5103
5104       if ($componentName == 'CiviMember') {
5105         $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
5106           CRM_Member_PseudoConstant::membershipStatus()
5107         );
5108
5109         $statusNameMsgPart = 'updated';
5110         switch ($updatedStatusName) {
5111           case 'Cancelled':
5112           case 'Expired':
5113             $statusNameMsgPart = $updatedStatusName;
5114             break;
5115         }
5116
5117         $statusMsg .= "<br />" . ts("Membership for %1 has been %2.", [
5118           1 => $userDisplayName,
5119           2 => $statusNameMsgPart,
5120         ]);
5121       }
5122
5123       if ($componentName == 'CiviEvent') {
5124         $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
5125           CRM_Event_PseudoConstant::participantStatus()
5126         );
5127         if ($updatedStatusName == 'Cancelled') {
5128           $statusMsg .= "<br />" . ts("Event Registration for %1 has been Cancelled.", [1 => $userDisplayName]);
5129         }
5130         elseif ($updatedStatusName == 'Registered') {
5131           $statusMsg .= "<br />" . ts("Event Registration for %1 has been updated.", [1 => $userDisplayName]);
5132         }
5133       }
5134
5135       if ($componentName == 'CiviPledge') {
5136         $updatedStatusName = CRM_Utils_Array::value($updatedStatusId,
5137           CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name')
5138         );
5139         if ($updatedStatusName == 'Cancelled') {
5140           $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Cancelled.", [1 => $userDisplayName]);
5141         }
5142         elseif ($updatedStatusName == 'Failed') {
5143           $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been Failed.", [1 => $userDisplayName]);
5144         }
5145         elseif ($updatedStatusName == 'Completed') {
5146           $statusMsg .= "<br />" . ts("Pledge Payment for %1 has been updated.", [1 => $userDisplayName]);
5147         }
5148       }
5149     }
5150
5151     return $statusMsg;
5152   }
5153
5154   /**
5155    * Get the contribution as it is in the database before being updated.
5156    *
5157    * @param int $contributionID
5158    *
5159    * @return \CRM_Contribute_BAO_Contribution|null
5160    */
5161   private static function getOriginalContribution($contributionID) {
5162     return self::getValues(['id' => $contributionID]);
5163   }
5164
5165   /**
5166    * Get the amount for the financial item row.
5167    *
5168    * Helper function to start to break down recordFinancialTransactions for readability.
5169    *
5170    * The logic is more historical than .. logical. Paths other than the deprecated one are tested.
5171    *
5172    * Codewise, several somewhat disimmilar things have been squished into recordFinancialAccounts
5173    * for historical reasons. Going forwards we can hope to add tests & improve readibility
5174    * of that function
5175    *
5176    * @param array $params
5177    *   Params as passed to contribution.create
5178    *
5179    * @param string $context
5180    *   changeFinancialType| changedAmount
5181    * @param array $lineItemDetails
5182    *   Line items.
5183    * @param bool $isARefund
5184    *   Is this a refund / negative transaction.
5185    * @param int $previousLineItemTotal
5186    *
5187    * @return float
5188    * @todo move recordFinancialAccounts & helper functions to their own class?
5189    *
5190    */
5191   protected static function getFinancialItemAmountFromParams($params, $context, $lineItemDetails, $isARefund, $previousLineItemTotal) {
5192     if ($context == 'changedAmount') {
5193       $lineTotal = $lineItemDetails['line_total'];
5194       if ($lineTotal != $previousLineItemTotal) {
5195         $lineTotal -= $previousLineItemTotal;
5196       }
5197       return $lineTotal;
5198     }
5199     elseif ($context == 'changeFinancialType') {
5200       return -$lineItemDetails['line_total'];
5201     }
5202     elseif ($context == 'changedStatus') {
5203       $cancelledTaxAmount = 0;
5204       if ($isARefund) {
5205         $cancelledTaxAmount = CRM_Utils_Array::value('tax_amount', $lineItemDetails, '0.00');
5206       }
5207       return self::getMultiplier($params['contribution']->contribution_status_id, $context) * ((float) $lineItemDetails['line_total'] + (float) $cancelledTaxAmount);
5208     }
5209     elseif ($context === NULL) {
5210       // erm, yes because? but, hey, it's tested.
5211       return $lineItemDetails['line_total'];
5212     }
5213     elseif (empty($lineItemDetails['line_total'])) {
5214       // follow legacy code path
5215       Civi::log()
5216         ->warning('Deprecated bit of code, please log a ticket explaining how you got here!', ['civi.tag' => 'deprecated']);
5217       return $params['total_amount'];
5218     }
5219     else {
5220       return self::getMultiplier($params['contribution']->contribution_status_id, $context) * ((float) $lineItemDetails['line_total']);
5221     }
5222   }
5223
5224   /**
5225    * Get the multiplier for adjusting rows.
5226    *
5227    * If we are dealing with a refund or cancellation then it will be a negative
5228    * amount to reflect the negative transaction.
5229    *
5230    * If we are changing Financial Type it will be a negative amount to
5231    * adjust down the old type.
5232    *
5233    * @param int $contribution_status_id
5234    * @param string $context
5235    *
5236    * @return int
5237    */
5238   protected static function getMultiplier($contribution_status_id, $context) {
5239     if ($context == 'changeFinancialType' || self::isContributionStatusNegative($contribution_status_id)) {
5240       return -1;
5241     }
5242     return 1;
5243   }
5244
5245   /**
5246    * Does this transaction reflect a payment instrument change.
5247    *
5248    * @param array $params
5249    * @param array $pendingStatuses
5250    *
5251    * @return bool
5252    */
5253   protected static function isPaymentInstrumentChange(&$params, $pendingStatuses) {
5254     $contributionStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $params['contribution']->contribution_status_id);
5255
5256     if (array_key_exists('payment_instrument_id', $params)) {
5257       if (CRM_Utils_System::isNull($params['prevContribution']->payment_instrument_id) &&
5258         !CRM_Utils_System::isNull($params['payment_instrument_id'])
5259       ) {
5260         //check if status is changed from Pending to Completed
5261         // do not update payment instrument changes for Pending to Completed
5262         if (!($contributionStatus == 'Completed' &&
5263           in_array($params['prevContribution']->contribution_status_id, $pendingStatuses))
5264         ) {
5265           return TRUE;
5266         }
5267       }
5268       elseif ((!CRM_Utils_System::isNull($params['payment_instrument_id']) &&
5269           !CRM_Utils_System::isNull($params['prevContribution']->payment_instrument_id)) &&
5270         $params['payment_instrument_id'] != $params['prevContribution']->payment_instrument_id
5271       ) {
5272         return TRUE;
5273       }
5274       elseif (!CRM_Utils_System::isNull($params['contribution']->check_number) &&
5275         $params['contribution']->check_number != $params['prevContribution']->check_number
5276       ) {
5277         // another special case when check number is changed, create new financial records
5278         // create financial trxn with negative amount
5279         return TRUE;
5280       }
5281     }
5282     return FALSE;
5283   }
5284
5285   /**
5286    * Update the memberships associated with a contribution if it has been completed.
5287    *
5288    * Note that the way in which $memberships are loaded as objects is pretty messy & I think we could just
5289    * load them in this function. Code clean up would compensate for any minor performance implication.
5290    *
5291    * @param \CRM_Contribute_BAO_Contribution $contribution
5292    * @param int $primaryContributionID
5293    * @param string $changeDate
5294    *
5295    * @throws \CRM_Core_Exception
5296    * @throws \CiviCRM_API3_Exception
5297    */
5298   public static function updateMembershipBasedOnCompletionOfContribution($contribution, $primaryContributionID, $changeDate) {
5299     $memberships = self::getRelatedMemberships($contribution->id);
5300     foreach ($memberships as $membership) {
5301       $membershipParams = [
5302         'id' => $membership['id'],
5303         'contact_id' => $membership['contact_id'],
5304         'is_test' => $membership['is_test'],
5305         'membership_type_id' => $membership['membership_type_id'],
5306         'membership_activity_status' => 'Completed',
5307       ];
5308
5309       $currentMembership = CRM_Member_BAO_Membership::getContactMembership($membershipParams['contact_id'],
5310         $membershipParams['membership_type_id'],
5311         $membershipParams['is_test'],
5312         $membershipParams['id']
5313       );
5314
5315       // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
5316       // this picks up membership type changes during renewals
5317       // @todo this is almost certainly an obsolete sql call, the pre-change
5318       // membership is accessible via $this->_relatedObjects
5319       $sql = "
5320 SELECT    membership_type_id
5321 FROM      civicrm_membership_log
5322 WHERE     membership_id={$membershipParams['id']}
5323 ORDER BY  id DESC
5324 LIMIT 1;";
5325       $dao = CRM_Core_DAO::executeQuery($sql);
5326       if ($dao->fetch()) {
5327         if (!empty($dao->membership_type_id)) {
5328           $membershipParams['membership_type_id'] = $dao->membership_type_id;
5329         }
5330       }
5331       if (empty($membership['end_date']) || (int) $membership['status_id'] !== CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Pending')) {
5332         // Passing num_terms to the api triggers date calculations, but for pending memberships these may be already calculated.
5333         // sigh - they should  be  consistent but removing the end date check causes test failures & maybe UI too?
5334         // The api assumes num_terms is a special sauce for 'is_renewal' so we need to not pass it when updating a pending to completed.
5335         // @todo once apiv4 ships with core switch to that & find sanity.
5336         $membershipParams['num_terms'] = $contribution->getNumTermsByContributionAndMembershipType(
5337           $membershipParams['membership_type_id'],
5338           $primaryContributionID
5339         );
5340       }
5341       // @todo remove all this stuff in favour of letting the api call further down handle in
5342       // (it is a duplication of what the api does).
5343       $dates = array_fill_keys([
5344         'join_date',
5345         'start_date',
5346         'end_date',
5347       ], NULL);
5348       if ($currentMembership) {
5349         /*
5350          * Fixed FOR CRM-4433
5351          * In BAO/Membership.php(renewMembership function), we skip the extend membership date and status
5352          * when Contribution mode is notify and membership is for renewal )
5353          */
5354         CRM_Member_BAO_Membership::fixMembershipStatusBeforeRenew($currentMembership, $changeDate);
5355
5356         // @todo - we should pass membership_type_id instead of null here but not
5357         // adding as not sure of testing
5358         $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($membershipParams['id'],
5359           $changeDate, NULL, $membershipParams['num_terms']
5360         );
5361         $dates['join_date'] = $currentMembership['join_date'];
5362       }
5363
5364       //get the status for membership.
5365       $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($dates['start_date'],
5366         $dates['end_date'],
5367         $dates['join_date'],
5368         'today',
5369         TRUE,
5370         $membershipParams['membership_type_id'],
5371         $membershipParams
5372       );
5373
5374       unset($dates['end_date']);
5375       $membershipParams['status_id'] = CRM_Utils_Array::value('id', $calcStatus, 'New');
5376       //we might be renewing membership,
5377       //so make status override false.
5378       $membershipParams['is_override'] = FALSE;
5379       $membershipParams['status_override_end_date'] = 'null';
5380
5381       //CRM-17723 - reset static $relatedContactIds array()
5382       // @todo move it to Civi Statics.
5383       $var = TRUE;
5384       CRM_Member_BAO_Membership::createRelatedMemberships($var, $var, TRUE);
5385       civicrm_api3('Membership', 'create', $membershipParams);
5386     }
5387   }
5388
5389   /**
5390    * Get payment links as they relate to a contribution.
5391    *
5392    * If a payment can be made then include a payment link & if a refund is appropriate
5393    * then a refund link.
5394    *
5395    * @param int $id
5396    * @param float $balance
5397    * @param string $contributionStatus
5398    *
5399    * @return array
5400    *   $actionLinks Links array containing:
5401    *     -url
5402    *     -title
5403    */
5404   protected static function getContributionPaymentLinks($id, $balance, $contributionStatus) {
5405     if ($contributionStatus === 'Failed' || !CRM_Core_Permission::check('edit contributions')) {
5406       // In general the balance is the best way to determine if a payment can be added or not,
5407       // but not for Failed contributions, where we don't accept additional payments at the moment.
5408       // (in some cases the contribution is 'Pending' and only the payment is failed. In those we
5409       // do accept more payments agains them.
5410       return [];
5411     }
5412     $actionLinks = [];
5413     if ((int) $balance > 0) {
5414       if (CRM_Core_Config::isEnabledBackOfficeCreditCardPayments()) {
5415         $actionLinks[] = [
5416           'url' => CRM_Utils_System::url('civicrm/payment', [
5417             'action' => 'add',
5418             'reset' => 1,
5419             'id' => $id,
5420             'mode' => 'live',
5421           ]),
5422           'title' => ts('Submit Credit Card payment'),
5423         ];
5424       }
5425       $actionLinks[] = [
5426         'url' => CRM_Utils_System::url('civicrm/payment', [
5427           'action' => 'add',
5428           'reset' => 1,
5429           'id' => $id,
5430         ]),
5431         'title' => ts('Record Payment'),
5432       ];
5433     }
5434     elseif ((int) $balance < 0) {
5435       $actionLinks[] = [
5436         'url' => CRM_Utils_System::url('civicrm/payment', [
5437           'action' => 'add',
5438           'reset' => 1,
5439           'id' => $id,
5440         ]),
5441         'title' => ts('Record Refund'),
5442       ];
5443     }
5444     return $actionLinks;
5445   }
5446
5447   /**
5448    * Get a query to determine the amount donated by the contact/s in the current financial year.
5449    *
5450    * @param array $contactIDs
5451    *
5452    * @return string
5453    */
5454   public static function getAnnualQuery($contactIDs) {
5455     $contactIDs = implode(',', $contactIDs);
5456     $config = CRM_Core_Config::singleton();
5457     $currentMonth = date('m');
5458     $currentDay = date('d');
5459     if (
5460       (int) $config->fiscalYearStart['M'] > $currentMonth ||
5461       (
5462         (int) $config->fiscalYearStart['M'] == $currentMonth &&
5463         (int) $config->fiscalYearStart['d'] > $currentDay
5464       )
5465     ) {
5466       $year = date('Y') - 1;
5467     }
5468     else {
5469       $year = date('Y');
5470     }
5471     $nextYear = $year + 1;
5472
5473     if ($config->fiscalYearStart) {
5474       $newFiscalYearStart = $config->fiscalYearStart;
5475       if ($newFiscalYearStart['M'] < 10) {
5476         // This is just a clumsy way of adding padding.
5477         // @todo next round look for a nicer way.
5478         $newFiscalYearStart['M'] = '0' . $newFiscalYearStart['M'];
5479       }
5480       if ($newFiscalYearStart['d'] < 10) {
5481         // This is just a clumsy way of adding padding.
5482         // @todo next round look for a nicer way.
5483         $newFiscalYearStart['d'] = '0' . $newFiscalYearStart['d'];
5484       }
5485       $config->fiscalYearStart = $newFiscalYearStart;
5486       $monthDay = $config->fiscalYearStart['M'] . $config->fiscalYearStart['d'];
5487     }
5488     else {
5489       // First of January.
5490       $monthDay = '0101';
5491     }
5492     $startDate = "$year$monthDay";
5493     $endDate = "$nextYear$monthDay";
5494
5495     $whereClauses = [
5496       'contact_id' => 'IN (' . $contactIDs . ')',
5497       'is_test' => ' = 0',
5498       'receive_date' => ['>=' . $startDate, '<  ' . $endDate],
5499     ];
5500     $havingClause = 'contribution_status_id = ' . (int) CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
5501     CRM_Financial_BAO_FinancialType::addACLClausesToWhereClauses($whereClauses);
5502
5503     $clauses = [];
5504     foreach ($whereClauses as $key => $clause) {
5505       $clauses[] = 'b.' . $key . " " . implode(' AND b.' . $key, (array) $clause);
5506     }
5507     $whereClauseString = implode(' AND ', $clauses);
5508
5509     // See https://github.com/civicrm/civicrm-core/pull/13512 for discussion of how
5510     // this group by + having on contribution_status_id improves performance
5511     $query = "
5512       SELECT COUNT(*) as count,
5513              SUM(total_amount) as amount,
5514              AVG(total_amount) as average,
5515              currency
5516       FROM civicrm_contribution b
5517       WHERE " . $whereClauseString . "
5518       GROUP BY currency, contribution_status_id
5519       HAVING $havingClause
5520       ";
5521     return $query;
5522   }
5523
5524   /**
5525    * Assign Test Value.
5526    *
5527    * @param string $fieldName
5528    * @param array $fieldDef
5529    * @param int $counter
5530    */
5531   protected function assignTestValue($fieldName, &$fieldDef, $counter) {
5532     if ($fieldName == 'tax_amount') {
5533       $this->{$fieldName} = "0.00";
5534     }
5535     elseif ($fieldName == 'net_amount') {
5536       $this->{$fieldName} = "2.00";
5537     }
5538     elseif ($fieldName == 'total_amount') {
5539       $this->{$fieldName} = "3.00";
5540     }
5541     elseif ($fieldName == 'fee_amount') {
5542       $this->{$fieldName} = "1.00";
5543     }
5544     else {
5545       parent::assignTestValues($fieldName, $fieldDef, $counter);
5546     }
5547   }
5548
5549   /**
5550    * Check if contribution has participant/membership payment.
5551    *
5552    * @param int $contributionId
5553    *   Contribution ID
5554    *
5555    * @return bool
5556    */
5557   public static function allowUpdateRevenueRecognitionDate($contributionId) {
5558     // get line item for contribution
5559     $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($contributionId);
5560     // check if line item is for membership or participant
5561     foreach ($lineItems as $items) {
5562       if ($items['entity_table'] == 'civicrm_participant') {
5563         $flag = FALSE;
5564         break;
5565       }
5566       elseif ($items['entity_table'] == 'civicrm_membership') {
5567         $flag = FALSE;
5568       }
5569       else {
5570         $flag = TRUE;
5571         break;
5572       }
5573     }
5574     return $flag;
5575   }
5576
5577   /**
5578    * Create Accounts Receivable financial trxn entry for Completed Contribution.
5579    *
5580    * @param array $trxnParams
5581    *   Financial trxn params
5582    * @param array $contributionParams
5583    *   Contribution Params
5584    *
5585    * @return null
5586    */
5587   public static function recordAlwaysAccountsReceivable(&$trxnParams, $contributionParams) {
5588     if (!Civi::settings()->get('always_post_to_accounts_receivable')) {
5589       return NULL;
5590     }
5591     $statusId = $contributionParams['contribution']->contribution_status_id;
5592     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
5593     $contributionStatus = empty($statusId) ? NULL : $contributionStatuses[$statusId];
5594     $previousContributionStatus = empty($contributionParams['prevContribution']) ? NULL : $contributionStatuses[$contributionParams['prevContribution']->contribution_status_id];
5595     // Return if contribution status is not completed.
5596     if (!($contributionStatus == 'Completed' && (empty($previousContributionStatus)
5597         || (!empty($previousContributionStatus) && $previousContributionStatus == 'Pending'
5598           && $contributionParams['prevContribution']->is_pay_later == 0
5599         )))
5600     ) {
5601       return NULL;
5602     }
5603
5604     $params = $trxnParams;
5605     $financialTypeID = CRM_Utils_Array::value('financial_type_id', $contributionParams) ? $contributionParams['financial_type_id'] : $contributionParams['prevContribution']->financial_type_id;
5606     $arAccountId = CRM_Contribute_PseudoConstant::getRelationalFinancialAccount($financialTypeID, 'Accounts Receivable Account is');
5607     $params['to_financial_account_id'] = $arAccountId;
5608     $params['status_id'] = array_search('Pending', $contributionStatuses);
5609     $params['is_payment'] = FALSE;
5610     $trxn = CRM_Core_BAO_FinancialTrxn::create($params);
5611     self::$_trxnIDs[] = $trxn->id;
5612     $trxnParams['from_financial_account_id'] = $params['to_financial_account_id'];
5613   }
5614
5615   /**
5616    * Calculate financial item amount when contribution is updated.
5617    *
5618    * @param array $params
5619    *   contribution params
5620    * @param array $amountParams
5621    *
5622    * @param string $context
5623    *
5624    * @return float
5625    */
5626   public static function calculateFinancialItemAmount($params, $amountParams, $context) {
5627     if (!empty($params['is_quick_config'])) {
5628       $amount = $amountParams['item_amount'];
5629       if (!$amount) {
5630         $amount = $params['total_amount'];
5631         if ($context === NULL) {
5632           $amount -= CRM_Utils_Array::value('tax_amount', $params, 0);
5633         }
5634       }
5635     }
5636     else {
5637       $amount = $amountParams['line_total'];
5638       if ($context == 'changedAmount') {
5639         $amount -= $amountParams['previous_line_total'];
5640       }
5641       $amount *= $amountParams['diff'];
5642     }
5643     return $amount;
5644   }
5645
5646   /**
5647    * Retrieve Sales Tax Financial Accounts.
5648    *
5649    *
5650    * @return array
5651    *
5652    */
5653   public static function getSalesTaxFinancialAccounts() {
5654     $query = "SELECT cfa.id FROM civicrm_entity_financial_account ce
5655  INNER JOIN civicrm_financial_account cfa ON ce.financial_account_id = cfa.id
5656  WHERE `entity_table` = 'civicrm_financial_type' AND cfa.is_tax = 1 AND ce.account_relationship = %1 GROUP BY cfa.id";
5657     $accountRel = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' "));
5658     $queryParams = [1 => [$accountRel, 'Integer']];
5659     $dao = CRM_Core_DAO::executeQuery($query, $queryParams);
5660     $financialAccount = [];
5661     while ($dao->fetch()) {
5662       $financialAccount[$dao->id] = $dao->id;
5663     }
5664     return $financialAccount;
5665   }
5666
5667   /**
5668    * Create tax entry in civicrm_entity_financial_trxn table.
5669    *
5670    * @param array $entityParams
5671    *
5672    * @param array $eftParams
5673    *
5674    * @throws \CiviCRM_API3_Exception
5675    */
5676   public static function createProportionalEntry($entityParams, $eftParams) {
5677     $paid = 0;
5678     if ($entityParams['contribution_total_amount'] != 0) {
5679       $paid = $entityParams['line_item_amount'] * ($entityParams['trxn_total_amount'] / $entityParams['contribution_total_amount']);
5680     }
5681     // Record Entity Financial Trxn; CRM-20145
5682     $eftParams['amount'] = CRM_Contribute_BAO_Contribution_Utils::formatAmount($paid);
5683     civicrm_api3('EntityFinancialTrxn', 'create', $eftParams);
5684   }
5685
5686   /**
5687    * Create array of last financial item id's.
5688    *
5689    * @param int $contributionId
5690    *
5691    * @return array
5692    */
5693   public static function getLastFinancialItemIds($contributionId) {
5694     $sql = "SELECT fi.id, li.price_field_value_id, li.tax_amount, fi.financial_account_id
5695       FROM civicrm_financial_item fi
5696       INNER JOIN civicrm_line_item li ON li.id = fi.entity_id and fi.entity_table = 'civicrm_line_item'
5697       WHERE li.contribution_id = %1";
5698     $dao = CRM_Core_DAO::executeQuery($sql, [
5699       1 => [
5700         $contributionId,
5701         'Integer',
5702       ],
5703     ]);
5704     $ftIds = $taxItems = [];
5705     $salesTaxFinancialAccount = self::getSalesTaxFinancialAccounts();
5706     while ($dao->fetch()) {
5707       /* if sales tax item*/
5708       if (in_array($dao->financial_account_id, $salesTaxFinancialAccount)) {
5709         $taxItems[$dao->price_field_value_id] = [
5710           'financial_item_id' => $dao->id,
5711           'amount' => $dao->tax_amount,
5712         ];
5713       }
5714       else {
5715         $ftIds[$dao->price_field_value_id] = $dao->id;
5716       }
5717     }
5718     return [$ftIds, $taxItems];
5719   }
5720
5721   /**
5722    * Create proportional entries in civicrm_entity_financial_trxn.
5723    *
5724    * @param array $entityParams
5725    *
5726    * @param array $lineItems
5727    *
5728    * @param array $ftIds
5729    *
5730    * @param array $taxItems
5731    *
5732    * @throws \CiviCRM_API3_Exception
5733    */
5734   public static function createProportionalFinancialEntries($entityParams, $lineItems, $ftIds, $taxItems) {
5735     $eftParams = [
5736       'entity_table' => 'civicrm_financial_item',
5737       'financial_trxn_id' => $entityParams['trxn_id'],
5738     ];
5739     foreach ($lineItems as $key => $value) {
5740       if ($value['qty'] == 0) {
5741         continue;
5742       }
5743       $eftParams['entity_id'] = $ftIds[$value['price_field_value_id']];
5744       $entityParams['line_item_amount'] = $value['line_total'];
5745       self::createProportionalEntry($entityParams, $eftParams);
5746       if (array_key_exists($value['price_field_value_id'], $taxItems)) {
5747         $entityParams['line_item_amount'] = $taxItems[$value['price_field_value_id']]['amount'];
5748         $eftParams['entity_id'] = $taxItems[$value['price_field_value_id']]['financial_item_id'];
5749         self::createProportionalEntry($entityParams, $eftParams);
5750       }
5751     }
5752   }
5753
5754   /**
5755    * Load entities related to the contribution into $this->_relatedObjects.
5756    *
5757    * @param array $ids
5758    *
5759    * @throws \CRM_Core_Exception
5760    */
5761   protected function loadRelatedEntitiesByID($ids) {
5762     $entities = [
5763       'contact' => 'CRM_Contact_BAO_Contact',
5764       'contributionRecur' => 'CRM_Contribute_BAO_ContributionRecur',
5765       'contributionType' => 'CRM_Financial_BAO_FinancialType',
5766       'financialType' => 'CRM_Financial_BAO_FinancialType',
5767       'contributionPage' => 'CRM_Contribute_BAO_ContributionPage',
5768     ];
5769     foreach ($entities as $entity => $bao) {
5770       if (!empty($ids[$entity])) {
5771         $this->_relatedObjects[$entity] = new $bao();
5772         $this->_relatedObjects[$entity]->id = $ids[$entity];
5773         if (!$this->_relatedObjects[$entity]->find(TRUE)) {
5774           throw new CRM_Core_Exception($entity . ' could not be loaded');
5775         }
5776       }
5777     }
5778   }
5779
5780   /**
5781    * Should an email receipt be sent for this contribution when complete.
5782    *
5783    * @param array $input
5784    *
5785    * @return mixed
5786    */
5787   protected function isEmailReceipt($input) {
5788     if (isset($input['is_email_receipt'])) {
5789       return $input['is_email_receipt'];
5790     }
5791     if (!empty($this->_relatedObjects['contribution_page_id'])) {
5792       return $this->_relatedObjects['contribution_page_id']->is_email_receipt;
5793     }
5794     return TRUE;
5795   }
5796
5797   /**
5798    * Function to replace contribution tokens.
5799    *
5800    * @param array $contributionIds
5801    *
5802    * @param string $subject
5803    *
5804    * @param array $subjectToken
5805    *
5806    * @param string $text
5807    *
5808    * @param string $html
5809    *
5810    * @param array $messageToken
5811    *
5812    * @param bool $escapeSmarty
5813    *
5814    * @return array
5815    * @throws \CiviCRM_API3_Exception
5816    */
5817   public static function replaceContributionTokens(
5818     $contributionIds,
5819     $subject,
5820     $subjectToken,
5821     $text,
5822     $html,
5823     $messageToken,
5824     $escapeSmarty
5825   ) {
5826     if (empty($contributionIds)) {
5827       return [];
5828     }
5829     $contributionDetails = [];
5830     foreach ($contributionIds as $id) {
5831       $result = self::getContributionTokenValues($id, $messageToken);
5832       $contributionDetails[$result['values'][$result['id']]['contact_id']]['subject'] = CRM_Utils_Token::replaceContributionTokens($subject, $result, FALSE, $subjectToken, FALSE, $escapeSmarty);
5833       $contributionDetails[$result['values'][$result['id']]['contact_id']]['text'] = CRM_Utils_Token::replaceContributionTokens($text, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
5834       $contributionDetails[$result['values'][$result['id']]['contact_id']]['html'] = CRM_Utils_Token::replaceContributionTokens($html, $result, FALSE, $messageToken, FALSE, $escapeSmarty);
5835     }
5836     return $contributionDetails;
5837   }
5838
5839   /**
5840    * Get the contribution fields for $id and display labels where
5841    * appropriate (if the token is present).
5842    *
5843    * @param int $id
5844    * @param array $messageToken
5845    * @return array
5846    */
5847   public static function getContributionTokenValues($id, $messageToken) {
5848     if (empty($id)) {
5849       return [];
5850     }
5851     $result = civicrm_api3('Contribution', 'get', ['id' => $id]);
5852     // lab.c.o mail#46 - show labels, not values, for custom fields with option values.
5853     if (!empty($messageToken)) {
5854       foreach ($result['values'][$id] as $fieldName => $fieldValue) {
5855         if (strpos($fieldName, 'custom_') === 0 && array_search($fieldName, $messageToken['contribution']) !== FALSE) {
5856           $result['values'][$id][$fieldName] = CRM_Core_BAO_CustomField::displayValue($result['values'][$id][$fieldName], $fieldName);
5857         }
5858       }
5859     }
5860     return $result;
5861   }
5862
5863   /**
5864    * Get invoice_number for contribution.
5865    *
5866    * @param int $contributionID
5867    *
5868    * @return string
5869    */
5870   public static function getInvoiceNumber($contributionID) {
5871     if ($invoicePrefix = self::checkContributeSettings('invoice_prefix', TRUE)) {
5872       return $invoicePrefix . $contributionID;
5873     }
5874
5875     return NULL;
5876   }
5877
5878   /**
5879    * Load the values needed for the event message.
5880    *
5881    * @param int $eventID
5882    * @param int $participantID
5883    * @param int|null $contributionID
5884    *
5885    * @return array
5886    * @throws \CRM_Core_Exception
5887    */
5888   protected function loadEventMessageTemplateParams(int $eventID, int $participantID, $contributionID): array {
5889
5890     $eventParams = [
5891       'id' => $eventID,
5892     ];
5893     $values = ['event' => []];
5894
5895     CRM_Event_BAO_Event::retrieve($eventParams, $values['event']);
5896     // add custom fields for event
5897     $eventGroupTree = CRM_Core_BAO_CustomGroup::getTree('Event', NULL, $eventID);
5898
5899     $eventCustomGroup = [];
5900     foreach ($eventGroupTree as $key => $group) {
5901       if ($key === 'info') {
5902         continue;
5903       }
5904
5905       foreach ($group['fields'] as $k => $customField) {
5906         $groupLabel = $group['title'];
5907         if (!empty($customField['customValue'])) {
5908           foreach ($customField['customValue'] as $customFieldValues) {
5909             $eventCustomGroup[$groupLabel][$customField['label']] = CRM_Utils_Array::value('data', $customFieldValues);
5910           }
5911         }
5912       }
5913     }
5914     $values['event']['customGroup'] = $eventCustomGroup;
5915
5916     //get participant details
5917     $participantParams = [
5918       'id' => $participantID,
5919     ];
5920
5921     $values['participant'] = [];
5922
5923     CRM_Event_BAO_Participant::getValues($participantParams, $values['participant'], $participantIds);
5924     // add custom fields for event
5925     $participantGroupTree = CRM_Core_BAO_CustomGroup::getTree('Participant', NULL, $participantID);
5926     $participantCustomGroup = [];
5927     foreach ($participantGroupTree as $key => $group) {
5928       if ($key === 'info') {
5929         continue;
5930       }
5931
5932       foreach ($group['fields'] as $k => $customField) {
5933         $groupLabel = $group['title'];
5934         if (!empty($customField['customValue'])) {
5935           foreach ($customField['customValue'] as $customFieldValues) {
5936             $participantCustomGroup[$groupLabel][$customField['label']] = CRM_Utils_Array::value('data', $customFieldValues);
5937           }
5938         }
5939       }
5940     }
5941     $values['participant']['customGroup'] = $participantCustomGroup;
5942
5943     //get location details
5944     $locationParams = [
5945       'entity_id' => $eventID,
5946       'entity_table' => 'civicrm_event',
5947     ];
5948     $values['location'] = CRM_Core_BAO_Location::getValues($locationParams);
5949
5950     $ufJoinParams = [
5951       'entity_table' => 'civicrm_event',
5952       'entity_id' => $eventID,
5953       'module' => 'CiviEvent',
5954     ];
5955
5956     list($custom_pre_id,
5957       $custom_post_ids
5958       ) = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
5959
5960     $values['custom_pre_id'] = $custom_pre_id;
5961     $values['custom_post_id'] = $custom_post_ids;
5962
5963     // set lineItem for event contribution
5964     if ($contributionID) {
5965       $participantIds = CRM_Event_BAO_Participant::getParticipantIds($contributionID);
5966       if (!empty($participantIds)) {
5967         foreach ($participantIds as $pIDs) {
5968           $lineItem = CRM_Price_BAO_LineItem::getLineItems($pIDs);
5969           if (!CRM_Utils_System::isNull($lineItem)) {
5970             $values['lineItem'][] = $lineItem;
5971           }
5972         }
5973       }
5974     }
5975     return $values;
5976   }
5977
5978 }