CRM/Contribute/BAO/Contribution.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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-2016
  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   static $_importableFields = NULL;
  41
  42   /**
  43    * Static field for all the contribution information that we can potentially export
  44    *
  45    * @var array
  46    */
  47   static $_exportableFields = NULL;
  48
  49   /**
  50    * Field for all the objects related to this contribution
  51    * @var array of objects (e.g membership object, participant object)
  52    */
  53   public $_relatedObjects = array();
  54
  55   /**
  56    * Field for the component - either 'event' (participant) or 'contribute'
  57    * (any item related to a contribution page e.g. membership, pledge, contribution)
  58    * This is used for composing messages because they have dependency on the
  59    * contribution_page or event page - although over time we may eliminate that
  60    *
  61    * @var string component or event
  62    */
  63   public $_component = NULL;
  64
  65   /**
  66    * Possibly obsolete variable.
  67    *
  68    * If you use it please explain why it is set in the create function here.
  69    *
  70    * @var string
  71    */
  72   public $trxn_result_code;
  73
  74   /**
  75    * Class constructor.
  76    */
  77   public function __construct() {
  78     parent::__construct();
  79   }
  80
  81   /**
  82    * Takes an associative array and creates a contribution object.
  83    *
  84    * the function extract all the params it needs to initialize the create a
  85    * contribution object. the params array could contain additional unused name/value
  86    * pairs
  87    *
  88    * @param array $params
  89    *   (reference ) an assoc array of name/value pairs.
  90    * @param array $ids
  91    *   The array that holds all the db ids.
  92    *
  93    * @return CRM_Contribute_BAO_Contribution|void
  94    */
  95   public static function add(&$params, $ids = array()) {
  96     if (empty($params)) {
  97       return NULL;
  98     }
  99     //per http://wiki.civicrm.org/confluence/display/CRM/Database+layer we are moving away from $ids array
 100     $contributionID = CRM_Utils_Array::value('contribution', $ids, CRM_Utils_Array::value('id', $params));
 101     $duplicates = array();
 102     if (self::checkDuplicate($params, $duplicates, $contributionID)) {
 103       $error = CRM_Core_Error::singleton();
 104       $d = implode(', ', $duplicates);
 105       $error->push(CRM_Core_Error::DUPLICATE_CONTRIBUTION,
 106         'Fatal',
 107         array($d),
 108         "Duplicate error - existing contribution record(s) have a matching Transaction ID or Invoice ID. Contribution record ID(s) are: $d"
 109       );
 110       return $error;
 111     }
 112
 113     // first clean up all the money fields
 114     $moneyFields = array(
 115       'total_amount',
 116       'net_amount',
 117       'fee_amount',
 118       'non_deductible_amount',
 119     );
 120
 121     //if priceset is used, no need to cleanup money
 122     if (!empty($params['skipCleanMoney'])) {
 123       unset($moneyFields[0]);
 124     }
 125
 126     foreach ($moneyFields as $field) {
 127       if (isset($params[$field])) {
 128         $params[$field] = CRM_Utils_Rule::cleanMoney($params[$field]);
 129       }
 130     }
 131
 132     //set defaults in create mode
 133     if (!$contributionID) {
 134       CRM_Core_DAO::setCreateDefaults($params, self::getDefaults());
 135     }
 136
 137     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 138     //if contribution is created with cancelled or refunded status, add credit note id
 139     if (!empty($params['contribution_status_id'])) {
 140       // @todo - should we include Chargeback? If so use self::isContributionStatusNegative($params['contribution_status_id'])
 141       if (($params['contribution_status_id'] == array_search('Refunded', $contributionStatus)
 142         || $params['contribution_status_id'] == array_search('Cancelled', $contributionStatus))
 143       ) {
 144         if (empty($params['creditnote_id']) || $params['creditnote_id'] == "null") {
 145           $params['creditnote_id'] = self::createCreditNoteId();
 146         }
 147       }
 148     }
 149     else {
 150       // Since the fee amount is expecting this (later on) ensure it is always set.
 151       // It would only not be set for an update where it is unchanged.
 152       $params['contribution_status_id'] = civicrm_api3('Contribution', 'getvalue', array('id' => $contributionID, 'return' => 'contribution_status_id'));
 153     }
 154
 155     self::calculateMissingAmountParams($params, $contributionID);
 156
 157     if (!empty($params['payment_instrument_id'])) {
 158       $paymentInstruments = CRM_Contribute_PseudoConstant::paymentInstrument('name');
 159       if ($params['payment_instrument_id'] != array_search('Check', $paymentInstruments)) {
 160         $params['check_number'] = 'null';
 161       }
 162     }
 163
 164     $setPrevContribution = TRUE;
 165     // CRM-13964 partial payment
 166     if (!empty($params['partial_payment_total']) && !empty($params['partial_amount_pay'])) {
 167       $partialAmtTotal = $params['partial_payment_total'];
 168       $partialAmtPay = $params['partial_amount_pay'];
 169       $params['total_amount'] = $partialAmtTotal;
 170       if ($partialAmtPay < $partialAmtTotal) {
 171         $params['contribution_status_id'] = CRM_Core_OptionGroup::getValue('contribution_status', 'Partially paid', 'name');
 172         $params['is_pay_later'] = 0;
 173         $setPrevContribution = FALSE;
 174       }
 175     }
 176     if ($contributionID && $setPrevContribution) {
 177       $params['prevContribution'] = self::getValues(array('id' => $contributionID), CRM_Core_DAO::$_nullArray, CRM_Core_DAO::$_nullArray);
 178     }
 179
 180     if ($contributionID) {
 181       CRM_Utils_Hook::pre('edit', 'Contribution', $contributionID, $params);
 182     }
 183     else {
 184       CRM_Utils_Hook::pre('create', 'Contribution', NULL, $params);
 185     }
 186     $contribution = new CRM_Contribute_BAO_Contribution();
 187     $contribution->copyValues($params);
 188
 189     $contribution->id = $contributionID;
 190
 191     if (empty($contribution->id)) {
 192       // (only) on 'create', make sure that a valid currency is set (CRM-16845)
 193       if (!CRM_Utils_Rule::currencyCode($contribution->currency)) {
 194         $contribution->currency = CRM_Core_Config::singleton()->defaultCurrency;
 195       }
 196     }
 197
 198     $result = $contribution->save();
 199
 200     // Add financial_trxn details as part of fix for CRM-4724
 201     $contribution->trxn_result_code = CRM_Utils_Array::value('trxn_result_code', $params);
 202     $contribution->payment_processor = CRM_Utils_Array::value('payment_processor', $params);
 203
 204     //add Account details
 205     $params['contribution'] = $contribution;
 206     self::recordFinancialAccounts($params);
 207
 208     if (self::isUpdateToRecurringContribution($params)) {
 209       CRM_Contribute_BAO_ContributionRecur::updateOnNewPayment(
 210         (!empty($params['contribution_recur_id']) ? $params['contribution_recur_id'] : $params['prevContribution']->contribution_recur_id),
 211         $contributionStatus[$params['contribution_status_id']]
 212       );
 213     }
 214
 215     // reset the group contact cache for this group
 216     CRM_Contact_BAO_GroupContactCache::remove();
 217
 218     if ($contributionID) {
 219       CRM_Utils_Hook::post('edit', 'Contribution', $contribution->id, $contribution);
 220     }
 221     else {
 222       CRM_Utils_Hook::post('create', 'Contribution', $contribution->id, $contribution);
 223     }
 224
 225     return $result;
 226   }
 227
 228   /**
 229    * Is this contribution updating an existing recurring contribution.
 230    *
 231    * We need to upd the status of the linked recurring contribution if we have a new payment against it, or the initial
 232    * pending payment is being confirmed (or failing).
 233    *
 234    * @param array $params
 235    *
 236    * @return bool
 237    */
 238   public static function isUpdateToRecurringContribution($params) {
 239     if (!empty($params['contribution_recur_id']) && empty($params['id'])) {
 240       return TRUE;
 241     }
 242     if (empty($params['prevContribution']) || empty($params['contribution_status_id'])) {
 243       return FALSE;
 244     }
 245     if (empty($params['contribution_recur_id']) && empty($params['prevContribution']->contribution_recur_id)) {
 246       return FALSE;
 247     }
 248     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 249     if ($params['prevContribution']->contribution_status_id == array_search('Pending', $contributionStatus)) {
 250       return TRUE;
 251     }
 252     return FALSE;
 253   }
 254
 255   /**
 256    * Get defaults for new entity.
 257    * @return array
 258    */
 259   public static function getDefaults() {
 260     return array(
 261       'payment_instrument_id' => key(CRM_Core_OptionGroup::values('payment_instrument',
 262           FALSE, FALSE, FALSE, 'AND is_default = 1')
 263       ),
 264       'contribution_status_id' => CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name'),
 265     );
 266   }
 267
 268   /**
 269    * Fetch the object and store the values in the values array.
 270    *
 271    * @param array $params
 272    *   Input parameters to find object.
 273    * @param array $values
 274    *   Output values of the object.
 275    * @param array $ids
 276    *   The array that holds all the db ids.
 277    *
 278    * @return CRM_Contribute_BAO_Contribution|null
 279    *   The found object or null
 280    */
 281   public static function getValues($params, &$values, &$ids) {
 282     if (empty($params)) {
 283       return NULL;
 284     }
 285     $contribution = new CRM_Contribute_BAO_Contribution();
 286
 287     $contribution->copyValues($params);
 288
 289     if ($contribution->find(TRUE)) {
 290       $ids['contribution'] = $contribution->id;
 291
 292       CRM_Core_DAO::storeValues($contribution, $values);
 293
 294       return $contribution;
 295     }
 296     $null = NULL; // return by reference
 297     return $null;
 298   }
 299
 300   /**
 301    * Get the values and resolve the most common mappings.
 302    *
 303    * Since contribution status is resolved in almost every function that calls getValues it makes
 304    * sense to have an extra function to resolve it rather than repeat the code.
 305    *
 306    * Think carefully before adding more mappings to be resolved as there could be performance implications
 307    * if this function starts to be called from more iterative functions.
 308    *
 309    * @param array $params
 310    *   Input parameters to find object.
 311    *
 312    * @return array
 313    *   Array of the found contribution.
 314    * @throws CRM_Core_Exception
 315    */
 316   public static function getValuesWithMappings($params) {
 317     $values = $ids = array();
 318     $contribution = self::getValues($params, $values, $ids);
 319     if (is_null($contribution)) {
 320       throw new CRM_Core_Exception('No contribution found');
 321     }
 322     $values['contribution_status'] = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $values['contribution_status_id']);
 323     return $values;
 324   }
 325
 326   /**
 327    * Calculate net_amount & fee_amount if they are not set.
 328    *
 329    * Net amount should be total - fee.
 330    * This should only be called for new contributions.
 331    *
 332    * @param array $params
 333    *   Params for a new contribution before they are saved.
 334    * @param int|null $contributionID
 335    *   Contribution ID if we are dealing with an update.
 336    *
 337    * @throws \CiviCRM_API3_Exception
 338    */
 339   public static function calculateMissingAmountParams(&$params, $contributionID) {
 340     if (!$contributionID && !isset($params['fee_amount'])) {
 341       if (isset($params['total_amount']) && isset($params['net_amount'])) {
 342         $params['fee_amount'] = $params['total_amount'] - $params['net_amount'];
 343       }
 344       else {
 345         $params['fee_amount'] = 0;
 346       }
 347     }
 348     if (!isset($params['net_amount'])) {
 349       if (!$contributionID) {
 350         $params['net_amount'] = $params['total_amount'] - $params['fee_amount'];
 351       }
 352       else {
 353         if (isset($params['fee_amount']) || isset($params['total_amount'])) {
 354           // We have an existing contribution and fee_amount or total_amount has been passed in but not net_amount.
 355           // net_amount may need adjusting.
 356           $contribution = civicrm_api3('Contribution', 'getsingle', array(
 357             'id' => $contributionID,
 358             'return' => array('total_amount', 'net_amount'),
 359           ));
 360           $totalAmount = isset($params['total_amount']) ? $params['total_amount'] : CRM_Utils_Array::value('total_amount', $contribution);
 361           $feeAmount = isset($params['fee_amount']) ? $params['fee_amount'] : CRM_Utils_Array::value('fee_amount', $contribution);
 362           $params['net_amount'] = $totalAmount - $feeAmount;
 363         }
 364       }
 365     }
 366   }
 367
 368   /**
 369    * @param $params
 370    * @param $billingLocationTypeID
 371    *
 372    * @return array
 373    */
 374   protected static function getBillingAddressParams($params, $billingLocationTypeID) {
 375     $hasBillingField = FALSE;
 376     $billingFields = array(
 377       'street_address',
 378       'city',
 379       'state_province_id',
 380       'postal_code',
 381       'country_id',
 382     );
 383
 384     //build address array
 385     $addressParams = array();
 386     $addressParams['location_type_id'] = $billingLocationTypeID;
 387     $addressParams['is_billing'] = 1;
 388
 389     $billingFirstName = CRM_Utils_Array::value('billing_first_name', $params);
 390     $billingMiddleName = CRM_Utils_Array::value('billing_middle_name', $params);
 391     $billingLastName = CRM_Utils_Array::value('billing_last_name', $params);
 392     $addressParams['address_name'] = "{$billingFirstName}" . CRM_Core_DAO::VALUE_SEPARATOR . "{$billingMiddleName}" . CRM_Core_DAO::VALUE_SEPARATOR . "{$billingLastName}";
 393
 394     foreach ($billingFields as $value) {
 395       $addressParams[$value] = CRM_Utils_Array::value("billing_{$value}-{$billingLocationTypeID}", $params);
 396       if (!empty($addressParams[$value])) {
 397         $hasBillingField = TRUE;
 398       }
 399     }
 400     return array($hasBillingField, $addressParams);
 401   }
 402
 403   /**
 404    * Get address params ready to be passed to the payment processor.
 405    *
 406    * We need address params in a couple of formats. For the payment processor we wan state_province_id-5.
 407    * To create an address we need state_province_id.
 408    *
 409    * @param array $params
 410    * @param int $billingLocationTypeID
 411    *
 412    * @return array
 413    */
 414   public static function getPaymentProcessorReadyAddressParams($params, $billingLocationTypeID) {
 415     list($hasBillingField, $addressParams) = self::getBillingAddressParams($params, $billingLocationTypeID);
 416     foreach ($addressParams as $name => $field) {
 417       if (substr($name, 0, 8) == 'billing_') {
 418         $addressParams[substr($name, 9)] = $addressParams[$field];
 419       }
 420     }
 421     return array($hasBillingField, $addressParams);
 422   }
 423
 424   /**
 425    * Get the number of terms for this contribution for a given membership type
 426    * based on querying the line item table and relevant price field values
 427    * Note that any one contribution should only be able to have one line item relating to a particular membership
 428    * type
 429    *
 430    * @param int $membershipTypeID
 431    *
 432    * @param int $contributionID
 433    *
 434    * @return int
 435    */
 436   public function getNumTermsByContributionAndMembershipType($membershipTypeID, $contributionID) {
 437     $numTerms = CRM_Core_DAO::singleValueQuery("
 438       SELECT membership_num_terms FROM civicrm_line_item li
 439       LEFT JOIN civicrm_price_field_value v ON li.price_field_value_id = v.id
 440       WHERE contribution_id = %1 AND membership_type_id = %2",
 441       array(1 => array($contributionID, 'Integer'), 2 => array($membershipTypeID, 'Integer'))
 442     );
 443     // default of 1 is precautionary
 444     return empty($numTerms) ? 1 : $numTerms;
 445   }
 446
 447   /**
 448    * Takes an associative array and creates a contribution object.
 449    *
 450    * @param array $params
 451    *   (reference ) an assoc array of name/value pairs.
 452    * @param array $ids
 453    *   The array that holds all the db ids.
 454    *
 455    * @return CRM_Contribute_BAO_Contribution
 456    */
 457   public static function create(&$params, $ids = array()) {
 458     $dateFields = array('receive_date', 'cancel_date', 'receipt_date', 'thankyou_date');
 459     foreach ($dateFields as $df) {
 460       if (isset($params[$df])) {
 461         $params[$df] = CRM_Utils_Date::isoToMysql($params[$df]);
 462       }
 463     }
 464
 465     //if contribution is created with cancelled or refunded status, add credit note id
 466     if (!empty($params['contribution_status_id'])) {
 467       $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
 468
 469       if (($params['contribution_status_id'] == array_search('Refunded', $contributionStatus)
 470           || $params['contribution_status_id'] == array_search('Cancelled', $contributionStatus))
 471       ) {
 472         if (empty($params['creditnote_id']) || $params['creditnote_id'] == "null") {
 473           $params['creditnote_id'] = self::createCreditNoteId();
 474         }
 475       }
 476     }
 477
 478     $transaction = new CRM_Core_Transaction();
 479
 480     $contribution = self::add($params, $ids);
 481
 482     if (is_a($contribution, 'CRM_Core_Error')) {
 483       $transaction->rollback();
 484       return $contribution;
 485     }
 486
 487     $params['contribution_id'] = $contribution->id;
 488
 489     if (!empty($params['custom']) &&
 490       is_array($params['custom'])
 491     ) {
 492       CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_contribution', $contribution->id);
 493     }
 494
 495     $session = CRM_Core_Session::singleton();
 496
 497     if (!empty($params['note'])) {
 498       $noteParams = array(
 499         'entity_table' => 'civicrm_contribution',
 500         'note' => $params['note'],
 501         'entity_id' => $contribution->id,
 502         'contact_id' => $session->get('userID'),
 503         'modified_date' => date('Ymd'),
 504       );
 505       if (!$noteParams['contact_id']) {
 506         $noteParams['contact_id'] = $params['contact_id'];
 507       }
 508       CRM_Core_BAO_Note::add($noteParams);
 509     }
 510
 511     // make entry in batch entity batch table
 512     if (!empty($params['batch_id'])) {
 513       // in some update cases we need to get extra fields - ie an update that doesn't pass in all these params
 514       $titleFields = array(
 515         'contact_id',
 516         'total_amount',
 517         'currency',
 518         'financial_type_id',
 519       );
 520       $retrieveRequired = 0;
 521       foreach ($titleFields as $titleField) {
 522         if (!isset($contribution->$titleField)) {
 523           $retrieveRequired = 1;
 524           break;
 525         }
 526       }
 527       if ($retrieveRequired == 1) {
 528         $contribution->find(TRUE);
 529       }
 530     }
 531
 532     CRM_Contribute_BAO_ContributionSoft::processSoftContribution($params, $contribution);
 533
 534     $transaction->commit();
 535
 536     // check if activity record exist for this contribution, if
 537     // not add activity
 538     $activity = new CRM_Activity_DAO_Activity();
 539     $activity->source_record_id = $contribution->id;
 540     $activity->activity_type_id = CRM_Core_OptionGroup::getValue('activity_type',
 541       'Contribution',
 542       'name'
 543     );
 544     if (!$activity->find(TRUE)) {
 545       if (empty($contribution->contact_id)) {
 546         $contribution->find(TRUE);
 547       }
 548       CRM_Activity_BAO_Activity::addActivity($contribution, 'Offline');
 549     }
 550     else {
 551       // CRM-13237 : if activity record found, update it with campaign id of contribution
 552       CRM_Core_DAO::setFieldValue('CRM_Activity_BAO_Activity', $activity->id, 'campaign_id', $contribution->campaign_id);
 553     }
 554
 555     // do not add to recent items for import, CRM-4399
 556     if (empty($params['skipRecentView'])) {
 557       $url = CRM_Utils_System::url('civicrm/contact/view/contribution',
 558         "action=view&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
 559       );
 560       // in some update cases we need to get extra fields - ie an update that doesn't pass in all these params
 561       $titleFields = array(
 562         'contact_id',
 563         'total_amount',
 564         'currency',
 565         'financial_type_id',
 566       );
 567       $retrieveRequired = 0;
 568       foreach ($titleFields as $titleField) {
 569         if (!isset($contribution->$titleField)) {
 570           $retrieveRequired = 1;
 571           break;
 572         }
 573       }
 574       if ($retrieveRequired == 1) {
 575         $contribution->find(TRUE);
 576       }
 577       $contributionTypes = CRM_Contribute_PseudoConstant::financialType();
 578       $title = CRM_Contact_BAO_Contact::displayName($contribution->contact_id) . ' - (' . CRM_Utils_Money::format($contribution->total_amount, $contribution->currency) . ' ' . ' - ' . $contributionTypes[$contribution->financial_type_id] . ')';
 579
 580       $recentOther = array();
 581       if (CRM_Core_Permission::checkActionPermission('CiviContribute', CRM_Core_Action::UPDATE)) {
 582         $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/view/contribution',
 583           "action=update&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
 584         );
 585       }
 586
 587       if (CRM_Core_Permission::checkActionPermission('CiviContribute', CRM_Core_Action::DELETE)) {
 588         $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/contribution',
 589           "action=delete&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
 590         );
 591       }
 592
 593       // add the recently created Contribution
 594       CRM_Utils_Recent::add($title,
 595         $url,
 596         $contribution->id,
 597         'Contribution',
 598         $contribution->contact_id,
 599         NULL,
 600         $recentOther
 601       );
 602     }
 603
 604     return $contribution;
 605   }
 606
 607   /**
 608    * Get the values for pseudoconstants for name->value and reverse.
 609    *
 610    * @param array $defaults
 611    *   (reference) the default values, some of which need to be resolved.
 612    * @param bool $reverse
 613    *   True if we want to resolve the values in the reverse direction (value -> name).
 614    */
 615   public static function resolveDefaults(&$defaults, $reverse = FALSE) {
 616     self::lookupValue($defaults, 'financial_type', CRM_Contribute_PseudoConstant::financialType(), $reverse);
 617     self::lookupValue($defaults, 'payment_instrument', CRM_Contribute_PseudoConstant::paymentInstrument(), $reverse);
 618     self::lookupValue($defaults, 'contribution_status', CRM_Contribute_PseudoConstant::contributionStatus(), $reverse);
 619     self::lookupValue($defaults, 'pcp', CRM_Contribute_PseudoConstant::pcPage(), $reverse);
 620   }
 621
 622   /**
 623    * Convert associative array names to values and vice-versa.
 624    *
 625    * This function is used by both the web form layer and the api. Note that
 626    * the api needs the name => value conversion, also the view layer typically
 627    * requires value => name conversion
 628    *
 629    * @param array $defaults
 630    * @param string $property
 631    * @param array $lookup
 632    * @param bool $reverse
 633    *
 634    * @return bool
 635    */
 636   public static function lookupValue(&$defaults, $property, &$lookup, $reverse) {
 637     $id = $property . '_id';
 638
 639     $src = $reverse ? $property : $id;
 640     $dst = $reverse ? $id : $property;
 641
 642     if (!array_key_exists($src, $defaults)) {
 643       return FALSE;
 644     }
 645
 646     $look = $reverse ? array_flip($lookup) : $lookup;
 647
 648     if (is_array($look)) {
 649       if (!array_key_exists($defaults[$src], $look)) {
 650         return FALSE;
 651       }
 652     }
 653     $defaults[$dst] = $look[$defaults[$src]];
 654     return TRUE;
 655   }
 656
 657   /**
 658    * Retrieve DB object based on input parameters.
 659    *
 660    * It also stores all the retrieved values in the default array.
 661    *
 662    * @param array $params
 663    *   (reference ) an assoc array of name/value pairs.
 664    * @param array $defaults
 665    *   (reference ) an assoc array to hold the name / value pairs.
 666    *                        in a hierarchical manner
 667    * @param array $ids
 668    *   (reference) the array that holds all the db ids.
 669    *
 670    * @return CRM_Contribute_BAO_Contribution
 671    */
 672   public static function retrieve(&$params, &$defaults, &$ids) {
 673     $contribution = CRM_Contribute_BAO_Contribution::getValues($params, $defaults, $ids);
 674     return $contribution;
 675   }
 676
 677   /**
 678    * Combine all the importable fields from the lower levels object.
 679    *
 680    * The ordering is important, since currently we do not have a weight
 681    * scheme. Adding weight is super important and should be done in the
 682    * next week or so, before this can be called complete.
 683    *
 684    * @param string $contactType
 685    * @param bool $status
 686    *
 687    * @return array
 688    *   array of importable Fields
 689    */
 690   public static function &importableFields($contactType = 'Individual', $status = TRUE) {
 691     if (!self::$_importableFields) {
 692       if (!self::$_importableFields) {
 693         self::$_importableFields = array();
 694       }
 695
 696       if (!$status) {
 697         $fields = array('' => array('title' => ts('- do not import -')));
 698       }
 699       else {
 700         $fields = array('' => array('title' => ts('- Contribution Fields -')));
 701       }
 702
 703       $note = CRM_Core_DAO_Note::import();
 704       $tmpFields = CRM_Contribute_DAO_Contribution::import();
 705       unset($tmpFields['option_value']);
 706       $optionFields = CRM_Core_OptionValue::getFields($mode = 'contribute');
 707       $contactFields = CRM_Contact_BAO_Contact::importableFields($contactType, NULL);
 708
 709       // Using new Dedupe rule.
 710       $ruleParams = array(
 711         'contact_type' => $contactType,
 712         'used' => 'Unsupervised',
 713       );
 714       $fieldsArray = CRM_Dedupe_BAO_Rule::dedupeRuleFields($ruleParams);
 715       $tmpContactField = array();
 716       if (is_array($fieldsArray)) {
 717         foreach ($fieldsArray as $value) {
 718           //skip if there is no dupe rule
 719           if ($value == 'none') {
 720             continue;
 721           }
 722           $customFieldId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
 723             $value,
 724             'id',
 725             'column_name'
 726           );
 727           $value = $customFieldId ? 'custom_' . $customFieldId : $value;
 728           $tmpContactField[trim($value)] = $contactFields[trim($value)];
 729           if (!$status) {
 730             $title = $tmpContactField[trim($value)]['title'] . ' ' . ts('(match to contact)');
 731           }
 732           else {
 733             $title = $tmpContactField[trim($value)]['title'];
 734           }
 735           $tmpContactField[trim($value)]['title'] = $title;
 736         }
 737       }
 738
 739       $tmpContactField['external_identifier'] = $contactFields['external_identifier'];
 740       $tmpContactField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . ' ' . ts('(match to contact)');
 741       $tmpFields['contribution_contact_id']['title'] = $tmpFields['contribution_contact_id']['title'] . ' ' . ts('(match to contact)');
 742       $fields = array_merge($fields, $tmpContactField);
 743       $fields = array_merge($fields, $tmpFields);
 744       $fields = array_merge($fields, $note);
 745       $fields = array_merge($fields, $optionFields);
 746       $fields = array_merge($fields, CRM_Financial_DAO_FinancialType::export());
 747       $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Contribution'));
 748       self::$_importableFields = $fields;
 749     }
 750     return self::$_importableFields;
 751   }
 752
 753   /**
 754    * Combine all the exportable fields from the lower level objects.
 755    *
 756    * @param bool $checkPermission
 757    *
 758    * @return array
 759    *   array of exportable Fields
 760    */
 761   public static function &exportableFields($checkPermission = TRUE) {
 762     if (!self::$_exportableFields) {
 763       if (!self::$_exportableFields) {
 764         self::$_exportableFields = array();
 765       }
 766
 767       $impFields = CRM_Contribute_DAO_Contribution::export();
 768       $expFieldProduct = CRM_Contribute_DAO_Product::export();
 769       $expFieldsContrib = CRM_Contribute_DAO_ContributionProduct::export();
 770       $typeField = CRM_Financial_DAO_FinancialType::export();
 771       $financialAccount = CRM_Financial_DAO_FinancialAccount::export();
 772       $optionField = CRM_Core_OptionValue::getFields($mode = 'contribute');
 773       $contributionStatus = array(
 774         'contribution_status' => array(
 775           'title' => ts('Contribution Status'),
 776           'name' => 'contribution_status',
 777           'data_type' => CRM_Utils_Type::T_STRING,
 778         ),
 779       );
 780
 781       $contributionPage = array(
 782         'contribution_page' => array(
 783           'title' => ts('Contribution Page'),
 784           'name' => 'contribution_page',
 785           'where' => 'civicrm_contribution_page.title',
 786           'data_type' => CRM_Utils_Type::T_STRING,
 787         ),
 788       );
 789
 790       $contributionNote = array(
 791         'contribution_note' => array(
 792           'title' => ts('Contribution Note'),
 793           'name' => 'contribution_note',
 794           'data_type' => CRM_Utils_Type::T_TEXT,
 795         ),
 796       );
 797
 798       $contributionRecurId = array(
 799         'contribution_recur_id' => array(
 800           'title' => ts('Recurring Contributions ID'),
 801           'name' => 'contribution_recur_id',
 802           'where' => 'civicrm_contribution.contribution_recur_id',
 803           'data_type' => CRM_Utils_Type::T_INT,
 804         ),
 805       );
 806
 807       $extraFields = array(
 808         'contribution_batch' => array(
 809           'title' => ts('Batch Name'),
 810         ),
 811       );
 812
 813       // CRM-17787
 814       $campaignTitle = array(
 815         'contribution_campaign_title' => array(
 816           'title' => ts('Campaign Title'),
 817           'name' => 'campaign_title',
 818           'where' => 'civicrm_campaign.title',
 819           'data_type' => CRM_Utils_Type::T_STRING,
 820         ),
 821       );
 822       $softCreditFields = array(
 823         'contribution_soft_credit_name' => array(
 824           'name' => 'contribution_soft_credit_name',
 825           'title' => 'Soft Credit For',
 826           'where' => 'civicrm_contact_d.display_name',
 827           'data_type' => CRM_Utils_Type::T_STRING,
 828         ),
 829         'contribution_soft_credit_amount' => array(
 830           'name' => 'contribution_soft_credit_amount',
 831           'title' => 'Soft Credit Amount',
 832           'where' => 'civicrm_contribution_soft.amount',
 833           'data_type' => CRM_Utils_Type::T_MONEY,
 834         ),
 835         'contribution_soft_credit_type' => array(
 836           'name' => 'contribution_soft_credit_type',
 837           'title' => 'Soft Credit Type',
 838           'where' => 'contribution_softcredit_type.label',
 839           'data_type' => CRM_Utils_Type::T_STRING,
 840         ),
 841         'contribution_soft_credit_contribution_id' => array(
 842           'name' => 'contribution_soft_credit_contribution_id',
 843           'title' => 'Soft Credit For Contribution ID',
 844           'where' => 'civicrm_contribution_soft.contribution_id',
 845           'data_type' => CRM_Utils_Type::T_INT,
 846         ),
 847         'contribution_soft_credit_contact_id' => array(
 848           'name' => 'contribution_soft_credit_contact_id',
 849           'title' => 'Soft Credit For Contact ID',
 850           'where' => 'civicrm_contact_d.id',
 851           'data_type' => CRM_Utils_Type::T_INT,
 852         ),
 853       );
 854
 855       // CRM-16713 - contribution search by Premiums on 'Find Contribution' form.
 856       $premiums = array(
 857         'contribution_product_id' => array(
 858           'title' => ts('Premium'),
 859           'name' => 'contribution_product_id',
 860           'where' => 'civicrm_product.id',
 861           'data_type' => CRM_Utils_Type::T_INT,
 862         ),
 863       );
 864
 865       $fields = array_merge($impFields, $typeField, $contributionStatus, $contributionPage, $optionField, $expFieldProduct,
 866         $expFieldsContrib, $contributionNote, $contributionRecurId, $extraFields, $softCreditFields, $financialAccount, $premiums, $campaignTitle,
 867         CRM_Core_BAO_CustomField::getFieldsForImport('Contribution', FALSE, FALSE, FALSE, $checkPermission)
 868       );
 869
 870       self::$_exportableFields = $fields;
 871     }
 872
 873     return self::$_exportableFields;
 874   }
 875
 876   /**
 877    * @param null $status
 878    * @param null $startDate
 879    * @param null $endDate
 880    *
 881    * @return array|null
 882    */
 883   public static function getTotalAmountAndCount($status = NULL, $startDate = NULL, $endDate = NULL) {
 884     $where = array();
 885     switch ($status) {
 886       case 'Valid':
 887         $where[] = 'contribution_status_id = 1';
 888         break;
 889
 890       case 'Cancelled':
 891         $where[] = 'contribution_status_id = 3';
 892         break;
 893     }
 894
 895     if ($startDate) {
 896       $where[] = "receive_date >= '" . CRM_Utils_Type::escape($startDate, 'Timestamp') . "'";
 897     }
 898     if ($endDate) {
 899       $where[] = "receive_date <= '" . CRM_Utils_Type::escape($endDate, 'Timestamp') . "'";
 900     }
 901     CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes);
 902     if ($financialTypes) {
 903       $where[] = "c.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
 904       $where[] = "i.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
 905     }
 906     else {
 907       $where[] = "c.financial_type_id IN (0)";
 908     }
 909
 910     $whereCond = implode(' AND ', $where);
 911
 912     $query = "
 913     SELECT  sum( total_amount ) as total_amount,
 914             count( c.id ) as total_count,
 915             currency
 916       FROM  civicrm_contribution c
 917 INNER JOIN  civicrm_contact contact ON ( contact.id = c.contact_id )
 918 LEFT JOIN  civicrm_line_item i ON ( i.contribution_id = c.id AND i.entity_table = 'civicrm_contribution' )
 919      WHERE  $whereCond
 920        AND  ( is_test = 0 OR is_test IS NULL )
 921        AND  contact.is_deleted = 0
 922   GROUP BY  currency
 923 ";
 924
 925     $dao = CRM_Core_DAO::executeQuery($query);
 926     $amount = array();
 927     $count = 0;
 928     while ($dao->fetch()) {
 929       $count += $dao->total_count;
 930       $amount[] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
 931     }
 932     if ($count) {
 933       return array(
 934         'amount' => implode(', ', $amount),
 935         'count' => $count,
 936       );
 937     }
 938     return NULL;
 939   }
 940
 941   /**
 942    * Delete the indirect records associated with this contribution first.
 943    *
 944    * @param int $id
 945    *
 946    * @return mixed|null
 947    *   $results no of deleted Contribution on success, false otherwise
 948    */
 949   public static function deleteContribution($id) {
 950     CRM_Utils_Hook::pre('delete', 'Contribution', $id, CRM_Core_DAO::$_nullArray);
 951
 952     $transaction = new CRM_Core_Transaction();
 953
 954     $results = NULL;
 955     //delete activity record
 956     $params = array(
 957       'source_record_id' => $id,
 958       // activity type id for contribution
 959       'activity_type_id' => 6,
 960     );
 961
 962     CRM_Activity_BAO_Activity::deleteActivity($params);
 963
 964     //delete billing address if exists for this contribution.
 965     self::deleteAddress($id);
 966
 967     //update pledge and pledge payment, CRM-3961
 968     CRM_Pledge_BAO_PledgePayment::resetPledgePayment($id);
 969
 970     // remove entry from civicrm_price_set_entity, CRM-5095
 971     if (CRM_Price_BAO_PriceSet::getFor('civicrm_contribution', $id)) {
 972       CRM_Price_BAO_PriceSet::removeFrom('civicrm_contribution', $id);
 973     }
 974     // cleanup line items.
 975     $participantId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment', $id, 'participant_id', 'contribution_id');
 976
 977     // delete any related entity_financial_trxn, financial_trxn and financial_item records.
 978     CRM_Core_BAO_FinancialTrxn::deleteFinancialTrxn($id);
 979
 980     if ($participantId) {
 981       CRM_Price_BAO_LineItem::deleteLineItems($participantId, 'civicrm_participant');
 982     }
 983     else {
 984       CRM_Price_BAO_LineItem::deleteLineItems($id, 'civicrm_contribution');
 985     }
 986
 987     //delete note.
 988     $note = CRM_Core_BAO_Note::getNote($id, 'civicrm_contribution');
 989     $noteId = key($note);
 990     if ($noteId) {
 991       CRM_Core_BAO_Note::del($noteId, FALSE);
 992     }
 993
 994     $dao = new CRM_Contribute_DAO_Contribution();
 995     $dao->id = $id;
 996
 997     $results = $dao->delete();
 998
 999     $transaction->commit();
1000
1001     CRM_Utils_Hook::post('delete', 'Contribution', $dao->id, $dao);
1002
1003     // delete the recently created Contribution
1004     $contributionRecent = array(
1005       'id' => $id,
1006       'type' => 'Contribution',
1007     );
1008     CRM_Utils_Recent::del($contributionRecent);
1009
1010     return $results;
1011   }
1012
1013   /**
1014    * React to a financial transaction (payment) failure.
1015    *
1016    * Prior to CRM-16417 these were simply removed from the database but it has been agreed that seeing attempted
1017    * payments is important for forensic and outreach reasons.
1018    *
1019    * @param int $contributionID
1020    * @param int $contactID
1021    * @param string $message
1022    *
1023    * @throws \CiviCRM_API3_Exception
1024    */
1025   public static function failPayment($contributionID, $contactID, $message) {
1026     civicrm_api3('activity', 'create', array(
1027       'activity_type_id' => 'Failed Payment',
1028       'details' => $message,
1029       'subject' => ts('Payment failed at payment processor'),
1030       'source_record_id' => $contributionID,
1031       'source_contact_id' => CRM_Core_Session::getLoggedInContactID() ? CRM_Core_Session::getLoggedInContactID() :
1032         $contactID,
1033     ));
1034   }
1035
1036   /**
1037    * Check if there is a contribution with the same trxn_id or invoice_id.
1038    *
1039    * @param array $input
1040    *   An assoc array of name/value pairs.
1041    * @param array $duplicates
1042    *   (reference) store ids of duplicate contribs.
1043    * @param int $id
1044    *
1045    * @return bool
1046    *   true if duplicate, false otherwise
1047    */
1048   public static function checkDuplicate($input, &$duplicates, $id = NULL) {
1049     if (!$id) {
1050       $id = CRM_Utils_Array::value('id', $input);
1051     }
1052     $trxn_id = CRM_Utils_Array::value('trxn_id', $input);
1053     $invoice_id = CRM_Utils_Array::value('invoice_id', $input);
1054
1055     $clause = array();
1056     $input = array();
1057
1058     if ($trxn_id) {
1059       $clause[] = "trxn_id = %1";
1060       $input[1] = array($trxn_id, 'String');
1061     }
1062
1063     if ($invoice_id) {
1064       $clause[] = "invoice_id = %2";
1065       $input[2] = array($invoice_id, 'String');
1066     }
1067
1068     if (empty($clause)) {
1069       return FALSE;
1070     }
1071
1072     $clause = implode(' OR ', $clause);
1073     if ($id) {
1074       $clause = "( $clause ) AND id != %3";
1075       $input[3] = array($id, 'Integer');
1076     }
1077
1078     $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1079     $dao = CRM_Core_DAO::executeQuery($query, $input);
1080     $result = FALSE;
1081     while ($dao->fetch()) {
1082       $duplicates[] = $dao->id;
1083       $result = TRUE;
1084     }
1085     return $result;
1086   }
1087
1088   /**
1089    * Takes an associative array and creates a contribution_product object.
1090    *
1091    * the function extract all the params it needs to initialize the create a
1092    * contribution_product object. the params array could contain additional unused name/value
1093    * pairs
1094    *
1095    * @param array $params
1096    *   (reference) an assoc array of name/value pairs.
1097    *
1098    * @return CRM_Contribute_DAO_ContributionProduct
1099    */
1100   public static function addPremium(&$params) {
1101     $contributionProduct = new CRM_Contribute_DAO_ContributionProduct();
1102     $contributionProduct->copyValues($params);
1103     return $contributionProduct->save();
1104   }
1105
1106   /**
1107    * Get list of contribution fields for profile.
1108    * For now we only allow custom contribution fields to be in
1109    * profile
1110    *
1111    * @param bool $addExtraFields
1112    *   True if special fields needs to be added.
1113    *
1114    * @return array
1115    *   the list of contribution fields
1116    */
1117   public static function getContributionFields($addExtraFields = TRUE) {
1118     $contributionFields = CRM_Contribute_DAO_Contribution::export();
1119     $contributionFields = array_merge($contributionFields, CRM_Core_OptionValue::getFields($mode = 'contribute'));
1120
1121     if ($addExtraFields) {
1122       $contributionFields = array_merge($contributionFields, self::getSpecialContributionFields());
1123     }
1124
1125     $contributionFields = array_merge($contributionFields, CRM_Financial_DAO_FinancialType::export());
1126
1127     foreach ($contributionFields as $key => $var) {
1128       if ($key == 'contribution_contact_id') {
1129         continue;
1130       }
1131       elseif ($key == 'contribution_campaign_id') {
1132         $var['title'] = ts('Campaign');
1133       }
1134       $fields[$key] = $var;
1135     }
1136
1137     $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Contribution'));
1138     return $fields;
1139   }
1140
1141   /**
1142    * Add extra fields specific to contribution.
1143    */
1144   public static function getSpecialContributionFields() {
1145     $extraFields = array(
1146       'contribution_soft_credit_name' => array(
1147         'name' => 'contribution_soft_credit_name',
1148         'title' => 'Soft Credit Name',
1149         'headerPattern' => '/^soft_credit_name$/i',
1150         'where' => 'civicrm_contact_d.display_name',
1151       ),
1152       'contribution_soft_credit_email' => array(
1153         'name' => 'contribution_soft_credit_email',
1154         'title' => 'Soft Credit Email',
1155         'headerPattern' => '/^soft_credit_email$/i',
1156         'where' => 'soft_email.email',
1157       ),
1158       'contribution_soft_credit_phone' => array(
1159         'name' => 'contribution_soft_credit_phone',
1160         'title' => 'Soft Credit Phone',
1161         'headerPattern' => '/^soft_credit_phone$/i',
1162         'where' => 'soft_phone.phone',
1163       ),
1164       'contribution_soft_credit_contact_id' => array(
1165         'name' => 'contribution_soft_credit_contact_id',
1166         'title' => 'Soft Credit Contact ID',
1167         'headerPattern' => '/^soft_credit_contact_id$/i',
1168         'where' => 'civicrm_contribution_soft.contact_id',
1169       ),
1170       'contribution_pcp_title' => array(
1171         'name' => 'contribution_pcp_title',
1172         'title' => 'Personal Campaign Page Title',
1173         'headerPattern' => '/^contribution_pcp_title$/i',
1174         'where' => 'contribution_pcp.title',
1175       ),
1176     );
1177
1178     return $extraFields;
1179   }
1180
1181   /**
1182    * @param int $pageID
1183    *
1184    * @return array
1185    */
1186   public static function getCurrentandGoalAmount($pageID) {
1187     $query = "
1188 SELECT p.goal_amount as goal, sum( c.total_amount ) as total
1189   FROM civicrm_contribution_page p,
1190        civicrm_contribution      c
1191  WHERE p.id = c.contribution_page_id
1192    AND p.id = %1
1193    AND c.cancel_date is null
1194 GROUP BY p.id
1195 ";
1196
1197     $config = CRM_Core_Config::singleton();
1198     $params = array(1 => array($pageID, 'Integer'));
1199     $dao = CRM_Core_DAO::executeQuery($query, $params);
1200
1201     if ($dao->fetch()) {
1202       return array($dao->goal, $dao->total);
1203     }
1204     else {
1205       return array(NULL, NULL);
1206     }
1207   }
1208
1209   /**
1210    * Get list of contribution In Honor of contact Ids.
1211    *
1212    * @param int $honorId
1213    *   In Honor of Contact ID.
1214    *
1215    * @return array
1216    *   list of contribution fields
1217    */
1218   public static function getHonorContacts($honorId) {
1219     $params = array();
1220     $honorDAO = new CRM_Contribute_DAO_ContributionSoft();
1221     $honorDAO->contact_id = $honorId;
1222     $honorDAO->find();
1223
1224     $type = CRM_Contribute_PseudoConstant::financialType();
1225
1226     while ($honorDAO->fetch()) {
1227       $contributionDAO = new CRM_Contribute_DAO_Contribution();
1228       $contributionDAO->id = $honorDAO->contribution_id;
1229
1230       if ($contributionDAO->find(TRUE)) {
1231         $params[$contributionDAO->id]['honor_type'] = CRM_Core_PseudoConstant::getLabel('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', $honorDAO->soft_credit_type_id);
1232         $params[$contributionDAO->id]['honorId'] = $contributionDAO->contact_id;
1233         $params[$contributionDAO->id]['display_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contributionDAO->contact_id, 'display_name');
1234         $params[$contributionDAO->id]['type'] = $type[$contributionDAO->financial_type_id];
1235         $params[$contributionDAO->id]['type_id'] = $contributionDAO->financial_type_id;
1236         $params[$contributionDAO->id]['amount'] = CRM_Utils_Money::format($contributionDAO->total_amount, $contributionDAO->currency);
1237         $params[$contributionDAO->id]['source'] = $contributionDAO->source;
1238         $params[$contributionDAO->id]['receive_date'] = $contributionDAO->receive_date;
1239         $params[$contributionDAO->id]['contribution_status'] = CRM_Contribute_PseudoConstant::contributionStatus($contributionDAO->contribution_status_id);
1240       }
1241     }
1242
1243     return $params;
1244   }
1245
1246   /**
1247    * Get the sort name of a contact for a particular contribution.
1248    *
1249    * @param int $id
1250    *   Id of the contribution.
1251    *
1252    * @return null|string
1253    *   sort name of the contact if found
1254    */
1255   public static function sortName($id) {
1256     $id = CRM_Utils_Type::escape($id, 'Integer');
1257
1258     $query = "
1259 SELECT civicrm_contact.sort_name
1260 FROM   civicrm_contribution, civicrm_contact
1261 WHERE  civicrm_contribution.contact_id = civicrm_contact.id
1262   AND  civicrm_contribution.id = {$id}
1263 ";
1264     return CRM_Core_DAO::singleValueQuery($query);
1265   }
1266
1267   /**
1268    * @param int $contactID
1269    *
1270    * @return array
1271    */
1272   public static function annual($contactID) {
1273     if (is_array($contactID)) {
1274       $contactIDs = implode(',', $contactID);
1275     }
1276     else {
1277       $contactIDs = $contactID;
1278     }
1279
1280     $config = CRM_Core_Config::singleton();
1281     $startDate = $endDate = NULL;
1282
1283     $currentMonth = date('m');
1284     $currentDay = date('d');
1285     if ((int ) $config->fiscalYearStart['M'] > $currentMonth ||
1286       ((int ) $config->fiscalYearStart['M'] == $currentMonth &&
1287         (int ) $config->fiscalYearStart['d'] > $currentDay
1288       )
1289     ) {
1290       $year = date('Y') - 1;
1291     }
1292     else {
1293       $year = date('Y');
1294     }
1295     $nextYear = $year + 1;
1296
1297     if ($config->fiscalYearStart) {
1298       $newFiscalYearStart = $config->fiscalYearStart;
1299       if ($newFiscalYearStart['M'] < 10) {
1300         $newFiscalYearStart['M'] = '0' . $newFiscalYearStart['M'];
1301       }
1302       if ($newFiscalYearStart['d'] < 10) {
1303         $newFiscalYearStart['d'] = '0' . $newFiscalYearStart['d'];
1304       }
1305       $config->fiscalYearStart = $newFiscalYearStart;
1306       $monthDay = $config->fiscalYearStart['M'] . $config->fiscalYearStart['d'];
1307     }
1308     else {
1309       $monthDay = '0101';
1310     }
1311     $startDate = "$year$monthDay";
1312     $endDate = "$nextYear$monthDay";
1313     CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes);
1314     $additionalWhere = " AND b.financial_type_id IN (0)";
1315     $liWhere = " AND i.financial_type_id IN (0)";
1316     if (!empty($financialTypes)) {
1317       $additionalWhere = " AND b.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ") AND i.id IS NULL";
1318       $liWhere = " AND i.financial_type_id NOT IN (" . implode(',', array_keys($financialTypes)) . ")";
1319     }
1320     $query = "
1321       SELECT count(*) as count,
1322              sum(total_amount) as amount,
1323              avg(total_amount) as average,
1324              currency
1325         FROM civicrm_contribution b
1326         LEFT JOIN civicrm_line_item i ON i.contribution_id = b.id AND i.entity_table = 'civicrm_contribution' $liWhere
1327        WHERE b.contact_id IN ( $contactIDs )
1328          AND b.contribution_status_id = 1
1329          AND b.is_test = 0
1330          AND b.receive_date >= $startDate
1331          AND b.receive_date <  $endDate
1332       $additionalWhere
1333       GROUP BY currency
1334       ";
1335     $dao = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
1336     $count = 0;
1337     $amount = $average = array();
1338     while ($dao->fetch()) {
1339       if ($dao->count > 0 && $dao->amount > 0) {
1340         $count += $dao->count;
1341         $amount[] = CRM_Utils_Money::format($dao->amount, $dao->currency);
1342         $average[] = CRM_Utils_Money::format($dao->average, $dao->currency);
1343       }
1344     }
1345     if ($count > 0) {
1346       return array(
1347         $count,
1348         implode(',&nbsp;', $amount),
1349         implode(',&nbsp;', $average),
1350       );
1351     }
1352     return array(0, 0, 0);
1353   }
1354
1355   /**
1356    * Check if there is a contribution with the params passed in.
1357    *
1358    * Used for trxn_id,invoice_id and contribution_id
1359    *
1360    * @param array $params
1361    *   An assoc array of name/value pairs.
1362    *
1363    * @return array
1364    *   contribution id if success else NULL
1365    */
1366   public static function checkDuplicateIds($params) {
1367     $dao = new CRM_Contribute_DAO_Contribution();
1368
1369     $clause = array();
1370     $input = array();
1371     foreach ($params as $k => $v) {
1372       if ($v) {
1373         $clause[] = "$k = '$v'";
1374       }
1375     }
1376     $clause = implode(' AND ', $clause);
1377     $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1378     $dao = CRM_Core_DAO::executeQuery($query, $input);
1379
1380     while ($dao->fetch()) {
1381       $result = $dao->id;
1382       return $result;
1383     }
1384     return NULL;
1385   }
1386
1387   /**
1388    * Get the contribution details for component export.
1389    *
1390    * @param int $exportMode
1391    *   Export mode.
1392    * @param string $componentIds
1393    *   Component ids.
1394    *
1395    * @return array
1396    *   associated array
1397    */
1398   public static function getContributionDetails($exportMode, $componentIds) {
1399     $paymentDetails = array();
1400     $componentClause = ' IN ( ' . implode(',', $componentIds) . ' ) ';
1401
1402     if ($exportMode == CRM_Export_Form_Select::EVENT_EXPORT) {
1403       $componentSelect = " civicrm_participant_payment.participant_id id";
1404       $additionalClause = "
1405 INNER JOIN civicrm_participant_payment ON (civicrm_contribution.id = civicrm_participant_payment.contribution_id
1406 AND civicrm_participant_payment.participant_id {$componentClause} )
1407 ";
1408     }
1409     elseif ($exportMode == CRM_Export_Form_Select::MEMBER_EXPORT) {
1410       $componentSelect = " civicrm_membership_payment.membership_id id";
1411       $additionalClause = "
1412 INNER JOIN civicrm_membership_payment ON (civicrm_contribution.id = civicrm_membership_payment.contribution_id
1413 AND civicrm_membership_payment.membership_id {$componentClause} )
1414 ";
1415     }
1416     elseif ($exportMode == CRM_Export_Form_Select::PLEDGE_EXPORT) {
1417       $componentSelect = " civicrm_pledge_payment.id id";
1418       $additionalClause = "
1419 INNER JOIN civicrm_pledge_payment ON (civicrm_contribution.id = civicrm_pledge_payment.contribution_id
1420 AND civicrm_pledge_payment.pledge_id {$componentClause} )
1421 ";
1422     }
1423
1424     $query = " SELECT total_amount, contribution_status.name as status_id, contribution_status.label as status, payment_instrument.name as payment_instrument, receive_date,
1425                           trxn_id, {$componentSelect}
1426 FROM civicrm_contribution
1427 LEFT JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')
1428 LEFT JOIN civicrm_option_value payment_instrument ON (civicrm_contribution.payment_instrument_id = payment_instrument.value
1429      AND option_group_payment_instrument.id = payment_instrument.option_group_id )
1430 LEFT JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')
1431 LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
1432                                AND option_group_contribution_status.id = contribution_status.option_group_id )
1433 {$additionalClause}
1434 ";
1435
1436     $dao = CRM_Core_DAO::executeQuery($query);
1437
1438     while ($dao->fetch()) {
1439       $paymentDetails[$dao->id] = array(
1440         'total_amount' => $dao->total_amount,
1441         'contribution_status' => $dao->status,
1442         'receive_date' => $dao->receive_date,
1443         'pay_instru' => $dao->payment_instrument,
1444         'trxn_id' => $dao->trxn_id,
1445       );
1446     }
1447
1448     return $paymentDetails;
1449   }
1450
1451   /**
1452    * Create address associated with contribution record.
1453    *
1454    * As long as there is one or more billing field in the parameters we will create the address.
1455    *
1456    * (historically the decision to create or not was based on the payment 'type' but these lines are greyer than once
1457    * thought).
1458    *
1459    * @param array $params
1460    * @param int $billingLocationTypeID
1461    *
1462    * @return int
1463    *   address id
1464    */
1465   public static function createAddress($params, $billingLocationTypeID) {
1466     list($hasBillingField, $addressParams) = self::getBillingAddressParams($params, $billingLocationTypeID);
1467     if ($hasBillingField) {
1468       $address = CRM_Core_BAO_Address::add($addressParams, FALSE);
1469       return $address->id;
1470     }
1471     return NULL;
1472
1473   }
1474
1475   /**
1476    * Delete billing address record related contribution.
1477    *
1478    * @param int $contributionId
1479    * @param int $contactId
1480    */
1481   public static function deleteAddress($contributionId = NULL, $contactId = NULL) {
1482     $clauses = array();
1483     $contactJoin = NULL;
1484
1485     if ($contributionId) {
1486       $clauses[] = "cc.id = {$contributionId}";
1487     }
1488
1489     if ($contactId) {
1490       $clauses[] = "cco.id = {$contactId}";
1491       $contactJoin = "INNER JOIN civicrm_contact cco ON cc.contact_id = cco.id";
1492     }
1493
1494     if (empty($clauses)) {
1495       CRM_Core_Error::fatal();
1496     }
1497
1498     $condition = implode(' OR ', $clauses);
1499
1500     $query = "
1501 SELECT     ca.id
1502 FROM       civicrm_address ca
1503 INNER JOIN civicrm_contribution cc ON cc.address_id = ca.id
1504            $contactJoin
1505 WHERE      $condition
1506 ";
1507     $dao = CRM_Core_DAO::executeQuery($query);
1508
1509     while ($dao->fetch()) {
1510       $params = array('id' => $dao->id);
1511       CRM_Core_BAO_Block::blockDelete('Address', $params);
1512     }
1513   }
1514
1515   /**
1516    * This function check online pending contribution associated w/
1517    * Online Event Registration or Online Membership signup.
1518    *
1519    * @param int $componentId
1520    *   Participant/membership id.
1521    * @param string $componentName
1522    *   Event/Membership.
1523    *
1524    * @return int
1525    *   pending contribution id.
1526    */
1527   public static function checkOnlinePendingContribution($componentId, $componentName) {
1528     $contributionId = NULL;
1529     if (!$componentId ||
1530       !in_array($componentName, array('Event', 'Membership'))
1531     ) {
1532       return $contributionId;
1533     }
1534
1535     if ($componentName == 'Event') {
1536       $idName = 'participant_id';
1537       $componentTable = 'civicrm_participant';
1538       $paymentTable = 'civicrm_participant_payment';
1539       $source = ts('Online Event Registration');
1540     }
1541
1542     if ($componentName == 'Membership') {
1543       $idName = 'membership_id';
1544       $componentTable = 'civicrm_membership';
1545       $paymentTable = 'civicrm_membership_payment';
1546       $source = ts('Online Contribution');
1547     }
1548
1549     $pendingStatusId = array_search('Pending', CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'));
1550
1551     $query = "
1552    SELECT  component.id as {$idName},
1553            componentPayment.contribution_id as contribution_id,
1554            contribution.source source,
1555            contribution.contribution_status_id as contribution_status_id,
1556            contribution.is_pay_later as is_pay_later
1557      FROM  $componentTable component
1558 LEFT JOIN  $paymentTable componentPayment    ON ( componentPayment.{$idName} = component.id )
1559 LEFT JOIN  civicrm_contribution contribution ON ( componentPayment.contribution_id = contribution.id )
1560     WHERE  component.id = {$componentId}";
1561
1562     $dao = CRM_Core_DAO::executeQuery($query);
1563
1564     while ($dao->fetch()) {
1565       if ($dao->contribution_id &&
1566         $dao->is_pay_later &&
1567         $dao->contribution_status_id == $pendingStatusId &&
1568         strpos($dao->source, $source) !== FALSE
1569       ) {
1570         $contributionId = $dao->contribution_id;
1571         $dao->free();
1572       }
1573     }
1574
1575     return $contributionId;
1576   }
1577
1578   /**
1579    * Update contribution as well as related objects.
1580    *
1581    * This function by-passes hooks - to address this - don't use this function.
1582    *
1583    * @deprecated
1584    *
1585    * Use api contribute.completetransaction
1586    * For failures use failPayment (preferably exposing by api in the process).
1587    *
1588    * @param array $params
1589    * @param bool $processContributionObject
1590    *
1591    * @return array
1592    * @throws \Exception
1593    */
1594   public static function transitionComponents($params, $processContributionObject = FALSE) {
1595     // get minimum required values.
1596     $contactId = CRM_Utils_Array::value('contact_id', $params);
1597     $componentId = CRM_Utils_Array::value('component_id', $params);
1598     $componentName = CRM_Utils_Array::value('componentName', $params);
1599     $contributionId = CRM_Utils_Array::value('contribution_id', $params);
1600     $contributionStatusId = CRM_Utils_Array::value('contribution_status_id', $params);
1601
1602     // if we already processed contribution object pass previous status id.
1603     $previousContriStatusId = CRM_Utils_Array::value('previous_contribution_status_id', $params);
1604
1605     $updateResult = array();
1606
1607     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
1608
1609     // we process only ( Completed, Cancelled, or Failed ) contributions.
1610     if (!$contributionId ||
1611       !in_array($contributionStatusId, array(
1612         array_search('Completed', $contributionStatuses),
1613         array_search('Cancelled', $contributionStatuses),
1614         array_search('Failed', $contributionStatuses),
1615       ))
1616     ) {
1617       return $updateResult;
1618     }
1619
1620     if (!$componentName || !$componentId) {
1621       // get the related component details.
1622       $componentDetails = self::getComponentDetails($contributionId);
1623     }
1624     else {
1625       $componentDetails['contact_id'] = $contactId;
1626       $componentDetails['component'] = $componentName;
1627
1628       if ($componentName == 'event') {
1629         $componentDetails['participant'] = $componentId;
1630       }
1631       else {
1632         $componentDetails['membership'] = $componentId;
1633       }
1634     }
1635
1636     if (!empty($componentDetails['contact_id'])) {
1637       $componentDetails['contact_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
1638         $contributionId,
1639         'contact_id'
1640       );
1641     }
1642
1643     // do check for required ids.
1644     if (empty($componentDetails['membership']) && empty($componentDetails['participant']) && empty($componentDetails['pledge_payment']) || empty($componentDetails['contact_id'])) {
1645       return $updateResult;
1646     }
1647
1648     //now we are ready w/ required ids, start processing.
1649
1650     $baseIPN = new CRM_Core_Payment_BaseIPN();
1651
1652     $input = $ids = $objects = array();
1653
1654     $input['component'] = CRM_Utils_Array::value('component', $componentDetails);
1655     $ids['contribution'] = $contributionId;
1656     $ids['contact'] = CRM_Utils_Array::value('contact_id', $componentDetails);
1657     $ids['membership'] = CRM_Utils_Array::value('membership', $componentDetails);
1658     $ids['participant'] = CRM_Utils_Array::value('participant', $componentDetails);
1659     $ids['event'] = CRM_Utils_Array::value('event', $componentDetails);
1660     $ids['pledge_payment'] = CRM_Utils_Array::value('pledge_payment', $componentDetails);
1661     $ids['contributionRecur'] = NULL;
1662     $ids['contributionPage'] = NULL;
1663
1664     if (!$baseIPN->validateData($input, $ids, $objects, FALSE)) {
1665       CRM_Core_Error::fatal();
1666     }
1667
1668     $memberships = &$objects['membership'];
1669     $participant = &$objects['participant'];
1670     $pledgePayment = &$objects['pledge_payment'];
1671     $contribution = &$objects['contribution'];
1672
1673     if ($pledgePayment) {
1674       $pledgePaymentIDs = array();
1675       foreach ($pledgePayment as $key => $object) {
1676         $pledgePaymentIDs[] = $object->id;
1677       }
1678       $pledgeID = $pledgePayment[0]->pledge_id;
1679     }
1680
1681     $membershipStatuses = CRM_Member_PseudoConstant::membershipStatus();
1682
1683     if ($participant) {
1684       $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
1685       $oldStatus = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant',
1686         $participant->id,
1687         'status_id'
1688       );
1689     }
1690     // we might want to process contribution object.
1691     $processContribution = FALSE;
1692     if ($contributionStatusId == array_search('Cancelled', $contributionStatuses)) {
1693       if (is_array($memberships)) {
1694         foreach ($memberships as $membership) {
1695           if ($membership) {
1696             $membership->status_id = array_search('Cancelled', $membershipStatuses);
1697             $membership->save();
1698
1699             $updateResult['updatedComponents']['CiviMember'] = $membership->status_id;
1700             if ($processContributionObject) {
1701               $processContribution = TRUE;
1702             }
1703           }
1704         }
1705       }
1706
1707       if ($participant) {
1708         $updatedStatusId = array_search('Cancelled', $participantStatuses);
1709         CRM_Event_BAO_Participant::updateParticipantStatus($participant->id, $oldStatus, $updatedStatusId, TRUE);
1710
1711         $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1712         if ($processContributionObject) {
1713           $processContribution = TRUE;
1714         }
1715       }
1716
1717       if ($pledgePayment) {
1718         CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1719
1720         $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1721         if ($processContributionObject) {
1722           $processContribution = TRUE;
1723         }
1724       }
1725     }
1726     elseif ($contributionStatusId == array_search('Failed', $contributionStatuses)) {
1727       if (is_array($memberships)) {
1728         foreach ($memberships as $membership) {
1729           if ($membership) {
1730             $membership->status_id = array_search('Expired', $membershipStatuses);
1731             $membership->save();
1732
1733             $updateResult['updatedComponents']['CiviMember'] = $membership->status_id;
1734             if ($processContributionObject) {
1735               $processContribution = TRUE;
1736             }
1737           }
1738         }
1739       }
1740       if ($participant) {
1741         $updatedStatusId = array_search('Cancelled', $participantStatuses);
1742         CRM_Event_BAO_Participant::updateParticipantStatus($participant->id, $oldStatus, $updatedStatusId, TRUE);
1743
1744         $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1745         if ($processContributionObject) {
1746           $processContribution = TRUE;
1747         }
1748       }
1749
1750       if ($pledgePayment) {
1751         CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1752
1753         $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1754         if ($processContributionObject) {
1755           $processContribution = TRUE;
1756         }
1757       }
1758     }
1759     elseif ($contributionStatusId == array_search('Completed', $contributionStatuses)) {
1760
1761       // only pending contribution related object processed.
1762       if ($previousContriStatusId &&
1763         ($previousContriStatusId != array_search('Pending', $contributionStatuses))
1764       ) {
1765         // this is case when we already processed contribution object.
1766         return $updateResult;
1767       }
1768       elseif (!$previousContriStatusId &&
1769         $contribution->contribution_status_id != array_search('Pending', $contributionStatuses)
1770       ) {
1771         // this is case when we are going to process contribution object later.
1772         return $updateResult;
1773       }
1774
1775       if (is_array($memberships)) {
1776         foreach ($memberships as $membership) {
1777           if ($membership) {
1778             $format = '%Y%m%d';
1779
1780             //CRM-4523
1781             $currentMembership = CRM_Member_BAO_Membership::getContactMembership($membership->contact_id,
1782               $membership->membership_type_id,
1783               $membership->is_test, $membership->id
1784             );
1785
1786             // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
1787             // this picks up membership type changes during renewals
1788             $sql = "
1789               SELECT    membership_type_id
1790               FROM      civicrm_membership_log
1791               WHERE     membership_id=$membership->id
1792               ORDER BY  id DESC
1793               LIMIT     1;";
1794             $dao = new CRM_Core_DAO();
1795             $dao->query($sql);
1796             if ($dao->fetch()) {
1797               if (!empty($dao->membership_type_id)) {
1798                 $membership->membership_type_id = $dao->membership_type_id;
1799                 $membership->save();
1800               }
1801             }
1802             // else fall back to using current membership type
1803             $dao->free();
1804
1805             // Figure out number of terms
1806             $numterms = 1;
1807             $lineitems = CRM_Price_BAO_LineItem::getLineItems($contributionId, 'contribution');
1808             foreach ($lineitems as $lineitem) {
1809               if ($membership->membership_type_id == CRM_Utils_Array::value('membership_type_id', $lineitem)) {
1810                 $numterms = CRM_Utils_Array::value('membership_num_terms', $lineitem);
1811
1812                 // in case membership_num_terms comes through as null or zero
1813                 $numterms = $numterms >= 1 ? $numterms : 1;
1814                 break;
1815               }
1816             }
1817
1818             // CRM-15735-to update the membership status as per the contribution receive date
1819             $joinDate = NULL;
1820             if (!empty($params['receive_date'])) {
1821               $joinDate = $params['receive_date'];
1822               $status = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($membership->start_date,
1823                 $membership->end_date,
1824                 $membership->join_date,
1825                 $params['receive_date'],
1826                 FALSE,
1827                 $membership->membership_type_id,
1828                 (array) $membership
1829               );
1830               $membership->status_id = CRM_Utils_Array::value('id', $status, $membership->status_id);
1831               $membership->save();
1832             }
1833
1834             if ($currentMembership) {
1835               CRM_Member_BAO_Membership::fixMembershipStatusBeforeRenew($currentMembership, NULL);
1836               $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($membership->id, NULL, NULL, $numterms);
1837               $dates['join_date'] = CRM_Utils_Date::customFormat($currentMembership['join_date'], $format);
1838             }
1839             else {
1840               $dates = CRM_Member_BAO_MembershipType::getDatesForMembershipType($membership->membership_type_id, $joinDate, NULL, NULL, $numterms);
1841             }
1842
1843             //get the status for membership.
1844             $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($dates['start_date'],
1845               $dates['end_date'],
1846               $dates['join_date'],
1847               'today',
1848               TRUE,
1849               $membership->membership_type_id,
1850               (array) $membership
1851             );
1852
1853             $formattedParams = array(
1854               'status_id' => CRM_Utils_Array::value('id', $calcStatus,
1855                 array_search('Current', $membershipStatuses)
1856               ),
1857               'join_date' => CRM_Utils_Date::customFormat($dates['join_date'], $format),
1858               'start_date' => CRM_Utils_Date::customFormat($dates['start_date'], $format),
1859               'end_date' => CRM_Utils_Date::customFormat($dates['end_date'], $format),
1860             );
1861
1862             CRM_Utils_Hook::pre('edit', 'Membership', $membership->id, $formattedParams);
1863
1864             $membership->copyValues($formattedParams);
1865             $membership->save();
1866
1867             //updating the membership log
1868             $membershipLog = array();
1869             $membershipLog = $formattedParams;
1870             $logStartDate = CRM_Utils_Date::customFormat(CRM_Utils_Array::value('log_start_date', $dates), $format);
1871             $logStartDate = ($logStartDate) ? CRM_Utils_Date::isoToMysql($logStartDate) : $formattedParams['start_date'];
1872
1873             $membershipLog['start_date'] = $logStartDate;
1874             $membershipLog['membership_id'] = $membership->id;
1875             $membershipLog['modified_id'] = $membership->contact_id;
1876             $membershipLog['modified_date'] = date('Ymd');
1877             $membershipLog['membership_type_id'] = $membership->membership_type_id;
1878
1879             CRM_Member_BAO_MembershipLog::add($membershipLog, CRM_Core_DAO::$_nullArray);
1880
1881             //update related Memberships.
1882             CRM_Member_BAO_Membership::updateRelatedMemberships($membership->id, $formattedParams);
1883
1884             $updateResult['membership_end_date'] = CRM_Utils_Date::customFormat($dates['end_date'],
1885               '%B %E%f, %Y'
1886             );
1887             $updateResult['updatedComponents']['CiviMember'] = $membership->status_id;
1888             if ($processContributionObject) {
1889               $processContribution = TRUE;
1890             }
1891
1892             CRM_Utils_Hook::post('edit', 'Membership', $membership->id, $membership);
1893           }
1894         }
1895       }
1896
1897       if ($participant) {
1898         $updatedStatusId = array_search('Registered', $participantStatuses);
1899         CRM_Event_BAO_Participant::updateParticipantStatus($participant->id, $oldStatus, $updatedStatusId, TRUE);
1900
1901         $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1902         if ($processContributionObject) {
1903           $processContribution = TRUE;
1904         }
1905       }
1906
1907       if ($pledgePayment) {
1908         CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1909
1910         $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1911         if ($processContributionObject) {
1912           $processContribution = TRUE;
1913         }
1914       }
1915     }
1916
1917     // process contribution object.
1918     if ($processContribution) {
1919       $contributionParams = array();
1920       $fields = array(
1921         'contact_id',
1922         'total_amount',
1923         'receive_date',
1924         'is_test',
1925         'campaign_id',
1926         'payment_instrument_id',
1927         'trxn_id',
1928         'invoice_id',
1929         'financial_type_id',
1930         'contribution_status_id',
1931         'non_deductible_amount',
1932         'receipt_date',
1933         'check_number',
1934       );
1935       foreach ($fields as $field) {
1936         if (empty($params[$field])) {
1937           continue;
1938         }
1939         $contributionParams[$field] = $params[$field];
1940       }
1941
1942       $ids = array('contribution' => $contributionId);
1943       $contribution = CRM_Contribute_BAO_Contribution::create($contributionParams, $ids);
1944     }
1945
1946     return $updateResult;
1947   }
1948
1949   /**
1950    * Returns all contribution related object ids.
1951    *
1952    * @param $contributionId
1953    *
1954    * @return array
1955    */
1956   public static function getComponentDetails($contributionId) {
1957     $componentDetails = $pledgePayment = array();
1958     if (!$contributionId) {
1959       return $componentDetails;
1960     }
1961
1962     $query = "
1963       SELECT    c.id                 as contribution_id,
1964                 c.contact_id         as contact_id,
1965                 c.contribution_recur_id,
1966                 mp.membership_id     as membership_id,
1967                 m.membership_type_id as membership_type_id,
1968                 pp.participant_id    as participant_id,
1969                 p.event_id           as event_id,
1970                 pgp.id               as pledge_payment_id
1971       FROM      civicrm_contribution c
1972       LEFT JOIN civicrm_membership_payment  mp   ON mp.contribution_id = c.id
1973       LEFT JOIN civicrm_participant_payment pp   ON pp.contribution_id = c.id
1974       LEFT JOIN civicrm_participant         p    ON pp.participant_id  = p.id
1975       LEFT JOIN civicrm_membership          m    ON m.id  = mp.membership_id
1976       LEFT JOIN civicrm_pledge_payment      pgp  ON pgp.contribution_id  = c.id
1977       WHERE     c.id = $contributionId";
1978
1979     $dao = CRM_Core_DAO::executeQuery($query);
1980     $componentDetails = array();
1981
1982     while ($dao->fetch()) {
1983       $componentDetails['component'] = $dao->participant_id ? 'event' : 'contribute';
1984       $componentDetails['contact_id'] = $dao->contact_id;
1985       if ($dao->event_id) {
1986         $componentDetails['event'] = $dao->event_id;
1987       }
1988       if ($dao->participant_id) {
1989         $componentDetails['participant'] = $dao->participant_id;
1990       }
1991       if ($dao->membership_id) {
1992         if (!isset($componentDetails['membership'])) {
1993           $componentDetails['membership'] = $componentDetails['membership_type'] = array();
1994         }
1995         $componentDetails['membership'][] = $dao->membership_id;
1996         $componentDetails['membership_type'][] = $dao->membership_type_id;
1997       }
1998       if ($dao->pledge_payment_id) {
1999         $pledgePayment[] = $dao->pledge_payment_id;
2000       }
2001       if ($dao->contribution_recur_id) {
2002         $componentDetails['contributionRecur'] = $dao->contribution_recur_id;
2003       }
2004     }
2005
2006     if ($pledgePayment) {
2007       $componentDetails['pledge_payment'] = $pledgePayment;
2008     }
2009
2010     return $componentDetails;
2011   }
2012
2013   /**
2014    * @param int $contactId
2015    * @param bool $includeSoftCredit
2016    *
2017    * @return null|string
2018    */
2019   public static function contributionCount($contactId, $includeSoftCredit = TRUE) {
2020     if (!$contactId) {
2021       return 0;
2022     }
2023     CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes);
2024     $additionalWhere = " AND contribution.financial_type_id IN (0)";
2025     $liWhere = " AND i.financial_type_id IN (0)";
2026     if (!empty($financialTypes)) {
2027       $additionalWhere = " AND contribution.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
2028       $liWhere = " AND i.financial_type_id NOT IN (" . implode(',', array_keys($financialTypes)) . ")";
2029     }
2030     $contactContributionsSQL = "
2031       SELECT contribution.id AS id
2032       FROM civicrm_contribution contribution
2033       LEFT JOIN civicrm_line_item i ON i.contribution_id = contribution.id AND i.entity_table = 'civicrm_contribution' $liWhere
2034       WHERE contribution.is_test = 0 AND contribution.contact_id = {$contactId}
2035       $additionalWhere
2036       AND i.id IS NULL";
2037
2038     $contactSoftCreditContributionsSQL = "
2039       SELECT contribution.id
2040       FROM civicrm_contribution contribution INNER JOIN civicrm_contribution_soft softContribution
2041       ON ( contribution.id = softContribution.contribution_id )
2042       WHERE contribution.is_test = 0 AND softContribution.contact_id = {$contactId} ";
2043     $query = "SELECT count( x.id ) count FROM ( ";
2044     $query .= $contactContributionsSQL;
2045
2046     if ($includeSoftCredit) {
2047       $query .= " UNION ";
2048       $query .= $contactSoftCreditContributionsSQL;
2049     }
2050
2051     $query .= ") x";
2052
2053     return CRM_Core_DAO::singleValueQuery($query);
2054   }
2055
2056   /**
2057    * Repeat a transaction as part of a recurring series.
2058    *
2059    * Only call this via the api as it is being refactored. The intention is that the repeatTransaction function
2060    * (possibly living on the ContributionRecur BAO) would be called first to create a pending contribution with a
2061    * subsequent call to the contribution.completetransaction api.
2062    *
2063    * The completeTransaction functionality has historically been overloaded to both complete and repeat payments.
2064    *
2065    * @param CRM_Contribute_BAO_Contribution $contribution
2066    * @param array $input
2067    * @param array $contributionParams
2068    *
2069    * @return array
2070    */
2071   protected static function repeatTransaction(&$contribution, &$input, $contributionParams) {
2072     if (!empty($contribution->id)) {
2073       return FALSE;
2074     }
2075     if (empty($contribution->id)) {
2076       // Unclear why this would only be set for repeats.
2077       if (!empty($input['amount'])) {
2078         $contribution->total_amount = $contributionParams['total_amount'] = $input['amount'];
2079       }
2080       $templateContribution = CRM_Contribute_BAO_ContributionRecur::getTemplateContribution($contributionParams['contribution_recur_id']);
2081       if (!empty($contributionParams['contribution_recur_id'])) {
2082         $recurringContribution = civicrm_api3('ContributionRecur', 'getsingle', array(
2083           'id' => $contributionParams['contribution_recur_id'],
2084         ));
2085         if (!empty($recurringContribution['campaign_id'])) {
2086           // CRM-17718 the campaign id on the contribution recur record should get precedence.
2087           $contributionParams['campaign_id'] = $recurringContribution['campaign_id'];
2088         }
2089         if (!empty($recurringContribution['financial_type_id'])) {
2090           // CRM-17718 the campaign id on the contribution recur record should get precedence.
2091           $contributionParams['financial_type_id'] = $recurringContribution['financial_type_id'];
2092         }
2093       }
2094       $contributionParams['skipLineItem'] = TRUE;
2095       $contributionParams['status_id'] = 'Pending';
2096       if (isset($contributionParams['financial_type_id'])) {
2097         // Give precedence to passed in type.
2098         $contribution->financial_type_id = $contributionParams['financial_type_id'];
2099       }
2100       else {
2101         $contributionParams['financial_type_id'] = $templateContribution['financial_type_id'];
2102       }
2103       $contributionParams['contact_id'] = $templateContribution['contact_id'];
2104       $contributionParams['source'] = empty($templateContribution['source']) ? ts('Recurring contribution') : $templateContribution['source'];
2105       $createContribution = civicrm_api3('Contribution', 'create', $contributionParams);
2106       $contribution->id = $createContribution['id'];
2107       $input['line_item'] = CRM_Contribute_BAO_ContributionRecur::addRecurLineItems($contribution->contribution_recur_id, $contribution);
2108       CRM_Contribute_BAO_ContributionRecur::copyCustomValues($contributionParams['contribution_recur_id'], $contribution->id);
2109       return TRUE;
2110     }
2111   }
2112
2113   /**
2114    * Get individual id for onbehalf contribution.
2115    *
2116    * @param int $contributionId
2117    *   Contribution id.
2118    * @param int $contributorId
2119    *   Contributor id.
2120    *
2121    * @return array
2122    *   containing organization id and individual id
2123    */
2124   public static function getOnbehalfIds($contributionId, $contributorId = NULL) {
2125
2126     $ids = array();
2127
2128     if (!$contributionId) {
2129       return $ids;
2130     }
2131
2132     // fetch contributor id if null
2133     if (!$contributorId) {
2134       $contributorId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
2135         $contributionId, 'contact_id'
2136       );
2137     }
2138
2139     $activityTypeIds = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
2140     $activityTypeId = array_search('Contribution', $activityTypeIds);
2141
2142     if ($activityTypeId && $contributorId) {
2143       $activityQuery = "
2144 SELECT     civicrm_activity_contact.contact_id
2145   FROM     civicrm_activity_contact
2146 INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_activity.id
2147  WHERE     civicrm_activity.activity_type_id   = %1
2148    AND     civicrm_activity.source_record_id   = %2
2149    AND     civicrm_activity_contact.record_type_id = %3
2150 ";
2151
2152       $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2153       $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
2154
2155       $params = array(
2156         1 => array($activityTypeId, 'Integer'),
2157         2 => array($contributionId, 'Integer'),
2158         3 => array($sourceID, 'Integer'),
2159       );
2160
2161       $sourceContactId = CRM_Core_DAO::singleValueQuery($activityQuery, $params);
2162
2163       // for on behalf contribution source is individual and contributor is organization
2164       if ($sourceContactId && $sourceContactId != $contributorId) {
2165         $relationshipTypeIds = CRM_Core_PseudoConstant::relationshipType('name');
2166         // get rel type id for employee of relation
2167         foreach ($relationshipTypeIds as $id => $typeVals) {
2168           if ($typeVals['name_a_b'] == 'Employee of') {
2169             $relationshipTypeId = $id;
2170             break;
2171           }
2172         }
2173
2174         $rel = new CRM_Contact_DAO_Relationship();
2175         $rel->relationship_type_id = $relationshipTypeId;
2176         $rel->contact_id_a = $sourceContactId;
2177         $rel->contact_id_b = $contributorId;
2178         if ($rel->find(TRUE)) {
2179           $ids['individual_id'] = $rel->contact_id_a;
2180           $ids['organization_id'] = $rel->contact_id_b;
2181         }
2182       }
2183     }
2184
2185     return $ids;
2186   }
2187
2188   /**
2189    * @return array
2190    */
2191   public static function getContributionDates() {
2192     $config = CRM_Core_Config::singleton();
2193     $currentMonth = date('m');
2194     $currentDay = date('d');
2195     if ((int ) $config->fiscalYearStart['M'] > $currentMonth ||
2196       ((int ) $config->fiscalYearStart['M'] == $currentMonth &&
2197         (int ) $config->fiscalYearStart['d'] > $currentDay
2198       )
2199     ) {
2200       $year = date('Y') - 1;
2201     }
2202     else {
2203       $year = date('Y');
2204     }
2205     $year = array('Y' => $year);
2206     $yearDate = $config->fiscalYearStart;
2207     $yearDate = array_merge($year, $yearDate);
2208     $yearDate = CRM_Utils_Date::format($yearDate);
2209
2210     $monthDate = date('Ym') . '01';
2211
2212     $now = date('Ymd');
2213
2214     return array(
2215       'now' => $now,
2216       'yearDate' => $yearDate,
2217       'monthDate' => $monthDate,
2218     );
2219   }
2220
2221   /**
2222    * Load objects relations to contribution object.
2223    * Objects are stored in the $_relatedObjects property
2224    * In the first instance we are just moving functionality from BASEIpn -
2225    * @see http://issues.civicrm.org/jira/browse/CRM-9996
2226    *
2227    * Note that the unit test for the BaseIPN class tests this function
2228    *
2229    * @param array $input
2230    *   Input as delivered from Payment Processor.
2231    * @param array $ids
2232    *   Ids as Loaded by Payment Processor.
2233    * @param bool $loadAll
2234    *   Load all related objects - even where id not passed in? (allows API to call this).
2235    *
2236    * @return bool
2237    * @throws Exception
2238    */
2239   public function loadRelatedObjects(&$input, &$ids, $loadAll = FALSE) {
2240     if ($loadAll) {
2241       $ids = array_merge($this->getComponentDetails($this->id), $ids);
2242       if (empty($ids['contact']) && isset($this->contact_id)) {
2243         $ids['contact'] = $this->contact_id;
2244       }
2245     }
2246     if (empty($this->_component)) {
2247       if (!empty($ids['event'])) {
2248         $this->_component = 'event';
2249       }
2250       else {
2251         $this->_component = strtolower(CRM_Utils_Array::value('component', $input, 'contribute'));
2252       }
2253     }
2254
2255     // If the object is not fully populated then make sure it is - this is a more about legacy paths & cautious
2256     // refactoring than anything else, and has unit test coverage.
2257     if (empty($this->financial_type_id)) {
2258       $this->find(TRUE);
2259     }
2260
2261     $paymentProcessorID = CRM_Utils_Array::value('payment_processor_id', $input, CRM_Utils_Array::value(
2262       'paymentProcessor',
2263       $ids
2264     ));
2265
2266     if (!$paymentProcessorID && $this->contribution_page_id) {
2267       $paymentProcessorID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage',
2268         $this->contribution_page_id,
2269         'payment_processor'
2270       );
2271       if ($paymentProcessorID) {
2272         $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromContributionPage;
2273       }
2274     }
2275
2276     $ids['contributionType'] = $this->financial_type_id;
2277     $ids['financialType'] = $this->financial_type_id;
2278
2279     $entities = array(
2280       'contact' => 'CRM_Contact_BAO_Contact',
2281       'contributionRecur' => 'CRM_Contribute_BAO_ContributionRecur',
2282       'contributionType' => 'CRM_Financial_BAO_FinancialType',
2283       'financialType' => 'CRM_Financial_BAO_FinancialType',
2284     );
2285     foreach ($entities as $entity => $bao) {
2286       if (!empty($ids[$entity])) {
2287         $this->_relatedObjects[$entity] = new $bao();
2288         $this->_relatedObjects[$entity]->id = $ids[$entity];
2289         if (!$this->_relatedObjects[$entity]->find(TRUE)) {
2290           throw new CRM_Core_Exception($entity . ' could not be loaded');
2291         }
2292       }
2293     }
2294
2295     if (!empty($ids['contributionRecur']) && !$paymentProcessorID) {
2296       $paymentProcessorID = $this->_relatedObjects['contributionRecur']->payment_processor_id;
2297     }
2298
2299     if (!empty($ids['pledge_payment'])) {
2300       foreach ($ids['pledge_payment'] as $key => $paymentID) {
2301         if (empty($paymentID)) {
2302           continue;
2303         }
2304         $payment = new CRM_Pledge_BAO_PledgePayment();
2305         $payment->id = $paymentID;
2306         if (!$payment->find(TRUE)) {
2307           throw new Exception("Could not find pledge payment record: " . $paymentID);
2308         }
2309         $this->_relatedObjects['pledge_payment'][] = $payment;
2310       }
2311     }
2312
2313     $this->loadRelatedMembershipObjects($ids);
2314
2315     if ($this->_component != 'contribute') {
2316       // we are in event mode
2317       // make sure event exists and is valid
2318       $event = new CRM_Event_BAO_Event();
2319       $event->id = $ids['event'];
2320       if ($ids['event'] &&
2321         !$event->find(TRUE)
2322       ) {
2323         throw new Exception("Could not find event: " . $ids['event']);
2324       }
2325
2326       $this->_relatedObjects['event'] = &$event;
2327
2328       $participant = new CRM_Event_BAO_Participant();
2329       $participant->id = $ids['participant'];
2330       if ($ids['participant'] &&
2331         !$participant->find(TRUE)
2332       ) {
2333         throw new Exception("Could not find participant: " . $ids['participant']);
2334       }
2335       $participant->register_date = CRM_Utils_Date::isoToMysql($participant->register_date);
2336
2337       $this->_relatedObjects['participant'] = &$participant;
2338
2339       // get the payment processor id from event - this is inaccurate see CRM-16923
2340       // in future we should look at throwing an exception here rather than an dubious guess.
2341       if (!$paymentProcessorID) {
2342         $paymentProcessorID = $this->_relatedObjects['event']->payment_processor;
2343         if ($paymentProcessorID) {
2344           $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromEvent;
2345         }
2346       }
2347     }
2348
2349     if ($paymentProcessorID) {
2350       $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($paymentProcessorID,
2351         $this->is_test ? 'test' : 'live'
2352       );
2353       $ids['paymentProcessor'] = $paymentProcessorID;
2354       $this->_relatedObjects['paymentProcessor'] = $paymentProcessor;
2355     }
2356     return TRUE;
2357   }
2358
2359   /**
2360    * Create array of message information - ie. return html version, txt version, to field
2361    *
2362    * @param array $input
2363    *   Incoming information.
2364    *   - is_recur - should this be treated as recurring (not sure why you wouldn't
2365    *    just check presence of recur object but maintaining legacy approach
2366    *    to be careful)
2367    * @param array $ids
2368    *   IDs of related objects.
2369    * @param array $values
2370    *   Any values that may have already been compiled by calling process.
2371    *   This is augmented by values 'gathered' by gatherMessageValues
2372    * @param bool $recur
2373    * @param bool $returnMessageText
2374    *   Distinguishes between whether to send message or return.
2375    *   message text. We are working towards this function ALWAYS returning message text & calling
2376    *   function doing emails / pdfs with it
2377    *
2378    * @return array
2379    *   messages
2380    * @throws Exception
2381    */
2382   public function composeMessageArray(&$input, &$ids, &$values, $recur = FALSE, $returnMessageText = TRUE) {
2383     $this->loadRelatedObjects($input, $ids);
2384
2385     if (empty($this->_component)) {
2386       $this->_component = CRM_Utils_Array::value('component', $input);
2387     }
2388
2389     //not really sure what params might be passed in but lets merge em into values
2390     $values = array_merge($this->_gatherMessageValues($input, $values, $ids), $values);
2391     if (!empty($input['receipt_date'])) {
2392       $values['receipt_date'] = $input['receipt_date'];
2393     }
2394
2395     $template = CRM_Core_Smarty::singleton();
2396     $this->_assignMessageVariablesToTemplate($values, $input, $template, $recur, $returnMessageText);
2397     //what does recur 'mean here - to do with payment processor return functionality but
2398     // what is the importance
2399     if ($recur && !empty($this->_relatedObjects['paymentProcessor'])) {
2400       $paymentObject = Civi\Payment\System::singleton()->getByProcessor($this->_relatedObjects['paymentProcessor']);
2401
2402       $entityID = $entity = NULL;
2403       if (isset($ids['contribution'])) {
2404         $entity = 'contribution';
2405         $entityID = $ids['contribution'];
2406       }
2407       if (!empty($ids['membership'])) {
2408         //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
2409         // 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
2410         // line having loaded an array
2411         $ids['membership'] = (array) $ids['membership'];
2412         $entity = 'membership';
2413         $entityID = $ids['membership'][0];
2414       }
2415
2416       $template->assign('cancelSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'cancel'));
2417       $template->assign('updateSubscriptionBillingUrl', $paymentObject->subscriptionURL($entityID, $entity, 'billing'));
2418       $template->assign('updateSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'update'));
2419
2420       if ($this->_relatedObjects['paymentProcessor']['billing_mode'] & CRM_Core_Payment::BILLING_MODE_FORM) {
2421         //direct mode showing billing block, so use directIPN for temporary
2422         $template->assign('contributeMode', 'directIPN');
2423       }
2424     }
2425     // todo remove strtolower - check consistency
2426     if (strtolower($this->_component) == 'event') {
2427       $eventParams = array('id' => $this->_relatedObjects['participant']->event_id);
2428       $values['event'] = array();
2429
2430       CRM_Event_BAO_Event::retrieve($eventParams, $values['event']);
2431
2432       //get location details
2433       $locationParams = array('entity_id' => $this->_relatedObjects['participant']->event_id, 'entity_table' => 'civicrm_event');
2434       $values['location'] = CRM_Core_BAO_Location::getValues($locationParams);
2435
2436       $ufJoinParams = array(
2437         'entity_table' => 'civicrm_event',
2438         'entity_id' => $ids['event'],
2439         'module' => 'CiviEvent',
2440       );
2441
2442       list($custom_pre_id,
2443         $custom_post_ids
2444         ) = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
2445
2446       $values['custom_pre_id'] = $custom_pre_id;
2447       $values['custom_post_id'] = $custom_post_ids;
2448       //for tasks 'Change Participant Status' and 'Update multiple Contributions' case
2449       //and cases involving status updation through ipn
2450       // whatever that means!
2451       // total_amount appears to be the preferred input param & it is unclear why we support amount here
2452       // perhaps we should throw an e-notice if amount is set & force total_amount?
2453       if (!empty($input['amount'])) {
2454         $values['totalAmount'] = $input['amount'];
2455       }
2456
2457       if ($values['event']['is_email_confirm']) {
2458         $values['is_email_receipt'] = 1;
2459       }
2460
2461       if (!empty($ids['contribution'])) {
2462         $values['contributionId'] = $ids['contribution'];
2463       }
2464
2465       return CRM_Event_BAO_Event::sendMail($ids['contact'], $values,
2466         $this->_relatedObjects['participant']->id, $this->is_test, $returnMessageText
2467       );
2468     }
2469     else {
2470       $values['contribution_id'] = $this->id;
2471       if (!empty($ids['related_contact'])) {
2472         $values['related_contact'] = $ids['related_contact'];
2473         if (isset($ids['onbehalf_dupe_alert'])) {
2474           $values['onbehalf_dupe_alert'] = $ids['onbehalf_dupe_alert'];
2475         }
2476         $entityBlock = array(
2477           'contact_id' => $ids['contact'],
2478           'location_type_id' => CRM_Core_DAO::getFieldValue('CRM_Core_DAO_LocationType',
2479             'Home', 'id', 'name'
2480           ),
2481         );
2482         $address = CRM_Core_BAO_Address::getValues($entityBlock);
2483         $template->assign('onBehalfAddress', $address[$entityBlock['location_type_id']]['display']);
2484       }
2485       $isTest = FALSE;
2486       if ($this->is_test) {
2487         $isTest = TRUE;
2488       }
2489       if (!empty($this->_relatedObjects['membership'])) {
2490         foreach ($this->_relatedObjects['membership'] as $membership) {
2491           if ($membership->id) {
2492             $values['isMembership'] = TRUE;
2493             $values['membership_assign'] = TRUE;
2494
2495             // need to set the membership values here
2496             $template->assign('membership_name',
2497               CRM_Member_PseudoConstant::membershipType($membership->membership_type_id)
2498             );
2499             $template->assign('mem_start_date', $membership->start_date);
2500             $template->assign('mem_join_date', $membership->join_date);
2501             $template->assign('mem_end_date', $membership->end_date);
2502             $membership_status = CRM_Member_PseudoConstant::membershipStatus($membership->status_id, NULL, 'label');
2503             $template->assign('mem_status', $membership_status);
2504             if ($membership_status == 'Pending' && $membership->is_pay_later == 1) {
2505               $template->assign('is_pay_later', 1);
2506             }
2507
2508             // if separate payment there are two contributions recorded and the
2509             // admin will need to send a receipt for each of them separately.
2510             // we dont link the two in the db (but can potentially infer it if needed)
2511             $template->assign('is_separate_payment', 0);
2512
2513             if ($recur && $paymentObject) {
2514               $url = $paymentObject->subscriptionURL($membership->id, 'membership', 'cancel');
2515               $template->assign('cancelSubscriptionUrl', $url);
2516               $url = $paymentObject->subscriptionURL($membership->id, 'membership', 'billing');
2517               $template->assign('updateSubscriptionBillingUrl', $url);
2518               $url = $paymentObject->subscriptionURL($entityID, $entity, 'update');
2519               $template->assign('updateSubscriptionUrl', $url);
2520             }
2521
2522             $result = CRM_Contribute_BAO_ContributionPage::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
2523
2524             return $result;
2525             // otherwise if its about sending emails, continue sending without return, as we
2526             // don't want to exit the loop.
2527           }
2528         }
2529       }
2530       else {
2531         return CRM_Contribute_BAO_ContributionPage::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
2532       }
2533     }
2534   }
2535
2536   /**
2537    * Gather values for contribution mail - this function has been created
2538    * as part of CRM-9996 refactoring as a step towards simplifying the composeMessage function
2539    * Values related to the contribution in question are gathered
2540    *
2541    * @param array $input
2542    *   Input into function (probably from payment processor).
2543    * @param array $values
2544    * @param array $ids
2545    *   The set of ids related to the input.
2546    *
2547    * @return array
2548    */
2549   public function _gatherMessageValues($input, &$values, $ids = array()) {
2550     // set display address of contributor
2551     if ($this->address_id) {
2552       $addressParams = array('id' => $this->address_id);
2553       $addressDetails = CRM_Core_BAO_Address::getValues($addressParams, FALSE, 'id');
2554       $addressDetails = array_values($addressDetails);
2555       $values['address'] = $addressDetails[0]['display'];
2556     }
2557     // Else we assign the billing address of the contribution contact.
2558     else {
2559       $addressParams = array('contact_id' => $this->contact_id, 'is_billing' => 1);
2560       $addressDetails = CRM_Core_BAO_Address::getValues($addressParams);
2561       if (!is_null($addressDetails)) {
2562         $addressDetails = array_values($addressDetails);
2563         $values['address'] = $addressDetails[0]['display'];
2564       }
2565     }
2566     if ($this->_component == 'contribute') {
2567       //get soft contributions
2568       $softContributions = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($this->id, TRUE);
2569       if (!empty($softContributions)) {
2570         $values['softContributions'] = $softContributions['soft_credit'];
2571       }
2572       if (isset($this->contribution_page_id)) {
2573         CRM_Contribute_BAO_ContributionPage::setValues(
2574           $this->contribution_page_id,
2575           $values
2576         );
2577         if ($this->contribution_page_id) {
2578           // CRM-8254 - override default currency if applicable
2579           $config = CRM_Core_Config::singleton();
2580           $config->defaultCurrency = CRM_Utils_Array::value(
2581             'currency',
2582             $values,
2583             $config->defaultCurrency
2584           );
2585         }
2586       }
2587       // no contribution page -probably back office
2588       else {
2589         // Handle re-print receipt for offline contributions (call from PDF.php - no contribution_page_id)
2590         $values['is_email_receipt'] = 1;
2591         $values['title'] = 'Contribution';
2592       }
2593       // set lineItem for contribution
2594       if ($this->id) {
2595         $lineItem = CRM_Price_BAO_LineItem::getLineItems($this->id, 'contribution', 1);
2596         if (!empty($lineItem)) {
2597           $itemId = key($lineItem);
2598           foreach ($lineItem as &$eachItem) {
2599             if (is_array($this->_relatedObjects['membership']) && array_key_exists($eachItem['membership_type_id'], $this->_relatedObjects['membership'])) {
2600               $eachItem['join_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->join_date);
2601               $eachItem['start_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->start_date);
2602               $eachItem['end_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->end_date);
2603             }
2604           }
2605           $values['lineItem'][0] = $lineItem;
2606           $values['priceSetID'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $lineItem[$itemId]['price_field_id'], 'price_set_id');
2607         }
2608       }
2609
2610       $relatedContact = CRM_Contribute_BAO_Contribution::getOnbehalfIds(
2611         $this->id,
2612         $this->contact_id
2613       );
2614       // if this is onbehalf of contribution then set related contact
2615       if (!empty($relatedContact['individual_id'])) {
2616         $values['related_contact'] = $ids['related_contact'] = $relatedContact['individual_id'];
2617       }
2618     }
2619     else {
2620       // event
2621       $eventParams = array(
2622         'id' => $this->_relatedObjects['event']->id,
2623       );
2624       $values['event'] = array();
2625
2626       CRM_Event_BAO_Event::retrieve($eventParams, $values['event']);
2627       // add custom fields for event
2628       $eventGroupTree = CRM_Core_BAO_CustomGroup::getTree('Event', $this->_relatedObjects['event'], $this->_relatedObjects['event']->id);
2629
2630       $eventCustomGroup = array();
2631       foreach ($eventGroupTree as $key => $group) {
2632         if ($key === 'info') {
2633           continue;
2634         }
2635
2636         foreach ($group['fields'] as $k => $customField) {
2637           $groupLabel = $group['title'];
2638           if (!empty($customField['customValue'])) {
2639             foreach ($customField['customValue'] as $customFieldValues) {
2640               $eventCustomGroup[$groupLabel][$customField['label']] = CRM_Utils_Array::value('data', $customFieldValues);
2641             }
2642           }
2643         }
2644       }
2645       $values['event']['customGroup'] = $eventCustomGroup;
2646
2647       //get participant details
2648       $participantParams = array(
2649         'id' => $this->_relatedObjects['participant']->id,
2650       );
2651
2652       $values['participant'] = array();
2653
2654       CRM_Event_BAO_Participant::getValues($participantParams, $values['participant'], $participantIds);
2655       // add custom fields for event
2656       $participantGroupTree = CRM_Core_BAO_CustomGroup::getTree('Participant', $this->_relatedObjects['participant'], $this->_relatedObjects['participant']->id);
2657       $participantCustomGroup = array();
2658       foreach ($participantGroupTree as $key => $group) {
2659         if ($key === 'info') {
2660           continue;
2661         }
2662
2663         foreach ($group['fields'] as $k => $customField) {
2664           $groupLabel = $group['title'];
2665           if (!empty($customField['customValue'])) {
2666             foreach ($customField['customValue'] as $customFieldValues) {
2667               $participantCustomGroup[$groupLabel][$customField['label']] = CRM_Utils_Array::value('data', $customFieldValues);
2668             }
2669           }
2670         }
2671       }
2672       $values['participant']['customGroup'] = $participantCustomGroup;
2673
2674       //get location details
2675       $locationParams = array(
2676         'entity_id' => $this->_relatedObjects['event']->id,
2677         'entity_table' => 'civicrm_event',
2678       );
2679       $values['location'] = CRM_Core_BAO_Location::getValues($locationParams);
2680
2681       $ufJoinParams = array(
2682         'entity_table' => 'civicrm_event',
2683         'entity_id' => $ids['event'],
2684         'module' => 'CiviEvent',
2685       );
2686
2687       list($custom_pre_id,
2688         $custom_post_ids
2689         ) = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
2690
2691       $values['custom_pre_id'] = $custom_pre_id;
2692       $values['custom_post_id'] = $custom_post_ids;
2693
2694       // set lineItem for event contribution
2695       if ($this->id) {
2696         $participantIds = CRM_Event_BAO_Participant::getParticipantIds($this->id);
2697         if (!empty($participantIds)) {
2698           foreach ($participantIds as $pIDs) {
2699             $lineItem = CRM_Price_BAO_LineItem::getLineItems($pIDs);
2700             if (!CRM_Utils_System::isNull($lineItem)) {
2701               $values['lineItem'][] = $lineItem;
2702             }
2703           }
2704         }
2705       }
2706     }
2707
2708     $groupTree = CRM_Core_BAO_CustomGroup::getTree('Contribution', $this, $this->id);
2709
2710     $customGroup = array();
2711     foreach ($groupTree as $key => $group) {
2712       if ($key === 'info') {
2713         continue;
2714       }
2715
2716       foreach ($group['fields'] as $k => $customField) {
2717         $groupLabel = $group['title'];
2718         if (!empty($customField['customValue'])) {
2719           foreach ($customField['customValue'] as $customFieldValues) {
2720             $customGroup[$groupLabel][$customField['label']] = CRM_Utils_Array::value('data', $customFieldValues);
2721           }
2722         }
2723       }
2724     }
2725     $values['customGroup'] = $customGroup;
2726
2727     return $values;
2728   }
2729
2730   /**
2731    * Assign message variables to template but try to break the habit.
2732    *
2733    * In order to get away from leaky variables it is better to ensure variables are set in values and assign them
2734    * from the send function. Otherwise smarty variables can leak if this is called more than once - e.g. processing
2735    * multiple recurring payments for processors like IATS that use tokens.
2736    *
2737    * Apply variables for message to smarty template - this function is part of analysing what is in the huge
2738    * function & breaking it down into manageable chunks. Eventually it will be refactored into something else
2739    * Note we send directly from this function in some cases because it is only partly refactored.
2740    *
2741    * Don't call this function directly as the signature will change.
2742    *
2743    * @param $values
2744    * @param $input
2745    * @param CRM_Core_SMARTY $template
2746    * @param bool $recur
2747    * @param bool $returnMessageText
2748    *
2749    * @return mixed
2750    */
2751   public function _assignMessageVariablesToTemplate(&$values, $input, &$template, $recur = FALSE, $returnMessageText = TRUE) {
2752     $template->assign('first_name', $this->_relatedObjects['contact']->first_name);
2753     $template->assign('last_name', $this->_relatedObjects['contact']->last_name);
2754     $template->assign('displayName', $this->_relatedObjects['contact']->display_name);
2755     if (!empty($values['lineItem']) && !empty($this->_relatedObjects['membership'])) {
2756       $values['useForMember'] = TRUE;
2757     }
2758     //assign honor information to receipt message
2759     $softRecord = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($this->id);
2760
2761     if (isset($softRecord['soft_credit'])) {
2762       //if id of contribution page is present
2763       if (!empty($values['id'])) {
2764         $values['honor'] = array(
2765           'honor_profile_values' => array(),
2766           'honor_profile_id' => CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'uf_group_id', 'entity_id'),
2767           'honor_id' => $softRecord['soft_credit'][1]['contact_id'],
2768         );
2769         $softCreditTypes = CRM_Core_OptionGroup::values('soft_credit_type');
2770
2771         $template->assign('soft_credit_type', $softRecord['soft_credit'][1]['soft_credit_type_label']);
2772         $template->assign('honor_block_is_active', CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'is_active', 'entity_id'));
2773       }
2774       else {
2775         //offline contribution
2776         $softCreditTypes = $softCredits = array();
2777         foreach ($softRecord['soft_credit'] as $key => $softCredit) {
2778           $softCreditTypes[$key] = $softCredit['soft_credit_type_label'];
2779           $softCredits[$key] = array(
2780             'Name' => $softCredit['contact_name'],
2781             'Amount' => CRM_Utils_Money::format($softCredit['amount'], $softCredit['currency']),
2782           );
2783         }
2784         $template->assign('softCreditTypes', $softCreditTypes);
2785         $template->assign('softCredits', $softCredits);
2786       }
2787     }
2788
2789     $dao = new CRM_Contribute_DAO_ContributionProduct();
2790     $dao->contribution_id = $this->id;
2791     if ($dao->find(TRUE)) {
2792       $premiumId = $dao->product_id;
2793       $template->assign('option', $dao->product_option);
2794
2795       $productDAO = new CRM_Contribute_DAO_Product();
2796       $productDAO->id = $premiumId;
2797       $productDAO->find(TRUE);
2798       $template->assign('selectPremium', TRUE);
2799       $template->assign('product_name', $productDAO->name);
2800       $template->assign('price', $productDAO->price);
2801       $template->assign('sku', $productDAO->sku);
2802     }
2803     $template->assign('title', CRM_Utils_Array::value('title', $values));
2804     $values['amount'] = CRM_Utils_Array::value('total_amount', $input, (CRM_Utils_Array::value('amount', $input)), NULL);
2805     if (!$values['amount'] && isset($this->total_amount)) {
2806       $values['amount'] = $this->total_amount;
2807     }
2808
2809     // add the new contribution values
2810     if (strtolower($this->_component) == 'contribute') {
2811       //PCP Info
2812       $softDAO = new CRM_Contribute_DAO_ContributionSoft();
2813       $softDAO->contribution_id = $this->id;
2814       if ($softDAO->find(TRUE)) {
2815         $template->assign('pcpBlock', TRUE);
2816         $template->assign('pcp_display_in_roll', $softDAO->pcp_display_in_roll);
2817         $template->assign('pcp_roll_nickname', $softDAO->pcp_roll_nickname);
2818         $template->assign('pcp_personal_note', $softDAO->pcp_personal_note);
2819
2820         //assign the pcp page title for email subject
2821         $pcpDAO = new CRM_PCP_DAO_PCP();
2822         $pcpDAO->id = $softDAO->pcp_id;
2823         if ($pcpDAO->find(TRUE)) {
2824           $template->assign('title', $pcpDAO->title);
2825         }
2826       }
2827     }
2828
2829     if ($this->financial_type_id) {
2830       $values['financial_type_id'] = $this->financial_type_id;
2831     }
2832
2833     $template->assign('trxn_id', $this->trxn_id);
2834     $template->assign('receive_date',
2835       CRM_Utils_Date::processDate($this->receive_date)
2836     );
2837     $template->assign('contributeMode', 'notify');
2838     $template->assign('action', $this->is_test ? 1024 : 1);
2839     $template->assign('receipt_text',
2840       CRM_Utils_Array::value('receipt_text',
2841         $values
2842       )
2843     );
2844     $template->assign('is_monetary', 1);
2845     $template->assign('is_recur', (bool) $recur);
2846     $template->assign('currency', $this->currency);
2847     $template->assign('address', CRM_Utils_Address::format($input));
2848     if (!empty($values['customGroup'])) {
2849       $template->assign('customGroup', $values['customGroup']);
2850     }
2851     if (!empty($values['softContributions'])) {
2852       $template->assign('softContributions', $values['softContributions']);
2853     }
2854     if ($this->_component == 'event') {
2855       $template->assign('title', $values['event']['title']);
2856       $participantRoles = CRM_Event_PseudoConstant::participantRole();
2857       $viewRoles = array();
2858       foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $this->_relatedObjects['participant']->role_id) as $k => $v) {
2859         $viewRoles[] = $participantRoles[$v];
2860       }
2861       $values['event']['participant_role'] = implode(', ', $viewRoles);
2862       $template->assign('event', $values['event']);
2863       $template->assign('participant', $values['participant']);
2864       $template->assign('location', $values['location']);
2865       $template->assign('customPre', $values['custom_pre_id']);
2866       $template->assign('customPost', $values['custom_post_id']);
2867
2868       $isTest = FALSE;
2869       if ($this->_relatedObjects['participant']->is_test) {
2870         $isTest = TRUE;
2871       }
2872
2873       $values['params'] = array();
2874       //to get email of primary participant.
2875       $primaryEmail = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Email', $this->_relatedObjects['participant']->contact_id, 'email', 'contact_id');
2876       $primaryAmount[] = array(
2877         'label' => $this->_relatedObjects['participant']->fee_level . ' - ' . $primaryEmail,
2878         'amount' => $this->_relatedObjects['participant']->fee_amount,
2879       );
2880       //build an array of cId/pId of participants
2881       $additionalIDs = CRM_Event_BAO_Event::buildCustomProfile($this->_relatedObjects['participant']->id, NULL, $this->_relatedObjects['contact']->id, $isTest, TRUE);
2882       unset($additionalIDs[$this->_relatedObjects['participant']->id]);
2883       //send receipt to additional participant if exists
2884       if (count($additionalIDs)) {
2885         $template->assign('isPrimary', 0);
2886         $template->assign('customProfile', NULL);
2887         //set additionalParticipant true
2888         $values['params']['additionalParticipant'] = TRUE;
2889         foreach ($additionalIDs as $pId => $cId) {
2890           $amount = array();
2891           //to change the status pending to completed
2892           $additional = new CRM_Event_DAO_Participant();
2893           $additional->id = $pId;
2894           $additional->contact_id = $cId;
2895           $additional->find(TRUE);
2896           $additional->register_date = $this->_relatedObjects['participant']->register_date;
2897           $additional->status_id = 1;
2898           $additionalParticipantInfo = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Email', $additional->contact_id, 'email', 'contact_id');
2899           //if additional participant dont have email
2900           //use display name.
2901           if (!$additionalParticipantInfo) {
2902             $additionalParticipantInfo = CRM_Contact_BAO_Contact::displayName($additional->contact_id);
2903           }
2904           $amount[0] = array('label' => $additional->fee_level, 'amount' => $additional->fee_amount);
2905           $primaryAmount[] = array(
2906             'label' => $additional->fee_level . ' - ' . $additionalParticipantInfo,
2907             'amount' => $additional->fee_amount,
2908           );
2909           $additional->save();
2910           $additional->free();
2911           $template->assign('amount', $amount);
2912           CRM_Event_BAO_Event::sendMail($cId, $values, $pId, $isTest, $returnMessageText);
2913         }
2914       }
2915
2916       //build an array of custom profile and assigning it to template
2917       $customProfile = CRM_Event_BAO_Event::buildCustomProfile($this->_relatedObjects['participant']->id, $values, NULL, $isTest);
2918
2919       if (count($customProfile)) {
2920         $template->assign('customProfile', $customProfile);
2921       }
2922
2923       // for primary contact
2924       $values['params']['additionalParticipant'] = FALSE;
2925       $template->assign('isPrimary', 1);
2926       $template->assign('amount', $primaryAmount);
2927       $template->assign('register_date', CRM_Utils_Date::isoToMysql($this->_relatedObjects['participant']->register_date));
2928       if ($this->payment_instrument_id) {
2929         $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
2930         $template->assign('paidBy', $paymentInstrument[$this->payment_instrument_id]);
2931       }
2932       // carry paylater, since we did not created billing,
2933       // so need to pull email from primary location, CRM-4395
2934       $values['params']['is_pay_later'] = $this->_relatedObjects['participant']->is_pay_later;
2935     }
2936     return $template;
2937   }
2938
2939   /**
2940    * Check whether payment processor supports
2941    * cancellation of contribution subscription
2942    *
2943    * @param int $contributionId
2944    *   Contribution id.
2945    *
2946    * @param bool $isNotCancelled
2947    *
2948    * @return bool
2949    */
2950   public static function isCancelSubscriptionSupported($contributionId, $isNotCancelled = TRUE) {
2951     $cacheKeyString = "$contributionId";
2952     $cacheKeyString .= $isNotCancelled ? '_1' : '_0';
2953
2954     static $supportsCancel = array();
2955
2956     if (!array_key_exists($cacheKeyString, $supportsCancel)) {
2957       $supportsCancel[$cacheKeyString] = FALSE;
2958       $isCancelled = FALSE;
2959
2960       if ($isNotCancelled) {
2961         $isCancelled = self::isSubscriptionCancelled($contributionId);
2962       }
2963
2964       $paymentObject = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($contributionId, 'contribute', 'obj');
2965       if (!empty($paymentObject)) {
2966         $supportsCancel[$cacheKeyString] = $paymentObject->supports('cancelRecurring') && !$isCancelled;
2967       }
2968     }
2969     return $supportsCancel[$cacheKeyString];
2970   }
2971
2972   /**
2973    * Check whether subscription is already cancelled.
2974    *
2975    * @param int $contributionId
2976    *   Contribution id.
2977    *
2978    * @return string
2979    *   contribution status
2980    */
2981   public static function isSubscriptionCancelled($contributionId) {
2982     $sql = "
2983        SELECT cr.contribution_status_id
2984          FROM civicrm_contribution_recur cr
2985     LEFT JOIN civicrm_contribution con ON ( cr.id = con.contribution_recur_id )
2986         WHERE con.id = %1 LIMIT 1";
2987     $params = array(1 => array($contributionId, 'Integer'));
2988     $statusId = CRM_Core_DAO::singleValueQuery($sql, $params);
2989     $status = CRM_Contribute_PseudoConstant::contributionStatus($statusId);
2990     if ($status == 'Cancelled') {
2991       return TRUE;
2992     }
2993     return FALSE;
2994   }
2995
2996   /**
2997    * Create all financial accounts entry.
2998    *
2999    * @param array $params
3000    *   Contribution object, line item array and params for trxn.
3001    *
3002    *
3003    * @param array $financialTrxnValues
3004    *
3005    * @return null|object
3006    */
3007   public static function recordFinancialAccounts(&$params, $financialTrxnValues = NULL) {
3008     $skipRecords = $update = $return = $isRelatedId = FALSE;
3009
3010     $additionalParticipantId = array();
3011     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
3012     $contributionStatus = empty($params['contribution_status_id']) ? NULL : $contributionStatuses[$params['contribution_status_id']];
3013
3014     if (CRM_Utils_Array::value('contribution_mode', $params) == 'participant') {
3015       $entityId = $params['participant_id'];
3016       $entityTable = 'civicrm_participant';
3017       $additionalParticipantId = CRM_Event_BAO_Participant::getAdditionalParticipantIds($entityId);
3018     }
3019     elseif (!empty($params['membership_id'])) {
3020       //so far $params['membership_id'] should only be set coming in from membershipBAO::create so the situation where multiple memberships
3021       // are created off one contribution should be handled elsewhere
3022       $entityId = $params['membership_id'];
3023       $entityTable = 'civicrm_membership';
3024     }
3025     else {
3026       $entityId = $params['contribution']->id;
3027       $entityTable = 'civicrm_contribution';
3028     }
3029
3030     if (CRM_Utils_Array::value('contribution_mode', $params) == 'membership') {
3031       $isRelatedId = TRUE;
3032     }
3033
3034     $entityID[] = $entityId;
3035     if (!empty($additionalParticipantId)) {
3036       $entityID += $additionalParticipantId;
3037     }
3038     // prevContribution appears to mean - original contribution object- ie copy of contribution from before the update started that is being updated
3039     if (empty($params['prevContribution'])) {
3040       $entityID = NULL;
3041     }
3042     else {
3043       $update = TRUE;
3044     }
3045
3046     $statusId = $params['contribution']->contribution_status_id;
3047     // CRM-13964 partial payment
3048     if ($contributionStatus == 'Partially paid'
3049       && !empty($params['partial_payment_total']) && !empty($params['partial_amount_pay'])
3050     ) {
3051       $partialAmtPay = $params['partial_amount_pay'];
3052       $partialAmtTotal = $params['partial_payment_total'];
3053
3054       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3055       $fromFinancialAccountId = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id'], $relationTypeId);
3056       $statusId = CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name');
3057       $params['total_amount'] = $partialAmtPay;
3058
3059       $balanceTrxnInfo = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($params['contribution']->id, $params['financial_type_id']);
3060       if (empty($balanceTrxnInfo['trxn_id'])) {
3061         // create new balance transaction record
3062         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3063         $toFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id'], $relationTypeId);
3064
3065         $balanceTrxnParams['total_amount'] = $partialAmtTotal;
3066         $balanceTrxnParams['to_financial_account_id'] = $toFinancialAccount;
3067         $balanceTrxnParams['contribution_id'] = $params['contribution']->id;
3068         $balanceTrxnParams['trxn_date'] = !empty($params['contribution']->receive_date) ? $params['contribution']->receive_date : date('YmdHis');
3069         $balanceTrxnParams['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
3070         $balanceTrxnParams['net_amount'] = CRM_Utils_Array::value('net_amount', $params);
3071         $balanceTrxnParams['currency'] = $params['contribution']->currency;
3072         $balanceTrxnParams['trxn_id'] = $params['contribution']->trxn_id;
3073         $balanceTrxnParams['status_id'] = $statusId;
3074         $balanceTrxnParams['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
3075         $balanceTrxnParams['check_number'] = CRM_Utils_Array::value('check_number', $params);
3076         if (!empty($balanceTrxnParams['from_financial_account_id']) &&
3077           ($statusId == array_search('Completed', $contributionStatuses) || $statusId == array_search('Partially paid', $contributionStatuses))
3078         ) {
3079           $balanceTrxnParams['is_payment'] = 1;
3080         }
3081         if (!empty($params['payment_processor'])) {
3082           $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
3083         }
3084         $financialTxn = CRM_Core_BAO_FinancialTrxn::create($balanceTrxnParams);
3085       }
3086     }
3087
3088     // build line item array if its not set in $params
3089     if (empty($params['line_item']) || $additionalParticipantId) {
3090       CRM_Price_BAO_LineItem::getLineItemArray($params, $entityID, str_replace('civicrm_', '', $entityTable), $isRelatedId);
3091     }
3092
3093     if ($contributionStatus != 'Failed' &&
3094       !($contributionStatus == 'Pending' && !$params['contribution']->is_pay_later)
3095     ) {
3096       $skipRecords = TRUE;
3097       $pendingStatus = array(
3098         'Pending',
3099         'In Progress',
3100       );
3101       if (in_array($contributionStatus, $pendingStatus)) {
3102         $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship(
3103           $params['financial_type_id'],
3104           'Accounts Receivable Account is'
3105         );
3106       }
3107       elseif (!empty($params['payment_processor'])) {
3108         $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getFinancialAccount($params['payment_processor'], 'civicrm_payment_processor', 'financial_account_id');
3109       }
3110       elseif (!empty($params['payment_instrument_id'])) {
3111         $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($params['payment_instrument_id']);
3112       }
3113       else {
3114         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
3115         $queryParams = array(1 => array($relationTypeId, 'Integer'));
3116         $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);
3117       }
3118
3119       $totalAmount = CRM_Utils_Array::value('total_amount', $params);
3120       if (!isset($totalAmount) && !empty($params['prevContribution'])) {
3121         $totalAmount = $params['total_amount'] = $params['prevContribution']->total_amount;
3122       }
3123
3124       //build financial transaction params
3125       $trxnParams = array(
3126         'contribution_id' => $params['contribution']->id,
3127         'to_financial_account_id' => $params['to_financial_account_id'],
3128         'trxn_date' => !empty($params['contribution']->receive_date) ? $params['contribution']->receive_date : date('YmdHis'),
3129         'total_amount' => $totalAmount,
3130         'fee_amount' => CRM_Utils_Array::value('fee_amount', $params),
3131         'net_amount' => CRM_Utils_Array::value('net_amount', $params, $totalAmount),
3132         'currency' => $params['contribution']->currency,
3133         'trxn_id' => $params['contribution']->trxn_id,
3134         'status_id' => $statusId,
3135         'payment_instrument_id' => $params['contribution']->payment_instrument_id,
3136         'check_number' => CRM_Utils_Array::value('check_number', $params),
3137       );
3138       if ($contributionStatus == 'Refunded' || $contributionStatus == 'Chargeback') {
3139         $trxnParams['trxn_date'] = !empty($params['contribution']->cancel_date) ? $params['contribution']->cancel_date : date('YmdHis');
3140         if (isset($params['refund_trxn_id'])) {
3141           // CRM-17751 allow a separate trxn_id for the refund to be passed in via api & form.
3142           $trxnParams['trxn_id'] = $params['refund_trxn_id'];
3143         }
3144       }
3145       //CRM-16259, set is_payment flag for non pending status
3146       if (!in_array($contributionStatus, $pendingStatus)) {
3147         $trxnParams['is_payment'] = 1;
3148       }
3149       if (!empty($params['payment_processor'])) {
3150         $trxnParams['payment_processor_id'] = $params['payment_processor'];
3151       }
3152
3153       if (isset($fromFinancialAccountId)) {
3154         $trxnParams['from_financial_account_id'] = $fromFinancialAccountId;
3155       }
3156
3157       // consider external values passed for recording transaction entry
3158       if (!empty($financialTrxnValues)) {
3159         $trxnParams = array_merge($trxnParams, $financialTrxnValues);
3160       }
3161
3162       $params['trxnParams'] = $trxnParams;
3163
3164       if (!empty($params['prevContribution'])) {
3165         $updated = FALSE;
3166         $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $params['prevContribution']->total_amount;
3167         $params['trxnParams']['fee_amount'] = $params['prevContribution']->fee_amount;
3168         $params['trxnParams']['net_amount'] = $params['prevContribution']->net_amount;
3169         if (!isset($params['trxnParams']['trxn_id'])) {
3170           // Actually I have no idea why we are overwriting any values from the previous contribution.
3171           // (filling makes sense to me). However, only protecting this value as I really really know we
3172           // don't want this one overwritten.
3173           // CRM-17751.
3174           $params['trxnParams']['trxn_id'] = $params['prevContribution']->trxn_id;
3175         }
3176         $params['trxnParams']['status_id'] = $params['prevContribution']->contribution_status_id;
3177
3178         if (!(($params['prevContribution']->contribution_status_id == array_search('Pending', $contributionStatuses)
3179             || $params['prevContribution']->contribution_status_id == array_search('In Progress', $contributionStatuses))
3180           && $params['contribution']->contribution_status_id == array_search('Completed', $contributionStatuses))
3181         ) {
3182           $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id;
3183           $params['trxnParams']['check_number'] = $params['prevContribution']->check_number;
3184         }
3185
3186         //if financial type is changed
3187         if (!empty($params['financial_type_id']) &&
3188           $params['contribution']->financial_type_id != $params['prevContribution']->financial_type_id
3189         ) {
3190           $incomeTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Income Account is' "));
3191           $oldFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($params['prevContribution']->financial_type_id, $incomeTypeId);
3192           $newFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id'], $incomeTypeId);
3193           if ($oldFinancialAccount != $newFinancialAccount) {
3194             $params['total_amount'] = 0;
3195             if (in_array($params['contribution']->contribution_status_id, $pendingStatus)) {
3196               $params['trxnParams']['to_financial_account_id'] = CRM_Contribute_PseudoConstant::financialAccountType(
3197                 $params['prevContribution']->financial_type_id, $relationTypeId);
3198             }
3199             else {
3200               $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['prevContribution']->id, 'DESC');
3201               if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
3202                 $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
3203               }
3204             }
3205             self::updateFinancialAccounts($params, 'changeFinancialType');
3206             /* $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id']; */
3207             $params['financial_account_id'] = $newFinancialAccount;
3208             $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
3209             self::updateFinancialAccounts($params);
3210             $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id'];
3211             $updated = TRUE;
3212           }
3213         }
3214
3215         //Update contribution status
3216         $params['trxnParams']['status_id'] = $params['contribution']->contribution_status_id;
3217         if (!isset($params['refund_trxn_id'])) {
3218           // CRM-17751 This has previously been deliberately set. No explanation as to why one variant
3219           // gets preference over another so I am only 'protecting' a very specific tested flow
3220           // and letting natural justice take care of the rest.
3221           $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id;
3222         }
3223         if (!empty($params['contribution_status_id']) &&
3224           $params['prevContribution']->contribution_status_id != $params['contribution']->contribution_status_id
3225         ) {
3226           //Update Financial Records
3227           self::updateFinancialAccounts($params, 'changedStatus');
3228           $updated = TRUE;
3229         }
3230
3231         // change Payment Instrument for a Completed contribution
3232         // first handle special case when contribution is changed from Pending to Completed status when initial payment
3233         // instrument is null and now new payment instrument is added along with the payment
3234         $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
3235         $params['trxnParams']['check_number'] = CRM_Utils_Array::value('check_number', $params);
3236         if (array_key_exists('payment_instrument_id', $params)) {
3237           $params['trxnParams']['total_amount'] = -$trxnParams['total_amount'];
3238           if (CRM_Utils_System::isNull($params['prevContribution']->payment_instrument_id) &&
3239             !CRM_Utils_System::isNull($params['contribution']->payment_instrument_id)
3240           ) {
3241             //check if status is changed from Pending to Completed
3242             // do not update payment instrument changes for Pending to Completed
3243             if (!($params['contribution']->contribution_status_id == array_search('Completed', $contributionStatuses) &&
3244               in_array($params['prevContribution']->contribution_status_id, $pendingStatus))
3245             ) {
3246               // for all other statuses create new financial records
3247               self::updateFinancialAccounts($params, 'changePaymentInstrument');
3248               $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
3249               self::updateFinancialAccounts($params, 'changePaymentInstrument');
3250               $updated = TRUE;
3251             }
3252           }
3253           elseif ((!CRM_Utils_System::isNull($params['contribution']->payment_instrument_id) ||
3254               !CRM_Utils_System::isNull($params['prevContribution']->payment_instrument_id)) &&
3255             $params['contribution']->payment_instrument_id != $params['prevContribution']->payment_instrument_id
3256           ) {
3257             // for any other payment instrument changes create new financial records
3258             self::updateFinancialAccounts($params, 'changePaymentInstrument');
3259             $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
3260             self::updateFinancialAccounts($params, 'changePaymentInstrument');
3261             $updated = TRUE;
3262           }
3263           elseif (!CRM_Utils_System::isNull($params['contribution']->check_number) &&
3264             $params['contribution']->check_number != $params['prevContribution']->check_number
3265           ) {
3266             // another special case when check number is changed, create new financial records
3267             // create financial trxn with negative amount
3268             $params['trxnParams']['check_number'] = $params['prevContribution']->check_number;
3269             self::updateFinancialAccounts($params, 'changePaymentInstrument');
3270             // create financial trxn with positive amount
3271             $params['trxnParams']['check_number'] = $params['contribution']->check_number;
3272             $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
3273             self::updateFinancialAccounts($params, 'changePaymentInstrument');
3274             $updated = TRUE;
3275           }
3276         }
3277
3278         //if Change contribution amount
3279         $params['trxnParams']['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
3280         $params['trxnParams']['net_amount'] = CRM_Utils_Array::value('net_amount', $params);
3281         $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $totalAmount;
3282         $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id;
3283         if (isset($totalAmount) &&
3284           $totalAmount != $params['prevContribution']->total_amount
3285         ) {
3286           //Update Financial Records
3287           $params['trxnParams']['from_financial_account_id'] = NULL;
3288           self::updateFinancialAccounts($params, 'changedAmount');
3289           $updated = TRUE;
3290         }
3291
3292         if (!$updated) {
3293           // Looks like we might have a data correction update.
3294           // This would be a case where a transaction id has been entered but it is incorrect &
3295           // the person goes back in & fixes it, as opposed to a new transaction.
3296           // Currently the UI doesn't support multiple refunds against a single transaction & we are only supporting
3297           // the data fix scenario.
3298           // CRM-17751.
3299           if (isset($params['refund_trxn_id'])) {
3300             $refundIDs = CRM_Core_BAO_FinancialTrxn::getRefundTransactionIDs($params['id']);
3301             if (!empty($refundIDs['financialTrxnId']) && $refundIDs['trxn_id'] != $params['refund_trxn_id']) {
3302               civicrm_api3('FinancialTrxn', 'create', array('id' => $refundIDs['financialTrxnId'], 'trxn_id' => $params['refund_trxn_id']));
3303             }
3304           }
3305         }
3306       }
3307
3308       if (!$update) {
3309         // records finanical trxn and entity financial trxn
3310         // also make it available as return value
3311         $return = $financialTxn = CRM_Core_BAO_FinancialTrxn::create($trxnParams);
3312         $params['entity_id'] = $financialTxn->id;
3313       }
3314     }
3315     // record line items and financial items
3316     if (empty($params['skipLineItem'])) {
3317       CRM_Price_BAO_LineItem::processPriceSet($entityId, CRM_Utils_Array::value('line_item', $params), $params['contribution'], $entityTable, $update);
3318     }
3319
3320     // create batch entry if batch_id is passed and
3321     // ensure no batch entry is been made on 'Pending' or 'Failed' contribution, CRM-16611
3322     if (!empty($params['batch_id']) && !empty($financialTxn)) {
3323       $entityParams = array(
3324         'batch_id' => $params['batch_id'],
3325         'entity_table' => 'civicrm_financial_trxn',
3326         'entity_id' => $financialTxn->id,
3327       );
3328       CRM_Batch_BAO_Batch::addBatchEntity($entityParams);
3329     }
3330
3331     // when a fee is charged
3332     if (!empty($params['fee_amount']) && (empty($params['prevContribution']) || $params['contribution']->fee_amount != $params['prevContribution']->fee_amount) && $skipRecords) {
3333       CRM_Core_BAO_FinancialTrxn::recordFees($params);
3334     }
3335
3336     if (!empty($params['prevContribution']) && $entityTable == 'civicrm_participant'
3337       && $params['prevContribution']->contribution_status_id != $params['contribution']->contribution_status_id
3338     ) {
3339       $eventID = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $entityId, 'event_id');
3340       $feeLevel[] = str_replace('\ 1', '', $params['prevContribution']->amount_level);
3341       CRM_Event_BAO_Participant::createDiscountTrxn($eventID, $params, $feeLevel);
3342     }
3343     unset($params['line_item']);
3344
3345     return $return;
3346   }
3347
3348   /**
3349    * Update all financial accounts entry.
3350    *
3351    * @param array $params
3352    *   Contribution object, line item array and params for trxn.
3353    *
3354    * @param string $context
3355    *   Update scenarios.
3356    *
3357    * @param null $skipTrxn
3358    *
3359    */
3360   public static function updateFinancialAccounts(&$params, $context = NULL, $skipTrxn = NULL) {
3361     $itemAmount = $trxnID = NULL;
3362     //get all the statuses
3363     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
3364     $previousContributionStatus = CRM_Contribute_PseudoConstant::contributionStatus($params['prevContribution']->contribution_status_id, 'name');
3365     if (($previousContributionStatus == 'Pending'
3366         || $previousContributionStatus == 'In Progress')
3367       && $params['contribution']->contribution_status_id == array_search('Completed', $contributionStatus)
3368       && $context == 'changePaymentInstrument'
3369     ) {
3370       return;
3371     }
3372     if ((($previousContributionStatus == 'Partially paid'
3373       && $params['contribution']->contribution_status_id == array_search('Completed', $contributionStatus))
3374       || ($previousContributionStatus == 'Pending' && $params['prevContribution']->is_pay_later == TRUE
3375       && $params['contribution']->contribution_status_id == array_search('Partially paid', $contributionStatus)))
3376       && $context == 'changedStatus'
3377     ) {
3378       return;
3379     }
3380     if ($context == 'changedAmount' || $context == 'changeFinancialType') {
3381       $itemAmount = $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = $params['total_amount'] - $params['prevContribution']->total_amount;
3382     }
3383     if ($context == 'changedStatus') {
3384       //get all the statuses
3385       $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
3386       $cancelledTaxAmount = 0;
3387       if ($previousContributionStatus == 'Completed'
3388         && (self::isContributionStatusNegative($params['contribution']->contribution_status_id))
3389       ) {
3390         $params['trxnParams']['total_amount'] = -$params['total_amount'];
3391         $cancelledTaxAmount = CRM_Utils_Array::value('tax_amount', $params, '0.00');
3392         if (empty($params['contribution']->creditnote_id) || $params['contribution']->creditnote_id == "null") {
3393           $creditNoteId = self::createCreditNoteId();
3394           CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution']->id, 'creditnote_id', $creditNoteId);
3395         }
3396       }
3397       elseif (($previousContributionStatus == 'Pending'
3398           && $params['prevContribution']->is_pay_later) || $previousContributionStatus == 'In Progress'
3399       ) {
3400         $financialTypeID = CRM_Utils_Array::value('financial_type_id', $params) ? $params['financial_type_id'] : $params['prevContribution']->financial_type_id;
3401         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3402         $arAccountId = CRM_Contribute_PseudoConstant::financialAccountType($financialTypeID, $relationTypeId);
3403
3404         if ($params['contribution']->contribution_status_id == array_search('Cancelled', $contributionStatus)) {
3405           $params['trxnParams']['to_financial_account_id'] = $arAccountId;
3406           $params['trxnParams']['total_amount'] = -$params['total_amount'];
3407           if (is_null($params['contribution']->creditnote_id) || $params['contribution']->creditnote_id == "null") {
3408             $creditNoteId = self::createCreditNoteId();
3409             CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution']->id, 'creditnote_id', $creditNoteId);
3410           }
3411         }
3412         else {
3413           $params['trxnParams']['from_financial_account_id'] = $arAccountId;
3414         }
3415       }
3416       $itemAmount = $params['trxnParams']['total_amount'] + $cancelledTaxAmount;
3417     }
3418     elseif ($context == 'changePaymentInstrument') {
3419       if ($params['trxnParams']['total_amount'] < 0) {
3420         $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['prevContribution']->id, 'DESC');
3421         if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
3422           $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
3423           $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id;
3424         }
3425       }
3426       else {
3427         $params['trxnParams']['to_financial_account_id'] = $params['to_financial_account_id'];
3428         $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
3429       }
3430     }
3431
3432     if ($context == 'changedStatus') {
3433       if (($previousContributionStatus == 'Pending'
3434           || $previousContributionStatus == 'In Progress')
3435         && ($params['contribution']->contribution_status_id == array_search('Completed', $contributionStatus))
3436       ) {
3437         if (empty($params['line_item'])) {
3438           //CRM-15296
3439           //@todo - check with Joe regarding this situation - payment processors create pending transactions with no line items
3440           // when creating recurring membership payment - there are 2 lines to comment out in contributonPageTest if fixed
3441           // & this can be removed
3442           return;
3443         }
3444         $trxn = CRM_Core_BAO_FinancialTrxn::create($params['trxnParams']);
3445         $params['entity_id'] = $trxn->id;
3446         $query = "UPDATE civicrm_financial_item SET status_id = %1 WHERE entity_id = %2 and entity_table = 'civicrm_line_item'";
3447         $sql = "SELECT id, amount FROM civicrm_financial_item WHERE entity_id = %1 and entity_table = 'civicrm_line_item'";
3448
3449         $entityParams = array(
3450           'entity_table' => 'civicrm_financial_item',
3451           'financial_trxn_id' => $trxn->id,
3452         );
3453         foreach ($params['line_item'] as $fieldId => $fields) {
3454           foreach ($fields as $fieldValueId => $fieldValues) {
3455             $fparams = array(
3456               1 => array(CRM_Core_OptionGroup::getValue('financial_item_status', 'Paid', 'name'), 'Integer'),
3457               2 => array($fieldValues['id'], 'Integer'),
3458             );
3459             CRM_Core_DAO::executeQuery($query, $fparams);
3460             $fparams = array(
3461               1 => array($fieldValues['id'], 'Integer'),
3462             );
3463             $financialItem = CRM_Core_DAO::executeQuery($sql, $fparams);
3464             while ($financialItem->fetch()) {
3465               $entityParams['entity_id'] = $financialItem->id;
3466               $entityParams['amount'] = $financialItem->amount;
3467               CRM_Financial_BAO_FinancialItem::createEntityTrxn($entityParams);
3468             }
3469           }
3470         }
3471         return;
3472       }
3473     }
3474
3475     $trxn = CRM_Core_BAO_FinancialTrxn::create($params['trxnParams']);
3476     $params['entity_id'] = $trxn->id;
3477     if ($context != 'changePaymentInstrument') {
3478       $itemParams['entity_table'] = 'civicrm_line_item';
3479       $trxnIds['id'] = $params['entity_id'];
3480       foreach ($params['line_item'] as $fieldId => $fields) {
3481         foreach ($fields as $fieldValueId => $fieldValues) {
3482           $prevParams['entity_id'] = $fieldValues['id'];
3483           $prevFinancialItem = CRM_Financial_BAO_FinancialItem::retrieve($prevParams, CRM_Core_DAO::$_nullArray);
3484
3485           $receiveDate = CRM_Utils_Date::isoToMysql($params['prevContribution']->receive_date);
3486           if ($params['contribution']->receive_date) {
3487             $receiveDate = CRM_Utils_Date::isoToMysql($params['contribution']->receive_date);
3488           }
3489
3490           $financialAccount = self::getFinancialAccountForStatusChangeTrxn($params, $prevFinancialItem);
3491
3492           $currency = $params['prevContribution']->currency;
3493           if ($params['contribution']->currency) {
3494             $currency = $params['contribution']->currency;
3495           }
3496           $diff = 1;
3497           if ($context == 'changeFinancialType' || self::isContributionStatusNegative($params['contribution']->contribution_status_id)) {
3498             $diff = -1;
3499           }
3500           if (!empty($params['is_quick_config'])) {
3501             $amount = $itemAmount;
3502             if (!$amount) {
3503               $amount = $params['total_amount'];
3504             }
3505           }
3506           else {
3507             $amount = $diff * $fieldValues['line_total'];
3508           }
3509
3510           $itemParams = array(
3511             'transaction_date' => $receiveDate,
3512             'contact_id' => $params['prevContribution']->contact_id,
3513             'currency' => $currency,
3514             'amount' => $amount,
3515             'description' => $prevFinancialItem->description,
3516             'status_id' => $prevFinancialItem->status_id,
3517             'financial_account_id' => $financialAccount,
3518             'entity_table' => 'civicrm_line_item',
3519             'entity_id' => $fieldValues['id'],
3520           );
3521           CRM_Financial_BAO_FinancialItem::create($itemParams, NULL, $trxnIds);
3522
3523           if ($fieldValues['tax_amount']) {
3524             $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
3525             $taxTerm = CRM_Utils_Array::value('tax_term', $invoiceSettings);
3526             $itemParams['amount'] = $diff * $fieldValues['tax_amount'];
3527             $itemParams['description'] = $taxTerm;
3528             if ($fieldValues['financial_type_id']) {
3529               $itemParams['financial_account_id'] = self::getFinancialAccountId($fieldValues['financial_type_id']);
3530             }
3531             CRM_Financial_BAO_FinancialItem::create($itemParams, NULL, $trxnIds);
3532           }
3533         }
3534       }
3535     }
3536     if ($context == 'changeFinancialType') {
3537       $params['skipLineItem'] = FALSE;
3538       foreach ($params['line_item'] as &$lineItems) {
3539         foreach ($lineItems as &$line) {
3540           $line['financial_type_id'] = $params['financial_type_id'];
3541         }
3542       }
3543     }
3544   }
3545
3546   /**
3547    * Is this contribution status a reversal.
3548    *
3549    * If so we would expect to record a negative value in the financial_trxn table.
3550    *
3551    * @param int $status_id
3552    *
3553    * @return bool
3554    */
3555   public static function isContributionStatusNegative($status_id) {
3556     $reversalStatuses = array('Cancelled', 'Chargeback', 'Refunded');
3557     return in_array(CRM_Contribute_PseudoConstant::contributionStatus($status_id, 'name'), $reversalStatuses);
3558   }
3559
3560   /**
3561    * Check status validation on update of a contribution.
3562    *
3563    * @param array $values
3564    *   Previous form values before submit.
3565    *
3566    * @param array $fields
3567    *   The input form values.
3568    *
3569    * @param array $errors
3570    *   List of errors.
3571    *
3572    * @return bool
3573    */
3574   public static function checkStatusValidation($values, &$fields, &$errors) {
3575     if (CRM_Utils_System::isNull($values) && !empty($fields['id'])) {
3576       $values['contribution_status_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $fields['id'], 'contribution_status_id');
3577       if ($values['contribution_status_id'] == $fields['contribution_status_id']) {
3578         return FALSE;
3579       }
3580     }
3581     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
3582     $checkStatus = array(
3583       'Cancelled' => array('Completed', 'Refunded'),
3584       'Completed' => array('Cancelled', 'Refunded', 'Chargeback'),
3585       'Pending' => array('Cancelled', 'Completed', 'Failed', 'Partially paid'),
3586       'In Progress' => array('Cancelled', 'Completed', 'Failed'),
3587       'Refunded' => array('Cancelled', 'Completed'),
3588       'Partially paid' => array('Completed'),
3589     );
3590
3591     if (!in_array($contributionStatuses[$fields['contribution_status_id']],
3592       CRM_Utils_Array::value($contributionStatuses[$values['contribution_status_id']], $checkStatus, array()))
3593     ) {
3594       $errors['contribution_status_id'] = ts("Cannot change contribution status from %1 to %2.", array(
3595         1 => $contributionStatuses[$values['contribution_status_id']],
3596         2 => $contributionStatuses[$fields['contribution_status_id']],
3597       ));
3598     }
3599   }
3600
3601   /**
3602    * Delete contribution of contact.
3603    *
3604    * CRM-12155
3605    *
3606    * @param int $contactId
3607    *   Contact id.
3608    *
3609    */
3610   public static function deleteContactContribution($contactId) {
3611     $contribution = new CRM_Contribute_DAO_Contribution();
3612     $contribution->contact_id = $contactId;
3613     $contribution->find();
3614     while ($contribution->fetch()) {
3615       self::deleteContribution($contribution->id);
3616     }
3617   }
3618
3619   /**
3620    * Get options for a given contribution field.
3621    * @see CRM_Core_DAO::buildOptions
3622    *
3623    * @param string $fieldName
3624    * @param string $context see CRM_Core_DAO::buildOptionsContext.
3625    * @param array $props  whatever is known about this dao object.
3626    *
3627    * @return array|bool
3628    */
3629   public static function buildOptions($fieldName, $context = NULL, $props = array()) {
3630     $className = __CLASS__;
3631     $params = array();
3632     switch ($fieldName) {
3633       // This field is not part of this object but the api supports it
3634       case 'payment_processor':
3635         $className = 'CRM_Contribute_BAO_ContributionPage';
3636         // Filter results by contribution page
3637         if (!empty($props['contribution_page_id'])) {
3638           $page = civicrm_api('contribution_page', 'getsingle', array(
3639             'version' => 3,
3640             'id' => ($props['contribution_page_id']),
3641           ));
3642           $types = (array) CRM_Utils_Array::value('payment_processor', $page, 0);
3643           $params['condition'] = 'id IN (' . implode(',', $types) . ')';
3644         }
3645         break;
3646
3647       // CRM-13981 This field was combined with soft_credits in 4.5 but the api still supports it
3648       case 'honor_type_id':
3649         $className = 'CRM_Contribute_BAO_ContributionSoft';
3650         $fieldName = 'soft_credit_type_id';
3651         $params['condition'] = "v.name IN ('in_honor_of','in_memory_of')";
3652         break;
3653     }
3654     return CRM_Core_PseudoConstant::get($className, $fieldName, $params, $context);
3655   }
3656
3657   /**
3658    * Validate financial type.
3659    *
3660    * CRM-13231
3661    *
3662    * @param int $financialTypeId
3663    *   Financial Type id.
3664    *
3665    * @param string $relationName
3666    *
3667    * @return array|bool
3668    */
3669   public static function validateFinancialType($financialTypeId, $relationName = 'Expense Account is') {
3670     $expenseTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE '{$relationName}' "));
3671     $financialAccount = CRM_Contribute_PseudoConstant::financialAccountType($financialTypeId, $expenseTypeId);
3672
3673     if (!$financialAccount) {
3674       return CRM_Contribute_PseudoConstant::financialType($financialTypeId);
3675     }
3676     return FALSE;
3677   }
3678
3679
3680   /**
3681    * Function to record additional payment for partial and refund contributions.
3682    *
3683    * @param int $contributionId
3684    *   is the invoice contribution id (got created after processing participant payment).
3685    * @param array $trxnsData
3686    *   to take user provided input of transaction details.
3687    * @param string $paymentType
3688    *   'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments.
3689    * @param int $participantId
3690    *
3691    * @return null|object
3692    */
3693   public static function recordAdditionalPayment($contributionId, $trxnsData, $paymentType = 'owed', $participantId = NULL, $updateStatus = TRUE) {
3694     $statusId = CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name');
3695     $getInfoOf['id'] = $contributionId;
3696     $defaults = array();
3697     $contributionDAO = CRM_Contribute_BAO_Contribution::retrieve($getInfoOf, $defaults, CRM_Core_DAO::$_nullArray);
3698     if (!$participantId) {
3699       $participantId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment', $contributionId, 'participant_id');
3700     }
3701
3702     if ($paymentType == 'owed') {
3703       // build params for recording financial trxn entry
3704       $params['contribution'] = $contributionDAO;
3705       $params = array_merge($defaults, $params);
3706       $params['skipLineItem'] = TRUE;
3707       $params['partial_payment_total'] = $contributionDAO->total_amount;
3708       $params['partial_amount_pay'] = $trxnsData['total_amount'];
3709       $trxnsData['trxn_date'] = !empty($trxnsData['trxn_date']) ? $trxnsData['trxn_date'] : date('YmdHis');
3710       $trxnsData['net_amount'] = !empty($trxnsData['net_amount']) ? $trxnsData['net_amount'] : $trxnsData['total_amount'];
3711
3712       // record the entry
3713       $financialTrxn = CRM_Contribute_BAO_Contribution::recordFinancialAccounts($params, $trxnsData);
3714       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3715       $toFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($contributionDAO->financial_type_id, $relationTypeId);
3716
3717       $trxnId = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($contributionId, $contributionDAO->financial_type_id);
3718       if (!empty($trxnId)) {
3719         $trxnId = $trxnId['trxn_id'];
3720       }
3721       elseif (!empty($contributionDAO->payment_instrument_id)) {
3722         $trxnId = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($contributionDAO->payment_instrument_id);
3723       }
3724       else {
3725         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
3726         $queryParams = array(1 => array($relationTypeId, 'Integer'));
3727         $trxnId = CRM_Core_DAO::singleValueQuery("SELECT id FROM civicrm_financial_account WHERE is_default = 1 AND financial_account_type_id = %1", $queryParams);
3728       }
3729
3730       // update statuses
3731       // criteria for updates contribution total_amount == financial_trxns of partial_payments
3732       $sql = "SELECT SUM(ft.total_amount) as sum_of_payments, SUM(ft.net_amount) as net_amount_total
3733 FROM civicrm_financial_trxn ft
3734 LEFT JOIN civicrm_entity_financial_trxn eft
3735   ON (ft.id = eft.financial_trxn_id)
3736 WHERE eft.entity_table = 'civicrm_contribution'
3737   AND eft.entity_id = {$contributionId}
3738   AND ft.to_financial_account_id != {$toFinancialAccount}
3739   AND ft.status_id = {$statusId}
3740 ";
3741       $query = CRM_Core_DAO::executeQuery($sql);
3742       $query->fetch();
3743       $sumOfPayments = $query->sum_of_payments;
3744
3745       // update statuses
3746       if ($contributionDAO->total_amount == $sumOfPayments) {
3747         // update contribution status and
3748         // clean cancel info (if any) if prev. contribution was updated in case of 'Refunded' => 'Completed'
3749         $contributionDAO->contribution_status_id = $statusId;
3750         $contributionDAO->cancel_date = 'null';
3751         $contributionDAO->cancel_reason = NULL;
3752         $netAmount = !empty($trxnsData['net_amount']) ? NULL : $trxnsData['total_amount'];
3753         $contributionDAO->net_amount = $query->net_amount_total + $netAmount;
3754         $contributionDAO->fee_amount = $contributionDAO->total_amount - $contributionDAO->net_amount;
3755         $contributionDAO->save();
3756
3757         //Change status of financial record too
3758         $financialTrxn->status_id = $statusId;
3759         $financialTrxn->save();
3760
3761         // note : not using the self::add method,
3762         // the reason because it performs 'status change' related code execution for financial records
3763         // which in 'Partial Paid' => 'Completed' is not useful, instead specific financial record updates
3764         // are coded below i.e. just updating financial_item status to 'Paid'
3765
3766         if ($participantId) {
3767           // update participant status
3768           $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
3769           $ids = CRM_Event_BAO_Participant::getParticipantIds($contributionId);
3770           foreach ($ids as $val) {
3771             $participantUpdate['id'] = $val;
3772             $participantUpdate['status_id'] = array_search('Registered', $participantStatuses);
3773             CRM_Event_BAO_Participant::add($participantUpdate);
3774           }
3775         }
3776
3777         // update financial item statuses
3778         $financialItemStatus = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_FinancialItem', 'status_id');
3779         $paidStatus = array_search('Paid', $financialItemStatus);
3780
3781         $baseTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($contributionId);
3782         $sqlFinancialItemUpdate = "
3783 UPDATE civicrm_financial_item fi
3784   LEFT JOIN civicrm_entity_financial_trxn eft
3785     ON (eft.entity_id = fi.id AND eft.entity_table = 'civicrm_financial_item')
3786 SET status_id = {$paidStatus}
3787 WHERE eft.financial_trxn_id IN ({$trxnId}, {$baseTrxnId['financialTrxnId']})
3788 ";
3789         CRM_Core_DAO::executeQuery($sqlFinancialItemUpdate);
3790       }
3791     }
3792     elseif ($paymentType == 'refund') {
3793       // build params for recording financial trxn entry
3794       $params['contribution'] = $contributionDAO;
3795       $params = array_merge($defaults, $params);
3796       $params['skipLineItem'] = TRUE;
3797       $trxnsData['trxn_date'] = !empty($trxnsData['trxn_date']) ? $trxnsData['trxn_date'] : date('YmdHis');
3798       $trxnsData['total_amount'] = -$trxnsData['total_amount'];
3799
3800       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3801       $trxnsData['from_financial_account_id'] = CRM_Contribute_PseudoConstant::financialAccountType($contributionDAO->financial_type_id, $relationTypeId);
3802       $trxnsData['status_id'] = CRM_Core_OptionGroup::getValue('contribution_status', 'Refunded', 'name');
3803       // record the entry
3804       $financialTrxn = CRM_Contribute_BAO_Contribution::recordFinancialAccounts($params, $trxnsData);
3805
3806       // note : not using the self::add method,
3807       // the reason because it performs 'status change' related code execution for financial records
3808       // which in 'Pending Refund' => 'Completed' is not useful, instead specific financial record updates
3809       // are coded below i.e. just updating financial_item status to 'Paid'
3810       if ($updateStatus) {
3811         $contributionDetails = CRM_Core_DAO::setFieldValue('CRM_Contribute_BAO_Contribution', $contributionId, 'contribution_status_id', $statusId);
3812       }
3813       // add financial item entry
3814       $financialItemStatus = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_FinancialItem', 'status_id');
3815       $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($contributionDAO->id);
3816       if (!empty($lineItems)) {
3817         foreach ($lineItems as $lineItemId => $lineItemValue) {
3818           $paid = $lineItemValue['line_total'] * ($financialTrxn->total_amount / $contributionDAO->total_amount);
3819           $addFinancialEntry = array(
3820             'transaction_date' => $financialTrxn->trxn_date,
3821             'contact_id' => $contributionDAO->contact_id,
3822             'amount' => round($paid, 2),
3823             'status_id' => array_search('Paid', $financialItemStatus),
3824             'entity_id' => $lineItemId,
3825             'entity_table' => 'civicrm_line_item',
3826           );
3827           $trxnIds['id'] = $financialTrxn->id;
3828           CRM_Financial_BAO_FinancialItem::create($addFinancialEntry, NULL, $trxnIds);
3829         }
3830       }
3831       if ($participantId) {
3832         // update participant status
3833         $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
3834         $ids = CRM_Event_BAO_Participant::getParticipantIds($contributionId);
3835         foreach ($ids as $val) {
3836           $participantUpdate['id'] = $val;
3837           $participantUpdate['status_id'] = array_search('Registered', $participantStatuses);
3838           CRM_Event_BAO_Participant::add($participantUpdate);
3839         }
3840       }
3841     }
3842
3843     // activity creation
3844     if (!empty($financialTrxn)) {
3845       if ($participantId) {
3846         $inputParams['id'] = $participantId;
3847         $values = array();
3848         $ids = array();
3849         $component = 'event';
3850         $entityObj = CRM_Event_BAO_Participant::getValues($inputParams, $values, $ids);
3851         $entityObj = $entityObj[$participantId];
3852       }
3853       $activityType = ($paymentType == 'refund') ? 'Refund' : 'Payment';
3854
3855       self::addActivityForPayment($entityObj, $financialTrxn, $activityType, $component, $contributionId);
3856     }
3857     return $financialTrxn;
3858   }
3859
3860   /**
3861    * @param $entityObj
3862    * @param $trxnObj
3863    * @param $activityType
3864    * @param $component
3865    * @param int $contributionId
3866    *
3867    * @throws CRM_Core_Exception
3868    */
3869   public static function addActivityForPayment($entityObj, $trxnObj, $activityType, $component, $contributionId) {
3870     if ($component == 'event') {
3871       $date = CRM_Utils_Date::isoToMysql($trxnObj->trxn_date);
3872       $paymentAmount = CRM_Utils_Money::format($trxnObj->total_amount, $trxnObj->currency);
3873       $eventTitle = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Event', $entityObj->event_id, 'title');
3874       $subject = "{$paymentAmount} - Offline {$activityType} for {$eventTitle}";
3875       $targetCid = $entityObj->contact_id;
3876       // source record id would be the contribution id
3877       $srcRecId = $contributionId;
3878     }
3879
3880     // activity params
3881     $activityParams = array(
3882       'source_contact_id' => $targetCid,
3883       'source_record_id' => $srcRecId,
3884       'activity_type_id' => CRM_Core_OptionGroup::getValue('activity_type',
3885         $activityType,
3886         'name'
3887       ),
3888       'subject' => $subject,
3889       'activity_date_time' => $date,
3890       'status_id' => CRM_Core_OptionGroup::getValue('activity_status',
3891         'Completed',
3892         'name'
3893       ),
3894       'skipRecentView' => TRUE,
3895     );
3896
3897     // create activity with target contacts
3898     $session = CRM_Core_Session::singleton();
3899     $id = $session->get('userID');
3900     if ($id) {
3901       $activityParams['source_contact_id'] = $id;
3902       $activityParams['target_contact_id'][] = $targetCid;
3903     }
3904     CRM_Activity_BAO_Activity::create($activityParams);
3905   }
3906
3907   /**
3908    * Get list of payments displayed by Contribute_Page_PaymentInfo.
3909    *
3910    * @param int $id
3911    * @param $component
3912    * @param bool $getTrxnInfo
3913    * @param bool $usingLineTotal
3914    *
3915    * @return mixed
3916    */
3917   public static function getPaymentInfo($id, $component, $getTrxnInfo = FALSE, $usingLineTotal = FALSE) {
3918     if ($component == 'event') {
3919       $entity = 'participant';
3920       $entityTable = 'civicrm_participant';
3921       $contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'contribution_id', 'participant_id');
3922
3923       if (!$contributionId) {
3924         if ($primaryParticipantId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Participant', $id, 'registered_by_id')) {
3925           $contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $primaryParticipantId, 'contribution_id', 'participant_id');
3926           $id = $primaryParticipantId;
3927         }
3928         if (!$contributionId) {
3929           return;
3930         }
3931       }
3932     }
3933     else {
3934       $contributionId = $id;
3935       $entity = 'contribution';
3936       $entityTable = 'civicrm_contribution';
3937     }
3938
3939     $total = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($contributionId);
3940     $baseTrxnId = !empty($total['trxn_id']) ? $total['trxn_id'] : NULL;
3941     $isBalance = NULL;
3942     if ($baseTrxnId) {
3943       $isBalance = TRUE;
3944     }
3945     else {
3946       $baseTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($contributionId);
3947       $baseTrxnId = $baseTrxnId['financialTrxnId'];
3948       $isBalance = FALSE;
3949     }
3950     if (!CRM_Utils_Array::value('total_amount', $total) || $usingLineTotal) {
3951       // for additional participants
3952       if ($entityTable == 'civicrm_participant') {
3953         $ids = CRM_Event_BAO_Participant::getParticipantIds($contributionId);
3954         $total = 0;
3955         foreach ($ids as $val) {
3956           $total += CRM_Price_BAO_LineItem::getLineTotal($val, $entityTable);
3957         }
3958       }
3959       else {
3960         $total = CRM_Price_BAO_LineItem::getLineTotal($id, $entityTable);
3961       }
3962     }
3963     else {
3964       $baseTrxnId = $total['trxn_id'];
3965       $total = $total['total_amount'];
3966     }
3967
3968     $paymentBalance = CRM_Core_BAO_FinancialTrxn::getPartialPaymentWithType($id, $entity, FALSE, $total);
3969     $contributionIsPayLater = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'is_pay_later');
3970
3971     $feeRelationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Expense Account is' "));
3972     $financialTypeId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id');
3973     $feeFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($financialTypeId, $feeRelationTypeId);
3974
3975     if ($paymentBalance == 0 && $contributionIsPayLater) {
3976       $paymentBalance = $total;
3977     }
3978
3979     $info['total'] = $total;
3980     $info['paid'] = $total - $paymentBalance;
3981     $info['balance'] = $paymentBalance;
3982     $info['id'] = $id;
3983     $info['component'] = $component;
3984     $info['payLater'] = $contributionIsPayLater;
3985     $rows = array();
3986     if ($getTrxnInfo && $baseTrxnId) {
3987       // Need to exclude fee trxn rows so filter out rows where TO FINANCIAL ACCOUNT is expense account
3988       $sql = "
3989         SELECT GROUP_CONCAT(fa.`name`) as financial_account,
3990           ft.total_amount,
3991           ft.payment_instrument_id,
3992           ft.trxn_date, ft.trxn_id, ft.status_id, ft.check_number
3993
3994         FROM civicrm_contribution con
3995           LEFT JOIN civicrm_entity_financial_trxn eft ON (eft.entity_id = con.id AND eft.entity_table = 'civicrm_contribution')
3996           INNER JOIN civicrm_financial_trxn ft ON ft.id = eft.financial_trxn_id
3997             AND ft.to_financial_account_id != {$feeFinancialAccount}
3998           INNER JOIN civicrm_entity_financial_trxn ef ON (ef.financial_trxn_id = ft.id AND ef.entity_table = 'civicrm_financial_item')
3999           LEFT JOIN civicrm_financial_item fi ON fi.id = ef.entity_id
4000           INNER JOIN civicrm_financial_account fa ON fa.id = fi.financial_account_id
4001
4002         WHERE con.id = {$contributionId}
4003         GROUP BY ft.id
4004       ";
4005
4006       // conditioned WHERE clause
4007       if ($isBalance) {
4008         // if balance trxn exists don't include details of it in transaction info
4009         $sql .= " AND ft.id != {$baseTrxnId} ";
4010       }
4011       $resultDAO = CRM_Core_DAO::executeQuery($sql);
4012
4013       $statuses = CRM_Contribute_PseudoConstant::contributionStatus();
4014
4015       while ($resultDAO->fetch()) {
4016         $paidByLabel = CRM_Core_PseudoConstant::getLabel('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id);
4017         $paidByName = CRM_Core_PseudoConstant::getName('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id);
4018         $val = array(
4019           'total_amount' => $resultDAO->total_amount,
4020           'financial_type' => $resultDAO->financial_account,
4021           'payment_instrument' => $paidByLabel,
4022           'receive_date' => $resultDAO->trxn_date,
4023           'trxn_id' => $resultDAO->trxn_id,
4024           'status' => $statuses[$resultDAO->status_id],
4025         );
4026         if ($paidByName == 'Check') {
4027           $val['check_number'] = $resultDAO->check_number;
4028         }
4029         $rows[] = $val;
4030       }
4031       $info['transaction'] = $rows;
4032     }
4033     return $info;
4034   }
4035
4036   /**
4037    * Get financial account id has 'Sales Tax Account is'
4038    * account relationship with financial type
4039    *
4040    * @param int $financialTypeId
4041    *
4042    * @return FinancialAccountId
4043    */
4044   public static function getFinancialAccountId($financialTypeId) {
4045     $accountRel = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' "));
4046     $searchParams = array(
4047       'entity_table' => 'civicrm_financial_type',
4048       'entity_id' => $financialTypeId,
4049       'account_relationship' => $accountRel,
4050     );
4051     $result = array();
4052     CRM_Financial_BAO_FinancialTypeAccount::retrieve($searchParams, $result);
4053
4054     return CRM_Utils_Array::value('financial_account_id', $result);
4055   }
4056
4057   /**
4058    * Check tax amount.
4059    *
4060    * @param array $params
4061    * @param bool $isLineItem
4062    *
4063    * @return mixed
4064    */
4065   public static function checkTaxAmount($params, $isLineItem = FALSE) {
4066     $taxRates = CRM_Core_PseudoConstant::getTaxRates();
4067
4068     // Update contribution.
4069     if (!empty($params['id'])) {
4070       $id = $params['id'];
4071       $values = $ids = array();
4072       $contrbutionParams = array('id' => $id);
4073       $prevContributionValue = CRM_Contribute_BAO_Contribution::getValues($contrbutionParams, $values, $ids);
4074
4075       // To assign pervious finantial type on update of contribution
4076       if (!isset($params['financial_type_id'])) {
4077         $params['financial_type_id'] = $prevContributionValue->financial_type_id;
4078       }
4079       elseif (isset($params['financial_type_id']) && !array_key_exists($params['financial_type_id'], $taxRates)) {
4080         // Assisn tax Amount on update of contrbution
4081         if (!empty($prevContributionValue->tax_amount)) {
4082           $params['tax_amount'] = 'null';
4083           CRM_Price_BAO_LineItem::getLineItemArray($params, array($params['id']));
4084           foreach ($params['line_item'] as $setID => $priceField) {
4085             foreach ($priceField as $priceFieldID => $priceFieldValue) {
4086               $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4087             }
4088           }
4089         }
4090       }
4091     }
4092
4093     // New Contrbution and update of contribution with tax rate financial type
4094     if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) &&
4095       empty($params['skipLineItem']) && !$isLineItem
4096     ) {
4097       $taxRateParams = $taxRates[$params['financial_type_id']];
4098       $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount(CRM_Utils_Array::value('total_amount', $params), $taxRateParams);
4099       $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4100
4101       // Get Line Item on update of contribution
4102       if (isset($params['id'])) {
4103         CRM_Price_BAO_LineItem::getLineItemArray($params, array($params['id']));
4104       }
4105       else {
4106         CRM_Price_BAO_LineItem::getLineItemArray($params);
4107       }
4108       foreach ($params['line_item'] as $setID => $priceField) {
4109         foreach ($priceField as $priceFieldID => $priceFieldValue) {
4110           $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4111         }
4112       }
4113       $params['total_amount'] = CRM_Utils_Array::value('total_amount', $params) + $params['tax_amount'];
4114     }
4115     elseif (isset($params['api.line_item.create'])) {
4116       // Update total amount of contribution using lineItem
4117       $taxAmountArray = array();
4118       foreach ($params['api.line_item.create'] as $key => $value) {
4119         if (isset($value['financial_type_id']) && array_key_exists($value['financial_type_id'], $taxRates)) {
4120           $taxRate = $taxRates[$value['financial_type_id']];
4121           $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount($value['line_total'], $taxRate);
4122           $taxAmountArray[] = round($taxAmount['tax_amount'], 2);
4123         }
4124       }
4125       $params['tax_amount'] = array_sum($taxAmountArray);
4126       $params['total_amount'] = $params['total_amount'] + $params['tax_amount'];
4127     }
4128     else {
4129       // update line item of contrbution
4130       if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) && $isLineItem) {
4131         $taxRate = $taxRates[$params['financial_type_id']];
4132         $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount($params['line_total'], $taxRate);
4133         $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4134       }
4135     }
4136     return $params;
4137   }
4138
4139   /**
4140    * Check financial type validation on update of a contribution.
4141    *
4142    * @param Integer $financialTypeId
4143    *   Value of latest Financial Type.
4144    *
4145    * @param Integer $contributionId
4146    *   Contribution Id.
4147    *
4148    * @param array $errors
4149    *   List of errors.
4150    *
4151    * @return bool
4152    */
4153   public static function checkFinancialTypeChange($financialTypeId, $contributionId, &$errors) {
4154     if (!empty($financialTypeId)) {
4155       $oldFinancialTypeId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id');
4156       if ($oldFinancialTypeId == $financialTypeId) {
4157         return FALSE;
4158       }
4159     }
4160     $sql = 'SELECT financial_type_id FROM civicrm_line_item WHERE contribution_id = %1 GROUP BY financial_type_id;';
4161     $params = array(
4162       '1' => array($contributionId, 'Integer'),
4163     );
4164     $result = CRM_Core_DAO::executeQuery($sql, $params);
4165     if ($result->N > 1) {
4166       $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.');
4167     }
4168   }
4169
4170   /**
4171    * Update related pledge payment payments.
4172    *
4173    * This function has been refactored out of the back office contribution form and may
4174    * still overlap with other functions.
4175    *
4176    * @param string $action
4177    * @param int $pledgePaymentID
4178    * @param int $contributionID
4179    * @param bool $adjustTotalAmount
4180    * @param float $total_amount
4181    * @param float $original_total_amount
4182    * @param int $contribution_status_id
4183    * @param int $original_contribution_status_id
4184    */
4185   public static function updateRelatedPledge(
4186     $action,
4187     $pledgePaymentID,
4188     $contributionID,
4189     $adjustTotalAmount,
4190     $total_amount,
4191     $original_total_amount,
4192     $contribution_status_id,
4193     $original_contribution_status_id
4194   ) {
4195     if (!$pledgePaymentID && $action & CRM_Core_Action::ADD && !$contributionID) {
4196       return;
4197     }
4198
4199     if ($pledgePaymentID) {
4200       //store contribution id in payment record.
4201       CRM_Core_DAO::setFieldValue('CRM_Pledge_DAO_PledgePayment', $pledgePaymentID, 'contribution_id', $contributionID);
4202     }
4203     else {
4204       $pledgePaymentID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4205         $contributionID,
4206         'id',
4207         'contribution_id'
4208       );
4209     }
4210
4211     if (!$pledgePaymentID) {
4212       return;
4213     }
4214     $pledgeID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4215       $contributionID,
4216       'pledge_id',
4217       'contribution_id'
4218     );
4219
4220     $updatePledgePaymentStatus = FALSE;
4221
4222     // If either the status or the amount has changed we update the pledge status.
4223     if ($action & CRM_Core_Action::ADD) {
4224       $updatePledgePaymentStatus = TRUE;
4225     }
4226     elseif ($action & CRM_Core_Action::UPDATE && (($original_contribution_status_id != $contribution_status_id) ||
4227         ($original_total_amount != $total_amount))
4228     ) {
4229       $updatePledgePaymentStatus = TRUE;
4230     }
4231
4232     if ($updatePledgePaymentStatus) {
4233       CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID,
4234         array($pledgePaymentID),
4235         $contribution_status_id,
4236         NULL,
4237         $total_amount,
4238         $adjustTotalAmount
4239       );
4240     }
4241   }
4242
4243   /**
4244    * Compute the stats values
4245    *
4246    * @param $stat either 'mode' or 'median'
4247    * @param $sql
4248    * @param $alias of civicrm_contribution
4249    */
4250   public static function computeStats($stat, $sql, $alias = NULL) {
4251     $mode = $median = array();
4252     switch ($stat) {
4253       case 'mode':
4254         $modeDAO = CRM_Core_DAO::executeQuery($sql);
4255         while ($modeDAO->fetch()) {
4256           if ($modeDAO->civicrm_contribution_total_amount_count > 1) {
4257             $mode[] = CRM_Utils_Money::format($modeDAO->amount, $modeDAO->currency);
4258           }
4259           else {
4260             $mode[] = 'N/A';
4261           }
4262         }
4263         return $mode;
4264
4265       case 'median':
4266         $currencies = CRM_Core_OptionGroup::values('currencies_enabled');
4267         foreach ($currencies as $currency => $val) {
4268           $midValue = 0;
4269           $where = "AND {$alias}.currency = '{$currency}'";
4270           $rowCount = CRM_Core_DAO::singleValueQuery("SELECT count(*) as count {$sql} {$where}");
4271
4272           $even = FALSE;
4273           $offset = 1;
4274           $medianRow = floor($rowCount / 2);
4275           if ($rowCount % 2 == 0 && !empty($medianRow)) {
4276             $even = TRUE;
4277             $offset++;
4278             $medianRow--;
4279           }
4280
4281           $medianValue = "SELECT {$alias}.total_amount as median
4282              {$sql} {$where}
4283              ORDER BY median LIMIT {$medianRow},{$offset}";
4284           $medianValDAO = CRM_Core_DAO::executeQuery($medianValue);
4285           while ($medianValDAO->fetch()) {
4286             if ($even) {
4287               $midValue = $midValue + $medianValDAO->median;
4288             }
4289             else {
4290               $median[] = CRM_Utils_Money::format($medianValDAO->median, $currency);
4291             }
4292           }
4293           if ($even) {
4294             $midValue = $midValue / 2;
4295             $median[] = CRM_Utils_Money::format($midValue, $currency);
4296           }
4297         }
4298         return $median;
4299
4300       default:
4301         return;
4302     }
4303   }
4304
4305   /**
4306    * Is there only one line item attached to the contribution.
4307    *
4308    * @param int $id
4309    *   Contribution ID.
4310    *
4311    * @return bool
4312    * @throws \CiviCRM_API3_Exception
4313    */
4314   public static function isSingleLineItem($id) {
4315     $lineItemCount = civicrm_api3('LineItem', 'getcount', array('contribution_id' => $id));
4316     return ($lineItemCount == 1);
4317   }
4318
4319   /**
4320    * Complete an order.
4321    *
4322    * Do not call this directly - use the contribution.completetransaction api as this function is being refactored.
4323    *
4324    * Currently overloaded to complete a transaction & repeat a transaction - fix!
4325    *
4326    * Moving it out of the BaseIPN class is just the first step.
4327    *
4328    * @param array $input
4329    * @param array $ids
4330    * @param array $objects
4331    * @param CRM_Core_Transaction $transaction
4332    * @param int $recur
4333    * @param CRM_Contribute_BAO_Contribution $contribution
4334    * @param bool $isRecurring
4335    *   Duplication of param needs review. Only used by AuthorizeNetIPN
4336    * @param int $isFirstOrLastRecurringPayment
4337    *   Deprecated param only used by AuthorizeNetIPN.
4338    */
4339   public static function completeOrder(&$input, &$ids, $objects, $transaction, $recur, $contribution, $isRecurring, $isFirstOrLastRecurringPayment) {
4340     $primaryContributionID = isset($contribution->id) ? $contribution->id : $objects['first_contribution']->id;
4341     // The previous details are used when calculating line items so keep it before any code that 'does something'
4342     if (!empty($contribution->id)) {
4343       $input['prevContribution'] = CRM_Contribute_BAO_Contribution::getValues(array('id' => $contribution->id),
4344         CRM_Core_DAO::$_nullArray, CRM_Core_DAO::$_nullArray);
4345     }
4346     $inputContributionWhiteList = array(
4347       'fee_amount',
4348       'net_amount',
4349       'trxn_id',
4350       'check_number',
4351       'payment_instrument_id',
4352       'is_test',
4353       'campaign_id',
4354       'receive_date',
4355       'receipt_date',
4356       'contribution_status_id',
4357     );
4358     if (self::isSingleLineItem($primaryContributionID)) {
4359       $inputContributionWhiteList[] = 'financial_type_id';
4360     }
4361
4362     $participant = CRM_Utils_Array::value('participant', $objects);
4363     $memberships = CRM_Utils_Array::value('membership', $objects);
4364     $recurContrib = CRM_Utils_Array::value('contributionRecur', $objects);
4365     $recurringContributionID = (empty($recurContrib->id)) ? NULL : $recurContrib->id;
4366     $event = CRM_Utils_Array::value('event', $objects);
4367
4368     $completedContributionStatusID = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
4369
4370     $contributionParams = array_merge(array(
4371       'contribution_status_id' => $completedContributionStatusID,
4372       'source' => self::getRecurringContributionDescription($contribution, $event),
4373     ), array_intersect_key($input, array_fill_keys($inputContributionWhiteList, 1)
4374     ));
4375
4376     if ($recurringContributionID) {
4377       $contributionParams['contribution_recur_id'] = $recurringContributionID;
4378     }
4379     $changeDate = CRM_Utils_Array::value('trxn_date', $input, date('YmdHis'));
4380
4381     if (empty($contributionParams['receive_date']) && $changeDate) {
4382       $contributionParams['receive_date'] = $changeDate;
4383     }
4384
4385     self::repeatTransaction($contribution, $input, $contributionParams);
4386     $contributionParams['financial_type_id'] = $contribution->financial_type_id;
4387
4388     if (is_numeric($memberships)) {
4389       $memberships = array($objects['membership']);
4390     }
4391
4392     $values = array();
4393     if (isset($input['is_email_receipt'])) {
4394       $values['is_email_receipt'] = $input['is_email_receipt'];
4395     }
4396
4397     if ($input['component'] == 'contribute') {
4398       if ($contribution->contribution_page_id) {
4399         // Figure out what we gain from this.
4400         CRM_Contribute_BAO_ContributionPage::setValues($contribution->contribution_page_id, $values);
4401       }
4402       elseif ($recurContrib && $recurringContributionID) {
4403         $values['amount'] = $recurContrib->amount;
4404         $values['financial_type_id'] = $objects['contributionType']->id;
4405         $values['title'] = $source = ts('Offline Recurring Contribution');
4406       }
4407
4408       if ($recurContrib && $recurringContributionID && !isset($input['is_email_receipt'])) {
4409         //CRM-13273 - is_email_receipt setting on recurring contribution should take precedence over contribution page setting
4410         // but CRM-16124 if $input['is_email_receipt'] is set then that should not be overridden.
4411         $values['is_email_receipt'] = $recurContrib->is_email_receipt;
4412       }
4413
4414       if (!empty($memberships)) {
4415         foreach ($memberships as $membershipTypeIdKey => $membership) {
4416           if ($membership) {
4417             $membershipParams = array(
4418               'id' => $membership->id,
4419               'contact_id' => $membership->contact_id,
4420               'is_test' => $membership->is_test,
4421               'membership_type_id' => $membership->membership_type_id,
4422             );
4423
4424             $currentMembership = CRM_Member_BAO_Membership::getContactMembership($membershipParams['contact_id'],
4425               $membershipParams['membership_type_id'],
4426               $membershipParams['is_test'],
4427               $membershipParams['id']
4428             );
4429
4430             // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
4431             // this picks up membership type changes during renewals
4432             $sql = "
4433 SELECT    membership_type_id
4434 FROM      civicrm_membership_log
4435 WHERE     membership_id={$membershipParams['id']}
4436 ORDER BY  id DESC
4437 LIMIT 1;";
4438             $dao = CRM_Core_DAO::executeQuery($sql);
4439             if ($dao->fetch()) {
4440               if (!empty($dao->membership_type_id)) {
4441                 $membershipParams['membership_type_id'] = $dao->membership_type_id;
4442               }
4443             }
4444             $dao->free();
4445
4446             $membershipParams['num_terms'] = $contribution->getNumTermsByContributionAndMembershipType(
4447               $membershipParams['membership_type_id'],
4448               $primaryContributionID
4449             );
4450             $dates = array_fill_keys(array('join_date', 'start_date', 'end_date'), NULL);
4451             if ($currentMembership) {
4452               /*
4453                * Fixed FOR CRM-4433
4454                * In BAO/Membership.php(renewMembership function), we skip the extend membership date and status
4455                * when Contribution mode is notify and membership is for renewal )
4456                */
4457               CRM_Member_BAO_Membership::fixMembershipStatusBeforeRenew($currentMembership, $changeDate);
4458
4459               // @todo - we should pass membership_type_id instead of null here but not
4460               // adding as not sure of testing
4461               $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($membershipParams['id'],
4462                 $changeDate, NULL, $membershipParams['num_terms']
4463               );
4464
4465               $dates['join_date'] = $currentMembership['join_date'];
4466             }
4467
4468             //get the status for membership.
4469             $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($dates['start_date'],
4470               $dates['end_date'],
4471               $dates['join_date'],
4472               'today',
4473               TRUE,
4474               $membershipParams['membership_type_id'],
4475               $membershipParams
4476             );
4477
4478             $membershipParams['status_id'] = CRM_Utils_Array::value('id', $calcStatus, 'New');
4479             //we might be renewing membership,
4480             //so make status override false.
4481             $membershipParams['is_override'] = FALSE;
4482             //CRM-17723 - reset static $relatedContactIds array()
4483             $var = TRUE;
4484             CRM_Member_BAO_Membership::createRelatedMemberships($var, $var, TRUE);
4485             civicrm_api3('Membership', 'create', $membershipParams);
4486           }
4487         }
4488       }
4489     }
4490     else {
4491       if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
4492         if ($event->is_email_confirm) {
4493           // @todo this should be set by the function that sends the mail after sending.
4494           $contributionParams['receipt_date'] = $changeDate;
4495         }
4496         $participantParams['id'] = $participant->id;
4497         $participantParams['status_id'] = 'Registered';
4498         civicrm_api3('Participant', 'create', $participantParams);
4499       }
4500     }
4501
4502     $contributionParams['id'] = $contribution->id;
4503
4504     $contributionResult = civicrm_api3('Contribution', 'create', $contributionParams);
4505
4506     // Add new soft credit against current $contribution.
4507     if (CRM_Utils_Array::value('contributionRecur', $objects) && $objects['contributionRecur']->id) {
4508       CRM_Contribute_BAO_ContributionRecur::addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id);
4509     }
4510
4511     $paymentProcessorId = '';
4512     if (isset($objects['paymentProcessor'])) {
4513       if (is_array($objects['paymentProcessor'])) {
4514         $paymentProcessorId = $objects['paymentProcessor']['id'];
4515       }
4516       else {
4517         $paymentProcessorId = $objects['paymentProcessor']->id;
4518       }
4519     }
4520
4521     $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
4522       'labelColumn' => 'name',
4523       'flip' => 1,
4524     ));
4525     if ((empty($input['prevContribution']) && $paymentProcessorId) || (!$input['prevContribution']->is_pay_later && $input['prevContribution']->contribution_status_id == $contributionStatuses['Pending'])) {
4526       $input['payment_processor'] = $paymentProcessorId;
4527     }
4528
4529     if (!empty($contribution->_relatedObjects['participant'])) {
4530       $input['contribution_mode'] = 'participant';
4531       $input['participant_id'] = $contribution->_relatedObjects['participant']->id;
4532       $input['skipLineItem'] = 1;
4533     }
4534     elseif (!empty($contribution->_relatedObjects['membership'])) {
4535       $input['skipLineItem'] = TRUE;
4536       $input['contribution_mode'] = 'membership';
4537       $contribution->contribution_status_id = $contributionParams['contribution_status_id'];
4538       $contribution->trxn_id = CRM_Utils_Array::value('trxn_id', $input);
4539       $contribution->receive_date = CRM_Utils_Date::isoToMysql($contribution->receive_date);
4540     }
4541     $input['contribution_status_id'] = $contributionParams['contribution_status_id'];
4542     $input['total_amount'] = $input['amount'];
4543     $input['contribution'] = $contribution;
4544     $input['financial_type_id'] = $contribution->financial_type_id;
4545     //@todo writing a unit test I was unable to create a scenario where this line did not fatal on second
4546     // and subsequent payments. In this case the line items are created at
4547     // CRM_Contribute_BAO_ContributionRecur::addRecurLineItems
4548     // and since the contribution is saved prior to this line there is always a contribution-id,
4549     // however there is never a prevContribution (which appears to mean original contribution not previous
4550     // contribution - or preUpdateContributionObject most accurately)
4551     // so, this is always called & only appears to succeed when prevContribution exists - which appears
4552     // to mean "are we updating an exisitng pending contribution"
4553     //I was able to make the unit test complete as fataling here doesn't prevent
4554     // the contribution being created - but activities would not be created or emails sent
4555
4556     CRM_Contribute_BAO_Contribution::recordFinancialAccounts($input, NULL);
4557
4558     CRM_Core_Error::debug_log_message("Contribution record updated successfully");
4559     $transaction->commit();
4560
4561     CRM_Contribute_BAO_ContributionRecur::updateRecurLinkedPledge($contribution->id, $recurringContributionID,
4562       $input['contribution_status_id'], $input['total_amount']);
4563
4564     // create an activity record
4565     if ($input['component'] == 'contribute') {
4566       //CRM-4027
4567       $targetContactID = NULL;
4568       if (!empty($ids['related_contact'])) {
4569         $targetContactID = $contribution->contact_id;
4570         $contribution->contact_id = $ids['related_contact'];
4571       }
4572       CRM_Activity_BAO_Activity::addActivity($contribution, NULL, $targetContactID);
4573       // event
4574     }
4575     else {
4576       CRM_Activity_BAO_Activity::addActivity($participant);
4577     }
4578
4579     // CRM-9132 legacy behaviour was that receipts were sent out in all instances. Still sending
4580     // when array_key 'is_email_receipt doesn't exist in case some instances where is needs setting haven't been set
4581     if (!array_key_exists('is_email_receipt', $values) ||
4582       $values['is_email_receipt'] == 1
4583     ) {
4584       civicrm_api3('Contribution', 'sendconfirmation', array(
4585         'id' => $contribution->id,
4586         'payment_processor_id' => $paymentProcessorId,
4587       ));
4588       CRM_Core_Error::debug_log_message("Receipt sent");
4589     }
4590
4591     CRM_Core_Error::debug_log_message("Success: Database updated");
4592     if ($isRecurring) {
4593       CRM_Contribute_BAO_ContributionRecur::sendRecurringStartOrEndNotification($ids, $recur,
4594         $isFirstOrLastRecurringPayment);
4595     }
4596     return $contributionResult;
4597   }
4598
4599   /**
4600    * Send receipt from contribution.
4601    *
4602    * Do not call this directly - it is being refactored. use contribution.sendmessage api call.
4603    *
4604    * Note that the compose message part has been moved to contribution
4605    * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it.
4606    *
4607    * @param array $input
4608    *   Incoming data from Payment processor.
4609    * @param array $ids
4610    *   Related object IDs.
4611    * @param int $contributionID
4612    * @param array $values
4613    *   Values related to objects that have already been loaded.
4614    * @param bool $recur
4615    *   Is it part of a recurring contribution.
4616    * @param bool $returnMessageText
4617    *   Should text be returned instead of sent. This.
4618    *   is because the function is also used to generate pdfs
4619    *
4620    * @return array
4621    * @throws \CRM_Core_Exception
4622    * @throws \CiviCRM_API3_Exception
4623    */
4624   public static function sendMail(&$input, &$ids, $contributionID, &$values, $recur = FALSE,
4625                                   $returnMessageText = FALSE) {
4626     $input['is_recur'] = $recur;
4627
4628     $contribution = new CRM_Contribute_BAO_Contribution();
4629     $contribution->id = $contributionID;
4630     if (!$contribution->find(TRUE)) {
4631       throw new CRM_Core_Exception('Contribution does not exist');
4632     }
4633     $contribution->loadRelatedObjects($input, $ids, TRUE);
4634     // set receipt from e-mail and name in value
4635     if (!$returnMessageText) {
4636       $session = CRM_Core_Session::singleton();
4637       $userID = $session->get('userID');
4638       if (!empty($userID)) {
4639         list($userName, $userEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($userID);
4640         $values['receipt_from_email'] = CRM_Utils_Array::value('receipt_from_email', $input, $userEmail);
4641         $values['receipt_from_name'] = CRM_Utils_Array::value('receipt_from_name', $input, $userName);
4642       }
4643     }
4644     // Contribution ID should really always be set. But ?
4645     if (!$returnMessageText && (!isset($input['receipt_update']) || $input['receipt_update'])) {
4646       civicrm_api3('Contribution', 'create', array('receipt_date' => 'now', 'id' => $contribution->id));
4647       $values['receipt_date'] = date('Y-m-d H:i:s');
4648     }
4649     return $contribution->composeMessageArray($input, $ids, $values, $recur, $returnMessageText);
4650   }
4651
4652   /**
4653    * Generate credit note id with next avaible number
4654    *
4655    * @return string
4656    *   Credit Note Id.
4657    */
4658   public static function createCreditNoteId() {
4659     $prefixValue = Civi::settings()->get('contribution_invoice_settings');
4660
4661     $creditNoteNum = CRM_Core_DAO::singleValueQuery("SELECT count(creditnote_id) as creditnote_number FROM civicrm_contribution");
4662     $creditNoteId = NULL;
4663
4664     do {
4665       $creditNoteNum++;
4666       $creditNoteId = CRM_Utils_Array::value('credit_notes_prefix', $prefixValue) . "" . $creditNoteNum;
4667       $result = civicrm_api3('Contribution', 'getcount', array(
4668         'sequential' => 1,
4669         'creditnote_id' => $creditNoteId,
4670       ));
4671     } while ($result > 0);
4672
4673     return $creditNoteId;
4674   }
4675
4676   /**
4677    * Load related memberships.
4678    *
4679    * Note that in theory it should be possible to retrieve these from the line_item table
4680    * with the membership_payment table being deprecated. Attempting to do this here causes tests to fail
4681    * as it seems the api is not correctly linking the line items when the contribution is created in the flow
4682    * where the contribution is created in the API, followed by the membership (using the api) followed by the membership
4683    * payment. The membership payment BAO does have code to address this but it doesn't appear to be working.
4684    *
4685    * I don't know if it never worked or broke as a result of https://issues.civicrm.org/jira/browse/CRM-14918.
4686    *
4687    * @param array $ids
4688    *
4689    * @throws Exception
4690    */
4691   public function loadRelatedMembershipObjects(&$ids) {
4692     $query = "
4693       SELECT membership_id
4694       FROM   civicrm_membership_payment
4695       WHERE  contribution_id = %1 ";
4696     $params = array(1 => array($this->id, 'Integer'));
4697
4698     $dao = CRM_Core_DAO::executeQuery($query, $params);
4699     while ($dao->fetch()) {
4700       if ($dao->membership_id) {
4701         if (!is_array($ids['membership'])) {
4702           $ids['membership'] = array();
4703         }
4704         $ids['membership'][] = $dao->membership_id;
4705       }
4706     }
4707
4708     if (array_key_exists('membership', $ids) && is_array($ids['membership'])) {
4709       foreach ($ids['membership'] as $id) {
4710         if (!empty($id)) {
4711           $membership = new CRM_Member_BAO_Membership();
4712           $membership->id = $id;
4713           if (!$membership->find(TRUE)) {
4714             throw new Exception("Could not find membership record: $id");
4715           }
4716           $membership->join_date = CRM_Utils_Date::isoToMysql($membership->join_date);
4717           $membership->start_date = CRM_Utils_Date::isoToMysql($membership->start_date);
4718           $membership->end_date = CRM_Utils_Date::isoToMysql($membership->end_date);
4719           $this->_relatedObjects['membership'][$membership->membership_type_id] = $membership;
4720           $membership->free();
4721         }
4722       }
4723     }
4724   }
4725
4726   /**
4727    * This function is used to record partial payments for contribution
4728    *
4729    * @param array $contribution
4730    *
4731    * @param array $params
4732    *
4733    * @return object
4734    */
4735   public static function recordPartialPayment($contribution, $params) {
4736     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
4737     $pendingStatus = array(
4738       array_search('Pending', $contributionStatuses),
4739       array_search('In Progress', $contributionStatuses),
4740     );
4741     $statusId = array_search('Completed', $contributionStatuses);
4742     if (in_array(CRM_Utils_Array::value('contribution_status_id', $contribution), $pendingStatus)) {
4743       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
4744       $balanceTrxnParams['to_financial_account_id'] = CRM_Contribute_PseudoConstant::financialAccountType($contribution['financial_type_id'], $relationTypeId);
4745     }
4746     elseif (!empty($params['payment_processor'])) {
4747       $balanceTrxnParams['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getFinancialAccount($contribution['payment_processor'], 'civicrm_payment_processor', 'financial_account_id');
4748     }
4749     elseif (!empty($params['payment_instrument_id'])) {
4750       $balanceTrxnParams['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($contribution['payment_instrument_id']);
4751     }
4752     else {
4753       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
4754       $queryParams = array(1 => array($relationTypeId, 'Integer'));
4755       $balanceTrxnParams['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);
4756     }
4757     $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
4758     $fromFinancialAccountId = CRM_Contribute_PseudoConstant::financialAccountType($contribution['financial_type_id'], $relationTypeId);
4759     $balanceTrxnParams['from_financial_account_id'] = $fromFinancialAccountId;
4760     $balanceTrxnParams['total_amount'] = $params['total_amount'];
4761     $balanceTrxnParams['contribution_id'] = $params['contribution_id'];
4762     $balanceTrxnParams['trxn_date'] = !empty($params['contribution_receive_date']) ? $params['contribution_receive_date'] : date('YmdHis');
4763     $balanceTrxnParams['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
4764     $balanceTrxnParams['net_amount'] = CRM_Utils_Array::value('total_amount', $params);
4765     $balanceTrxnParams['currency'] = $contribution['currency'];
4766     $balanceTrxnParams['trxn_id'] = CRM_Utils_Array::value('contribution_trxn_id', $params, NULL);
4767     $balanceTrxnParams['status_id'] = $statusId;
4768     $balanceTrxnParams['payment_instrument_id'] = CRM_Utils_Array::value('payment_instrument_id', $params, $contribution['payment_instrument_id']);
4769     $balanceTrxnParams['check_number'] = CRM_Utils_Array::value('check_number', $params);
4770     if ($fromFinancialAccountId != NULL &&
4771       ($statusId == array_search('Completed', $contributionStatuses) || $statusId == array_search('Partially paid', $contributionStatuses))
4772     ) {
4773       $balanceTrxnParams['is_payment'] = 1;
4774     }
4775     if (!empty($params['payment_processor'])) {
4776       $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
4777     }
4778     return CRM_Core_BAO_FinancialTrxn::create($balanceTrxnParams);
4779   }
4780
4781   /**
4782    * Get the description (source field) for the recurring contribution.
4783    *
4784    * @param CRM_Contribute_BAO_Contribution $contribution
4785    * @param CRM_Event_DAO_Event|null $event
4786    *
4787    * @return array
4788    * @throws \CiviCRM_API3_Exception
4789    */
4790   protected static function getRecurringContributionDescription($contribution, $event) {
4791     if (!empty($contribution->source)) {
4792       return $contribution->source;
4793     }
4794     elseif (!empty($contribution->contribution_page_id)) {
4795       $contributionPageTitle = civicrm_api3('ContributionPage', 'getvalue', array(
4796         'id' => $contribution->contribution_page_id,
4797         'return' => 'title',
4798       ));
4799       return ts('Online Contribution') . ': ' . $contributionPageTitle;
4800     }
4801     elseif ($event) {
4802       return ts('Online Event Registration') . ': ' . $event->title;
4803     }
4804     return 'recurring contribution';
4805   }
4806
4807   /**
4808    * Function to add payments for contribution
4809    * for Partially Paid status
4810    *
4811    * @param array $lineItems
4812    * @param array $contributions
4813    *
4814    */
4815   public static function addPayments($lineItems, $contributions) {
4816     // get financial trxn which is a payment
4817     $ftSql = "SELECT ft.id, ft.total_amount
4818       FROM civicrm_financial_trxn ft
4819       INNER JOIN civicrm_entity_financial_trxn eft ON eft.financial_trxn_id = ft.id AND eft.entity_table = 'civicrm_contribution'
4820       WHERE eft.entity_id = %1 AND ft.is_payment = 1 ORDER BY ft.id DESC LIMIT 1";
4821     $sql = "SELECT fi.id, li.price_field_value_id
4822       FROM civicrm_financial_item fi
4823       INNER JOIN civicrm_line_item li ON li.id = fi.entity_id
4824       WHERE li.contribution_id = %1";
4825
4826     foreach ($contributions as $k => $contribution) {
4827       if ($contribution->contribution_status_id != CRM_Core_OptionGroup::getValue('contribution_status', 'Partially paid', 'name')) {
4828         continue;
4829       }
4830       $ftDao = CRM_Core_DAO::executeQuery($ftSql, array(1 => array($contribution->id, 'Integer')));
4831       $ftDao->fetch();
4832       $trxnAmount = $ftDao->total_amount;
4833       $ftId = $ftDao->id;
4834
4835       // get financial item
4836       $dao = CRM_Core_DAO::executeQuery($sql, array(1 => array($contribution->id, 'Integer')));
4837       while ($dao->fetch()) {
4838         $ftIds[$dao->price_field_value_id] = $dao->id;
4839       }
4840
4841       $params = array(
4842         'entity_table' => 'civicrm_financial_item',
4843         'financial_trxn_id' => $ftId,
4844       );
4845       foreach ($lineItems as $key => $value) {
4846         $paid = $value['line_total'] * ($trxnAmount / $contribution->total_amount);
4847         // Record Entity Financial Trxn
4848         $params['amount'] = round($paid, 2);
4849         $params['entity_id'] = $ftIds[$value['price_field_value_id']];
4850
4851         civicrm_api3('EntityFinancialTrxn', 'create', $params);
4852       }
4853     }
4854   }
4855
4856   /**
4857    * Function use to store line item proportionaly in
4858    * in entity financial trxn table
4859    *
4860    * @param array $params
4861    *  array of contribution params.
4862    * @param object $trxn
4863    *  CRM_Financial_DAO_FinancialTrxn object
4864    * @param array $contribution
4865    *
4866    */
4867   public static function assignProportionalLineItems($params, $trxn, $contribution) {
4868     $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($params['contribution_id']);
4869     if (!empty($lineItems)) {
4870       // get financial item
4871       $sql = "SELECT fi.id, li.price_field_value_id
4872       FROM civicrm_financial_item fi
4873       INNER JOIN civicrm_line_item li ON li.id = fi.entity_id and fi.entity_table = 'civicrm_line_item'
4874       WHERE li.contribution_id = %1";
4875       $dao = CRM_Core_DAO::executeQuery($sql, array(1 => array($params['contribution_id'], 'Integer')));
4876       while ($dao->fetch()) {
4877         $ftIds[$dao->price_field_value_id] = $dao->id;
4878       }
4879       $eftParams = array(
4880         'entity_table' => 'civicrm_financial_item',
4881         'financial_trxn_id' => $trxn->id,
4882       );
4883       foreach ($lineItems as $key => $value) {
4884         $paid = $value['line_total'] * ($params['total_amount'] / $contribution['total_amount']);
4885         // Record Entity Financial Trxn
4886         $eftParams['amount'] = round($paid, 2);
4887         $eftParams['entity_id'] = $ftIds[$value['price_field_value_id']];
4888
4889         civicrm_api3('EntityFinancialTrxn', 'create', $eftParams);
4890       }
4891     }
4892   }
4893
4894   /**
4895    * Function to check line items
4896    *
4897    * @param array $params
4898    *  array of order params.
4899    *
4900    */
4901   public static function checkLineItems(&$params) {
4902     $totalAmount = CRM_Utils_Array::value('total_amount', $params);
4903     $lineItemAmount = 0;
4904     foreach ($params['line_items'] as &$lineItems) {
4905       foreach ($lineItems['line_item'] as &$item) {
4906         if (empty($item['financial_type_id'])) {
4907           $item['financial_type_id'] = $params['financial_type_id'];
4908         }
4909         $lineItemAmount += $item['line_total'];
4910       }
4911     }
4912     if (!isset($totalAmount)) {
4913       $params['total_amount'] = $lineItemAmount;
4914     }
4915     elseif ($totalAmount != $lineItemAmount) {
4916       throw new API_Exception("Line item total doesn't match with total amount.");
4917     }
4918   }
4919
4920   /**
4921    * Get the financial account for the item associated with the new transaction.
4922    *
4923    * @param array $params
4924    * @param CRM_Financial_BAO_FinancialItem $prevFinancialItem
4925    *
4926    * @return int
4927    */
4928   public static function getFinancialAccountForStatusChangeTrxn($params, $prevFinancialItem) {
4929
4930     if (!empty($params['financial_account_id'])) {
4931       return $params['financial_account_id'];
4932     }
4933     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus($params['contribution_status_id'], 'name');
4934     $preferredAccountsRelationships = array(
4935       'Refunded' => 'Credit/Contra Revenue Account is',
4936       'Chargeback' => 'Chargeback Account is',
4937     );
4938     if (in_array($contributionStatus, array_keys($preferredAccountsRelationships))) {
4939       $financialTypeID = !empty($params['financial_type_id']) ? $params['financial_type_id'] : $params['prevContribution']->financial_type_id;
4940       return CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship(
4941         $financialTypeID,
4942         $preferredAccountsRelationships[$contributionStatus]
4943       );
4944     }
4945     return $prevFinancialItem->financial_account_id;
4946   }
4947
4948 }