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 contributions which credit the passed in contact ID.
1211    *
1212    * The returned array provides details about the original contribution & donor.
1213    *
1214    * @todo - this is a confusing function called from one place. It has a test. It would be
1215    * nice to deprecate it.
1216    *
1217    * @param int $honorId
1218    *   In Honor of Contact ID.
1219    *
1220    * @return array
1221    *   list of contribution fields
1222    */
1223   public static function getHonorContacts($honorId) {
1224     $params = array();
1225     $honorDAO = new CRM_Contribute_DAO_ContributionSoft();
1226     $honorDAO->contact_id = $honorId;
1227     $honorDAO->find();
1228
1229     $type = CRM_Contribute_PseudoConstant::financialType();
1230
1231     while ($honorDAO->fetch()) {
1232       $contributionDAO = new CRM_Contribute_DAO_Contribution();
1233       $contributionDAO->id = $honorDAO->contribution_id;
1234
1235       if ($contributionDAO->find(TRUE)) {
1236         $params[$contributionDAO->id]['honor_type'] = CRM_Core_PseudoConstant::getLabel('CRM_Contribute_BAO_ContributionSoft', 'soft_credit_type_id', $honorDAO->soft_credit_type_id);
1237         $params[$contributionDAO->id]['honorId'] = $contributionDAO->contact_id;
1238         $params[$contributionDAO->id]['display_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contributionDAO->contact_id, 'display_name');
1239         $params[$contributionDAO->id]['type'] = $type[$contributionDAO->financial_type_id];
1240         $params[$contributionDAO->id]['type_id'] = $contributionDAO->financial_type_id;
1241         $params[$contributionDAO->id]['amount'] = CRM_Utils_Money::format($contributionDAO->total_amount, $contributionDAO->currency);
1242         $params[$contributionDAO->id]['source'] = $contributionDAO->source;
1243         $params[$contributionDAO->id]['receive_date'] = $contributionDAO->receive_date;
1244         $params[$contributionDAO->id]['contribution_status'] = CRM_Contribute_PseudoConstant::contributionStatus($contributionDAO->contribution_status_id);
1245       }
1246     }
1247
1248     return $params;
1249   }
1250
1251   /**
1252    * Get the sort name of a contact for a particular contribution.
1253    *
1254    * @param int $id
1255    *   Id of the contribution.
1256    *
1257    * @return null|string
1258    *   sort name of the contact if found
1259    */
1260   public static function sortName($id) {
1261     $id = CRM_Utils_Type::escape($id, 'Integer');
1262
1263     $query = "
1264 SELECT civicrm_contact.sort_name
1265 FROM   civicrm_contribution, civicrm_contact
1266 WHERE  civicrm_contribution.contact_id = civicrm_contact.id
1267   AND  civicrm_contribution.id = {$id}
1268 ";
1269     return CRM_Core_DAO::singleValueQuery($query);
1270   }
1271
1272   /**
1273    * @param int $contactID
1274    *
1275    * @return array
1276    */
1277   public static function annual($contactID) {
1278     if (is_array($contactID)) {
1279       $contactIDs = implode(',', $contactID);
1280     }
1281     else {
1282       $contactIDs = $contactID;
1283     }
1284
1285     $config = CRM_Core_Config::singleton();
1286     $startDate = $endDate = NULL;
1287
1288     $currentMonth = date('m');
1289     $currentDay = date('d');
1290     if ((int ) $config->fiscalYearStart['M'] > $currentMonth ||
1291       ((int ) $config->fiscalYearStart['M'] == $currentMonth &&
1292         (int ) $config->fiscalYearStart['d'] > $currentDay
1293       )
1294     ) {
1295       $year = date('Y') - 1;
1296     }
1297     else {
1298       $year = date('Y');
1299     }
1300     $nextYear = $year + 1;
1301
1302     if ($config->fiscalYearStart) {
1303       $newFiscalYearStart = $config->fiscalYearStart;
1304       if ($newFiscalYearStart['M'] < 10) {
1305         $newFiscalYearStart['M'] = '0' . $newFiscalYearStart['M'];
1306       }
1307       if ($newFiscalYearStart['d'] < 10) {
1308         $newFiscalYearStart['d'] = '0' . $newFiscalYearStart['d'];
1309       }
1310       $config->fiscalYearStart = $newFiscalYearStart;
1311       $monthDay = $config->fiscalYearStart['M'] . $config->fiscalYearStart['d'];
1312     }
1313     else {
1314       $monthDay = '0101';
1315     }
1316     $startDate = "$year$monthDay";
1317     $endDate = "$nextYear$monthDay";
1318     CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes);
1319     $additionalWhere = " AND b.financial_type_id IN (0)";
1320     $liWhere = " AND i.financial_type_id IN (0)";
1321     if (!empty($financialTypes)) {
1322       $additionalWhere = " AND b.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ") AND i.id IS NULL";
1323       $liWhere = " AND i.financial_type_id NOT IN (" . implode(',', array_keys($financialTypes)) . ")";
1324     }
1325     $query = "
1326       SELECT count(*) as count,
1327              sum(total_amount) as amount,
1328              avg(total_amount) as average,
1329              currency
1330         FROM civicrm_contribution b
1331         LEFT JOIN civicrm_line_item i ON i.contribution_id = b.id AND i.entity_table = 'civicrm_contribution' $liWhere
1332        WHERE b.contact_id IN ( $contactIDs )
1333          AND b.contribution_status_id = 1
1334          AND b.is_test = 0
1335          AND b.receive_date >= $startDate
1336          AND b.receive_date <  $endDate
1337       $additionalWhere
1338       GROUP BY currency
1339       ";
1340     $dao = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
1341     $count = 0;
1342     $amount = $average = array();
1343     while ($dao->fetch()) {
1344       if ($dao->count > 0 && $dao->amount > 0) {
1345         $count += $dao->count;
1346         $amount[] = CRM_Utils_Money::format($dao->amount, $dao->currency);
1347         $average[] = CRM_Utils_Money::format($dao->average, $dao->currency);
1348       }
1349     }
1350     if ($count > 0) {
1351       return array(
1352         $count,
1353         implode(',&nbsp;', $amount),
1354         implode(',&nbsp;', $average),
1355       );
1356     }
1357     return array(0, 0, 0);
1358   }
1359
1360   /**
1361    * Check if there is a contribution with the params passed in.
1362    *
1363    * Used for trxn_id,invoice_id and contribution_id
1364    *
1365    * @param array $params
1366    *   An assoc array of name/value pairs.
1367    *
1368    * @return array
1369    *   contribution id if success else NULL
1370    */
1371   public static function checkDuplicateIds($params) {
1372     $dao = new CRM_Contribute_DAO_Contribution();
1373
1374     $clause = array();
1375     $input = array();
1376     foreach ($params as $k => $v) {
1377       if ($v) {
1378         $clause[] = "$k = '$v'";
1379       }
1380     }
1381     $clause = implode(' AND ', $clause);
1382     $query = "SELECT id FROM civicrm_contribution WHERE $clause";
1383     $dao = CRM_Core_DAO::executeQuery($query, $input);
1384
1385     while ($dao->fetch()) {
1386       $result = $dao->id;
1387       return $result;
1388     }
1389     return NULL;
1390   }
1391
1392   /**
1393    * Get the contribution details for component export.
1394    *
1395    * @param int $exportMode
1396    *   Export mode.
1397    * @param string $componentIds
1398    *   Component ids.
1399    *
1400    * @return array
1401    *   associated array
1402    */
1403   public static function getContributionDetails($exportMode, $componentIds) {
1404     $paymentDetails = array();
1405     $componentClause = ' IN ( ' . implode(',', $componentIds) . ' ) ';
1406
1407     if ($exportMode == CRM_Export_Form_Select::EVENT_EXPORT) {
1408       $componentSelect = " civicrm_participant_payment.participant_id id";
1409       $additionalClause = "
1410 INNER JOIN civicrm_participant_payment ON (civicrm_contribution.id = civicrm_participant_payment.contribution_id
1411 AND civicrm_participant_payment.participant_id {$componentClause} )
1412 ";
1413     }
1414     elseif ($exportMode == CRM_Export_Form_Select::MEMBER_EXPORT) {
1415       $componentSelect = " civicrm_membership_payment.membership_id id";
1416       $additionalClause = "
1417 INNER JOIN civicrm_membership_payment ON (civicrm_contribution.id = civicrm_membership_payment.contribution_id
1418 AND civicrm_membership_payment.membership_id {$componentClause} )
1419 ";
1420     }
1421     elseif ($exportMode == CRM_Export_Form_Select::PLEDGE_EXPORT) {
1422       $componentSelect = " civicrm_pledge_payment.id id";
1423       $additionalClause = "
1424 INNER JOIN civicrm_pledge_payment ON (civicrm_contribution.id = civicrm_pledge_payment.contribution_id
1425 AND civicrm_pledge_payment.pledge_id {$componentClause} )
1426 ";
1427     }
1428
1429     $query = " SELECT total_amount, contribution_status.name as status_id, contribution_status.label as status, payment_instrument.name as payment_instrument, receive_date,
1430                           trxn_id, {$componentSelect}
1431 FROM civicrm_contribution
1432 LEFT JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')
1433 LEFT JOIN civicrm_option_value payment_instrument ON (civicrm_contribution.payment_instrument_id = payment_instrument.value
1434      AND option_group_payment_instrument.id = payment_instrument.option_group_id )
1435 LEFT JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')
1436 LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
1437                                AND option_group_contribution_status.id = contribution_status.option_group_id )
1438 {$additionalClause}
1439 ";
1440
1441     $dao = CRM_Core_DAO::executeQuery($query);
1442
1443     while ($dao->fetch()) {
1444       $paymentDetails[$dao->id] = array(
1445         'total_amount' => $dao->total_amount,
1446         'contribution_status' => $dao->status,
1447         'receive_date' => $dao->receive_date,
1448         'pay_instru' => $dao->payment_instrument,
1449         'trxn_id' => $dao->trxn_id,
1450       );
1451     }
1452
1453     return $paymentDetails;
1454   }
1455
1456   /**
1457    * Create address associated with contribution record.
1458    *
1459    * As long as there is one or more billing field in the parameters we will create the address.
1460    *
1461    * (historically the decision to create or not was based on the payment 'type' but these lines are greyer than once
1462    * thought).
1463    *
1464    * @param array $params
1465    * @param int $billingLocationTypeID
1466    *
1467    * @return int
1468    *   address id
1469    */
1470   public static function createAddress($params, $billingLocationTypeID) {
1471     list($hasBillingField, $addressParams) = self::getBillingAddressParams($params, $billingLocationTypeID);
1472     if ($hasBillingField) {
1473       $address = CRM_Core_BAO_Address::add($addressParams, FALSE);
1474       return $address->id;
1475     }
1476     return NULL;
1477
1478   }
1479
1480   /**
1481    * Delete billing address record related contribution.
1482    *
1483    * @param int $contributionId
1484    * @param int $contactId
1485    */
1486   public static function deleteAddress($contributionId = NULL, $contactId = NULL) {
1487     $clauses = array();
1488     $contactJoin = NULL;
1489
1490     if ($contributionId) {
1491       $clauses[] = "cc.id = {$contributionId}";
1492     }
1493
1494     if ($contactId) {
1495       $clauses[] = "cco.id = {$contactId}";
1496       $contactJoin = "INNER JOIN civicrm_contact cco ON cc.contact_id = cco.id";
1497     }
1498
1499     if (empty($clauses)) {
1500       CRM_Core_Error::fatal();
1501     }
1502
1503     $condition = implode(' OR ', $clauses);
1504
1505     $query = "
1506 SELECT     ca.id
1507 FROM       civicrm_address ca
1508 INNER JOIN civicrm_contribution cc ON cc.address_id = ca.id
1509            $contactJoin
1510 WHERE      $condition
1511 ";
1512     $dao = CRM_Core_DAO::executeQuery($query);
1513
1514     while ($dao->fetch()) {
1515       $params = array('id' => $dao->id);
1516       CRM_Core_BAO_Block::blockDelete('Address', $params);
1517     }
1518   }
1519
1520   /**
1521    * This function check online pending contribution associated w/
1522    * Online Event Registration or Online Membership signup.
1523    *
1524    * @param int $componentId
1525    *   Participant/membership id.
1526    * @param string $componentName
1527    *   Event/Membership.
1528    *
1529    * @return int
1530    *   pending contribution id.
1531    */
1532   public static function checkOnlinePendingContribution($componentId, $componentName) {
1533     $contributionId = NULL;
1534     if (!$componentId ||
1535       !in_array($componentName, array('Event', 'Membership'))
1536     ) {
1537       return $contributionId;
1538     }
1539
1540     if ($componentName == 'Event') {
1541       $idName = 'participant_id';
1542       $componentTable = 'civicrm_participant';
1543       $paymentTable = 'civicrm_participant_payment';
1544       $source = ts('Online Event Registration');
1545     }
1546
1547     if ($componentName == 'Membership') {
1548       $idName = 'membership_id';
1549       $componentTable = 'civicrm_membership';
1550       $paymentTable = 'civicrm_membership_payment';
1551       $source = ts('Online Contribution');
1552     }
1553
1554     $pendingStatusId = array_search('Pending', CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'));
1555
1556     $query = "
1557    SELECT  component.id as {$idName},
1558            componentPayment.contribution_id as contribution_id,
1559            contribution.source source,
1560            contribution.contribution_status_id as contribution_status_id,
1561            contribution.is_pay_later as is_pay_later
1562      FROM  $componentTable component
1563 LEFT JOIN  $paymentTable componentPayment    ON ( componentPayment.{$idName} = component.id )
1564 LEFT JOIN  civicrm_contribution contribution ON ( componentPayment.contribution_id = contribution.id )
1565     WHERE  component.id = {$componentId}";
1566
1567     $dao = CRM_Core_DAO::executeQuery($query);
1568
1569     while ($dao->fetch()) {
1570       if ($dao->contribution_id &&
1571         $dao->is_pay_later &&
1572         $dao->contribution_status_id == $pendingStatusId &&
1573         strpos($dao->source, $source) !== FALSE
1574       ) {
1575         $contributionId = $dao->contribution_id;
1576         $dao->free();
1577       }
1578     }
1579
1580     return $contributionId;
1581   }
1582
1583   /**
1584    * Update contribution as well as related objects.
1585    *
1586    * This function by-passes hooks - to address this - don't use this function.
1587    *
1588    * @deprecated
1589    *
1590    * Use api contribute.completetransaction
1591    * For failures use failPayment (preferably exposing by api in the process).
1592    *
1593    * @param array $params
1594    * @param bool $processContributionObject
1595    *
1596    * @return array
1597    * @throws \Exception
1598    */
1599   public static function transitionComponents($params, $processContributionObject = FALSE) {
1600     // get minimum required values.
1601     $contactId = CRM_Utils_Array::value('contact_id', $params);
1602     $componentId = CRM_Utils_Array::value('component_id', $params);
1603     $componentName = CRM_Utils_Array::value('componentName', $params);
1604     $contributionId = CRM_Utils_Array::value('contribution_id', $params);
1605     $contributionStatusId = CRM_Utils_Array::value('contribution_status_id', $params);
1606
1607     // if we already processed contribution object pass previous status id.
1608     $previousContriStatusId = CRM_Utils_Array::value('previous_contribution_status_id', $params);
1609
1610     $updateResult = array();
1611
1612     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
1613
1614     // we process only ( Completed, Cancelled, or Failed ) contributions.
1615     if (!$contributionId ||
1616       !in_array($contributionStatusId, array(
1617         array_search('Completed', $contributionStatuses),
1618         array_search('Cancelled', $contributionStatuses),
1619         array_search('Failed', $contributionStatuses),
1620       ))
1621     ) {
1622       return $updateResult;
1623     }
1624
1625     if (!$componentName || !$componentId) {
1626       // get the related component details.
1627       $componentDetails = self::getComponentDetails($contributionId);
1628     }
1629     else {
1630       $componentDetails['contact_id'] = $contactId;
1631       $componentDetails['component'] = $componentName;
1632
1633       if ($componentName == 'event') {
1634         $componentDetails['participant'] = $componentId;
1635       }
1636       else {
1637         $componentDetails['membership'] = $componentId;
1638       }
1639     }
1640
1641     if (!empty($componentDetails['contact_id'])) {
1642       $componentDetails['contact_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
1643         $contributionId,
1644         'contact_id'
1645       );
1646     }
1647
1648     // do check for required ids.
1649     if (empty($componentDetails['membership']) && empty($componentDetails['participant']) && empty($componentDetails['pledge_payment']) || empty($componentDetails['contact_id'])) {
1650       return $updateResult;
1651     }
1652
1653     //now we are ready w/ required ids, start processing.
1654
1655     $baseIPN = new CRM_Core_Payment_BaseIPN();
1656
1657     $input = $ids = $objects = array();
1658
1659     $input['component'] = CRM_Utils_Array::value('component', $componentDetails);
1660     $ids['contribution'] = $contributionId;
1661     $ids['contact'] = CRM_Utils_Array::value('contact_id', $componentDetails);
1662     $ids['membership'] = CRM_Utils_Array::value('membership', $componentDetails);
1663     $ids['participant'] = CRM_Utils_Array::value('participant', $componentDetails);
1664     $ids['event'] = CRM_Utils_Array::value('event', $componentDetails);
1665     $ids['pledge_payment'] = CRM_Utils_Array::value('pledge_payment', $componentDetails);
1666     $ids['contributionRecur'] = NULL;
1667     $ids['contributionPage'] = NULL;
1668
1669     if (!$baseIPN->validateData($input, $ids, $objects, FALSE)) {
1670       CRM_Core_Error::fatal();
1671     }
1672
1673     $memberships = &$objects['membership'];
1674     $participant = &$objects['participant'];
1675     $pledgePayment = &$objects['pledge_payment'];
1676     $contribution = &$objects['contribution'];
1677
1678     if ($pledgePayment) {
1679       $pledgePaymentIDs = array();
1680       foreach ($pledgePayment as $key => $object) {
1681         $pledgePaymentIDs[] = $object->id;
1682       }
1683       $pledgeID = $pledgePayment[0]->pledge_id;
1684     }
1685
1686     $membershipStatuses = CRM_Member_PseudoConstant::membershipStatus();
1687
1688     if ($participant) {
1689       $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
1690       $oldStatus = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant',
1691         $participant->id,
1692         'status_id'
1693       );
1694     }
1695     // we might want to process contribution object.
1696     $processContribution = FALSE;
1697     if ($contributionStatusId == array_search('Cancelled', $contributionStatuses)) {
1698       if (is_array($memberships)) {
1699         foreach ($memberships as $membership) {
1700           if ($membership) {
1701             $membership->status_id = array_search('Cancelled', $membershipStatuses);
1702             $membership->save();
1703
1704             $updateResult['updatedComponents']['CiviMember'] = $membership->status_id;
1705             if ($processContributionObject) {
1706               $processContribution = TRUE;
1707             }
1708           }
1709         }
1710       }
1711
1712       if ($participant) {
1713         $updatedStatusId = array_search('Cancelled', $participantStatuses);
1714         CRM_Event_BAO_Participant::updateParticipantStatus($participant->id, $oldStatus, $updatedStatusId, TRUE);
1715
1716         $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1717         if ($processContributionObject) {
1718           $processContribution = TRUE;
1719         }
1720       }
1721
1722       if ($pledgePayment) {
1723         CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1724
1725         $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1726         if ($processContributionObject) {
1727           $processContribution = TRUE;
1728         }
1729       }
1730     }
1731     elseif ($contributionStatusId == array_search('Failed', $contributionStatuses)) {
1732       if (is_array($memberships)) {
1733         foreach ($memberships as $membership) {
1734           if ($membership) {
1735             $membership->status_id = array_search('Expired', $membershipStatuses);
1736             $membership->save();
1737
1738             $updateResult['updatedComponents']['CiviMember'] = $membership->status_id;
1739             if ($processContributionObject) {
1740               $processContribution = TRUE;
1741             }
1742           }
1743         }
1744       }
1745       if ($participant) {
1746         $updatedStatusId = array_search('Cancelled', $participantStatuses);
1747         CRM_Event_BAO_Participant::updateParticipantStatus($participant->id, $oldStatus, $updatedStatusId, TRUE);
1748
1749         $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1750         if ($processContributionObject) {
1751           $processContribution = TRUE;
1752         }
1753       }
1754
1755       if ($pledgePayment) {
1756         CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1757
1758         $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1759         if ($processContributionObject) {
1760           $processContribution = TRUE;
1761         }
1762       }
1763     }
1764     elseif ($contributionStatusId == array_search('Completed', $contributionStatuses)) {
1765
1766       // only pending contribution related object processed.
1767       if ($previousContriStatusId &&
1768         ($previousContriStatusId != array_search('Pending', $contributionStatuses))
1769       ) {
1770         // this is case when we already processed contribution object.
1771         return $updateResult;
1772       }
1773       elseif (!$previousContriStatusId &&
1774         $contribution->contribution_status_id != array_search('Pending', $contributionStatuses)
1775       ) {
1776         // this is case when we are going to process contribution object later.
1777         return $updateResult;
1778       }
1779
1780       if (is_array($memberships)) {
1781         foreach ($memberships as $membership) {
1782           if ($membership) {
1783             $format = '%Y%m%d';
1784
1785             //CRM-4523
1786             $currentMembership = CRM_Member_BAO_Membership::getContactMembership($membership->contact_id,
1787               $membership->membership_type_id,
1788               $membership->is_test, $membership->id
1789             );
1790
1791             // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
1792             // this picks up membership type changes during renewals
1793             $sql = "
1794               SELECT    membership_type_id
1795               FROM      civicrm_membership_log
1796               WHERE     membership_id=$membership->id
1797               ORDER BY  id DESC
1798               LIMIT     1;";
1799             $dao = new CRM_Core_DAO();
1800             $dao->query($sql);
1801             if ($dao->fetch()) {
1802               if (!empty($dao->membership_type_id)) {
1803                 $membership->membership_type_id = $dao->membership_type_id;
1804                 $membership->save();
1805               }
1806             }
1807             // else fall back to using current membership type
1808             $dao->free();
1809
1810             // Figure out number of terms
1811             $numterms = 1;
1812             $lineitems = CRM_Price_BAO_LineItem::getLineItems($contributionId, 'contribution');
1813             foreach ($lineitems as $lineitem) {
1814               if ($membership->membership_type_id == CRM_Utils_Array::value('membership_type_id', $lineitem)) {
1815                 $numterms = CRM_Utils_Array::value('membership_num_terms', $lineitem);
1816
1817                 // in case membership_num_terms comes through as null or zero
1818                 $numterms = $numterms >= 1 ? $numterms : 1;
1819                 break;
1820               }
1821             }
1822
1823             // CRM-15735-to update the membership status as per the contribution receive date
1824             $joinDate = NULL;
1825             if (!empty($params['receive_date'])) {
1826               $joinDate = $params['receive_date'];
1827               $status = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($membership->start_date,
1828                 $membership->end_date,
1829                 $membership->join_date,
1830                 $params['receive_date'],
1831                 FALSE,
1832                 $membership->membership_type_id,
1833                 (array) $membership
1834               );
1835               $membership->status_id = CRM_Utils_Array::value('id', $status, $membership->status_id);
1836               $membership->save();
1837             }
1838
1839             if ($currentMembership) {
1840               CRM_Member_BAO_Membership::fixMembershipStatusBeforeRenew($currentMembership, NULL);
1841               $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($membership->id, NULL, NULL, $numterms);
1842               $dates['join_date'] = CRM_Utils_Date::customFormat($currentMembership['join_date'], $format);
1843             }
1844             else {
1845               $dates = CRM_Member_BAO_MembershipType::getDatesForMembershipType($membership->membership_type_id, $joinDate, NULL, NULL, $numterms);
1846             }
1847
1848             //get the status for membership.
1849             $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($dates['start_date'],
1850               $dates['end_date'],
1851               $dates['join_date'],
1852               'today',
1853               TRUE,
1854               $membership->membership_type_id,
1855               (array) $membership
1856             );
1857
1858             $formattedParams = array(
1859               'status_id' => CRM_Utils_Array::value('id', $calcStatus,
1860                 array_search('Current', $membershipStatuses)
1861               ),
1862               'join_date' => CRM_Utils_Date::customFormat($dates['join_date'], $format),
1863               'start_date' => CRM_Utils_Date::customFormat($dates['start_date'], $format),
1864               'end_date' => CRM_Utils_Date::customFormat($dates['end_date'], $format),
1865             );
1866
1867             CRM_Utils_Hook::pre('edit', 'Membership', $membership->id, $formattedParams);
1868
1869             $membership->copyValues($formattedParams);
1870             $membership->save();
1871
1872             //updating the membership log
1873             $membershipLog = array();
1874             $membershipLog = $formattedParams;
1875             $logStartDate = CRM_Utils_Date::customFormat(CRM_Utils_Array::value('log_start_date', $dates), $format);
1876             $logStartDate = ($logStartDate) ? CRM_Utils_Date::isoToMysql($logStartDate) : $formattedParams['start_date'];
1877
1878             $membershipLog['start_date'] = $logStartDate;
1879             $membershipLog['membership_id'] = $membership->id;
1880             $membershipLog['modified_id'] = $membership->contact_id;
1881             $membershipLog['modified_date'] = date('Ymd');
1882             $membershipLog['membership_type_id'] = $membership->membership_type_id;
1883
1884             CRM_Member_BAO_MembershipLog::add($membershipLog, CRM_Core_DAO::$_nullArray);
1885
1886             //update related Memberships.
1887             CRM_Member_BAO_Membership::updateRelatedMemberships($membership->id, $formattedParams);
1888
1889             $updateResult['membership_end_date'] = CRM_Utils_Date::customFormat($dates['end_date'],
1890               '%B %E%f, %Y'
1891             );
1892             $updateResult['updatedComponents']['CiviMember'] = $membership->status_id;
1893             if ($processContributionObject) {
1894               $processContribution = TRUE;
1895             }
1896
1897             CRM_Utils_Hook::post('edit', 'Membership', $membership->id, $membership);
1898           }
1899         }
1900       }
1901
1902       if ($participant) {
1903         $updatedStatusId = array_search('Registered', $participantStatuses);
1904         CRM_Event_BAO_Participant::updateParticipantStatus($participant->id, $oldStatus, $updatedStatusId, TRUE);
1905
1906         $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1907         if ($processContributionObject) {
1908           $processContribution = TRUE;
1909         }
1910       }
1911
1912       if ($pledgePayment) {
1913         CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1914
1915         $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1916         if ($processContributionObject) {
1917           $processContribution = TRUE;
1918         }
1919       }
1920     }
1921
1922     // process contribution object.
1923     if ($processContribution) {
1924       $contributionParams = array();
1925       $fields = array(
1926         'contact_id',
1927         'total_amount',
1928         'receive_date',
1929         'is_test',
1930         'campaign_id',
1931         'payment_instrument_id',
1932         'trxn_id',
1933         'invoice_id',
1934         'financial_type_id',
1935         'contribution_status_id',
1936         'non_deductible_amount',
1937         'receipt_date',
1938         'check_number',
1939       );
1940       foreach ($fields as $field) {
1941         if (empty($params[$field])) {
1942           continue;
1943         }
1944         $contributionParams[$field] = $params[$field];
1945       }
1946
1947       $ids = array('contribution' => $contributionId);
1948       $contribution = CRM_Contribute_BAO_Contribution::create($contributionParams, $ids);
1949     }
1950
1951     return $updateResult;
1952   }
1953
1954   /**
1955    * Returns all contribution related object ids.
1956    *
1957    * @param $contributionId
1958    *
1959    * @return array
1960    */
1961   public static function getComponentDetails($contributionId) {
1962     $componentDetails = $pledgePayment = array();
1963     if (!$contributionId) {
1964       return $componentDetails;
1965     }
1966
1967     $query = "
1968       SELECT    c.id                 as contribution_id,
1969                 c.contact_id         as contact_id,
1970                 c.contribution_recur_id,
1971                 mp.membership_id     as membership_id,
1972                 m.membership_type_id as membership_type_id,
1973                 pp.participant_id    as participant_id,
1974                 p.event_id           as event_id,
1975                 pgp.id               as pledge_payment_id
1976       FROM      civicrm_contribution c
1977       LEFT JOIN civicrm_membership_payment  mp   ON mp.contribution_id = c.id
1978       LEFT JOIN civicrm_participant_payment pp   ON pp.contribution_id = c.id
1979       LEFT JOIN civicrm_participant         p    ON pp.participant_id  = p.id
1980       LEFT JOIN civicrm_membership          m    ON m.id  = mp.membership_id
1981       LEFT JOIN civicrm_pledge_payment      pgp  ON pgp.contribution_id  = c.id
1982       WHERE     c.id = $contributionId";
1983
1984     $dao = CRM_Core_DAO::executeQuery($query);
1985     $componentDetails = array();
1986
1987     while ($dao->fetch()) {
1988       $componentDetails['component'] = $dao->participant_id ? 'event' : 'contribute';
1989       $componentDetails['contact_id'] = $dao->contact_id;
1990       if ($dao->event_id) {
1991         $componentDetails['event'] = $dao->event_id;
1992       }
1993       if ($dao->participant_id) {
1994         $componentDetails['participant'] = $dao->participant_id;
1995       }
1996       if ($dao->membership_id) {
1997         if (!isset($componentDetails['membership'])) {
1998           $componentDetails['membership'] = $componentDetails['membership_type'] = array();
1999         }
2000         $componentDetails['membership'][] = $dao->membership_id;
2001         $componentDetails['membership_type'][] = $dao->membership_type_id;
2002       }
2003       if ($dao->pledge_payment_id) {
2004         $pledgePayment[] = $dao->pledge_payment_id;
2005       }
2006       if ($dao->contribution_recur_id) {
2007         $componentDetails['contributionRecur'] = $dao->contribution_recur_id;
2008       }
2009     }
2010
2011     if ($pledgePayment) {
2012       $componentDetails['pledge_payment'] = $pledgePayment;
2013     }
2014
2015     return $componentDetails;
2016   }
2017
2018   /**
2019    * @param int $contactId
2020    * @param bool $includeSoftCredit
2021    *
2022    * @return null|string
2023    */
2024   public static function contributionCount($contactId, $includeSoftCredit = TRUE) {
2025     if (!$contactId) {
2026       return 0;
2027     }
2028     CRM_Financial_BAO_FinancialType::getAvailableFinancialTypes($financialTypes);
2029     $additionalWhere = " AND contribution.financial_type_id IN (0)";
2030     $liWhere = " AND i.financial_type_id IN (0)";
2031     if (!empty($financialTypes)) {
2032       $additionalWhere = " AND contribution.financial_type_id IN (" . implode(',', array_keys($financialTypes)) . ")";
2033       $liWhere = " AND i.financial_type_id NOT IN (" . implode(',', array_keys($financialTypes)) . ")";
2034     }
2035     $contactContributionsSQL = "
2036       SELECT contribution.id AS id
2037       FROM civicrm_contribution contribution
2038       LEFT JOIN civicrm_line_item i ON i.contribution_id = contribution.id AND i.entity_table = 'civicrm_contribution' $liWhere
2039       WHERE contribution.is_test = 0 AND contribution.contact_id = {$contactId}
2040       $additionalWhere
2041       AND i.id IS NULL";
2042
2043     $contactSoftCreditContributionsSQL = "
2044       SELECT contribution.id
2045       FROM civicrm_contribution contribution INNER JOIN civicrm_contribution_soft softContribution
2046       ON ( contribution.id = softContribution.contribution_id )
2047       WHERE contribution.is_test = 0 AND softContribution.contact_id = {$contactId} ";
2048     $query = "SELECT count( x.id ) count FROM ( ";
2049     $query .= $contactContributionsSQL;
2050
2051     if ($includeSoftCredit) {
2052       $query .= " UNION ";
2053       $query .= $contactSoftCreditContributionsSQL;
2054     }
2055
2056     $query .= ") x";
2057
2058     return CRM_Core_DAO::singleValueQuery($query);
2059   }
2060
2061   /**
2062    * Repeat a transaction as part of a recurring series.
2063    *
2064    * Only call this via the api as it is being refactored. The intention is that the repeatTransaction function
2065    * (possibly living on the ContributionRecur BAO) would be called first to create a pending contribution with a
2066    * subsequent call to the contribution.completetransaction api.
2067    *
2068    * The completeTransaction functionality has historically been overloaded to both complete and repeat payments.
2069    *
2070    * @param CRM_Contribute_BAO_Contribution $contribution
2071    * @param array $input
2072    * @param array $contributionParams
2073    *
2074    * @return array
2075    */
2076   protected static function repeatTransaction(&$contribution, &$input, $contributionParams) {
2077     if (!empty($contribution->id)) {
2078       return FALSE;
2079     }
2080     if (empty($contribution->id)) {
2081       // Unclear why this would only be set for repeats.
2082       if (!empty($input['amount'])) {
2083         $contribution->total_amount = $contributionParams['total_amount'] = $input['amount'];
2084       }
2085       $templateContribution = CRM_Contribute_BAO_ContributionRecur::getTemplateContribution($contributionParams['contribution_recur_id']);
2086       if (!empty($contributionParams['contribution_recur_id'])) {
2087         $recurringContribution = civicrm_api3('ContributionRecur', 'getsingle', array(
2088           'id' => $contributionParams['contribution_recur_id'],
2089         ));
2090         if (!empty($recurringContribution['campaign_id'])) {
2091           // CRM-17718 the campaign id on the contribution recur record should get precedence.
2092           $contributionParams['campaign_id'] = $recurringContribution['campaign_id'];
2093         }
2094         if (!empty($recurringContribution['financial_type_id'])) {
2095           // CRM-17718 the campaign id on the contribution recur record should get precedence.
2096           $contributionParams['financial_type_id'] = $recurringContribution['financial_type_id'];
2097         }
2098       }
2099       $contributionParams['skipLineItem'] = TRUE;
2100       $contributionParams['status_id'] = 'Pending';
2101       if (isset($contributionParams['financial_type_id'])) {
2102         // Give precedence to passed in type.
2103         $contribution->financial_type_id = $contributionParams['financial_type_id'];
2104       }
2105       else {
2106         $contributionParams['financial_type_id'] = $templateContribution['financial_type_id'];
2107       }
2108       $contributionParams['contact_id'] = $templateContribution['contact_id'];
2109       $contributionParams['source'] = empty($templateContribution['source']) ? ts('Recurring contribution') : $templateContribution['source'];
2110       $createContribution = civicrm_api3('Contribution', 'create', $contributionParams);
2111       $contribution->id = $createContribution['id'];
2112       $input['line_item'] = CRM_Contribute_BAO_ContributionRecur::addRecurLineItems($contribution->contribution_recur_id, $contribution);
2113       CRM_Contribute_BAO_ContributionRecur::copyCustomValues($contributionParams['contribution_recur_id'], $contribution->id);
2114       return TRUE;
2115     }
2116   }
2117
2118   /**
2119    * Get individual id for onbehalf contribution.
2120    *
2121    * @param int $contributionId
2122    *   Contribution id.
2123    * @param int $contributorId
2124    *   Contributor id.
2125    *
2126    * @return array
2127    *   containing organization id and individual id
2128    */
2129   public static function getOnbehalfIds($contributionId, $contributorId = NULL) {
2130
2131     $ids = array();
2132
2133     if (!$contributionId) {
2134       return $ids;
2135     }
2136
2137     // fetch contributor id if null
2138     if (!$contributorId) {
2139       $contributorId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
2140         $contributionId, 'contact_id'
2141       );
2142     }
2143
2144     $activityTypeIds = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
2145     $activityTypeId = array_search('Contribution', $activityTypeIds);
2146
2147     if ($activityTypeId && $contributorId) {
2148       $activityQuery = "
2149 SELECT     civicrm_activity_contact.contact_id
2150   FROM     civicrm_activity_contact
2151 INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_activity.id
2152  WHERE     civicrm_activity.activity_type_id   = %1
2153    AND     civicrm_activity.source_record_id   = %2
2154    AND     civicrm_activity_contact.record_type_id = %3
2155 ";
2156
2157       $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
2158       $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
2159
2160       $params = array(
2161         1 => array($activityTypeId, 'Integer'),
2162         2 => array($contributionId, 'Integer'),
2163         3 => array($sourceID, 'Integer'),
2164       );
2165
2166       $sourceContactId = CRM_Core_DAO::singleValueQuery($activityQuery, $params);
2167
2168       // for on behalf contribution source is individual and contributor is organization
2169       if ($sourceContactId && $sourceContactId != $contributorId) {
2170         $relationshipTypeIds = CRM_Core_PseudoConstant::relationshipType('name');
2171         // get rel type id for employee of relation
2172         foreach ($relationshipTypeIds as $id => $typeVals) {
2173           if ($typeVals['name_a_b'] == 'Employee of') {
2174             $relationshipTypeId = $id;
2175             break;
2176           }
2177         }
2178
2179         $rel = new CRM_Contact_DAO_Relationship();
2180         $rel->relationship_type_id = $relationshipTypeId;
2181         $rel->contact_id_a = $sourceContactId;
2182         $rel->contact_id_b = $contributorId;
2183         if ($rel->find(TRUE)) {
2184           $ids['individual_id'] = $rel->contact_id_a;
2185           $ids['organization_id'] = $rel->contact_id_b;
2186         }
2187       }
2188     }
2189
2190     return $ids;
2191   }
2192
2193   /**
2194    * @return array
2195    */
2196   public static function getContributionDates() {
2197     $config = CRM_Core_Config::singleton();
2198     $currentMonth = date('m');
2199     $currentDay = date('d');
2200     if ((int ) $config->fiscalYearStart['M'] > $currentMonth ||
2201       ((int ) $config->fiscalYearStart['M'] == $currentMonth &&
2202         (int ) $config->fiscalYearStart['d'] > $currentDay
2203       )
2204     ) {
2205       $year = date('Y') - 1;
2206     }
2207     else {
2208       $year = date('Y');
2209     }
2210     $year = array('Y' => $year);
2211     $yearDate = $config->fiscalYearStart;
2212     $yearDate = array_merge($year, $yearDate);
2213     $yearDate = CRM_Utils_Date::format($yearDate);
2214
2215     $monthDate = date('Ym') . '01';
2216
2217     $now = date('Ymd');
2218
2219     return array(
2220       'now' => $now,
2221       'yearDate' => $yearDate,
2222       'monthDate' => $monthDate,
2223     );
2224   }
2225
2226   /**
2227    * Load objects relations to contribution object.
2228    * Objects are stored in the $_relatedObjects property
2229    * In the first instance we are just moving functionality from BASEIpn -
2230    * @see http://issues.civicrm.org/jira/browse/CRM-9996
2231    *
2232    * Note that the unit test for the BaseIPN class tests this function
2233    *
2234    * @param array $input
2235    *   Input as delivered from Payment Processor.
2236    * @param array $ids
2237    *   Ids as Loaded by Payment Processor.
2238    * @param bool $loadAll
2239    *   Load all related objects - even where id not passed in? (allows API to call this).
2240    *
2241    * @return bool
2242    * @throws Exception
2243    */
2244   public function loadRelatedObjects(&$input, &$ids, $loadAll = FALSE) {
2245     if ($loadAll) {
2246       $ids = array_merge($this->getComponentDetails($this->id), $ids);
2247       if (empty($ids['contact']) && isset($this->contact_id)) {
2248         $ids['contact'] = $this->contact_id;
2249       }
2250     }
2251     if (empty($this->_component)) {
2252       if (!empty($ids['event'])) {
2253         $this->_component = 'event';
2254       }
2255       else {
2256         $this->_component = strtolower(CRM_Utils_Array::value('component', $input, 'contribute'));
2257       }
2258     }
2259
2260     // If the object is not fully populated then make sure it is - this is a more about legacy paths & cautious
2261     // refactoring than anything else, and has unit test coverage.
2262     if (empty($this->financial_type_id)) {
2263       $this->find(TRUE);
2264     }
2265
2266     $paymentProcessorID = CRM_Utils_Array::value('payment_processor_id', $input, CRM_Utils_Array::value(
2267       'paymentProcessor',
2268       $ids
2269     ));
2270
2271     if (!$paymentProcessorID && $this->contribution_page_id) {
2272       $paymentProcessorID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage',
2273         $this->contribution_page_id,
2274         'payment_processor'
2275       );
2276       if ($paymentProcessorID) {
2277         $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromContributionPage;
2278       }
2279     }
2280
2281     $ids['contributionType'] = $this->financial_type_id;
2282     $ids['financialType'] = $this->financial_type_id;
2283
2284     $entities = array(
2285       'contact' => 'CRM_Contact_BAO_Contact',
2286       'contributionRecur' => 'CRM_Contribute_BAO_ContributionRecur',
2287       'contributionType' => 'CRM_Financial_BAO_FinancialType',
2288       'financialType' => 'CRM_Financial_BAO_FinancialType',
2289     );
2290     foreach ($entities as $entity => $bao) {
2291       if (!empty($ids[$entity])) {
2292         $this->_relatedObjects[$entity] = new $bao();
2293         $this->_relatedObjects[$entity]->id = $ids[$entity];
2294         if (!$this->_relatedObjects[$entity]->find(TRUE)) {
2295           throw new CRM_Core_Exception($entity . ' could not be loaded');
2296         }
2297       }
2298     }
2299
2300     if (!empty($ids['contributionRecur']) && !$paymentProcessorID) {
2301       $paymentProcessorID = $this->_relatedObjects['contributionRecur']->payment_processor_id;
2302     }
2303
2304     if (!empty($ids['pledge_payment'])) {
2305       foreach ($ids['pledge_payment'] as $key => $paymentID) {
2306         if (empty($paymentID)) {
2307           continue;
2308         }
2309         $payment = new CRM_Pledge_BAO_PledgePayment();
2310         $payment->id = $paymentID;
2311         if (!$payment->find(TRUE)) {
2312           throw new Exception("Could not find pledge payment record: " . $paymentID);
2313         }
2314         $this->_relatedObjects['pledge_payment'][] = $payment;
2315       }
2316     }
2317
2318     $this->loadRelatedMembershipObjects($ids);
2319
2320     if ($this->_component != 'contribute') {
2321       // we are in event mode
2322       // make sure event exists and is valid
2323       $event = new CRM_Event_BAO_Event();
2324       $event->id = $ids['event'];
2325       if ($ids['event'] &&
2326         !$event->find(TRUE)
2327       ) {
2328         throw new Exception("Could not find event: " . $ids['event']);
2329       }
2330
2331       $this->_relatedObjects['event'] = &$event;
2332
2333       $participant = new CRM_Event_BAO_Participant();
2334       $participant->id = $ids['participant'];
2335       if ($ids['participant'] &&
2336         !$participant->find(TRUE)
2337       ) {
2338         throw new Exception("Could not find participant: " . $ids['participant']);
2339       }
2340       $participant->register_date = CRM_Utils_Date::isoToMysql($participant->register_date);
2341
2342       $this->_relatedObjects['participant'] = &$participant;
2343
2344       // get the payment processor id from event - this is inaccurate see CRM-16923
2345       // in future we should look at throwing an exception here rather than an dubious guess.
2346       if (!$paymentProcessorID) {
2347         $paymentProcessorID = $this->_relatedObjects['event']->payment_processor;
2348         if ($paymentProcessorID) {
2349           $intentionalEnotice = $CRM16923AnUnreliableMethodHasBeenUserToDeterminePaymentProcessorFromEvent;
2350         }
2351       }
2352     }
2353
2354     if ($paymentProcessorID) {
2355       $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($paymentProcessorID,
2356         $this->is_test ? 'test' : 'live'
2357       );
2358       $ids['paymentProcessor'] = $paymentProcessorID;
2359       $this->_relatedObjects['paymentProcessor'] = $paymentProcessor;
2360     }
2361     return TRUE;
2362   }
2363
2364   /**
2365    * Create array of message information - ie. return html version, txt version, to field
2366    *
2367    * @param array $input
2368    *   Incoming information.
2369    *   - is_recur - should this be treated as recurring (not sure why you wouldn't
2370    *    just check presence of recur object but maintaining legacy approach
2371    *    to be careful)
2372    * @param array $ids
2373    *   IDs of related objects.
2374    * @param array $values
2375    *   Any values that may have already been compiled by calling process.
2376    *   This is augmented by values 'gathered' by gatherMessageValues
2377    * @param bool $recur
2378    * @param bool $returnMessageText
2379    *   Distinguishes between whether to send message or return.
2380    *   message text. We are working towards this function ALWAYS returning message text & calling
2381    *   function doing emails / pdfs with it
2382    *
2383    * @return array
2384    *   messages
2385    * @throws Exception
2386    */
2387   public function composeMessageArray(&$input, &$ids, &$values, $recur = FALSE, $returnMessageText = TRUE) {
2388     $this->loadRelatedObjects($input, $ids);
2389
2390     if (empty($this->_component)) {
2391       $this->_component = CRM_Utils_Array::value('component', $input);
2392     }
2393
2394     //not really sure what params might be passed in but lets merge em into values
2395     $values = array_merge($this->_gatherMessageValues($input, $values, $ids), $values);
2396     if (!empty($input['receipt_date'])) {
2397       $values['receipt_date'] = $input['receipt_date'];
2398     }
2399
2400     $template = CRM_Core_Smarty::singleton();
2401     $this->_assignMessageVariablesToTemplate($values, $input, $template, $recur, $returnMessageText);
2402     //what does recur 'mean here - to do with payment processor return functionality but
2403     // what is the importance
2404     if ($recur && !empty($this->_relatedObjects['paymentProcessor'])) {
2405       $paymentObject = Civi\Payment\System::singleton()->getByProcessor($this->_relatedObjects['paymentProcessor']);
2406
2407       $entityID = $entity = NULL;
2408       if (isset($ids['contribution'])) {
2409         $entity = 'contribution';
2410         $entityID = $ids['contribution'];
2411       }
2412       if (!empty($ids['membership'])) {
2413         //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
2414         // 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
2415         // line having loaded an array
2416         $ids['membership'] = (array) $ids['membership'];
2417         $entity = 'membership';
2418         $entityID = $ids['membership'][0];
2419       }
2420
2421       $template->assign('cancelSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'cancel'));
2422       $template->assign('updateSubscriptionBillingUrl', $paymentObject->subscriptionURL($entityID, $entity, 'billing'));
2423       $template->assign('updateSubscriptionUrl', $paymentObject->subscriptionURL($entityID, $entity, 'update'));
2424
2425       if ($this->_relatedObjects['paymentProcessor']['billing_mode'] & CRM_Core_Payment::BILLING_MODE_FORM) {
2426         //direct mode showing billing block, so use directIPN for temporary
2427         $template->assign('contributeMode', 'directIPN');
2428       }
2429     }
2430     // todo remove strtolower - check consistency
2431     if (strtolower($this->_component) == 'event') {
2432       $eventParams = array('id' => $this->_relatedObjects['participant']->event_id);
2433       $values['event'] = array();
2434
2435       CRM_Event_BAO_Event::retrieve($eventParams, $values['event']);
2436
2437       //get location details
2438       $locationParams = array('entity_id' => $this->_relatedObjects['participant']->event_id, 'entity_table' => 'civicrm_event');
2439       $values['location'] = CRM_Core_BAO_Location::getValues($locationParams);
2440
2441       $ufJoinParams = array(
2442         'entity_table' => 'civicrm_event',
2443         'entity_id' => $ids['event'],
2444         'module' => 'CiviEvent',
2445       );
2446
2447       list($custom_pre_id,
2448         $custom_post_ids
2449         ) = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
2450
2451       $values['custom_pre_id'] = $custom_pre_id;
2452       $values['custom_post_id'] = $custom_post_ids;
2453       //for tasks 'Change Participant Status' and 'Update multiple Contributions' case
2454       //and cases involving status updation through ipn
2455       // whatever that means!
2456       // total_amount appears to be the preferred input param & it is unclear why we support amount here
2457       // perhaps we should throw an e-notice if amount is set & force total_amount?
2458       if (!empty($input['amount'])) {
2459         $values['totalAmount'] = $input['amount'];
2460       }
2461
2462       if ($values['event']['is_email_confirm']) {
2463         $values['is_email_receipt'] = 1;
2464       }
2465
2466       if (!empty($ids['contribution'])) {
2467         $values['contributionId'] = $ids['contribution'];
2468       }
2469
2470       return CRM_Event_BAO_Event::sendMail($ids['contact'], $values,
2471         $this->_relatedObjects['participant']->id, $this->is_test, $returnMessageText
2472       );
2473     }
2474     else {
2475       $values['contribution_id'] = $this->id;
2476       if (!empty($ids['related_contact'])) {
2477         $values['related_contact'] = $ids['related_contact'];
2478         if (isset($ids['onbehalf_dupe_alert'])) {
2479           $values['onbehalf_dupe_alert'] = $ids['onbehalf_dupe_alert'];
2480         }
2481         $entityBlock = array(
2482           'contact_id' => $ids['contact'],
2483           'location_type_id' => CRM_Core_DAO::getFieldValue('CRM_Core_DAO_LocationType',
2484             'Home', 'id', 'name'
2485           ),
2486         );
2487         $address = CRM_Core_BAO_Address::getValues($entityBlock);
2488         $template->assign('onBehalfAddress', $address[$entityBlock['location_type_id']]['display']);
2489       }
2490       $isTest = FALSE;
2491       if ($this->is_test) {
2492         $isTest = TRUE;
2493       }
2494       if (!empty($this->_relatedObjects['membership'])) {
2495         foreach ($this->_relatedObjects['membership'] as $membership) {
2496           if ($membership->id) {
2497             $values['isMembership'] = TRUE;
2498             $values['membership_assign'] = TRUE;
2499
2500             // need to set the membership values here
2501             $template->assign('membership_name',
2502               CRM_Member_PseudoConstant::membershipType($membership->membership_type_id)
2503             );
2504             $template->assign('mem_start_date', $membership->start_date);
2505             $template->assign('mem_join_date', $membership->join_date);
2506             $template->assign('mem_end_date', $membership->end_date);
2507             $membership_status = CRM_Member_PseudoConstant::membershipStatus($membership->status_id, NULL, 'label');
2508             $template->assign('mem_status', $membership_status);
2509             if ($membership_status == 'Pending' && $membership->is_pay_later == 1) {
2510               $values['is_pay_later'] = 1;
2511             }
2512
2513             // if separate payment there are two contributions recorded and the
2514             // admin will need to send a receipt for each of them separately.
2515             // we dont link the two in the db (but can potentially infer it if needed)
2516             $template->assign('is_separate_payment', 0);
2517
2518             if ($recur && $paymentObject) {
2519               $url = $paymentObject->subscriptionURL($membership->id, 'membership', 'cancel');
2520               $template->assign('cancelSubscriptionUrl', $url);
2521               $url = $paymentObject->subscriptionURL($membership->id, 'membership', 'billing');
2522               $template->assign('updateSubscriptionBillingUrl', $url);
2523               $url = $paymentObject->subscriptionURL($entityID, $entity, 'update');
2524               $template->assign('updateSubscriptionUrl', $url);
2525             }
2526
2527             $result = CRM_Contribute_BAO_ContributionPage::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
2528
2529             return $result;
2530             // otherwise if its about sending emails, continue sending without return, as we
2531             // don't want to exit the loop.
2532           }
2533         }
2534       }
2535       else {
2536         return CRM_Contribute_BAO_ContributionPage::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
2537       }
2538     }
2539   }
2540
2541   /**
2542    * Gather values for contribution mail - this function has been created
2543    * as part of CRM-9996 refactoring as a step towards simplifying the composeMessage function
2544    * Values related to the contribution in question are gathered
2545    *
2546    * @param array $input
2547    *   Input into function (probably from payment processor).
2548    * @param array $values
2549    * @param array $ids
2550    *   The set of ids related to the input.
2551    *
2552    * @return array
2553    */
2554   public function _gatherMessageValues($input, &$values, $ids = array()) {
2555     // set display address of contributor
2556     if ($this->address_id) {
2557       $addressParams = array('id' => $this->address_id);
2558       $addressDetails = CRM_Core_BAO_Address::getValues($addressParams, FALSE, 'id');
2559       $addressDetails = array_values($addressDetails);
2560     }
2561     // Else we assign the billing address of the contribution contact.
2562     else {
2563       $addressParams = array('contact_id' => $this->contact_id, 'is_billing' => 1);
2564       $addressDetails = (array) CRM_Core_BAO_Address::getValues($addressParams);
2565       $addressDetails = array_values($addressDetails);
2566     }
2567
2568     if (!empty($addressDetails[0]['display'])) {
2569       $values['address'] = $addressDetails[0]['display'];
2570     }
2571
2572     if ($this->_component == 'contribute') {
2573       //get soft contributions
2574       $softContributions = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($this->id, TRUE);
2575       if (!empty($softContributions)) {
2576         $values['softContributions'] = $softContributions['soft_credit'];
2577       }
2578       if (isset($this->contribution_page_id)) {
2579         CRM_Contribute_BAO_ContributionPage::setValues(
2580           $this->contribution_page_id,
2581           $values
2582         );
2583         if ($this->contribution_page_id) {
2584           // CRM-8254 - override default currency if applicable
2585           $config = CRM_Core_Config::singleton();
2586           $config->defaultCurrency = CRM_Utils_Array::value(
2587             'currency',
2588             $values,
2589             $config->defaultCurrency
2590           );
2591         }
2592       }
2593       // no contribution page -probably back office
2594       else {
2595         // Handle re-print receipt for offline contributions (call from PDF.php - no contribution_page_id)
2596         $values['is_email_receipt'] = 1;
2597         $values['title'] = 'Contribution';
2598       }
2599       // set lineItem for contribution
2600       if ($this->id) {
2601         $lineItem = CRM_Price_BAO_LineItem::getLineItems($this->id, 'contribution', 1);
2602         if (!empty($lineItem)) {
2603           $itemId = key($lineItem);
2604           foreach ($lineItem as &$eachItem) {
2605             if (isset($this->_relatedObjects['membership'])
2606              && is_array($this->_relatedObjects['membership'])
2607              && array_key_exists($eachItem['membership_type_id'], $this->_relatedObjects['membership'])) {
2608               $eachItem['join_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->join_date);
2609               $eachItem['start_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->start_date);
2610               $eachItem['end_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->end_date);
2611             }
2612           }
2613           $values['lineItem'][0] = $lineItem;
2614           $values['priceSetID'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $lineItem[$itemId]['price_field_id'], 'price_set_id');
2615         }
2616       }
2617
2618       $relatedContact = CRM_Contribute_BAO_Contribution::getOnbehalfIds(
2619         $this->id,
2620         $this->contact_id
2621       );
2622       // if this is onbehalf of contribution then set related contact
2623       if (!empty($relatedContact['individual_id'])) {
2624         $values['related_contact'] = $ids['related_contact'] = $relatedContact['individual_id'];
2625       }
2626     }
2627     else {
2628       // event
2629       $eventParams = array(
2630         'id' => $this->_relatedObjects['event']->id,
2631       );
2632       $values['event'] = array();
2633
2634       CRM_Event_BAO_Event::retrieve($eventParams, $values['event']);
2635       // add custom fields for event
2636       $eventGroupTree = CRM_Core_BAO_CustomGroup::getTree('Event', $this->_relatedObjects['event'], $this->_relatedObjects['event']->id);
2637
2638       $eventCustomGroup = array();
2639       foreach ($eventGroupTree as $key => $group) {
2640         if ($key === 'info') {
2641           continue;
2642         }
2643
2644         foreach ($group['fields'] as $k => $customField) {
2645           $groupLabel = $group['title'];
2646           if (!empty($customField['customValue'])) {
2647             foreach ($customField['customValue'] as $customFieldValues) {
2648               $eventCustomGroup[$groupLabel][$customField['label']] = CRM_Utils_Array::value('data', $customFieldValues);
2649             }
2650           }
2651         }
2652       }
2653       $values['event']['customGroup'] = $eventCustomGroup;
2654
2655       //get participant details
2656       $participantParams = array(
2657         'id' => $this->_relatedObjects['participant']->id,
2658       );
2659
2660       $values['participant'] = array();
2661
2662       CRM_Event_BAO_Participant::getValues($participantParams, $values['participant'], $participantIds);
2663       // add custom fields for event
2664       $participantGroupTree = CRM_Core_BAO_CustomGroup::getTree('Participant', $this->_relatedObjects['participant'], $this->_relatedObjects['participant']->id);
2665       $participantCustomGroup = array();
2666       foreach ($participantGroupTree as $key => $group) {
2667         if ($key === 'info') {
2668           continue;
2669         }
2670
2671         foreach ($group['fields'] as $k => $customField) {
2672           $groupLabel = $group['title'];
2673           if (!empty($customField['customValue'])) {
2674             foreach ($customField['customValue'] as $customFieldValues) {
2675               $participantCustomGroup[$groupLabel][$customField['label']] = CRM_Utils_Array::value('data', $customFieldValues);
2676             }
2677           }
2678         }
2679       }
2680       $values['participant']['customGroup'] = $participantCustomGroup;
2681
2682       //get location details
2683       $locationParams = array(
2684         'entity_id' => $this->_relatedObjects['event']->id,
2685         'entity_table' => 'civicrm_event',
2686       );
2687       $values['location'] = CRM_Core_BAO_Location::getValues($locationParams);
2688
2689       $ufJoinParams = array(
2690         'entity_table' => 'civicrm_event',
2691         'entity_id' => $ids['event'],
2692         'module' => 'CiviEvent',
2693       );
2694
2695       list($custom_pre_id,
2696         $custom_post_ids
2697         ) = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
2698
2699       $values['custom_pre_id'] = $custom_pre_id;
2700       $values['custom_post_id'] = $custom_post_ids;
2701
2702       // set lineItem for event contribution
2703       if ($this->id) {
2704         $participantIds = CRM_Event_BAO_Participant::getParticipantIds($this->id);
2705         if (!empty($participantIds)) {
2706           foreach ($participantIds as $pIDs) {
2707             $lineItem = CRM_Price_BAO_LineItem::getLineItems($pIDs);
2708             if (!CRM_Utils_System::isNull($lineItem)) {
2709               $values['lineItem'][] = $lineItem;
2710             }
2711           }
2712         }
2713       }
2714     }
2715
2716     $groupTree = CRM_Core_BAO_CustomGroup::getTree('Contribution', $this, $this->id);
2717
2718     $customGroup = array();
2719     foreach ($groupTree as $key => $group) {
2720       if ($key === 'info') {
2721         continue;
2722       }
2723
2724       foreach ($group['fields'] as $k => $customField) {
2725         $groupLabel = $group['title'];
2726         if (!empty($customField['customValue'])) {
2727           foreach ($customField['customValue'] as $customFieldValues) {
2728             $customGroup[$groupLabel][$customField['label']] = CRM_Utils_Array::value('data', $customFieldValues);
2729           }
2730         }
2731       }
2732     }
2733     $values['customGroup'] = $customGroup;
2734
2735     return $values;
2736   }
2737
2738   /**
2739    * Assign message variables to template but try to break the habit.
2740    *
2741    * In order to get away from leaky variables it is better to ensure variables are set in values and assign them
2742    * from the send function. Otherwise smarty variables can leak if this is called more than once - e.g. processing
2743    * multiple recurring payments for processors like IATS that use tokens.
2744    *
2745    * Apply variables for message to smarty template - this function is part of analysing what is in the huge
2746    * function & breaking it down into manageable chunks. Eventually it will be refactored into something else
2747    * Note we send directly from this function in some cases because it is only partly refactored.
2748    *
2749    * Don't call this function directly as the signature will change.
2750    *
2751    * @param $values
2752    * @param $input
2753    * @param CRM_Core_SMARTY $template
2754    * @param bool $recur
2755    * @param bool $returnMessageText
2756    *
2757    * @return mixed
2758    */
2759   public function _assignMessageVariablesToTemplate(&$values, $input, &$template, $recur = FALSE, $returnMessageText = TRUE) {
2760     $template->assign('first_name', $this->_relatedObjects['contact']->first_name);
2761     $template->assign('last_name', $this->_relatedObjects['contact']->last_name);
2762     $template->assign('displayName', $this->_relatedObjects['contact']->display_name);
2763     if (!empty($values['lineItem']) && !empty($this->_relatedObjects['membership'])) {
2764       $values['useForMember'] = TRUE;
2765     }
2766     //assign honor information to receipt message
2767     $softRecord = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($this->id);
2768
2769     if (isset($softRecord['soft_credit'])) {
2770       //if id of contribution page is present
2771       if (!empty($values['id'])) {
2772         $values['honor'] = array(
2773           'honor_profile_values' => array(),
2774           'honor_profile_id' => CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'uf_group_id', 'entity_id'),
2775           'honor_id' => $softRecord['soft_credit'][1]['contact_id'],
2776         );
2777         $softCreditTypes = CRM_Core_OptionGroup::values('soft_credit_type');
2778
2779         $template->assign('soft_credit_type', $softRecord['soft_credit'][1]['soft_credit_type_label']);
2780         $template->assign('honor_block_is_active', CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'is_active', 'entity_id'));
2781       }
2782       else {
2783         //offline contribution
2784         $softCreditTypes = $softCredits = array();
2785         foreach ($softRecord['soft_credit'] as $key => $softCredit) {
2786           $softCreditTypes[$key] = $softCredit['soft_credit_type_label'];
2787           $softCredits[$key] = array(
2788             'Name' => $softCredit['contact_name'],
2789             'Amount' => CRM_Utils_Money::format($softCredit['amount'], $softCredit['currency']),
2790           );
2791         }
2792         $template->assign('softCreditTypes', $softCreditTypes);
2793         $template->assign('softCredits', $softCredits);
2794       }
2795     }
2796
2797     $dao = new CRM_Contribute_DAO_ContributionProduct();
2798     $dao->contribution_id = $this->id;
2799     if ($dao->find(TRUE)) {
2800       $premiumId = $dao->product_id;
2801       $template->assign('option', $dao->product_option);
2802
2803       $productDAO = new CRM_Contribute_DAO_Product();
2804       $productDAO->id = $premiumId;
2805       $productDAO->find(TRUE);
2806       $template->assign('selectPremium', TRUE);
2807       $template->assign('product_name', $productDAO->name);
2808       $template->assign('price', $productDAO->price);
2809       $template->assign('sku', $productDAO->sku);
2810     }
2811     $template->assign('title', CRM_Utils_Array::value('title', $values));
2812     $values['amount'] = CRM_Utils_Array::value('total_amount', $input, (CRM_Utils_Array::value('amount', $input)), NULL);
2813     if (!$values['amount'] && isset($this->total_amount)) {
2814       $values['amount'] = $this->total_amount;
2815     }
2816
2817     // add the new contribution values
2818     if (strtolower($this->_component) == 'contribute') {
2819       //PCP Info
2820       $softDAO = new CRM_Contribute_DAO_ContributionSoft();
2821       $softDAO->contribution_id = $this->id;
2822       if ($softDAO->find(TRUE)) {
2823         $template->assign('pcpBlock', TRUE);
2824         $template->assign('pcp_display_in_roll', $softDAO->pcp_display_in_roll);
2825         $template->assign('pcp_roll_nickname', $softDAO->pcp_roll_nickname);
2826         $template->assign('pcp_personal_note', $softDAO->pcp_personal_note);
2827
2828         //assign the pcp page title for email subject
2829         $pcpDAO = new CRM_PCP_DAO_PCP();
2830         $pcpDAO->id = $softDAO->pcp_id;
2831         if ($pcpDAO->find(TRUE)) {
2832           $template->assign('title', $pcpDAO->title);
2833         }
2834       }
2835     }
2836
2837     if ($this->financial_type_id) {
2838       $values['financial_type_id'] = $this->financial_type_id;
2839     }
2840
2841     $template->assign('trxn_id', $this->trxn_id);
2842     $template->assign('receive_date',
2843       CRM_Utils_Date::processDate($this->receive_date)
2844     );
2845     $values['receipt_date'] = (empty($this->receipt_date) ? NULL : $this->receipt_date);
2846     $template->assign('contributeMode', 'notify');
2847     $template->assign('action', $this->is_test ? 1024 : 1);
2848     $template->assign('receipt_text',
2849       CRM_Utils_Array::value('receipt_text',
2850         $values
2851       )
2852     );
2853     $template->assign('is_monetary', 1);
2854     $template->assign('is_recur', (bool) $recur);
2855     $template->assign('currency', $this->currency);
2856     $template->assign('address', CRM_Utils_Address::format($input));
2857     if (!empty($values['customGroup'])) {
2858       $template->assign('customGroup', $values['customGroup']);
2859     }
2860     if (!empty($values['softContributions'])) {
2861       $template->assign('softContributions', $values['softContributions']);
2862     }
2863     if ($this->_component == 'event') {
2864       $template->assign('title', $values['event']['title']);
2865       $participantRoles = CRM_Event_PseudoConstant::participantRole();
2866       $viewRoles = array();
2867       foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $this->_relatedObjects['participant']->role_id) as $k => $v) {
2868         $viewRoles[] = $participantRoles[$v];
2869       }
2870       $values['event']['participant_role'] = implode(', ', $viewRoles);
2871       $template->assign('event', $values['event']);
2872       $template->assign('participant', $values['participant']);
2873       $template->assign('location', $values['location']);
2874       $template->assign('customPre', $values['custom_pre_id']);
2875       $template->assign('customPost', $values['custom_post_id']);
2876
2877       $isTest = FALSE;
2878       if ($this->_relatedObjects['participant']->is_test) {
2879         $isTest = TRUE;
2880       }
2881
2882       $values['params'] = array();
2883       //to get email of primary participant.
2884       $primaryEmail = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Email', $this->_relatedObjects['participant']->contact_id, 'email', 'contact_id');
2885       $primaryAmount[] = array(
2886         'label' => $this->_relatedObjects['participant']->fee_level . ' - ' . $primaryEmail,
2887         'amount' => $this->_relatedObjects['participant']->fee_amount,
2888       );
2889       //build an array of cId/pId of participants
2890       $additionalIDs = CRM_Event_BAO_Event::buildCustomProfile($this->_relatedObjects['participant']->id, NULL, $this->_relatedObjects['contact']->id, $isTest, TRUE);
2891       unset($additionalIDs[$this->_relatedObjects['participant']->id]);
2892       //send receipt to additional participant if exists
2893       if (count($additionalIDs)) {
2894         $template->assign('isPrimary', 0);
2895         $template->assign('customProfile', NULL);
2896         //set additionalParticipant true
2897         $values['params']['additionalParticipant'] = TRUE;
2898         foreach ($additionalIDs as $pId => $cId) {
2899           $amount = array();
2900           //to change the status pending to completed
2901           $additional = new CRM_Event_DAO_Participant();
2902           $additional->id = $pId;
2903           $additional->contact_id = $cId;
2904           $additional->find(TRUE);
2905           $additional->register_date = $this->_relatedObjects['participant']->register_date;
2906           $additional->status_id = 1;
2907           $additionalParticipantInfo = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Email', $additional->contact_id, 'email', 'contact_id');
2908           //if additional participant dont have email
2909           //use display name.
2910           if (!$additionalParticipantInfo) {
2911             $additionalParticipantInfo = CRM_Contact_BAO_Contact::displayName($additional->contact_id);
2912           }
2913           $amount[0] = array('label' => $additional->fee_level, 'amount' => $additional->fee_amount);
2914           $primaryAmount[] = array(
2915             'label' => $additional->fee_level . ' - ' . $additionalParticipantInfo,
2916             'amount' => $additional->fee_amount,
2917           );
2918           $additional->save();
2919           $additional->free();
2920           $template->assign('amount', $amount);
2921           CRM_Event_BAO_Event::sendMail($cId, $values, $pId, $isTest, $returnMessageText);
2922         }
2923       }
2924
2925       //build an array of custom profile and assigning it to template
2926       $customProfile = CRM_Event_BAO_Event::buildCustomProfile($this->_relatedObjects['participant']->id, $values, NULL, $isTest);
2927
2928       if (count($customProfile)) {
2929         $template->assign('customProfile', $customProfile);
2930       }
2931
2932       // for primary contact
2933       $values['params']['additionalParticipant'] = FALSE;
2934       $template->assign('isPrimary', 1);
2935       $template->assign('amount', $primaryAmount);
2936       $template->assign('register_date', CRM_Utils_Date::isoToMysql($this->_relatedObjects['participant']->register_date));
2937       if ($this->payment_instrument_id) {
2938         $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
2939         $template->assign('paidBy', $paymentInstrument[$this->payment_instrument_id]);
2940       }
2941       // carry paylater, since we did not created billing,
2942       // so need to pull email from primary location, CRM-4395
2943       $values['params']['is_pay_later'] = $this->_relatedObjects['participant']->is_pay_later;
2944     }
2945     return $template;
2946   }
2947
2948   /**
2949    * Check whether payment processor supports
2950    * cancellation of contribution subscription
2951    *
2952    * @param int $contributionId
2953    *   Contribution id.
2954    *
2955    * @param bool $isNotCancelled
2956    *
2957    * @return bool
2958    */
2959   public static function isCancelSubscriptionSupported($contributionId, $isNotCancelled = TRUE) {
2960     $cacheKeyString = "$contributionId";
2961     $cacheKeyString .= $isNotCancelled ? '_1' : '_0';
2962
2963     static $supportsCancel = array();
2964
2965     if (!array_key_exists($cacheKeyString, $supportsCancel)) {
2966       $supportsCancel[$cacheKeyString] = FALSE;
2967       $isCancelled = FALSE;
2968
2969       if ($isNotCancelled) {
2970         $isCancelled = self::isSubscriptionCancelled($contributionId);
2971       }
2972
2973       $paymentObject = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($contributionId, 'contribute', 'obj');
2974       if (!empty($paymentObject)) {
2975         $supportsCancel[$cacheKeyString] = $paymentObject->supports('cancelRecurring') && !$isCancelled;
2976       }
2977     }
2978     return $supportsCancel[$cacheKeyString];
2979   }
2980
2981   /**
2982    * Check whether subscription is already cancelled.
2983    *
2984    * @param int $contributionId
2985    *   Contribution id.
2986    *
2987    * @return string
2988    *   contribution status
2989    */
2990   public static function isSubscriptionCancelled($contributionId) {
2991     $sql = "
2992        SELECT cr.contribution_status_id
2993          FROM civicrm_contribution_recur cr
2994     LEFT JOIN civicrm_contribution con ON ( cr.id = con.contribution_recur_id )
2995         WHERE con.id = %1 LIMIT 1";
2996     $params = array(1 => array($contributionId, 'Integer'));
2997     $statusId = CRM_Core_DAO::singleValueQuery($sql, $params);
2998     $status = CRM_Contribute_PseudoConstant::contributionStatus($statusId);
2999     if ($status == 'Cancelled') {
3000       return TRUE;
3001     }
3002     return FALSE;
3003   }
3004
3005   /**
3006    * Create all financial accounts entry.
3007    *
3008    * @param array $params
3009    *   Contribution object, line item array and params for trxn.
3010    *
3011    *
3012    * @param array $financialTrxnValues
3013    *
3014    * @return null|object
3015    */
3016   public static function recordFinancialAccounts(&$params, $financialTrxnValues = NULL) {
3017     $skipRecords = $update = $return = $isRelatedId = FALSE;
3018
3019     $additionalParticipantId = array();
3020     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
3021     $contributionStatus = empty($params['contribution_status_id']) ? NULL : $contributionStatuses[$params['contribution_status_id']];
3022
3023     if (CRM_Utils_Array::value('contribution_mode', $params) == 'participant') {
3024       $entityId = $params['participant_id'];
3025       $entityTable = 'civicrm_participant';
3026       $additionalParticipantId = CRM_Event_BAO_Participant::getAdditionalParticipantIds($entityId);
3027     }
3028     elseif (!empty($params['membership_id'])) {
3029       //so far $params['membership_id'] should only be set coming in from membershipBAO::create so the situation where multiple memberships
3030       // are created off one contribution should be handled elsewhere
3031       $entityId = $params['membership_id'];
3032       $entityTable = 'civicrm_membership';
3033     }
3034     else {
3035       $entityId = $params['contribution']->id;
3036       $entityTable = 'civicrm_contribution';
3037     }
3038
3039     if (CRM_Utils_Array::value('contribution_mode', $params) == 'membership') {
3040       $isRelatedId = TRUE;
3041     }
3042
3043     $entityID[] = $entityId;
3044     if (!empty($additionalParticipantId)) {
3045       $entityID += $additionalParticipantId;
3046     }
3047     // prevContribution appears to mean - original contribution object- ie copy of contribution from before the update started that is being updated
3048     if (empty($params['prevContribution'])) {
3049       $entityID = NULL;
3050     }
3051     else {
3052       $update = TRUE;
3053     }
3054
3055     $statusId = $params['contribution']->contribution_status_id;
3056     // CRM-13964 partial payment
3057     if ($contributionStatus == 'Partially paid'
3058       && !empty($params['partial_payment_total']) && !empty($params['partial_amount_pay'])
3059     ) {
3060       $partialAmtPay = $params['partial_amount_pay'];
3061       $partialAmtTotal = $params['partial_payment_total'];
3062
3063       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3064       $fromFinancialAccountId = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id'], $relationTypeId);
3065       $statusId = CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name');
3066       $params['total_amount'] = $partialAmtPay;
3067
3068       $balanceTrxnInfo = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($params['contribution']->id, $params['financial_type_id']);
3069       if (empty($balanceTrxnInfo['trxn_id'])) {
3070         // create new balance transaction record
3071         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3072         $toFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id'], $relationTypeId);
3073
3074         $balanceTrxnParams['total_amount'] = $partialAmtTotal;
3075         $balanceTrxnParams['to_financial_account_id'] = $toFinancialAccount;
3076         $balanceTrxnParams['contribution_id'] = $params['contribution']->id;
3077         $balanceTrxnParams['trxn_date'] = !empty($params['contribution']->receive_date) ? $params['contribution']->receive_date : date('YmdHis');
3078         $balanceTrxnParams['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
3079         $balanceTrxnParams['net_amount'] = CRM_Utils_Array::value('net_amount', $params);
3080         $balanceTrxnParams['currency'] = $params['contribution']->currency;
3081         $balanceTrxnParams['trxn_id'] = $params['contribution']->trxn_id;
3082         $balanceTrxnParams['status_id'] = $statusId;
3083         $balanceTrxnParams['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
3084         $balanceTrxnParams['check_number'] = CRM_Utils_Array::value('check_number', $params);
3085         if (!empty($balanceTrxnParams['from_financial_account_id']) &&
3086           ($statusId == array_search('Completed', $contributionStatuses) || $statusId == array_search('Partially paid', $contributionStatuses))
3087         ) {
3088           $balanceTrxnParams['is_payment'] = 1;
3089         }
3090         if (!empty($params['payment_processor'])) {
3091           $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
3092         }
3093         $financialTxn = CRM_Core_BAO_FinancialTrxn::create($balanceTrxnParams);
3094       }
3095     }
3096
3097     // build line item array if its not set in $params
3098     if (empty($params['line_item']) || $additionalParticipantId) {
3099       CRM_Price_BAO_LineItem::getLineItemArray($params, $entityID, str_replace('civicrm_', '', $entityTable), $isRelatedId);
3100     }
3101
3102     if ($contributionStatus != 'Failed' &&
3103       !($contributionStatus == 'Pending' && !$params['contribution']->is_pay_later)
3104     ) {
3105       $skipRecords = TRUE;
3106       $pendingStatus = array(
3107         'Pending',
3108         'In Progress',
3109       );
3110       if (in_array($contributionStatus, $pendingStatus)) {
3111         $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship(
3112           $params['financial_type_id'],
3113           'Accounts Receivable Account is'
3114         );
3115       }
3116       elseif (!empty($params['payment_processor'])) {
3117         $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getFinancialAccount($params['payment_processor'], 'civicrm_payment_processor', 'financial_account_id');
3118       }
3119       elseif (!empty($params['payment_instrument_id'])) {
3120         $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($params['payment_instrument_id']);
3121       }
3122       else {
3123         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
3124         $queryParams = array(1 => array($relationTypeId, 'Integer'));
3125         $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);
3126       }
3127
3128       $totalAmount = CRM_Utils_Array::value('total_amount', $params);
3129       if (!isset($totalAmount) && !empty($params['prevContribution'])) {
3130         $totalAmount = $params['total_amount'] = $params['prevContribution']->total_amount;
3131       }
3132
3133       //build financial transaction params
3134       $trxnParams = array(
3135         'contribution_id' => $params['contribution']->id,
3136         'to_financial_account_id' => $params['to_financial_account_id'],
3137         'trxn_date' => !empty($params['contribution']->receive_date) ? $params['contribution']->receive_date : date('YmdHis'),
3138         'total_amount' => $totalAmount,
3139         'fee_amount' => CRM_Utils_Array::value('fee_amount', $params),
3140         'net_amount' => CRM_Utils_Array::value('net_amount', $params, $totalAmount),
3141         'currency' => $params['contribution']->currency,
3142         'trxn_id' => $params['contribution']->trxn_id,
3143         'status_id' => $statusId,
3144         'payment_instrument_id' => $params['contribution']->payment_instrument_id,
3145         'check_number' => CRM_Utils_Array::value('check_number', $params),
3146       );
3147       if ($contributionStatus == 'Refunded' || $contributionStatus == 'Chargeback') {
3148         $trxnParams['trxn_date'] = !empty($params['contribution']->cancel_date) ? $params['contribution']->cancel_date : date('YmdHis');
3149         if (isset($params['refund_trxn_id'])) {
3150           // CRM-17751 allow a separate trxn_id for the refund to be passed in via api & form.
3151           $trxnParams['trxn_id'] = $params['refund_trxn_id'];
3152         }
3153       }
3154       //CRM-16259, set is_payment flag for non pending status
3155       if (!in_array($contributionStatus, $pendingStatus)) {
3156         $trxnParams['is_payment'] = 1;
3157       }
3158       if (!empty($params['payment_processor'])) {
3159         $trxnParams['payment_processor_id'] = $params['payment_processor'];
3160       }
3161
3162       if (isset($fromFinancialAccountId)) {
3163         $trxnParams['from_financial_account_id'] = $fromFinancialAccountId;
3164       }
3165
3166       // consider external values passed for recording transaction entry
3167       if (!empty($financialTrxnValues)) {
3168         $trxnParams = array_merge($trxnParams, $financialTrxnValues);
3169       }
3170
3171       $params['trxnParams'] = $trxnParams;
3172
3173       if (!empty($params['prevContribution'])) {
3174         $updated = FALSE;
3175         $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $params['prevContribution']->total_amount;
3176         $params['trxnParams']['fee_amount'] = $params['prevContribution']->fee_amount;
3177         $params['trxnParams']['net_amount'] = $params['prevContribution']->net_amount;
3178         if (!isset($params['trxnParams']['trxn_id'])) {
3179           // Actually I have no idea why we are overwriting any values from the previous contribution.
3180           // (filling makes sense to me). However, only protecting this value as I really really know we
3181           // don't want this one overwritten.
3182           // CRM-17751.
3183           $params['trxnParams']['trxn_id'] = $params['prevContribution']->trxn_id;
3184         }
3185         $params['trxnParams']['status_id'] = $params['prevContribution']->contribution_status_id;
3186
3187         if (!(($params['prevContribution']->contribution_status_id == array_search('Pending', $contributionStatuses)
3188             || $params['prevContribution']->contribution_status_id == array_search('In Progress', $contributionStatuses))
3189           && $params['contribution']->contribution_status_id == array_search('Completed', $contributionStatuses))
3190         ) {
3191           $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id;
3192           $params['trxnParams']['check_number'] = $params['prevContribution']->check_number;
3193         }
3194
3195         //if financial type is changed
3196         if (!empty($params['financial_type_id']) &&
3197           $params['contribution']->financial_type_id != $params['prevContribution']->financial_type_id
3198         ) {
3199           $incomeTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Income Account is' "));
3200           $oldFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($params['prevContribution']->financial_type_id, $incomeTypeId);
3201           $newFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id'], $incomeTypeId);
3202           if ($oldFinancialAccount != $newFinancialAccount) {
3203             $params['total_amount'] = 0;
3204             if (in_array($params['contribution']->contribution_status_id, $pendingStatus)) {
3205               $params['trxnParams']['to_financial_account_id'] = CRM_Contribute_PseudoConstant::financialAccountType(
3206                 $params['prevContribution']->financial_type_id, $relationTypeId);
3207             }
3208             else {
3209               $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['prevContribution']->id, 'DESC');
3210               if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
3211                 $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
3212               }
3213             }
3214             self::updateFinancialAccounts($params, 'changeFinancialType');
3215             /* $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id']; */
3216             $params['financial_account_id'] = $newFinancialAccount;
3217             $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
3218             self::updateFinancialAccounts($params);
3219             $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id'];
3220             $updated = TRUE;
3221           }
3222         }
3223
3224         //Update contribution status
3225         $params['trxnParams']['status_id'] = $params['contribution']->contribution_status_id;
3226         if (!isset($params['refund_trxn_id'])) {
3227           // CRM-17751 This has previously been deliberately set. No explanation as to why one variant
3228           // gets preference over another so I am only 'protecting' a very specific tested flow
3229           // and letting natural justice take care of the rest.
3230           $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id;
3231         }
3232         if (!empty($params['contribution_status_id']) &&
3233           $params['prevContribution']->contribution_status_id != $params['contribution']->contribution_status_id
3234         ) {
3235           //Update Financial Records
3236           self::updateFinancialAccounts($params, 'changedStatus');
3237           $updated = TRUE;
3238         }
3239
3240         // change Payment Instrument for a Completed contribution
3241         // first handle special case when contribution is changed from Pending to Completed status when initial payment
3242         // instrument is null and now new payment instrument is added along with the payment
3243         $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
3244         $params['trxnParams']['check_number'] = CRM_Utils_Array::value('check_number', $params);
3245         if (array_key_exists('payment_instrument_id', $params)) {
3246           $params['trxnParams']['total_amount'] = -$trxnParams['total_amount'];
3247           if (CRM_Utils_System::isNull($params['prevContribution']->payment_instrument_id) &&
3248             !CRM_Utils_System::isNull($params['contribution']->payment_instrument_id)
3249           ) {
3250             //check if status is changed from Pending to Completed
3251             // do not update payment instrument changes for Pending to Completed
3252             if (!($params['contribution']->contribution_status_id == array_search('Completed', $contributionStatuses) &&
3253               in_array($params['prevContribution']->contribution_status_id, $pendingStatus))
3254             ) {
3255               // for all other statuses create new financial records
3256               self::updateFinancialAccounts($params, 'changePaymentInstrument');
3257               $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
3258               self::updateFinancialAccounts($params, 'changePaymentInstrument');
3259               $updated = TRUE;
3260             }
3261           }
3262           elseif ((!CRM_Utils_System::isNull($params['contribution']->payment_instrument_id) ||
3263               !CRM_Utils_System::isNull($params['prevContribution']->payment_instrument_id)) &&
3264             $params['contribution']->payment_instrument_id != $params['prevContribution']->payment_instrument_id
3265           ) {
3266             // for any other payment instrument changes create new financial records
3267             self::updateFinancialAccounts($params, 'changePaymentInstrument');
3268             $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
3269             self::updateFinancialAccounts($params, 'changePaymentInstrument');
3270             $updated = TRUE;
3271           }
3272           elseif (!CRM_Utils_System::isNull($params['contribution']->check_number) &&
3273             $params['contribution']->check_number != $params['prevContribution']->check_number
3274           ) {
3275             // another special case when check number is changed, create new financial records
3276             // create financial trxn with negative amount
3277             $params['trxnParams']['check_number'] = $params['prevContribution']->check_number;
3278             self::updateFinancialAccounts($params, 'changePaymentInstrument');
3279             // create financial trxn with positive amount
3280             $params['trxnParams']['check_number'] = $params['contribution']->check_number;
3281             $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
3282             self::updateFinancialAccounts($params, 'changePaymentInstrument');
3283             $updated = TRUE;
3284           }
3285         }
3286
3287         //if Change contribution amount
3288         $params['trxnParams']['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
3289         $params['trxnParams']['net_amount'] = CRM_Utils_Array::value('net_amount', $params);
3290         $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $totalAmount;
3291         $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id;
3292         if (isset($totalAmount) &&
3293           $totalAmount != $params['prevContribution']->total_amount
3294         ) {
3295           //Update Financial Records
3296           $params['trxnParams']['from_financial_account_id'] = NULL;
3297           self::updateFinancialAccounts($params, 'changedAmount');
3298           $updated = TRUE;
3299         }
3300
3301         if (!$updated) {
3302           // Looks like we might have a data correction update.
3303           // This would be a case where a transaction id has been entered but it is incorrect &
3304           // the person goes back in & fixes it, as opposed to a new transaction.
3305           // Currently the UI doesn't support multiple refunds against a single transaction & we are only supporting
3306           // the data fix scenario.
3307           // CRM-17751.
3308           if (isset($params['refund_trxn_id'])) {
3309             $refundIDs = CRM_Core_BAO_FinancialTrxn::getRefundTransactionIDs($params['id']);
3310             if (!empty($refundIDs['financialTrxnId']) && $refundIDs['trxn_id'] != $params['refund_trxn_id']) {
3311               civicrm_api3('FinancialTrxn', 'create', array('id' => $refundIDs['financialTrxnId'], 'trxn_id' => $params['refund_trxn_id']));
3312             }
3313           }
3314         }
3315       }
3316
3317       if (!$update) {
3318         // records finanical trxn and entity financial trxn
3319         // also make it available as return value
3320         $return = $financialTxn = CRM_Core_BAO_FinancialTrxn::create($trxnParams);
3321         $params['entity_id'] = $financialTxn->id;
3322       }
3323     }
3324     // record line items and financial items
3325     if (empty($params['skipLineItem'])) {
3326       CRM_Price_BAO_LineItem::processPriceSet($entityId, CRM_Utils_Array::value('line_item', $params), $params['contribution'], $entityTable, $update);
3327     }
3328
3329     // create batch entry if batch_id is passed and
3330     // ensure no batch entry is been made on 'Pending' or 'Failed' contribution, CRM-16611
3331     if (!empty($params['batch_id']) && !empty($financialTxn)) {
3332       $entityParams = array(
3333         'batch_id' => $params['batch_id'],
3334         'entity_table' => 'civicrm_financial_trxn',
3335         'entity_id' => $financialTxn->id,
3336       );
3337       CRM_Batch_BAO_Batch::addBatchEntity($entityParams);
3338     }
3339
3340     // when a fee is charged
3341     if (!empty($params['fee_amount']) && (empty($params['prevContribution']) || $params['contribution']->fee_amount != $params['prevContribution']->fee_amount) && $skipRecords) {
3342       CRM_Core_BAO_FinancialTrxn::recordFees($params);
3343     }
3344
3345     if (!empty($params['prevContribution']) && $entityTable == 'civicrm_participant'
3346       && $params['prevContribution']->contribution_status_id != $params['contribution']->contribution_status_id
3347     ) {
3348       $eventID = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $entityId, 'event_id');
3349       $feeLevel[] = str_replace('\ 1', '', $params['prevContribution']->amount_level);
3350       CRM_Event_BAO_Participant::createDiscountTrxn($eventID, $params, $feeLevel);
3351     }
3352     unset($params['line_item']);
3353
3354     return $return;
3355   }
3356
3357   /**
3358    * Update all financial accounts entry.
3359    *
3360    * @param array $params
3361    *   Contribution object, line item array and params for trxn.
3362    *
3363    * @param string $context
3364    *   Update scenarios.
3365    *
3366    * @param null $skipTrxn
3367    *
3368    */
3369   public static function updateFinancialAccounts(&$params, $context = NULL, $skipTrxn = NULL) {
3370     $itemAmount = $trxnID = NULL;
3371     //get all the statuses
3372     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
3373     $previousContributionStatus = CRM_Contribute_PseudoConstant::contributionStatus($params['prevContribution']->contribution_status_id, 'name');
3374     if (($previousContributionStatus == 'Pending'
3375         || $previousContributionStatus == 'In Progress')
3376       && $params['contribution']->contribution_status_id == array_search('Completed', $contributionStatus)
3377       && $context == 'changePaymentInstrument'
3378     ) {
3379       return;
3380     }
3381     if ((($previousContributionStatus == 'Partially paid'
3382       && $params['contribution']->contribution_status_id == array_search('Completed', $contributionStatus))
3383       || ($previousContributionStatus == 'Pending' && $params['prevContribution']->is_pay_later == TRUE
3384       && $params['contribution']->contribution_status_id == array_search('Partially paid', $contributionStatus)))
3385       && $context == 'changedStatus'
3386     ) {
3387       return;
3388     }
3389     if ($context == 'changedAmount' || $context == 'changeFinancialType') {
3390       $itemAmount = $params['trxnParams']['total_amount'] = $params['trxnParams']['net_amount'] = $params['total_amount'] - $params['prevContribution']->total_amount;
3391     }
3392     if ($context == 'changedStatus') {
3393       //get all the statuses
3394       $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
3395       $cancelledTaxAmount = 0;
3396       if ($previousContributionStatus == 'Completed'
3397         && (self::isContributionStatusNegative($params['contribution']->contribution_status_id))
3398       ) {
3399         $params['trxnParams']['total_amount'] = -$params['total_amount'];
3400         $cancelledTaxAmount = CRM_Utils_Array::value('tax_amount', $params, '0.00');
3401         if (empty($params['contribution']->creditnote_id) || $params['contribution']->creditnote_id == "null") {
3402           $creditNoteId = self::createCreditNoteId();
3403           CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution']->id, 'creditnote_id', $creditNoteId);
3404         }
3405       }
3406       elseif (($previousContributionStatus == 'Pending'
3407           && $params['prevContribution']->is_pay_later) || $previousContributionStatus == 'In Progress'
3408       ) {
3409         $financialTypeID = CRM_Utils_Array::value('financial_type_id', $params) ? $params['financial_type_id'] : $params['prevContribution']->financial_type_id;
3410         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3411         $arAccountId = CRM_Contribute_PseudoConstant::financialAccountType($financialTypeID, $relationTypeId);
3412
3413         if ($params['contribution']->contribution_status_id == array_search('Cancelled', $contributionStatus)) {
3414           $params['trxnParams']['to_financial_account_id'] = $arAccountId;
3415           $params['trxnParams']['total_amount'] = -$params['total_amount'];
3416           if (is_null($params['contribution']->creditnote_id) || $params['contribution']->creditnote_id == "null") {
3417             $creditNoteId = self::createCreditNoteId();
3418             CRM_Core_DAO::setFieldValue('CRM_Contribute_DAO_Contribution', $params['contribution']->id, 'creditnote_id', $creditNoteId);
3419           }
3420         }
3421         else {
3422           $params['trxnParams']['from_financial_account_id'] = $arAccountId;
3423         }
3424       }
3425       $itemAmount = $params['trxnParams']['total_amount'] + $cancelledTaxAmount;
3426     }
3427     elseif ($context == 'changePaymentInstrument') {
3428       if ($params['trxnParams']['total_amount'] < 0) {
3429         $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['prevContribution']->id, 'DESC');
3430         if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
3431           $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
3432           $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id;
3433         }
3434       }
3435       else {
3436         $params['trxnParams']['to_financial_account_id'] = $params['to_financial_account_id'];
3437         $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
3438       }
3439     }
3440
3441     if ($context == 'changedStatus') {
3442       if (($previousContributionStatus == 'Pending'
3443           || $previousContributionStatus == 'In Progress')
3444         && ($params['contribution']->contribution_status_id == array_search('Completed', $contributionStatus))
3445       ) {
3446         if (empty($params['line_item'])) {
3447           //CRM-15296
3448           //@todo - check with Joe regarding this situation - payment processors create pending transactions with no line items
3449           // when creating recurring membership payment - there are 2 lines to comment out in contributonPageTest if fixed
3450           // & this can be removed
3451           return;
3452         }
3453         $trxn = CRM_Core_BAO_FinancialTrxn::create($params['trxnParams']);
3454         $params['entity_id'] = $trxn->id;
3455         $query = "UPDATE civicrm_financial_item SET status_id = %1 WHERE entity_id = %2 and entity_table = 'civicrm_line_item'";
3456         $sql = "SELECT id, amount FROM civicrm_financial_item WHERE entity_id = %1 and entity_table = 'civicrm_line_item'";
3457
3458         $entityParams = array(
3459           'entity_table' => 'civicrm_financial_item',
3460           'financial_trxn_id' => $trxn->id,
3461         );
3462         foreach ($params['line_item'] as $fieldId => $fields) {
3463           foreach ($fields as $fieldValueId => $fieldValues) {
3464             $fparams = array(
3465               1 => array(CRM_Core_OptionGroup::getValue('financial_item_status', 'Paid', 'name'), 'Integer'),
3466               2 => array($fieldValues['id'], 'Integer'),
3467             );
3468             CRM_Core_DAO::executeQuery($query, $fparams);
3469             $fparams = array(
3470               1 => array($fieldValues['id'], 'Integer'),
3471             );
3472             $financialItem = CRM_Core_DAO::executeQuery($sql, $fparams);
3473             while ($financialItem->fetch()) {
3474               $entityParams['entity_id'] = $financialItem->id;
3475               $entityParams['amount'] = $financialItem->amount;
3476               CRM_Financial_BAO_FinancialItem::createEntityTrxn($entityParams);
3477             }
3478           }
3479         }
3480         return;
3481       }
3482     }
3483
3484     $trxn = CRM_Core_BAO_FinancialTrxn::create($params['trxnParams']);
3485     $params['entity_id'] = $trxn->id;
3486     if ($context != 'changePaymentInstrument') {
3487       $itemParams['entity_table'] = 'civicrm_line_item';
3488       $trxnIds['id'] = $params['entity_id'];
3489       foreach ($params['line_item'] as $fieldId => $fields) {
3490         foreach ($fields as $fieldValueId => $fieldValues) {
3491           $prevParams['entity_id'] = $fieldValues['id'];
3492           $prevFinancialItem = CRM_Financial_BAO_FinancialItem::retrieve($prevParams, CRM_Core_DAO::$_nullArray);
3493
3494           $receiveDate = CRM_Utils_Date::isoToMysql($params['prevContribution']->receive_date);
3495           if ($params['contribution']->receive_date) {
3496             $receiveDate = CRM_Utils_Date::isoToMysql($params['contribution']->receive_date);
3497           }
3498
3499           $financialAccount = self::getFinancialAccountForStatusChangeTrxn($params, $prevFinancialItem);
3500
3501           $currency = $params['prevContribution']->currency;
3502           if ($params['contribution']->currency) {
3503             $currency = $params['contribution']->currency;
3504           }
3505           $diff = 1;
3506           if ($context == 'changeFinancialType' || self::isContributionStatusNegative($params['contribution']->contribution_status_id)) {
3507             $diff = -1;
3508           }
3509           if (!empty($params['is_quick_config'])) {
3510             $amount = $itemAmount;
3511             if (!$amount) {
3512               $amount = $params['total_amount'];
3513             }
3514           }
3515           else {
3516             $amount = $diff * $fieldValues['line_total'];
3517           }
3518
3519           $itemParams = array(
3520             'transaction_date' => $receiveDate,
3521             'contact_id' => $params['prevContribution']->contact_id,
3522             'currency' => $currency,
3523             'amount' => $amount,
3524             'description' => $prevFinancialItem->description,
3525             'status_id' => $prevFinancialItem->status_id,
3526             'financial_account_id' => $financialAccount,
3527             'entity_table' => 'civicrm_line_item',
3528             'entity_id' => $fieldValues['id'],
3529           );
3530           CRM_Financial_BAO_FinancialItem::create($itemParams, NULL, $trxnIds);
3531
3532           if ($fieldValues['tax_amount']) {
3533             $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
3534             $taxTerm = CRM_Utils_Array::value('tax_term', $invoiceSettings);
3535             $itemParams['amount'] = $diff * $fieldValues['tax_amount'];
3536             $itemParams['description'] = $taxTerm;
3537             if ($fieldValues['financial_type_id']) {
3538               $itemParams['financial_account_id'] = self::getFinancialAccountId($fieldValues['financial_type_id']);
3539             }
3540             CRM_Financial_BAO_FinancialItem::create($itemParams, NULL, $trxnIds);
3541           }
3542         }
3543       }
3544     }
3545     if ($context == 'changeFinancialType') {
3546       $params['skipLineItem'] = FALSE;
3547       foreach ($params['line_item'] as &$lineItems) {
3548         foreach ($lineItems as &$line) {
3549           $line['financial_type_id'] = $params['financial_type_id'];
3550         }
3551       }
3552     }
3553   }
3554
3555   /**
3556    * Is this contribution status a reversal.
3557    *
3558    * If so we would expect to record a negative value in the financial_trxn table.
3559    *
3560    * @param int $status_id
3561    *
3562    * @return bool
3563    */
3564   public static function isContributionStatusNegative($status_id) {
3565     $reversalStatuses = array('Cancelled', 'Chargeback', 'Refunded');
3566     return in_array(CRM_Contribute_PseudoConstant::contributionStatus($status_id, 'name'), $reversalStatuses);
3567   }
3568
3569   /**
3570    * Check status validation on update of a contribution.
3571    *
3572    * @param array $values
3573    *   Previous form values before submit.
3574    *
3575    * @param array $fields
3576    *   The input form values.
3577    *
3578    * @param array $errors
3579    *   List of errors.
3580    *
3581    * @return bool
3582    */
3583   public static function checkStatusValidation($values, &$fields, &$errors) {
3584     if (CRM_Utils_System::isNull($values) && !empty($fields['id'])) {
3585       $values['contribution_status_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $fields['id'], 'contribution_status_id');
3586       if ($values['contribution_status_id'] == $fields['contribution_status_id']) {
3587         return FALSE;
3588       }
3589     }
3590     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
3591     $checkStatus = array(
3592       'Cancelled' => array('Completed', 'Refunded'),
3593       'Completed' => array('Cancelled', 'Refunded', 'Chargeback'),
3594       'Pending' => array('Cancelled', 'Completed', 'Failed', 'Partially paid'),
3595       'In Progress' => array('Cancelled', 'Completed', 'Failed'),
3596       'Refunded' => array('Cancelled', 'Completed'),
3597       'Partially paid' => array('Completed'),
3598     );
3599
3600     if (!in_array($contributionStatuses[$fields['contribution_status_id']],
3601       CRM_Utils_Array::value($contributionStatuses[$values['contribution_status_id']], $checkStatus, array()))
3602     ) {
3603       $errors['contribution_status_id'] = ts("Cannot change contribution status from %1 to %2.", array(
3604         1 => $contributionStatuses[$values['contribution_status_id']],
3605         2 => $contributionStatuses[$fields['contribution_status_id']],
3606       ));
3607     }
3608   }
3609
3610   /**
3611    * Delete contribution of contact.
3612    *
3613    * CRM-12155
3614    *
3615    * @param int $contactId
3616    *   Contact id.
3617    *
3618    */
3619   public static function deleteContactContribution($contactId) {
3620     $contribution = new CRM_Contribute_DAO_Contribution();
3621     $contribution->contact_id = $contactId;
3622     $contribution->find();
3623     while ($contribution->fetch()) {
3624       self::deleteContribution($contribution->id);
3625     }
3626   }
3627
3628   /**
3629    * Get options for a given contribution field.
3630    * @see CRM_Core_DAO::buildOptions
3631    *
3632    * @param string $fieldName
3633    * @param string $context see CRM_Core_DAO::buildOptionsContext.
3634    * @param array $props  whatever is known about this dao object.
3635    *
3636    * @return array|bool
3637    */
3638   public static function buildOptions($fieldName, $context = NULL, $props = array()) {
3639     $className = __CLASS__;
3640     $params = array();
3641     switch ($fieldName) {
3642       // This field is not part of this object but the api supports it
3643       case 'payment_processor':
3644         $className = 'CRM_Contribute_BAO_ContributionPage';
3645         // Filter results by contribution page
3646         if (!empty($props['contribution_page_id'])) {
3647           $page = civicrm_api('contribution_page', 'getsingle', array(
3648             'version' => 3,
3649             'id' => ($props['contribution_page_id']),
3650           ));
3651           $types = (array) CRM_Utils_Array::value('payment_processor', $page, 0);
3652           $params['condition'] = 'id IN (' . implode(',', $types) . ')';
3653         }
3654         break;
3655
3656       // CRM-13981 This field was combined with soft_credits in 4.5 but the api still supports it
3657       case 'honor_type_id':
3658         $className = 'CRM_Contribute_BAO_ContributionSoft';
3659         $fieldName = 'soft_credit_type_id';
3660         $params['condition'] = "v.name IN ('in_honor_of','in_memory_of')";
3661         break;
3662     }
3663     return CRM_Core_PseudoConstant::get($className, $fieldName, $params, $context);
3664   }
3665
3666   /**
3667    * Validate financial type.
3668    *
3669    * CRM-13231
3670    *
3671    * @param int $financialTypeId
3672    *   Financial Type id.
3673    *
3674    * @param string $relationName
3675    *
3676    * @return array|bool
3677    */
3678   public static function validateFinancialType($financialTypeId, $relationName = 'Expense Account is') {
3679     $expenseTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE '{$relationName}' "));
3680     $financialAccount = CRM_Contribute_PseudoConstant::financialAccountType($financialTypeId, $expenseTypeId);
3681
3682     if (!$financialAccount) {
3683       return CRM_Contribute_PseudoConstant::financialType($financialTypeId);
3684     }
3685     return FALSE;
3686   }
3687
3688
3689   /**
3690    * Function to record additional payment for partial and refund contributions.
3691    *
3692    * @param int $contributionId
3693    *   is the invoice contribution id (got created after processing participant payment).
3694    * @param array $trxnsData
3695    *   to take user provided input of transaction details.
3696    * @param string $paymentType
3697    *   'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments.
3698    * @param int $participantId
3699    *
3700    * @return null|object
3701    */
3702   public static function recordAdditionalPayment($contributionId, $trxnsData, $paymentType = 'owed', $participantId = NULL, $updateStatus = TRUE) {
3703     $statusId = CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name');
3704     $getInfoOf['id'] = $contributionId;
3705     $defaults = array();
3706     $contributionDAO = CRM_Contribute_BAO_Contribution::retrieve($getInfoOf, $defaults, CRM_Core_DAO::$_nullArray);
3707     if (!$participantId) {
3708       $participantId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment', $contributionId, 'participant_id');
3709     }
3710
3711     if ($paymentType == 'owed') {
3712       // build params for recording financial trxn entry
3713       $params['contribution'] = $contributionDAO;
3714       $params = array_merge($defaults, $params);
3715       $params['skipLineItem'] = TRUE;
3716       $params['partial_payment_total'] = $contributionDAO->total_amount;
3717       $params['partial_amount_pay'] = $trxnsData['total_amount'];
3718       $trxnsData['trxn_date'] = !empty($trxnsData['trxn_date']) ? $trxnsData['trxn_date'] : date('YmdHis');
3719       $trxnsData['net_amount'] = !empty($trxnsData['net_amount']) ? $trxnsData['net_amount'] : $trxnsData['total_amount'];
3720
3721       // record the entry
3722       $financialTrxn = CRM_Contribute_BAO_Contribution::recordFinancialAccounts($params, $trxnsData);
3723       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3724       $toFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($contributionDAO->financial_type_id, $relationTypeId);
3725
3726       $trxnId = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($contributionId, $contributionDAO->financial_type_id);
3727       if (!empty($trxnId)) {
3728         $trxnId = $trxnId['trxn_id'];
3729       }
3730       elseif (!empty($contributionDAO->payment_instrument_id)) {
3731         $trxnId = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($contributionDAO->payment_instrument_id);
3732       }
3733       else {
3734         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
3735         $queryParams = array(1 => array($relationTypeId, 'Integer'));
3736         $trxnId = CRM_Core_DAO::singleValueQuery("SELECT id FROM civicrm_financial_account WHERE is_default = 1 AND financial_account_type_id = %1", $queryParams);
3737       }
3738
3739       // update statuses
3740       // criteria for updates contribution total_amount == financial_trxns of partial_payments
3741       $sql = "SELECT SUM(ft.total_amount) as sum_of_payments, SUM(ft.net_amount) as net_amount_total
3742 FROM civicrm_financial_trxn ft
3743 LEFT JOIN civicrm_entity_financial_trxn eft
3744   ON (ft.id = eft.financial_trxn_id)
3745 WHERE eft.entity_table = 'civicrm_contribution'
3746   AND eft.entity_id = {$contributionId}
3747   AND ft.to_financial_account_id != {$toFinancialAccount}
3748   AND ft.status_id = {$statusId}
3749 ";
3750       $query = CRM_Core_DAO::executeQuery($sql);
3751       $query->fetch();
3752       $sumOfPayments = $query->sum_of_payments;
3753
3754       // update statuses
3755       if ($contributionDAO->total_amount == $sumOfPayments) {
3756         // update contribution status and
3757         // clean cancel info (if any) if prev. contribution was updated in case of 'Refunded' => 'Completed'
3758         $contributionDAO->contribution_status_id = $statusId;
3759         $contributionDAO->cancel_date = 'null';
3760         $contributionDAO->cancel_reason = NULL;
3761         $netAmount = !empty($trxnsData['net_amount']) ? NULL : $trxnsData['total_amount'];
3762         $contributionDAO->net_amount = $query->net_amount_total + $netAmount;
3763         $contributionDAO->fee_amount = $contributionDAO->total_amount - $contributionDAO->net_amount;
3764         $contributionDAO->save();
3765
3766         //Change status of financial record too
3767         $financialTrxn->status_id = $statusId;
3768         $financialTrxn->save();
3769
3770         // note : not using the self::add method,
3771         // the reason because it performs 'status change' related code execution for financial records
3772         // which in 'Partial Paid' => 'Completed' is not useful, instead specific financial record updates
3773         // are coded below i.e. just updating financial_item status to 'Paid'
3774
3775         if ($participantId) {
3776           // update participant status
3777           $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
3778           $ids = CRM_Event_BAO_Participant::getParticipantIds($contributionId);
3779           foreach ($ids as $val) {
3780             $participantUpdate['id'] = $val;
3781             $participantUpdate['status_id'] = array_search('Registered', $participantStatuses);
3782             CRM_Event_BAO_Participant::add($participantUpdate);
3783           }
3784         }
3785
3786         // update financial item statuses
3787         $financialItemStatus = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_FinancialItem', 'status_id');
3788         $paidStatus = array_search('Paid', $financialItemStatus);
3789
3790         $baseTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($contributionId);
3791         $sqlFinancialItemUpdate = "
3792 UPDATE civicrm_financial_item fi
3793   LEFT JOIN civicrm_entity_financial_trxn eft
3794     ON (eft.entity_id = fi.id AND eft.entity_table = 'civicrm_financial_item')
3795 SET status_id = {$paidStatus}
3796 WHERE eft.financial_trxn_id IN ({$trxnId}, {$baseTrxnId['financialTrxnId']})
3797 ";
3798         CRM_Core_DAO::executeQuery($sqlFinancialItemUpdate);
3799       }
3800     }
3801     elseif ($paymentType == 'refund') {
3802       // build params for recording financial trxn entry
3803       $params['contribution'] = $contributionDAO;
3804       $params = array_merge($defaults, $params);
3805       $params['skipLineItem'] = TRUE;
3806       $trxnsData['trxn_date'] = !empty($trxnsData['trxn_date']) ? $trxnsData['trxn_date'] : date('YmdHis');
3807       $trxnsData['total_amount'] = -$trxnsData['total_amount'];
3808
3809       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3810       $trxnsData['from_financial_account_id'] = CRM_Contribute_PseudoConstant::financialAccountType($contributionDAO->financial_type_id, $relationTypeId);
3811       $trxnsData['status_id'] = CRM_Core_OptionGroup::getValue('contribution_status', 'Refunded', 'name');
3812       // record the entry
3813       $financialTrxn = CRM_Contribute_BAO_Contribution::recordFinancialAccounts($params, $trxnsData);
3814
3815       // note : not using the self::add method,
3816       // the reason because it performs 'status change' related code execution for financial records
3817       // which in 'Pending Refund' => 'Completed' is not useful, instead specific financial record updates
3818       // are coded below i.e. just updating financial_item status to 'Paid'
3819       if ($updateStatus) {
3820         $contributionDetails = CRM_Core_DAO::setFieldValue('CRM_Contribute_BAO_Contribution', $contributionId, 'contribution_status_id', $statusId);
3821       }
3822       // add financial item entry
3823       $financialItemStatus = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_FinancialItem', 'status_id');
3824       $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($contributionDAO->id);
3825       if (!empty($lineItems)) {
3826         foreach ($lineItems as $lineItemId => $lineItemValue) {
3827           $paid = $lineItemValue['line_total'] * ($financialTrxn->total_amount / $contributionDAO->total_amount);
3828           $addFinancialEntry = array(
3829             'transaction_date' => $financialTrxn->trxn_date,
3830             'contact_id' => $contributionDAO->contact_id,
3831             'amount' => round($paid, 2),
3832             'status_id' => array_search('Paid', $financialItemStatus),
3833             'entity_id' => $lineItemId,
3834             'entity_table' => 'civicrm_line_item',
3835           );
3836           $trxnIds['id'] = $financialTrxn->id;
3837           CRM_Financial_BAO_FinancialItem::create($addFinancialEntry, NULL, $trxnIds);
3838         }
3839       }
3840       if ($participantId) {
3841         // update participant status
3842         $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
3843         $ids = CRM_Event_BAO_Participant::getParticipantIds($contributionId);
3844         foreach ($ids as $val) {
3845           $participantUpdate['id'] = $val;
3846           $participantUpdate['status_id'] = array_search('Registered', $participantStatuses);
3847           CRM_Event_BAO_Participant::add($participantUpdate);
3848         }
3849       }
3850     }
3851
3852     // activity creation
3853     if (!empty($financialTrxn)) {
3854       if ($participantId) {
3855         $inputParams['id'] = $participantId;
3856         $values = array();
3857         $ids = array();
3858         $component = 'event';
3859         $entityObj = CRM_Event_BAO_Participant::getValues($inputParams, $values, $ids);
3860         $entityObj = $entityObj[$participantId];
3861       }
3862       $activityType = ($paymentType == 'refund') ? 'Refund' : 'Payment';
3863
3864       self::addActivityForPayment($entityObj, $financialTrxn, $activityType, $component, $contributionId);
3865     }
3866     return $financialTrxn;
3867   }
3868
3869   /**
3870    * @param $entityObj
3871    * @param $trxnObj
3872    * @param $activityType
3873    * @param $component
3874    * @param int $contributionId
3875    *
3876    * @throws CRM_Core_Exception
3877    */
3878   public static function addActivityForPayment($entityObj, $trxnObj, $activityType, $component, $contributionId) {
3879     if ($component == 'event') {
3880       $date = CRM_Utils_Date::isoToMysql($trxnObj->trxn_date);
3881       $paymentAmount = CRM_Utils_Money::format($trxnObj->total_amount, $trxnObj->currency);
3882       $eventTitle = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Event', $entityObj->event_id, 'title');
3883       $subject = "{$paymentAmount} - Offline {$activityType} for {$eventTitle}";
3884       $targetCid = $entityObj->contact_id;
3885       // source record id would be the contribution id
3886       $srcRecId = $contributionId;
3887     }
3888
3889     // activity params
3890     $activityParams = array(
3891       'source_contact_id' => $targetCid,
3892       'source_record_id' => $srcRecId,
3893       'activity_type_id' => CRM_Core_OptionGroup::getValue('activity_type',
3894         $activityType,
3895         'name'
3896       ),
3897       'subject' => $subject,
3898       'activity_date_time' => $date,
3899       'status_id' => CRM_Core_OptionGroup::getValue('activity_status',
3900         'Completed',
3901         'name'
3902       ),
3903       'skipRecentView' => TRUE,
3904     );
3905
3906     // create activity with target contacts
3907     $session = CRM_Core_Session::singleton();
3908     $id = $session->get('userID');
3909     if ($id) {
3910       $activityParams['source_contact_id'] = $id;
3911       $activityParams['target_contact_id'][] = $targetCid;
3912     }
3913     CRM_Activity_BAO_Activity::create($activityParams);
3914   }
3915
3916   /**
3917    * Get list of payments displayed by Contribute_Page_PaymentInfo.
3918    *
3919    * @param int $id
3920    * @param $component
3921    * @param bool $getTrxnInfo
3922    * @param bool $usingLineTotal
3923    *
3924    * @return mixed
3925    */
3926   public static function getPaymentInfo($id, $component, $getTrxnInfo = FALSE, $usingLineTotal = FALSE) {
3927     if ($component == 'event') {
3928       $entity = 'participant';
3929       $entityTable = 'civicrm_participant';
3930       $contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'contribution_id', 'participant_id');
3931
3932       if (!$contributionId) {
3933         if ($primaryParticipantId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Participant', $id, 'registered_by_id')) {
3934           $contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $primaryParticipantId, 'contribution_id', 'participant_id');
3935           $id = $primaryParticipantId;
3936         }
3937         if (!$contributionId) {
3938           return;
3939         }
3940       }
3941     }
3942     else {
3943       $contributionId = $id;
3944       $entity = 'contribution';
3945       $entityTable = 'civicrm_contribution';
3946     }
3947
3948     $total = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($contributionId);
3949     $baseTrxnId = !empty($total['trxn_id']) ? $total['trxn_id'] : NULL;
3950     $isBalance = NULL;
3951     if ($baseTrxnId) {
3952       $isBalance = TRUE;
3953     }
3954     else {
3955       $baseTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($contributionId);
3956       $baseTrxnId = $baseTrxnId['financialTrxnId'];
3957       $isBalance = FALSE;
3958     }
3959     if (!CRM_Utils_Array::value('total_amount', $total) || $usingLineTotal) {
3960       // for additional participants
3961       if ($entityTable == 'civicrm_participant') {
3962         $ids = CRM_Event_BAO_Participant::getParticipantIds($contributionId);
3963         $total = 0;
3964         foreach ($ids as $val) {
3965           $total += CRM_Price_BAO_LineItem::getLineTotal($val, $entityTable);
3966         }
3967       }
3968       else {
3969         $total = CRM_Price_BAO_LineItem::getLineTotal($id, $entityTable);
3970       }
3971     }
3972     else {
3973       $baseTrxnId = $total['trxn_id'];
3974       $total = $total['total_amount'];
3975     }
3976
3977     $paymentBalance = CRM_Core_BAO_FinancialTrxn::getPartialPaymentWithType($id, $entity, FALSE, $total);
3978     $contributionIsPayLater = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'is_pay_later');
3979
3980     $feeRelationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Expense Account is' "));
3981     $financialTypeId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id');
3982     $feeFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($financialTypeId, $feeRelationTypeId);
3983
3984     if ($paymentBalance == 0 && $contributionIsPayLater) {
3985       $paymentBalance = $total;
3986     }
3987
3988     $info['total'] = $total;
3989     $info['paid'] = $total - $paymentBalance;
3990     $info['balance'] = $paymentBalance;
3991     $info['id'] = $id;
3992     $info['component'] = $component;
3993     $info['payLater'] = $contributionIsPayLater;
3994     $rows = array();
3995     if ($getTrxnInfo && $baseTrxnId) {
3996       // Need to exclude fee trxn rows so filter out rows where TO FINANCIAL ACCOUNT is expense account
3997       $sql = "
3998         SELECT GROUP_CONCAT(fa.`name`) as financial_account,
3999           ft.total_amount,
4000           ft.payment_instrument_id,
4001           ft.trxn_date, ft.trxn_id, ft.status_id, ft.check_number, con.currency
4002
4003         FROM civicrm_contribution con
4004           LEFT JOIN civicrm_entity_financial_trxn eft ON (eft.entity_id = con.id AND eft.entity_table = 'civicrm_contribution')
4005           INNER JOIN civicrm_financial_trxn ft ON ft.id = eft.financial_trxn_id
4006             AND ft.to_financial_account_id != {$feeFinancialAccount}
4007           INNER JOIN civicrm_entity_financial_trxn ef ON (ef.financial_trxn_id = ft.id AND ef.entity_table = 'civicrm_financial_item')
4008           LEFT JOIN civicrm_financial_item fi ON fi.id = ef.entity_id
4009           INNER JOIN civicrm_financial_account fa ON fa.id = fi.financial_account_id
4010
4011         WHERE con.id = {$contributionId}
4012         GROUP BY ft.id
4013       ";
4014
4015       // conditioned WHERE clause
4016       if ($isBalance) {
4017         // if balance trxn exists don't include details of it in transaction info
4018         $sql .= " AND ft.id != {$baseTrxnId} ";
4019       }
4020       $resultDAO = CRM_Core_DAO::executeQuery($sql);
4021
4022       $statuses = CRM_Contribute_PseudoConstant::contributionStatus();
4023
4024       while ($resultDAO->fetch()) {
4025         $paidByLabel = CRM_Core_PseudoConstant::getLabel('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id);
4026         $paidByName = CRM_Core_PseudoConstant::getName('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id);
4027         $val = array(
4028           'total_amount' => $resultDAO->total_amount,
4029           'financial_type' => $resultDAO->financial_account,
4030           'payment_instrument' => $paidByLabel,
4031           'receive_date' => $resultDAO->trxn_date,
4032           'trxn_id' => $resultDAO->trxn_id,
4033           'status' => $statuses[$resultDAO->status_id],
4034           'currency' => $resultDAO->currency,
4035         );
4036         if ($paidByName == 'Check') {
4037           $val['check_number'] = $resultDAO->check_number;
4038         }
4039         $rows[] = $val;
4040       }
4041       $info['transaction'] = $rows;
4042     }
4043     return $info;
4044   }
4045
4046   /**
4047    * Get financial account id has 'Sales Tax Account is'
4048    * account relationship with financial type
4049    *
4050    * @param int $financialTypeId
4051    *
4052    * @return FinancialAccountId
4053    */
4054   public static function getFinancialAccountId($financialTypeId) {
4055     $accountRel = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Sales Tax Account is' "));
4056     $searchParams = array(
4057       'entity_table' => 'civicrm_financial_type',
4058       'entity_id' => $financialTypeId,
4059       'account_relationship' => $accountRel,
4060     );
4061     $result = array();
4062     CRM_Financial_BAO_FinancialTypeAccount::retrieve($searchParams, $result);
4063
4064     return CRM_Utils_Array::value('financial_account_id', $result);
4065   }
4066
4067   /**
4068    * Check tax amount.
4069    *
4070    * @param array $params
4071    * @param bool $isLineItem
4072    *
4073    * @return mixed
4074    */
4075   public static function checkTaxAmount($params, $isLineItem = FALSE) {
4076     $taxRates = CRM_Core_PseudoConstant::getTaxRates();
4077
4078     // Update contribution.
4079     if (!empty($params['id'])) {
4080       $id = $params['id'];
4081       $values = $ids = array();
4082       $contrbutionParams = array('id' => $id);
4083       $prevContributionValue = CRM_Contribute_BAO_Contribution::getValues($contrbutionParams, $values, $ids);
4084
4085       // To assign pervious finantial type on update of contribution
4086       if (!isset($params['financial_type_id'])) {
4087         $params['financial_type_id'] = $prevContributionValue->financial_type_id;
4088       }
4089       elseif (isset($params['financial_type_id']) && !array_key_exists($params['financial_type_id'], $taxRates)) {
4090         // Assisn tax Amount on update of contrbution
4091         if (!empty($prevContributionValue->tax_amount)) {
4092           $params['tax_amount'] = 'null';
4093           CRM_Price_BAO_LineItem::getLineItemArray($params, array($params['id']));
4094           foreach ($params['line_item'] as $setID => $priceField) {
4095             foreach ($priceField as $priceFieldID => $priceFieldValue) {
4096               $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4097             }
4098           }
4099         }
4100       }
4101     }
4102
4103     // New Contrbution and update of contribution with tax rate financial type
4104     if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) &&
4105       empty($params['skipLineItem']) && !$isLineItem
4106     ) {
4107       $taxRateParams = $taxRates[$params['financial_type_id']];
4108       $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount(CRM_Utils_Array::value('total_amount', $params), $taxRateParams);
4109       $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4110
4111       // Get Line Item on update of contribution
4112       if (isset($params['id'])) {
4113         CRM_Price_BAO_LineItem::getLineItemArray($params, array($params['id']));
4114       }
4115       else {
4116         CRM_Price_BAO_LineItem::getLineItemArray($params);
4117       }
4118       foreach ($params['line_item'] as $setID => $priceField) {
4119         foreach ($priceField as $priceFieldID => $priceFieldValue) {
4120           $params['line_item'][$setID][$priceFieldID]['tax_amount'] = $params['tax_amount'];
4121         }
4122       }
4123       $params['total_amount'] = CRM_Utils_Array::value('total_amount', $params) + $params['tax_amount'];
4124     }
4125     elseif (isset($params['api.line_item.create'])) {
4126       // Update total amount of contribution using lineItem
4127       $taxAmountArray = array();
4128       foreach ($params['api.line_item.create'] as $key => $value) {
4129         if (isset($value['financial_type_id']) && array_key_exists($value['financial_type_id'], $taxRates)) {
4130           $taxRate = $taxRates[$value['financial_type_id']];
4131           $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount($value['line_total'], $taxRate);
4132           $taxAmountArray[] = round($taxAmount['tax_amount'], 2);
4133         }
4134       }
4135       $params['tax_amount'] = array_sum($taxAmountArray);
4136       $params['total_amount'] = $params['total_amount'] + $params['tax_amount'];
4137     }
4138     else {
4139       // update line item of contrbution
4140       if (isset($params['financial_type_id']) && array_key_exists($params['financial_type_id'], $taxRates) && $isLineItem) {
4141         $taxRate = $taxRates[$params['financial_type_id']];
4142         $taxAmount = CRM_Contribute_BAO_Contribution_Utils::calculateTaxAmount($params['line_total'], $taxRate);
4143         $params['tax_amount'] = round($taxAmount['tax_amount'], 2);
4144       }
4145     }
4146     return $params;
4147   }
4148
4149   /**
4150    * Check financial type validation on update of a contribution.
4151    *
4152    * @param Integer $financialTypeId
4153    *   Value of latest Financial Type.
4154    *
4155    * @param Integer $contributionId
4156    *   Contribution Id.
4157    *
4158    * @param array $errors
4159    *   List of errors.
4160    *
4161    * @return bool
4162    */
4163   public static function checkFinancialTypeChange($financialTypeId, $contributionId, &$errors) {
4164     if (!empty($financialTypeId)) {
4165       $oldFinancialTypeId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'financial_type_id');
4166       if ($oldFinancialTypeId == $financialTypeId) {
4167         return FALSE;
4168       }
4169     }
4170     $sql = 'SELECT financial_type_id FROM civicrm_line_item WHERE contribution_id = %1 GROUP BY financial_type_id;';
4171     $params = array(
4172       '1' => array($contributionId, 'Integer'),
4173     );
4174     $result = CRM_Core_DAO::executeQuery($sql, $params);
4175     if ($result->N > 1) {
4176       $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.');
4177     }
4178   }
4179
4180   /**
4181    * Update related pledge payment payments.
4182    *
4183    * This function has been refactored out of the back office contribution form and may
4184    * still overlap with other functions.
4185    *
4186    * @param string $action
4187    * @param int $pledgePaymentID
4188    * @param int $contributionID
4189    * @param bool $adjustTotalAmount
4190    * @param float $total_amount
4191    * @param float $original_total_amount
4192    * @param int $contribution_status_id
4193    * @param int $original_contribution_status_id
4194    */
4195   public static function updateRelatedPledge(
4196     $action,
4197     $pledgePaymentID,
4198     $contributionID,
4199     $adjustTotalAmount,
4200     $total_amount,
4201     $original_total_amount,
4202     $contribution_status_id,
4203     $original_contribution_status_id
4204   ) {
4205     if (!$pledgePaymentID && $action & CRM_Core_Action::ADD && !$contributionID) {
4206       return;
4207     }
4208
4209     if ($pledgePaymentID) {
4210       //store contribution id in payment record.
4211       CRM_Core_DAO::setFieldValue('CRM_Pledge_DAO_PledgePayment', $pledgePaymentID, 'contribution_id', $contributionID);
4212     }
4213     else {
4214       $pledgePaymentID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4215         $contributionID,
4216         'id',
4217         'contribution_id'
4218       );
4219     }
4220
4221     if (!$pledgePaymentID) {
4222       return;
4223     }
4224     $pledgeID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment',
4225       $contributionID,
4226       'pledge_id',
4227       'contribution_id'
4228     );
4229
4230     $updatePledgePaymentStatus = FALSE;
4231
4232     // If either the status or the amount has changed we update the pledge status.
4233     if ($action & CRM_Core_Action::ADD) {
4234       $updatePledgePaymentStatus = TRUE;
4235     }
4236     elseif ($action & CRM_Core_Action::UPDATE && (($original_contribution_status_id != $contribution_status_id) ||
4237         ($original_total_amount != $total_amount))
4238     ) {
4239       $updatePledgePaymentStatus = TRUE;
4240     }
4241
4242     if ($updatePledgePaymentStatus) {
4243       CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID,
4244         array($pledgePaymentID),
4245         $contribution_status_id,
4246         NULL,
4247         $total_amount,
4248         $adjustTotalAmount
4249       );
4250     }
4251   }
4252
4253   /**
4254    * Compute the stats values
4255    *
4256    * @param $stat either 'mode' or 'median'
4257    * @param $sql
4258    * @param $alias of civicrm_contribution
4259    */
4260   public static function computeStats($stat, $sql, $alias = NULL) {
4261     $mode = $median = array();
4262     switch ($stat) {
4263       case 'mode':
4264         $modeDAO = CRM_Core_DAO::executeQuery($sql);
4265         while ($modeDAO->fetch()) {
4266           if ($modeDAO->civicrm_contribution_total_amount_count > 1) {
4267             $mode[] = CRM_Utils_Money::format($modeDAO->amount, $modeDAO->currency);
4268           }
4269           else {
4270             $mode[] = 'N/A';
4271           }
4272         }
4273         return $mode;
4274
4275       case 'median':
4276         $currencies = CRM_Core_OptionGroup::values('currencies_enabled');
4277         foreach ($currencies as $currency => $val) {
4278           $midValue = 0;
4279           $where = "AND {$alias}.currency = '{$currency}'";
4280           $rowCount = CRM_Core_DAO::singleValueQuery("SELECT count(*) as count {$sql} {$where}");
4281
4282           $even = FALSE;
4283           $offset = 1;
4284           $medianRow = floor($rowCount / 2);
4285           if ($rowCount % 2 == 0 && !empty($medianRow)) {
4286             $even = TRUE;
4287             $offset++;
4288             $medianRow--;
4289           }
4290
4291           $medianValue = "SELECT {$alias}.total_amount as median
4292              {$sql} {$where}
4293              ORDER BY median LIMIT {$medianRow},{$offset}";
4294           $medianValDAO = CRM_Core_DAO::executeQuery($medianValue);
4295           while ($medianValDAO->fetch()) {
4296             if ($even) {
4297               $midValue = $midValue + $medianValDAO->median;
4298             }
4299             else {
4300               $median[] = CRM_Utils_Money::format($medianValDAO->median, $currency);
4301             }
4302           }
4303           if ($even) {
4304             $midValue = $midValue / 2;
4305             $median[] = CRM_Utils_Money::format($midValue, $currency);
4306           }
4307         }
4308         return $median;
4309
4310       default:
4311         return;
4312     }
4313   }
4314
4315   /**
4316    * Is there only one line item attached to the contribution.
4317    *
4318    * @param int $id
4319    *   Contribution ID.
4320    *
4321    * @return bool
4322    * @throws \CiviCRM_API3_Exception
4323    */
4324   public static function isSingleLineItem($id) {
4325     $lineItemCount = civicrm_api3('LineItem', 'getcount', array('contribution_id' => $id));
4326     return ($lineItemCount == 1);
4327   }
4328
4329   /**
4330    * Complete an order.
4331    *
4332    * Do not call this directly - use the contribution.completetransaction api as this function is being refactored.
4333    *
4334    * Currently overloaded to complete a transaction & repeat a transaction - fix!
4335    *
4336    * Moving it out of the BaseIPN class is just the first step.
4337    *
4338    * @param array $input
4339    * @param array $ids
4340    * @param array $objects
4341    * @param CRM_Core_Transaction $transaction
4342    * @param int $recur
4343    * @param CRM_Contribute_BAO_Contribution $contribution
4344    * @param bool $isRecurring
4345    *   Duplication of param needs review. Only used by AuthorizeNetIPN
4346    * @param int $isFirstOrLastRecurringPayment
4347    *   Deprecated param only used by AuthorizeNetIPN.
4348    */
4349   public static function completeOrder(&$input, &$ids, $objects, $transaction, $recur, $contribution, $isRecurring, $isFirstOrLastRecurringPayment) {
4350     $primaryContributionID = isset($contribution->id) ? $contribution->id : $objects['first_contribution']->id;
4351     // The previous details are used when calculating line items so keep it before any code that 'does something'
4352     if (!empty($contribution->id)) {
4353       $input['prevContribution'] = CRM_Contribute_BAO_Contribution::getValues(array('id' => $contribution->id),
4354         CRM_Core_DAO::$_nullArray, CRM_Core_DAO::$_nullArray);
4355     }
4356     $inputContributionWhiteList = array(
4357       'fee_amount',
4358       'net_amount',
4359       'trxn_id',
4360       'check_number',
4361       'payment_instrument_id',
4362       'is_test',
4363       'campaign_id',
4364       'receive_date',
4365       'receipt_date',
4366       'contribution_status_id',
4367     );
4368     if (self::isSingleLineItem($primaryContributionID)) {
4369       $inputContributionWhiteList[] = 'financial_type_id';
4370     }
4371
4372     $participant = CRM_Utils_Array::value('participant', $objects);
4373     $memberships = CRM_Utils_Array::value('membership', $objects);
4374     $recurContrib = CRM_Utils_Array::value('contributionRecur', $objects);
4375     $recurringContributionID = (empty($recurContrib->id)) ? NULL : $recurContrib->id;
4376     $event = CRM_Utils_Array::value('event', $objects);
4377
4378     $completedContributionStatusID = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
4379
4380     $contributionParams = array_merge(array(
4381       'contribution_status_id' => $completedContributionStatusID,
4382       'source' => self::getRecurringContributionDescription($contribution, $event),
4383     ), array_intersect_key($input, array_fill_keys($inputContributionWhiteList, 1)
4384     ));
4385
4386     if ($recurringContributionID) {
4387       $contributionParams['contribution_recur_id'] = $recurringContributionID;
4388     }
4389     $changeDate = CRM_Utils_Array::value('trxn_date', $input, date('YmdHis'));
4390
4391     if (empty($contributionParams['receive_date']) && $changeDate) {
4392       $contributionParams['receive_date'] = $changeDate;
4393     }
4394
4395     self::repeatTransaction($contribution, $input, $contributionParams);
4396     $contributionParams['financial_type_id'] = $contribution->financial_type_id;
4397
4398     if (is_numeric($memberships)) {
4399       $memberships = array($objects['membership']);
4400     }
4401
4402     $values = array();
4403     if (isset($input['is_email_receipt'])) {
4404       $values['is_email_receipt'] = $input['is_email_receipt'];
4405     }
4406
4407     if ($input['component'] == 'contribute') {
4408       if ($contribution->contribution_page_id) {
4409         // Figure out what we gain from this.
4410         CRM_Contribute_BAO_ContributionPage::setValues($contribution->contribution_page_id, $values);
4411       }
4412       elseif ($recurContrib && $recurringContributionID) {
4413         $values['amount'] = $recurContrib->amount;
4414         $values['financial_type_id'] = $objects['contributionType']->id;
4415         $values['title'] = $source = ts('Offline Recurring Contribution');
4416       }
4417
4418       if ($recurContrib && $recurringContributionID && !isset($input['is_email_receipt'])) {
4419         //CRM-13273 - is_email_receipt setting on recurring contribution should take precedence over contribution page setting
4420         // but CRM-16124 if $input['is_email_receipt'] is set then that should not be overridden.
4421         $values['is_email_receipt'] = $recurContrib->is_email_receipt;
4422       }
4423
4424       if (!empty($memberships)) {
4425         foreach ($memberships as $membershipTypeIdKey => $membership) {
4426           if ($membership) {
4427             $membershipParams = array(
4428               'id' => $membership->id,
4429               'contact_id' => $membership->contact_id,
4430               'is_test' => $membership->is_test,
4431               'membership_type_id' => $membership->membership_type_id,
4432             );
4433
4434             $currentMembership = CRM_Member_BAO_Membership::getContactMembership($membershipParams['contact_id'],
4435               $membershipParams['membership_type_id'],
4436               $membershipParams['is_test'],
4437               $membershipParams['id']
4438             );
4439
4440             // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
4441             // this picks up membership type changes during renewals
4442             $sql = "
4443 SELECT    membership_type_id
4444 FROM      civicrm_membership_log
4445 WHERE     membership_id={$membershipParams['id']}
4446 ORDER BY  id DESC
4447 LIMIT 1;";
4448             $dao = CRM_Core_DAO::executeQuery($sql);
4449             if ($dao->fetch()) {
4450               if (!empty($dao->membership_type_id)) {
4451                 $membershipParams['membership_type_id'] = $dao->membership_type_id;
4452               }
4453             }
4454             $dao->free();
4455
4456             $membershipParams['num_terms'] = $contribution->getNumTermsByContributionAndMembershipType(
4457               $membershipParams['membership_type_id'],
4458               $primaryContributionID
4459             );
4460             $dates = array_fill_keys(array('join_date', 'start_date', 'end_date'), NULL);
4461             if ($currentMembership) {
4462               /*
4463                * Fixed FOR CRM-4433
4464                * In BAO/Membership.php(renewMembership function), we skip the extend membership date and status
4465                * when Contribution mode is notify and membership is for renewal )
4466                */
4467               CRM_Member_BAO_Membership::fixMembershipStatusBeforeRenew($currentMembership, $changeDate);
4468
4469               // @todo - we should pass membership_type_id instead of null here but not
4470               // adding as not sure of testing
4471               $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($membershipParams['id'],
4472                 $changeDate, NULL, $membershipParams['num_terms']
4473               );
4474
4475               $dates['join_date'] = $currentMembership['join_date'];
4476             }
4477
4478             //get the status for membership.
4479             $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($dates['start_date'],
4480               $dates['end_date'],
4481               $dates['join_date'],
4482               'today',
4483               TRUE,
4484               $membershipParams['membership_type_id'],
4485               $membershipParams
4486             );
4487
4488             $membershipParams['status_id'] = CRM_Utils_Array::value('id', $calcStatus, 'New');
4489             //we might be renewing membership,
4490             //so make status override false.
4491             $membershipParams['is_override'] = FALSE;
4492             //CRM-17723 - reset static $relatedContactIds array()
4493             $var = TRUE;
4494             CRM_Member_BAO_Membership::createRelatedMemberships($var, $var, TRUE);
4495             civicrm_api3('Membership', 'create', $membershipParams);
4496           }
4497         }
4498       }
4499     }
4500     else {
4501       if (empty($input['IAmAHorribleNastyBeyondExcusableHackInTheCRMEventFORMTaskClassThatNeedsToBERemoved'])) {
4502         if ($event->is_email_confirm) {
4503           // @todo this should be set by the function that sends the mail after sending.
4504           $contributionParams['receipt_date'] = $changeDate;
4505         }
4506         $participantParams['id'] = $participant->id;
4507         $participantParams['status_id'] = 'Registered';
4508         civicrm_api3('Participant', 'create', $participantParams);
4509       }
4510     }
4511
4512     $contributionParams['id'] = $contribution->id;
4513
4514     $contributionResult = civicrm_api3('Contribution', 'create', $contributionParams);
4515
4516     // Add new soft credit against current $contribution.
4517     if (CRM_Utils_Array::value('contributionRecur', $objects) && $objects['contributionRecur']->id) {
4518       CRM_Contribute_BAO_ContributionRecur::addrecurSoftCredit($objects['contributionRecur']->id, $contribution->id);
4519     }
4520
4521     $paymentProcessorId = '';
4522     if (isset($objects['paymentProcessor'])) {
4523       if (is_array($objects['paymentProcessor'])) {
4524         $paymentProcessorId = $objects['paymentProcessor']['id'];
4525       }
4526       else {
4527         $paymentProcessorId = $objects['paymentProcessor']->id;
4528       }
4529     }
4530
4531     $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution', 'contribution_status_id', array(
4532       'labelColumn' => 'name',
4533       'flip' => 1,
4534     ));
4535     if ((empty($input['prevContribution']) && $paymentProcessorId) || (!$input['prevContribution']->is_pay_later && $input['prevContribution']->contribution_status_id == $contributionStatuses['Pending'])) {
4536       $input['payment_processor'] = $paymentProcessorId;
4537     }
4538
4539     if (!empty($contribution->_relatedObjects['participant'])) {
4540       $input['contribution_mode'] = 'participant';
4541       $input['participant_id'] = $contribution->_relatedObjects['participant']->id;
4542       $input['skipLineItem'] = 1;
4543     }
4544     elseif (!empty($contribution->_relatedObjects['membership'])) {
4545       $input['skipLineItem'] = TRUE;
4546       $input['contribution_mode'] = 'membership';
4547       $contribution->contribution_status_id = $contributionParams['contribution_status_id'];
4548       $contribution->trxn_id = CRM_Utils_Array::value('trxn_id', $input);
4549       $contribution->receive_date = CRM_Utils_Date::isoToMysql($contribution->receive_date);
4550     }
4551     $input['contribution_status_id'] = $contributionParams['contribution_status_id'];
4552     $input['total_amount'] = $input['amount'];
4553     $input['contribution'] = $contribution;
4554     $input['financial_type_id'] = $contribution->financial_type_id;
4555     //@todo writing a unit test I was unable to create a scenario where this line did not fatal on second
4556     // and subsequent payments. In this case the line items are created at
4557     // CRM_Contribute_BAO_ContributionRecur::addRecurLineItems
4558     // and since the contribution is saved prior to this line there is always a contribution-id,
4559     // however there is never a prevContribution (which appears to mean original contribution not previous
4560     // contribution - or preUpdateContributionObject most accurately)
4561     // so, this is always called & only appears to succeed when prevContribution exists - which appears
4562     // to mean "are we updating an exisitng pending contribution"
4563     //I was able to make the unit test complete as fataling here doesn't prevent
4564     // the contribution being created - but activities would not be created or emails sent
4565
4566     CRM_Contribute_BAO_Contribution::recordFinancialAccounts($input, NULL);
4567
4568     CRM_Core_Error::debug_log_message("Contribution record updated successfully");
4569     $transaction->commit();
4570
4571     CRM_Contribute_BAO_ContributionRecur::updateRecurLinkedPledge($contribution->id, $recurringContributionID,
4572       $input['contribution_status_id'], $input['total_amount']);
4573
4574     // create an activity record
4575     if ($input['component'] == 'contribute') {
4576       //CRM-4027
4577       $targetContactID = NULL;
4578       if (!empty($ids['related_contact'])) {
4579         $targetContactID = $contribution->contact_id;
4580         $contribution->contact_id = $ids['related_contact'];
4581       }
4582       CRM_Activity_BAO_Activity::addActivity($contribution, NULL, $targetContactID);
4583       // event
4584     }
4585     else {
4586       CRM_Activity_BAO_Activity::addActivity($participant);
4587     }
4588
4589     // CRM-9132 legacy behaviour was that receipts were sent out in all instances. Still sending
4590     // when array_key 'is_email_receipt doesn't exist in case some instances where is needs setting haven't been set
4591     if (!array_key_exists('is_email_receipt', $values) ||
4592       $values['is_email_receipt'] == 1
4593     ) {
4594       civicrm_api3('Contribution', 'sendconfirmation', array(
4595         'id' => $contribution->id,
4596         'payment_processor_id' => $paymentProcessorId,
4597       ));
4598       CRM_Core_Error::debug_log_message("Receipt sent");
4599     }
4600
4601     CRM_Core_Error::debug_log_message("Success: Database updated");
4602     if ($isRecurring) {
4603       CRM_Contribute_BAO_ContributionRecur::sendRecurringStartOrEndNotification($ids, $recur,
4604         $isFirstOrLastRecurringPayment);
4605     }
4606     return $contributionResult;
4607   }
4608
4609   /**
4610    * Send receipt from contribution.
4611    *
4612    * Do not call this directly - it is being refactored. use contribution.sendmessage api call.
4613    *
4614    * Note that the compose message part has been moved to contribution
4615    * In general LoadObjects is called first to get the objects but the composeMessageArray function now calls it.
4616    *
4617    * @param array $input
4618    *   Incoming data from Payment processor.
4619    * @param array $ids
4620    *   Related object IDs.
4621    * @param int $contributionID
4622    * @param array $values
4623    *   Values related to objects that have already been loaded.
4624    * @param bool $recur
4625    *   Is it part of a recurring contribution.
4626    * @param bool $returnMessageText
4627    *   Should text be returned instead of sent. This.
4628    *   is because the function is also used to generate pdfs
4629    *
4630    * @return array
4631    * @throws \CRM_Core_Exception
4632    * @throws \CiviCRM_API3_Exception
4633    */
4634   public static function sendMail(&$input, &$ids, $contributionID, &$values, $recur = FALSE,
4635                                   $returnMessageText = FALSE) {
4636     $input['is_recur'] = $recur;
4637
4638     $contribution = new CRM_Contribute_BAO_Contribution();
4639     $contribution->id = $contributionID;
4640     if (!$contribution->find(TRUE)) {
4641       throw new CRM_Core_Exception('Contribution does not exist');
4642     }
4643     $contribution->loadRelatedObjects($input, $ids, TRUE);
4644     // set receipt from e-mail and name in value
4645     if (!$returnMessageText) {
4646       $session = CRM_Core_Session::singleton();
4647       $userID = $session->get('userID');
4648       if (!empty($userID)) {
4649         list($userName, $userEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($userID);
4650         $values['receipt_from_email'] = CRM_Utils_Array::value('receipt_from_email', $input, $userEmail);
4651         $values['receipt_from_name'] = CRM_Utils_Array::value('receipt_from_name', $input, $userName);
4652       }
4653     }
4654
4655     $return = $contribution->composeMessageArray($input, $ids, $values, $recur, $returnMessageText);
4656     // Contribution ID should really always be set. But ?
4657     if (!$returnMessageText && (!isset($input['receipt_update']) || $input['receipt_update']) && empty($contribution->receipt_date)) {
4658       civicrm_api3('Contribution', 'create', array('receipt_date' => 'now', 'id' => $contribution->id));
4659     }
4660     return $return;
4661   }
4662
4663   /**
4664    * Generate credit note id with next avaible number
4665    *
4666    * @return string
4667    *   Credit Note Id.
4668    */
4669   public static function createCreditNoteId() {
4670     $prefixValue = Civi::settings()->get('contribution_invoice_settings');
4671
4672     $creditNoteNum = CRM_Core_DAO::singleValueQuery("SELECT count(creditnote_id) as creditnote_number FROM civicrm_contribution");
4673     $creditNoteId = NULL;
4674
4675     do {
4676       $creditNoteNum++;
4677       $creditNoteId = CRM_Utils_Array::value('credit_notes_prefix', $prefixValue) . "" . $creditNoteNum;
4678       $result = civicrm_api3('Contribution', 'getcount', array(
4679         'sequential' => 1,
4680         'creditnote_id' => $creditNoteId,
4681       ));
4682     } while ($result > 0);
4683
4684     return $creditNoteId;
4685   }
4686
4687   /**
4688    * Load related memberships.
4689    *
4690    * Note that in theory it should be possible to retrieve these from the line_item table
4691    * with the membership_payment table being deprecated. Attempting to do this here causes tests to fail
4692    * as it seems the api is not correctly linking the line items when the contribution is created in the flow
4693    * where the contribution is created in the API, followed by the membership (using the api) followed by the membership
4694    * payment. The membership payment BAO does have code to address this but it doesn't appear to be working.
4695    *
4696    * I don't know if it never worked or broke as a result of https://issues.civicrm.org/jira/browse/CRM-14918.
4697    *
4698    * @param array $ids
4699    *
4700    * @throws Exception
4701    */
4702   public function loadRelatedMembershipObjects(&$ids) {
4703     $query = "
4704       SELECT membership_id
4705       FROM   civicrm_membership_payment
4706       WHERE  contribution_id = %1 ";
4707     $params = array(1 => array($this->id, 'Integer'));
4708
4709     $dao = CRM_Core_DAO::executeQuery($query, $params);
4710     while ($dao->fetch()) {
4711       if ($dao->membership_id) {
4712         if (!is_array($ids['membership'])) {
4713           $ids['membership'] = array();
4714         }
4715         $ids['membership'][] = $dao->membership_id;
4716       }
4717     }
4718
4719     if (array_key_exists('membership', $ids) && is_array($ids['membership'])) {
4720       foreach ($ids['membership'] as $id) {
4721         if (!empty($id)) {
4722           $membership = new CRM_Member_BAO_Membership();
4723           $membership->id = $id;
4724           if (!$membership->find(TRUE)) {
4725             throw new Exception("Could not find membership record: $id");
4726           }
4727           $membership->join_date = CRM_Utils_Date::isoToMysql($membership->join_date);
4728           $membership->start_date = CRM_Utils_Date::isoToMysql($membership->start_date);
4729           $membership->end_date = CRM_Utils_Date::isoToMysql($membership->end_date);
4730           $this->_relatedObjects['membership'][$membership->membership_type_id] = $membership;
4731           $membership->free();
4732         }
4733       }
4734     }
4735   }
4736
4737   /**
4738    * This function is used to record partial payments for contribution
4739    *
4740    * @param array $contribution
4741    *
4742    * @param array $params
4743    *
4744    * @return object
4745    */
4746   public static function recordPartialPayment($contribution, $params) {
4747     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
4748     $pendingStatus = array(
4749       array_search('Pending', $contributionStatuses),
4750       array_search('In Progress', $contributionStatuses),
4751     );
4752     $statusId = array_search('Completed', $contributionStatuses);
4753     if (in_array(CRM_Utils_Array::value('contribution_status_id', $contribution), $pendingStatus)) {
4754       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
4755       $balanceTrxnParams['to_financial_account_id'] = CRM_Contribute_PseudoConstant::financialAccountType($contribution['financial_type_id'], $relationTypeId);
4756     }
4757     elseif (!empty($params['payment_processor'])) {
4758       $balanceTrxnParams['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getFinancialAccount($contribution['payment_processor'], 'civicrm_payment_processor', 'financial_account_id');
4759     }
4760     elseif (!empty($params['payment_instrument_id'])) {
4761       $balanceTrxnParams['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($contribution['payment_instrument_id']);
4762     }
4763     else {
4764       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
4765       $queryParams = array(1 => array($relationTypeId, 'Integer'));
4766       $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);
4767     }
4768     $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
4769     $fromFinancialAccountId = CRM_Contribute_PseudoConstant::financialAccountType($contribution['financial_type_id'], $relationTypeId);
4770     $balanceTrxnParams['from_financial_account_id'] = $fromFinancialAccountId;
4771     $balanceTrxnParams['total_amount'] = $params['total_amount'];
4772     $balanceTrxnParams['contribution_id'] = $params['contribution_id'];
4773     $balanceTrxnParams['trxn_date'] = !empty($params['contribution_receive_date']) ? $params['contribution_receive_date'] : date('YmdHis');
4774     $balanceTrxnParams['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
4775     $balanceTrxnParams['net_amount'] = CRM_Utils_Array::value('total_amount', $params);
4776     $balanceTrxnParams['currency'] = $contribution['currency'];
4777     $balanceTrxnParams['trxn_id'] = CRM_Utils_Array::value('contribution_trxn_id', $params, NULL);
4778     $balanceTrxnParams['status_id'] = $statusId;
4779     $balanceTrxnParams['payment_instrument_id'] = CRM_Utils_Array::value('payment_instrument_id', $params, $contribution['payment_instrument_id']);
4780     $balanceTrxnParams['check_number'] = CRM_Utils_Array::value('check_number', $params);
4781     if ($fromFinancialAccountId != NULL &&
4782       ($statusId == array_search('Completed', $contributionStatuses) || $statusId == array_search('Partially paid', $contributionStatuses))
4783     ) {
4784       $balanceTrxnParams['is_payment'] = 1;
4785     }
4786     if (!empty($params['payment_processor'])) {
4787       $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
4788     }
4789     return CRM_Core_BAO_FinancialTrxn::create($balanceTrxnParams);
4790   }
4791
4792   /**
4793    * Get the description (source field) for the recurring contribution.
4794    *
4795    * @param CRM_Contribute_BAO_Contribution $contribution
4796    * @param CRM_Event_DAO_Event|null $event
4797    *
4798    * @return array
4799    * @throws \CiviCRM_API3_Exception
4800    */
4801   protected static function getRecurringContributionDescription($contribution, $event) {
4802     if (!empty($contribution->source)) {
4803       return $contribution->source;
4804     }
4805     elseif (!empty($contribution->contribution_page_id)) {
4806       $contributionPageTitle = civicrm_api3('ContributionPage', 'getvalue', array(
4807         'id' => $contribution->contribution_page_id,
4808         'return' => 'title',
4809       ));
4810       return ts('Online Contribution') . ': ' . $contributionPageTitle;
4811     }
4812     elseif ($event) {
4813       return ts('Online Event Registration') . ': ' . $event->title;
4814     }
4815     return 'recurring contribution';
4816   }
4817
4818   /**
4819    * Function to add payments for contribution
4820    * for Partially Paid status
4821    *
4822    * @param array $lineItems
4823    * @param array $contributions
4824    *
4825    */
4826   public static function addPayments($lineItems, $contributions) {
4827     // get financial trxn which is a payment
4828     $ftSql = "SELECT ft.id, ft.total_amount
4829       FROM civicrm_financial_trxn ft
4830       INNER JOIN civicrm_entity_financial_trxn eft ON eft.financial_trxn_id = ft.id AND eft.entity_table = 'civicrm_contribution'
4831       WHERE eft.entity_id = %1 AND ft.is_payment = 1 ORDER BY ft.id DESC LIMIT 1";
4832     $sql = "SELECT fi.id, li.price_field_value_id
4833       FROM civicrm_financial_item fi
4834       INNER JOIN civicrm_line_item li ON li.id = fi.entity_id
4835       WHERE li.contribution_id = %1";
4836
4837     foreach ($contributions as $k => $contribution) {
4838       if ($contribution->contribution_status_id != CRM_Core_OptionGroup::getValue('contribution_status', 'Partially paid', 'name')) {
4839         continue;
4840       }
4841       $ftDao = CRM_Core_DAO::executeQuery($ftSql, array(1 => array($contribution->id, 'Integer')));
4842       $ftDao->fetch();
4843       $trxnAmount = $ftDao->total_amount;
4844       $ftId = $ftDao->id;
4845
4846       // get financial item
4847       $dao = CRM_Core_DAO::executeQuery($sql, array(1 => array($contribution->id, 'Integer')));
4848       while ($dao->fetch()) {
4849         $ftIds[$dao->price_field_value_id] = $dao->id;
4850       }
4851
4852       $params = array(
4853         'entity_table' => 'civicrm_financial_item',
4854         'financial_trxn_id' => $ftId,
4855       );
4856       foreach ($lineItems as $key => $value) {
4857         $paid = $value['line_total'] * ($trxnAmount / $contribution->total_amount);
4858         // Record Entity Financial Trxn
4859         $params['amount'] = round($paid, 2);
4860         $params['entity_id'] = $ftIds[$value['price_field_value_id']];
4861
4862         civicrm_api3('EntityFinancialTrxn', 'create', $params);
4863       }
4864     }
4865   }
4866
4867   /**
4868    * Function use to store line item proportionaly in
4869    * in entity financial trxn table
4870    *
4871    * @param array $params
4872    *  array of contribution params.
4873    * @param object $trxn
4874    *  CRM_Financial_DAO_FinancialTrxn object
4875    * @param array $contribution
4876    *
4877    */
4878   public static function assignProportionalLineItems($params, $trxn, $contribution) {
4879     $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($params['contribution_id']);
4880     if (!empty($lineItems)) {
4881       // get financial item
4882       $sql = "SELECT fi.id, li.price_field_value_id
4883       FROM civicrm_financial_item fi
4884       INNER JOIN civicrm_line_item li ON li.id = fi.entity_id and fi.entity_table = 'civicrm_line_item'
4885       WHERE li.contribution_id = %1";
4886       $dao = CRM_Core_DAO::executeQuery($sql, array(1 => array($params['contribution_id'], 'Integer')));
4887       while ($dao->fetch()) {
4888         $ftIds[$dao->price_field_value_id] = $dao->id;
4889       }
4890       $eftParams = array(
4891         'entity_table' => 'civicrm_financial_item',
4892         'financial_trxn_id' => $trxn->id,
4893       );
4894       foreach ($lineItems as $key => $value) {
4895         $paid = $value['line_total'] * ($params['total_amount'] / $contribution['total_amount']);
4896         // Record Entity Financial Trxn
4897         $eftParams['amount'] = round($paid, 2);
4898         $eftParams['entity_id'] = $ftIds[$value['price_field_value_id']];
4899
4900         civicrm_api3('EntityFinancialTrxn', 'create', $eftParams);
4901       }
4902     }
4903   }
4904
4905   /**
4906    * Function to check line items
4907    *
4908    * @param array $params
4909    *  array of order params.
4910    *
4911    */
4912   public static function checkLineItems(&$params) {
4913     $totalAmount = CRM_Utils_Array::value('total_amount', $params);
4914     $lineItemAmount = 0;
4915     foreach ($params['line_items'] as &$lineItems) {
4916       foreach ($lineItems['line_item'] as &$item) {
4917         if (empty($item['financial_type_id'])) {
4918           $item['financial_type_id'] = $params['financial_type_id'];
4919         }
4920         $lineItemAmount += $item['line_total'];
4921       }
4922     }
4923     if (!isset($totalAmount)) {
4924       $params['total_amount'] = $lineItemAmount;
4925     }
4926     elseif ($totalAmount != $lineItemAmount) {
4927       throw new API_Exception("Line item total doesn't match with total amount.");
4928     }
4929   }
4930
4931   /**
4932    * Get the financial account for the item associated with the new transaction.
4933    *
4934    * @param array $params
4935    * @param CRM_Financial_BAO_FinancialItem $prevFinancialItem
4936    *
4937    * @return int
4938    */
4939   public static function getFinancialAccountForStatusChangeTrxn($params, $prevFinancialItem) {
4940
4941     if (!empty($params['financial_account_id'])) {
4942       return $params['financial_account_id'];
4943     }
4944     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus($params['contribution_status_id'], 'name');
4945     $preferredAccountsRelationships = array(
4946       'Refunded' => 'Credit/Contra Revenue Account is',
4947       'Chargeback' => 'Chargeback Account is',
4948     );
4949     if (in_array($contributionStatus, array_keys($preferredAccountsRelationships))) {
4950       $financialTypeID = !empty($params['financial_type_id']) ? $params['financial_type_id'] : $params['prevContribution']->financial_type_id;
4951       return CRM_Financial_BAO_FinancialAccount::getFinancialAccountForFinancialTypeByRelationship(
4952         $financialTypeID,
4953         $preferredAccountsRelationships[$contributionStatus]
4954       );
4955     }
4956     return $prevFinancialItem->financial_account_id;
4957   }
4958
4959 }