CRM/Contribute/Form/Contribution/Confirm.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2015
  32  */
  33
  34 /**
  35  * form to process actions on the group aspect of Custom Data
  36  */
  37 class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_ContributionBase {
  38
  39   /**
  40    * The id of the contact associated with this contribution.
  41    *
  42    * @var int
  43    */
  44   public $_contactID;
  45
  46
  47   /**
  48    * The id of the contribution object that is created when the form is submitted.
  49    *
  50    * @var int
  51    */
  52   public $_contributionID;
  53
  54   /**
  55    * Set the parameters to be passed to contribution create function.
  56    *
  57    * @param array $params
  58    * @param int $contactID
  59    * @param int $financialTypeID
  60    * @param bool $online
  61    * @param int $contributionPageId
  62    * @param float $nonDeductibleAmount
  63    * @param int $campaignId
  64    * @param bool $isMonetary
  65    * @param bool $pending
  66    * @param $paymentProcessorOutcome
  67    * @param $receiptDate
  68    * @param int $recurringContributionID
  69    * @param $isTest
  70    * @param int $addressID
  71    * @param int $softCreditToID
  72    * @param array $lineItems
  73    *
  74    * @return array
  75    */
  76   public static function getContributionParams(
  77     $params, $contactID, $financialTypeID, $online, $contributionPageId, $nonDeductibleAmount, $campaignId, $isMonetary, $pending,
  78     $paymentProcessorOutcome, $receiptDate, $recurringContributionID, $isTest, $addressID, $softCreditToID, $lineItems) {
  79     $contributionParams = array(
  80       'contact_id' => $contactID,
  81       'financial_type_id' => $financialTypeID,
  82       'contribution_page_id' => $contributionPageId,
  83       'receive_date' => (CRM_Utils_Array::value('receive_date', $params)) ? CRM_Utils_Date::processDate($params['receive_date']) : date('YmdHis'),
  84       'non_deductible_amount' => $nonDeductibleAmount,
  85       'total_amount' => $params['amount'],
  86       'tax_amount' => CRM_Utils_Array::value('tax_amount', $params),
  87       'amount_level' => CRM_Utils_Array::value('amount_level', $params),
  88       'invoice_id' => $params['invoiceID'],
  89       'currency' => $params['currencyID'],
  90       'source' => (!$online || !empty($params['source'])) ? CRM_Utils_Array::value('source', $params) : CRM_Utils_Array::value('description', $params),
  91       'is_pay_later' => CRM_Utils_Array::value('is_pay_later', $params, 0),
  92       //configure cancel reason, cancel date and thankyou date
  93       //from 'contribution' type profile if included
  94       'cancel_reason' => CRM_Utils_Array::value('cancel_reason', $params, 0),
  95       'cancel_date' => isset($params['cancel_date']) ? CRM_Utils_Date::format($params['cancel_date']) : NULL,
  96       'thankyou_date' => isset($params['thankyou_date']) ? CRM_Utils_Date::format($params['thankyou_date']) : NULL,
  97       'campaign_id' => $campaignId,
  98       'is_test' => $isTest,
  99       'address_id' => $addressID,
 100       //setting to make available to hook - although seems wrong to set on form for BAO hook availability
 101       'soft_credit_to' => $softCreditToID,
 102       'line_item' => $lineItems,
 103       'skipLineItem' => CRM_Utils_Array::value('skipLineItem', $params, 0),
 104     );
 105     if (!$online && isset($params['thankyou_date'])) {
 106       $contributionParam['thankyou_date'] = $params['thankyou_date'];
 107     }
 108     if (!$online || $isMonetary) {
 109       if (empty($params['is_pay_later'])) {
 110         $contributionParams['payment_instrument_id'] = 1;
 111       }
 112     }
 113     if ($paymentProcessorOutcome) {
 114       $contributionParams['payment_processor'] = CRM_Utils_Array::value('payment_processor', $paymentProcessorOutcome);
 115     }
 116     if (!$pending && $paymentProcessorOutcome) {
 117       $contributionParams += array(
 118         'fee_amount' => CRM_Utils_Array::value('fee_amount', $paymentProcessorOutcome),
 119         'net_amount' => CRM_Utils_Array::value('net_amount', $paymentProcessorOutcome, $params['amount']),
 120         'trxn_id' => $paymentProcessorOutcome['trxn_id'],
 121         'receipt_date' => $receiptDate,
 122         // also add financial_trxn details as part of fix for CRM-4724
 123         'trxn_result_code' => CRM_Utils_Array::value('trxn_result_code', $paymentProcessorOutcome),
 124       );
 125     }
 126
 127     // CRM-4038: for non-en_US locales, CRM_Contribute_BAO_Contribution::add() expects localised amounts
 128     $contributionParams['non_deductible_amount'] = trim(CRM_Utils_Money::format($contributionParams['non_deductible_amount'], ' '));
 129     $contributionParams['total_amount'] = trim(CRM_Utils_Money::format($contributionParams['total_amount'], ' '));
 130
 131     if ($recurringContributionID) {
 132       $contributionParams['contribution_recur_id'] = $recurringContributionID;
 133     }
 134
 135     $contributionParams['contribution_status_id'] = $pending ? 2 : 1;
 136     if (isset($contributionParams['invoice_id'])) {
 137       $contributionParams['id'] = CRM_Core_DAO::getFieldValue(
 138         'CRM_Contribute_DAO_Contribution',
 139         $contributionParams['invoice_id'],
 140         'id',
 141         'invoice_id'
 142       );
 143     }
 144
 145     return $contributionParams;
 146   }
 147
 148   /**
 149    * Get non-deductible amount.
 150    *
 151    * This is a bit too much about wierd form interpretation to be this deep.
 152    *
 153    * CRM-11885
 154    *  if non_deductible_amount exists i.e. Additional Details fieldset was opened [and staff typed something] -> keep
 155    * it.
 156    *
 157    * @param array $params
 158    * @param CRM_Financial_BAO_FinancialType $financialType
 159    * @param bool $online
 160    *
 161    * @return array
 162    */
 163   protected static function getNonDeductibleAmount($params, $financialType, $online) {
 164     if (isset($params['non_deductible_amount']) && (!empty($params['non_deductible_amount']))) {
 165       return $params['non_deductible_amount'];
 166     }
 167     else {
 168       if ($financialType->is_deductible) {
 169         if ($online && isset($params['selectProduct'])) {
 170           $selectProduct = CRM_Utils_Array::value('selectProduct', $params);
 171         }
 172         if (!$online && isset($params['product_name'][0])) {
 173           $selectProduct = $params['product_name'][0];
 174         }
 175         // if there is a product - compare the value to the contribution amount
 176         if (isset($selectProduct) &&
 177           $selectProduct != 'no_thanks'
 178         ) {
 179           $productDAO = new CRM_Contribute_DAO_Product();
 180           $productDAO->id = $selectProduct;
 181           $productDAO->find(TRUE);
 182           // product value exceeds contribution amount
 183           if ($params['amount'] < $productDAO->price) {
 184             $nonDeductibleAmount = $params['amount'];
 185             return $nonDeductibleAmount;
 186           }
 187           // product value does NOT exceed contribution amount
 188           else {
 189             return $productDAO->price;
 190           }
 191         }
 192         // contribution is deductible - but there is no product
 193         else {
 194           return '0.00';
 195         }
 196       }
 197       // contribution is NOT deductible
 198       else {
 199         return $params['amount'];
 200       }
 201     }
 202   }
 203
 204   /**
 205    * Set variables up before form is built.
 206    */
 207   public function preProcess() {
 208     $config = CRM_Core_Config::singleton();
 209     parent::preProcess();
 210
 211     // lineItem isn't set until Register postProcess
 212     $this->_lineItem = $this->get('lineItem');
 213     $this->_paymentProcessor = $this->get('paymentProcessor');
 214
 215     if ($this->_contributeMode == 'express') {
 216       // rfp == redirect from paypal
 217       $rfp = CRM_Utils_Request::retrieve('rfp', 'Boolean',
 218         CRM_Core_DAO::$_nullObject, FALSE, NULL, 'GET'
 219       );
 220       if ($rfp) {
 221         $payment = CRM_Core_Payment::singleton($this->_mode, $this->_paymentProcessor, $this);
 222         $expressParams = $payment->getExpressCheckoutDetails($this->get('token'));
 223
 224         $this->_params['payer'] = CRM_Utils_Array::value('payer', $expressParams);
 225         $this->_params['payer_id'] = $expressParams['payer_id'];
 226         $this->_params['payer_status'] = $expressParams['payer_status'];
 227
 228         CRM_Core_Payment_Form::mapParams($this->_bltID, $expressParams, $this->_params, FALSE);
 229
 230         // fix state and country id if present
 231         if (!empty($this->_params["billing_state_province_id-{$this->_bltID}"])) {
 232           $this->_params["billing_state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant::stateProvinceAbbreviation($this->_params["billing_state_province_id-{$this->_bltID}"]);
 233         }
 234         if (!empty($this->_params["billing_country_id-{$this->_bltID}"]) && $this->_params["billing_country_id-{$this->_bltID}"]) {
 235           $this->_params["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant::countryIsoCode($this->_params["billing_country_id-{$this->_bltID}"]);
 236         }
 237
 238         // set a few other parameters for PayPal
 239         $this->_params['token'] = $this->get('token');
 240
 241         $this->_params['amount'] = $this->get('amount');
 242
 243         if (!empty($this->_membershipBlock)) {
 244           $this->_params['selectMembership'] = $this->get('selectMembership');
 245         }
 246         // we use this here to incorporate any changes made by folks in hooks
 247         $this->_params['currencyID'] = $config->defaultCurrency;
 248
 249         // also merge all the other values from the profile fields
 250         $values = $this->controller->exportValues('Main');
 251         $skipFields = array(
 252           'amount',
 253           'amount_other',
 254           "billing_street_address-{$this->_bltID}",
 255           "billing_city-{$this->_bltID}",
 256           "billing_state_province_id-{$this->_bltID}",
 257           "billing_postal_code-{$this->_bltID}",
 258           "billing_country_id-{$this->_bltID}",
 259         );
 260         foreach ($values as $name => $value) {
 261           // skip amount field
 262           if (!in_array($name, $skipFields)) {
 263             $this->_params[$name] = $value;
 264           }
 265         }
 266         $this->set('getExpressCheckoutDetails', $this->_params);
 267       }
 268       else {
 269         $this->_params = $this->get('getExpressCheckoutDetails');
 270       }
 271     }
 272     else {
 273       $this->_params = $this->controller->exportValues('Main');
 274
 275       if (!empty($this->_params["billing_state_province_id-{$this->_bltID}"])) {
 276         $this->_params["billing_state_province-{$this->_bltID}"] = CRM_Core_PseudoConstant::stateProvinceAbbreviation($this->_params["billing_state_province_id-{$this->_bltID}"]);
 277       }
 278       if (!empty($this->_params["billing_country_id-{$this->_bltID}"])) {
 279         $this->_params["billing_country-{$this->_bltID}"] = CRM_Core_PseudoConstant::countryIsoCode($this->_params["billing_country_id-{$this->_bltID}"]);
 280       }
 281
 282       if (isset($this->_params['credit_card_exp_date'])) {
 283         $this->_params['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($this->_params);
 284         $this->_params['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($this->_params);
 285       }
 286
 287       $this->_params['ip_address'] = CRM_Utils_System::ipAddress();
 288       $this->_params['amount'] = $this->get('amount');
 289       $this->_params['tax_amount'] = $this->get('tax_amount');
 290
 291       $this->_useForMember = $this->get('useForMember');
 292
 293       if (isset($this->_params['amount'])) {
 294         $this->setFormAmountFields($this->_params['priceSetId']);
 295       }
 296       $this->_params['currencyID'] = $config->defaultCurrency;
 297     }
 298
 299     $this->_params['is_pay_later'] = $this->get('is_pay_later');
 300     $this->assign('is_pay_later', $this->_params['is_pay_later']);
 301     if ($this->_params['is_pay_later']) {
 302       $this->assign('pay_later_receipt', $this->_values['pay_later_receipt']);
 303     }
 304     // if onbehalf-of-organization
 305     if (!empty($this->_params['hidden_onbehalf_profile'])) {
 306       // CRM-15182
 307       if (empty($this->_params['org_option']) && empty($this->_params['organization_id'])) {
 308         if (!empty($this->_params['onbehalfof_id'])) {
 309           $this->_params['organization_id'] = $this->_params['onbehalfof_id'];
 310         }
 311         else {
 312           $this->_params['organization_id'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_params['onbehalf']['organization_name'], 'id', 'display_name');
 313         }
 314       }
 315
 316       $this->_params['organization_name'] = $this->_params['onbehalf']['organization_name'];
 317       $addressBlocks = array(
 318         'street_address',
 319         'city',
 320         'state_province',
 321         'postal_code',
 322         'country',
 323         'supplemental_address_1',
 324         'supplemental_address_2',
 325         'supplemental_address_3',
 326         'postal_code_suffix',
 327         'geo_code_1',
 328         'geo_code_2',
 329         'address_name',
 330       );
 331
 332       $blocks = array('email', 'phone', 'im', 'url', 'openid');
 333       foreach ($this->_params['onbehalf'] as $loc => $value) {
 334         $field = $typeId = NULL;
 335         if (strstr($loc, '-')) {
 336           list($field, $locType) = explode('-', $loc);
 337         }
 338
 339         if (in_array($field, $addressBlocks)) {
 340           if ($locType == 'Primary') {
 341             $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
 342             $locType = $defaultLocationType->id;
 343           }
 344
 345           if ($field == 'country') {
 346             $value = CRM_Core_PseudoConstant::countryIsoCode($value);
 347           }
 348           elseif ($field == 'state_province') {
 349             $value = CRM_Core_PseudoConstant::stateProvinceAbbreviation($value);
 350           }
 351
 352           $isPrimary = 1;
 353           if (isset($this->_params['onbehalf_location']['address'])
 354             && count($this->_params['onbehalf_location']['address']) > 0
 355           ) {
 356             $isPrimary = 0;
 357           }
 358
 359           $this->_params['onbehalf_location']['address'][$locType][$field] = $value;
 360           if (empty($this->_params['onbehalf_location']['address'][$locType]['is_primary'])) {
 361             $this->_params['onbehalf_location']['address'][$locType]['is_primary'] = $isPrimary;
 362           }
 363           $this->_params['onbehalf_location']['address'][$locType]['location_type_id'] = $locType;
 364         }
 365         elseif (in_array($field, $blocks)) {
 366           if (!$typeId || is_numeric($typeId)) {
 367             $blockName = $fieldName = $field;
 368             $locationType = 'location_type_id';
 369             if ($locType == 'Primary') {
 370               $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
 371               $locationValue = $defaultLocationType->id;
 372             }
 373             else {
 374               $locationValue = $locType;
 375             }
 376             $locTypeId = '';
 377             $phoneExtField = array();
 378
 379             if ($field == 'url') {
 380               $blockName = 'website';
 381               $locationType = 'website_type_id';
 382               list($field, $locationValue) = explode('-', $loc);
 383             }
 384             elseif ($field == 'im') {
 385               $fieldName = 'name';
 386               $locTypeId = 'provider_id';
 387               $typeId = $this->_params['onbehalf']["{$loc}-provider_id"];
 388             }
 389             elseif ($field == 'phone') {
 390               list($field, $locType, $typeId) = explode('-', $loc);
 391               $locTypeId = 'phone_type_id';
 392
 393               //check if extension field exists
 394               $extField = str_replace('phone', 'phone_ext', $loc);
 395               if (isset($this->_params['onbehalf'][$extField])) {
 396                 $phoneExtField = array('phone_ext' => $this->_params['onbehalf'][$extField]);
 397               }
 398             }
 399
 400             $isPrimary = 1;
 401             if (isset ($this->_params['onbehalf_location'][$blockName])
 402               && count($this->_params['onbehalf_location'][$blockName]) > 0
 403             ) {
 404               $isPrimary = 0;
 405             }
 406             if ($locationValue) {
 407               $blockValues = array(
 408                 $fieldName => $value,
 409                 $locationType => $locationValue,
 410                 'is_primary' => $isPrimary,
 411               );
 412
 413               if ($locTypeId) {
 414                 $blockValues = array_merge($blockValues, array($locTypeId => $typeId));
 415               }
 416               if (!empty($phoneExtField)) {
 417                 $blockValues = array_merge($blockValues, $phoneExtField);
 418               }
 419
 420               $this->_params['onbehalf_location'][$blockName][] = $blockValues;
 421             }
 422           }
 423         }
 424         elseif (strstr($loc, 'custom')) {
 425           if ($value && isset($this->_params['onbehalf']["{$loc}_id"])) {
 426             $value = $this->_params['onbehalf']["{$loc}_id"];
 427           }
 428           $this->_params['onbehalf_location']["{$loc}"] = $value;
 429         }
 430         else {
 431           if ($loc == 'contact_sub_type') {
 432             $this->_params['onbehalf_location'][$loc] = $value;
 433           }
 434           else {
 435             $this->_params['onbehalf_location'][$field] = $value;
 436           }
 437         }
 438       }
 439     }
 440     elseif (!empty($this->_values['is_for_organization'])) {
 441       // no on behalf of an organization, CRM-5519
 442       // so reset loc blocks from main params.
 443       foreach (array(
 444                  'phone',
 445                  'email',
 446                  'address',
 447                ) as $blk) {
 448         if (isset($this->_params[$blk])) {
 449           unset($this->_params[$blk]);
 450         }
 451       }
 452     }
 453
 454     // if auto renew checkbox is set, initiate a open-ended recurring membership
 455     if ((!empty($this->_params['selectMembership']) || !empty($this->_params['priceSetId'])) && !empty($this->_paymentProcessor['is_recur']) &&
 456       CRM_Utils_Array::value('auto_renew', $this->_params) && empty($this->_params['is_recur']) && empty($this->_params['frequency_interval'])
 457     ) {
 458
 459       $this->_params['is_recur'] = $this->_values['is_recur'] = 1;
 460       // check if price set is not quick config
 461       if (!empty($this->_params['priceSetId']) && !CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_params['priceSetId'], 'is_quick_config')) {
 462         list($this->_params['frequency_interval'], $this->_params['frequency_unit']) = CRM_Price_BAO_PriceSet::getRecurDetails($this->_params['priceSetId']);
 463       }
 464       else {
 465         // FIXME: set interval and unit based on selected membership type
 466         $this->_params['frequency_interval'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 467           $this->_params['selectMembership'], 'duration_interval'
 468         );
 469         $this->_params['frequency_unit'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
 470           $this->_params['selectMembership'], 'duration_unit'
 471         );
 472       }
 473     }
 474
 475     if ($this->_pcpId) {
 476       $params = $this->processPcp($this, $this->_params);
 477       $this->_params = $params;
 478     }
 479     $this->_params['invoiceID'] = $this->get('invoiceID');
 480
 481     //carry campaign from profile.
 482     if (array_key_exists('contribution_campaign_id', $this->_params)) {
 483       $this->_params['campaign_id'] = $this->_params['contribution_campaign_id'];
 484     }
 485
 486     // assign contribution page id to the template so we can add css class for it
 487     $this->assign('contributionPageID', $this->_id);
 488
 489     $this->set('params', $this->_params);
 490   }
 491
 492   /**
 493    * Build the form object.
 494    */
 495   public function buildQuickForm() {
 496     $this->assignToTemplate();
 497
 498     $params = $this->_params;
 499     // make sure we have values for it
 500     if ($this->_honor_block_is_active && !empty($params['soft_credit_type_id'])) {
 501       $honorName = NULL;
 502       $softCreditTypes = CRM_Core_OptionGroup::values("soft_credit_type", FALSE);
 503
 504       $this->assign('honor_block_is_active', $this->_honor_block_is_active);
 505       $this->assign('soft_credit_type', $softCreditTypes[$params['soft_credit_type_id']]);
 506       CRM_Contribute_BAO_ContributionSoft::formatHonoreeProfileFields($this, $params['honor'], $params['honoree_profile_id']);
 507
 508       $fieldTypes = array('Contact');
 509       $fieldTypes[] = CRM_Core_BAO_UFGroup::getContactType($params['honoree_profile_id']);
 510       $this->buildCustom($params['honoree_profile_id'], 'honoreeProfileFields', TRUE, 'honor', $fieldTypes);
 511     }
 512     $this->assign('receiptFromEmail', CRM_Utils_Array::value('receipt_from_email', $this->_values));
 513     $amount_block_is_active = $this->get('amount_block_is_active');
 514     $this->assign('amount_block_is_active', $amount_block_is_active);
 515
 516     $invoiceSettings = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME, 'contribution_invoice_settings');
 517     $invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings);
 518     if ($invoicing) {
 519       $getTaxDetails = FALSE;
 520       $taxTerm = CRM_Utils_Array::value('tax_term', $invoiceSettings);
 521       foreach ($this->_lineItem as $key => $value) {
 522         foreach ($value as $v) {
 523           if (isset($v['tax_rate'])) {
 524             if ($v['tax_rate'] != '') {
 525               $getTaxDetails = TRUE;
 526             }
 527           }
 528         }
 529       }
 530       $this->assign('getTaxDetails', $getTaxDetails);
 531       $this->assign('taxTerm', $taxTerm);
 532       $this->assign('totalTaxAmount', $params['tax_amount']);
 533     }
 534     if (!empty($params['selectProduct']) && $params['selectProduct'] != 'no_thanks') {
 535       $option = CRM_Utils_Array::value('options_' . $params['selectProduct'], $params);
 536       $productID = $params['selectProduct'];
 537       CRM_Contribute_BAO_Premium::buildPremiumBlock($this, $this->_id, FALSE,
 538         $productID, $option
 539       );
 540       $this->set('productID', $productID);
 541       $this->set('option', $option);
 542     }
 543     $config = CRM_Core_Config::singleton();
 544     if (in_array('CiviMember', $config->enableComponents)) {
 545       if (isset($params['selectMembership']) &&
 546         $params['selectMembership'] != 'no_thanks'
 547       ) {
 548         CRM_Member_BAO_Membership::buildMembershipBlock($this,
 549           $this->_id,
 550           $this->_membershipContactID,
 551           FALSE,
 552           $params['selectMembership'],
 553           FALSE
 554         );
 555         if (!empty($params['auto_renew'])) {
 556           $this->assign('auto_renew', TRUE);
 557         }
 558       }
 559       else {
 560         $this->assign('membershipBlock', FALSE);
 561       }
 562     }
 563     $this->buildCustom($this->_values['custom_pre_id'], 'customPre', TRUE);
 564     $this->buildCustom($this->_values['custom_post_id'], 'customPost', TRUE);
 565
 566     if (!empty($params['hidden_onbehalf_profile'])) {
 567       $ufJoinParams = array(
 568         'module' => 'onBehalf',
 569         'entity_table' => 'civicrm_contribution_page',
 570         'entity_id' => $this->_id,
 571       );
 572       $OnBehalfProfile = CRM_Core_BAO_UFJoin::getUFGroupIds($ufJoinParams);
 573       $profileId = $OnBehalfProfile[0];
 574
 575       $fieldTypes = array('Contact', 'Organization');
 576       $contactSubType = CRM_Contact_BAO_ContactType::subTypes('Organization');
 577       $fieldTypes = array_merge($fieldTypes, $contactSubType);
 578       if (is_array($this->_membershipBlock) && !empty($this->_membershipBlock)) {
 579         $fieldTypes = array_merge($fieldTypes, array('Membership'));
 580       }
 581       else {
 582         $fieldTypes = array_merge($fieldTypes, array('Contribution'));
 583       }
 584
 585       $this->buildCustom($profileId, 'onbehalfProfile', TRUE, 'onbehalf', $fieldTypes);
 586     }
 587
 588     $this->_separateMembershipPayment = $this->get('separateMembershipPayment');
 589     $this->assign('is_separate_payment', $this->_separateMembershipPayment);
 590     if ($this->_priceSetId && !CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId, 'is_quick_config')) {
 591       $this->assign('lineItem', $this->_lineItem);
 592     }
 593     else {
 594       $this->assign('is_quick_config', 1);
 595       $this->_params['is_quick_config'] = 1;
 596     }
 597     $this->assign('priceSetID', $this->_priceSetId);
 598     $paymentProcessorType = CRM_Core_PseudoConstant::paymentProcessorType(FALSE, NULL, 'name');
 599     if ($this->_paymentProcessor &&
 600       $this->_paymentProcessor['payment_processor_type_id'] == CRM_Utils_Array::key('Google_Checkout', $paymentProcessorType)
 601       && !$this->_params['is_pay_later'] && !($this->_amount == 0)
 602     ) {
 603       $this->_checkoutButtonName = $this->getButtonName('next', 'checkout');
 604       $this->add('image',
 605         $this->_checkoutButtonName,
 606         $this->_paymentProcessor['url_button'],
 607         array('class' => 'crm-form-submit')
 608       );
 609
 610       $this->addButtons(array(
 611           array(
 612             'type' => 'back',
 613             'name' => ts('Go Back'),
 614           ),
 615         )
 616       );
 617     }
 618     else {
 619       if ($this->_contributeMode == 'notify' || !$this->_values['is_monetary'] ||
 620         $this->_amount <= 0.0 || $this->_params['is_pay_later'] ||
 621         ($this->_separateMembershipPayment && $this->_amount <= 0.0)
 622       ) {
 623         $contribButton = ts('Continue');
 624         $this->assign('button', ts('Continue'));
 625       }
 626       else {
 627         $contribButton = ts('Make Contribution');
 628         $this->assign('button', ts('Make Contribution'));
 629       }
 630       $this->addButtons(array(
 631           array(
 632             'type' => 'next',
 633             'name' => $contribButton,
 634             'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 635             'isDefault' => TRUE,
 636             'js' => array('onclick' => "return submitOnce(this,'" . $this->_name . "','" . ts('Processing') . "');"),
 637           ),
 638           array(
 639             'type' => 'back',
 640             'name' => ts('Go Back'),
 641           ),
 642         )
 643       );
 644     }
 645
 646     $defaults = array();
 647     $fields = array_fill_keys(array_keys($this->_fields), 1);
 648     $fields["billing_state_province-{$this->_bltID}"] = $fields["billing_country-{$this->_bltID}"] = $fields["email-{$this->_bltID}"] = 1;
 649
 650     $contact = $this->_params;
 651     foreach ($fields as $name => $dontCare) {
 652       // Recursively set defaults for nested fields
 653       if (isset($contact[$name]) && is_array($contact[$name]) && ($name == 'onbehalf' || $name == 'honor')) {
 654         foreach ($contact[$name] as $fieldName => $fieldValue) {
 655           if (is_array($fieldValue) && !in_array($this->_fields[$name][$fieldName]['html_type'], array(
 656               'Multi-Select',
 657               'AdvMulti-Select',
 658             ))
 659           ) {
 660             foreach ($fieldValue as $key => $value) {
 661               $defaults["{$name}[{$fieldName}][{$key}]"] = $value;
 662             }
 663           }
 664           else {
 665             $defaults["{$name}[{$fieldName}]"] = $fieldValue;
 666           }
 667         }
 668       }
 669       elseif (isset($contact[$name])) {
 670         $defaults[$name] = $contact[$name];
 671         if (substr($name, 0, 7) == 'custom_') {
 672           $timeField = "{$name}_time";
 673           if (isset($contact[$timeField])) {
 674             $defaults[$timeField] = $contact[$timeField];
 675           }
 676           if (isset($contact["{$name}_id"])) {
 677             $defaults["{$name}_id"] = $contact["{$name}_id"];
 678           }
 679         }
 680         elseif (in_array($name, array(
 681             'addressee',
 682             'email_greeting',
 683             'postal_greeting',
 684           )) && !empty($contact[$name . '_custom'])
 685         ) {
 686           $defaults[$name . '_custom'] = $contact[$name . '_custom'];
 687         }
 688       }
 689     }
 690
 691     $this->assign('useForMember', $this->get('useForMember'));
 692
 693     $this->setDefaults($defaults);
 694
 695     $this->freeze();
 696   }
 697
 698   /**
 699    * Overwrite action, since we are only showing elements in frozen mode
 700    * no help display needed
 701    *
 702    * @return int
 703    */
 704   public function getAction() {
 705     if ($this->_action & CRM_Core_Action::PREVIEW) {
 706       return CRM_Core_Action::VIEW | CRM_Core_Action::PREVIEW;
 707     }
 708     else {
 709       return CRM_Core_Action::VIEW;
 710     }
 711   }
 712
 713   /**
 714    * Set default values for the form.
 715    *
 716    * Note that in edit/view mode
 717    * the default values are retrieved from the database
 718    *
 719    * @return void
 720    */
 721   public function setDefaultValues() {
 722   }
 723
 724   /**
 725    * Process the form.
 726    */
 727   public function postProcess() {
 728     $contactID = $this->getContactID();
 729     $result = $this->processFormSubmission($contactID);
 730     if (is_array($result) && !empty($result['is_payment_failure'])) {
 731       // We will probably have the function that gets this error throw an exception on the next round of refactoring.
 732       CRM_Core_Session::singleton()->setStatus(ts("Payment Processor Error message :") .
 733           $result['error']->getMessage());
 734       CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/transact',
 735         "_qf_Main_display=true&qfKey={$this->_params['qfKey']}"
 736       ));
 737     }
 738   }
 739
 740   /**
 741    * Wrangle financial type ID.
 742    *
 743    * This wrangling of the financialType ID was happening in a shared function rather than in the form it relates to & hence has been moved to that form
 744    * Pledges are not relevant to the membership code so that portion will not go onto the membership form.
 745    *
 746    * Comments from previous refactor indicate doubt as to what was going on.
 747    *
 748    * @param int $contributionTypeId
 749    *
 750    * @return null|string
 751    */
 752   public function wrangleFinancialTypeID($contributionTypeId) {
 753     if (isset($paymentParams['financial_type'])) {
 754       $contributionTypeId = $paymentParams['financial_type'];
 755     }
 756     elseif (!empty($this->_values['pledge_id'])) {
 757       $contributionTypeId = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_Pledge',
 758         $this->_values['pledge_id'],
 759         'financial_type_id'
 760       );
 761     }
 762     return $contributionTypeId;
 763   }
 764
 765   /**
 766    * Process the form.
 767    *
 768    * @param array $premiumParams
 769    * @param CRM_Contribute_BAO_Contribution $contribution
 770    */
 771   public function postProcessPremium($premiumParams, $contribution) {
 772     $hour = $minute = $second = 0;
 773     // assigning Premium information to receipt tpl
 774     $selectProduct = CRM_Utils_Array::value('selectProduct', $premiumParams);
 775     if ($selectProduct &&
 776       $selectProduct != 'no_thanks'
 777     ) {
 778       $startDate = $endDate = "";
 779       $this->assign('selectPremium', TRUE);
 780       $productDAO = new CRM_Contribute_DAO_Product();
 781       $productDAO->id = $selectProduct;
 782       $productDAO->find(TRUE);
 783       $this->assign('product_name', $productDAO->name);
 784       $this->assign('price', $productDAO->price);
 785       $this->assign('sku', $productDAO->sku);
 786       $this->assign('option', CRM_Utils_Array::value('options_' . $premiumParams['selectProduct'], $premiumParams));
 787
 788       $periodType = $productDAO->period_type;
 789
 790       if ($periodType) {
 791         $fixed_period_start_day = $productDAO->fixed_period_start_day;
 792         $duration_unit = $productDAO->duration_unit;
 793         $duration_interval = $productDAO->duration_interval;
 794         if ($periodType == 'rolling') {
 795           $startDate = date('Y-m-d');
 796         }
 797         elseif ($periodType == 'fixed') {
 798           if ($fixed_period_start_day) {
 799             $date = explode('-', date('Y-m-d'));
 800             $month = substr($fixed_period_start_day, 0, strlen($fixed_period_start_day) - 2);
 801             $day = substr($fixed_period_start_day, -2) . "<br/>";
 802             $year = $date[0];
 803             $startDate = $year . '-' . $month . '-' . $day;
 804           }
 805           else {
 806             $startDate = date('Y-m-d');
 807           }
 808         }
 809
 810         $date = explode('-', $startDate);
 811         $year = $date[0];
 812         $month = $date[1];
 813         $day = $date[2];
 814
 815         switch ($duration_unit) {
 816           case 'year':
 817             $year = $year + $duration_interval;
 818             break;
 819
 820           case 'month':
 821             $month = $month + $duration_interval;
 822             break;
 823
 824           case 'day':
 825             $day = $day + $duration_interval;
 826             break;
 827
 828           case 'week':
 829             $day = $day + ($duration_interval * 7);
 830         }
 831         $endDate = date('Y-m-d H:i:s', mktime($hour, $minute, $second, $month, $day, $year));
 832         $this->assign('start_date', $startDate);
 833         $this->assign('end_date', $endDate);
 834       }
 835
 836       $dao = new CRM_Contribute_DAO_Premium();
 837       $dao->entity_table = 'civicrm_contribution_page';
 838       $dao->entity_id = $this->_id;
 839       $dao->find(TRUE);
 840       $this->assign('contact_phone', $dao->premiums_contact_phone);
 841       $this->assign('contact_email', $dao->premiums_contact_email);
 842
 843       //create Premium record
 844       $params = array(
 845         'product_id' => $premiumParams['selectProduct'],
 846         'contribution_id' => $contribution->id,
 847         'product_option' => CRM_Utils_Array::value('options_' . $premiumParams['selectProduct'], $premiumParams),
 848         'quantity' => 1,
 849         'start_date' => CRM_Utils_Date::customFormat($startDate, '%Y%m%d'),
 850         'end_date' => CRM_Utils_Date::customFormat($endDate, '%Y%m%d'),
 851       );
 852       if (!empty($premiumParams['selectProduct'])) {
 853         $daoPremiumsProduct = new CRM_Contribute_DAO_PremiumsProduct();
 854         $daoPremiumsProduct->product_id = $premiumParams['selectProduct'];
 855         $daoPremiumsProduct->premiums_id = $dao->id;
 856         $daoPremiumsProduct->find(TRUE);
 857         $params['financial_type_id'] = $daoPremiumsProduct->financial_type_id;
 858       }
 859       //Fixed For CRM-3901
 860       $daoContrProd = new CRM_Contribute_DAO_ContributionProduct();
 861       $daoContrProd->contribution_id = $contribution->id;
 862       if ($daoContrProd->find(TRUE)) {
 863         $params['id'] = $daoContrProd->id;
 864       }
 865
 866       CRM_Contribute_BAO_Contribution::addPremium($params);
 867       if ($productDAO->cost && !empty($params['financial_type_id'])) {
 868         $trxnParams = array(
 869           'cost' => $productDAO->cost,
 870           'currency' => $productDAO->currency,
 871           'financial_type_id' => $params['financial_type_id'],
 872           'contributionId' => $contribution->id,
 873         );
 874         CRM_Core_BAO_FinancialTrxn::createPremiumTrxn($trxnParams);
 875       }
 876     }
 877     elseif ($selectProduct == 'no_thanks') {
 878       //Fixed For CRM-3901
 879       $daoContrProd = new CRM_Contribute_DAO_ContributionProduct();
 880       $daoContrProd->contribution_id = $contribution->id;
 881       if ($daoContrProd->find(TRUE)) {
 882         $daoContrProd->delete();
 883       }
 884     }
 885   }
 886
 887   /**
 888    * Process the contribution.
 889    *
 890    * @param CRM_Core_Form $form
 891    * @param array $params
 892    * @param array $result
 893    * @param int $contactID
 894    * @param CRM_Financial_DAO_FinancialType $financialType
 895    * @param bool $pending
 896    * @param bool $online
 897    *
 898    * @param bool $isTest
 899    * @param array $lineItems
 900    *
 901    * @param int $billingLocationID
 902    *   ID of billing location type.
 903    *
 904    * @return \CRM_Contribute_DAO_Contribution
 905    * @throws \Exception
 906    */
 907   public static function processFormContribution(
 908     &$form,
 909     $params,
 910     $result,
 911     $contactID,
 912     $financialType,
 913     $pending,
 914     $online,
 915     $isTest,
 916     $lineItems,
 917     $billingLocationID
 918   ) {
 919     $transaction = new CRM_Core_Transaction();
 920     $contribSoftContactId = $addressID = NULL;
 921     $contributeMode = $form->_contributeMode;
 922     $isMonetary = !empty($form->_values['is_monetary']);
 923     $isEmailReceipt = !empty($form->_values['is_email_receipt']);
 924     // How do these vary from params? These are currently passed to
 925     // - custom data function....
 926     $formParams = $form->_params;
 927     $isSeparateMembershipPayment = empty($formParams['separate_membership_payment']) ? FALSE : TRUE;
 928     $pledgeID = empty($formParams['pledge_id']) ? NULL : $formParams['pledge_id'];
 929     if (!$isSeparateMembershipPayment && !empty($form->_values['pledge_block_id']) &&
 930       (!empty($formParams['is_pledge']) || $pledgeID)) {
 931       $isPledge = TRUE;
 932     }
 933     else {
 934       $isPledge = FALSE;
 935     }
 936
 937     // add these values for the recurringContrib function ,CRM-10188
 938     $params['financial_type_id'] = $financialType->id;
 939
 940     //create an contribution address
 941     if ($contributeMode != 'notify' && empty($params['is_pay_later']) && $isMonetary) {
 942       $addressID = CRM_Contribute_BAO_Contribution::createAddress($params, $billingLocationID);
 943     }
 944
 945     //@todo - this is being set from the form to resolve CRM-10188 - an
 946     // eNotice caused by it not being set @ the front end
 947     // however, we then get it being over-written with null for backend contributions
 948     // a better fix would be to set the values in the respective forms rather than require
 949     // a function being shared by two forms to deal with their respective values
 950     // moving it to the BAO & not taking the $form as a param would make sense here.
 951     if (!isset($params['is_email_receipt']) && $isEmailReceipt) {
 952       $params['is_email_receipt'] = $isEmailReceipt;
 953     }
 954     $recurringContributionID = self::processRecurringContribution($form, $params, $contactID, $financialType, $online);
 955     $nonDeductibleAmount = self::getNonDeductibleAmount($params, $financialType, $online);
 956
 957     $now = date('YmdHis');
 958     $receiptDate = CRM_Utils_Array::value('receipt_date', $params);
 959     if ($isEmailReceipt) {
 960       $receiptDate = $now;
 961     }
 962
 963     //get the contrib page id.
 964     $contributionPageId = NULL;
 965     if ($online) {
 966       $contributionPageId = $form->_id;
 967       $campaignId = CRM_Utils_Array::value('campaign_id', $params);
 968       if (!array_key_exists('campaign_id', $params)) {
 969         $campaignId = CRM_Utils_Array::value('campaign_id', $form->_values);
 970       }
 971     }
 972     else {
 973       //also for offline we do support - CRM-7290
 974       $contributionPageId = CRM_Utils_Array::value('contribution_page_id', $params);
 975       $campaignId = CRM_Utils_Array::value('campaign_id', $params);
 976     }
 977
 978     // Prepare soft contribution due to pcp or Submit Credit / Debit Card Contribution by admin.
 979     if (!empty($params['pcp_made_through_id']) || !empty($params['soft_credit_to'])) {
 980       // if its due to pcp
 981       if (!empty($params['pcp_made_through_id'])) {
 982         $contribSoftContactId = CRM_Core_DAO::getFieldValue(
 983           'CRM_PCP_DAO_PCP',
 984           $params['pcp_made_through_id'],
 985           'contact_id'
 986         );
 987       }
 988       else {
 989         $contribSoftContactId = CRM_Utils_Array::value('soft_credit_to', $params);
 990       }
 991
 992       // Pass these details onto with the contribution to make them
 993       // available at hook_post_process, CRM-8908
 994       $params['soft_credit_to'] = $contribSoftContactId;
 995     }
 996
 997     if (isset($params['amount'])) {
 998       $contribParams = self::getContributionParams(
 999         $params, $contactID, $financialType->id, $online, $contributionPageId, $nonDeductibleAmount, $campaignId, $isMonetary, $pending, $result, $receiptDate,
1000         $recurringContributionID, $isTest, $addressID, $contribSoftContactId, $lineItems
1001       );
1002       $contribution = CRM_Contribute_BAO_Contribution::add($contribParams);
1003
1004       $invoiceSettings = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME, 'contribution_invoice_settings');
1005       $invoicing = CRM_Utils_Array::value('invoicing', $invoiceSettings);
1006       if ($invoicing) {
1007         $dataArray = array();
1008         foreach ($form->_lineItem as $lineItemKey => $lineItemValue) {
1009           foreach ($lineItemValue as $key => $value) {
1010             if (isset($value['tax_amount']) && isset($value['tax_rate'])) {
1011               if (isset($dataArray[$value['tax_rate']])) {
1012                 $dataArray[$value['tax_rate']] = $dataArray[$value['tax_rate']] + CRM_Utils_Array::value('tax_amount', $value);
1013               }
1014               else {
1015                 $dataArray[$value['tax_rate']] = CRM_Utils_Array::value('tax_amount', $value);
1016               }
1017             }
1018           }
1019         }
1020         $smarty = CRM_Core_Smarty::singleton();
1021         $smarty->assign('dataArray', $dataArray);
1022         $smarty->assign('totalTaxAmount', $params['tax_amount']);
1023       }
1024       if (is_a($contribution, 'CRM_Core_Error')) {
1025         $message = CRM_Core_Error::getMessages($contribution);
1026         CRM_Core_Error::fatal($message);
1027       }
1028
1029       // lets store it in the form variable so postProcess hook can get to this and use it
1030       $form->_contributionID = $contribution->id;
1031     }
1032
1033     //CRM-13981, processing honor contact into soft-credit contribution
1034     CRM_Contact_Form_ProfileContact::postProcess($form);
1035
1036     // process soft credit / pcp pages
1037     CRM_Contribute_Form_Contribution_Confirm::processPcpSoft($params, $contribution);
1038
1039     //handle pledge stuff.
1040     if ($isPledge) {
1041       if ($pledgeID) {
1042         //when user doing pledge payments.
1043         //update the schedule when payment(s) are made
1044         foreach ($form->_params['pledge_amount'] as $paymentId => $dontCare) {
1045           $scheduledAmount = CRM_Core_DAO::getFieldValue(
1046             'CRM_Pledge_DAO_PledgePayment',
1047             $paymentId,
1048             'scheduled_amount',
1049             'id'
1050           );
1051
1052           $pledgePaymentParams = array(
1053             'id' => $paymentId,
1054             'contribution_id' => $contribution->id,
1055             'status_id' => $contribution->contribution_status_id,
1056             'actual_amount' => $scheduledAmount,
1057           );
1058
1059           CRM_Pledge_BAO_PledgePayment::add($pledgePaymentParams);
1060         }
1061
1062         //update pledge status according to the new payment statuses
1063         CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID);
1064       }
1065       else {
1066         //when user creating pledge record.
1067         $pledgeParams = array();
1068         $pledgeParams['contact_id'] = $contribution->contact_id;
1069         $pledgeParams['installment_amount'] = $pledgeParams['actual_amount'] = $contribution->total_amount;
1070         $pledgeParams['contribution_id'] = $contribution->id;
1071         $pledgeParams['contribution_page_id'] = $contribution->contribution_page_id;
1072         $pledgeParams['financial_type_id'] = $contribution->financial_type_id;
1073         $pledgeParams['frequency_interval'] = $params['pledge_frequency_interval'];
1074         $pledgeParams['installments'] = $params['pledge_installments'];
1075         $pledgeParams['frequency_unit'] = $params['pledge_frequency_unit'];
1076         if ($pledgeParams['frequency_unit'] == 'month') {
1077           $pledgeParams['frequency_day'] = intval(date("d"));
1078         }
1079         else {
1080           $pledgeParams['frequency_day'] = 1;
1081         }
1082         $pledgeParams['create_date'] = $pledgeParams['start_date'] = $pledgeParams['scheduled_date'] = date("Ymd");
1083         $pledgeParams['status_id'] = $contribution->contribution_status_id;
1084         $pledgeParams['max_reminders'] = $form->_values['max_reminders'];
1085         $pledgeParams['initial_reminder_day'] = $form->_values['initial_reminder_day'];
1086         $pledgeParams['additional_reminder_day'] = $form->_values['additional_reminder_day'];
1087         $pledgeParams['is_test'] = $contribution->is_test;
1088         $pledgeParams['acknowledge_date'] = date('Ymd');
1089         $pledgeParams['original_installment_amount'] = $pledgeParams['installment_amount'];
1090
1091         //inherit campaign from contirb page.
1092         $pledgeParams['campaign_id'] = $campaignId;
1093
1094         $pledge = CRM_Pledge_BAO_Pledge::create($pledgeParams);
1095
1096         $form->_params['pledge_id'] = $pledge->id;
1097
1098         //send acknowledgment email. only when pledge is created
1099         if ($pledge->id) {
1100           //build params to send acknowledgment.
1101           $pledgeParams['id'] = $pledge->id;
1102           $pledgeParams['receipt_from_name'] = $form->_values['receipt_from_name'];
1103           $pledgeParams['receipt_from_email'] = $form->_values['receipt_from_email'];
1104
1105           //scheduled amount will be same as installment_amount.
1106           $pledgeParams['scheduled_amount'] = $pledgeParams['installment_amount'];
1107
1108           //get total pledge amount.
1109           $pledgeParams['total_pledge_amount'] = $pledge->amount;
1110
1111           CRM_Pledge_BAO_Pledge::sendAcknowledgment($form, $pledgeParams);
1112         }
1113       }
1114     }
1115
1116     if ($online && $contribution) {
1117       CRM_Core_BAO_CustomValueTable::postProcess($form->_params,
1118         'civicrm_contribution',
1119         $contribution->id,
1120         'Contribution'
1121       );
1122     }
1123     elseif ($contribution) {
1124       //handle custom data.
1125       $params['contribution_id'] = $contribution->id;
1126       if (!empty($params['custom']) &&
1127         is_array($params['custom']) &&
1128         !is_a($contribution, 'CRM_Core_Error')
1129       ) {
1130         CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_contribution', $contribution->id);
1131       }
1132     }
1133     // Save note
1134     if ($contribution && !empty($params['contribution_note'])) {
1135       $noteParams = array(
1136         'entity_table' => 'civicrm_contribution',
1137         'note' => $params['contribution_note'],
1138         'entity_id' => $contribution->id,
1139         'contact_id' => $contribution->contact_id,
1140         'modified_date' => date('Ymd'),
1141       );
1142
1143       CRM_Core_BAO_Note::add($noteParams, array());
1144     }
1145
1146     if (isset($params['related_contact'])) {
1147       $contactID = $params['related_contact'];
1148     }
1149     elseif (isset($params['cms_contactID'])) {
1150       $contactID = $params['cms_contactID'];
1151     }
1152
1153     //create contribution activity w/ individual and target
1154     //activity w/ organisation contact id when onbelf, CRM-4027
1155     $targetContactID = NULL;
1156     if (!empty($params['hidden_onbehalf_profile'])) {
1157       $targetContactID = $contribution->contact_id;
1158       $contribution->contact_id = $contactID;
1159     }
1160
1161     // create an activity record
1162     if ($contribution) {
1163       CRM_Activity_BAO_Activity::addActivity($contribution, NULL, $targetContactID);
1164     }
1165
1166     $transaction->commit();
1167     // CRM-13074 - create the CMSUser after the transaction is completed as it
1168     // is not appropriate to delete a valid contribution if a user create problem occurs
1169     CRM_Contribute_BAO_Contribution_Utils::createCMSUser($params,
1170       $contactID,
1171       'email-' . $billingLocationID
1172     );
1173     return $contribution;
1174   }
1175
1176   /**
1177    * Create the recurring contribution record.
1178    *
1179    * @param CRM_Core_Form $form
1180    * @param array $params
1181    * @param int $contactID
1182    * @param string $contributionType
1183    * @param bool $online
1184    *
1185    * @return mixed
1186    */
1187   public static function processRecurringContribution(&$form, &$params, $contactID, $contributionType, $online = TRUE) {
1188     // return if this page is not set for recurring
1189     // or the user has not chosen the recurring option
1190
1191     //this is online case validation.
1192     if ((empty($form->_values['is_recur']) && $online) || empty($params['is_recur'])) {
1193       return NULL;
1194     }
1195
1196     $recurParams = array('contact_id' => $contactID);
1197     $recurParams['amount'] = CRM_Utils_Array::value('amount', $params);
1198     $recurParams['auto_renew'] = CRM_Utils_Array::value('auto_renew', $params);
1199     $recurParams['frequency_unit'] = CRM_Utils_Array::value('frequency_unit', $params);
1200     $recurParams['frequency_interval'] = CRM_Utils_Array::value('frequency_interval', $params);
1201     $recurParams['installments'] = CRM_Utils_Array::value('installments', $params);
1202     $recurParams['financial_type_id'] = CRM_Utils_Array::value('financial_type_id', $params);
1203     $recurParams['currency'] = CRM_Utils_Array::value('currency', $params);
1204
1205     // CRM-14354: For an auto-renewing membership with an additional contribution,
1206     // if separate payments is not enabled, make sure only the membership fee recurs
1207     if (!empty($form->_membershipBlock)
1208       && $form->_membershipBlock['is_separate_payment'] === '0'
1209       && isset($params['selectMembership'])
1210       && $form->_values['is_allow_other_amount'] == '1'
1211       // CRM-16331
1212       && !empty($form->_membershipTypeValues)
1213       && !empty($form->_membershipTypeValues[$params['selectMembership']]['minimum_fee'])
1214     ) {
1215       $recurParams['amount'] = $form->_membershipTypeValues[$params['selectMembership']]['minimum_fee'];
1216     }
1217
1218     $recurParams['is_test'] = 0;
1219     if (($form->_action & CRM_Core_Action::PREVIEW) ||
1220       (isset($form->_mode) && ($form->_mode == 'test'))
1221     ) {
1222       $recurParams['is_test'] = 1;
1223     }
1224
1225     $recurParams['start_date'] = $recurParams['create_date'] = $recurParams['modified_date'] = date('YmdHis');
1226     if (!empty($params['receive_date'])) {
1227       $recurParams['start_date'] = $params['receive_date'];
1228     }
1229     $recurParams['invoice_id'] = CRM_Utils_Array::value('invoiceID', $params);
1230     $recurParams['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
1231     $recurParams['payment_processor_id'] = CRM_Utils_Array::value('payment_processor_id', $params);
1232     $recurParams['is_email_receipt'] = CRM_Utils_Array::value('is_email_receipt', $params);
1233     // we need to add a unique trxn_id to avoid a unique key error
1234     // in paypal IPN we reset this when paypal sends us the real trxn id, CRM-2991
1235     $recurParams['trxn_id'] = CRM_Utils_Array::value('trxn_id', $params, $params['invoiceID']);
1236     $recurParams['financial_type_id'] = $contributionType->id;
1237
1238     if (!$online || $form->_values['is_monetary']) {
1239       $recurParams['payment_instrument_id'] = 1;
1240     }
1241
1242     $campaignId = CRM_Utils_Array::value('campaign_id', $params);
1243     if ($online) {
1244       if (!array_key_exists('campaign_id', $params)) {
1245         $campaignId = CRM_Utils_Array::value('campaign_id', $form->_values);
1246       }
1247     }
1248     $recurParams['campaign_id'] = $campaignId;
1249
1250     $recurring = CRM_Contribute_BAO_ContributionRecur::add($recurParams);
1251     if (is_a($recurring, 'CRM_Core_Error')) {
1252       CRM_Core_Error::displaySessionError($recurring);
1253       $urlString = 'civicrm/contribute/transact';
1254       $urlParams = '_qf_Main_display=true';
1255       if (get_class($form) == 'CRM_Contribute_Form_Contribution') {
1256         $urlString = 'civicrm/contact/view/contribution';
1257         $urlParams = "action=add&cid={$form->_contactID}";
1258         if ($form->_mode) {
1259           $urlParams .= "&mode={$form->_mode}";
1260         }
1261       }
1262       CRM_Utils_System::redirect(CRM_Utils_System::url($urlString, $urlParams));
1263     }
1264
1265     return $recurring->id;
1266   }
1267
1268   /**
1269    * Add on behalf of organization and it's location.
1270    *
1271    * This situation occurs when on behalf of is enabled for the contribution page and the person
1272    * signing up does so on behalf of an organization.
1273    *
1274    * @param array $behalfOrganization
1275    *   array of organization info.
1276    * @param int $contactID
1277    *   individual contact id. One.
1278    *   who is doing the process of signup / contribution.
1279    *
1280    * @param array $values
1281    *   form values array.
1282    * @param array $params
1283    * @param array $fields
1284    *   Array of fields from the onbehalf profile relevant to the organization.
1285    */
1286   public static function processOnBehalfOrganization(&$behalfOrganization, &$contactID, &$values, &$params, $fields = NULL) {
1287     $isCurrentEmployer = FALSE;
1288     $dupeIDs = array();
1289     $orgID = NULL;
1290     if (!empty($behalfOrganization['organization_id']) && empty($behalfOrganization['org_option'])) {
1291       $orgID = $behalfOrganization['organization_id'];
1292       unset($behalfOrganization['organization_id']);
1293       $isCurrentEmployer = TRUE;
1294     }
1295
1296     // formalities for creating / editing organization.
1297     $behalfOrganization['contact_type'] = 'Organization';
1298
1299     // get the relationship type id
1300     $relType = new CRM_Contact_DAO_RelationshipType();
1301     $relType->name_a_b = 'Employee of';
1302     $relType->find(TRUE);
1303     $relTypeId = $relType->id;
1304
1305     // keep relationship params ready
1306     $relParams['relationship_type_id'] = $relTypeId . '_a_b';
1307     $relParams['is_permission_a_b'] = 1;
1308     $relParams['is_active'] = 1;
1309
1310     if (!$orgID) {
1311       // check if matching organization contact exists
1312       $dedupeParams = CRM_Dedupe_Finder::formatParams($behalfOrganization, 'Organization');
1313       $dedupeParams['check_permission'] = FALSE;
1314       $dupeIDs = CRM_Dedupe_Finder::dupesByParams($dedupeParams, 'Organization', 'Unsupervised');
1315
1316       // CRM-6243 says to pick the first org even if more than one match
1317       if (count($dupeIDs) >= 1) {
1318         $behalfOrganization['contact_id'] = $orgID = $dupeIDs[0];
1319         // don't allow name edit
1320         unset($behalfOrganization['organization_name']);
1321       }
1322     }
1323     else {
1324       // if found permissioned related organization, allow location edit
1325       $behalfOrganization['contact_id'] = $orgID;
1326       // don't allow name edit
1327       unset($behalfOrganization['organization_name']);
1328     }
1329
1330     // handling for image url
1331     if (!empty($behalfOrganization['image_URL'])) {
1332       CRM_Contact_BAO_Contact::processImageParams($behalfOrganization);
1333     }
1334
1335     // create organization, add location
1336     $orgID = CRM_Contact_BAO_Contact::createProfileContact($behalfOrganization, $fields, $orgID,
1337       NULL, NULL, 'Organization'
1338     );
1339     // create relationship
1340     $relParams['contact_check'][$orgID] = 1;
1341     $cid = array('contact' => $contactID);
1342     CRM_Contact_BAO_Relationship::legacyCreateMultiple($relParams, $cid);
1343
1344     // if multiple match - send a duplicate alert
1345     if ($dupeIDs && (count($dupeIDs) > 1)) {
1346       $values['onbehalf_dupe_alert'] = 1;
1347       // required for IPN
1348       $params['onbehalf_dupe_alert'] = 1;
1349     }
1350
1351     // make sure organization-contact-id is considered for recording
1352     // contribution/membership etc..
1353     if ($contactID != $orgID) {
1354       // take a note of contact-id, so we can send the
1355       // receipt to individual contact as well.
1356
1357       // required for mailing/template display ..etc
1358       $values['related_contact'] = $contactID;
1359       // required for IPN
1360       $params['related_contact'] = $contactID;
1361
1362       //make this employee of relationship as current
1363       //employer / employee relationship,  CRM-3532
1364       if ($isCurrentEmployer &&
1365         ($orgID != CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contactID, 'employer_id'))
1366       ) {
1367         $isCurrentEmployer = FALSE;
1368       }
1369
1370       if (!$isCurrentEmployer && $orgID) {
1371         //build current employer params
1372         $currentEmpParams[$contactID] = $orgID;
1373         CRM_Contact_BAO_Contact_Utils::setCurrentEmployer($currentEmpParams);
1374       }
1375
1376       // contribution / signup will be done using this
1377       // organization id.
1378       $contactID = $orgID;
1379     }
1380   }
1381
1382   /**
1383    * Function used to save pcp / soft credit entry.
1384    *
1385    * This is used by contribution and also event pcps
1386    *
1387    * @param array $params
1388    * @param object $contribution
1389    *   Contribution object.
1390    */
1391   public static function processPcpSoft(&$params, &$contribution) {
1392     // Add soft contribution due to pcp or Submit Credit / Debit Card Contribution by admin.
1393     if (!empty($params['soft_credit_to'])) {
1394       $contributionSoftParams = array();
1395       foreach (array(
1396           'pcp_display_in_roll',
1397           'pcp_roll_nickname',
1398           'pcp_personal_note',
1399           'amount',
1400         ) as $val) {
1401         if (!empty($params[$val])) {
1402           $contributionSoftParams[$val] = $params[$val];
1403         }
1404       }
1405
1406       $contributionSoftParams['contact_id'] = $params['soft_credit_to'];
1407       // add contribution id
1408       $contributionSoftParams['contribution_id'] = $contribution->id;
1409       // add pcp id
1410       $contributionSoftParams['pcp_id'] = $params['pcp_made_through_id'];
1411
1412       $contributionSoftParams['soft_credit_type_id'] = CRM_Core_OptionGroup::getValue('soft_credit_type', 'pcp', 'name');
1413
1414       $contributionSoft = CRM_Contribute_BAO_ContributionSoft::add($contributionSoftParams);
1415
1416       //Send notification to owner for PCP
1417       if ($contributionSoft->id && $contributionSoft->pcp_id) {
1418         CRM_Contribute_Form_Contribution_Confirm::pcpNotifyOwner($contribution, $contributionSoft);
1419       }
1420     }
1421   }
1422
1423   /**
1424    * Function used to send notification mail to pcp owner.
1425    *
1426    * This is used by contribution and also event PCPs.
1427    *
1428    * @param object $contribution
1429    * @param object $contributionSoft
1430    *   Contribution object.
1431    */
1432   public static function pcpNotifyOwner($contribution, $contributionSoft) {
1433     $params = array('id' => $contributionSoft->pcp_id);
1434     CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $params, $pcpInfo);
1435     $ownerNotifyID = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCPBlock', $pcpInfo['pcp_block_id'], 'owner_notify_id');
1436
1437     if ($ownerNotifyID != CRM_Core_OptionGroup::getValue('pcp_owner_notify', 'no_notifications', 'name') &&
1438         (($ownerNotifyID == CRM_Core_OptionGroup::getValue('pcp_owner_notify', 'owner_chooses', 'name') &&
1439         CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP', $contributionSoft->pcp_id, 'is_notify')) ||
1440         $ownerNotifyID == CRM_Core_OptionGroup::getValue('pcp_owner_notify', 'all_owners', 'name'))) {
1441       $pcpInfoURL = CRM_Utils_System::url('civicrm/pcp/info',
1442         "reset=1&id={$contributionSoft->pcp_id}",
1443         TRUE, NULL, FALSE, TRUE
1444       );
1445       // set email in the template here
1446       // get the billing location type
1447       $locationTypes = CRM_Core_PseudoConstant::get('CRM_Core_DAO_Address', 'location_type_id', array(), 'validate');
1448       $billingLocationTypeId = array_search('Billing', $locationTypes);
1449
1450       if ($billingLocationTypeId) {
1451         list($donorName, $email) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contribution->contact_id, FALSE, $billingLocationTypeId);
1452       }
1453       // get primary location email if no email exist( for billing location).
1454       if (!$email) {
1455         list($donorName, $email) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contribution->contact_id);
1456       }
1457       list($ownerName, $ownerEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($contributionSoft->contact_id);
1458       $tplParams = array(
1459         'page_title' => $pcpInfo['title'],
1460         'receive_date' => $contribution->receive_date,
1461         'total_amount' => $contributionSoft->amount,
1462         'donors_display_name' => $donorName,
1463         'donors_email' => $email,
1464         'pcpInfoURL' => $pcpInfoURL,
1465         'is_honor_roll_enabled' => $contributionSoft->pcp_display_in_roll,
1466       );
1467       $domainValues = CRM_Core_BAO_Domain::getNameAndEmail();
1468       $sendTemplateParams = array(
1469         'groupName' => 'msg_tpl_workflow_contribution',
1470         'valueName' => 'pcp_owner_notify',
1471         'contactId' => $contributionSoft->contact_id,
1472         'toEmail' => $ownerEmail,
1473         'toName' => $ownerName,
1474         'from' => "$domainValues[0] <$domainValues[1]>",
1475         'tplParams' => $tplParams,
1476         'PDFFilename' => 'receipt.pdf',
1477       );
1478       CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
1479     }
1480   }
1481
1482   /**
1483    * Function used to se pcp related defaults / params.
1484    *
1485    * This is used by contribution and also event PCPs
1486    *
1487    * @param CRM_Core_Form $page
1488    *   Form object.
1489    * @param array $params
1490    *
1491    * @return array
1492    */
1493   public static function processPcp(&$page, $params) {
1494     $params['pcp_made_through_id'] = $page->_pcpId;
1495     $page->assign('pcpBlock', TRUE);
1496     if (!empty($params['pcp_display_in_roll']) && empty($params['pcp_roll_nickname'])) {
1497       $params['pcp_roll_nickname'] = ts('Anonymous');
1498       $params['pcp_is_anonymous'] = 1;
1499     }
1500     else {
1501       $params['pcp_is_anonymous'] = 0;
1502     }
1503     foreach (array(
1504                'pcp_display_in_roll',
1505                'pcp_is_anonymous',
1506                'pcp_roll_nickname',
1507                'pcp_personal_note',
1508              ) as $val) {
1509       if (!empty($params[$val])) {
1510         $page->assign($val, $params[$val]);
1511       }
1512     }
1513
1514     return $params;
1515   }
1516
1517   /**
1518    * Process membership.
1519    *
1520    * @param array $membershipParams
1521    * @param int $contactID
1522    * @param array $customFieldsFormatted
1523    * @param array $fieldTypes
1524    * @param array $premiumParams
1525    * @param array $membershipLineItems
1526    *   Line items specifically relating to memberships.
1527    * @param $isPayLater
1528    */
1529   public function processMembership($membershipParams, $contactID, $customFieldsFormatted, $fieldTypes, $premiumParams, $membershipLineItems, $isPayLater) {
1530     try {
1531       $membershipTypeIDs = (array) $membershipParams['selectMembership'];
1532       $membershipTypes = CRM_Member_BAO_Membership::buildMembershipTypeValues($this, $membershipTypeIDs);
1533       $membershipType = empty($membershipTypes) ? array() : reset($membershipTypes);
1534       $isPending = $this->getIsPending();
1535
1536       $this->assign('membership_name', CRM_Utils_Array::value('name', $membershipType));
1537
1538       $isPaidMembership = FALSE;
1539       if ($this->_amount >= 0.0 && isset($membershipParams['amount'])) {
1540         //amount must be greater than zero for
1541         //adding contribution record  to contribution table.
1542         //this condition arises when separate membership payment is
1543         //enabled and contribution amount is not selected. fix for CRM-3010
1544         $isPaidMembership = TRUE;
1545       }
1546       $isProcessSeparateMembershipTransaction = $this->isSeparateMembershipTransaction($this->_id, $this->_values['amount_block_is_active']);
1547
1548       if ($this->_values['amount_block_is_active']) {
1549         $contributionTypeId = $this->_values['financial_type_id'];
1550       }
1551       else {
1552         $contributionTypeId = CRM_Utils_Array::value('financial_type_id', $membershipType, CRM_Utils_Array::value('financial_type_id', $membershipParams));
1553       }
1554
1555       CRM_Member_BAO_Membership::postProcessMembership($membershipParams, $contactID,
1556         $this, $premiumParams, $customFieldsFormatted, $fieldTypes, $membershipType, $membershipTypeIDs, $isPaidMembership, $this->_membershipId, $isProcessSeparateMembershipTransaction, $contributionTypeId,
1557         $membershipLineItems, $isPayLater, $isPending);
1558       $this->assign('membership_assign', TRUE);
1559       $this->set('membershipTypeID', $membershipParams['selectMembership']);
1560     }
1561     catch (CRM_Core_Exception $e) {
1562       CRM_Core_Session::singleton()->setStatus($e->getMessage());
1563       CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/transact', "_qf_Main_display=true&qfKey={$this->_params['qfKey']}"));
1564     }
1565   }
1566
1567   /**
1568    * Is the payment a pending payment.
1569    *
1570    * We are moving towards always creating as pending and updating at the end (based on payment), so this should be
1571    * an interim refactoring. It was shared with another unrelated form & some parameters may not apply to this form.
1572    *
1573    *
1574    * @return bool
1575    */
1576   protected function getIsPending() {
1577     if (((isset($this->_contributeMode)) || !empty
1578         ($this->_params['is_pay_later'])
1579       ) &&
1580       (($this->_values['is_monetary'] && $this->_amount > 0.0))
1581     ) {
1582       return TRUE;
1583     }
1584     return FALSE;
1585   }
1586
1587   /**
1588    * Are we going to do 2 financial transactions.
1589    *
1590    * Ie the membership block supports a separate transactions AND the contribution form has been configured for a
1591    * contribution
1592    * transaction AND a membership transaction AND the payment processor supports double financial transactions (ie. NOT doTransferPayment style)
1593    *
1594    * @param int $formID
1595    * @param bool $amountBlockActiveOnForm
1596    *
1597    * @return bool
1598    */
1599   public function isSeparateMembershipTransaction($formID, $amountBlockActiveOnForm) {
1600     $memBlockDetails = CRM_Member_BAO_Membership::getMembershipBlock($formID);
1601     if (!empty($memBlockDetails['is_separate_payment']) && $amountBlockActiveOnForm) {
1602       return TRUE;
1603     }
1604     return FALSE;
1605   }
1606
1607   /**
1608    * This function sets the fields.
1609    *
1610    * - $this->_params['amount_level']
1611    * - $this->_params['selectMembership']
1612    * And under certain circumstances sets
1613    * $this->_params['amount'] = null;
1614    *
1615    * @param int $priceSetID
1616    */
1617   public function setFormAmountFields($priceSetID) {
1618     $isQuickConfig = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_params['priceSetId'], 'is_quick_config');
1619     $priceField = new CRM_Price_DAO_PriceField();
1620     $priceField->price_set_id = $priceSetID;
1621     $priceField->orderBy('weight');
1622     $priceField->find();
1623     $paramWeDoNotUnderstand = NULL;
1624
1625     while ($priceField->fetch()) {
1626       if ($priceField->name == "contribution_amount") {
1627         $paramWeDoNotUnderstand = $priceField->id;
1628       }
1629       if ($isQuickConfig && !empty($this->_params["price_{$priceField->id}"])) {
1630         if ($this->_values['fee'][$priceField->id]['html_type'] != 'Text') {
1631           $this->_params['amount_level'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue',
1632             $this->_params["price_{$priceField->id}"], 'label');
1633         }
1634         if ($priceField->name == "membership_amount") {
1635           $this->_params['selectMembership'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue',
1636             $this->_params["price_{$priceField->id}"], 'membership_type_id');
1637         }
1638       }
1639       // If separate payment we set contribution amount to be null, so that it will not show contribution amount same
1640       // as membership amount.
1641       // @todo - this needs more documentation - it appears the setting to null is tied up with separate membership payments
1642       // but the circumstances are very confusing. Many of these conditions are repeated in the next conditional
1643       // so we should merge them together
1644       // the quick config seems like a red-herring - if this is about a separate membership payment then there
1645       // are 2 types of line items - membership ones & non-membership ones - regardless of whether quick config is set
1646       elseif (
1647         CRM_Utils_Array::value('is_separate_payment', $this->_membershipBlock)
1648         && !empty($this->_values['fee'][$priceField->id])
1649         && ($this->_values['fee'][$priceField->id]['name'] == "other_amount")
1650         && CRM_Utils_Array::value("price_{$paramWeDoNotUnderstand}", $this->_params) < 1
1651         && empty($this->_params["price_{$priceField->id}"])
1652       ) {
1653         $this->_params['amount'] = NULL;
1654       }
1655
1656       // Fix for CRM-14375 - If we are using separate payments and "no
1657       // thank you" is selected for the additional contribution, set
1658       // contribution amount to be null, so that it will not show
1659       // contribution amount same as membership amount.
1660       //@todo - merge with section above
1661       if ($this->_membershipBlock['is_separate_payment']
1662         && !empty($this->_values['fee'][$priceField->id])
1663         && CRM_Utils_Array::value('name', $this->_values['fee'][$priceField->id]) == 'contribution_amount'
1664         && CRM_Utils_Array::value("price_{$priceField->id}", $this->_params) == '-1'
1665       ) {
1666         $this->_params['amount'] = NULL;
1667       }
1668     }
1669   }
1670
1671   /**
1672    * Submit function.
1673    *
1674    * @param array $params
1675    *
1676    * @throws CiviCRM_API3_Exception
1677    */
1678   public static function submit($params) {
1679     $form = new CRM_Contribute_Form_Contribution_Confirm();
1680     $form->_id = $params['id'];
1681
1682     CRM_Contribute_BAO_ContributionPage::setValues($form->_id, $form->_values);
1683     $form->_separateMembershipPayment = CRM_Contribute_BAO_ContributionPage::getIsMembershipPayment($form->_id);
1684     //this way the mocked up controller ignores the session stuff
1685     $_SERVER['REQUEST_METHOD'] = 'GET';
1686     $form->controller = new CRM_Contribute_Controller_Contribution();
1687     $params['invoiceID'] = md5(uniqid(rand(), TRUE));
1688     $paramsProcessedForForm = $form->_params = self::getFormParams($params['id'], $params);
1689     $form->_amount = $params['amount'];
1690     $priceSetID = $form->_params['priceSetId'] = $paramsProcessedForForm['price_set_id'];
1691     $priceFields = CRM_Price_BAO_PriceSet::getSetDetail($priceSetID);
1692     $priceSetFields = reset($priceFields);
1693     $form->_values['fee'] = $priceSetFields['fields'];
1694     $form->_priceSetId = $priceSetID;
1695     $form->setFormAmountFields($priceSetID);
1696     if (!empty($params['payment_processor_id'])) {
1697       $form->_paymentProcessor = civicrm_api3('payment_processor', 'getsingle', array(
1698         'id' => $params['payment_processor_id'],
1699       ));
1700       if ($form->_paymentProcessor['billing_mode'] == 1) {
1701         $form->_contributeMode = 'direct';
1702       }
1703       else {
1704         $form->_contributeMode = 'notify';
1705       }
1706     }
1707     else {
1708       $form->_params['payment_processor_id'] = 0;
1709     }
1710     $priceFields = $priceFields[$priceSetID]['fields'];
1711     CRM_Price_BAO_PriceSet::processAmount($priceFields, $paramsProcessedForForm, $lineItems, 'civicrm_contribution');
1712     $form->_lineItem = array($priceSetID => $lineItems);
1713     $form->processFormSubmission(CRM_Utils_Array::value('contact_id', $params));
1714   }
1715
1716   /**
1717    * Helper function for static submit function.
1718    *
1719    * Set relevant params - help us to build up an array that we can pass in.
1720    *
1721    * @param int $id
1722    * @param array $params
1723    *
1724    * @return array
1725    * @throws CiviCRM_API3_Exception
1726    */
1727   public static function getFormParams($id, array $params) {
1728     if (!isset($params['is_pay_later'])) {
1729       if (!empty($params['payment_processor_id'])) {
1730         $params['is_pay_later'] = 0;
1731       }
1732       else {
1733         $params['is_pay_later'] = civicrm_api3('contribution_page', 'getvalue', array(
1734           'id' => $id,
1735           'return' => 'is_pay_later',
1736         ));
1737       }
1738     }
1739     if (empty($params['price_set_id'])) {
1740       $params['price_set_id'] = CRM_Price_BAO_PriceSet::getFor('civicrm_contribution_page', $params['id']);
1741     }
1742     return $params;
1743   }
1744
1745   /**
1746    * Post form submission handling.
1747    *
1748    * This is also called from the test suite.
1749    *
1750    * @param int $contactID
1751    *
1752    * @return array
1753    */
1754   protected function processFormSubmission($contactID) {
1755     $isPayLater = $this->_params['is_pay_later'];
1756     if (isset($this->_params['payment_processor_id']) && $this->_params['payment_processor_id'] == 0) {
1757       $this->_params['is_pay_later'] = $isPayLater = TRUE;
1758     }
1759     // add a description field at the very beginning
1760     $this->_params['description'] = ts('Online Contribution') . ': ' . (($this->_pcpInfo['title']) ? $this->_pcpInfo['title'] : $this->_values['title']);
1761
1762     $this->_params['accountingCode'] = CRM_Utils_Array::value('accountingCode', $this->_values);
1763
1764     // fix currency ID
1765     $this->_params['currencyID'] = CRM_Core_Config::singleton()->defaultCurrency;
1766
1767     //carry payment processor id.
1768     if (CRM_Utils_Array::value('id', $this->_paymentProcessor)) {
1769       $this->_params['payment_processor_id'] = $this->_paymentProcessor['id'];
1770     }
1771     if (!empty($params['image_URL'])) {
1772       CRM_Contact_BAO_Contact::processImageParams($params);
1773     }
1774     $premiumParams = $membershipParams = $params = $this->_params;
1775     $fields = array('email-Primary' => 1);
1776
1777     // get the add to groups
1778     $addToGroups = array();
1779
1780     // now set the values for the billing location.
1781     foreach ($this->_fields as $name => $value) {
1782       $fields[$name] = 1;
1783
1784       // get the add to groups for uf fields
1785       if (!empty($value['add_to_group_id'])) {
1786         $addToGroups[$value['add_to_group_id']] = $value['add_to_group_id'];
1787       }
1788     }
1789
1790     if (!array_key_exists('first_name', $fields)) {
1791       $nameFields = array('first_name', 'middle_name', 'last_name');
1792       foreach ($nameFields as $name) {
1793         $fields[$name] = 1;
1794         if (array_key_exists("billing_$name", $params)) {
1795           $params[$name] = $params["billing_{$name}"];
1796           $params['preserveDBName'] = TRUE;
1797         }
1798       }
1799     }
1800
1801     // billing email address
1802     $fields["email-{$this->_bltID}"] = 1;
1803
1804     //unset the billing parameters if it is pay later mode
1805     //to avoid creation of billing location
1806     if ($isPayLater && !$this->_isBillingAddressRequiredForPayLater) {
1807       $billingFields = array(
1808         'billing_first_name',
1809         'billing_middle_name',
1810         'billing_last_name',
1811         "billing_street_address-{$this->_bltID}",
1812         "billing_city-{$this->_bltID}",
1813         "billing_state_province-{$this->_bltID}",
1814         "billing_state_province_id-{$this->_bltID}",
1815         "billing_postal_code-{$this->_bltID}",
1816         "billing_country-{$this->_bltID}",
1817         "billing_country_id-{$this->_bltID}",
1818       );
1819
1820       foreach ($billingFields as $value) {
1821         unset($params[$value]);
1822         unset($fields[$value]);
1823       }
1824     }
1825
1826     // if onbehalf-of-organization contribution, take out
1827     // organization params in a separate variable, to make sure
1828     // normal behavior is continued. And use that variable to
1829     // process on-behalf-of functionality.
1830     if (!empty($this->_params['hidden_onbehalf_profile'])) {
1831       $behalfOrganization = array();
1832       $orgFields = array('organization_name', 'organization_id', 'org_option');
1833       foreach ($orgFields as $fld) {
1834         if (array_key_exists($fld, $params)) {
1835           $behalfOrganization[$fld] = $params[$fld];
1836           unset($params[$fld]);
1837         }
1838       }
1839
1840       if (is_array($params['onbehalf']) && !empty($params['onbehalf'])) {
1841         foreach ($params['onbehalf'] as $fld => $values) {
1842           if (strstr($fld, 'custom_')) {
1843             $behalfOrganization[$fld] = $values;
1844           }
1845           elseif (!(strstr($fld, '-'))) {
1846             if (in_array($fld, array(
1847               'contribution_campaign_id',
1848               'member_campaign_id',
1849             ))) {
1850               $fld = 'campaign_id';
1851             }
1852             else {
1853               $behalfOrganization[$fld] = $values;
1854             }
1855             $this->_params[$fld] = $values;
1856           }
1857         }
1858       }
1859
1860       if (array_key_exists('onbehalf_location', $params) && is_array($params['onbehalf_location'])) {
1861         foreach ($params['onbehalf_location'] as $block => $vals) {
1862           //fix for custom data (of type checkbox, multi-select)
1863           if (substr($block, 0, 7) == 'custom_') {
1864             continue;
1865           }
1866           // fix the index of block elements
1867           if (is_array($vals)) {
1868             foreach ($vals as $key => $val) {
1869               //dont adjust the index of address block as
1870               //it's index is WRT to location type
1871               $newKey = ($block == 'address') ? $key : ++$key;
1872               $behalfOrganization[$block][$newKey] = $val;
1873             }
1874           }
1875         }
1876         unset($params['onbehalf_location']);
1877       }
1878       if (!empty($params['onbehalf[image_URL]'])) {
1879         $behalfOrganization['image_URL'] = $params['onbehalf[image_URL]'];
1880       }
1881     }
1882
1883     // check for profile double opt-in and get groups to be subscribed
1884     $subscribeGroupIds = CRM_Core_BAO_UFGroup::getDoubleOptInGroupIds($params, $contactID);
1885
1886     // since we are directly adding contact to group lets unset it from mailing
1887     if (!empty($addToGroups)) {
1888       foreach ($addToGroups as $groupId) {
1889         if (isset($subscribeGroupIds[$groupId])) {
1890           unset($subscribeGroupIds[$groupId]);
1891         }
1892       }
1893     }
1894
1895     foreach ($addToGroups as $k) {
1896       if (array_key_exists($k, $subscribeGroupIds)) {
1897         unset($addToGroups[$k]);
1898       }
1899     }
1900
1901     if (empty($contactID)) {
1902       $dupeParams = $params;
1903       if (!empty($dupeParams['onbehalf'])) {
1904         unset($dupeParams['onbehalf']);
1905       }
1906       if (!empty($dupeParams['honor'])) {
1907         unset($dupeParams['honor']);
1908       }
1909
1910       $dedupeParams = CRM_Dedupe_Finder::formatParams($dupeParams, 'Individual');
1911       $dedupeParams['check_permission'] = FALSE;
1912       $ids = CRM_Dedupe_Finder::dupesByParams($dedupeParams, 'Individual');
1913
1914       // if we find more than one contact, use the first one
1915       $contactID = CRM_Utils_Array::value(0, $ids);
1916
1917       // Fetch default greeting id's if creating a contact
1918       if (!$contactID) {
1919         foreach (CRM_Contact_BAO_Contact::$_greetingTypes as $greeting) {
1920           if (!isset($params[$greeting])) {
1921             $params[$greeting] = CRM_Contact_BAO_Contact_Utils::defaultGreeting('Individual', $greeting);
1922           }
1923         }
1924       }
1925       $contactType = NULL;
1926     }
1927     else {
1928       $contactType = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contactID, 'contact_type');
1929     }
1930     $contactID = CRM_Contact_BAO_Contact::createProfileContact(
1931       $params,
1932       $fields,
1933       $contactID,
1934       $addToGroups,
1935       NULL,
1936       $contactType,
1937       TRUE
1938     );
1939
1940     // Make the contact ID associated with the contribution available at the Class level.
1941     // Also make available to the session.
1942     //@todo consider handling this in $this->getContactID();
1943     $this->set('contactID', $contactID);
1944     $this->_contactID = $contactID;
1945
1946     //get email primary first if exist
1947     $subscriptionEmail = array('email' => CRM_Utils_Array::value('email-Primary', $params));
1948     if (!$subscriptionEmail['email']) {
1949       $subscriptionEmail['email'] = CRM_Utils_Array::value("email-{$this->_bltID}", $params);
1950     }
1951     // subscribing contact to groups
1952     if (!empty($subscribeGroupIds) && $subscriptionEmail['email']) {
1953       CRM_Mailing_Event_BAO_Subscribe::commonSubscribe($subscribeGroupIds, $subscriptionEmail, $contactID);
1954     }
1955
1956     // If onbehalf-of-organization contribution / signup, add organization
1957     // and it's location.
1958     if (isset($params['hidden_onbehalf_profile']) && isset($behalfOrganization['organization_name'])) {
1959       $ufFields = array();
1960       foreach ($this->_fields['onbehalf'] as $name => $value) {
1961         $ufFields[$name] = 1;
1962       }
1963       self::processOnBehalfOrganization($behalfOrganization, $contactID, $this->_values,
1964         $this->_params, $ufFields
1965       );
1966     }
1967     elseif (!empty($this->_membershipContactID) && $contactID != $this->_membershipContactID) {
1968       // this is an onbehalf renew case for inherited membership. For e.g a permissioned member of household,
1969       // store current user id as related contact for later use for mailing / activity..
1970       $this->_values['related_contact'] = $contactID;
1971       $this->_params['related_contact'] = $contactID;
1972       // swap contact like we do for on-behalf-org case, so parent/primary membership is affected
1973       $contactID = $this->_membershipContactID;
1974     }
1975
1976     // lets store the contactID in the session
1977     // for things like tell a friend
1978     $session = CRM_Core_Session::singleton();
1979     if (!$session->get('userID')) {
1980       $session->set('transaction.userID', $contactID);
1981     }
1982     else {
1983       $session->set('transaction.userID', NULL);
1984     }
1985
1986     $this->_useForMember = $this->get('useForMember');
1987
1988     // store the fact that this is a membership and membership type is selected
1989     if ((!empty($membershipParams['selectMembership']) &&
1990         $membershipParams['selectMembership'] != 'no_thanks'
1991       ) ||
1992       $this->_useForMember
1993     ) {
1994       if (!$this->_useForMember) {
1995         $this->assign('membership_assign', TRUE);
1996         $this->set('membershipTypeID', $this->_params['selectMembership']);
1997       }
1998
1999       if ($this->_action & CRM_Core_Action::PREVIEW) {
2000         $membershipParams['is_test'] = 1;
2001       }
2002       if ($this->_params['is_pay_later']) {
2003         $membershipParams['is_pay_later'] = 1;
2004       }
2005
2006       //inherit campaign from contribution page.
2007       if (!array_key_exists('campaign_id', $membershipParams)) {
2008         $membershipParams['campaign_id'] = CRM_Utils_Array::value('campaign_id', $this->_values);
2009       }
2010
2011       CRM_Core_Payment_Form::mapParams($this->_bltID, $this->_params, $membershipParams, TRUE);
2012       $this->doMembershipProcessing($contactID, $membershipParams, $premiumParams, $isPayLater);
2013     }
2014     else {
2015       // at this point we've created a contact and stored its address etc
2016       // all the payment processors expect the name and address to be in the
2017       // so we copy stuff over to first_name etc.
2018       $paymentParams = $this->_params;
2019       $contributionTypeId = $this->_values['financial_type_id'];
2020
2021       $fieldTypes = array();
2022       if (!empty($paymentParams['onbehalf']) &&
2023         is_array($paymentParams['onbehalf'])
2024       ) {
2025         foreach ($paymentParams['onbehalf'] as $key => $value) {
2026           if (strstr($key, 'custom_')) {
2027             $this->_params[$key] = $value;
2028           }
2029         }
2030         $fieldTypes = array('Contact', 'Organization', 'Contribution');
2031       }
2032       $financialTypeID = $this->wrangleFinancialTypeID($contributionTypeId);
2033
2034       $result = CRM_Contribute_BAO_Contribution_Utils::processConfirm($this, $paymentParams,
2035         $premiumParams, $contactID,
2036         $financialTypeID,
2037         'contribution',
2038         $fieldTypes,
2039         ($this->_mode == 'test') ? 1 : 0,
2040         $isPayLater
2041       );
2042
2043       if (CRM_Utils_Array::value('contribution_status_id', $result) == 1) {
2044         civicrm_api3('contribution', 'completetransaction', array(
2045           'id' => $result['contribution']->id,
2046           'trxn_id' => CRM_Utils_Array::value('trxn_id', $result),
2047           )
2048         );
2049       }
2050       return $result;
2051     }
2052   }
2053
2054   /**
2055    * Membership processing section.
2056    *
2057    * This is in a separate function as part of a move towards refactoring.
2058    *
2059    * @param int $contactID
2060    * @param array $membershipParams
2061    * @param array $premiumParams
2062    * @param bool $isPayLater
2063    */
2064   protected function doMembershipProcessing($contactID, $membershipParams, $premiumParams, $isPayLater) {
2065
2066     // added new parameter for cms user contact id, needed to distinguish behaviour for on behalf of sign-ups
2067     if (isset($this->_params['related_contact'])) {
2068       $membershipParams['cms_contactID'] = $this->_params['related_contact'];
2069     }
2070     else {
2071       $membershipParams['cms_contactID'] = $contactID;
2072     }
2073
2074     if (!empty($membershipParams['onbehalf']) &&
2075       is_array($membershipParams['onbehalf']) && !empty($membershipParams['onbehalf']['member_campaign_id'])
2076     ) {
2077       $this->_params['campaign_id'] = $membershipParams['onbehalf']['member_campaign_id'];
2078     }
2079
2080     $customFieldsFormatted = $fieldTypes = array();
2081     if (!empty($membershipParams['onbehalf']) &&
2082       is_array($membershipParams['onbehalf'])
2083     ) {
2084       foreach ($membershipParams['onbehalf'] as $key => $value) {
2085         if (strstr($key, 'custom_')) {
2086           $customFieldId = explode('_', $key);
2087           CRM_Core_BAO_CustomField::formatCustomField(
2088             $customFieldId[1],
2089             $customFieldsFormatted,
2090             $value,
2091             'Membership',
2092             NULL,
2093             $contactID
2094           );
2095         }
2096       }
2097       $fieldTypes = array('Contact', 'Organization', 'Membership');
2098     }
2099
2100     $priceFieldIds = $this->get('memberPriceFieldIDS');
2101
2102     if (!empty($priceFieldIds)) {
2103       $contributionTypeID = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $priceFieldIds['id'], 'financial_type_id');
2104       unset($priceFieldIds['id']);
2105       $membershipTypeIds = array();
2106       $membershipTypeTerms = array();
2107       foreach ($priceFieldIds as $priceFieldId) {
2108         if ($id = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id')) {
2109           $membershipTypeIds[] = $id;
2110           //@todo the value for $term is immediately overwritten. It is unclear from the code whether it was intentional to
2111           // do this or a double = was intended (this ambiguity is the reason many IDEs complain about 'assignment in condition'
2112           $term = 1;
2113           if ($term = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_num_terms')) {
2114             $membershipTypeTerms[$id] = ($term > 1) ? $term : 1;
2115           }
2116           else {
2117             $membershipTypeTerms[$id] = 1;
2118           }
2119         }
2120       }
2121       $membershipParams['selectMembership'] = $membershipTypeIds;
2122       $membershipParams['financial_type_id'] = $contributionTypeID;
2123       $membershipParams['types_terms'] = $membershipTypeTerms;
2124     }
2125     if (!empty($membershipParams['selectMembership'])) {
2126       // CRM-12233
2127       $membershipLineItems = array();
2128       if ($this->_separateMembershipPayment && $this->_values['amount_block_is_active']) {
2129         foreach ($this->_values['fee'] as $key => $feeValues) {
2130           if ($feeValues['name'] == 'membership_amount') {
2131             $fieldId = $this->_params['price_' . $key];
2132             $membershipLineItems[$this->_priceSetId][$fieldId] = $this->_lineItem[$this->_priceSetId][$fieldId];
2133             unset($this->_lineItem[$this->_priceSetId][$fieldId]);
2134             break;
2135           }
2136         }
2137       }
2138       $this->processMembership($membershipParams, $contactID, $customFieldsFormatted, $fieldTypes, $premiumParams, $membershipLineItems, $isPayLater);
2139       if (!$this->_amount > 0.0 || !$membershipParams['amount']) {
2140         // we need to explicitly create a CMS user in case of free memberships
2141         // since it is done under processConfirm for paid memberships
2142         CRM_Contribute_BAO_Contribution_Utils::createCMSUser($membershipParams,
2143           $membershipParams['cms_contactID'],
2144           'email-' . $this->_bltID
2145         );
2146       }
2147     }
2148   }
2149
2150 }