CRM/Contribute/BAO/Contribution.php

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