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               $values['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     }
2556     // Else we assign the billing address of the contribution contact.
2557     else {
2558       $addressParams = array('contact_id' => $this->contact_id, 'is_billing' => 1);
2559       $addressDetails = (array) CRM_Core_BAO_Address::getValues($addressParams);
2560       $addressDetails = array_values($addressDetails);
2561     }
2562
2563     if (!empty($addressDetails[0]['display'])) {
2564       $values['address'] = $addressDetails[0]['display'];
2565     }
2566
2567     if ($this->_component == 'contribute') {
2568       //get soft contributions
2569       $softContributions = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($this->id, TRUE);
2570       if (!empty($softContributions)) {
2571         $values['softContributions'] = $softContributions['soft_credit'];
2572       }
2573       if (isset($this->contribution_page_id)) {
2574         CRM_Contribute_BAO_ContributionPage::setValues(
2575           $this->contribution_page_id,
2576           $values
2577         );
2578         if ($this->contribution_page_id) {
2579           // CRM-8254 - override default currency if applicable
2580           $config = CRM_Core_Config::singleton();
2581           $config->defaultCurrency = CRM_Utils_Array::value(
2582             'currency',
2583             $values,
2584             $config->defaultCurrency
2585           );
2586         }
2587       }
2588       // no contribution page -probably back office
2589       else {
2590         // Handle re-print receipt for offline contributions (call from PDF.php - no contribution_page_id)
2591         $values['is_email_receipt'] = 1;
2592         $values['title'] = 'Contribution';
2593       }
2594       // set lineItem for contribution
2595       if ($this->id) {
2596         $lineItem = CRM_Price_BAO_LineItem::getLineItems($this->id, 'contribution', 1);
2597         if (!empty($lineItem)) {
2598           $itemId = key($lineItem);
2599           foreach ($lineItem as &$eachItem) {
2600             if (isset($this->_relatedObjects['membership'])
2601              && is_array($this->_relatedObjects['membership'])
2602              && array_key_exists($eachItem['membership_type_id'], $this->_relatedObjects['membership'])) {
2603               $eachItem['join_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->join_date);
2604               $eachItem['start_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->start_date);
2605               $eachItem['end_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->end_date);
2606             }
2607           }
2608           $values['lineItem'][0] = $lineItem;
2609           $values['priceSetID'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $lineItem[$itemId]['price_field_id'], 'price_set_id');
2610         }
2611       }
2612
2613       $relatedContact = CRM_Contribute_BAO_Contribution::getOnbehalfIds(
2614         $this->id,
2615         $this->contact_id
2616       );
2617       // if this is onbehalf of contribution then set related contact
2618       if (!empty($relatedContact['individual_id'])) {
2619         $values['related_contact'] = $ids['related_contact'] = $relatedContact['individual_id'];
2620       }
2621     }
2622     else {
2623       // event
2624       $eventParams = array(
2625         'id' => $this->_relatedObjects['event']->id,
2626       );
2627       $values['event'] = array();
2628
2629       CRM_Event_BAO_Event::retrieve($eventParams, $values['event']);
2630       // add custom fields for event
2631       $eventGroupTree = CRM_Core_BAO_CustomGroup::getTree('Event', $this->_relatedObjects['event'], $this->_relatedObjects['event']->id);
2632
2633       $eventCustomGroup = array();
2634       foreach ($eventGroupTree as $key => $group) {
2635         if ($key === 'info') {
2636           continue;
2637         }
2638
2639         foreach ($group['fields'] as $k => $customField) {
2640           $groupLabel = $group['title'];
2641           if (!empty($customField['customValue'])) {
2642             foreach ($customField['customValue'] as $customFieldValues) {
2643               $eventCustomGroup[$groupLabel][$customField['label']] = CRM_Utils_Array::value('data', $customFieldValues);
2644             }
2645           }
2646         }
2647       }
2648       $values['event']['customGroup'] = $eventCustomGroup;
2649
2650       //get participant details
2651       $participantParams = array(
2652         'id' => $this->_relatedObjects['participant']->id,
2653       );
2654
2655       $values['participant'] = array();
2656
2657       CRM_Event_BAO_Participant::getValues($participantParams, $values['participant'], $participantIds);
2658       // add custom fields for event
2659       $participantGroupTree = CRM_Core_BAO_CustomGroup::getTree('Participant', $this->_relatedObjects['participant'], $this->_relatedObjects['participant']->id);
2660       $participantCustomGroup = array();
2661       foreach ($participantGroupTree as $key => $group) {
2662         if ($key === 'info') {
2663           continue;
2664         }
2665
2666         foreach ($group['fields'] as $k => $customField) {
2667           $groupLabel = $group['title'];
2668           if (!empty($customField['customValue'])) {
2669             foreach ($customField['customValue'] as $customFieldValues) {
2670               $participantCustomGroup[$groupLabel][$customField['label']] = CRM_Utils_Array::value('data', $customFieldValues);
2671             }
2672           }
2673         }
2674       }
2675       $values['participant']['customGroup'] = $participantCustomGroup;
2676
2677       //get location details
2678       $locationParams = array(
2679         'entity_id' => $this->_relatedObjects['event']->id,
2680         'entity_table' => 'civicrm_event',
2681       );
2682       $values['location'] = CRM_Core_BAO_Location::getValues($locationParams);
2683
2684       $ufJoinParams = array(
2685         'entity_table' => 'civicrm_event',
2686         'entity_id' => $ids['event'],
2687         'module' => 'CiviEvent',
2688       );
2689
2690       list($custom_pre_id,
2691         $custom_post_ids
2692         ) = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
2693
2694       $values['custom_pre_id'] = $custom_pre_id;
2695       $values['custom_post_id'] = $custom_post_ids;
2696
2697       // set lineItem for event contribution
2698       if ($this->id) {
2699         $participantIds = CRM_Event_BAO_Participant::getParticipantIds($this->id);
2700         if (!empty($participantIds)) {
2701           foreach ($participantIds as $pIDs) {
2702             $lineItem = CRM_Price_BAO_LineItem::getLineItems($pIDs);
2703             if (!CRM_Utils_System::isNull($lineItem)) {
2704               $values['lineItem'][] = $lineItem;
2705             }
2706           }
2707         }
2708       }
2709     }
2710
2711     $groupTree = CRM_Core_BAO_CustomGroup::getTree('Contribution', $this, $this->id);
2712
2713     $customGroup = array();
2714     foreach ($groupTree as $key => $group) {
2715       if ($key === 'info') {
2716         continue;
2717       }
2718
2719       foreach ($group['fields'] as $k => $customField) {
2720         $groupLabel = $group['title'];
2721         if (!empty($customField['customValue'])) {
2722           foreach ($customField['customValue'] as $customFieldValues) {
2723             $customGroup[$groupLabel][$customField['label']] = CRM_Utils_Array::value('data', $customFieldValues);
2724           }
2725         }
2726       }
2727     }
2728     $values['customGroup'] = $customGroup;
2729
2730     return $values;
2731   }
2732
2733   /**
2734    * Assign message variables to template but try to break the habit.
2735    *
2736    * In order to get away from leaky variables it is better to ensure variables are set in values and assign them
2737    * from the send function. Otherwise smarty variables can leak if this is called more than once - e.g. processing
2738    * multiple recurring payments for processors like IATS that use tokens.
2739    *
2740    * Apply variables for message to smarty template - this function is part of analysing what is in the huge
2741    * function & breaking it down into manageable chunks. Eventually it will be refactored into something else
2742    * Note we send directly from this function in some cases because it is only partly refactored.
2743    *
2744    * Don't call this function directly as the signature will change.
2745    *
2746    * @param $values
2747    * @param $input
2748    * @param CRM_Core_SMARTY $template
2749    * @param bool $recur
2750    * @param bool $returnMessageText
2751    *
2752    * @return mixed
2753    */
2754   public function _assignMessageVariablesToTemplate(&$values, $input, &$template, $recur = FALSE, $returnMessageText = TRUE) {
2755     $template->assign('first_name', $this->_relatedObjects['contact']->first_name);
2756     $template->assign('last_name', $this->_relatedObjects['contact']->last_name);
2757     $template->assign('displayName', $this->_relatedObjects['contact']->display_name);
2758     if (!empty($values['lineItem']) && !empty($this->_relatedObjects['membership'])) {
2759       $values['useForMember'] = TRUE;
2760     }
2761     //assign honor information to receipt message
2762     $softRecord = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($this->id);
2763
2764     if (isset($softRecord['soft_credit'])) {
2765       //if id of contribution page is present
2766       if (!empty($values['id'])) {
2767         $values['honor'] = array(
2768           'honor_profile_values' => array(),
2769           'honor_profile_id' => CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'uf_group_id', 'entity_id'),
2770           'honor_id' => $softRecord['soft_credit'][1]['contact_id'],
2771         );
2772         $softCreditTypes = CRM_Core_OptionGroup::values('soft_credit_type');
2773
2774         $template->assign('soft_credit_type', $softRecord['soft_credit'][1]['soft_credit_type_label']);
2775         $template->assign('honor_block_is_active', CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'is_active', 'entity_id'));
2776       }
2777       else {
2778         //offline contribution
2779         $softCreditTypes = $softCredits = array();
2780         foreach ($softRecord['soft_credit'] as $key => $softCredit) {
2781           $softCreditTypes[$key] = $softCredit['soft_credit_type_label'];
2782           $softCredits[$key] = array(
2783             'Name' => $softCredit['contact_name'],
2784             'Amount' => CRM_Utils_Money::format($softCredit['amount'], $softCredit['currency']),
2785           );
2786         }
2787         $template->assign('softCreditTypes', $softCreditTypes);
2788         $template->assign('softCredits', $softCredits);
2789       }
2790     }
2791
2792     $dao = new CRM_Contribute_DAO_ContributionProduct();
2793     $dao->contribution_id = $this->id;
2794     if ($dao->find(TRUE)) {
2795       $premiumId = $dao->product_id;
2796       $template->assign('option', $dao->product_option);
2797
2798       $productDAO = new CRM_Contribute_DAO_Product();
2799       $productDAO->id = $premiumId;
2800       $productDAO->find(TRUE);
2801       $template->assign('selectPremium', TRUE);
2802       $template->assign('product_name', $productDAO->name);
2803       $template->assign('price', $productDAO->price);
2804       $template->assign('sku', $productDAO->sku);
2805     }
2806     $template->assign('title', CRM_Utils_Array::value('title', $values));
2807     $values['amount'] = CRM_Utils_Array::value('total_amount', $input, (CRM_Utils_Array::value('amount', $input)), NULL);
2808     if (!$values['amount'] && isset($this->total_amount)) {
2809       $values['amount'] = $this->total_amount;
2810     }
2811
2812     // add the new contribution values
2813     if (strtolower($this->_component) == 'contribute') {
2814       //PCP Info
2815       $softDAO = new CRM_Contribute_DAO_ContributionSoft();
2816       $softDAO->contribution_id = $this->id;
2817       if ($softDAO->find(TRUE)) {
2818         $template->assign('pcpBlock', TRUE);
2819         $template->assign('pcp_display_in_roll', $softDAO->pcp_display_in_roll);
2820         $template->assign('pcp_roll_nickname', $softDAO->pcp_roll_nickname);
2821         $template->assign('pcp_personal_note', $softDAO->pcp_personal_note);
2822
2823         //assign the pcp page title for email subject
2824         $pcpDAO = new CRM_PCP_DAO_PCP();
2825         $pcpDAO->id = $softDAO->pcp_id;
2826         if ($pcpDAO->find(TRUE)) {
2827           $template->assign('title', $pcpDAO->title);
2828         }
2829       }
2830     }
2831
2832     if ($this->financial_type_id) {
2833       $values['financial_type_id'] = $this->financial_type_id;
2834     }
2835
2836     $template->assign('trxn_id', $this->trxn_id);
2837     $template->assign('receive_date',
2838       CRM_Utils_Date::processDate($this->receive_date)
2839     );
2840     $values['receipt_date'] = (empty($this->receipt_date) ? NULL : $this->receipt_date);
2841     $template->assign('contributeMode', 'notify');
2842     $template->assign('action', $this->is_test ? 1024 : 1);
2843     $template->assign('receipt_text',
2844       CRM_Utils_Array::value('receipt_text',
2845         $values
2846       )
2847     );
2848     $template->assign('is_monetary', 1);
2849     $template->assign('is_recur', (bool) $recur);
2850     $template->assign('currency', $this->currency);
2851     $template->assign('address', CRM_Utils_Address::format($input));
2852     if (!empty($values['customGroup'])) {
2853       $template->assign('customGroup', $values['customGroup']);
2854     }
2855     if (!empty($values['softContributions'])) {
2856       $template->assign('softContributions', $values['softContributions']);
2857     }
2858     if ($this->_component == 'event') {
2859       $template->assign('title', $values['event']['title']);
2860       $participantRoles = CRM_Event_PseudoConstant::participantRole();
2861       $viewRoles = array();
2862       foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $this->_relatedObjects['participant']->role_id) as $k => $v) {
2863         $viewRoles[] = $participantRoles[$v];
2864       }
2865       $values['event']['participant_role'] = implode(', ', $viewRoles);
2866       $template->assign('event', $values['event']);
2867       $template->assign('participant', $values['participant']);
2868       $template->assign('location', $values['location']);
2869       $template->assign('customPre', $values['custom_pre_id']);
2870       $template->assign('customPost', $values['custom_post_id']);
2871
2872       $isTest = FALSE;
2873       if ($this->_relatedObjects['participant']->is_test) {
2874         $isTest = TRUE;
2875       }
2876
2877       $values['params'] = array();
2878       //to get email of primary participant.
2879       $primaryEmail = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Email', $this->_relatedObjects['participant']->contact_id, 'email', 'contact_id');
2880       $primaryAmount[] = array(
2881         'label' => $this->_relatedObjects['participant']->fee_level . ' - ' . $primaryEmail,
2882         'amount' => $this->_relatedObjects['participant']->fee_amount,
2883       );
2884       //build an array of cId/pId of participants
2885       $additionalIDs = CRM_Event_BAO_Event::buildCustomProfile($this->_relatedObjects['participant']->id, NULL, $this->_relatedObjects['contact']->id, $isTest, TRUE);
2886       unset($additionalIDs[$this->_relatedObjects['participant']->id]);
2887       //send receipt to additional participant if exists
2888       if (count($additionalIDs)) {
2889         $template->assign('isPrimary', 0);
2890         $template->assign('customProfile', NULL);
2891         //set additionalParticipant true
2892         $values['params']['additionalParticipant'] = TRUE;
2893         foreach ($additionalIDs as $pId => $cId) {
2894           $amount = array();
2895           //to change the status pending to completed
2896           $additional = new CRM_Event_DAO_Participant();
2897           $additional->id = $pId;
2898           $additional->contact_id = $cId;
2899           $additional->find(TRUE);
2900           $additional->register_date = $this->_relatedObjects['participant']->register_date;
2901           $additional->status_id = 1;
2902           $additionalParticipantInfo = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Email', $additional->contact_id, 'email', 'contact_id');
2903           //if additional participant dont have email
2904           //use display name.
2905           if (!$additionalParticipantInfo) {
2906             $additionalParticipantInfo = CRM_Contact_BAO_Contact::displayName($additional->contact_id);
2907           }
2908           $amount[0] = array('label' => $additional->fee_level, 'amount' => $additional->fee_amount);
2909           $primaryAmount[] = array(
2910             'label' => $additional->fee_level . ' - ' . $additionalParticipantInfo,
2911             'amount' => $additional->fee_amount,
2912           );
2913           $additional->save();
2914           $additional->free();
2915           $template->assign('amount', $amount);
2916           CRM_Event_BAO_Event::sendMail($cId, $values, $pId, $isTest, $returnMessageText);
2917         }
2918       }
2919
2920       //build an array of custom profile and assigning it to template
2921       $customProfile = CRM_Event_BAO_Event::buildCustomProfile($this->_relatedObjects['participant']->id, $values, NULL, $isTest);
2922
2923       if (count($customProfile)) {
2924         $template->assign('customProfile', $customProfile);
2925       }
2926
2927       // for primary contact
2928       $values['params']['additionalParticipant'] = FALSE;
2929       $template->assign('isPrimary', 1);
2930       $template->assign('amount', $primaryAmount);
2931       $template->assign('register_date', CRM_Utils_Date::isoToMysql($this->_relatedObjects['participant']->register_date));
2932       if ($this->payment_instrument_id) {
2933         $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
2934         $template->assign('paidBy', $paymentInstrument[$this->payment_instrument_id]);
2935       }
2936       // carry paylater, since we did not created billing,
2937       // so need to pull email from primary location, CRM-4395
2938       $values['params']['is_pay_later'] = $this->_relatedObjects['participant']->is_pay_later;
2939     }
2940     return $template;
2941   }
2942
2943   /**
2944    * Check whether payment processor supports
2945    * cancellation of contribution subscription
2946    *
2947    * @param int $contributionId
2948    *   Contribution id.
2949    *
2950    * @param bool $isNotCancelled
2951    *
2952    * @return bool
2953    */
2954   public static function isCancelSubscriptionSupported($contributionId, $isNotCancelled = TRUE) {
2955     $cacheKeyString = "$contributionId";
2956     $cacheKeyString .= $isNotCancelled ? '_1' : '_0';
2957
2958     static $supportsCancel = array();
2959
2960     if (!array_key_exists($cacheKeyString, $supportsCancel)) {
2961       $supportsCancel[$cacheKeyString] = FALSE;
2962       $isCancelled = FALSE;
2963
2964       if ($isNotCancelled) {
2965         $isCancelled = self::isSubscriptionCancelled($contributionId);
2966       }
2967
2968       $paymentObject = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($contributionId, 'contribute', 'obj');
2969       if (!empty($paymentObject)) {
2970         $supportsCancel[$cacheKeyString] = $paymentObject->supports('cancelRecurring') && !$isCancelled;
2971       }
2972     }
2973     return $supportsCancel[$cacheKeyString];
2974   }
2975
2976   /**
2977    * Check whether subscription is already cancelled.
2978    *
2979    * @param int $contributionId
2980    *   Contribution id.
2981    *
2982    * @return string
2983    *   contribution status
2984    */
2985   public static function isSubscriptionCancelled($contributionId) {
2986     $sql = "
2987        SELECT cr.contribution_status_id
2988          FROM civicrm_contribution_recur cr
2989     LEFT JOIN civicrm_contribution con ON ( cr.id = con.contribution_recur_id )
2990         WHERE con.id = %1 LIMIT 1";
2991     $params = array(1 => array($contributionId, 'Integer'));
2992     $statusId = CRM_Core_DAO::singleValueQuery($sql, $params);
2993     $status = CRM_Contribute_PseudoConstant::contributionStatus($statusId);
2994     if ($status == 'Cancelled') {
2995       return TRUE;
2996     }
2997     return FALSE;
2998   }
2999
3000   /**
3001    * Create all financial accounts entry.
3002    *
3003    * @param array $params
3004    *   Contribution object, line item array and params for trxn.
3005    *
3006    *
3007    * @param array $financialTrxnValues
3008    *
3009    * @return null|object
3010    */
3011   public static function recordFinancialAccounts(&$params, $financialTrxnValues = NULL) {
3012     $skipRecords = $update = $return = $isRelatedId = FALSE;
3013
3014     $additionalParticipantId = array();
3015     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
3016     $contributionStatus = empty($params['contribution_status_id']) ? NULL : $contributionStatuses[$params['contribution_status_id']];
3017
3018     if (CRM_Utils_Array::value('contribution_mode', $params) == 'participant') {
3019       $entityId = $params['participant_id'];
3020       $entityTable = 'civicrm_participant';
3021       $additionalParticipantId = CRM_Event_BAO_Participant::getAdditionalParticipantIds($entityId);
3022     }
3023     elseif (!empty($params['membership_id'])) {
3024       //so far $params['membership_id'] should only be set coming in from membershipBAO::create so the situation where multiple memberships
3025       // are created off one contribution should be handled elsewhere
3026       $entityId = $params['membership_id'];
3027       $entityTable = 'civicrm_membership';
3028     }
3029     else {
3030       $entityId = $params['contribution']->id;
3031       $entityTable = 'civicrm_contribution';
3032     }
3033
3034     if (CRM_Utils_Array::value('contribution_mode', $params) == 'membership') {
3035       $isRelatedId = TRUE;
3036     }
3037
3038     $entityID[] = $entityId;
3039     if (!empty($additionalParticipantId)) {
3040       $entityID += $additionalParticipantId;
3041     }
3042     // prevContribution appears to mean - original contribution object- ie copy of contribution from before the update started that is being updated
3043     if (empty($params['prevContribution'])) {
3044       $entityID = NULL;
3045     }
3046     else {
3047       $update = TRUE;
3048     }
3049
3050     $statusId = $params['contribution']->contribution_status_id;
3051     // CRM-13964 partial payment
3052     if ($contributionStatus == 'Partially paid'
3053       && !empty($params['partial_payment_total']) && !empty($params['partial_amount_pay'])
3054     ) {
3055       $partialAmtPay = $params['partial_amount_pay'];
3056       $partialAmtTotal = $params['partial_payment_total'];
3057
3058       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3059       $fromFinancialAccountId = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id'], $relationTypeId);
3060       $statusId = CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name');
3061       $params['total_amount'] = $partialAmtPay;
3062
3063       $balanceTrxnInfo = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($params['contribution']->id, $params['financial_type_id']);
3064       if (empty($balanceTrxnInfo['trxn_id'])) {
3065         // create new balance transaction record
3066         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3067         $toFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id'], $relationTypeId);
3068
3069         $balanceTrxnParams['total_amount'] = $partialAmtTotal;
3070         $balanceTrxnParams['to_financial_account_id'] = $toFinancialAccount;
3071         $balanceTrxnParams['contribution_id'] = $params['contribution']->id;
3072         $balanceTrxnParams['trxn_date'] = !empty($params['contribution']->receive_date) ? $params['contribution']->receive_date : date('YmdHis');
3073         $balanceTrxnParams['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
3074         $balanceTrxnParams['net_amount'] = CRM_Utils_Array::value('net_amount', $params);
3075         $balanceTrxnParams['currency'] = $params['contribution']->currency;
3076         $balanceTrxnParams['trxn_id'] = $params['contribution']->trxn_id;
3077         $balanceTrxnParams['status_id'] = $statusId;
3078         $balanceTrxnParams['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
3079         $balanceTrxnParams['check_number'] = CRM_Utils_Array::value('check_number', $params);
3080         if (!empty($balanceTrxnParams['from_financial_account_id']) &&
3081           ($statusId == array_search('Completed', $contributionStatuses) || $statusId == array_search('Partially paid', $contributionStatuses))
3082         ) {
3083           $balanceTrxnParams['is_payment'] = 1;
3084         }
3085         if (!empty($params['payment_processor'])) {
3086           $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
3087         }
3088         $financialTxn = CRM_Core_BAO_FinancialTrxn::create($balanceTrxnParams);
3089       }
3090     }
3091
3092     // build line item array if its not set in $params
3093     if (empty($params['line_item']) || $additionalParticipantId) {
3094       CRM_Price_BAO_LineItem::getLineItemArray($params, $entityID, str_replace('civicrm_', '', $entityTable), $isRelatedId);
3095     }
3096
3097     if ($contributionStatus != 'Failed' &&
3098       !($contributionStatus == 'Pending' && !$params['contribution']->is_pay_later)
3099     ) {
3100       $skipRecords = TRUE;
3101       $pendingStatus = array(
3102         'Pending',
3103         'In Progress',
3104       );
3105       if (in_array($contributionStatus, $pendingStatus)) {
3106         $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship(
3107           $params['financial_type_id'],
3108           'Accounts Receivable Account is'
3109         );
3110       }
3111       elseif (!empty($params['payment_processor'])) {
3112         $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getFinancialAccount($params['payment_processor'], 'civicrm_payment_processor', 'financial_account_id');
3113       }
3114       elseif (!empty($params['payment_instrument_id'])) {
3115         $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($params['payment_instrument_id']);
3116       }
3117       else {
3118         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
3119         $queryParams = array(1 => array($relationTypeId, 'Integer'));
3120         $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);
3121       }
3122
3123       $totalAmount = CRM_Utils_Array::value('total_amount', $params);
3124       if (!isset($totalAmount) && !empty($params['prevContribution'])) {
3125         $totalAmount = $params['total_amount'] = $params['prevContribution']->total_amount;
3126       }
3127
3128       //build financial transaction params
3129       $trxnParams = array(
3130         'contribution_id' => $params['contribution']->id,
3131         'to_financial_account_id' => $params['to_financial_account_id'],
3132         'trxn_date' => !empty($params['contribution']->receive_date) ? $params['contribution']->receive_date : date('YmdHis'),
3133         'total_amount' => $totalAmount,
3134         'fee_amount' => CRM_Utils_Array::value('fee_amount', $params),
3135         'net_amount' => CRM_Utils_Array::value('net_amount', $params, $totalAmount),
3136         'currency' => $params['contribution']->currency,
3137         'trxn_id' => $params['contribution']->trxn_id,
3138         'status_id' => $statusId,
3139         'payment_instrument_id' => $params['contribution']->payment_instrument_id,
3140         'check_number' => CRM_Utils_Array::value('check_number', $params),
3141       );
3142       if ($contributionStatus == 'Refunded' || $contributionStatus == 'Chargeback') {
3143         $trxnParams['trxn_date'] = !empty($params['contribution']->cancel_date) ? $params['contribution']->cancel_date : date('YmdHis');
3144         if (isset($params['refund_trxn_id'])) {
3145           // CRM-17751 allow a separate trxn_id for the refund to be passed in via api & form.
3146           $trxnParams['trxn_id'] = $params['refund_trxn_id'];
3147         }
3148       }
3149       //CRM-16259, set is_payment flag for non pending status
3150       if (!in_array($contributionStatus, $pendingStatus)) {
3151         $trxnParams['is_payment'] = 1;
3152       }
3153       if (!empty($params['payment_processor'])) {
3154         $trxnParams['payment_processor_id'] = $params['payment_processor'];
3155       }
3156
3157       if (isset($fromFinancialAccountId)) {
3158         $trxnParams['from_financial_account_id'] = $fromFinancialAccountId;
3159       }
3160
3161       // consider external values passed for recording transaction entry
3162       if (!empty($financialTrxnValues)) {
3163         $trxnParams = array_merge($trxnParams, $financialTrxnValues);
3164       }
3165
3166       $params['trxnParams'] = $trxnParams;
3167
3168       if (!empty($params['prevContribution'])) {
3169         $updated = FALSE;
3170         $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $params['prevContribution']->total_amount;
3171         $params['trxnParams']['fee_amount'] = $params['prevContribution']->fee_amount;
3172         $params['trxnParams']['net_amount'] = $params['prevContribution']->net_amount;
3173         if (!isset($params['trxnParams']['trxn_id'])) {
3174           // Actually I have no idea why we are overwriting any values from the previous contribution.
3175           // (filling makes sense to me). However, only protecting this value as I really really know we
3176           // don't want this one overwritten.
3177           // CRM-17751.
3178           $params['trxnParams']['trxn_id'] = $params['prevContribution']->trxn_id;
3179         }
3180         $params['trxnParams']['status_id'] = $params['prevContribution']->contribution_status_id;
3181
3182         if (!(($params['prevContribution']->contribution_status_id == array_search('Pending', $contributionStatuses)
3183             || $params['prevContribution']->contribution_status_id == array_search('In Progress', $contributionStatuses))
3184           && $params['contribution']->contribution_status_id == array_search('Completed', $contributionStatuses))
3185         ) {
3186           $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id;
3187           $params['trxnParams']['check_number'] = $params['prevContribution']->check_number;
3188         }
3189
3190         //if financial type is changed
3191         if (!empty($params['financial_type_id']) &&
3192           $params['contribution']->financial_type_id != $params['prevContribution']->financial_type_id
3193         ) {
3194           $incomeTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Income Account is' "));
3195           $oldFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($params['prevContribution']->financial_type_id, $incomeTypeId);
3196           $newFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id'], $incomeTypeId);
3197           if ($oldFinancialAccount != $newFinancialAccount) {
3198             $params['total_amount'] = 0;
3199             if (in_array($params['contribution']->contribution_status_id, $pendingStatus)) {
3200               $params['trxnParams']['to_financial_account_id'] = CRM_Contribute_PseudoConstant::financialAccountType(
3201                 $params['prevContribution']->financial_type_id, $relationTypeId);
3202             }
3203             else {
3204               $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['prevContribution']->id, 'DESC');
3205               if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
3206                 $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
3207               }
3208             }
3209             self::updateFinancialAccounts($params, 'changeFinancialType');
3210             /* $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id']; */
3211             $params['financial_account_id'] = $newFinancialAccount;
3212             $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
3213             self::updateFinancialAccounts($params);
3214             $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id'];
3215             $updated = TRUE;
3216           }
3217         }
3218
3219         //Update contribution status
3220         $params['trxnParams']['status_id'] = $params['contribution']->contribution_status_id;
3221         if (!isset($params['refund_trxn_id'])) {
3222           // CRM-17751 This has previously been deliberately set. No explanation as to why one variant
3223           // gets preference over another so I am only 'protecting' a very specific tested flow
3224           // and letting natural justice take care of the rest.
3225           $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id;
3226         }
3227         if (!empty($params['contribution_status_id']) &&
3228           $params['prevContribution']->contribution_status_id != $params['contribution']->contribution_status_id
3229         ) {
3230           //Update Financial Records
3231           self::updateFinancialAccounts($params, 'changedStatus');
3232           $updated = TRUE;
3233         }
3234
3235         // change Payment Instrument for a Completed contribution
3236         // first handle special case when contribution is changed from Pending to Completed status when initial payment
3237         // instrument is null and now new payment instrument is added along with the payment
3238         $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
3239         $params['trxnParams']['check_number'] = CRM_Utils_Array::value('check_number', $params);
3240         if (array_key_exists('payment_instrument_id', $params)) {
3241           $params['trxnParams']['total_amount'] = -$trxnParams['total_amount'];
3242           if (CRM_Utils_System::isNull($params['prevContribution']->payment_instrument_id) &&
3243             !CRM_Utils_System::isNull($params['contribution']->payment_instrument_id)
3244           ) {
3245             //check if status is changed from Pending to Completed
3246             // do not update payment instrument changes for Pending to Completed
3247             if (!($params['contribution']->contribution_status_id == array_search('Completed', $contributionStatuses) &&
3248               in_array($params['prevContribution']->contribution_status_id, $pendingStatus))
3249             ) {
3250               // for all other statuses create new financial records
3251               self::updateFinancialAccounts($params, 'changePaymentInstrument');
3252               $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
3253               self::updateFinancialAccounts($params, 'changePaymentInstrument');
3254               $updated = TRUE;
3255             }
3256           }
3257           elseif ((!CRM_Utils_System::isNull($params['contribution']->payment_instrument_id) ||
3258               !CRM_Utils_System::isNull($params['prevContribution']->payment_instrument_id)) &&
3259             $params['contribution']->payment_instrument_id != $params['prevContribution']->payment_instrument_id
3260           ) {
3261             // for any other payment instrument changes create new financial records
3262             self::updateFinancialAccounts($params, 'changePaymentInstrument');
3263             $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
3264             self::updateFinancialAccounts($params, 'changePaymentInstrument');
3265             $updated = TRUE;
3266           }
3267           elseif (!CRM_Utils_System::isNull($params['contribution']->check_number) &&
3268             $params['contribution']->check_number != $params['prevContribution']->check_number
3269           ) {
3270             // another special case when check number is changed, create new financial records
3271             // create financial trxn with negative amount
3272             $params['trxnParams']['check_number'] = $params['prevContribution']->check_number;
3273             self::updateFinancialAccounts($params, 'changePaymentInstrument');
3274             // create financial trxn with positive amount
3275             $params['trxnParams']['check_number'] = $params['contribution']->check_number;
3276             $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
3277             self::updateFinancialAccounts($params, 'changePaymentInstrument');
3278             $updated = TRUE;
3279           }
3280         }
3281
3282         //if Change contribution amount
3283         $params['trxnParams']['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
3284         $params['trxnParams']['net_amount'] = CRM_Utils_Array::value('net_amount', $params);
3285         $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $totalAmount;
3286         $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id;
3287         if (isset($totalAmount) &&
3288           $totalAmount != $params['prevContribution']->total_amount
3289         ) {
3290           //Update Financial Records
3291           $params['trxnParams']['from_financial_account_id'] = NULL;
3292           self::updateFinancialAccounts($params, 'changedAmount');
3293           $updated = TRUE;
3294         }
3295
3296         if (!$updated) {
3297           // Looks like we might have a data correction update.
3298           // This would be a case where a transaction id has been entered but it is incorrect &
3299           // the person goes back in & fixes it, as opposed to a new transaction.
3300           // Currently the UI doesn't support multiple refunds against a single transaction & we are only supporting
3301           // the data fix scenario.
3302           // CRM-17751.
3303           if (isset($params['refund_trxn_id'])) {
3304             $refundIDs = CRM_Core_BAO_FinancialTrxn::getRefundTransactionIDs($params['id']);
3305             if (!empty($refundIDs['financialTrxnId']) && $refundIDs['trxn_id'] != $params['refund_trxn_id']) {
3306               civicrm_api3('FinancialTrxn', 'create', array('id' => $refundIDs['financialTrxnId'], 'trxn_id' => $params['refund_trxn_id']));
3307             }
3308           }
3309         }
3310       }
3311
3312       if (!$update) {
3313         // records finanical trxn and entity financial trxn
3314         // also make it available as return value
3315         $return = $financialTxn = CRM_Core_BAO_FinancialTrxn::create($trxnParams);
3316         $params['entity_id'] = $financialTxn->id;
3317       }
3318     }
3319     // record line items and financial items
3320     if (empty($params['skipLineItem'])) {
3321       CRM_Price_BAO_LineItem::processPriceSet($entityId, CRM_Utils_Array::value('line_item', $params), $params['contribution'], $entityTable, $update);
3322     }
3323
3324     // create batch entry if batch_id is passed and
3325     // ensure no batch entry is been made on 'Pending' or 'Failed' contribution, CRM-16611
3326     if (!empty($params['batch_id']) && !empty($financialTxn)) {
3327       $entityParams = array(
3328         'batch_id' => $params['batch_id'],
3329         'entity_table' => 'civicrm_financial_trxn',
3330         'entity_id' => $financialTxn->id,
3331       );
3332       CRM_Batch_BAO_Batch::addBatchEntity($entityParams);
3333     }
3334
3335     // when a fee is charged
3336     if (!empty($params['fee_amount']) && (empty($params['prevContribution']) || $params['contribution']->fee_amount != $params['prevContribution']->fee_amount) && $skipRecords) {
3337       CRM_Core_BAO_FinancialTrxn::recordFees($params);
3338     }
3339
3340     if (!empty($params['prevContribution']) && $entityTable == 'civicrm_participant'
3341       && $params['prevContribution']->contribution_status_id != $params['contribution']->contribution_status_id
3342     ) {
3343       $eventID = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $entityId, 'event_id');
3344       $feeLevel[] = str_replace('\ 1', '', $params['prevContribution']->amount_level);
3345       CRM_Event_BAO_Participant::createDiscountTrxn($eventID, $params, $feeLevel);
3346     }
3347     unset($params['line_item']);
3348
3349     return $return;
3350   }
3351
3352   /**
3353    * Update all financial accounts entry.
3354    *
3355    * @param array $params
3356    *   Contribution object, line item array and params for trxn.
3357    *
3358    * @param string $context
3359    *   Update scenarios.
3360    *
3361    * @param null $skipTrxn
3362    *
3363    */
3364   public static function updateFinancialAccounts(&$params, $context = NULL, $skipTrxn = NULL) {
3365     $itemAmount = $trxnID = NULL;
3366     //get all the statuses
3367     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
3368     $previousContributionStatus = CRM_Contribute_PseudoConstant::contributionStatus($params['prevContribution']->contribution_status_id, 'name');
3369     if (($previousContributionStatus == 'Pending'
3370         || $previousContributionStatus == 'In Progress')
3371       && $params['contribution']->contribution_status_id == array_search('Completed', $contributionStatus)
3372       && $context == 'changePaymentInstrument'
3373     ) {
3374       return;
3375     }
3376     if ((($previousContributionStatus == 'Partially paid'
3377       && $params['contribution']->contribution_status_id == array_search('Completed', $contributionStatus))
3378       || ($previousContributionStatus == 'Pending' && $params['prevContribution']->is_pay_later == TRUE
3379       && $params['contribution']->contribution_status_id == array_search('Partially paid', $contributionStatus)))
3380       && $context == 'changedStatus'
3381     ) {
3382       return;
3383     }
3384     if ($context == 'changedAmount' || $context == 'changeFinancialType') {
3385       $itemAmount = $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = $params['total_amount'] - $params['prevContribution']->total_amount;
3386     }
3387     if ($context == 'changedStatus') {
3388       //get all the statuses
3389       $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
3390       $cancelledTaxAmount = 0;
3391       if ($previousContributionStatus == 'Completed'
3392         && (self::isContributionStatusNegative($params['contribution']->contribution_status_id))
3393       ) {
3394         $params['trxnParams']['total_amount'] = -$params['total_amount'];
3395         $cancelledTaxAmount = CRM_Utils_Array::value('tax_amount', $params, '0.00');
3396         if (empty($params['contribution']->creditnote_id) || $params['contribution']->creditnote_id == "null") {
3397           $creditNoteId = self::createCreditNoteId();
3398           CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution']->id, 'creditnote_id', $creditNoteId);
3399         }
3400       }
3401       elseif (($previousContributionStatus == 'Pending'
3402           && $params['prevContribution']->is_pay_later) || $previousContributionStatus == 'In Progress'
3403       ) {
3404         $financialTypeID = CRM_Utils_Array::value('financial_type_id', $params) ? $params['financial_type_id'] : $params['prevContribution']->financial_type_id;
3405         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3406         $arAccountId = CRM_Contribute_PseudoConstant::financialAccountType($financialTypeID, $relationTypeId);
3407
3408         if ($params['contribution']->contribution_status_id == array_search('Cancelled', $contributionStatus)) {
3409           $params['trxnParams']['to_financial_account_id'] = $arAccountId;
3410           $params['trxnParams']['total_amount'] = -$params['total_amount'];
3411           if (is_null($params['contribution']->creditnote_id) || $params['contribution']->creditnote_id == "null") {
3412             $creditNoteId = self::createCreditNoteId();
3413             CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution']->id, 'creditnote_id', $creditNoteId);
3414           }
3415         }
3416         else {
3417           $params['trxnParams']['from_financial_account_id'] = $arAccountId;
3418         }
3419       }
3420       $itemAmount = $params['trxnParams']['total_amount'] + $cancelledTaxAmount;
3421     }
3422     elseif ($context == 'changePaymentInstrument') {
3423       if ($params['trxnParams']['total_amount'] < 0) {
3424         $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['prevContribution']->id, 'DESC');
3425         if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
3426           $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
3427           $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id;
3428         }
3429       }
3430       else {
3431         $params['trxnParams']['to_financial_account_id'] = $params['to_financial_account_id'];
3432         $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
3433       }
3434     }
3435
3436     if ($context == 'changedStatus') {
3437       if (($previousContributionStatus == 'Pending'
3438           || $previousContributionStatus == 'In Progress')
3439         && ($params['contribution']->contribution_status_id == array_search('Completed', $contributionStatus))
3440       ) {
3441         if (empty($params['line_item'])) {
3442           //CRM-15296
3443           //@todo - check with Joe regarding this situation - payment processors create pending transactions with no line items
3444           // when creating recurring membership payment - there are 2 lines to comment out in contributonPageTest if fixed
3445           // & this can be removed
3446           return;
3447         }
3448         $trxn = CRM_Core_BAO_FinancialTrxn::create($params['trxnParams']);
3449         $params['entity_id'] = $trxn->id;
3450         $query = "UPDATE civicrm_financial_item SET status_id = %1 WHERE entity_id = %2 and entity_table = 'civicrm_line_item'";
3451         $sql = "SELECT id, amount FROM civicrm_financial_item WHERE entity_id = %1 and entity_table = 'civicrm_line_item'";
3452
3453         $entityParams = array(
3454           'entity_table' => 'civicrm_financial_item',
3455           'financial_trxn_id' => $trxn->id,
3456         );
3457         foreach ($params['line_item'] as $fieldId => $fields) {
3458           foreach ($fields as $fieldValueId => $fieldValues) {
3459             $fparams = array(
3460               1 => array(CRM_Core_OptionGroup::getValue('financial_item_status', 'Paid', 'name'), 'Integer'),
3461               2 => array($fieldValues['id'], 'Integer'),
3462             );
3463             CRM_Core_DAO::executeQuery($query, $fparams);
3464             $fparams = array(
3465               1 => array($fieldValues['id'], 'Integer'),
3466             );
3467             $financialItem = CRM_Core_DAO::executeQuery($sql, $fparams);
3468             while ($financialItem->fetch()) {
3469               $entityParams['entity_id'] = $financialItem->id;
3470               $entityParams['amount'] = $financialItem->amount;
3471               CRM_Financial_BAO_FinancialItem::createEntityTrxn($entityParams);
3472             }
3473           }
3474         }
3475         return;
3476       }
3477     }
3478
3479     $trxn = CRM_Core_BAO_FinancialTrxn::create($params['trxnParams']);
3480     $params['entity_id'] = $trxn->id;
3481     if ($context != 'changePaymentInstrument') {
3482       $itemParams['entity_table'] = 'civicrm_line_item';
3483       $trxnIds['id'] = $params['entity_id'];
3484       foreach ($params['line_item'] as $fieldId => $fields) {
3485         foreach ($fields as $fieldValueId => $fieldValues) {
3486           $prevParams['entity_id'] = $fieldValues['id'];
3487           $prevFinancialItem = CRM_Financial_BAO_FinancialItem::retrieve($prevParams, CRM_Core_DAO::$_nullArray);
3488
3489           $receiveDate = CRM_Utils_Date::isoToMysql($params['prevContribution']->receive_date);
3490           if ($params['contribution']->receive_date) {
3491             $receiveDate = CRM_Utils_Date::isoToMysql($params['contribution']->receive_date);
3492           }
3493
3494           $financialAccount = self::getFinancialAccountForStatusChangeTrxn($params, $prevFinancialItem);
3495
3496           $currency = $params['prevContribution']->currency;
3497           if ($params['contribution']->currency) {
3498             $currency = $params['contribution']->currency;
3499           }
3500           $diff = 1;
3501           if ($context == 'changeFinancialType' || self::isContributionStatusNegative($params['contribution']->contribution_status_id)) {
3502             $diff = -1;
3503           }
3504           if (!empty($params['is_quick_config'])) {
3505             $amount = $itemAmount;
3506             if (!$amount) {
3507               $amount = $params['total_amount'];
3508             }
3509           }
3510           else {
3511             $amount = $diff * $fieldValues['line_total'];
3512           }
3513
3514           $itemParams = array(
3515             'transaction_date' => $receiveDate,
3516             'contact_id' => $params['prevContribution']->contact_id,
3517             'currency' => $currency,
3518             'amount' => $amount,
3519             'description' => $prevFinancialItem->description,
3520             'status_id' => $prevFinancialItem->status_id,
3521             'financial_account_id' => $financialAccount,
3522             'entity_table' => 'civicrm_line_item',
3523             'entity_id' => $fieldValues['id'],
3524           );
3525           CRM_Financial_BAO_FinancialItem::create($itemParams, NULL, $trxnIds);
3526
3527           if ($fieldValues['tax_amount']) {
3528             $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
3529             $taxTerm = CRM_Utils_Array::value('tax_term', $invoiceSettings);
3530             $itemParams['amount'] = $diff * $fieldValues['tax_amount'];
3531             $itemParams['description'] = $taxTerm;
3532             if ($fieldValues['financial_type_id']) {
3533               $itemParams['financial_account_id'] = self::getFinancialAccountId($fieldValues['financial_type_id']);
3534             }
3535             CRM_Financial_BAO_FinancialItem::create($itemParams, NULL, $trxnIds);
3536           }
3537         }
3538       }
3539     }
3540     if ($context == 'changeFinancialType') {
3541       $params['skipLineItem'] = FALSE;
3542       foreach ($params['line_item'] as &$lineItems) {
3543         foreach ($lineItems as &$line) {
3544           $line['financial_type_id'] = $params['financial_type_id'];
3545         }
3546       }
3547     }
3548   }
3549
3550   /**
3551    * Is this contribution status a reversal.
3552    *
3553    * If so we would expect to record a negative value in the financial_trxn table.
3554    *
3555    * @param int $status_id
3556    *
3557    * @return bool
3558    */
3559   public static function isContributionStatusNegative($status_id) {
3560     $reversalStatuses = array('Cancelled', 'Chargeback', 'Refunded');
3561     return in_array(CRM_Contribute_PseudoConstant::contributionStatus($status_id, 'name'), $reversalStatuses);
3562   }
3563
3564   /**
3565    * Check status validation on update of a contribution.
3566    *
3567    * @param array $values
3568    *   Previous form values before submit.
3569    *
3570    * @param array $fields
3571    *   The input form values.
3572    *
3573    * @param array $errors
3574    *   List of errors.
3575    *
3576    * @return bool
3577    */
3578   public static function checkStatusValidation($values, &$fields, &$errors) {
3579     if (CRM_Utils_System::isNull($values) && !empty($fields['id'])) {
3580       $values['contribution_status_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $fields['id'], 'contribution_status_id');
3581       if ($values['contribution_status_id'] == $fields['contribution_status_id']) {
3582         return FALSE;
3583       }
3584     }
3585     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
3586     $checkStatus = array(
3587       'Cancelled' => array('Completed', 'Refunded'),
3588       'Completed' => array('Cancelled', 'Refunded', 'Chargeback'),
3589       'Pending' => array('Cancelled', 'Completed', 'Failed', 'Partially paid'),
3590       'In Progress' => array('Cancelled', 'Completed', 'Failed'),
3591       'Refunded' => array('Cancelled', 'Completed'),
3592       'Partially paid' => array('Completed'),
3593     );
3594
3595     if (!in_array($contributionStatuses[$fields['contribution_status_id']],
3596       CRM_Utils_Array::value($contributionStatuses[$values['contribution_status_id']], $checkStatus, array()))
3597     ) {
3598       $errors['contribution_status_id'] = ts("Cannot change contribution status from %1 to %2.", array(
3599         1 => $contributionStatuses[$values['contribution_status_id']],
3600         2 => $contributionStatuses[$fields['contribution_status_id']],
3601       ));
3602     }
3603   }
3604
3605   /**
3606    * Delete contribution of contact.
3607    *
3608    * CRM-12155
3609    *
3610    * @param int $contactId
3611    *   Contact id.
3612    *
3613    */
3614   public static function deleteContactContribution($contactId) {
3615     $contribution = new CRM_Contribute_DAO_Contribution();
3616     $contribution->contact_id = $contactId;
3617     $contribution->find();
3618     while ($contribution->fetch()) {
3619       self::deleteContribution($contribution->id);
3620     }
3621   }
3622
3623   /**
3624    * Get options for a given contribution field.
3625    * @see CRM_Core_DAO::buildOptions
3626    *
3627    * @param string $fieldName
3628    * @param string $context see CRM_Core_DAO::buildOptionsContext.
3629    * @param array $props  whatever is known about this dao object.
3630    *
3631    * @return array|bool
3632    */
3633   public static function buildOptions($fieldName, $context = NULL, $props = array()) {
3634     $className = __CLASS__;
3635     $params = array();
3636     switch ($fieldName) {
3637       // This field is not part of this object but the api supports it
3638       case 'payment_processor':
3639         $className = 'CRM_Contribute_BAO_ContributionPage';
3640         // Filter results by contribution page
3641         if (!empty($props['contribution_page_id'])) {
3642           $page = civicrm_api('contribution_page', 'getsingle', array(
3643             'version' => 3,
3644             'id' => ($props['contribution_page_id']),
3645           ));
3646           $types = (array) CRM_Utils_Array::value('payment_processor', $page, 0);
3647           $params['condition'] = 'id IN (' . implode(',', $types) . ')';
3648         }
3649         break;
3650
3651       // CRM-13981 This field was combined with soft_credits in 4.5 but the api still supports it
3652       case 'honor_type_id':
3653         $className = 'CRM_Contribute_BAO_ContributionSoft';
3654         $fieldName = 'soft_credit_type_id';
3655         $params['condition'] = "v.name IN ('in_honor_of','in_memory_of')";
3656         break;
3657     }
3658     return CRM_Core_PseudoConstant::get($className, $fieldName, $params, $context);
3659   }
3660
3661   /**
3662    * Validate financial type.
3663    *
3664    * CRM-13231
3665    *
3666    * @param int $financialTypeId
3667    *   Financial Type id.
3668    *
3669    * @param string $relationName
3670    *
3671    * @return array|bool
3672    */
3673   public static function validateFinancialType($financialTypeId, $relationName = 'Expense Account is') {
3674     $expenseTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE '{$relationName}' "));
3675     $financialAccount = CRM_Contribute_PseudoConstant::financialAccountType($financialTypeId, $expenseTypeId);
3676
3677     if (!$financialAccount) {
3678       return CRM_Contribute_PseudoConstant::financialType($financialTypeId);
3679     }
3680     return FALSE;
3681   }
3682
3683
3684   /**
3685    * Function to record additional payment for partial and refund contributions.
3686    *
3687    * @param int $contributionId
3688    *   is the invoice contribution id (got created after processing participant payment).
3689    * @param array $trxnsData
3690    *   to take user provided input of transaction details.
3691    * @param string $paymentType
3692    *   'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments.
3693    * @param int $participantId
3694    *
3695    * @return null|object
3696    */
3697   public static function recordAdditionalPayment($contributionId, $trxnsData, $paymentType = 'owed', $participantId = NULL, $updateStatus = TRUE) {
3698     $statusId = CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name');
3699     $getInfoOf['id'] = $contributionId;
3700     $defaults = array();
3701     $contributionDAO = CRM_Contribute_BAO_Contribution::retrieve($getInfoOf, $defaults, CRM_Core_DAO::$_nullArray);
3702     if (!$participantId) {
3703       $participantId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment', $contributionId, 'participant_id');
3704     }
3705
3706     if ($paymentType == 'owed') {
3707       // build params for recording financial trxn entry
3708       $params['contribution'] = $contributionDAO;
3709       $params = array_merge($defaults, $params);
3710       $params['skipLineItem'] = TRUE;
3711       $params['partial_payment_total'] = $contributionDAO->total_amount;
3712       $params['partial_amount_pay'] = $trxnsData['total_amount'];
3713       $trxnsData['trxn_date'] = !empty($trxnsData['trxn_date']) ? $trxnsData['trxn_date'] : date('YmdHis');
3714       $trxnsData['net_amount'] = !empty($trxnsData['net_amount']) ? $trxnsData['net_amount'] : $trxnsData['total_amount'];
3715
3716       // record the entry
3717       $financialTrxn = CRM_Contribute_BAO_Contribution::recordFinancialAccounts($params, $trxnsData);
3718       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3719       $toFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($contributionDAO->financial_type_id, $relationTypeId);
3720
3721       $trxnId = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($contributionId, $contributionDAO->financial_type_id);
3722       if (!empty($trxnId)) {
3723         $trxnId = $trxnId['trxn_id'];
3724       }
3725       elseif (!empty($contributionDAO->payment_instrument_id)) {
3726         $trxnId = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($contributionDAO->payment_instrument_id);
3727       }
3728       else {
3729         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
3730         $queryParams = array(1 => array($relationTypeId, 'Integer'));
3731         $trxnId = CRM_Core_DAO::singleValueQuery("SELECT id FROM civicrm_financial_account WHERE is_default = 1 AND financial_account_type_id = %1", $queryParams);
3732       }
3733
3734       // update statuses
3735       // criteria for updates contribution total_amount == financial_trxns of partial_payments
3736       $sql = "SELECT SUM(ft.total_amount) as sum_of_payments, SUM(ft.net_amount) as net_amount_total
3737 FROM civicrm_financial_trxn ft
3738 LEFT JOIN civicrm_entity_financial_trxn eft
3739   ON (ft.id = eft.financial_trxn_id)
3740 WHERE eft.entity_table = 'civicrm_contribution'
3741   AND eft.entity_id = {$contributionId}
3742   AND ft.to_financial_account_id != {$toFinancialAccount}
3743   AND ft.status_id = {$statusId}
3744 ";
3745       $query = CRM_Core_DAO::executeQuery($sql);
3746       $query->fetch();
3747       $sumOfPayments = $query->sum_of_payments;
3748
3749       // update statuses
3750       if ($contributionDAO->total_amount == $sumOfPayments) {
3751         // update contribution status and
3752         // clean cancel info (if any) if prev. contribution was updated in case of 'Refunded' => 'Completed'
3753         $contributionDAO->contribution_status_id = $statusId;
3754         $contributionDAO->cancel_date = 'null';
3755         $contributionDAO->cancel_reason = NULL;
3756         $netAmount = !empty($trxnsData['net_amount']) ? NULL : $trxnsData['total_amount'];
3757         $contributionDAO->net_amount = $query->net_amount_total + $netAmount;
3758         $contributionDAO->fee_amount = $contributionDAO->total_amount - $contributionDAO->net_amount;
3759         $contributionDAO->save();
3760
3761         //Change status of financial record too
3762         $financialTrxn->status_id = $statusId;
3763         $financialTrxn->save();
3764
3765         // note : not using the self::add method,
3766         // the reason because it performs 'status change' related code execution for financial records
3767         // which in 'Partial Paid' => 'Completed' is not useful, instead specific financial record updates
3768         // are coded below i.e. just updating financial_item status to 'Paid'
3769
3770         if ($participantId) {
3771           // update participant status
3772           $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
3773           $ids = CRM_Event_BAO_Participant::getParticipantIds($contributionId);
3774           foreach ($ids as $val) {
3775             $participantUpdate['id'] = $val;
3776             $participantUpdate['status_id'] = array_search('Registered', $participantStatuses);
3777             CRM_Event_BAO_Participant::add($participantUpdate);
3778           }
3779         }
3780
3781         // update financial item statuses
3782         $financialItemStatus = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_FinancialItem', 'status_id');
3783         $paidStatus = array_search('Paid', $financialItemStatus);
3784
3785         $baseTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($contributionId);
3786         $sqlFinancialItemUpdate = "
3787 UPDATE civicrm_financial_item fi
3788   LEFT JOIN civicrm_entity_financial_trxn eft
3789     ON (eft.entity_id = fi.id AND eft.entity_table = 'civicrm_financial_item')
3790 SET status_id = {$paidStatus}
3791 WHERE eft.financial_trxn_id IN ({$trxnId}, {$baseTrxnId['financialTrxnId']})
3792 ";
3793         CRM_Core_DAO::executeQuery($sqlFinancialItemUpdate);
3794       }
3795     }
3796     elseif ($paymentType == 'refund') {
3797       // build params for recording financial trxn entry
3798       $params['contribution'] = $contributionDAO;
3799       $params = array_merge($defaults, $params);
3800       $params['skipLineItem'] = TRUE;
3801       $trxnsData['trxn_date'] = !empty($trxnsData['trxn_date']) ? $trxnsData['trxn_date'] : date('YmdHis');
3802       $trxnsData['total_amount'] = -$trxnsData['total_amount'];
3803
3804       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3805       $trxnsData['from_financial_account_id'] = CRM_Contribute_PseudoConstant::financialAccountType($contributionDAO->financial_type_id, $relationTypeId);
3806       $trxnsData['status_id'] = CRM_Core_OptionGroup::getValue('contribution_status', 'Refunded', 'name');
3807       // record the entry
3808       $financialTrxn = CRM_Contribute_BAO_Contribution::recordFinancialAccounts($params, $trxnsData);
3809
3810       // note : not using the self::add method,
3811       // the reason because it performs 'status change' related code execution for financial records
3812       // which in 'Pending Refund' => 'Completed' is not useful, instead specific financial record updates
3813       // are coded below i.e. just updating financial_item status to 'Paid'
3814       if ($updateStatus) {
3815         $contributionDetails = CRM_Core_DAO::setFieldValue('CRM_Contribute_BAO_Contribution', $contributionId, 'contribution_status_id', $statusId);
3816       }
3817       // add financial item entry
3818       $financialItemStatus = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_FinancialItem', 'status_id');
3819       $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($contributionDAO->id);
3820       if (!empty($lineItems)) {
3821         foreach ($lineItems as $lineItemId => $lineItemValue) {
3822           $paid = $lineItemValue['line_total'] * ($financialTrxn->total_amount / $contributionDAO->total_amount);
3823           $addFinancialEntry = array(
3824             'transaction_date' => $financialTrxn->trxn_date,
3825             'contact_id' => $contributionDAO->contact_id,
3826             'amount' => round($paid, 2),
3827             'status_id' => array_search('Paid', $financialItemStatus),
3828             'entity_id' => $lineItemId,
3829             'entity_table' => 'civicrm_line_item',
3830           );
3831           $trxnIds['id'] = $financialTrxn->id;
3832           CRM_Financial_BAO_FinancialItem::create($addFinancialEntry, NULL, $trxnIds);
3833         }
3834       }
3835       if ($participantId) {
3836         // update participant status
3837         $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
3838         $ids = CRM_Event_BAO_Participant::getParticipantIds($contributionId);
3839         foreach ($ids as $val) {
3840           $participantUpdate['id'] = $val;
3841           $participantUpdate['status_id'] = array_search('Registered', $participantStatuses);
3842           CRM_Event_BAO_Participant::add($participantUpdate);
3843         }
3844       }
3845     }
3846
3847     // activity creation
3848     if (!empty($financialTrxn)) {
3849       if ($participantId) {
3850         $inputParams['id'] = $participantId;
3851         $values = array();
3852         $ids = array();
3853         $component = 'event';
3854         $entityObj = CRM_Event_BAO_Participant::getValues($inputParams, $values, $ids);
3855         $entityObj = $entityObj[$participantId];
3856       }
3857       $activityType = ($paymentType == 'refund') ? 'Refund' : 'Payment';
3858
3859       self::addActivityForPayment($entityObj, $financialTrxn, $activityType, $component, $contributionId);
3860     }
3861     return $financialTrxn;
3862   }
3863
3864   /**
3865    * @param $entityObj
3866    * @param $trxnObj
3867    * @param $activityType
3868    * @param $component
3869    * @param int $contributionId
3870    *
3871    * @throws CRM_Core_Exception
3872    */
3873   public static function addActivityForPayment($entityObj, $trxnObj, $activityType, $component, $contributionId) {
3874     if ($component == 'event') {
3875       $date = CRM_Utils_Date::isoToMysql($trxnObj->trxn_date);
3876       $paymentAmount = CRM_Utils_Money::format($trxnObj->total_amount, $trxnObj->currency);
3877       $eventTitle = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Event', $entityObj->event_id, 'title');
3878       $subject = "{$paymentAmount} - Offline {$activityType} for {$eventTitle}";
3879       $targetCid = $entityObj->contact_id;
3880       // source record id would be the contribution id
3881       $srcRecId = $contributionId;
3882     }
3883
3884     // activity params
3885     $activityParams = array(
3886       'source_contact_id' => $targetCid,
3887       'source_record_id' => $srcRecId,
3888       'activity_type_id' => CRM_Core_OptionGroup::getValue('activity_type',
3889         $activityType,
3890         'name'
3891       ),
3892       'subject' => $subject,
3893       'activity_date_time' => $date,
3894       'status_id' => CRM_Core_OptionGroup::getValue('activity_status',
3895         'Completed',
3896         'name'
3897       ),
3898       'skipRecentView' => TRUE,
3899     );
3900
3901     // create activity with target contacts
3902     $session = CRM_Core_Session::singleton();
3903     $id = $session->get('userID');
3904     if ($id) {
3905       $activityParams['source_contact_id'] = $id;
3906       $activityParams['target_contact_id'][] = $targetCid;
3907     }
3908     CRM_Activity_BAO_Activity::create($activityParams);
3909   }
3910
3911   /**
3912    * Get list of payments displayed by Contribute_Page_PaymentInfo.
3913    *
3914    * @param int $id
3915    * @param $component
3916    * @param bool $getTrxnInfo
3917    * @param bool $usingLineTotal
3918    *
3919    * @return mixed
3920    */
3921   public static function getPaymentInfo($id, $component, $getTrxnInfo = FALSE, $usingLineTotal = FALSE) {
3922     if ($component == 'event') {
3923       $entity = 'participant';
3924       $entityTable = 'civicrm_participant';
3925       $contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'contribution_id', 'participant_id');
3926
3927       if (!$contributionId) {
3928         if ($primaryParticipantId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Participant', $id, 'registered_by_id')) {
3929           $contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $primaryParticipantId, 'contribution_id', 'participant_id');
3930           $id = $primaryParticipantId;
3931         }
3932         if (!$contributionId) {
3933           return;
3934         }
3935       }
3936     }
3937     else {
3938       $contributionId = $id;
3939       $entity = 'contribution';
3940       $entityTable = 'civicrm_contribution';
3941     }
3942
3943     $total = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($contributionId);
3944     $baseTrxnId = !empty($total['trxn_id']) ? $total['trxn_id'] : NULL;
3945     $isBalance = NULL;
3946     if ($baseTrxnId) {
3947       $isBalance = TRUE;
3948     }
3949     else {
3950       $baseTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($contributionId);
3951       $baseTrxnId = $baseTrxnId['financialTrxnId'];
3952       $isBalance = FALSE;
3953     }
3954     if (!CRM_Utils_Array::value('total_amount', $total) || $usingLineTotal) {
3955       // for additional participants
3956       if ($entityTable == 'civicrm_participant') {
3957         $ids = CRM_Event_BAO_Participant::getParticipantIds($contributionId);
3958         $total = 0;
3959         foreach ($ids as $val) {
3960           $total += CRM_Price_BAO_LineItem::getLineTotal($val, $entityTable);
3961         }
3962       }
3963       else {
3964         $total = CRM_Price_BAO_LineItem::getLineTotal($id, $entityTable);
3965       }
3966     }
3967     else {
3968       $baseTrxnId = $total['trxn_id'];
3969       $total = $total['total_amount'];
3970     }
3971
3972     $paymentBalance = CRM_Core_BAO_FinancialTrxn::getPartialPaymentWithType($id, $entity, FALSE, $total);
3973     $contributionIsPayLater = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'is_pay_later');
3974
3975     $feeRelationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Expense Account is' "));
3976     $financialTypeId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id');
3977     $feeFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($financialTypeId, $feeRelationTypeId);
3978
3979     if ($paymentBalance == 0 && $contributionIsPayLater) {
3980       $paymentBalance = $total;
3981     }
3982
3983     $info['total'] = $total;
3984     $info['paid'] = $total - $paymentBalance;
3985     $info['balance'] = $paymentBalance;
3986     $info['id'] = $id;
3987     $info['component'] = $component;
3988     $info['payLater'] = $contributionIsPayLater;
3989     $rows = array();
3990     if ($getTrxnInfo && $baseTrxnId) {
3991       // Need to exclude fee trxn rows so filter out rows where TO FINANCIAL ACCOUNT is expense account
3992       $sql = "
3993         SELECT GROUP_CONCAT(fa.`name`) as financial_account,
3994           ft.total_amount,
3995           ft.payment_instrument_id,
3996           ft.trxn_date, ft.trxn_id, ft.status_id, ft.check_number, con.currency
3997
3998         FROM civicrm_contribution con
3999           LEFT JOIN civicrm_entity_financial_trxn eft ON (eft.entity_id = con.id AND eft.entity_table = 'civicrm_contribution')
4000           INNER JOIN civicrm_financial_trxn ft ON ft.id = eft.financial_trxn_id
4001             AND ft.to_financial_account_id != {$feeFinancialAccount}
4002           INNER JOIN civicrm_entity_financial_trxn ef ON (ef.financial_trxn_id = ft.id AND ef.entity_table = 'civicrm_financial_item')
4003           LEFT JOIN civicrm_financial_item fi ON fi.id = ef.entity_id
4004           INNER JOIN civicrm_financial_account fa ON fa.id = fi.financial_account_id
4005
4006         WHERE con.id = {$contributionId}
4007         GROUP BY ft.id
4008       ";
4009
4010       // conditioned WHERE clause
4011       if ($isBalance) {
4012         // if balance trxn exists don't include details of it in transaction info
4013         $sql .= " AND ft.id != {$baseTrxnId} ";
4014       }
4015       $resultDAO = CRM_Core_DAO::executeQuery($sql);
4016
4017       $statuses = CRM_Contribute_PseudoConstant::contributionStatus();
4018
4019       while ($resultDAO->fetch()) {
4020         $paidByLabel = CRM_Core_PseudoConstant::getLabel('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id);
4021         $paidByName = CRM_Core_PseudoConstant::getName('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id);
4022         $val = array(
4023           'total_amount' => $resultDAO->total_amount,
4024           'financial_type' => $resultDAO->financial_account,
4025           'payment_instrument' => $paidByLabel,
4026           'receive_date' => $resultDAO->trxn_date,
4027           'trxn_id' => $resultDAO->trxn_id,
4028           'status' => $statuses[$resultDAO->status_id],
4029           'currency' => $resultDAO->currency,
4030         );
4031         if ($paidByName == 'Check') {
4032           $val['check_number'] = $resultDAO->check_number;
4033         }
4034         $rows[] = $val;
4035       }
4036       $info['transaction'] = $rows;
4037     }
4038     return $info;
4039   }
4040
4041   /**
4042    * Get financial account id has 'Sales Tax Account is'
4043    * account relationship with financial type
4044    *
4045    * @param int $financialTypeId
4046    *
4047    * @return FinancialAccountId
4048    */
4049   public static function getFinancialAccountId($financialTypeId) {
4050     $accountRel = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' "));
4051     $searchParams = array(
4052       'entity_table' => 'civicrm_financial_type',
4053       'entity_id' => $financialTypeId,
4054       'account_relationship' => $accountRel,
4055     );
4056     $result = array();
4057     CRM_Financial_BAO_FinancialTypeAccount::retrieve($searchParams, $result);
4058
4059     return CRM_Utils_Array::value('financial_account_id', $result);
4060   }
4061
4062   /**
4063    * Check tax amount.
4064    *
4065    * @param array $params
4066    * @param bool $isLineItem
4067    *
4068    * @return mixed
4069    */
4070   public static function checkTaxAmount($params, $isLineItem = FALSE) {
4071     $taxRates = CRM_Core_PseudoConstant::getTaxRates();
4072
4073     // Update contribution.
4074     if (!empty($params['id'])) {
4075       $id = $params['id'];
4076       $values = $ids = array();
4077       $contrbutionParams = array('id' => $id);
4078       $prevContributionValue = CRM_Contribute_BAO_Contribution::getValues($contrbutionParams, $values, $ids);
4079
4080       // To assign pervious finantial type on update of contribution
4081       if (!isset($params['financial_type_id'])) {
4082         $params['financial_type_id'] = $prevContributionValue->financial_type_id;
4083       }
4084       elseif (isset($params['financial_type_id']) && !array_key_exists($params['financial_type_id'], $taxRates)) {
4085         // Assisn tax Amount on update of contrbution
4086         if (!empty($prevContributionValue->tax_amount)) {
4087           $params['tax_amount'] = 'null';
4088           CRM_Price_BAO_LineItem::getLineItemArray($params, array($params['id']));
4089           foreach ($params['line_item'] as $setID => $priceField) {
4090             foreach ($priceField as $priceFieldID => $priceFieldValue) {
4091               $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4092             }
4093           }
4094         }
4095       }
4096     }
4097
4098     // New Contrbution and update of contribution with tax rate financial type
4099     if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) &&
4100       empty($params['skipLineItem']) && !$isLineItem
4101     ) {
4102       $taxRateParams = $taxRates[$params['financial_type_id']];
4103       $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount(CRM_Utils_Array::value('total_amount', $params), $taxRateParams);
4104       $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4105
4106       // Get Line Item on update of contribution
4107       if (isset($params['id'])) {
4108         CRM_Price_BAO_LineItem::getLineItemArray($params, array($params['id']));
4109       }
4110       else {
4111         CRM_Price_BAO_LineItem::getLineItemArray($params);
4112       }
4113       foreach ($params['line_item'] as $setID => $priceField) {
4114         foreach ($priceField as $priceFieldID => $priceFieldValue) {
4115           $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4116         }
4117       }
4118       $params['total_amount'] = CRM_Utils_Array::value('total_amount', $params) + $params['tax_amount'];
4119     }
4120     elseif (isset($params['api.line_item.create'])) {
4121       // Update total amount of contribution using lineItem
4122       $taxAmountArray = array();
4123       foreach ($params['api.line_item.create'] as $key => $value) {
4124         if (isset($value['financial_type_id']) && array_key_exists($value['financial_type_id'], $taxRates)) {
4125           $taxRate = $taxRates[$value['financial_type_id']];
4126           $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount($value['line_total'], $taxRate);
4127           $taxAmountArray[] = round($taxAmount['tax_amount'], 2);
4128         }
4129       }
4130       $params['tax_amount'] = array_sum($taxAmountArray);
4131       $params['total_amount'] = $params['total_amount'] + $params['tax_amount'];
4132     }
4133     else {
4134       // update line item of contrbution
4135       if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) && $isLineItem) {
4136         $taxRate = $taxRates[$params['financial_type_id']];
4137         $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount($params['line_total'], $taxRate);
4138         $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4139       }
4140     }
4141     return $params;
4142   }
4143
4144   /**
4145    * Check financial type validation on update of a contribution.
4146    *
4147    * @param Integer $financialTypeId
4148    *   Value of latest Financial Type.
4149    *
4150    * @param Integer $contributionId
4151    *   Contribution Id.
4152    *
4153    * @param array $errors
4154    *   List of errors.
4155    *
4156    * @return bool
4157    */
4158   public static function checkFinancialTypeChange($financialTypeId, $contributionId, &$errors) {
4159     if (!empty($financialTypeId)) {
4160       $oldFinancialTypeId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id');
4161       if ($oldFinancialTypeId == $financialTypeId) {
4162         return FALSE;
4163       }
4164     }
4165     $sql = 'SELECT financial_type_id FROM civicrm_line_item WHERE contribution_id = %1 GROUP BY financial_type_id;';
4166     $params = array(
4167       '1' => array($contributionId, 'Integer'),
4168     );
4169     $result = CRM_Core_DAO::executeQuery($sql, $params);
4170     if ($result->N > 1) {
4171       $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.');
4172     }
4173   }
4174
4175   /**
4176    * Update related pledge payment payments.
4177    *
4178    * This function has been refactored out of the back office contribution form and may
4179    * still overlap with other functions.
4180    *
4181    * @param string $action
4182    * @param int $pledgePaymentID
4183    * @param int $contributionID
4184    * @param bool $adjustTotalAmount
4185    * @param float $total_amount
4186    * @param float $original_total_amount
4187    * @param int $contribution_status_id
4188    * @param int $original_contribution_status_id
4189    */
4190   public static function updateRelatedPledge(
4191     $action,
4192     $pledgePaymentID,
4193     $contributionID,
4194     $adjustTotalAmount,
4195     $total_amount,
4196     $original_total_amount,
4197     $contribution_status_id,
4198     $original_contribution_status_id
4199   ) {
4200     if (!$pledgePaymentID && $action & CRM_Core_Action::ADD && !$contributionID) {
4201       return;
4202     }
4203
4204     if ($pledgePaymentID) {
4205       //store contribution id in payment record.
4206       CRM_Core_DAO::setFieldValue('CRM_Pledge_DAO_PledgePayment', $pledgePaymentID, 'contribution_id', $contributionID);
4207     }
4208     else {
4209       $pledgePaymentID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4210         $contributionID,
4211         'id',
4212         'contribution_id'
4213       );
4214     }
4215
4216     if (!$pledgePaymentID) {
4217       return;
4218     }
4219     $pledgeID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4220       $contributionID,
4221       'pledge_id',
4222       'contribution_id'
4223     );
4224
4225     $updatePledgePaymentStatus = FALSE;
4226
4227     // If either the status or the amount has changed we update the pledge status.
4228     if ($action & CRM_Core_Action::ADD) {
4229       $updatePledgePaymentStatus = TRUE;
4230     }
4231     elseif ($action & CRM_Core_Action::UPDATE && (($original_contribution_status_id != $contribution_status_id) ||
4232         ($original_total_amount != $total_amount))
4233     ) {
4234       $updatePledgePaymentStatus = TRUE;
4235     }
4236
4237     if ($updatePledgePaymentStatus) {
4238       CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID,
4239         array($pledgePaymentID),
4240         $contribution_status_id,
4241         NULL,
4242         $total_amount,
4243         $adjustTotalAmount
4244       );
4245     }
4246   }
4247
4248   /**
4249    * Compute the stats values
4250    *
4251    * @param $stat either 'mode' or 'median'
4252    * @param $sql
4253    * @param $alias of civicrm_contribution
4254    */
4255   public static function computeStats($stat, $sql, $alias = NULL) {
4256     $mode = $median = array();
4257     switch ($stat) {
4258       case 'mode':
4259         $modeDAO = CRM_Core_DAO::executeQuery($sql);
4260         while ($modeDAO->fetch()) {
4261           if ($modeDAO->civicrm_contribution_total_amount_count > 1) {
4262             $mode[] = CRM_Utils_Money::format($modeDAO->amount, $modeDAO->currency);
4263           }
4264           else {
4265             $mode[] = 'N/A';
4266           }
4267         }
4268         return $mode;
4269
4270       case 'median':
4271         $currencies = CRM_Core_OptionGroup::values('currencies_enabled');
4272         foreach ($currencies as $currency => $val) {
4273           $midValue = 0;
4274           $where = "AND {$alias}.currency = '{$currency}'";
4275           $rowCount = CRM_Core_DAO::singleValueQuery("SELECT count(*) as count {$sql} {$where}");
4276
4277           $even = FALSE;
4278           $offset = 1;
4279           $medianRow = floor($rowCount / 2);
4280           if ($rowCount % 2 == 0 && !empty($medianRow)) {
4281             $even = TRUE;
4282             $offset++;
4283             $medianRow--;
4284           }
4285
4286           $medianValue = "SELECT {$alias}.total_amount as median
4287              {$sql} {$where}
4288              ORDER BY median LIMIT {$medianRow},{$offset}";
4289           $medianValDAO = CRM_Core_DAO::executeQuery($medianValue);
4290           while ($medianValDAO->fetch()) {
4291             if ($even) {
4292               $midValue = $midValue + $medianValDAO->median;
4293             }
4294             else {
4295               $median[] = CRM_Utils_Money::format($medianValDAO->median, $currency);
4296             }
4297           }
4298           if ($even) {
4299             $midValue = $midValue / 2;
4300             $median[] = CRM_Utils_Money::format($midValue, $currency);
4301           }
4302         }
4303         return $median;
4304
4305       default:
4306         return;
4307     }
4308   }
4309
4310   /**
4311    * Is there only one line item attached to the contribution.
4312    *
4313    * @param int $id
4314    *   Contribution ID.
4315    *
4316    * @return bool
4317    * @throws \CiviCRM_API3_Exception
4318    */
4319   public static function isSingleLineItem($id) {
4320     $lineItemCount = civicrm_api3('LineItem', 'getcount', array('contribution_id' => $id));
4321     return ($lineItemCount == 1);
4322   }
4323
4324   /**
4325    * Complete an order.
4326    *
4327    * Do not call this directly - use the contribution.completetransaction api as this function is being refactored.
4328    *
4329    * Currently overloaded to complete a transaction & repeat a transaction - fix!
4330    *
4331    * Moving it out of the BaseIPN class is just the first step.
4332    *
4333    * @param array $input
4334    * @param array $ids
4335    * @param array $objects
4336    * @param CRM_Core_Transaction $transaction
4337    * @param int $recur
4338    * @param CRM_Contribute_BAO_Contribution $contribution
4339    * @param bool $isRecurring
4340    *   Duplication of param needs review. Only used by AuthorizeNetIPN
4341    * @param int $isFirstOrLastRecurringPayment
4342    *   Deprecated param only used by AuthorizeNetIPN.
4343    */
4344   public static function completeOrder(&$input, &$ids, $objects, $transaction, $recur, $contribution, $isRecurring, $isFirstOrLastRecurringPayment) {
4345     $primaryContributionID = isset($contribution->id) ? $contribution->id : $objects['first_contribution']->id;
4346     // The previous details are used when calculating line items so keep it before any code that 'does something'
4347     if (!empty($contribution->id)) {
4348       $input['prevContribution'] = CRM_Contribute_BAO_Contribution::getValues(array('id' => $contribution->id),
4349         CRM_Core_DAO::$_nullArray, CRM_Core_DAO::$_nullArray);
4350     }
4351     $inputContributionWhiteList = array(
4352       'fee_amount',
4353       'net_amount',
4354       'trxn_id',
4355       'check_number',
4356       'payment_instrument_id',
4357       'is_test',
4358       'campaign_id',
4359       'receive_date',
4360       'receipt_date',
4361       'contribution_status_id',
4362     );
4363     if (self::isSingleLineItem($primaryContributionID)) {
4364       $inputContributionWhiteList[] = 'financial_type_id';
4365     }
4366
4367     $participant = CRM_Utils_Array::value('participant', $objects);
4368     $memberships = CRM_Utils_Array::value('membership', $objects);
4369     $recurContrib = CRM_Utils_Array::value('contributionRecur', $objects);
4370     $recurringContributionID = (empty($recurContrib->id)) ? NULL : $recurContrib->id;
4371     $event = CRM_Utils_Array::value('event', $objects);
4372
4373     $completedContributionStatusID = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
4374
4375     $contributionParams = array_merge(array(
4376       'contribution_status_id' => $completedContributionStatusID,
4377       'source' => self::getRecurringContributionDescription($contribution, $event),
4378     ), array_intersect_key($input, array_fill_keys($inputContributionWhiteList, 1)
4379     ));
4380
4381     if ($recurringContributionID) {
4382       $contributionParams['contribution_recur_id'] = $recurringContributionID;
4383     }
4384     $changeDate = CRM_Utils_Array::value('trxn_date', $input, date('YmdHis'));
4385
4386     if (empty($contributionParams['receive_date']) && $changeDate) {
4387       $contributionParams['receive_date'] = $changeDate;
4388     }
4389
4390     self::repeatTransaction($contribution, $input, $contributionParams);
4391     $contributionParams['financial_type_id'] = $contribution->financial_type_id;
4392
4393     if (is_numeric($memberships)) {
4394       $memberships = array($objects['membership']);
4395     }
4396
4397     $values = array();
4398     if (isset($input['is_email_receipt'])) {
4399       $values['is_email_receipt'] = $input['is_email_receipt'];
4400     }
4401
4402     if ($input['component'] == 'contribute') {
4403       if ($contribution->contribution_page_id) {
4404         // Figure out what we gain from this.
4405         CRM_Contribute_BAO_ContributionPage::setValues($contribution->contribution_page_id, $values);
4406       }
4407       elseif ($recurContrib && $recurringContributionID) {
4408         $values['amount'] = $recurContrib->amount;
4409         $values['financial_type_id'] = $objects['contributionType']->id;
4410         $values['title'] = $source = ts('Offline Recurring Contribution');
4411       }
4412
4413       if ($recurContrib && $recurringContributionID && !isset($input['is_email_receipt'])) {
4414         //CRM-13273 - is_email_receipt setting on recurring contribution should take precedence over contribution page setting
4415         // but CRM-16124 if $input['is_email_receipt'] is set then that should not be overridden.
4416         $values['is_email_receipt'] = $recurContrib->is_email_receipt;
4417       }
4418
4419       if (!empty($memberships)) {
4420         foreach ($memberships as $membershipTypeIdKey => $membership) {
4421           if ($membership) {
4422             $membershipParams = array(
4423               'id' => $membership->id,
4424               'contact_id' => $membership->contact_id,
4425               'is_test' => $membership->is_test,
4426               'membership_type_id' => $membership->membership_type_id,
4427             );
4428
4429             $currentMembership = CRM_Member_BAO_Membership::getContactMembership($membershipParams['contact_id'],
4430               $membershipParams['membership_type_id'],
4431               $membershipParams['is_test'],
4432               $membershipParams['id']
4433             );
4434
4435             // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
4436             // this picks up membership type changes during renewals
4437             $sql = "
4438 SELECT    membership_type_id
4439 FROM      civicrm_membership_log
4440 WHERE     membership_id={$membershipParams['id']}
4441 ORDER BY  id DESC
4442 LIMIT 1;";
4443             $dao = CRM_Core_DAO::executeQuery($sql);
4444             if ($dao->fetch()) {
4445               if (!empty($dao->membership_type_id)) {
4446                 $membershipParams['membership_type_id'] = $dao->membership_type_id;
4447               }
4448             }
4449             $dao->free();
4450
4451             $membershipParams['num_terms'] = $contribution->getNumTermsByContributionAndMembershipType(
4452               $membershipParams['membership_type_id'],
4453               $primaryContributionID
4454             );
4455             $dates = array_fill_keys(array('join_date', 'start_date', 'end_date'), NULL);
4456             if ($currentMembership) {
4457               /*
4458                * Fixed FOR CRM-4433
4459                * In BAO/Membership.php(renewMembership function), we skip the extend membership date and status
4460                * when Contribution mode is notify and membership is for renewal )
4461                */
4462               CRM_Member_BAO_Membership::fixMembershipStatusBeforeRenew($currentMembership, $changeDate);
4463
4464               // @todo - we should pass membership_type_id instead of null here but not
4465               // adding as not sure of testing
4466               $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($membershipParams['id'],
4467                 $changeDate, NULL, $membershipParams['num_terms']
4468               );
4469
4470               $dates['join_date'] = $currentMembership['join_date'];
4471             }
4472
4473             //get the status for membership.
4474             $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($dates['start_date'],
4475               $dates['end_date'],
4476               $dates['join_date'],
4477               'today',
4478               TRUE,
4479               $membershipParams['membership_type_id'],
4480               $membershipParams
4481             );
4482
4483             $membershipParams['status_id'] = CRM_Utils_Array::value('id', $calcStatus, 'New');
4484             //we might be renewing membership,
4485             //so make status override false.
4486             $membershipParams['is_override'] = FALSE;
4487             //CRM-17723 - reset static $relatedContactIds array()
4488             $var = TRUE;
4489             CRM_Member_BAO_Membership::createRelatedMemberships($var, $var, TRUE);
4490             civicrm_api3('Membership', 'create', $membershipParams);
4491           }
4492         }
4493       }
4494     }
4495     else {
4496       if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
4497         if ($event->is_email_confirm) {
4498           // @todo this should be set by the function that sends the mail after sending.
4499           $contributionParams['receipt_date'] = $changeDate;
4500         }
4501         $participantParams['id'] = $participant->id;
4502         $participantParams['status_id'] = 'Registered';
4503         civicrm_api3('Participant', 'create', $participantParams);
4504       }
4505     }
4506
4507     $contributionParams['id'] = $contribution->id;
4508
4509     $contributionResult = civicrm_api3('Contribution', 'create', $contributionParams);
4510
4511     // Add new soft credit against current $contribution.
4512     if (CRM_Utils_Array::value('contributionRecur', $objects) && $objects['contributionRecur']->id) {
4513       CRM_Contribute_BAO_ContributionRecur::addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id);
4514     }
4515
4516     $paymentProcessorId = '';
4517     if (isset($objects['paymentProcessor'])) {
4518       if (is_array($objects['paymentProcessor'])) {
4519         $paymentProcessorId = $objects['paymentProcessor']['id'];
4520       }
4521       else {
4522         $paymentProcessorId = $objects['paymentProcessor']->id;
4523       }
4524     }
4525
4526     $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
4527       'labelColumn' => 'name',
4528       'flip' => 1,
4529     ));
4530     if ((empty($input['prevContribution']) && $paymentProcessorId) || (!$input['prevContribution']->is_pay_later && $input['prevContribution']->contribution_status_id == $contributionStatuses['Pending'])) {
4531       $input['payment_processor'] = $paymentProcessorId;
4532     }
4533
4534     if (!empty($contribution->_relatedObjects['participant'])) {
4535       $input['contribution_mode'] = 'participant';
4536       $input['participant_id'] = $contribution->_relatedObjects['participant']->id;
4537       $input['skipLineItem'] = 1;
4538     }
4539     elseif (!empty($contribution->_relatedObjects['membership'])) {
4540       $input['skipLineItem'] = TRUE;
4541       $input['contribution_mode'] = 'membership';
4542       $contribution->contribution_status_id = $contributionParams['contribution_status_id'];
4543       $contribution->trxn_id = CRM_Utils_Array::value('trxn_id', $input);
4544       $contribution->receive_date = CRM_Utils_Date::isoToMysql($contribution->receive_date);
4545     }
4546     $input['contribution_status_id'] = $contributionParams['contribution_status_id'];
4547     $input['total_amount'] = $input['amount'];
4548     $input['contribution'] = $contribution;
4549     $input['financial_type_id'] = $contribution->financial_type_id;
4550     //@todo writing a unit test I was unable to create a scenario where this line did not fatal on second
4551     // and subsequent payments. In this case the line items are created at
4552     // CRM_Contribute_BAO_ContributionRecur::addRecurLineItems
4553     // and since the contribution is saved prior to this line there is always a contribution-id,
4554     // however there is never a prevContribution (which appears to mean original contribution not previous
4555     // contribution - or preUpdateContributionObject most accurately)
4556     // so, this is always called & only appears to succeed when prevContribution exists - which appears
4557     // to mean "are we updating an exisitng pending contribution"
4558     //I was able to make the unit test complete as fataling here doesn't prevent
4559     // the contribution being created - but activities would not be created or emails sent
4560
4561     CRM_Contribute_BAO_Contribution::recordFinancialAccounts($input, NULL);
4562
4563     CRM_Core_Error::debug_log_message("Contribution record updated successfully");
4564     $transaction->commit();
4565
4566     CRM_Contribute_BAO_ContributionRecur::updateRecurLinkedPledge($contribution->id, $recurringContributionID,
4567       $input['contribution_status_id'], $input['total_amount']);
4568
4569     // create an activity record
4570     if ($input['component'] == 'contribute') {
4571       //CRM-4027
4572       $targetContactID = NULL;
4573       if (!empty($ids['related_contact'])) {
4574         $targetContactID = $contribution->contact_id;
4575         $contribution->contact_id = $ids['related_contact'];
4576       }
4577       CRM_Activity_BAO_Activity::addActivity($contribution, NULL, $targetContactID);
4578       // event
4579     }
4580     else {
4581       CRM_Activity_BAO_Activity::addActivity($participant);
4582     }
4583
4584     // CRM-9132 legacy behaviour was that receipts were sent out in all instances. Still sending
4585     // when array_key 'is_email_receipt doesn't exist in case some instances where is needs setting haven't been set
4586     if (!array_key_exists('is_email_receipt', $values) ||
4587       $values['is_email_receipt'] == 1
4588     ) {
4589       civicrm_api3('Contribution', 'sendconfirmation', array(
4590         'id' => $contribution->id,
4591         'payment_processor_id' => $paymentProcessorId,
4592       ));
4593       CRM_Core_Error::debug_log_message("Receipt sent");
4594     }
4595
4596     CRM_Core_Error::debug_log_message("Success: Database updated");
4597     if ($isRecurring) {
4598       CRM_Contribute_BAO_ContributionRecur::sendRecurringStartOrEndNotification($ids, $recur,
4599         $isFirstOrLastRecurringPayment);
4600     }
4601     return $contributionResult;
4602   }
4603
4604   /**
4605    * Send receipt from contribution.
4606    *
4607    * Do not call this directly - it is being refactored. use contribution.sendmessage api call.
4608    *
4609    * Note that the compose message part has been moved to contribution
4610    * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it.
4611    *
4612    * @param array $input
4613    *   Incoming data from Payment processor.
4614    * @param array $ids
4615    *   Related object IDs.
4616    * @param int $contributionID
4617    * @param array $values
4618    *   Values related to objects that have already been loaded.
4619    * @param bool $recur
4620    *   Is it part of a recurring contribution.
4621    * @param bool $returnMessageText
4622    *   Should text be returned instead of sent. This.
4623    *   is because the function is also used to generate pdfs
4624    *
4625    * @return array
4626    * @throws \CRM_Core_Exception
4627    * @throws \CiviCRM_API3_Exception
4628    */
4629   public static function sendMail(&$input, &$ids, $contributionID, &$values, $recur = FALSE,
4630                                   $returnMessageText = FALSE) {
4631     $input['is_recur'] = $recur;
4632
4633     $contribution = new CRM_Contribute_BAO_Contribution();
4634     $contribution->id = $contributionID;
4635     if (!$contribution->find(TRUE)) {
4636       throw new CRM_Core_Exception('Contribution does not exist');
4637     }
4638     $contribution->loadRelatedObjects($input, $ids, TRUE);
4639     // set receipt from e-mail and name in value
4640     if (!$returnMessageText) {
4641       $session = CRM_Core_Session::singleton();
4642       $userID = $session->get('userID');
4643       if (!empty($userID)) {
4644         list($userName, $userEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($userID);
4645         $values['receipt_from_email'] = CRM_Utils_Array::value('receipt_from_email', $input, $userEmail);
4646         $values['receipt_from_name'] = CRM_Utils_Array::value('receipt_from_name', $input, $userName);
4647       }
4648     }
4649
4650     $return = $contribution->composeMessageArray($input, $ids, $values, $recur, $returnMessageText);
4651     // Contribution ID should really always be set. But ?
4652     if (!$returnMessageText && (!isset($input['receipt_update']) || $input['receipt_update']) && empty($contribution->receipt_date)) {
4653       civicrm_api3('Contribution', 'create', array('receipt_date' => 'now', 'id' => $contribution->id));
4654     }
4655     return $return;
4656   }
4657
4658   /**
4659    * Generate credit note id with next avaible number
4660    *
4661    * @return string
4662    *   Credit Note Id.
4663    */
4664   public static function createCreditNoteId() {
4665     $prefixValue = Civi::settings()->get('contribution_invoice_settings');
4666
4667     $creditNoteNum = CRM_Core_DAO::singleValueQuery("SELECT count(creditnote_id) as creditnote_number FROM civicrm_contribution");
4668     $creditNoteId = NULL;
4669
4670     do {
4671       $creditNoteNum++;
4672       $creditNoteId = CRM_Utils_Array::value('credit_notes_prefix', $prefixValue) . "" . $creditNoteNum;
4673       $result = civicrm_api3('Contribution', 'getcount', array(
4674         'sequential' => 1,
4675         'creditnote_id' => $creditNoteId,
4676       ));
4677     } while ($result > 0);
4678
4679     return $creditNoteId;
4680   }
4681
4682   /**
4683    * Load related memberships.
4684    *
4685    * Note that in theory it should be possible to retrieve these from the line_item table
4686    * with the membership_payment table being deprecated. Attempting to do this here causes tests to fail
4687    * as it seems the api is not correctly linking the line items when the contribution is created in the flow
4688    * where the contribution is created in the API, followed by the membership (using the api) followed by the membership
4689    * payment. The membership payment BAO does have code to address this but it doesn't appear to be working.
4690    *
4691    * I don't know if it never worked or broke as a result of https://issues.civicrm.org/jira/browse/CRM-14918.
4692    *
4693    * @param array $ids
4694    *
4695    * @throws Exception
4696    */
4697   public function loadRelatedMembershipObjects(&$ids) {
4698     $query = "
4699       SELECT membership_id
4700       FROM   civicrm_membership_payment
4701       WHERE  contribution_id = %1 ";
4702     $params = array(1 => array($this->id, 'Integer'));
4703
4704     $dao = CRM_Core_DAO::executeQuery($query, $params);
4705     while ($dao->fetch()) {
4706       if ($dao->membership_id) {
4707         if (!is_array($ids['membership'])) {
4708           $ids['membership'] = array();
4709         }
4710         $ids['membership'][] = $dao->membership_id;
4711       }
4712     }
4713
4714     if (array_key_exists('membership', $ids) && is_array($ids['membership'])) {
4715       foreach ($ids['membership'] as $id) {
4716         if (!empty($id)) {
4717           $membership = new CRM_Member_BAO_Membership();
4718           $membership->id = $id;
4719           if (!$membership->find(TRUE)) {
4720             throw new Exception("Could not find membership record: $id");
4721           }
4722           $membership->join_date = CRM_Utils_Date::isoToMysql($membership->join_date);
4723           $membership->start_date = CRM_Utils_Date::isoToMysql($membership->start_date);
4724           $membership->end_date = CRM_Utils_Date::isoToMysql($membership->end_date);
4725           $this->_relatedObjects['membership'][$membership->membership_type_id] = $membership;
4726           $membership->free();
4727         }
4728       }
4729     }
4730   }
4731
4732   /**
4733    * This function is used to record partial payments for contribution
4734    *
4735    * @param array $contribution
4736    *
4737    * @param array $params
4738    *
4739    * @return object
4740    */
4741   public static function recordPartialPayment($contribution, $params) {
4742     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
4743     $pendingStatus = array(
4744       array_search('Pending', $contributionStatuses),
4745       array_search('In Progress', $contributionStatuses),
4746     );
4747     $statusId = array_search('Completed', $contributionStatuses);
4748     if (in_array(CRM_Utils_Array::value('contribution_status_id', $contribution), $pendingStatus)) {
4749       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
4750       $balanceTrxnParams['to_financial_account_id'] = CRM_Contribute_PseudoConstant::financialAccountType($contribution['financial_type_id'], $relationTypeId);
4751     }
4752     elseif (!empty($params['payment_processor'])) {
4753       $balanceTrxnParams['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getFinancialAccount($contribution['payment_processor'], 'civicrm_payment_processor', 'financial_account_id');
4754     }
4755     elseif (!empty($params['payment_instrument_id'])) {
4756       $balanceTrxnParams['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($contribution['payment_instrument_id']);
4757     }
4758     else {
4759       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
4760       $queryParams = array(1 => array($relationTypeId, 'Integer'));
4761       $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);
4762     }
4763     $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
4764     $fromFinancialAccountId = CRM_Contribute_PseudoConstant::financialAccountType($contribution['financial_type_id'], $relationTypeId);
4765     $balanceTrxnParams['from_financial_account_id'] = $fromFinancialAccountId;
4766     $balanceTrxnParams['total_amount'] = $params['total_amount'];
4767     $balanceTrxnParams['contribution_id'] = $params['contribution_id'];
4768     $balanceTrxnParams['trxn_date'] = !empty($params['contribution_receive_date']) ? $params['contribution_receive_date'] : date('YmdHis');
4769     $balanceTrxnParams['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
4770     $balanceTrxnParams['net_amount'] = CRM_Utils_Array::value('total_amount', $params);
4771     $balanceTrxnParams['currency'] = $contribution['currency'];
4772     $balanceTrxnParams['trxn_id'] = CRM_Utils_Array::value('contribution_trxn_id', $params, NULL);
4773     $balanceTrxnParams['status_id'] = $statusId;
4774     $balanceTrxnParams['payment_instrument_id'] = CRM_Utils_Array::value('payment_instrument_id', $params, $contribution['payment_instrument_id']);
4775     $balanceTrxnParams['check_number'] = CRM_Utils_Array::value('check_number', $params);
4776     if ($fromFinancialAccountId != NULL &&
4777       ($statusId == array_search('Completed', $contributionStatuses) || $statusId == array_search('Partially paid', $contributionStatuses))
4778     ) {
4779       $balanceTrxnParams['is_payment'] = 1;
4780     }
4781     if (!empty($params['payment_processor'])) {
4782       $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
4783     }
4784     return CRM_Core_BAO_FinancialTrxn::create($balanceTrxnParams);
4785   }
4786
4787   /**
4788    * Get the description (source field) for the recurring contribution.
4789    *
4790    * @param CRM_Contribute_BAO_Contribution $contribution
4791    * @param CRM_Event_DAO_Event|null $event
4792    *
4793    * @return array
4794    * @throws \CiviCRM_API3_Exception
4795    */
4796   protected static function getRecurringContributionDescription($contribution, $event) {
4797     if (!empty($contribution->source)) {
4798       return $contribution->source;
4799     }
4800     elseif (!empty($contribution->contribution_page_id)) {
4801       $contributionPageTitle = civicrm_api3('ContributionPage', 'getvalue', array(
4802         'id' => $contribution->contribution_page_id,
4803         'return' => 'title',
4804       ));
4805       return ts('Online Contribution') . ': ' . $contributionPageTitle;
4806     }
4807     elseif ($event) {
4808       return ts('Online Event Registration') . ': ' . $event->title;
4809     }
4810     return 'recurring contribution';
4811   }
4812
4813   /**
4814    * Function to add payments for contribution
4815    * for Partially Paid status
4816    *
4817    * @param array $lineItems
4818    * @param array $contributions
4819    *
4820    */
4821   public static function addPayments($lineItems, $contributions) {
4822     // get financial trxn which is a payment
4823     $ftSql = "SELECT ft.id, ft.total_amount
4824       FROM civicrm_financial_trxn ft
4825       INNER JOIN civicrm_entity_financial_trxn eft ON eft.financial_trxn_id = ft.id AND eft.entity_table = 'civicrm_contribution'
4826       WHERE eft.entity_id = %1 AND ft.is_payment = 1 ORDER BY ft.id DESC LIMIT 1";
4827     $sql = "SELECT fi.id, li.price_field_value_id
4828       FROM civicrm_financial_item fi
4829       INNER JOIN civicrm_line_item li ON li.id = fi.entity_id
4830       WHERE li.contribution_id = %1";
4831
4832     foreach ($contributions as $k => $contribution) {
4833       if ($contribution->contribution_status_id != CRM_Core_OptionGroup::getValue('contribution_status', 'Partially paid', 'name')) {
4834         continue;
4835       }
4836       $ftDao = CRM_Core_DAO::executeQuery($ftSql, array(1 => array($contribution->id, 'Integer')));
4837       $ftDao->fetch();
4838       $trxnAmount = $ftDao->total_amount;
4839       $ftId = $ftDao->id;
4840
4841       // get financial item
4842       $dao = CRM_Core_DAO::executeQuery($sql, array(1 => array($contribution->id, 'Integer')));
4843       while ($dao->fetch()) {
4844         $ftIds[$dao->price_field_value_id] = $dao->id;
4845       }
4846
4847       $params = array(
4848         'entity_table' => 'civicrm_financial_item',
4849         'financial_trxn_id' => $ftId,
4850       );
4851       foreach ($lineItems as $key => $value) {
4852         $paid = $value['line_total'] * ($trxnAmount / $contribution->total_amount);
4853         // Record Entity Financial Trxn
4854         $params['amount'] = round($paid, 2);
4855         $params['entity_id'] = $ftIds[$value['price_field_value_id']];
4856
4857         civicrm_api3('EntityFinancialTrxn', 'create', $params);
4858       }
4859     }
4860   }
4861
4862   /**
4863    * Function use to store line item proportionaly in
4864    * in entity financial trxn table
4865    *
4866    * @param array $params
4867    *  array of contribution params.
4868    * @param object $trxn
4869    *  CRM_Financial_DAO_FinancialTrxn object
4870    * @param array $contribution
4871    *
4872    */
4873   public static function assignProportionalLineItems($params, $trxn, $contribution) {
4874     $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($params['contribution_id']);
4875     if (!empty($lineItems)) {
4876       // get financial item
4877       $sql = "SELECT fi.id, li.price_field_value_id
4878       FROM civicrm_financial_item fi
4879       INNER JOIN civicrm_line_item li ON li.id = fi.entity_id and fi.entity_table = 'civicrm_line_item'
4880       WHERE li.contribution_id = %1";
4881       $dao = CRM_Core_DAO::executeQuery($sql, array(1 => array($params['contribution_id'], 'Integer')));
4882       while ($dao->fetch()) {
4883         $ftIds[$dao->price_field_value_id] = $dao->id;
4884       }
4885       $eftParams = array(
4886         'entity_table' => 'civicrm_financial_item',
4887         'financial_trxn_id' => $trxn->id,
4888       );
4889       foreach ($lineItems as $key => $value) {
4890         $paid = $value['line_total'] * ($params['total_amount'] / $contribution['total_amount']);
4891         // Record Entity Financial Trxn
4892         $eftParams['amount'] = round($paid, 2);
4893         $eftParams['entity_id'] = $ftIds[$value['price_field_value_id']];
4894
4895         civicrm_api3('EntityFinancialTrxn', 'create', $eftParams);
4896       }
4897     }
4898   }
4899
4900   /**
4901    * Function to check line items
4902    *
4903    * @param array $params
4904    *  array of order params.
4905    *
4906    */
4907   public static function checkLineItems(&$params) {
4908     $totalAmount = CRM_Utils_Array::value('total_amount', $params);
4909     $lineItemAmount = 0;
4910     foreach ($params['line_items'] as &$lineItems) {
4911       foreach ($lineItems['line_item'] as &$item) {
4912         if (empty($item['financial_type_id'])) {
4913           $item['financial_type_id'] = $params['financial_type_id'];
4914         }
4915         $lineItemAmount += $item['line_total'];
4916       }
4917     }
4918     if (!isset($totalAmount)) {
4919       $params['total_amount'] = $lineItemAmount;
4920     }
4921     elseif ($totalAmount != $lineItemAmount) {
4922       throw new API_Exception("Line item total doesn't match with total amount.");
4923     }
4924   }
4925
4926   /**
4927    * Get the financial account for the item associated with the new transaction.
4928    *
4929    * @param array $params
4930    * @param CRM_Financial_BAO_FinancialItem $prevFinancialItem
4931    *
4932    * @return int
4933    */
4934   public static function getFinancialAccountForStatusChangeTrxn($params, $prevFinancialItem) {
4935
4936     if (!empty($params['financial_account_id'])) {
4937       return $params['financial_account_id'];
4938     }
4939     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus($params['contribution_status_id'], 'name');
4940     $preferredAccountsRelationships = array(
4941       'Refunded' => 'Credit/Contra Revenue Account is',
4942       'Chargeback' => 'Chargeback Account is',
4943     );
4944     if (in_array($contributionStatus, array_keys($preferredAccountsRelationships))) {
4945       $financialTypeID = !empty($params['financial_type_id']) ? $params['financial_type_id'] : $params['prevContribution']->financial_type_id;
4946       return CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship(
4947         $financialTypeID,
4948         $preferredAccountsRelationships[$contributionStatus]
4949       );
4950     }
4951     return $prevFinancialItem->financial_account_id;
4952   }
4953
4954 }