CRM/Contribute/BAO/Contribution.php

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