CRM/Contribute/BAO/Contribution.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35 class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution {
  36
  37   /**
  38    * static field for all the contribution information that we can potentially import
  39    *
  40    * @var array
  41    * @static
  42    */
  43   static $_importableFields = NULL;
  44
  45   /**
  46    * static field for all the contribution information that we can potentially export
  47    *
  48    * @var array
  49    * @static
  50    */
  51   static $_exportableFields = NULL;
  52
  53   /**
  54    * field for all the objects related to this contribution
  55    * @var array of objects (e.g membership object, participant object)
  56    */
  57   public $_relatedObjects = array();
  58
  59   /**
  60    * field for the component - either 'event' (participant) or 'contribute'
  61    * (any item related to a contribution page e.g. membership, pledge, contribution)
  62    * This is used for composing messages because they have dependency on the
  63    * contribution_page or event page - although over time we may eliminate that
  64    *
  65    * @var string component or event
  66    */
  67   public $_component = NULL;
  68
  69   /*
  70    * construct method
  71    */
  72   function __construct() {
  73     parent::__construct();
  74   }
  75
  76   /**
  77    * takes an associative array and creates a contribution object
  78    *
  79    * the function extract all the params it needs to initialize the create a
  80    * contribution object. the params array could contain additional unused name/value
  81    * pairs
  82    *
  83    * @param array  $params (reference ) an assoc array of name/value pairs
  84    * @param array $ids    the array that holds all the db ids
  85    *
  86    * @return object CRM_Contribute_BAO_Contribution object
  87    * @access public
  88    * @static
  89    */
  90   static function add(&$params, $ids = array()) {
  91     if (empty($params)) {
  92       return;
  93     }
  94     //per http://wiki.civicrm.org/confluence/display/CRM/Database+layer we are moving away from $ids array
  95     $contributionID = CRM_Utils_Array::value('contribution', $ids, CRM_Utils_Array::value('id', $params));
  96
  97     $duplicates = array();
  98     if (self::checkDuplicate($params, $duplicates, $contributionID)) {
  99       $error = CRM_Core_Error::singleton();
 100       $d = implode(', ', $duplicates);
 101       $error->push(CRM_Core_Error::DUPLICATE_CONTRIBUTION,
 102         'Fatal',
 103         array($d),
 104         "Duplicate error - existing contribution record(s) have a matching Transaction ID or Invoice ID. Contribution record ID(s) are: $d"
 105       );
 106       return $error;
 107     }
 108
 109     // first clean up all the money fields
 110     $moneyFields = array(
 111       'total_amount',
 112       'net_amount',
 113       'fee_amount',
 114       'non_deductible_amount',
 115     );
 116
 117     //if priceset is used, no need to cleanup money
 118     if (!empty($params['skipCleanMoney'])) {
 119       unset($moneyFields[0]);
 120     }
 121
 122     foreach ($moneyFields as $field) {
 123       if (isset($params[$field])) {
 124         $params[$field] = CRM_Utils_Rule::cleanMoney($params[$field]);
 125       }
 126     }
 127
 128     // CRM-13420, set payment instrument to default if payment_instrument_id is empty
 129     if (!$contributionID && empty($params['payment_instrument_id'])) {
 130       $params['payment_instrument_id'] = key(CRM_Core_OptionGroup::values('payment_instrument',
 131         FALSE, FALSE, FALSE, 'AND is_default = 1'));
 132     }
 133
 134     if (!empty($params['payment_instrument_id'])) {
 135       $paymentInstruments = CRM_Contribute_PseudoConstant::paymentInstrument('name');
 136       if ($params['payment_instrument_id'] != array_search('Check', $paymentInstruments)) {
 137         $params['check_number'] = 'null';
 138       }
 139     }
 140
 141     // contribution status is missing, choose Completed as default status
 142     // do this for create mode only
 143     if (empty($ids['contribution']) && empty($params['contribution_status_id'])) {
 144       $params['contribution_status_id'] = CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name');
 145     }
 146     $setPrevContribution = TRUE;
 147     // CRM-13964 partial payment
 148     if (!empty($params['partial_payment_total']) && !empty($params['partial_amount_pay'])) {
 149       $partialAmtTotal = $params['partial_payment_total'];
 150       $partialAmtPay = $params['partial_amount_pay'];
 151       $params['total_amount'] = $partialAmtTotal;
 152       if ($partialAmtPay < $partialAmtTotal) {
 153         $params['contribution_status_id'] = CRM_Core_OptionGroup::getValue('contribution_status', 'Partially paid', 'name');
 154         $params['is_pay_later'] = 0;
 155         $setPrevContribution = FALSE;
 156       }
 157     }
 158
 159     if ($contributionID) {
 160       CRM_Utils_Hook::pre('edit', 'Contribution', $contributionID, $params);
 161     }
 162     else {
 163       CRM_Utils_Hook::pre('create', 'Contribution', NULL, $params);
 164     }
 165     $contribution = new CRM_Contribute_BAO_Contribution();
 166     $contribution->copyValues($params);
 167
 168     $contribution->id = $contributionID;
 169
 170     if (!CRM_Utils_Rule::currencyCode($contribution->currency)) {
 171       $config = CRM_Core_Config::singleton();
 172       $contribution->currency = $config->defaultCurrency;
 173     }
 174
 175     if ($contributionID && $setPrevContribution) {
 176       $params['prevContribution'] = self::getValues(array('id' => $contributionID), CRM_Core_DAO::$_nullArray, CRM_Core_DAO::$_nullArray);
 177     }
 178
 179     $result = $contribution->save();
 180
 181     // Add financial_trxn details as part of fix for CRM-4724
 182     $contribution->trxn_result_code = CRM_Utils_Array::value('trxn_result_code', $params);
 183     $contribution->payment_processor = CRM_Utils_Array::value('payment_processor', $params);
 184
 185     //add Account details
 186     $params['contribution'] = $contribution;
 187     self::recordFinancialAccounts($params);
 188
 189     // reset the group contact cache for this group
 190     CRM_Contact_BAO_GroupContactCache::remove();
 191
 192     if ($contributionID) {
 193       CRM_Utils_Hook::post('edit', 'Contribution', $contribution->id, $contribution);
 194     }
 195     else {
 196       CRM_Utils_Hook::post('create', 'Contribution', $contribution->id, $contribution);
 197     }
 198
 199     return $result;
 200   }
 201
 202   /**
 203    * Given the list of params in the params array, fetch the object
 204    * and store the values in the values array
 205    *
 206    * @param array $params input parameters to find object
 207    * @param array $values output values of the object
 208    * @param array $ids    the array that holds all the db ids
 209    *
 210    * @return CRM_Contribute_BAO_Contribution|null the found object or null
 211    * @access public
 212    * @static
 213    */
 214   static function &getValues($params, &$values, &$ids) {
 215     if (empty($params)) {
 216       return NULL;
 217     }
 218     $contribution = new CRM_Contribute_BAO_Contribution();
 219
 220     $contribution->copyValues($params);
 221
 222     if ($contribution->find(TRUE)) {
 223       $ids['contribution'] = $contribution->id;
 224
 225       CRM_Core_DAO::storeValues($contribution, $values);
 226
 227       return $contribution;
 228     }
 229     return NULL;
 230   }
 231
 232   /**
 233    * takes an associative array and creates a contribution object
 234    *
 235    * @param array $params (reference ) an assoc array of name/value pairs
 236    * @param array $ids    the array that holds all the db ids
 237    *
 238    * @return object CRM_Contribute_BAO_Contribution object
 239    * @access public
 240    * @static
 241    */
 242   static function create(&$params, $ids = array()) {
 243     $dateFields = array('receive_date', 'cancel_date', 'receipt_date', 'thankyou_date');
 244     foreach ($dateFields as $df) {
 245       if (isset($params[$df])) {
 246         $params[$df] = CRM_Utils_Date::isoToMysql($params[$df]);
 247       }
 248     }
 249
 250     $transaction = new CRM_Core_Transaction();
 251
 252     $contribution = self::add($params, $ids);
 253
 254     if (is_a($contribution, 'CRM_Core_Error')) {
 255       $transaction->rollback();
 256       return $contribution;
 257     }
 258
 259     $params['contribution_id'] = $contribution->id;
 260
 261     if (!empty($params['custom']) &&
 262       is_array($params['custom'])
 263     ) {
 264       CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_contribution', $contribution->id);
 265     }
 266
 267     $session = CRM_Core_Session::singleton();
 268
 269     if (!empty($params['note'])) {
 270       $noteParams = array(
 271         'entity_table' => 'civicrm_contribution',
 272         'note' => $params['note'],
 273         'entity_id' => $contribution->id,
 274         'contact_id' => $session->get('userID'),
 275         'modified_date' => date('Ymd'),
 276       );
 277       if (!$noteParams['contact_id']) {
 278         $noteParams['contact_id'] = $params['contact_id'];
 279       }
 280       CRM_Core_BAO_Note::add($noteParams);
 281     }
 282
 283     // make entry in batch entity batch table
 284     if (!empty($params['batch_id'])) {
 285       // in some update cases we need to get extra fields - ie an update that doesn't pass in all these params
 286       $titleFields = array(
 287         'contact_id',
 288         'total_amount',
 289         'currency',
 290         'financial_type_id',
 291       );
 292       $retrieveRequired = 0;
 293       foreach ($titleFields as $titleField) {
 294         if(!isset($contribution->$titleField)){
 295           $retrieveRequired = 1;
 296           break;
 297         }
 298       }
 299       if ($retrieveRequired == 1) {
 300         $contribution->find(TRUE);
 301       }
 302     }
 303
 304     // check if activity record exist for this contribution, if
 305     // not add activity
 306     $activity = new CRM_Activity_DAO_Activity();
 307     $activity->source_record_id = $contribution->id;
 308     $activity->activity_type_id = CRM_Core_OptionGroup::getValue('activity_type',
 309       'Contribution',
 310       'name'
 311     );
 312     if (!$activity->find(TRUE)) {
 313       CRM_Activity_BAO_Activity::addActivity($contribution, 'Offline');
 314     }
 315     else {
 316       // CRM-13237 : if activity record found, update it with campaign id of contribution
 317       CRM_Core_DAO::setFieldValue('CRM_Activity_BAO_Activity', $activity->id, 'campaign_id', $contribution->campaign_id);
 318     }
 319
 320     // Handle soft credit and / or link to personal campaign page
 321     $softIDs = CRM_Contribute_BAO_ContributionSoft::getSoftCreditIds($contribution->id);
 322
 323     //Delete PCP against this contribution and create new on submitted PCP information
 324     $pcpId = CRM_Contribute_BAO_ContributionSoft::getSoftCreditIds($contribution->id, TRUE);
 325     if ($pcpId) {
 326       $deleteParams = array('id' => $pcpId);
 327       CRM_Contribute_BAO_ContributionSoft::del($deleteParams);
 328     }
 329     if ($pcp = CRM_Utils_Array::value('pcp', $params)) {
 330       $softParams = array();
 331       $softParams['contribution_id'] = $contribution->id;
 332       $softParams['pcp_id'] = $pcp['pcp_made_through_id'];
 333       $softParams['contact_id'] = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP',
 334         $pcp['pcp_made_through_id'], 'contact_id'
 335       );
 336       $softParams['currency'] = $contribution->currency;
 337       $softParams['amount'] = $contribution->total_amount;
 338       $softParams['pcp_display_in_roll'] = CRM_Utils_Array::value('pcp_display_in_roll', $pcp);
 339       $softParams['pcp_roll_nickname'] = CRM_Utils_Array::value('pcp_roll_nickname', $pcp);
 340       $softParams['pcp_personal_note'] = CRM_Utils_Array::value('pcp_personal_note', $pcp);
 341       $softParams['soft_credit_type_id'] = CRM_Core_OptionGroup::getValue('soft_credit_type', 'pcp', 'name');
 342       CRM_Contribute_BAO_ContributionSoft::add($softParams);
 343     }
 344     if (isset($params['soft_credit'])) {
 345       $softParams = $params['soft_credit'];
 346
 347       if (!empty($softIDs)) {
 348         foreach ( $softIDs as $softID) {
 349           if (!in_array($softID, $params['soft_credit_ids'])) {
 350             $deleteParams = array('id' => $softID);
 351             CRM_Contribute_BAO_ContributionSoft::del($deleteParams);
 352           }
 353         }
 354       }
 355
 356       foreach ($softParams as $softParam) {
 357         $softParam['contribution_id'] = $contribution->id;
 358         $softParam['currency'] = $contribution->currency;
 359         //case during Contribution Import when we assign soft contribution amount as contribution's total_amount by default
 360         if (empty($softParam['amount'])) {
 361           $softParam['amount'] = $contribution->total_amount;
 362         }
 363         CRM_Contribute_BAO_ContributionSoft::add($softParam);
 364       }
 365     }
 366
 367     $transaction->commit();
 368
 369     // do not add to recent items for import, CRM-4399
 370     if (empty($params['skipRecentView'])) {
 371       $url = CRM_Utils_System::url('civicrm/contact/view/contribution',
 372         "action=view&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
 373       );
 374       // in some update cases we need to get extra fields - ie an update that doesn't pass in all these params
 375       $titleFields = array(
 376         'contact_id',
 377         'total_amount',
 378         'currency',
 379         'financial_type_id',
 380       );
 381       $retrieveRequired = 0;
 382       foreach ($titleFields as $titleField) {
 383         if(!isset($contribution->$titleField)){
 384           $retrieveRequired = 1;
 385           break;
 386         }
 387       }
 388       if($retrieveRequired == 1){
 389         $contribution->find(TRUE);
 390       }
 391       $contributionTypes = CRM_Contribute_PseudoConstant::financialType();
 392       $title = CRM_Contact_BAO_Contact::displayName($contribution->contact_id) . ' - (' . CRM_Utils_Money::format($contribution->total_amount, $contribution->currency) . ' ' . ' - ' . $contributionTypes[$contribution->financial_type_id] . ')';
 393
 394       $recentOther = array();
 395       if (CRM_Core_Permission::checkActionPermission('CiviContribute', CRM_Core_Action::UPDATE)) {
 396         $recentOther['editUrl'] = CRM_Utils_System::url('civicrm/contact/view/contribution',
 397           "action=update&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
 398         );
 399       }
 400
 401       if (CRM_Core_Permission::checkActionPermission('CiviContribute', CRM_Core_Action::DELETE)) {
 402         $recentOther['deleteUrl'] = CRM_Utils_System::url('civicrm/contact/view/contribution',
 403           "action=delete&reset=1&id={$contribution->id}&cid={$contribution->contact_id}&context=home"
 404         );
 405       }
 406
 407       // add the recently created Contribution
 408       CRM_Utils_Recent::add($title,
 409         $url,
 410         $contribution->id,
 411         'Contribution',
 412         $contribution->contact_id,
 413         NULL,
 414         $recentOther
 415       );
 416     }
 417
 418     return $contribution;
 419   }
 420
 421   /**
 422    * Get the values for pseudoconstants for name->value and reverse.
 423    *
 424    * @param array   $defaults (reference) the default values, some of which need to be resolved.
 425    * @param boolean $reverse  true if we want to resolve the values in the reverse direction (value -> name)
 426    *
 427    * @return void
 428    * @access public
 429    * @static
 430    */
 431   static function resolveDefaults(&$defaults, $reverse = FALSE) {
 432     self::lookupValue($defaults, 'financial_type', CRM_Contribute_PseudoConstant::financialType(), $reverse);
 433     self::lookupValue($defaults, 'payment_instrument', CRM_Contribute_PseudoConstant::paymentInstrument(), $reverse);
 434     self::lookupValue($defaults, 'contribution_status', CRM_Contribute_PseudoConstant::contributionStatus(), $reverse);
 435     self::lookupValue($defaults, 'pcp', CRM_Contribute_PseudoConstant::pcPage(), $reverse);
 436   }
 437
 438   /**
 439    * This function is used to convert associative array names to values
 440    * and vice-versa.
 441    *
 442    * This function is used by both the web form layer and the api. Note that
 443    * the api needs the name => value conversion, also the view layer typically
 444    * requires value => name conversion
 445    */
 446   static function lookupValue(&$defaults, $property, &$lookup, $reverse) {
 447     $id = $property . '_id';
 448
 449     $src = $reverse ? $property : $id;
 450     $dst = $reverse ? $id : $property;
 451
 452     if (!array_key_exists($src, $defaults)) {
 453       return FALSE;
 454     }
 455
 456     $look = $reverse ? array_flip($lookup) : $lookup;
 457
 458     if (is_array($look)) {
 459       if (!array_key_exists($defaults[$src], $look)) {
 460         return FALSE;
 461       }
 462     }
 463     $defaults[$dst] = $look[$defaults[$src]];
 464     return TRUE;
 465   }
 466
 467   /**
 468    * Takes a bunch of params that are needed to match certain criteria and
 469    * retrieves the relevant objects. We'll tweak this function to be more
 470    * full featured over a period of time. This is the inverse function of
 471    * create.  It also stores all the retrieved values in the default array
 472    *
 473    * @param array $params   (reference ) an assoc array of name/value pairs
 474    * @param array $defaults (reference ) an assoc array to hold the name / value pairs
 475    *                        in a hierarchical manner
 476    * @param array $ids      (reference) the array that holds all the db ids
 477    *
 478    * @return object CRM_Contribute_BAO_Contribution object
 479    * @access public
 480    * @static
 481    */
 482   static function retrieve(&$params, &$defaults, &$ids) {
 483     $contribution = CRM_Contribute_BAO_Contribution::getValues($params, $defaults, $ids);
 484     return $contribution;
 485   }
 486
 487   /**
 488    * combine all the importable fields from the lower levels object
 489    *
 490    * The ordering is important, since currently we do not have a weight
 491    * scheme. Adding weight is super important and should be done in the
 492    * next week or so, before this can be called complete.
 493    *
 494    * @param string $contactType
 495    * @param bool $status
 496    *
 497    * @return array array of importable Fields
 498    * @access public
 499    * @static
 500    */
 501   static function &importableFields($contactType = 'Individual', $status = TRUE) {
 502     if (!self::$_importableFields) {
 503       if (!self::$_importableFields) {
 504         self::$_importableFields = array();
 505       }
 506
 507       if (!$status) {
 508         $fields = array('' => array('title' => ts('- do not import -')));
 509       }
 510       else {
 511         $fields = array('' => array('title' => ts('- Contribution Fields -')));
 512       }
 513
 514       $note = CRM_Core_DAO_Note::import();
 515       $tmpFields = CRM_Contribute_DAO_Contribution::import();
 516       unset($tmpFields['option_value']);
 517       $optionFields = CRM_Core_OptionValue::getFields($mode = 'contribute');
 518       $contactFields = CRM_Contact_BAO_Contact::importableFields($contactType, NULL);
 519
 520       // Using new Dedupe rule.
 521       $ruleParams = array(
 522         'contact_type' => $contactType,
 523         'used'         => 'Unsupervised',
 524       );
 525       $fieldsArray = CRM_Dedupe_BAO_Rule::dedupeRuleFields($ruleParams);
 526       $tmpContactField = array();
 527       if (is_array($fieldsArray)) {
 528         foreach ($fieldsArray as $value) {
 529           //skip if there is no dupe rule
 530           if ($value == 'none') {
 531             continue;
 532           }
 533           $customFieldId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_CustomField',
 534             $value,
 535             'id',
 536             'column_name'
 537           );
 538           $value = $customFieldId ? 'custom_' . $customFieldId : $value;
 539           $tmpContactField[trim($value)] = $contactFields[trim($value)];
 540           if (!$status) {
 541             $title = $tmpContactField[trim($value)]['title'] . ' ' . ts('(match to contact)');
 542           }
 543           else {
 544             $title = $tmpContactField[trim($value)]['title'];
 545           }
 546           $tmpContactField[trim($value)]['title'] = $title;
 547         }
 548       }
 549
 550       $tmpContactField['external_identifier'] = $contactFields['external_identifier'];
 551       $tmpContactField['external_identifier']['title'] = $contactFields['external_identifier']['title'] . ' ' . ts('(match to contact)');
 552       $tmpFields['contribution_contact_id']['title'] = $tmpFields['contribution_contact_id']['title'] . ' ' . ts('(match to contact)');
 553       $fields = array_merge($fields, $tmpContactField);
 554       $fields = array_merge($fields, $tmpFields);
 555       $fields = array_merge($fields, $note);
 556       $fields = array_merge($fields, $optionFields);
 557       $fields = array_merge($fields, CRM_Financial_DAO_FinancialType::export());
 558       $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Contribution'));
 559       self::$_importableFields = $fields;
 560     }
 561     return self::$_importableFields;
 562   }
 563
 564   static function &exportableFields() {
 565     if (!self::$_exportableFields) {
 566       if (!self::$_exportableFields) {
 567         self::$_exportableFields = array();
 568       }
 569
 570       $impFields          = CRM_Contribute_DAO_Contribution::export();
 571       $expFieldProduct    = CRM_Contribute_DAO_Product::export();
 572       $expFieldsContrib   = CRM_Contribute_DAO_ContributionProduct::export();
 573       $typeField          = CRM_Financial_DAO_FinancialType::export();
 574       $financialAccount   = CRM_Financial_DAO_FinancialAccount::export();
 575       $optionField        = CRM_Core_OptionValue::getFields($mode = 'contribute');
 576       $contributionStatus = array(
 577         'contribution_status' => array(
 578           'title' => ts('Contribution Status'),
 579           'name' => 'contribution_status',
 580           'data_type' => CRM_Utils_Type::T_STRING
 581         ));
 582
 583       $contributionNote = array(
 584         'contribution_note' =>
 585         array(
 586           'title' => ts('Contribution Note'),
 587           'name' => 'contribution_note',
 588           'data_type' => CRM_Utils_Type::T_TEXT
 589         )
 590       );
 591
 592       $contributionRecurId = array(
 593         'contribution_recur_id' =>
 594         array(
 595           'title' => ts('Recurring Contributions ID'),
 596           'name' => 'contribution_recur_id',
 597           'where' => 'civicrm_contribution.contribution_recur_id',
 598           'data_type' => CRM_Utils_Type::T_INT
 599         ));
 600
 601       $extraFields = array(
 602         'contribution_batch' => array(
 603           'title' => ts('Batch Name')
 604         )
 605       );
 606
 607       $softCreditFields = array(
 608         'contribution_soft_credit_name' => array(
 609           'name' => 'contribution_soft_credit_name',
 610           'title' => 'Soft Credit For',
 611           'where' => 'civicrm_contact_d.display_name',
 612           'data_type' => CRM_Utils_Type::T_STRING
 613         ),
 614         'contribution_soft_credit_amount' => array(
 615           'name' => 'contribution_soft_credit_amount',
 616           'title' => 'Soft Credit Amount',
 617           'where' => 'civicrm_contribution_soft.amount',
 618           'data_type' => CRM_Utils_Type::T_MONEY
 619         ),
 620         'contribution_soft_credit_type' => array(
 621           'name' => 'contribution_soft_credit_type',
 622           'title' => 'Soft Credit Type',
 623           'where' => 'contribution_softcredit_type.label',
 624           'data_type' => CRM_Utils_Type::T_STRING
 625         ),
 626         'contribution_soft_credit_contribution_id' => array(
 627           'name' => 'contribution_soft_credit_contribution_id',
 628           'title' => 'Soft Credit For Contribution ID',
 629           'where' => 'civicrm_contribution_soft.contribution_id',
 630           'data_type' => CRM_Utils_Type::T_INT
 631         ),
 632       );
 633
 634       $fields = array_merge($impFields, $typeField, $contributionStatus, $optionField, $expFieldProduct,
 635         $expFieldsContrib, $contributionNote, $contributionRecurId, $extraFields, $softCreditFields, $financialAccount,
 636         CRM_Core_BAO_CustomField::getFieldsForImport('Contribution')
 637       );
 638
 639       self::$_exportableFields = $fields;
 640     }
 641
 642     return self::$_exportableFields;
 643   }
 644
 645   static function getTotalAmountAndCount($status = NULL, $startDate = NULL, $endDate = NULL) {
 646     $where = array();
 647     switch ($status) {
 648       case 'Valid':
 649         $where[] = 'contribution_status_id = 1';
 650         break;
 651
 652       case 'Cancelled':
 653         $where[] = 'contribution_status_id = 3';
 654         break;
 655     }
 656
 657     if ($startDate) {
 658       $where[] = "receive_date >= '" . CRM_Utils_Type::escape($startDate, 'Timestamp') . "'";
 659     }
 660     if ($endDate) {
 661       $where[] = "receive_date <= '" . CRM_Utils_Type::escape($endDate, 'Timestamp') . "'";
 662     }
 663
 664     $whereCond = implode(' AND ', $where);
 665
 666     $query = "
 667     SELECT  sum( total_amount ) as total_amount,
 668             count( civicrm_contribution.id ) as total_count,
 669             currency
 670       FROM  civicrm_contribution
 671 INNER JOIN  civicrm_contact contact ON ( contact.id = civicrm_contribution.contact_id )
 672      WHERE  $whereCond
 673        AND  ( is_test = 0 OR is_test IS NULL )
 674        AND  contact.is_deleted = 0
 675   GROUP BY  currency
 676 ";
 677
 678     $dao    = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
 679     $amount = array();
 680     $count  = 0;
 681     while ($dao->fetch()) {
 682       $count += $dao->total_count;
 683       $amount[] = CRM_Utils_Money::format($dao->total_amount, $dao->currency);
 684     }
 685     if ($count) {
 686       return array('amount' => implode(', ', $amount),
 687         'count' => $count,
 688       );
 689     }
 690     return NULL;
 691   }
 692
 693   /**
 694    * Delete the indirect records associated with this contribution first
 695    *
 696    * @param $id
 697    *
 698    * @return mixed|null $results no of deleted Contribution on success, false otherwise@access public
 699    * @static
 700    */
 701   static function deleteContribution($id) {
 702     CRM_Utils_Hook::pre('delete', 'Contribution', $id, CRM_Core_DAO::$_nullArray);
 703
 704     $transaction = new CRM_Core_Transaction();
 705
 706     $results = NULL;
 707     //delete activity record
 708     $params = array(
 709       'source_record_id' => $id,
 710       // activity type id for contribution
 711       'activity_type_id' => 6,
 712     );
 713
 714     CRM_Activity_BAO_Activity::deleteActivity($params);
 715
 716     //delete billing address if exists for this contribution.
 717     self::deleteAddress($id);
 718
 719     //update pledge and pledge payment, CRM-3961
 720     CRM_Pledge_BAO_PledgePayment::resetPledgePayment($id);
 721
 722     // remove entry from civicrm_price_set_entity, CRM-5095
 723     if (CRM_Price_BAO_PriceSet::getFor('civicrm_contribution', $id)) {
 724       CRM_Price_BAO_PriceSet::removeFrom('civicrm_contribution', $id);
 725     }
 726     // cleanup line items.
 727     $participantId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment', $id, 'participant_id', 'contribution_id');
 728
 729     // delete any related entity_financial_trxn, financial_trxn and financial_item records.
 730     CRM_Core_BAO_FinancialTrxn::deleteFinancialTrxn($id);
 731
 732     if ($participantId) {
 733       CRM_Price_BAO_LineItem::deleteLineItems($participantId, 'civicrm_participant');
 734     }
 735     else {
 736       CRM_Price_BAO_LineItem::deleteLineItems($id, 'civicrm_contribution');
 737     }
 738
 739     //delete note.
 740     $note = CRM_Core_BAO_Note::getNote($id, 'civicrm_contribution');
 741     $noteId = key($note);
 742     if ($noteId) {
 743       CRM_Core_BAO_Note::del($noteId, FALSE);
 744     }
 745
 746     $dao = new CRM_Contribute_DAO_Contribution();
 747     $dao->id = $id;
 748
 749     $results = $dao->delete();
 750
 751     $transaction->commit();
 752
 753     CRM_Utils_Hook::post('delete', 'Contribution', $dao->id, $dao);
 754
 755     // delete the recently created Contribution
 756     $contributionRecent = array(
 757       'id' => $id,
 758       'type' => 'Contribution',
 759     );
 760     CRM_Utils_Recent::del($contributionRecent);
 761
 762     return $results;
 763   }
 764
 765   /**
 766    * Check if there is a contribution with the same trxn_id or invoice_id
 767    *
 768    * @param array  $params (reference ) an assoc array of name/value pairs
 769    * @param array  $duplicates (reference ) store ids of duplicate contribs
 770    *
 771    * @return boolean true if duplicate, false otherwise
 772    * @access public
 773    * static
 774    */
 775   static function checkDuplicate($input, &$duplicates, $id = NULL) {
 776     if (!$id) {
 777       $id = CRM_Utils_Array::value('id', $input);
 778     }
 779     $trxn_id = CRM_Utils_Array::value('trxn_id', $input);
 780     $invoice_id = CRM_Utils_Array::value('invoice_id', $input);
 781
 782     $clause = array();
 783     $input = array();
 784
 785     if ($trxn_id) {
 786       $clause[] = "trxn_id = %1";
 787       $input[1] = array($trxn_id, 'String');
 788     }
 789
 790     if ($invoice_id) {
 791       $clause[] = "invoice_id = %2";
 792       $input[2] = array($invoice_id, 'String');
 793     }
 794
 795     if (empty($clause)) {
 796       return FALSE;
 797     }
 798
 799     $clause = implode(' OR ', $clause);
 800     if ($id) {
 801       $clause = "( $clause ) AND id != %3";
 802       $input[3] = array($id, 'Integer');
 803     }
 804
 805     $query  = "SELECT id FROM civicrm_contribution WHERE $clause";
 806     $dao    = CRM_Core_DAO::executeQuery($query, $input);
 807     $result = FALSE;
 808     while ($dao->fetch()) {
 809       $duplicates[] = $dao->id;
 810       $result = TRUE;
 811     }
 812     return $result;
 813   }
 814
 815   /**
 816    * takes an associative array and creates a contribution_product object
 817    *
 818    * the function extract all the params it needs to initialize the create a
 819    * contribution_product object. the params array could contain additional unused name/value
 820    * pairs
 821    *
 822    * @param array  $params (reference ) an assoc array of name/value pairs
 823    *
 824    * @return object CRM_Contribute_BAO_ContributionProduct object
 825    * @access public
 826    * @static
 827    */
 828   static function addPremium(&$params) {
 829     $contributionProduct = new CRM_Contribute_DAO_ContributionProduct();
 830     $contributionProduct->copyValues($params);
 831     return $contributionProduct->save();
 832   }
 833
 834   /**
 835    * Function to get list of contribution fields for profile
 836    * For now we only allow custom contribution fields to be in
 837    * profile
 838    *
 839    * @param boolean $addExtraFields true if special fields needs to be added
 840    *
 841    * @return return the list of contribution fields
 842    * @static
 843    * @access public
 844    */
 845   static function getContributionFields($addExtraFields = TRUE) {
 846     $contributionFields = CRM_Contribute_DAO_Contribution::export();
 847     $contributionFields = array_merge($contributionFields, CRM_Core_OptionValue::getFields($mode = 'contribute'));
 848
 849     if ($addExtraFields) {
 850       $contributionFields = array_merge($contributionFields, self::getSpecialContributionFields());
 851     }
 852
 853     $contributionFields = array_merge($contributionFields, CRM_Financial_DAO_FinancialType::export());
 854
 855     foreach ($contributionFields as $key => $var) {
 856       if ($key == 'contribution_contact_id') {
 857         continue;
 858       }
 859       elseif ($key == 'contribution_campaign_id') {
 860         $var['title'] = ts('Campaign');
 861       }
 862       $fields[$key] = $var;
 863     }
 864
 865     $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Contribution'));
 866     return $fields;
 867   }
 868
 869   /**
 870    * Function to add extra fields specific to contribtion
 871    *
 872    * @static
 873    */
 874   static function getSpecialContributionFields() {
 875     $extraFields = array(
 876       'contribution_soft_credit_name' => array(
 877         'name' => 'contribution_soft_credit_name',
 878         'title' => 'Soft Credit Name',
 879         'headerPattern' => '/^soft_credit_name$/i',
 880         'where' => 'civicrm_contact_d.display_name',
 881       ),
 882       'contribution_soft_credit_email' => array(
 883         'name' => 'contribution_soft_credit_email',
 884         'title' => 'Soft Credit Email',
 885         'headerPattern' => '/^soft_credit_email$/i',
 886         'where' => 'soft_email.email',
 887       ),
 888       'contribution_soft_credit_phone' => array(
 889         'name' => 'contribution_soft_credit_phone',
 890         'title' => 'Soft Credit Phone',
 891         'headerPattern' => '/^soft_credit_phone$/i',
 892         'where' => 'soft_phone.phone',
 893       ),
 894       'contribution_soft_credit_contact_id' => array(
 895         'name' => 'contribution_soft_credit_contact_id',
 896         'title' => 'Soft Credit Contact ID',
 897         'headerPattern' => '/^soft_credit_contact_id$/i',
 898         'where' => 'civicrm_contribution_soft.contact_id',
 899       ),
 900     );
 901
 902     return $extraFields;
 903   }
 904
 905   static function getCurrentandGoalAmount($pageID) {
 906     $query = "
 907 SELECT p.goal_amount as goal, sum( c.total_amount ) as total
 908   FROM civicrm_contribution_page p,
 909        civicrm_contribution      c
 910  WHERE p.id = c.contribution_page_id
 911    AND p.id = %1
 912    AND c.cancel_date is null
 913 GROUP BY p.id
 914 ";
 915
 916     $config = CRM_Core_Config::singleton();
 917     $params = array(1 => array($pageID, 'Integer'));
 918     $dao    = CRM_Core_DAO::executeQuery($query, $params);
 919
 920     if ($dao->fetch()) {
 921       return array($dao->goal, $dao->total);
 922     }
 923     else {
 924       return array(NULL, NULL);
 925     }
 926   }
 927
 928   /**
 929    * Function to get list of contribution In Honor of contact Ids
 930    *
 931    * @param int $honorId In Honor of Contact ID
 932    *
 933    * @return return the list of contribution fields
 934    *
 935    * @access public
 936    * @static
 937    */
 938   static function getHonorContacts($honorId) {
 939     $params = array();
 940     $honorDAO = new CRM_Contribute_DAO_ContributionSoft();
 941     $honorDAO->contact_id = $honorId;
 942     $honorDAO->find();
 943
 944     $type = CRM_Contribute_PseudoConstant::financialType();
 945
 946     while ($honorDAO->fetch()) {
 947       $contributionDAO = new CRM_Contribute_DAO_Contribution();
 948       $contributionDAO->id = $honorDAO->contribution_id;
 949
 950       if ($contributionDAO->find(TRUE)) {
 951         $params[$contributionDAO->id]['honor_type'] = CRM_Core_OptionGroup::getLabel('soft_credit_type', $honorDAO->soft_credit_type_id, 'value');
 952         $params[$contributionDAO->id]['honorId'] = $contributionDAO->contact_id;
 953         $params[$contributionDAO->id]['display_name'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contributionDAO->contact_id, 'display_name');
 954         $params[$contributionDAO->id]['type'] = $type[$contributionDAO->financial_type_id];
 955         $params[$contributionDAO->id]['type_id'] = $contributionDAO->financial_type_id;
 956         $params[$contributionDAO->id]['amount'] = CRM_Utils_Money::format($contributionDAO->total_amount, $contributionDAO->currency);
 957         $params[$contributionDAO->id]['source'] = $contributionDAO->source;
 958         $params[$contributionDAO->id]['receive_date'] = $contributionDAO->receive_date;
 959         $params[$contributionDAO->id]['contribution_status'] = CRM_Contribute_PseudoConstant::contributionStatus($contributionDAO->contribution_status_id);
 960       }
 961     }
 962
 963     return $params;
 964   }
 965
 966   /**
 967    * function to get the sort name of a contact for a particular contribution
 968    *
 969    * @param  int    $id      id of the contribution
 970    *
 971    * @return null|string     sort name of the contact if found
 972    * @static
 973    * @access public
 974    */
 975   static function sortName($id) {
 976     $id = CRM_Utils_Type::escape($id, 'Integer');
 977
 978     $query = "
 979 SELECT civicrm_contact.sort_name
 980 FROM   civicrm_contribution, civicrm_contact
 981 WHERE  civicrm_contribution.contact_id = civicrm_contact.id
 982   AND  civicrm_contribution.id = {$id}
 983 ";
 984     return CRM_Core_DAO::singleValueQuery($query, CRM_Core_DAO::$_nullArray);
 985   }
 986
 987   static function annual($contactID) {
 988     if (is_array($contactID)) {
 989       $contactIDs = implode(',', $contactID);
 990     }
 991     else {
 992       $contactIDs = $contactID;
 993     }
 994
 995     $config = CRM_Core_Config::singleton();
 996     $startDate = $endDate = NULL;
 997
 998     $currentMonth = date('m');
 999     $currentDay = date('d');
1000     if ((int ) $config->fiscalYearStart['M'] > $currentMonth ||
1001       ((int ) $config->fiscalYearStart['M'] == $currentMonth &&
1002         (int ) $config->fiscalYearStart['d'] > $currentDay
1003       )
1004     ) {
1005       $year = date('Y') - 1;
1006     }
1007     else {
1008       $year = date('Y');
1009     }
1010     $nextYear = $year + 1;
1011
1012     if ($config->fiscalYearStart) {
1013       if ($config->fiscalYearStart['M'] < 10) {
1014         $config->fiscalYearStart['M'] = '0' . $config->fiscalYearStart['M'];
1015       }
1016       if ($config->fiscalYearStart['d'] < 10) {
1017         $config->fiscalYearStart['d'] = '0' . $config->fiscalYearStart['d'];
1018       }
1019       $monthDay = $config->fiscalYearStart['M'] . $config->fiscalYearStart['d'];
1020     }
1021     else {
1022       $monthDay = '0101';
1023     }
1024     $startDate = "$year$monthDay";
1025     $endDate = "$nextYear$monthDay";
1026
1027     $query = "
1028       SELECT count(*) as count,
1029              sum(total_amount) as amount,
1030              avg(total_amount) as average,
1031              currency
1032         FROM civicrm_contribution b
1033        WHERE b.contact_id IN ( $contactIDs )
1034          AND b.contribution_status_id = 1
1035          AND b.is_test = 0
1036          AND b.receive_date >= $startDate
1037          AND b.receive_date <  $endDate
1038       GROUP BY currency
1039       ";
1040     $dao    = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
1041     $count  = 0;
1042     $amount = $average = array();
1043     while ($dao->fetch()) {
1044       if ($dao->count > 0 && $dao->amount > 0) {
1045         $count += $dao->count;
1046         $amount[] = CRM_Utils_Money::format($dao->amount, $dao->currency);
1047         $average[] = CRM_Utils_Money::format($dao->average, $dao->currency);
1048       }
1049     }
1050     if ($count > 0) {
1051       return array(
1052         $count,
1053         implode(',&nbsp;', $amount),
1054         implode(',&nbsp;', $average),
1055       );
1056     }
1057     return array(0, 0, 0);
1058   }
1059
1060   /**
1061    * Check if there is a contribution with the params passed in.
1062    * Used for trxn_id,invoice_id and contribution_id
1063    *
1064    * @param array  $params an assoc array of name/value pairs
1065    *
1066    * @return array contribution id if success else NULL
1067    * @access public
1068    * static
1069    */
1070   static function checkDuplicateIds($params) {
1071     $dao = new CRM_Contribute_DAO_Contribution();
1072
1073     $clause = array();
1074     $input = array();
1075     foreach ($params as $k => $v) {
1076       if ($v) {
1077         $clause[] = "$k = '$v'";
1078       }
1079     }
1080     $clause = implode(' AND ', $clause);
1081     $query  = "SELECT id FROM civicrm_contribution WHERE $clause";
1082     $dao    = CRM_Core_DAO::executeQuery($query, $input);
1083
1084     while ($dao->fetch()) {
1085       $result = $dao->id;
1086       return $result;
1087     }
1088     return NULL;
1089   }
1090
1091   /**
1092    * Function to get the contribution details for component export
1093    *
1094    * @param int     $exportMode export mode
1095    * @param string  $componentIds  component ids
1096    *
1097    * @return array associated array
1098    *
1099    * @static
1100    * @access public
1101    */
1102   static function getContributionDetails($exportMode, $componentIds) {
1103     $paymentDetails = array();
1104     $componentClause = ' IN ( ' . implode(',', $componentIds) . ' ) ';
1105
1106     if ($exportMode == CRM_Export_Form_Select::EVENT_EXPORT) {
1107       $componentSelect = " civicrm_participant_payment.participant_id id";
1108       $additionalClause = "
1109 INNER JOIN civicrm_participant_payment ON (civicrm_contribution.id = civicrm_participant_payment.contribution_id
1110 AND civicrm_participant_payment.participant_id {$componentClause} )
1111 ";
1112     }
1113     elseif ($exportMode == CRM_Export_Form_Select::MEMBER_EXPORT) {
1114       $componentSelect = " civicrm_membership_payment.membership_id id";
1115       $additionalClause = "
1116 INNER JOIN civicrm_membership_payment ON (civicrm_contribution.id = civicrm_membership_payment.contribution_id
1117 AND civicrm_membership_payment.membership_id {$componentClause} )
1118 ";
1119     }
1120     elseif ($exportMode == CRM_Export_Form_Select::PLEDGE_EXPORT) {
1121       $componentSelect = " civicrm_pledge_payment.id id";
1122       $additionalClause = "
1123 INNER JOIN civicrm_pledge_payment ON (civicrm_contribution.id = civicrm_pledge_payment.contribution_id
1124 AND civicrm_pledge_payment.pledge_id {$componentClause} )
1125 ";
1126     }
1127
1128     $query = " SELECT total_amount, contribution_status.name as status_id, contribution_status.label as status, payment_instrument.name as payment_instrument, receive_date,
1129                           trxn_id, {$componentSelect}
1130 FROM civicrm_contribution
1131 LEFT JOIN civicrm_option_group option_group_payment_instrument ON ( option_group_payment_instrument.name = 'payment_instrument')
1132 LEFT JOIN civicrm_option_value payment_instrument ON (civicrm_contribution.payment_instrument_id = payment_instrument.value
1133      AND option_group_payment_instrument.id = payment_instrument.option_group_id )
1134 LEFT JOIN civicrm_option_group option_group_contribution_status ON (option_group_contribution_status.name = 'contribution_status')
1135 LEFT JOIN civicrm_option_value contribution_status ON (civicrm_contribution.contribution_status_id = contribution_status.value
1136                                AND option_group_contribution_status.id = contribution_status.option_group_id )
1137 {$additionalClause}
1138 ";
1139
1140     $dao = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
1141
1142     while ($dao->fetch()) {
1143       $paymentDetails[$dao->id] = array(
1144         'total_amount' => $dao->total_amount,
1145         'contribution_status' => $dao->status,
1146         'receive_date' => $dao->receive_date,
1147         'pay_instru' => $dao->payment_instrument,
1148         'trxn_id' => $dao->trxn_id,
1149       );
1150     }
1151
1152     return $paymentDetails;
1153   }
1154
1155   /**
1156    *  Function to create address associated with contribution record.
1157    *  @param array $params an associated array
1158    *  @param int   $billingID $billingLocationTypeID
1159    *
1160    *  @return address id
1161    *  @static
1162    */
1163   static function createAddress(&$params, $billingLocationTypeID) {
1164     $billingFields = array(
1165       'street_address',
1166       'city',
1167       'state_province_id',
1168       'postal_code',
1169       'country_id',
1170     );
1171
1172     //build address array
1173     $addressParams = array();
1174     $addressParams['location_type_id'] = $billingLocationTypeID;
1175     $addressParams['is_billing'] = 1;
1176
1177     $billingFirstName = CRM_Utils_Array::value('billing_first_name', $params);
1178     $billingMiddleName = CRM_Utils_Array::value('billing_middle_name', $params);
1179     $billingLastName = CRM_Utils_Array::value('billing_last_name', $params);
1180     $addressParams['address_name'] = "{$billingFirstName}" . CRM_Core_DAO::VALUE_SEPARATOR . "{$billingMiddleName}" . CRM_Core_DAO::VALUE_SEPARATOR . "{$billingLastName}";
1181
1182     foreach ($billingFields as $value) {
1183       $addressParams[$value] = CRM_Utils_Array::value("billing_{$value}-{$billingLocationTypeID}", $params);
1184     }
1185
1186     $address = CRM_Core_BAO_Address::add($addressParams, FALSE);
1187
1188     return $address->id;
1189   }
1190
1191   /**
1192    * Delete billing address record related contribution
1193    *
1194    * @param int $contact_id contact id
1195    * @param int $contribution_id contributionId
1196    * @access public
1197    * @static
1198    */
1199   static function deleteAddress($contributionId = NULL, $contactId = NULL) {
1200     $clauses = array();
1201     $contactJoin = NULL;
1202
1203     if ($contributionId) {
1204       $clauses[] = "cc.id = {$contributionId}";
1205     }
1206
1207     if ($contactId) {
1208       $clauses[] = "cco.id = {$contactId}";
1209       $contactJoin = "INNER JOIN civicrm_contact cco ON cc.contact_id = cco.id";
1210     }
1211
1212     if (empty($clauses)) {
1213       CRM_Core_Error::fatal();
1214     }
1215
1216     $condition = implode(' OR ', $clauses);
1217
1218     $query = "
1219 SELECT     ca.id
1220 FROM       civicrm_address ca
1221 INNER JOIN civicrm_contribution cc ON cc.address_id = ca.id
1222            $contactJoin
1223 WHERE      $condition
1224 ";
1225     $dao = CRM_Core_DAO::executeQuery($query);
1226
1227     while ($dao->fetch()) {
1228       $params = array('id' => $dao->id);
1229       CRM_Core_BAO_Block::blockDelete('Address', $params);
1230     }
1231   }
1232
1233   /**
1234    * This function check online pending contribution associated w/
1235    * Online Event Registration or Online Membership signup.
1236    *
1237    * @param int    $componentId   participant/membership id.
1238    * @param string $componentName Event/Membership.
1239    *
1240    * @return $contributionId pending contribution id.
1241    * @static
1242    */
1243   static function checkOnlinePendingContribution($componentId, $componentName) {
1244     $contributionId = NULL;
1245     if (!$componentId ||
1246       !in_array($componentName, array('Event', 'Membership'))
1247     ) {
1248       return $contributionId;
1249     }
1250
1251     if ($componentName == 'Event') {
1252       $idName         = 'participant_id';
1253       $componentTable = 'civicrm_participant';
1254       $paymentTable   = 'civicrm_participant_payment';
1255       $source         = ts('Online Event Registration');
1256     }
1257
1258     if ($componentName == 'Membership') {
1259       $idName         = 'membership_id';
1260       $componentTable = 'civicrm_membership';
1261       $paymentTable   = 'civicrm_membership_payment';
1262       $source         = ts('Online Contribution');
1263     }
1264
1265     $pendingStatusId = array_search('Pending', CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name'));
1266
1267     $query = "
1268    SELECT  component.id as {$idName},
1269            componentPayment.contribution_id as contribution_id,
1270            contribution.source source,
1271            contribution.contribution_status_id as contribution_status_id,
1272            contribution.is_pay_later as is_pay_later
1273      FROM  $componentTable component
1274 LEFT JOIN  $paymentTable componentPayment    ON ( componentPayment.{$idName} = component.id )
1275 LEFT JOIN  civicrm_contribution contribution ON ( componentPayment.contribution_id = contribution.id )
1276     WHERE  component.id = {$componentId}";
1277
1278     $dao = CRM_Core_DAO::executeQuery($query);
1279
1280     while ($dao->fetch()) {
1281       if ($dao->contribution_id &&
1282         $dao->is_pay_later &&
1283         $dao->contribution_status_id == $pendingStatusId &&
1284         strpos($dao->source, $source) !== FALSE
1285       ) {
1286         $contributionId = $dao->contribution_id;
1287         $dao->free();
1288       }
1289     }
1290
1291     return $contributionId;
1292   }
1293
1294   /**
1295    * This function update contribution as well as related objects.
1296    */
1297   static function transitionComponents($params, $processContributionObject = FALSE) {
1298     // get minimum required values.
1299     $contactId = CRM_Utils_Array::value('contact_id', $params);
1300     $componentId = CRM_Utils_Array::value('component_id', $params);
1301     $componentName = CRM_Utils_Array::value('componentName', $params);
1302     $contributionId = CRM_Utils_Array::value('contribution_id', $params);
1303     $contributionStatusId = CRM_Utils_Array::value('contribution_status_id', $params);
1304
1305     // if we already processed contribution object pass previous status id.
1306     $previousContriStatusId = CRM_Utils_Array::value('previous_contribution_status_id', $params);
1307
1308     $updateResult = array();
1309
1310     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
1311
1312     // we process only ( Completed, Cancelled, or Failed ) contributions.
1313     if (!$contributionId ||
1314       !in_array($contributionStatusId, array(array_search('Completed', $contributionStatuses),
1315           array_search('Cancelled', $contributionStatuses),
1316           array_search('Failed', $contributionStatuses),
1317         ))
1318     ) {
1319       return $updateResult;
1320     }
1321
1322     if (!$componentName || !$componentId) {
1323       // get the related component details.
1324       $componentDetails = self::getComponentDetails($contributionId);
1325     }
1326     else {
1327       $componentDetails['contact_id'] = $contactId;
1328       $componentDetails['component'] = $componentName;
1329
1330       if ($componentName == 'event') {
1331         $componentDetails['participant'] = $componentId;
1332       }
1333       else {
1334         $componentDetails['membership'] = $componentId;
1335       }
1336     }
1337
1338     if (!empty($componentDetails['contact_id'])) {
1339       $componentDetails['contact_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
1340         $contributionId,
1341         'contact_id'
1342       );
1343     }
1344
1345     // do check for required ids.
1346     if (empty($componentDetails['membership']) && empty($componentDetails['participant']) && empty($componentDetails['pledge_payment']) || empty($componentDetails['contact_id'])) {
1347       return $updateResult;
1348     }
1349
1350     //now we are ready w/ required ids, start processing.
1351
1352     $baseIPN = new CRM_Core_Payment_BaseIPN();
1353
1354     $input = $ids = $objects = array();
1355
1356     $input['component'] = CRM_Utils_Array::value('component', $componentDetails);
1357     $ids['contribution'] = $contributionId;
1358     $ids['contact'] = CRM_Utils_Array::value('contact_id', $componentDetails);
1359     $ids['membership'] = CRM_Utils_Array::value('membership', $componentDetails);
1360     $ids['participant'] = CRM_Utils_Array::value('participant', $componentDetails);
1361     $ids['event'] = CRM_Utils_Array::value('event', $componentDetails);
1362     $ids['pledge_payment'] = CRM_Utils_Array::value('pledge_payment', $componentDetails);
1363     $ids['contributionRecur'] = NULL;
1364     $ids['contributionPage'] = NULL;
1365
1366     if (!$baseIPN->validateData($input, $ids, $objects, FALSE)) {
1367       CRM_Core_Error::fatal();
1368     }
1369
1370     $memberships   = &$objects['membership'];
1371     $participant   = &$objects['participant'];
1372     $pledgePayment = &$objects['pledge_payment'];
1373     $contribution  = &$objects['contribution'];
1374
1375     if ($pledgePayment) {
1376       $pledgePaymentIDs = array();
1377       foreach ($pledgePayment as $key => $object) {
1378         $pledgePaymentIDs[] = $object->id;
1379       }
1380       $pledgeID = $pledgePayment[0]->pledge_id;
1381     }
1382
1383     $membershipStatuses = CRM_Member_PseudoConstant::membershipStatus();
1384
1385     if ($participant) {
1386       $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
1387       $oldStatus = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant',
1388         $participant->id,
1389         'status_id'
1390       );
1391     }
1392     // we might want to process contribution object.
1393     $processContribution = FALSE;
1394     if ($contributionStatusId == array_search('Cancelled', $contributionStatuses)) {
1395       if (is_array($memberships)) {
1396         foreach ($memberships as $membership) {
1397           if ($membership) {
1398             $membership->status_id = array_search('Cancelled', $membershipStatuses);
1399             $membership->save();
1400
1401             $updateResult['updatedComponents']['CiviMember'] = $membership->status_id;
1402             if ($processContributionObject) {
1403               $processContribution = TRUE;
1404             }
1405           }
1406         }
1407       }
1408
1409       if ($participant) {
1410         $updatedStatusId = array_search('Cancelled', $participantStatuses);
1411         CRM_Event_BAO_Participant::updateParticipantStatus($participant->id, $oldStatus, $updatedStatusId, TRUE);
1412
1413         $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1414         if ($processContributionObject) {
1415           $processContribution = TRUE;
1416         }
1417       }
1418
1419       if ($pledgePayment) {
1420         CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1421
1422         $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1423         if ($processContributionObject) {
1424           $processContribution = TRUE;
1425         }
1426       }
1427     }
1428     elseif ($contributionStatusId == array_search('Failed', $contributionStatuses)) {
1429       if (is_array($memberships)) {
1430         foreach ($memberships as $membership) {
1431           if ($membership) {
1432             $membership->status_id = array_search('Expired', $membershipStatuses);
1433             $membership->save();
1434
1435             $updateResult['updatedComponents']['CiviMember'] = $membership->status_id;
1436             if ($processContributionObject) {
1437               $processContribution = TRUE;
1438             }
1439           }
1440         }
1441       }
1442       if ($participant) {
1443         $updatedStatusId = array_search('Cancelled', $participantStatuses);
1444         CRM_Event_BAO_Participant::updateParticipantStatus($participant->id, $oldStatus, $updatedStatusId, TRUE);
1445
1446         $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1447         if ($processContributionObject) {
1448           $processContribution = TRUE;
1449         }
1450       }
1451
1452       if ($pledgePayment) {
1453         CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1454
1455         $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1456         if ($processContributionObject) {
1457           $processContribution = TRUE;
1458         }
1459       }
1460     }
1461     elseif ($contributionStatusId == array_search('Completed', $contributionStatuses)) {
1462
1463       // only pending contribution related object processed.
1464       if ($previousContriStatusId &&
1465         ($previousContriStatusId != array_search('Pending', $contributionStatuses))
1466       ) {
1467         // this is case when we already processed contribution object.
1468         return $updateResult;
1469       }
1470       elseif (!$previousContriStatusId &&
1471         $contribution->contribution_status_id != array_search('Pending', $contributionStatuses)
1472       ) {
1473         // this is case when we are going to process contribution object later.
1474         return $updateResult;
1475       }
1476
1477       if (is_array($memberships)) {
1478         foreach ($memberships as $membership) {
1479           if ($membership) {
1480             $format = '%Y%m%d';
1481
1482             //CRM-4523
1483             $currentMembership = CRM_Member_BAO_Membership::getContactMembership($membership->contact_id,
1484               $membership->membership_type_id,
1485               $membership->is_test, $membership->id
1486             );
1487
1488             // CRM-8141 update the membership type with the value recorded in log when membership created/renewed
1489             // this picks up membership type changes during renewals
1490             $sql = "
1491               SELECT    membership_type_id
1492               FROM      civicrm_membership_log
1493               WHERE     membership_id=$membership->id
1494               ORDER BY  id DESC
1495               LIMIT     1;";
1496             $dao = new CRM_Core_DAO;
1497             $dao->query($sql);
1498             if ($dao->fetch()) {
1499               if (!empty($dao->membership_type_id)) {
1500                 $membership->membership_type_id = $dao->membership_type_id;
1501                 $membership->save();
1502               }
1503             }
1504             // else fall back to using current membership type
1505             $dao->free();
1506
1507             // Figure out number of terms
1508             $numterms = 1;
1509             $lineitems = CRM_Price_BAO_LineItem::getLineItems($contributionId, 'contribution');
1510             foreach ($lineitems as $lineitem) {
1511               if ($membership->membership_type_id == CRM_Utils_Array::value('membership_type_id', $lineitem)) {
1512                 $numterms = CRM_Utils_Array::value('membership_num_terms', $lineitem);
1513
1514                 // in case membership_num_terms comes through as null or zero
1515                 $numterms = $numterms >= 1 ? $numterms : 1;
1516                 break;
1517               }
1518             }
1519
1520             if ($currentMembership) {
1521               CRM_Member_BAO_Membership::fixMembershipStatusBeforeRenew($currentMembership, NULL);
1522               $dates = CRM_Member_BAO_MembershipType::getRenewalDatesForMembershipType($membership->id, NULL, NULL, $numterms);
1523               $dates['join_date'] = CRM_Utils_Date::customFormat($currentMembership['join_date'], $format);
1524             }
1525             else {
1526               $dates = CRM_Member_BAO_MembershipType::getDatesForMembershipType($membership->membership_type_id, NULL, NULL, NULL, $numterms);
1527             }
1528
1529             //get the status for membership.
1530             $calcStatus = CRM_Member_BAO_MembershipStatus::getMembershipStatusByDate($dates['start_date'],
1531               $dates['end_date'],
1532               $dates['join_date'],
1533               'today',
1534               TRUE,
1535               $membership->membership_type_id,
1536               (array) $membership
1537             );
1538
1539             $formattedParams = array(
1540               'status_id' => CRM_Utils_Array::value('id', $calcStatus,
1541                 array_search('Current', $membershipStatuses)
1542               ),
1543               'join_date' => CRM_Utils_Date::customFormat($dates['join_date'], $format),
1544               'start_date' => CRM_Utils_Date::customFormat($dates['start_date'], $format),
1545               'end_date' => CRM_Utils_Date::customFormat($dates['end_date'], $format),
1546             );
1547
1548             CRM_Utils_Hook::pre('edit', 'Membership', $membership->id, $formattedParams);
1549
1550             $membership->copyValues($formattedParams);
1551             $membership->save();
1552
1553             //updating the membership log
1554             $membershipLog = array();
1555             $membershipLog = $formattedParams;
1556             $logStartDate  = CRM_Utils_Date::customFormat(CRM_Utils_Array::value('log_start_date', $dates), $format);
1557             $logStartDate  = ($logStartDate) ? CRM_Utils_Date::isoToMysql($logStartDate) : $formattedParams['start_date'];
1558
1559             $membershipLog['start_date'] = $logStartDate;
1560             $membershipLog['membership_id'] = $membership->id;
1561             $membershipLog['modified_id'] = $membership->contact_id;
1562             $membershipLog['modified_date'] = date('Ymd');
1563             $membershipLog['membership_type_id'] = $membership->membership_type_id;
1564
1565             CRM_Member_BAO_MembershipLog::add($membershipLog, CRM_Core_DAO::$_nullArray);
1566
1567             //update related Memberships.
1568             CRM_Member_BAO_Membership::updateRelatedMemberships($membership->id, $formattedParams);
1569
1570             $updateResult['membership_end_date'] = CRM_Utils_Date::customFormat($dates['end_date'],
1571               '%B %E%f, %Y'
1572             );
1573             $updateResult['updatedComponents']['CiviMember'] = $membership->status_id;
1574             if ($processContributionObject) {
1575               $processContribution = TRUE;
1576             }
1577
1578             CRM_Utils_Hook::post('edit', 'Membership', $membership->id, $membership);
1579           }
1580         }
1581       }
1582
1583       if ($participant) {
1584         $updatedStatusId = array_search('Registered', $participantStatuses);
1585         CRM_Event_BAO_Participant::updateParticipantStatus($participant->id, $oldStatus, $updatedStatusId, TRUE);
1586
1587         $updateResult['updatedComponents']['CiviEvent'] = $updatedStatusId;
1588         if ($processContributionObject) {
1589           $processContribution = TRUE;
1590         }
1591       }
1592
1593       if ($pledgePayment) {
1594         CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID, $pledgePaymentIDs, $contributionStatusId);
1595
1596         $updateResult['updatedComponents']['CiviPledge'] = $contributionStatusId;
1597         if ($processContributionObject) {
1598           $processContribution = TRUE;
1599         }
1600       }
1601     }
1602
1603     // process contribution object.
1604     if ($processContribution) {
1605       $contributionParams = array();
1606       $fields = array(
1607         'contact_id', 'total_amount', 'receive_date', 'is_test', 'campaign_id',
1608         'payment_instrument_id', 'trxn_id', 'invoice_id', 'financial_type_id',
1609         'contribution_status_id', 'non_deductible_amount', 'receipt_date', 'check_number',
1610       );
1611       foreach ($fields as $field) {
1612         if (empty($params[$field])) {
1613           continue;
1614         }
1615         $contributionParams[$field] = $params[$field];
1616       }
1617
1618       $ids = array('contribution' => $contributionId);
1619       $contribution = CRM_Contribute_BAO_Contribution::create($contributionParams, $ids);
1620     }
1621
1622     return $updateResult;
1623   }
1624
1625   /**
1626    * This function returns all contribution related object ids.
1627    */
1628   public static function getComponentDetails($contributionId) {
1629     $componentDetails = $pledgePayment = array();
1630     if (!$contributionId) {
1631       return $componentDetails;
1632     }
1633
1634     $query = "
1635       SELECT    c.id                 as contribution_id,
1636                 c.contact_id         as contact_id,
1637                 mp.membership_id     as membership_id,
1638                 m.membership_type_id as membership_type_id,
1639                 pp.participant_id    as participant_id,
1640                 p.event_id           as event_id,
1641                 pgp.id               as pledge_payment_id
1642       FROM      civicrm_contribution c
1643       LEFT JOIN civicrm_membership_payment  mp   ON mp.contribution_id = c.id
1644       LEFT JOIN civicrm_participant_payment pp   ON pp.contribution_id = c.id
1645       LEFT JOIN civicrm_participant         p    ON pp.participant_id  = p.id
1646       LEFT JOIN civicrm_membership          m    ON m.id  = mp.membership_id
1647       LEFT JOIN civicrm_pledge_payment      pgp  ON pgp.contribution_id  = c.id
1648       WHERE     c.id = $contributionId";
1649
1650     $dao = CRM_Core_DAO::executeQuery($query);
1651     $componentDetails = array();
1652
1653     while ($dao->fetch()) {
1654       $componentDetails['component'] = $dao->participant_id ? 'event' : 'contribute';
1655       $componentDetails['contact_id'] = $dao->contact_id;
1656       if ($dao->event_id) {
1657         $componentDetails['event'] = $dao->event_id;
1658       }
1659       if ($dao->participant_id) {
1660         $componentDetails['participant'] = $dao->participant_id;
1661       }
1662       if ($dao->membership_id) {
1663         if (!isset($componentDetails['membership'])) {
1664           $componentDetails['membership'] = $componentDetails['membership_type'] = array();
1665         }
1666         $componentDetails['membership'][] = $dao->membership_id;
1667         $componentDetails['membership_type'][] = $dao->membership_type_id;
1668       }
1669       if ($dao->pledge_payment_id) {
1670         $pledgePayment[] = $dao->pledge_payment_id;
1671       }
1672     }
1673
1674     if ($pledgePayment) {
1675       $componentDetails['pledge_payment'] = $pledgePayment;
1676     }
1677
1678     return $componentDetails;
1679   }
1680
1681   static function contributionCount($contactId, $includeSoftCredit = TRUE) {
1682     if (!$contactId) {
1683       return 0;
1684     }
1685
1686     $contactContributionsSQL = "
1687       SELECT contribution.id AS id
1688       FROM civicrm_contribution contribution
1689       WHERE contribution.is_test = 0 AND contribution.contact_id = {$contactId} ";
1690
1691     $contactSoftCreditContributionsSQL = "
1692       SELECT contribution.id
1693       FROM civicrm_contribution contribution INNER JOIN civicrm_contribution_soft softContribution
1694       ON ( contribution.id = softContribution.contribution_id )
1695       WHERE contribution.is_test = 0 AND softContribution.contact_id = {$contactId} ";
1696     $query = "SELECT count( x.id ) count FROM ( ";
1697     $query .= $contactContributionsSQL;
1698
1699     if ($includeSoftCredit) {
1700       $query .= " UNION ";
1701       $query .= $contactSoftCreditContributionsSQL;
1702     }
1703
1704     $query .= ") x";
1705
1706     return CRM_Core_DAO::singleValueQuery($query);
1707   }
1708
1709   /**
1710    * Function to get individual id for onbehalf contribution
1711    *
1712    * @param int $contributionId contribution id
1713    * @param int $contributorId  contributor id
1714    *
1715    * @return array $ids containing organization id and individual id
1716    * @access public
1717    */
1718   static function getOnbehalfIds($contributionId, $contributorId = NULL) {
1719
1720     $ids = array();
1721
1722     if (!$contributionId) {
1723       return $ids;
1724     }
1725
1726     // fetch contributor id if null
1727     if (!$contributorId) {
1728       $contributorId = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
1729         $contributionId, 'contact_id'
1730       );
1731     }
1732
1733     $activityTypeIds = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
1734     $activityTypeId = array_search('Contribution', $activityTypeIds);
1735
1736     if ($activityTypeId && $contributorId) {
1737       $activityQuery = "
1738 SELECT     civicrm_activity_contact.contact_id
1739   FROM     civicrm_activity_contact
1740 INNER JOIN civicrm_activity ON civicrm_activity_contact.activity_id = civicrm_activity.id
1741  WHERE     civicrm_activity.activity_type_id   = %1
1742    AND     civicrm_activity.source_record_id   = %2
1743    AND     civicrm_activity_contact.record_type_id = %3
1744 ";
1745
1746       $activityContacts = CRM_Core_OptionGroup::values('activity_contacts', FALSE, FALSE, FALSE, NULL, 'name');
1747       $sourceID = CRM_Utils_Array::key('Activity Source', $activityContacts);
1748
1749       $params = array(
1750         1 => array($activityTypeId, 'Integer'),
1751         2 => array($contributionId, 'Integer'),
1752         3 => array($sourceID, 'Integer'),
1753       );
1754
1755       $sourceContactId = CRM_Core_DAO::singleValueQuery($activityQuery, $params);
1756
1757       // for on behalf contribution source is individual and contributor is organization
1758       if ($sourceContactId && $sourceContactId != $contributorId) {
1759         $relationshipTypeIds = CRM_Core_PseudoConstant::relationshipType('name');
1760         // get rel type id for employee of relation
1761         foreach ($relationshipTypeIds as $id => $typeVals) {
1762           if ($typeVals['name_a_b'] == 'Employee of') {
1763             $relationshipTypeId = $id;
1764             break;
1765           }
1766         }
1767
1768         $rel = new CRM_Contact_DAO_Relationship();
1769         $rel->relationship_type_id = $relationshipTypeId;
1770         $rel->contact_id_a = $sourceContactId;
1771         $rel->contact_id_b = $contributorId;
1772         if ($rel->find(TRUE)) {
1773           $ids['individual_id'] = $rel->contact_id_a;
1774           $ids['organization_id'] = $rel->contact_id_b;
1775         }
1776       }
1777     }
1778
1779     return $ids;
1780   }
1781
1782   /**
1783    * @return array
1784    * @static
1785    */
1786   static function getContributionDates() {
1787     $config       = CRM_Core_Config::singleton();
1788     $currentMonth = date('m');
1789     $currentDay   = date('d');
1790     if ((int ) $config->fiscalYearStart['M'] > $currentMonth ||
1791       ((int ) $config->fiscalYearStart['M'] == $currentMonth &&
1792         (int ) $config->fiscalYearStart['d'] > $currentDay
1793       )
1794     ) {
1795       $year = date('Y') - 1;
1796     }
1797     else {
1798       $year = date('Y');
1799     }
1800     $year     = array('Y' => $year);
1801     $yearDate = $config->fiscalYearStart;
1802     $yearDate = array_merge($year, $yearDate);
1803     $yearDate = CRM_Utils_Date::format($yearDate);
1804
1805     $monthDate = date('Ym') . '01';
1806
1807     $now = date('Ymd');
1808
1809     return array(
1810       'now' => $now,
1811       'yearDate' => $yearDate,
1812       'monthDate' => $monthDate,
1813     );
1814   }
1815
1816   /*
1817    * Load objects relations to contribution object
1818    * Objects are stored in the $_relatedObjects property
1819    * In the first instance we are just moving functionality from BASEIpn -
1820    * see http://issues.civicrm.org/jira/browse/CRM-9996
1821    *
1822    * @param array $input Input as delivered from Payment Processor
1823    * @param array $ids Ids as Loaded by Payment Processor
1824    * @param boolean $required Is Payment processor / contribution page required
1825    * @param boolean $loadAll - load all related objects - even where id not passed in? (allows API to call this)
1826    * Note that the unit test for the BaseIPN class tests this function
1827    */
1828   function loadRelatedObjects(&$input, &$ids, $required = FALSE, $loadAll = false) {
1829     if($loadAll){
1830       $ids = array_merge($this->getComponentDetails($this->id),$ids);
1831       if(empty($ids['contact']) && isset($this->contact_id)){
1832         $ids['contact'] = $this->contact_id;
1833       }
1834     }
1835     if (empty($this->_component)) {
1836       if (! empty($ids['event'])) {
1837         $this->_component = 'event';
1838       }
1839       else {
1840         $this->_component = strtolower(CRM_Utils_Array::value('component', $input, 'contribute'));
1841       }
1842     }
1843     $paymentProcessorID = CRM_Utils_Array::value('paymentProcessor', $ids);
1844     $contributionType = new CRM_Financial_BAO_FinancialType();
1845     $contributionType->id = $this->financial_type_id;
1846     if (!$contributionType->find(TRUE)) {
1847       throw new Exception("Could not find financial type record: " . $this->financial_type_id);
1848     }
1849     if (!empty($ids['contact'])) {
1850       $this->_relatedObjects['contact'] = new CRM_Contact_BAO_Contact();
1851       $this->_relatedObjects['contact']->id = $ids['contact'];
1852       $this->_relatedObjects['contact']->find(TRUE);
1853     }
1854     $this->_relatedObjects['contributionType'] = $contributionType;
1855
1856     if ($this->_component == 'contribute') {
1857       // retrieve the other optional objects first so
1858       // stuff down the line can use this info and do things
1859       // CRM-6056
1860       //in any case get the memberships associated with the contribution
1861       //because we now support multiple memberships w/ price set
1862           // see if there are any other memberships to be considered for same contribution.
1863           $query = "
1864             SELECT membership_id
1865             FROM   civicrm_membership_payment
1866 WHERE  contribution_id = %1 ";
1867       $params = array(1 => array($this->id, 'Integer'));
1868
1869       $dao = CRM_Core_DAO::executeQuery($query, $params );
1870           while ($dao->fetch()) {
1871         if ($dao->membership_id) {
1872           if (!is_array($ids['membership'])) {
1873             $ids['membership'] = array();
1874           }
1875             $ids['membership'][] = $dao->membership_id;
1876           }
1877         }
1878
1879       if (array_key_exists('membership', $ids) && is_array($ids['membership'])) {
1880           foreach ($ids['membership'] as $id) {
1881             if (!empty($id)) {
1882               $membership = new CRM_Member_BAO_Membership();
1883               $membership->id = $id;
1884               if (!$membership->find(TRUE)) {
1885                 throw new Exception("Could not find membership record: $id");
1886               }
1887               $membership->join_date = CRM_Utils_Date::isoToMysql($membership->join_date);
1888               $membership->start_date = CRM_Utils_Date::isoToMysql($membership->start_date);
1889               $membership->end_date = CRM_Utils_Date::isoToMysql($membership->end_date);
1890               $this->_relatedObjects['membership'][$membership->membership_type_id] = $membership;
1891               $membership->free();
1892             }
1893           }
1894         }
1895
1896       if (!empty($ids['pledge_payment'])) {
1897
1898         foreach ($ids['pledge_payment'] as $key => $paymentID) {
1899           if (empty($paymentID)) {
1900             continue;
1901           }
1902           $payment = new CRM_Pledge_BAO_PledgePayment();
1903           $payment->id = $paymentID;
1904           if (!$payment->find(TRUE)) {
1905             throw new Exception("Could not find pledge payment record: " . $paymentID);
1906           }
1907           $this->_relatedObjects['pledge_payment'][] = $payment;
1908         }
1909       }
1910
1911       if (!empty($ids['contributionRecur'])) {
1912         $recur = new CRM_Contribute_BAO_ContributionRecur();
1913         $recur->id = $ids['contributionRecur'];
1914         if (!$recur->find(TRUE)) {
1915           throw new Exception("Could not find recur record: " . $ids['contributionRecur']);
1916         }
1917         $this->_relatedObjects['contributionRecur'] = &$recur;
1918         //get payment processor id from recur object.
1919         $paymentProcessorID = $recur->payment_processor_id;
1920       }
1921       //for normal contribution get the payment processor id.
1922       if (!$paymentProcessorID) {
1923         if ($this->contribution_page_id) {
1924           // get the payment processor id from contribution page
1925           $paymentProcessorID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_ContributionPage',
1926             $this->contribution_page_id,
1927             'payment_processor'
1928           );
1929         }
1930         //fail to load payment processor id.
1931         elseif (empty($ids['pledge_payment'])) {
1932           $loadObjectSuccess = TRUE;
1933           if ($required) {
1934             throw new Exception("Could not find contribution page for contribution record: " . $this->id);
1935           }
1936           return $loadObjectSuccess;
1937         }
1938       }
1939     }
1940     else {
1941       // we are in event mode
1942       // make sure event exists and is valid
1943       $event = new CRM_Event_BAO_Event();
1944       $event->id = $ids['event'];
1945       if ($ids['event'] &&
1946         !$event->find(TRUE)
1947       ) {
1948         throw new Exception("Could not find event: " . $ids['event']);
1949       }
1950
1951       $this->_relatedObjects['event'] = &$event;
1952
1953       $participant = new CRM_Event_BAO_Participant();
1954       $participant->id = $ids['participant'];
1955       if ($ids['participant'] &&
1956         !$participant->find(TRUE)
1957       ) {
1958         throw new Exception("Could not find participant: " . $ids['participant']);
1959       }
1960       $participant->register_date = CRM_Utils_Date::isoToMysql($participant->register_date);
1961
1962       $this->_relatedObjects['participant'] = &$participant;
1963
1964       if (!$paymentProcessorID) {
1965         $paymentProcessorID = $this->_relatedObjects['event']->payment_processor;
1966       }
1967     }
1968
1969     $loadObjectSuccess = TRUE;
1970     if ($paymentProcessorID) {
1971       $paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment($paymentProcessorID,
1972         $this->is_test ? 'test' : 'live'
1973       );
1974       $ids['paymentProcessor'] = $paymentProcessorID;
1975       $this->_relatedObjects['paymentProcessor'] = &$paymentProcessor;
1976     }
1977     elseif ($required) {
1978       $loadObjectSuccess = FALSE;
1979       throw new Exception("Could not find payment processor for contribution record: " . $this->id);
1980     }
1981
1982     return $loadObjectSuccess;
1983   }
1984
1985   /*
1986    * Create array of message information - ie. return html version, txt version, to field
1987    *
1988    * @param array $input incoming information
1989    *  - is_recur - should this be treated as recurring (not sure why you wouldn't
1990    *    just check presence of recur object but maintaining legacy approach
1991    *    to be careful)
1992    * @param array $ids IDs of related objects
1993    * @param array $values any values that may have already been compiled by calling process
1994    *   This is augmented by values 'gathered' by gatherMessageValues
1995    * @param bool $returnMessageText distinguishes between whether to send message or return
1996    *   message text. We are working towards this function ALWAYS returning message text & calling
1997    *   function doing emails / pdfs with it
1998    * @return array $messageArray - messages
1999    */
2000   function composeMessageArray(&$input, &$ids, &$values, $recur = FALSE, $returnMessageText = TRUE) {
2001     if (empty($this->_relatedObjects)) {
2002       $this->loadRelatedObjects($input, $ids);
2003     }
2004     if (empty($this->_component)) {
2005       $this->_component = CRM_Utils_Array::value('component', $input);
2006     }
2007
2008     //not really sure what params might be passed in but lets merge em into values
2009     $values = array_merge($this->_gatherMessageValues($input, $values, $ids), $values);
2010     $template = CRM_Core_Smarty::singleton();
2011     $this->_assignMessageVariablesToTemplate($values, $input, $template, $recur, $returnMessageText);
2012     //what does recur 'mean here - to do with payment processor return functionality but
2013     // what is the importance
2014     if ($recur && !empty($this->_relatedObjects['paymentProcessor'])) {
2015       $paymentObject = &CRM_Core_Payment::singleton(
2016         $this->is_test ? 'test' : 'live',
2017         $this->_relatedObjects['paymentProcessor']
2018       );
2019
2020       $entityID = $entity = NULL;
2021       if (isset($ids['contribution'])) {
2022         $entity = 'contribution';
2023         $entityID = $ids['contribution'];
2024       }
2025       if (isset($ids['membership']) && $ids['membership']) {
2026         $entity = 'membership';
2027         $entityID = $ids['membership'];
2028       }
2029
2030       $url = $paymentObject->subscriptionURL($entityID, $entity);
2031       $template->assign('cancelSubscriptionUrl', $url);
2032
2033       $url = $paymentObject->subscriptionURL($entityID, $entity, 'billing');
2034       $template->assign('updateSubscriptionBillingUrl', $url);
2035
2036       $url = $paymentObject->subscriptionURL($entityID, $entity, 'update');
2037       $template->assign('updateSubscriptionUrl', $url);
2038
2039       if ($this->_relatedObjects['paymentProcessor']['billing_mode'] & CRM_Core_Payment::BILLING_MODE_FORM) {
2040         //direct mode showing billing block, so use directIPN for temporary
2041         $template->assign('contributeMode', 'directIPN');
2042       }
2043     }
2044     // todo remove strtolower - check consistency
2045     if (strtolower($this->_component) == 'event') {
2046       return CRM_Event_BAO_Event::sendMail($ids['contact'], $values,
2047         $this->_relatedObjects['participant']->id, $this->is_test, $returnMessageText
2048       );
2049     }
2050     else {
2051       $values['contribution_id'] = $this->id;
2052       if (!empty($ids['related_contact'])) {
2053         $values['related_contact'] = $ids['related_contact'];
2054         if (isset($ids['onbehalf_dupe_alert'])) {
2055           $values['onbehalf_dupe_alert'] = $ids['onbehalf_dupe_alert'];
2056         }
2057         $entityBlock = array(
2058           'contact_id' => $ids['contact'],
2059           'location_type_id' => CRM_Core_DAO::getFieldValue('CRM_Core_DAO_LocationType',
2060             'Home', 'id', 'name'
2061           ),
2062         );
2063         $address = CRM_Core_BAO_Address::getValues($entityBlock);
2064         $template->assign('onBehalfAddress', $address[$entityBlock['location_type_id']]['display']);
2065       }
2066       $isTest = FALSE;
2067       if ($this->is_test) {
2068         $isTest = TRUE;
2069       }
2070       if (!empty($this->_relatedObjects['membership'])) {
2071         foreach ($this->_relatedObjects['membership'] as $membership) {
2072           if ($membership->id) {
2073             $values['membership_id'] = $membership->id;
2074
2075             // need to set the membership values here
2076             $template->assign('membership_assign', 1);
2077             $template->assign('membership_name',
2078               CRM_Member_PseudoConstant::membershipType($membership->membership_type_id)
2079             );
2080             $template->assign('mem_start_date', $membership->start_date);
2081             $template->assign('mem_join_date', $membership->join_date);
2082             $template->assign('mem_end_date', $membership->end_date);
2083             $membership_status = CRM_Member_PseudoConstant::membershipStatus($membership->status_id, NULL, 'label');
2084             $template->assign('mem_status', $membership_status);
2085             if ($membership_status == 'Pending' && $membership->is_pay_later == 1) {
2086               $template->assign('is_pay_later', 1);
2087             }
2088
2089             // if separate payment there are two contributions recorded and the
2090             // admin will need to send a receipt for each of them separately.
2091             // we dont link the two in the db (but can potentially infer it if needed)
2092             $template->assign('is_separate_payment', 0);
2093
2094             if ($recur && $paymentObject) {
2095               $url = $paymentObject->subscriptionURL($membership->id, 'membership');
2096               $template->assign('cancelSubscriptionUrl', $url);
2097               $url = $paymentObject->subscriptionURL($membership->id, 'membership', 'billing');
2098               $template->assign('updateSubscriptionBillingUrl', $url);
2099               $url = $paymentObject->subscriptionURL($entityID, $entity, 'update');
2100               $template->assign('updateSubscriptionUrl', $url);
2101             }
2102
2103             $result = CRM_Contribute_BAO_ContributionPage::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
2104
2105             return $result;
2106             // otherwise if its about sending emails, continue sending without return, as we
2107             // don't want to exit the loop.
2108           }
2109         }
2110       }
2111       else {
2112         return CRM_Contribute_BAO_ContributionPage::sendMail($ids['contact'], $values, $isTest, $returnMessageText);
2113       }
2114     }
2115   }
2116
2117   /*
2118    * Gather values for contribution mail - this function has been created
2119    * as part of CRM-9996 refactoring as a step towards simplifying the composeMessage function
2120    * Values related to the contribution in question are gathered
2121    *
2122    * @param array $input input into function (probably from payment processor)
2123    * @param array $ids   the set of ids related to the inpurt
2124    *
2125    * @return array $values
2126    *
2127    * NB don't add direct calls to the function as we intend to change the signature
2128    */
2129   function _gatherMessageValues($input, &$values, $ids = array()) {
2130     // set display address of contributor
2131     if ($this->address_id) {
2132       $addressParams     = array('id' => $this->address_id);
2133       $addressDetails    = CRM_Core_BAO_Address::getValues($addressParams, FALSE, 'id');
2134       $addressDetails    = array_values($addressDetails);
2135       $values['address'] = $addressDetails[0]['display'];
2136     }
2137     if ($this->_component == 'contribute') {
2138       if (isset($this->contribution_page_id)) {
2139         CRM_Contribute_BAO_ContributionPage::setValues(
2140           $this->contribution_page_id,
2141           $values
2142         );
2143         if ($this->contribution_page_id) {
2144           // CRM-8254 - override default currency if applicable
2145           $config = CRM_Core_Config::singleton();
2146           $config->defaultCurrency = CRM_Utils_Array::value(
2147             'currency',
2148             $values,
2149             $config->defaultCurrency
2150           );
2151         }
2152       }
2153       // no contribution page -probably back office
2154       else {
2155         // Handle re-print receipt for offline contributions (call from PDF.php - no contribution_page_id)
2156         $values['is_email_receipt'] = 1;
2157         $values['title'] = 'Contribution';
2158       }
2159       // set lineItem for contribution
2160       if ($this->id) {
2161         $lineItem = CRM_Price_BAO_LineItem::getLineItems($this->id, 'contribution', 1);
2162         if (!empty($lineItem)) {
2163           $itemId                = key($lineItem);
2164           foreach ($lineItem as &$eachItem) {
2165             if (array_key_exists($eachItem['membership_type_id'], $this->_relatedObjects['membership']) ) {
2166               $eachItem['join_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->join_date);
2167               $eachItem['start_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->start_date);
2168               $eachItem['end_date'] = CRM_Utils_Date::customFormat($this->_relatedObjects['membership'][$eachItem['membership_type_id']]->end_date);
2169             }
2170           }
2171           $values['lineItem'][0] = $lineItem;
2172           $values['priceSetID']  = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $lineItem[$itemId]['price_field_id'], 'price_set_id');
2173       }
2174       }
2175
2176       $relatedContact = CRM_Contribute_BAO_Contribution::getOnbehalfIds(
2177         $this->id,
2178         $this->contact_id
2179       );
2180       // if this is onbehalf of contribution then set related contact
2181       if (!empty($relatedContact['individual_id'])) {
2182         $values['related_contact'] = $ids['related_contact'] = $relatedContact['individual_id'];
2183       }
2184     }
2185     else {
2186       // event
2187       $eventParams = array(
2188         'id' => $this->_relatedObjects['event']->id,
2189       );
2190       $values['event'] = array();
2191
2192       CRM_Event_BAO_Event::retrieve($eventParams, $values['event']);
2193
2194       //get location details
2195       $locationParams = array(
2196         'entity_id' => $this->_relatedObjects['event']->id,
2197         'entity_table' => 'civicrm_event',
2198       );
2199       $values['location'] = CRM_Core_BAO_Location::getValues($locationParams);
2200
2201       $ufJoinParams = array(
2202         'entity_table' => 'civicrm_event',
2203         'entity_id'    => $ids['event'],
2204         'module'       => 'CiviEvent',
2205       );
2206
2207       list($custom_pre_id,
2208            $custom_post_ids
2209            ) = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
2210
2211       $values['custom_pre_id'] = $custom_pre_id;
2212       $values['custom_post_id'] = $custom_post_ids;
2213
2214       // set lineItem for event contribution
2215       if ($this->id) {
2216         $participantIds = CRM_Event_BAO_Participant::getParticipantIds($this->id);
2217         if (!empty($participantIds)) {
2218           foreach ($participantIds as $pIDs) {
2219             $lineItem = CRM_Price_BAO_LineItem::getLineItems($pIDs);
2220             if (!CRM_Utils_System::isNull($lineItem)) {
2221               $values['lineItem'][] = $lineItem;
2222             }
2223           }
2224         }
2225       }
2226     }
2227
2228     return $values;
2229   }
2230
2231   /**
2232    * Apply variables for message to smarty template - this function is part of analysing what is in the huge
2233    * function & breaking it down into manageable chunks. Eventually it will be refactored into something else
2234    * Note we send directly from this function in some cases because it is only partly refactored
2235    * Don't call this function directly as the signature will change
2236    */
2237   function _assignMessageVariablesToTemplate(&$values, $input, &$template, $recur = FALSE, $returnMessageText = True) {
2238     $template->assign('first_name', $this->_relatedObjects['contact']->first_name);
2239     $template->assign('last_name', $this->_relatedObjects['contact']->last_name);
2240     $template->assign('displayName', $this->_relatedObjects['contact']->display_name);
2241     if (!empty($values['lineItem']) && !empty($this->_relatedObjects['membership'])) {
2242       $template->assign('useForMember', true);
2243     }
2244     //assign honor infomation to receiptmessage
2245     $softRecord = CRM_Contribute_BAO_ContributionSoft::getSoftContribution($this->id);
2246
2247     if (isset($softRecord['soft_credit'])) {
2248       //if id of contribution page is present
2249       if (!empty($values['id'])) {
2250         $values['honor'] = array(
2251           'honor_profile_values' => array(),
2252           'honor_profile_id' => CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'uf_group_id', 'entity_id'),
2253           'honor_id' => $softRecord['soft_credit'][1]['contact_id'],
2254         );
2255         $softCreditTypes = CRM_Core_OptionGroup::values('soft_credit_type');
2256
2257         $template->assign('soft_credit_type',  $softRecord['soft_credit'][1]['soft_credit_type_label']);
2258         $template->assign('honor_block_is_active', CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFJoin', $values['id'], 'is_active', 'entity_id'));
2259       }
2260       else {
2261         //offline contribution
2262         $softCreditTypes = $softCredits = array();
2263         foreach ($softRecord['soft_credit'] as $key => $softCredit) {
2264           $softCreditTypes[$key] = $softCredit['soft_credit_type_label'];
2265           $softCredits[$key] = array(
2266             'Name' => $softCredit['contact_name'],
2267             'Amount' => CRM_Utils_Money::format($softCredit['amount'], $softCredit['currency'])
2268           );
2269         }
2270         $template->assign('softCreditTypes', $softCreditTypes);
2271         $template->assign('softCredits', $softCredits);
2272       }
2273     }
2274
2275     $dao = new CRM_Contribute_DAO_ContributionProduct();
2276     $dao->contribution_id = $this->id;
2277     if ($dao->find(TRUE)) {
2278       $premiumId = $dao->product_id;
2279       $template->assign('option', $dao->product_option);
2280
2281       $productDAO = new CRM_Contribute_DAO_Product();
2282       $productDAO->id = $premiumId;
2283       $productDAO->find(TRUE);
2284       $template->assign('selectPremium', TRUE);
2285       $template->assign('product_name', $productDAO->name);
2286       $template->assign('price', $productDAO->price);
2287       $template->assign('sku', $productDAO->sku);
2288     }
2289     $template->assign('title', CRM_Utils_Array::value('title',$values));
2290     $amount = CRM_Utils_Array::value('total_amount', $input,(CRM_Utils_Array::value('amount', $input)),null);
2291     if(empty($amount) && isset($this->total_amount)){
2292       $amount = $this->total_amount;
2293     }
2294     $template->assign('amount', $amount);
2295     // add the new contribution values
2296     if (strtolower($this->_component) == 'contribute') {
2297       //PCP Info
2298       $softDAO = new CRM_Contribute_DAO_ContributionSoft();
2299       $softDAO->contribution_id = $this->id;
2300       if ($softDAO->find(TRUE)) {
2301         $template->assign('pcpBlock', TRUE);
2302         $template->assign('pcp_display_in_roll', $softDAO->pcp_display_in_roll);
2303         $template->assign('pcp_roll_nickname', $softDAO->pcp_roll_nickname);
2304         $template->assign('pcp_personal_note', $softDAO->pcp_personal_note);
2305
2306         //assign the pcp page title for email subject
2307         $pcpDAO = new CRM_PCP_DAO_PCP();
2308         $pcpDAO->id = $softDAO->pcp_id;
2309         if ($pcpDAO->find(TRUE)) {
2310           $template->assign('title', $pcpDAO->title);
2311         }
2312       }
2313     }
2314
2315     if ($this->financial_type_id) {
2316       $values['financial_type_id'] = $this->financial_type_id;
2317     }
2318
2319
2320     $template->assign('trxn_id', $this->trxn_id);
2321     $template->assign('receive_date',
2322       CRM_Utils_Date::mysqlToIso($this->receive_date)
2323     );
2324     $template->assign('contributeMode', 'notify');
2325     $template->assign('action', $this->is_test ? 1024 : 1);
2326     $template->assign('receipt_text',
2327       CRM_Utils_Array::value('receipt_text',
2328         $values
2329       )
2330     );
2331     $template->assign('is_monetary', 1);
2332     $template->assign('is_recur', (bool) $recur);
2333     $template->assign('currency', $this->currency);
2334     $template->assign('address', CRM_Utils_Address::format($input));
2335     if ($this->_component == 'event') {
2336       $template->assign('title', $values['event']['title']);
2337       $participantRoles = CRM_Event_PseudoConstant::participantRole();
2338       $viewRoles = array();
2339       foreach (explode(CRM_Core_DAO::VALUE_SEPARATOR, $this->_relatedObjects['participant']->role_id) as $k => $v) {
2340         $viewRoles[] = $participantRoles[$v];
2341       }
2342       $values['event']['participant_role'] = implode(', ', $viewRoles);
2343       $template->assign('event', $values['event']);
2344       $template->assign('location', $values['location']);
2345       $template->assign('customPre', $values['custom_pre_id']);
2346       $template->assign('customPost', $values['custom_post_id']);
2347
2348       $isTest = FALSE;
2349       if ($this->_relatedObjects['participant']->is_test) {
2350         $isTest = TRUE;
2351       }
2352
2353       $values['params'] = array();
2354       //to get email of primary participant.
2355       $primaryEmail = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Email', $this->_relatedObjects['participant']->contact_id, 'email', 'contact_id');
2356       $primaryAmount[] = array('label' => $this->_relatedObjects['participant']->fee_level . ' - ' . $primaryEmail, 'amount' => $this->_relatedObjects['participant']->fee_amount);
2357       //build an array of cId/pId of participants
2358       $additionalIDs = CRM_Event_BAO_Event::buildCustomProfile($this->_relatedObjects['participant']->id, NULL, $this->_relatedObjects['contact']->id, $isTest, TRUE);
2359       unset($additionalIDs[$this->_relatedObjects['participant']->id]);
2360       //send receipt to additional participant if exists
2361       if (count($additionalIDs)) {
2362         $template->assign('isPrimary', 0);
2363         $template->assign('customProfile', NULL);
2364         //set additionalParticipant true
2365         $values['params']['additionalParticipant'] = TRUE;
2366         foreach ($additionalIDs as $pId => $cId) {
2367           $amount = array();
2368           //to change the status pending to completed
2369           $additional = new CRM_Event_DAO_Participant();
2370           $additional->id = $pId;
2371           $additional->contact_id = $cId;
2372           $additional->find(TRUE);
2373           $additional->register_date = $this->_relatedObjects['participant']->register_date;
2374           $additional->status_id = 1;
2375           $additionalParticipantInfo = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Email', $additional->contact_id, 'email', 'contact_id');
2376           //if additional participant dont have email
2377           //use display name.
2378           if (!$additionalParticipantInfo) {
2379             $additionalParticipantInfo = CRM_Contact_BAO_Contact::displayName($additional->contact_id);
2380           }
2381           $amount[0] = array('label' => $additional->fee_level, 'amount' => $additional->fee_amount);
2382           $primaryAmount[] = array('label' => $additional->fee_level . ' - ' . $additionalParticipantInfo, 'amount' => $additional->fee_amount);
2383           $additional->save();
2384           $additional->free();
2385           $template->assign('amount', $amount);
2386           CRM_Event_BAO_Event::sendMail($cId, $values, $pId, $isTest, $returnMessageText);
2387         }
2388       }
2389
2390       //build an array of custom profile and assigning it to template
2391       $customProfile = CRM_Event_BAO_Event::buildCustomProfile($this->_relatedObjects['participant']->id, $values, NULL, $isTest);
2392
2393       if (count($customProfile)) {
2394         $template->assign('customProfile', $customProfile);
2395       }
2396
2397       // for primary contact
2398       $values['params']['additionalParticipant'] = FALSE;
2399       $template->assign('isPrimary', 1);
2400       $template->assign('amount', $primaryAmount);
2401       $template->assign('register_date', CRM_Utils_Date::isoToMysql($this->_relatedObjects['participant']->register_date));
2402       if ($this->payment_instrument_id) {
2403         $paymentInstrument = CRM_Contribute_PseudoConstant::paymentInstrument();
2404         $template->assign('paidBy', $paymentInstrument[$this->payment_instrument_id]);
2405       }
2406       // carry paylater, since we did not created billing,
2407       // so need to pull email from primary location, CRM-4395
2408       $values['params']['is_pay_later'] = $this->_relatedObjects['participant']->is_pay_later;
2409     }
2410     return $template;
2411   }
2412
2413   /**
2414    * Function to check whether payment processor supports
2415    * cancellation of contribution subscription
2416    *
2417    * @param int $contributionId contribution id
2418    *
2419    * @return boolean
2420    * @access public
2421    * @static
2422    */
2423   static function isCancelSubscriptionSupported($contributionId, $isNotCancelled = TRUE) {
2424     $cacheKeyString = "$contributionId";
2425     $cacheKeyString .= $isNotCancelled ? '_1' : '_0';
2426
2427     static $supportsCancel = array();
2428
2429     if (!array_key_exists($cacheKeyString, $supportsCancel)) {
2430       $supportsCancel[$cacheKeyString] = FALSE;
2431       $isCancelled = FALSE;
2432
2433       if ($isNotCancelled) {
2434         $isCancelled = self::isSubscriptionCancelled($contributionId);
2435       }
2436
2437       $paymentObject = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($contributionId, 'contribute', 'obj');
2438       if (!empty($paymentObject)) {
2439         $supportsCancel[$cacheKeyString] = $paymentObject->isSupported('cancelSubscription') && !$isCancelled;
2440       }
2441     }
2442     return $supportsCancel[$cacheKeyString];
2443   }
2444
2445   /**
2446    * Function to check whether subscription is already cancelled
2447    *
2448    * @param int $contributionId contribution id
2449    *
2450    * @return string $status contribution status
2451    * @access public
2452    * @static
2453    */
2454   static function isSubscriptionCancelled($contributionId) {
2455     $sql = "
2456        SELECT cr.contribution_status_id
2457          FROM civicrm_contribution_recur cr
2458     LEFT JOIN civicrm_contribution con ON ( cr.id = con.contribution_recur_id )
2459         WHERE con.id = %1 LIMIT 1";
2460     $params   = array(1 => array($contributionId, 'Integer'));
2461     $statusId = CRM_Core_DAO::singleValueQuery($sql, $params);
2462     $status   = CRM_Contribute_PseudoConstant::contributionStatus($statusId);
2463     if ($status == 'Cancelled') {
2464       return TRUE;
2465     }
2466     return FALSE;
2467   }
2468
2469   /**
2470    * Function to create all financial accounts entry
2471    *
2472    * @param array $params contribution object, line item array and params for trxn
2473    *
2474    *
2475    * @access public
2476    * @static
2477    */
2478   static function recordFinancialAccounts(&$params, $financialTrxnVals = NULL) {
2479     $skipRecords = $update = FALSE;
2480     // in few scenarios we require the trxn record details which has got created
2481     $return = NULL;
2482     $additionalParticipantId = array();
2483     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
2484
2485     if (CRM_Utils_Array::value('contribution_mode', $params) == 'participant') {
2486       $entityId = $params['participant_id'];
2487       $entityTable = 'civicrm_participant';
2488       $additionalParticipantId = CRM_Event_BAO_Participant::getAdditionalParticipantIds($entityId);
2489     }
2490     else {
2491       $entityId = $params['contribution']->id;
2492       $entityTable = 'civicrm_contribution';
2493     }
2494
2495     $entityID[] = $entityId;
2496     if (!empty($additionalParticipantId)) {
2497       $entityID += $additionalParticipantId;
2498     }
2499     // prevContribution appears to mean - original contribution object- ie copy of contribution from before the update started that is being updated
2500     if (empty($params['prevContribution'])) {
2501       $entityID = NULL;
2502     }
2503     else {
2504       $update = TRUE;
2505     }
2506
2507     $statusId = $params['contribution']->contribution_status_id;
2508     // CRM-13964 partial payment
2509     if (CRM_Utils_Array::value('contribution_status_id', $params) == array_search('Partially paid', $contributionStatuses)
2510       && !empty($params['partial_payment_total']) && !empty($params['partial_amount_pay'])) {
2511       $partialAmtPay = $params['partial_amount_pay'];
2512       $partialAmtTotal = $params['partial_payment_total'];
2513
2514       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
2515       $fromFinancialAccountId = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id'], $relationTypeId);
2516       $statusId = CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name');
2517       $params['total_amount'] = $partialAmtPay;
2518
2519       $balanceTrxnInfo = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($params['contribution']->id, $params['financial_type_id']);
2520       if (empty($balanceTrxnInfo['trxn_id'])) {
2521         // create new balance transaction record
2522         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
2523         $toFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id'], $relationTypeId);
2524
2525         $balanceTrxnParams['total_amount'] = $partialAmtTotal;
2526         $balanceTrxnParams['to_financial_account_id'] = $toFinancialAccount;
2527         $balanceTrxnParams['contribution_id'] = $params['contribution']->id;
2528         $balanceTrxnParams['trxn_date'] = date('YmdHis');
2529         $balanceTrxnParams['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
2530         $balanceTrxnParams['net_amount'] = CRM_Utils_Array::value('net_amount', $params);
2531         $balanceTrxnParams['currency'] = $params['contribution']->currency;
2532         $balanceTrxnParams['trxn_id'] = $params['contribution']->trxn_id;
2533         $balanceTrxnParams['status_id'] = $statusId;
2534         $balanceTrxnParams['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
2535         $balanceTrxnParams['check_number'] = CRM_Utils_Array::value('check_number', $params);
2536         if (!empty($params['payment_processor'])) {
2537           $balanceTrxnParams['payment_processor_id'] = $params['payment_processor'];
2538         }
2539         CRM_Core_BAO_FinancialTrxn::create($balanceTrxnParams);
2540       }
2541     }
2542
2543     // build line item array if its not set in $params
2544     if (empty($params['line_item']) || $additionalParticipantId) {
2545       CRM_Price_BAO_LineItem::getLineItemArray($params, $entityID, str_replace('civicrm_', '', $entityTable));
2546     }
2547
2548     if (CRM_Utils_Array::value('contribution_status_id', $params) != array_search('Failed', $contributionStatuses) &&
2549       !(CRM_Utils_Array::value('contribution_status_id', $params) == array_search('Pending', $contributionStatuses) && !$params['contribution']->is_pay_later)) {
2550       $skipRecords = TRUE;
2551       $pendingStatus = array(array_search('Pending', $contributionStatuses), array_search('In Progress', $contributionStatuses));
2552       if (in_array(CRM_Utils_Array::value('contribution_status_id', $params), $pendingStatus)) {
2553         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
2554         $params['to_financial_account_id'] = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id'], $relationTypeId);
2555       }
2556       elseif (!empty($params['payment_processor'])) {
2557         $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getFinancialAccount($params['payment_processor'], 'civicrm_payment_processor', 'financial_account_id');
2558       }
2559       elseif (!empty($params['payment_instrument_id'])) {
2560         $params['to_financial_account_id'] = CRM_Financial_BAO_FinancialTypeAccount::getInstrumentFinancialAccount($params['payment_instrument_id']);
2561       }
2562       else {
2563         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('financial_account_type', NULL, " AND v.name LIKE 'Asset' "));
2564         $queryParams = array(1 => array($relationTypeId, 'Integer'));
2565         $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);
2566       }
2567
2568       $totalAmount = CRM_Utils_Array::value('total_amount', $params);
2569       if (!isset($totalAmount) && !empty($params['prevContribution'])) {
2570         $totalAmount = $params['total_amount'] = $params['prevContribution']->total_amount;
2571       }
2572
2573       //build financial transaction params
2574       $trxnParams = array(
2575         'contribution_id' => $params['contribution']->id,
2576         'to_financial_account_id' => $params['to_financial_account_id'],
2577         'trxn_date' => date('YmdHis'),
2578         'total_amount' => $totalAmount,
2579         'fee_amount' => CRM_Utils_Array::value('fee_amount', $params),
2580         'net_amount' => CRM_Utils_Array::value('net_amount', $params),
2581         'currency' => $params['contribution']->currency,
2582         'trxn_id' => $params['contribution']->trxn_id,
2583         'status_id' => $statusId,
2584         'payment_instrument_id' => $params['contribution']->payment_instrument_id,
2585         'check_number' => CRM_Utils_Array::value('check_number', $params),
2586       );
2587
2588       if (!empty($params['payment_processor'])) {
2589         $trxnParams['payment_processor_id'] = $params['payment_processor'];
2590       }
2591
2592       if (isset($fromFinancialAccountId)) {
2593         $trxnParams['from_financial_account_id'] = $fromFinancialAccountId;
2594       }
2595
2596       // consider external values passed for recording transaction entry
2597       if (!empty($financialTrxnVals)) {
2598         $trxnParams = array_merge($trxnParams, $financialTrxnVals);
2599       }
2600
2601       $params['trxnParams'] = $trxnParams;
2602
2603       if (!empty($params['prevContribution'])) {
2604         $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $params['prevContribution']->total_amount;
2605         $params['trxnParams']['fee_amount'] = $params['prevContribution']->fee_amount;
2606         $params['trxnParams']['net_amount'] = $params['prevContribution']->net_amount;
2607         $params['trxnParams']['trxn_id'] = $params['prevContribution']->trxn_id;
2608         $params['trxnParams']['status_id'] = $params['prevContribution']->contribution_status_id;
2609         $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id;
2610         $params['trxnParams']['check_number'] = $params['prevContribution']->check_number;
2611
2612         //if financial type is changed
2613         if (!empty($params['financial_type_id']) &&
2614           $params['contribution']->financial_type_id != $params['prevContribution']->financial_type_id) {
2615           $incomeTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Income Account is' "));
2616           $oldFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($params['prevContribution']->financial_type_id, $incomeTypeId);
2617           $newFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($params['financial_type_id'], $incomeTypeId);
2618           if ($oldFinancialAccount != $newFinancialAccount) {
2619             $params['total_amount'] = 0;
2620             if (in_array($params['contribution']->contribution_status_id, $pendingStatus)) {
2621               $params['trxnParams']['to_financial_account_id'] = CRM_Contribute_PseudoConstant::financialAccountType(
2622                 $params['prevContribution']->financial_type_id, $relationTypeId);
2623             }
2624             else {
2625               $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['prevContribution']->id, 'DESC');
2626               if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
2627                 $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
2628               }
2629             }
2630             self::updateFinancialAccounts($params, 'changeFinancialType');
2631             /* $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id']; */
2632             $params['financial_account_id'] = $newFinancialAccount;
2633             $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
2634             self::updateFinancialAccounts($params);
2635             $params['trxnParams']['to_financial_account_id'] = $trxnParams['to_financial_account_id'];
2636           }
2637         }
2638
2639         //Update contribution status
2640         $params['trxnParams']['status_id'] = $params['contribution']->contribution_status_id;
2641         if (!empty($params['contribution_status_id']) &&
2642           $params['prevContribution']->contribution_status_id != $params['contribution']->contribution_status_id) {
2643           //Update Financial Records
2644           self::updateFinancialAccounts($params, 'changedStatus');
2645         }
2646
2647         // change Payment Instrument for a Completed contribution
2648         // first handle special case when contribution is changed from Pending to Completed status when initial payment
2649         // instrument is null and now new payment instrument is added along with the payment
2650         $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
2651         $params['trxnParams']['check_number'] = CRM_Utils_Array::value('check_number', $params);
2652         if (array_key_exists('payment_instrument_id', $params)) {
2653           $params['trxnParams']['total_amount'] = - $trxnParams['total_amount'];
2654           if (CRM_Utils_System::isNull($params['prevContribution']->payment_instrument_id) &&
2655             !CRM_Utils_System::isNull($params['contribution']->payment_instrument_id)) {
2656             //check if status is changed from Pending to Completed
2657             // do not update payment instrument changes for Pending to Completed
2658             if (!($params['contribution']->contribution_status_id == array_search('Completed', $contributionStatuses) &&
2659               in_array($params['prevContribution']->contribution_status_id, $pendingStatus))) {
2660               // for all other statuses create new financial records
2661               self::updateFinancialAccounts($params, 'changePaymentInstrument');
2662               $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
2663               self::updateFinancialAccounts($params, 'changePaymentInstrument');
2664             }
2665           }
2666           else if ((!CRM_Utils_System::isNull($params['contribution']->payment_instrument_id) ||
2667             !CRM_Utils_System::isNull($params['prevContribution']->payment_instrument_id)) &&
2668             $params['contribution']->payment_instrument_id != $params['prevContribution']->payment_instrument_id) {
2669             // for any other payment instrument changes create new financial records
2670             self::updateFinancialAccounts($params, 'changePaymentInstrument');
2671             $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
2672             self::updateFinancialAccounts($params, 'changePaymentInstrument');
2673           }
2674           else if (!CRM_Utils_System::isNull($params['contribution']->check_number) &&
2675             $params['contribution']->check_number != $params['prevContribution']->check_number) {
2676             // another special case when check number is changed, create new financial records
2677             // create financial trxn with negative amount
2678             $params['trxnParams']['check_number'] = $params['prevContribution']->check_number;
2679             self::updateFinancialAccounts($params, 'changePaymentInstrument');
2680             // create financial trxn with positive amount
2681             $params['trxnParams']['check_number'] = $params['contribution']->check_number;
2682             $params['total_amount'] = $params['trxnParams']['total_amount'] = $trxnParams['total_amount'];
2683             self::updateFinancialAccounts($params, 'changePaymentInstrument');
2684           }
2685         }
2686
2687         //if Change contribution amount
2688         $params['trxnParams']['fee_amount'] = CRM_Utils_Array::value('fee_amount', $params);
2689         $params['trxnParams']['net_amount'] = CRM_Utils_Array::value('net_amount', $params);
2690         $params['trxnParams']['total_amount'] = $trxnParams['total_amount'] = $params['total_amount'] = $totalAmount;
2691         $params['trxnParams']['trxn_id'] = $params['contribution']->trxn_id;
2692         if (isset($totalAmount) &&
2693           $totalAmount != $params['prevContribution']->total_amount) {
2694           //Update Financial Records
2695           $params['trxnParams']['from_financial_account_id'] = NULL;
2696           self::updateFinancialAccounts($params, 'changedAmount');
2697         }
2698       }
2699
2700       if (!$update) {
2701         // records finanical trxn and entity financial trxn
2702         // also make it available as return value
2703         $return = $financialTxn = CRM_Core_BAO_FinancialTrxn::create($trxnParams);
2704         $params['entity_id'] = $financialTxn->id;
2705       }
2706     }
2707     // record line items and finacial items
2708     if (empty($params['skipLineItem'])) {
2709       CRM_Price_BAO_LineItem::processPriceSet($entityId, CRM_Utils_Array::value('line_item', $params), $params['contribution'], $entityTable, $update);
2710     }
2711
2712     // create batch entry if batch_id is passed
2713     if (!empty($params['batch_id'])) {
2714       $entityParams = array(
2715         'batch_id' => $params['batch_id'],
2716         'entity_table' => 'civicrm_financial_trxn',
2717         'entity_id' => $financialTxn->id,
2718       );
2719       CRM_Batch_BAO_Batch::addBatchEntity($entityParams);
2720     }
2721
2722     // when a fee is charged
2723     if (!empty($params['fee_amount']) && (empty($params['prevContribution']) || $params['contribution']->fee_amount != $params['prevContribution']->fee_amount) && $skipRecords) {
2724       CRM_Core_BAO_FinancialTrxn::recordFees($params);
2725     }
2726
2727     if (!empty($params['prevContribution']) && $entityTable == 'civicrm_participant'
2728       && $params['prevContribution']->contribution_status_id != $params['contribution']->contribution_status_id) {
2729       $eventID = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $entityId, 'event_id');
2730       $feeLevel[] = str_replace('\ 1', '', $params['prevContribution']->amount_level);
2731       CRM_Event_BAO_Participant::createDiscountTrxn($eventID, $params, $feeLevel);
2732     }
2733     unset($params['line_item']);
2734
2735     return $return;
2736   }
2737
2738   /**
2739    * Function to update all financial accounts entry
2740    *
2741    * @param array $params contribution object, line item array and params for trxn
2742    *
2743    * @param string $context update scenarios
2744    *
2745    * @access public
2746    * @static
2747    */
2748   static function updateFinancialAccounts(&$params, $context = NULL, $skipTrxn = NULL) {
2749     $itemAmount = $trxnID = NULL;
2750     //get all the statuses
2751     $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
2752     if (($params['prevContribution']->contribution_status_id == array_search('Pending', $contributionStatus)
2753       || $params['prevContribution']->contribution_status_id == array_search('In Progress', $contributionStatus))
2754       && $params['contribution']->contribution_status_id == array_search('Completed', $contributionStatus)
2755       && $context == 'changePaymentInstrument') {
2756       return;
2757     }
2758     if ($context == 'changedAmount' || $context == 'changeFinancialType') {
2759       $itemAmount = $params['trxnParams']['total_amount'] = $params['total_amount'] - $params['prevContribution']->total_amount;
2760     }
2761     if ($context == 'changedStatus') {
2762       //get all the statuses
2763       $contributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
2764
2765       if ($params['prevContribution']->contribution_status_id == array_search('Completed', $contributionStatus)
2766         && ($params['contribution']->contribution_status_id == array_search('Refunded', $contributionStatus)
2767         || $params['contribution']->contribution_status_id == array_search('Cancelled', $contributionStatus))) {
2768         $params['trxnParams']['total_amount'] = - $params['total_amount'];
2769       }
2770       elseif (($params['prevContribution']->contribution_status_id == array_search('Pending', $contributionStatus)
2771         && $params['prevContribution']->is_pay_later) || $params['prevContribution']->contribution_status_id == array_search('In Progress', $contributionStatus)) {
2772         $financialTypeID = CRM_Utils_Array::value('financial_type_id', $params) ? $params['financial_type_id'] : $params['prevContribution']->financial_type_id;
2773         if ($params['contribution']->contribution_status_id == array_search('Cancelled', $contributionStatus)) {
2774           $params['trxnParams']['to_financial_account_id'] = NULL;
2775           $params['trxnParams']['total_amount'] = - $params['total_amount'];
2776         }
2777         $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
2778         $params['trxnParams']['from_financial_account_id'] = CRM_Contribute_PseudoConstant::financialAccountType(
2779           $financialTypeID, $relationTypeId);
2780       }
2781       $itemAmount = $params['trxnParams']['total_amount'];
2782     }
2783     elseif ($context == 'changePaymentInstrument') {
2784       if ($params['trxnParams']['total_amount'] < 0) {
2785         $lastFinancialTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($params['prevContribution']->id, 'DESC');
2786         if (!empty($lastFinancialTrxnId['financialTrxnId'])) {
2787           $params['trxnParams']['to_financial_account_id'] = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $lastFinancialTrxnId['financialTrxnId'], 'to_financial_account_id');
2788           $params['trxnParams']['payment_instrument_id'] = $params['prevContribution']->payment_instrument_id;
2789         }
2790       }
2791       else {
2792         $params['trxnParams']['to_financial_account_id'] = $params['to_financial_account_id'];
2793         $params['trxnParams']['payment_instrument_id'] = $params['contribution']->payment_instrument_id;
2794       }
2795     }
2796     $trxn = CRM_Core_BAO_FinancialTrxn::create($params['trxnParams']);
2797     $params['entity_id'] = $trxn->id;
2798
2799     if ($context == 'changedStatus') {
2800       if (($params['prevContribution']->contribution_status_id == array_search('Pending', $contributionStatus)
2801         || $params['prevContribution']->contribution_status_id == array_search('In Progress', $contributionStatus))
2802         && ($params['contribution']->contribution_status_id == array_search('Completed', $contributionStatus))) {
2803         $query = "UPDATE civicrm_financial_item SET status_id = %1 WHERE entity_id = %2 and entity_table = 'civicrm_line_item'";
2804         $sql = "SELECT id, amount FROM civicrm_financial_item WHERE entity_id = %1 and entity_table = 'civicrm_line_item'";
2805
2806         $entityParams = array(
2807           'entity_table' => 'civicrm_financial_item',
2808           'financial_trxn_id' => $trxn->id,
2809         );
2810         foreach ($params['line_item'] as $fieldId => $fields) {
2811           foreach ($fields as $fieldValueId => $fieldValues) {
2812             $fparams = array(
2813               1 => array(CRM_Core_OptionGroup::getValue('financial_item_status', 'Paid', 'name'), 'Integer'),
2814               2 => array($fieldValues['id'], 'Integer'),
2815             );
2816             CRM_Core_DAO::executeQuery($query, $fparams);
2817             $fparams = array(
2818               1 => array($fieldValues['id'], 'Integer'),
2819             );
2820             $financialItem = CRM_Core_DAO::executeQuery($sql, $fparams);
2821             while ($financialItem->fetch()) {
2822               $entityParams['entity_id'] = $financialItem->id;
2823               $entityParams['amount'] = $financialItem->amount;
2824               CRM_Financial_BAO_FinancialItem::createEntityTrxn($entityParams);
2825             }
2826           }
2827         }
2828         return;
2829       }
2830     }
2831     if ($context != 'changePaymentInstrument') {
2832       $itemParams['entity_table'] = 'civicrm_line_item';
2833       $trxnIds['id'] = $params['entity_id'];
2834       foreach ($params['line_item'] as $fieldId => $fields) {
2835         foreach ($fields as $fieldValueId => $fieldValues) {
2836           $prevParams['entity_id'] = $fieldValues['id'];
2837           $prevfinancialItem = CRM_Financial_BAO_FinancialItem::retrieve($prevParams, CRM_Core_DAO::$_nullArray);
2838
2839           $receiveDate = CRM_Utils_Date::isoToMysql($params['prevContribution']->receive_date);
2840           if ($params['contribution']->receive_date) {
2841             $receiveDate = CRM_Utils_Date::isoToMysql($params['contribution']->receive_date);
2842           }
2843
2844           $financialAccount = $prevfinancialItem->financial_account_id;
2845           if (!empty($params['financial_account_id'])) {
2846             $financialAccount = $params['financial_account_id'];
2847           }
2848
2849           $currency = $params['prevContribution']->currency;
2850           if ($params['contribution']->currency) {
2851             $currency = $params['contribution']->currency;
2852           }
2853           if (!empty($params['is_quick_config'])) {
2854             $amount = $itemAmount;
2855             if (!$amount) {
2856               $amount = $params['total_amount'];
2857             }
2858           }
2859           else {
2860             $diff = 1;
2861             if ($context == 'changeFinancialType' || $params['contribution']->contribution_status_id == array_search('Cancelled', $contributionStatus)
2862               || $params['contribution']->contribution_status_id == array_search('Refunded', $contributionStatus)) {
2863              $diff = -1;
2864             }
2865             $amount = $diff * $fieldValues['line_total'];
2866           }
2867
2868           $itemParams = array(
2869             'transaction_date' => $receiveDate,
2870             'contact_id' => $params['prevContribution']->contact_id,
2871             'currency' => $currency,
2872             'amount' => $amount,
2873             'description' => $prevfinancialItem->description,
2874             'status_id' => $prevfinancialItem->status_id,
2875             'financial_account_id' => $financialAccount,
2876             'entity_table' => 'civicrm_line_item',
2877             'entity_id' => $fieldValues['id']
2878           );
2879           CRM_Financial_BAO_FinancialItem::create($itemParams, NULL, $trxnIds);
2880         }
2881       }
2882     }
2883   }
2884
2885   /**
2886    * Function to check status validation on update of a contribution
2887    *
2888    * @param array $values previous form values before submit
2889    *
2890    * @param array $fields the input form values
2891    *
2892    * @param array $errors list of errors
2893    *
2894    * @access public
2895    * @static
2896    */
2897   static function checkStatusValidation($values, &$fields, &$errors) {
2898     if (CRM_Utils_System::isNull($values) && !empty($fields['id'])) {
2899       $values['contribution_status_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $fields['id'], 'contribution_status_id');
2900       if ($values['contribution_status_id'] == $fields['contribution_status_id']) {
2901         return FALSE;
2902       }
2903     }
2904     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
2905     $checkStatus = array(
2906       'Cancelled' => array('Completed', 'Refunded'),
2907       'Completed' => array('Cancelled', 'Refunded'),
2908       'Pending' => array('Cancelled', 'Completed', 'Failed'),
2909       'In Progress' => array('Cancelled', 'Completed', 'Failed'),
2910       'Refunded' => array('Cancelled', 'Completed')
2911     );
2912
2913     if (!in_array($contributionStatuses[$fields['contribution_status_id']], $checkStatus[$contributionStatuses[$values['contribution_status_id']]])) {
2914       $errors['contribution_status_id'] = ts("Cannot change contribution status from %1 to %2.", array(1 => $contributionStatuses[$values['contribution_status_id']], 2 => $contributionStatuses[$fields['contribution_status_id']]));
2915     }
2916   }
2917
2918   /**
2919    * Function to delete contribution of contact
2920    *
2921    * CRM-12155
2922    *
2923    * @param integer $contactId contact id
2924    *
2925    * @access public
2926    * @static
2927    */
2928   static function deleteContactContribution($contactId) {
2929     $contribution = new CRM_Contribute_DAO_Contribution();
2930     $contribution->contact_id = $contactId;
2931     $contribution->find();
2932     while ($contribution->fetch()) {
2933       self::deleteContribution($contribution->id);
2934     }
2935   }
2936
2937   /**
2938    * Get options for a given contribution field.
2939    * @see CRM_Core_DAO::buildOptions
2940    *
2941    * @param String $fieldName
2942    * @param String $context: @see CRM_Core_DAO::buildOptionsContext
2943    * @param Array $props: whatever is known about this dao object
2944    */
2945   public static function buildOptions($fieldName, $context = NULL, $props = array()) {
2946     $className = __CLASS__;
2947     $params = array();
2948     switch ($fieldName) {
2949       // This field is not part of this object but the api supports it
2950       case 'payment_processor':
2951         $className = 'CRM_Contribute_BAO_ContributionPage';
2952         // Filter results by contribution page
2953         if (!empty($props['contribution_page_id'])) {
2954           $page = civicrm_api('contribution_page', 'getsingle', array(
2955             'version' => 3,
2956             'id' => ($props['contribution_page_id'])
2957           ));
2958           $types = (array) CRM_Utils_Array::value('payment_processor', $page, 0);
2959           $params['condition'] = 'id IN (' . implode(',', $types) . ')';
2960         }
2961     }
2962     return CRM_Core_PseudoConstant::get($className, $fieldName, $params, $context);
2963   }
2964
2965   /**
2966    * Function to validate financial type
2967    *
2968    * CRM-13231
2969    *
2970    * @param integer $financialTypeId Financial Type id
2971    *
2972    * @access public
2973    * @static
2974    */
2975   static function validateFinancialType($financialTypeId, $relationName = 'Expense Account is') {
2976     $expenseTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE '{$relationName}' "));
2977     $financialAccount = CRM_Contribute_PseudoConstant::financialAccountType($financialTypeId, $expenseTypeId);
2978
2979     if (!$financialAccount) {
2980       return CRM_Contribute_PseudoConstant::financialType($financialTypeId);
2981     }
2982     return FALSE;
2983   }
2984
2985
2986   /*
2987    * Function to record additional payment for partial and refund contributions
2988    *
2989    * @param integer $contributionId : is the invoice contribution id (got created after processing participant payment)
2990    * @param array $trxnData : to take user provided input of transaction details.
2991    * @param string $paymentType 'owed' for purpose of recording partial payments, 'refund' for purpose of recording refund payments
2992    */
2993   static function recordAdditionalPayment($contributionId, $trxnsData, $paymentType = 'owed', $participantId = NULL) {
2994     $statusId = CRM_Core_OptionGroup::getValue('contribution_status', 'Completed', 'name');
2995     $getInfoOf['id'] = $contributionId;
2996     $defaults = array();
2997     $contributionDAO = CRM_Contribute_BAO_Contribution::retrieve($getInfoOf, $defaults, CRM_Core_DAO::$_nullArray);
2998
2999     if ($paymentType == 'owed') {
3000       // build params for recording financial trxn entry
3001       $params['contribution'] = $contributionDAO;
3002       $params = array_merge($defaults, $params);
3003       $params['skipLineItem'] = TRUE;
3004       $params['partial_payment_total'] = $contributionDAO->total_amount;
3005       $params['partial_amount_pay'] = $trxnsData['total_amount'];
3006       $trxnsData['trxn_date'] = !empty($trxnsData['trxn_date']) ? $trxnsData['trxn_date'] : date('YmdHis');
3007
3008       // record the entry
3009       $financialTrxn = CRM_Contribute_BAO_Contribution::recordFinancialAccounts($params, $trxnsData);
3010       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3011       $toFinancialAccount = CRM_Contribute_PseudoConstant::financialAccountType($contributionDAO->financial_type_id, $relationTypeId);
3012
3013       $trxnId = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($contributionId, $contributionDAO->financial_type_id);
3014       $trxnId = $trxnId['trxn_id'];
3015
3016       // update statuses
3017       // criteria for updates contribution total_amount == financial_trxns of partial_payments
3018       $sql = "SELECT SUM(ft.total_amount) as sum_of_payments
3019 FROM civicrm_financial_trxn ft
3020 LEFT JOIN civicrm_entity_financial_trxn eft
3021   ON (ft.id = eft.financial_trxn_id)
3022 WHERE eft.entity_table = 'civicrm_contribution'
3023   AND eft.entity_id = {$contributionId}
3024   AND ft.to_financial_account_id != {$toFinancialAccount}
3025   AND ft.status_id = {$statusId}
3026 ";
3027       $sumOfPayments = CRM_Core_DAO::singleValueQuery($sql);
3028
3029       // update statuses
3030       if ($contributionDAO->total_amount == $sumOfPayments) {
3031         // update contribution status
3032         $contributionUpdate['id'] = $contributionId;
3033         $contributionUpdate['contribution_status_id'] = $statusId;
3034         $contributionUpdate['skipLineItem'] = TRUE;
3035         // note : not using the self::add method,
3036         // the reason because it performs 'status change' related code execution for financial records
3037         // which in 'Partial Paid' => 'Completed' is not useful, instead specific financial record updates
3038         // are coded below i.e. just updating financial_item status to 'Paid'
3039         $contributionDetails = CRM_Core_DAO::setFieldValue('CRM_Contribute_BAO_Contribution', $contributionId, 'contribution_status_id', $statusId);
3040
3041         if ($participantId) {
3042           // update participant status
3043           $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
3044           $ids = CRM_Event_BAO_Participant::getParticipantIds($contributionId);
3045           foreach ($ids as $val) {
3046             $participantUpdate['id'] = $val;
3047             $participantUpdate['status_id'] = array_search('Registered', $participantStatuses);
3048             CRM_Event_BAO_Participant::add($participantUpdate);
3049           }
3050         }
3051
3052         // update financial item statuses
3053         $financialItemStatus = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_FinancialItem', 'status_id');
3054         $paidStatus = array_search('Paid', $financialItemStatus);
3055
3056         $baseTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($contributionId);
3057         $sqlFinancialItemUpdate = "
3058 UPDATE civicrm_financial_item fi
3059   LEFT JOIN civicrm_entity_financial_trxn eft
3060     ON (eft.entity_id = fi.id AND eft.entity_table = 'civicrm_financial_item')
3061 SET status_id = {$paidStatus}
3062 WHERE eft.financial_trxn_id IN ({$trxnId}, {$baseTrxnId['financialTrxnId']})
3063 ";
3064         CRM_Core_DAO::executeQuery($sqlFinancialItemUpdate);
3065       }
3066     }
3067     elseif ($paymentType == 'refund') {
3068       // build params for recording financial trxn entry
3069       $params['contribution'] = $contributionDAO;
3070       $params = array_merge($defaults, $params);
3071       $params['skipLineItem'] = TRUE;
3072       $trxnsData['trxn_date'] = !empty($trxnsData['trxn_date']) ? $trxnsData['trxn_date'] : date('YmdHis');
3073       $trxnsData['total_amount'] = - $trxnsData['total_amount'];
3074
3075       $relationTypeId = key(CRM_Core_PseudoConstant::accountOptionValues('account_relationship', NULL, " AND v.name LIKE 'Accounts Receivable Account is' "));
3076       $trxnsData['from_financial_account_id'] = CRM_Contribute_PseudoConstant::financialAccountType($contributionDAO->financial_type_id, $relationTypeId);
3077       $trxnsData['status_id'] = CRM_Core_OptionGroup::getValue('contribution_status', 'Refunded', 'name');
3078       // record the entry
3079       $financialTrxn = CRM_Contribute_BAO_Contribution::recordFinancialAccounts($params, $trxnsData);
3080
3081       // note : not using the self::add method,
3082       // the reason because it performs 'status change' related code execution for financial records
3083       // which in 'Pending Refund' => 'Completed' is not useful, instead specific financial record updates
3084       // are coded below i.e. just updating financial_item status to 'Paid'
3085       $contributionDetails = CRM_Core_DAO::setFieldValue('CRM_Contribute_BAO_Contribution', $contributionId, 'contribution_status_id', $statusId);
3086
3087       // add financial item entry
3088       $financialItemStatus = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_FinancialItem', 'status_id');
3089       $getLine['entity_id'] = $contributionDAO->id;
3090       $getLine['entity_table'] = 'civicrm_contribution';
3091       $lineItemId = CRM_Price_BAO_LineItem::retrieve($getLine, CRM_Core_DAO::$_nullArray);
3092       if (!empty($lineItemId->id)) {
3093         $addFinancialEntry = array(
3094           'transaction_date' => $financialTrxn->trxn_date,
3095           'contact_id' => $contributionDAO->contact_id,
3096           'amount' => $financialTrxn->total_amount,
3097           'status_id' => array_search('Paid', $financialItemStatus),
3098           'entity_id' => $lineItemId->id,
3099           'entity_table' => 'civicrm_line_item'
3100         );
3101         $trxnIds['id'] =  $financialTrxn->id;
3102         CRM_Financial_BAO_FinancialItem::create($addFinancialEntry, NULL, $trxnIds);
3103       }
3104       if ($participantId) {
3105         // update participant status
3106         $participantStatuses = CRM_Event_PseudoConstant::participantStatus();
3107         $ids = CRM_Event_BAO_Participant::getParticipantIds($contributionId);
3108         foreach ($ids as $val) {
3109           $participantUpdate['id'] = $val;
3110           $participantUpdate['status_id'] = array_search('Registered', $participantStatuses);
3111           CRM_Event_BAO_Participant::add($participantUpdate);
3112         }
3113       }
3114     }
3115
3116     // activity creation
3117     if (!empty($financialTrxn)) {
3118       if ($participantId) {
3119         $inputParams['id'] = $participantId;
3120         $values = array();
3121         $ids = array();
3122         $component = 'event';
3123         $entityObj = CRM_Event_BAO_Participant::getValues($inputParams, $values, $ids);
3124         $entityObj = $entityObj[$participantId];
3125       }
3126       $activityType = ($paymentType == 'refund') ? 'Refund' : 'Payment';
3127
3128       self::addActivityForPayment($entityObj, $financialTrxn, $activityType, $component, $contributionId);
3129     }
3130     return $financialTrxn;
3131   }
3132
3133   static function addActivityForPayment($entityObj, $trxnObj, $activityType, $component, $contributionId) {
3134     if ($component == 'event') {
3135       $date = CRM_Utils_Date::isoToMysql($trxnObj->trxn_date);
3136       $paymentAmount = CRM_Utils_Money::format($trxnObj->total_amount, $trxnObj->currency);
3137       $eventTitle = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Event', $entityObj->event_id, 'title');
3138       $subject = "{$paymentAmount} - Offline {$activityType} for {$eventTitle}";
3139       $targetCid = $entityObj->contact_id;
3140       // source record id would be the contribution id
3141       $srcRecId = $contributionId;
3142     }
3143
3144     // activity params
3145     $activityParams = array(
3146       'source_contact_id' => $targetCid,
3147       'source_record_id' => $srcRecId,
3148       'activity_type_id' => CRM_Core_OptionGroup::getValue('activity_type',
3149         $activityType,
3150         'name'
3151       ),
3152       'subject' => $subject,
3153       'activity_date_time' => $date,
3154       'status_id' => CRM_Core_OptionGroup::getValue('activity_status',
3155         'Completed',
3156         'name'
3157       ),
3158       'skipRecentView' => TRUE,
3159     );
3160
3161     // create activity with target contacts
3162     $session = CRM_Core_Session::singleton();
3163     $id = $session->get('userID');
3164     if ($id) {
3165       $activityParams['source_contact_id'] = $id;
3166       $activityParams['target_contact_id'][] = $targetCid;
3167     }
3168     CRM_Activity_BAO_Activity::create($activityParams);
3169   }
3170
3171   static function getPaymentInfo($id, $component, $getTrxnInfo = FALSE, $usingLineTotal = FALSE) {
3172     if ($component == 'event') {
3173       $entity = 'participant';
3174       $entityTable = 'civicrm_participant';
3175       $contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'contribution_id', 'participant_id');
3176
3177       if (!$contributionId) {
3178         if ($primaryParticipantId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Participant', $id, 'registered_by_id')) {
3179           $contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $primaryParticipantId, 'contribution_id', 'participant_id');
3180           $id = $primaryParticipantId;
3181         }
3182       }
3183     }
3184     $total = CRM_Core_BAO_FinancialTrxn::getBalanceTrxnAmt($contributionId);
3185     $baseTrxnId = !empty($total['trxn_id']) ? $total['trxn_id'] : NULL;
3186     $isBalance = NULL;
3187     if ($baseTrxnId) {
3188       $isBalance = TRUE;
3189     }
3190     else {
3191       $baseTrxnId = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($contributionId);
3192       $baseTrxnId = $baseTrxnId['financialTrxnId'];
3193       $isBalance = FALSE;
3194     }
3195     if (empty($total) || $usingLineTotal) {
3196       // for additional participants
3197       if ($entityTable == 'civicrm_participant') {
3198        $ids = CRM_Event_BAO_Participant::getParticipantIds($contributionId);
3199        $total = 0;
3200        foreach ($ids as $val) {
3201          $total += CRM_Price_BAO_LineItem::getLineTotal($val, $entityTable);
3202        }
3203       }
3204       else {
3205         $total = CRM_Price_BAO_LineItem::getLineTotal($id, $entityTable);
3206       }
3207     }
3208     else {
3209       $baseTrxnId = $total['trxn_id'];
3210       $total = $total['total_amount'];
3211     }
3212
3213     $paymentBalance = CRM_Core_BAO_FinancialTrxn::getPartialPaymentWithType($id, $entity, FALSE, $total);
3214     $contributionIsPayLater = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $contributionId, 'is_pay_later');
3215     if ($paymentBalance == 0 && $contributionIsPayLater) {
3216       $paymentBalance = $total;
3217     }
3218
3219     $info['total'] = $total;
3220     $info['paid'] = $total - $paymentBalance;
3221     $info['balance'] = $paymentBalance;
3222     $info['id'] = $id;
3223     $info['component'] = $component;
3224     $info['payLater'] = $contributionIsPayLater;
3225     $rows = array();
3226     if ($getTrxnInfo && $baseTrxnId) {
3227       $sql = "
3228 SELECT ft.total_amount, con.financial_type_id, ft.payment_instrument_id, ft.trxn_date, ft.trxn_id, ft.status_id, ft.check_number
3229 FROM civicrm_contribution con
3230   LEFT JOIN civicrm_entity_financial_trxn eft ON (eft.entity_id = con.id AND eft.entity_table = 'civicrm_contribution')
3231   LEFT JOIN civicrm_financial_trxn ft ON ft.id = eft.financial_trxn_id
3232 WHERE con.id = {$contributionId}
3233 ";
3234
3235       // conditioned WHERE clause
3236       if ($isBalance) {
3237         // if balance trxn exists don't include details of it in transaction info
3238         $sql .= " AND ft.id != {$baseTrxnId} ";
3239       }
3240       $resultDAO = CRM_Core_DAO::executeQuery($sql);
3241
3242       $statuses = CRM_Contribute_PseudoConstant::contributionStatus();
3243       $financialTypes = CRM_Contribute_PseudoConstant::financialType();
3244       while($resultDAO->fetch()) {
3245         $paidByLabel = CRM_Core_PseudoConstant::getLabel('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id);
3246         $paidByName = CRM_Core_PseudoConstant::getName('CRM_Core_BAO_FinancialTrxn', 'payment_instrument_id', $resultDAO->payment_instrument_id);
3247         $val = array(
3248           'total_amount' => $resultDAO->total_amount,
3249           'financial_type' => $financialTypes[$resultDAO->financial_type_id],
3250           'payment_instrument' => $paidByLabel,
3251           'receive_date' => $resultDAO->trxn_date,
3252           'trxn_id' => $resultDAO->trxn_id,
3253           'status' => $statuses[$resultDAO->status_id],
3254         );
3255         if ($paidByName == 'Check') {
3256           $val['check_number'] = $resultDAO->check_number;
3257         }
3258         $rows[] = $val;
3259       }
3260       $info['transaction'] = $rows;
3261     }
3262     return $info;
3263   }
3264 }