CRM/Contribute/Form/Contribution/Confirm.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * form to process actions on the group aspect of Custom Data
  20  */
  21 class CRM_Contribute_Form_Contribution_Confirm extends CRM_Contribute_Form_ContributionBase {
  22
  23   /**
  24    * The id of the contact associated with this contribution.
  25    *
  26    * @var int
  27    */
  28   public $_contactID;
  29
  30
  31   /**
  32    * The id of the contribution object that is created when the form is submitted.
  33    *
  34    * @var int
  35    */
  36   public $_contributionID;
  37
  38   public $submitOnce = TRUE;
  39
  40   /**
  41    * @param $form
  42    * @param $params
  43    * @param $contributionParams
  44    * @param $pledgeID
  45    * @param $contribution
  46    * @param $isEmailReceipt
  47    * @return mixed
  48    */
  49   public static function handlePledge(&$form, $params, $contributionParams, $pledgeID, $contribution, $isEmailReceipt) {
  50     if ($pledgeID) {
  51       //when user doing pledge payments.
  52       //update the schedule when payment(s) are made
  53       $amount = $params['amount'];
  54       $pledgePaymentParams = [];
  55       foreach ($params['pledge_amount'] as $paymentId => $dontCare) {
  56         $scheduledAmount = CRM_Core_DAO::getFieldValue(
  57           'CRM_Pledge_DAO_PledgePayment',
  58           $paymentId,
  59           'scheduled_amount',
  60           'id'
  61         );
  62
  63         $pledgePayment = ($amount >= $scheduledAmount) ? $scheduledAmount : $amount;
  64         if ($pledgePayment > 0) {
  65           $pledgePaymentParams[] = [
  66             'id' => $paymentId,
  67             'contribution_id' => $contribution->id,
  68             'status_id' => $contribution->contribution_status_id,
  69             'actual_amount' => $pledgePayment,
  70           ];
  71           $amount -= $pledgePayment;
  72         }
  73       }
  74       if ($amount > 0 && count($pledgePaymentParams)) {
  75         $pledgePaymentParams[count($pledgePaymentParams) - 1]['actual_amount'] += $amount;
  76       }
  77       foreach ($pledgePaymentParams as $p) {
  78         CRM_Pledge_BAO_PledgePayment::add($p);
  79       }
  80
  81       //update pledge status according to the new payment statuses
  82       CRM_Pledge_BAO_PledgePayment::updatePledgePaymentStatus($pledgeID);
  83       return $form;
  84     }
  85     else {
  86       //when user creating pledge record.
  87       $pledgeParams = [];
  88       $pledgeParams['contact_id'] = $contribution->contact_id;
  89       $pledgeParams['installment_amount'] = $pledgeParams['actual_amount'] = $contribution->total_amount;
  90       $pledgeParams['contribution_id'] = $contribution->id;
  91       $pledgeParams['contribution_page_id'] = $contribution->contribution_page_id;
  92       $pledgeParams['financial_type_id'] = $contribution->financial_type_id;
  93       $pledgeParams['frequency_interval'] = $params['pledge_frequency_interval'];
  94       $pledgeParams['installments'] = $params['pledge_installments'];
  95       $pledgeParams['frequency_unit'] = $params['pledge_frequency_unit'];
  96       if ($pledgeParams['frequency_unit'] === 'month') {
  97         $pledgeParams['frequency_day'] = intval(date("d"));
  98       }
  99       else {
 100         $pledgeParams['frequency_day'] = 1;
 101       }
 102       $pledgeParams['create_date'] = $pledgeParams['start_date'] = $pledgeParams['scheduled_date'] = date("Ymd");
 103       if (!empty($params['start_date'])) {
 104         $pledgeParams['frequency_day'] = intval(date("d", strtotime($params['start_date'])));
 105         $pledgeParams['start_date'] = $pledgeParams['scheduled_date'] = date('Ymd', strtotime($params['start_date']));
 106       }
 107       $pledgeParams['status_id'] = $contribution->contribution_status_id;
 108       $pledgeParams['max_reminders'] = $form->_values['max_reminders'];
 109       $pledgeParams['initial_reminder_day'] = $form->_values['initial_reminder_day'];
 110       $pledgeParams['additional_reminder_day'] = $form->_values['additional_reminder_day'];
 111       $pledgeParams['is_test'] = $contribution->is_test;
 112       $pledgeParams['acknowledge_date'] = date('Ymd');
 113       $pledgeParams['original_installment_amount'] = $pledgeParams['installment_amount'];
 114
 115       //inherit campaign from contirb page.
 116       $pledgeParams['campaign_id'] = $contributionParams['campaign_id'] ?? NULL;
 117
 118       $pledge = CRM_Pledge_BAO_Pledge::create($pledgeParams);
 119
 120       $form->_params['pledge_id'] = $pledge->id;
 121
 122       //send acknowledgment email. only when pledge is created
 123       if ($pledge->id && $isEmailReceipt) {
 124         //build params to send acknowledgment.
 125         $pledgeParams['id'] = $pledge->id;
 126         $pledgeParams['receipt_from_name'] = $form->_values['receipt_from_name'];
 127         $pledgeParams['receipt_from_email'] = $form->_values['receipt_from_email'];
 128
 129         //scheduled amount will be same as installment_amount.
 130         $pledgeParams['scheduled_amount'] = $pledgeParams['installment_amount'];
 131
 132         //get total pledge amount.
 133         $pledgeParams['total_pledge_amount'] = $pledge->amount;
 134
 135         CRM_Pledge_BAO_Pledge::sendAcknowledgment($form, $pledgeParams);
 136         return $form;
 137       }
 138       return $form;
 139     }
 140   }
 141
 142   /**
 143    * Set the parameters to be passed to contribution create function.
 144    *
 145    * @param array $params
 146    * @param int $financialTypeID
 147    * @param array $paymentProcessorOutcome
 148    * @param string $receiptDate
 149    * @param int $recurringContributionID
 150    *
 151    * @return array
 152    * @throws \CRM_Core_Exception
 153    */
 154   public static function getContributionParams(
 155     $params, $financialTypeID,
 156     $paymentProcessorOutcome, $receiptDate, $recurringContributionID) {
 157     $contributionParams = [
 158       'financial_type_id' => $financialTypeID,
 159       'receive_date' => !empty($params['receive_date']) ? CRM_Utils_Date::processDate($params['receive_date']) : date('YmdHis'),
 160       'tax_amount' => $params['tax_amount'] ?? NULL,
 161       'amount_level' => $params['amount_level'] ?? NULL,
 162       'invoice_id' => $params['invoiceID'],
 163       'currency' => $params['currencyID'],
 164       'is_pay_later' => $params['is_pay_later'] ?? 0,
 165       //configure cancel reason, cancel date and thankyou date
 166       //from 'contribution' type profile if included
 167       'cancel_reason' => $params['cancel_reason'] ?? 0,
 168       'cancel_date' => isset($params['cancel_date']) ? CRM_Utils_Date::format($params['cancel_date']) : NULL,
 169       'thankyou_date' => isset($params['thankyou_date']) ? CRM_Utils_Date::format($params['thankyou_date']) : NULL,
 170       //setting to make available to hook - although seems wrong to set on form for BAO hook availability
 171       'skipLineItem' => $params['skipLineItem'] ?? 0,
 172     ];
 173
 174     if ($paymentProcessorOutcome) {
 175       $contributionParams['payment_processor'] = $paymentProcessorOutcome['payment_processor'] ?? NULL;
 176     }
 177     if (!empty($params["is_email_receipt"])) {
 178       $contributionParams += [
 179         'receipt_date' => $receiptDate,
 180       ];
 181     }
 182
 183     if ($recurringContributionID) {
 184       $contributionParams['contribution_recur_id'] = $recurringContributionID;
 185     }
 186
 187     $contributionParams['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
 188     if (isset($contributionParams['invoice_id'])) {
 189       $contributionParams['id'] = CRM_Core_DAO::getFieldValue(
 190         'CRM_Contribute_DAO_Contribution',
 191         $contributionParams['invoice_id'],
 192         'id',
 193         'invoice_id'
 194       );
 195     }
 196
 197     return $contributionParams;
 198   }
 199
 200   /**
 201    * Get non-deductible amount.
 202    *
 203    * This is a bit too much about wierd form interpretation to be this deep.
 204    *
 205    * @see https://issues.civicrm.org/jira/browse/CRM-11885
 206    *  if non_deductible_amount exists i.e. Additional Details fieldset was opened [and staff typed something] -> keep
 207    * it.
 208    *
 209    * @param array $params
 210    * @param CRM_Financial_BAO_FinancialType $financialType
 211    * @param bool $online
 212    * @param CRM_Contribute_Form_Contribution_Confirm $form
 213    *
 214    * @return array
 215    */
 216   public static function getNonDeductibleAmount($params, $financialType, $online, $form) {
 217     if (isset($params['non_deductible_amount']) && (!empty($params['non_deductible_amount']))) {
 218       return $params['non_deductible_amount'];
 219     }
 220     $priceSetId = $params['priceSetId'] ?? NULL;
 221     // return non-deductible amount if it is set at the price field option level
 222     if ($priceSetId && !empty($form->_lineItem)) {
 223       $nonDeductibleAmount = CRM_Price_BAO_PriceSet::getNonDeductibleAmountFromPriceSet($priceSetId, $form->_lineItem);
 224     }
 225
 226     if (!empty($nonDeductibleAmount)) {
 227       return $nonDeductibleAmount;
 228     }
 229     else {
 230       if ($financialType->is_deductible) {
 231         if ($online && isset($params['selectProduct'])) {
 232           $selectProduct = $params['selectProduct'] ?? NULL;
 233         }
 234         if (!$online && isset($params['product_name'][0])) {
 235           $selectProduct = $params['product_name'][0];
 236         }
 237         // if there is a product - compare the value to the contribution amount
 238         if (isset($selectProduct) &&
 239           $selectProduct !== 'no_thanks'
 240         ) {
 241           $productDAO = new CRM_Contribute_DAO_Product();
 242           $productDAO->id = $selectProduct;
 243           $productDAO->find(TRUE);
 244           // product value exceeds contribution amount
 245           if ($params['amount'] < $productDAO->price) {
 246             $nonDeductibleAmount = $params['amount'];
 247             return $nonDeductibleAmount;
 248           }
 249           // product value does NOT exceed contribution amount
 250           else {
 251             return $productDAO->price;
 252           }
 253         }
 254         // contribution is deductible - but there is no product
 255         else {
 256           return '0.00';
 257         }
 258       }
 259       // contribution is NOT deductible
 260       else {
 261         return $params['amount'];
 262       }
 263     }
 264   }
 265
 266   /**
 267    * Set variables up before form is built.
 268    */
 269   public function preProcess() {
 270     parent::preProcess();
 271
 272     // lineItem isn't set until Register postProcess
 273     $this->_lineItem = $this->get('lineItem');
 274     $this->_ccid = $this->get('ccid');
 275
 276     $this->_params = $this->controller->exportValues('Main');
 277     $this->_params['ip_address'] = CRM_Utils_System::ipAddress();
 278     $this->_params['amount'] = $this->get('amount');
 279     if (isset($this->_params['amount'])) {
 280       $this->setFormAmountFields($this->_params['priceSetId']);
 281     }
 282
 283     $this->_params['tax_amount'] = $this->get('tax_amount');
 284     $this->_useForMember = $this->get('useForMember');
 285
 286     CRM_Contribute_Form_AbstractEditPayment::formatCreditCardDetails($this->_params);
 287
 288     $this->_params['currencyID'] = CRM_Core_Config::singleton()->defaultCurrency;
 289
 290     if (!empty($this->_membershipBlock)) {
 291       $this->_params['selectMembership'] = $this->get('selectMembership');
 292     }
 293     if (!empty($this->_paymentProcessor) &&  $this->_paymentProcessor['object']->supports('preApproval')) {
 294       $preApprovalParams = $this->_paymentProcessor['object']->getPreApprovalDetails($this->get('pre_approval_parameters'));
 295       $this->_params = array_merge($this->_params, $preApprovalParams);
 296
 297       // We may have fetched some billing details from the getPreApprovalDetails function so we
 298       // want to ensure we set this after that function has been called.
 299       CRM_Core_Payment_Form::mapParams($this->_bltID, $preApprovalParams, $this->_params, FALSE);
 300     }
 301
 302     $this->_params['is_pay_later'] = $this->get('is_pay_later');
 303     $this->assign('is_pay_later', $this->_params['is_pay_later']);
 304     if ($this->_params['is_pay_later']) {
 305       $this->assign('pay_later_receipt', $this->_values['pay_later_receipt'] ?? NULL);
 306     }
 307     // if onbehalf-of-organization
 308     if (!empty($this->_values['onbehalf_profile_id']) && !empty($this->_params['onbehalf']['organization_name'])) {
 309       if (empty($this->_params['org_option']) && empty($this->_params['organization_id'])) {
 310         $this->_params['organization_id'] = $this->_params['onbehalfof_id'] ?? NULL;
 311       }
 312       $this->_params['organization_name'] = $this->_params['onbehalf']['organization_name'];
 313       $addressBlocks = [
 314         'street_address',
 315         'city',
 316         'state_province',
 317         'postal_code',
 318         'country',
 319         'supplemental_address_1',
 320         'supplemental_address_2',
 321         'supplemental_address_3',
 322         'postal_code_suffix',
 323         'geo_code_1',
 324         'geo_code_2',
 325         'address_name',
 326       ];
 327
 328       $blocks = ['email', 'phone', 'im', 'url', 'openid'];
 329       foreach ($this->_params['onbehalf'] as $loc => $value) {
 330         $field = $typeId = NULL;
 331         if (strstr($loc, '-')) {
 332           [$field, $locType] = explode('-', $loc);
 333         }
 334
 335         if (in_array($field, $addressBlocks)) {
 336           if ($locType === 'Primary') {
 337             $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
 338             $locType = $defaultLocationType->id;
 339           }
 340
 341           if ($field === 'country') {
 342             $value = CRM_Core_PseudoConstant::countryIsoCode($value);
 343           }
 344           elseif ($field === 'state_province') {
 345             $value = CRM_Core_PseudoConstant::stateProvinceAbbreviation($value);
 346           }
 347
 348           $isPrimary = 1;
 349           if (isset($this->_params['onbehalf_location']['address'])
 350             && count($this->_params['onbehalf_location']['address']) > 0
 351           ) {
 352             $isPrimary = 0;
 353           }
 354
 355           $this->_params['onbehalf_location']['address'][$locType][$field] = $value;
 356           if (empty($this->_params['onbehalf_location']['address'][$locType]['is_primary'])) {
 357             $this->_params['onbehalf_location']['address'][$locType]['is_primary'] = $isPrimary;
 358           }
 359           $this->_params['onbehalf_location']['address'][$locType]['location_type_id'] = $locType;
 360         }
 361         elseif (in_array($field, $blocks)) {
 362           if (!$typeId || is_numeric($typeId)) {
 363             $blockName = $fieldName = $field;
 364             $locationType = 'location_type_id';
 365             if ($locType === 'Primary') {
 366               $defaultLocationType = CRM_Core_BAO_LocationType::getDefault();
 367               $locationValue = $defaultLocationType->id;
 368             }
 369             else {
 370               $locationValue = $locType;
 371             }
 372             $locTypeId = '';
 373             $phoneExtField = [];
 374
 375             if ($field === 'url') {
 376               $blockName = 'website';
 377               $locationType = 'website_type_id';
 378               [$field, $locationValue] = explode('-', $loc);
 379             }
 380             elseif ($field === 'im') {
 381               $fieldName = 'name';
 382               $locTypeId = 'provider_id';
 383               $typeId = $this->_params['onbehalf']["{$loc}-provider_id"];
 384             }
 385             elseif ($field == 'phone') {
 386               [$field, $locType, $typeId] = explode('-', $loc);
 387               $locTypeId = 'phone_type_id';
 388
 389               //check if extension field exists
 390               $extField = str_replace('phone', 'phone_ext', $loc);
 391               if (isset($this->_params['onbehalf'][$extField])) {
 392                 $phoneExtField = ['phone_ext' => $this->_params['onbehalf'][$extField]];
 393               }
 394             }
 395
 396             $isPrimary = 1;
 397             if (isset($this->_params['onbehalf_location'][$blockName])
 398               && count($this->_params['onbehalf_location'][$blockName]) > 0
 399             ) {
 400               $isPrimary = 0;
 401             }
 402             if ($locationValue) {
 403               $blockValues = [
 404                 $fieldName => $value,
 405                 $locationType => $locationValue,
 406                 'is_primary' => $isPrimary,
 407               ];
 408
 409               if ($locTypeId) {
 410                 $blockValues = array_merge($blockValues, [$locTypeId => $typeId]);
 411               }
 412               if (!empty($phoneExtField)) {
 413                 $blockValues = array_merge($blockValues, $phoneExtField);
 414               }
 415
 416               $this->_params['onbehalf_location'][$blockName][] = $blockValues;
 417             }
 418           }
 419         }
 420         elseif (strstr($loc, 'custom')) {
 421           if ($value && isset($this->_params['onbehalf']["{$loc}_id"])) {
 422             $value = $this->_params['onbehalf']["{$loc}_id"];
 423           }
 424           $this->_params['onbehalf_location']["{$loc}"] = $value;
 425         }
 426         else {
 427           if ($loc === 'contact_sub_type') {
 428             $this->_params['onbehalf_location'][$loc] = $value;
 429           }
 430           else {
 431             $this->_params['onbehalf_location'][$field] = $value;
 432           }
 433         }
 434       }
 435     }
 436     elseif (!empty($this->_values['is_for_organization'])) {
 437       // no on behalf of an organization, CRM-5519
 438       // so reset loc blocks from main params.
 439       foreach ([
 440         'phone',
 441         'email',
 442         'address',
 443       ] as $blk) {
 444         if (isset($this->_params[$blk])) {
 445           unset($this->_params[$blk]);
 446         }
 447       }
 448     }
 449     $this->setRecurringMembershipParams();
 450
 451     if ($this->_pcpId) {
 452       $params = $this->processPcp($this, $this->_params);
 453       $this->_params = $params;
 454     }
 455     $this->_params['invoiceID'] = $this->get('invoiceID');
 456
 457     //carry campaign from profile.
 458     if (array_key_exists('contribution_campaign_id', $this->_params)) {
 459       $this->_params['campaign_id'] = $this->_params['contribution_campaign_id'];
 460     }
 461
 462     // assign contribution page id to the template so we can add css class for it
 463     $this->assign('contributionPageID', $this->_id);
 464     $this->assign('is_for_organization', $this->_params['is_for_organization'] ?? NULL);
 465
 466     $this->set('params', $this->_params);
 467   }
 468
 469   /**
 470    * Build the form object.
 471    */
 472   public function buildQuickForm() {
 473     // FIXME: Some of this code is identical to Thankyou.php and should be broken out into a shared function
 474     $this->assignToTemplate();
 475
 476     $params = $this->_params;
 477     // make sure we have values for it
 478     if (!empty($this->_values['honoree_profile_id']) && !empty($params['soft_credit_type_id']) && empty($this->_ccid)) {
 479       $honorName = NULL;
 480       $softCreditTypes = CRM_Core_OptionGroup::values("soft_credit_type", FALSE);
 481
 482       $this->assign('soft_credit_type', $softCreditTypes[$params['soft_credit_type_id']]);
 483       CRM_Contribute_BAO_ContributionSoft::formatHonoreeProfileFields($this, $params['honor']);
 484
 485       $fieldTypes = ['Contact'];
 486       $fieldTypes[] = CRM_Core_BAO_UFGroup::getContactType($this->_values['honoree_profile_id']);
 487       $this->buildCustom($this->_values['honoree_profile_id'], 'honoreeProfileFields', TRUE, 'honor', $fieldTypes);
 488     }
 489     $this->assign('receiptFromEmail', $this->_values['receipt_from_email'] ?? NULL);
 490     $amount_block_is_active = $this->get('amount_block_is_active');
 491     $this->assign('amount_block_is_active', $amount_block_is_active);
 492
 493     // Make a copy of line items array to use for display only
 494     $tplLineItems = $this->_lineItem;
 495     if (CRM_Invoicing_Utils::isInvoicingEnabled()) {
 496       // @todo $params seems like exactly the wrong place to get totalTaxAmount from
 497       // this is a calculated variable so we it should be transparent how we
 498       // calculated it rather than coming from 'params'
 499       $this->assign('totalTaxAmount', $params['tax_amount']);
 500     }
 501     $this->assignLineItemsToTemplate($tplLineItems);
 502
 503     $isDisplayLineItems = $this->_priceSetId && !CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_priceSetId, 'is_quick_config');
 504
 505     $this->assign('isDisplayLineItems', $isDisplayLineItems);
 506
 507     if (!$isDisplayLineItems) {
 508       // quickConfig is deprecated in favour of isDisplayLineItems. Lots of logic has been harnessed to quick config
 509       // whereas isDisplayLineItems is specific & clear.
 510       $this->assign('is_quick_config', 1);
 511       $this->_params['is_quick_config'] = 1;
 512     }
 513
 514     if (!empty($params['selectProduct']) && $params['selectProduct'] !== 'no_thanks') {
 515       $option = $params['options_' . $params['selectProduct']] ?? NULL;
 516       $productID = $params['selectProduct'];
 517       CRM_Contribute_BAO_Premium::buildPremiumBlock($this, $this->_id, FALSE,
 518         $productID, $option
 519       );
 520       $this->set('productID', $productID);
 521       $this->set('option', $option);
 522     }
 523     $config = CRM_Core_Config::singleton();
 524     if (in_array('CiviMember', $config->enableComponents) && empty($this->_ccid)) {
 525       if (isset($params['selectMembership']) &&
 526         $params['selectMembership'] !== 'no_thanks'
 527       ) {
 528         $this->buildMembershipBlock(
 529           $this->_membershipContactID,
 530           $params['selectMembership']
 531         );
 532         if (!empty($params['auto_renew'])) {
 533           $this->assign('auto_renew', TRUE);
 534         }
 535       }
 536       else {
 537         $this->assign('membershipBlock', FALSE);
 538       }
 539     }
 540     if (empty($this->_ccid)) {
 541       $this->buildCustom($this->_values['custom_pre_id'], 'customPre', TRUE);
 542       $this->buildCustom($this->_values['custom_post_id'], 'customPost', TRUE);
 543     }
 544
 545     if (!empty($this->_values['onbehalf_profile_id']) &&
 546       !empty($params['onbehalf']) &&
 547       ($this->_values['is_for_organization'] == 2 ||
 548         !empty($params['is_for_organization'])
 549       ) && empty($this->_ccid)
 550     ) {
 551       $fieldTypes = ['Contact', 'Organization'];
 552       $contactSubType = CRM_Contact_BAO_ContactType::subTypes('Organization');
 553       $fieldTypes = array_merge($fieldTypes, $contactSubType);
 554       if (is_array($this->_membershipBlock) && !empty($this->_membershipBlock)) {
 555         $fieldTypes = array_merge($fieldTypes, ['Membership']);
 556       }
 557       else {
 558         $fieldTypes = array_merge($fieldTypes, ['Contribution']);
 559       }
 560
 561       $this->buildCustom($this->_values['onbehalf_profile_id'], 'onbehalfProfile', TRUE, 'onbehalf', $fieldTypes);
 562     }
 563
 564     $this->_separateMembershipPayment = $this->get('separateMembershipPayment');
 565     $this->assign('is_separate_payment', $this->_separateMembershipPayment);
 566
 567     $this->assign('priceSetID', $this->_priceSetId);
 568
 569     // The concept of contributeMode is deprecated.
 570     // the is_monetary concept probably should be too as it can be calculated from
 571     // the existence of 'amount' & seems fragile.
 572     if ($this->_contributeMode === 'notify' ||
 573       $this->_amount <= 0.0 || $this->_params['is_pay_later']
 574     ) {
 575       $contribButton = ts('Continue');
 576     }
 577     elseif (!empty($this->_ccid)) {
 578       $contribButton = ts('Make Payment');
 579     }
 580     else {
 581       $contribButton = ts('Make Contribution');
 582     }
 583     $this->assign('button', $contribButton);
 584
 585     $this->assign('continueText',
 586       $this->getPaymentProcessorObject()->getText('contributionPageContinueText', [
 587         'is_payment_to_existing' => !empty($this->_ccid),
 588         'amount' => $this->_amount,
 589       ])
 590     );
 591
 592     $this->addButtons([
 593       [
 594         'type' => 'next',
 595         'name' => $contribButton,
 596         'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 597         'isDefault' => TRUE,
 598       ],
 599       [
 600         'type' => 'back',
 601         'name' => ts('Go Back'),
 602       ],
 603     ]);
 604
 605     $defaults = [];
 606     $fields = array_fill_keys(array_keys($this->_fields), 1);
 607     $fields["billing_state_province-{$this->_bltID}"] = $fields["billing_country-{$this->_bltID}"] = $fields["email-{$this->_bltID}"] = 1;
 608
 609     $contact = $this->_params;
 610     foreach ($fields as $name => $dontCare) {
 611       // Recursively set defaults for nested fields
 612       if (isset($contact[$name]) && is_array($contact[$name]) && ($name === 'onbehalf' || $name === 'honor')) {
 613         foreach ($contact[$name] as $fieldName => $fieldValue) {
 614           if (is_array($fieldValue) && $this->_fields[$name][$fieldName]['html_type'] === 'CheckBox') {
 615             foreach ($fieldValue as $key => $value) {
 616               $defaults["{$name}[{$fieldName}][{$key}]"] = $value;
 617             }
 618           }
 619           else {
 620             $defaults["{$name}[{$fieldName}]"] = $fieldValue;
 621           }
 622         }
 623       }
 624       elseif (isset($contact[$name])) {
 625         $defaults[$name] = $contact[$name];
 626         if (substr($name, 0, 7) === 'custom_') {
 627           $timeField = "{$name}_time";
 628           if (isset($contact[$timeField])) {
 629             $defaults[$timeField] = $contact[$timeField];
 630           }
 631           if (isset($contact["{$name}_id"])) {
 632             $defaults["{$name}_id"] = $contact["{$name}_id"];
 633           }
 634         }
 635         elseif (in_array($name, [
 636           'addressee',
 637           'email_greeting',
 638           'postal_greeting',
 639         ]) && !empty($contact[$name . '_custom'])
 640         ) {
 641           $defaults[$name . '_custom'] = $contact[$name . '_custom'];
 642         }
 643       }
 644     }
 645
 646     $this->assign('useForMember', $this->get('useForMember'));
 647
 648     $this->setDefaults($defaults);
 649
 650     $this->freeze();
 651   }
 652
 653   /**
 654    * Build Membership  Block in Contribution Pages.
 655    * @todo this was shared on CRM_Contribute_Form_ContributionBase but we are refactoring and simplifying for each
 656    *   step (main/confirm/thankyou)
 657    *
 658    * @param int $cid
 659    *   Contact checked for having a current membership for a particular membership.
 660    * @param int|array $selectedMembershipTypeID
 661    *   Selected membership id.
 662    * @param null $isTest
 663    *
 664    * @return bool
 665    *   Is this a separate membership payment
 666    *
 667    * @throws \CiviCRM_API3_Exception
 668    * @throws \CRM_Core_Exception
 669    */
 670   private function buildMembershipBlock($cid, $selectedMembershipTypeID = NULL, $isTest = NULL) {
 671     $separateMembershipPayment = FALSE;
 672     if ($this->_membershipBlock) {
 673       $this->_currentMemberships = [];
 674
 675       $membershipTypeIds = $membershipTypes = $radio = $radioOptAttrs = [];
 676       $membershipPriceset = (!empty($this->_priceSetId) && $this->_useForMember);
 677
 678       $allowAutoRenewMembership = $autoRenewOption = FALSE;
 679       $autoRenewMembershipTypeOptions = [];
 680
 681       $separateMembershipPayment = $this->_membershipBlock['is_separate_payment'] ?? NULL;
 682
 683       if ($membershipPriceset) {
 684         foreach ($this->_priceSet['fields'] as $pField) {
 685           if (empty($pField['options'])) {
 686             continue;
 687           }
 688           foreach ($pField['options'] as $opId => $opValues) {
 689             if (empty($opValues['membership_type_id'])) {
 690               continue;
 691             }
 692             $membershipTypeIds[$opValues['membership_type_id']] = $opValues['membership_type_id'];
 693           }
 694         }
 695       }
 696       elseif (!empty($this->_membershipBlock['membership_types'])) {
 697         $membershipTypeIds = explode(',', $this->_membershipBlock['membership_types']);
 698       }
 699
 700       if (!empty($membershipTypeIds)) {
 701         //set status message if wrong membershipType is included in membershipBlock
 702         if (isset($this->_mid) && !$membershipPriceset) {
 703           $membershipTypeID = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
 704             $this->_mid,
 705             'membership_type_id'
 706           );
 707           if (!in_array($membershipTypeID, $membershipTypeIds)) {
 708             CRM_Core_Session::setStatus(ts("Oops. The membership you're trying to renew appears to be invalid. Contact your site administrator if you need assistance. If you continue, you will be issued a new membership."), ts('Invalid Membership'), 'error');
 709           }
 710         }
 711
 712         $membershipTypeValues = CRM_Member_BAO_Membership::buildMembershipTypeValues($this, $membershipTypeIds);
 713         $this->_membershipTypeValues = $membershipTypeValues;
 714         $endDate = NULL;
 715
 716         // Check if we support auto-renew on this contribution page
 717         // FIXME: If any of the payment processors do NOT support recurring you cannot setup an
 718         //   auto-renew payment even if that processor is not selected.
 719         $allowAutoRenewOpt = TRUE;
 720         if (is_array($this->_paymentProcessors)) {
 721           foreach ($this->_paymentProcessors as $id => $val) {
 722             if ($id && !$val['is_recur']) {
 723               $allowAutoRenewOpt = FALSE;
 724             }
 725           }
 726         }
 727         foreach ($membershipTypeIds as $value) {
 728           $memType = $membershipTypeValues[$value];
 729           if ($selectedMembershipTypeID != NULL) {
 730             if ($memType['id'] == $selectedMembershipTypeID) {
 731               $this->assign('minimum_fee', $memType['minimum_fee'] ?? NULL);
 732               $this->assign('membership_name', $memType['name']);
 733               if ($cid) {
 734                 $membership = new CRM_Member_DAO_Membership();
 735                 $membership->contact_id = $cid;
 736                 $membership->membership_type_id = $memType['id'];
 737                 if ($membership->find(TRUE)) {
 738                   $this->assign('renewal_mode', TRUE);
 739                   $memType['current_membership'] = $membership->end_date;
 740                   $this->_currentMemberships[$membership->membership_type_id] = $membership->membership_type_id;
 741                 }
 742               }
 743               $membershipTypes[] = $memType;
 744             }
 745           }
 746           elseif ($memType['is_active']) {
 747
 748             if ($allowAutoRenewOpt) {
 749               $javascriptMethod = ['onclick' => "return showHideAutoRenew( this.value );"];
 750               $isAvailableAutoRenew = $this->_membershipBlock['auto_renew'][$value] ?? 1;
 751               $autoRenewMembershipTypeOptions["autoRenewMembershipType_{$value}"] = (int) $memType['auto_renew'] * $isAvailableAutoRenew;
 752               $allowAutoRenewMembership = TRUE;
 753             }
 754             else {
 755               $javascriptMethod = NULL;
 756               $autoRenewMembershipTypeOptions["autoRenewMembershipType_{$value}"] = 0;
 757             }
 758
 759             //add membership type.
 760             $radio[$memType['id']] = NULL;
 761             $radioOptAttrs[$memType['id']] = $javascriptMethod;
 762             if ($cid) {
 763               $membership = new CRM_Member_DAO_Membership();
 764               $membership->contact_id = $cid;
 765               $membership->membership_type_id = $memType['id'];
 766
 767               //show current membership, skip pending and cancelled membership records,
 768               //because we take first membership record id for renewal
 769               $membership->whereAdd('status_id != 5 AND status_id !=6');
 770
 771               if (!is_null($isTest)) {
 772                 $membership->is_test = $isTest;
 773               }
 774
 775               //CRM-4297
 776               $membership->orderBy('end_date DESC');
 777
 778               if ($membership->find(TRUE)) {
 779                 if (!$membership->end_date) {
 780                   unset($radio[$memType['id']]);
 781                   unset($radioOptAttrs[$memType['id']]);
 782                   $this->assign('islifetime', TRUE);
 783                   continue;
 784                 }
 785                 $this->assign('renewal_mode', TRUE);
 786                 $this->_currentMemberships[$membership->membership_type_id] = $membership->membership_type_id;
 787                 $memType['current_membership'] = $membership->end_date;
 788                 if (!$endDate) {
 789                   $endDate = $memType['current_membership'];
 790                   $this->_defaultMemTypeId = $memType['id'];
 791                 }
 792                 if ($memType['current_membership'] < $endDate) {
 793                   $endDate = $memType['current_membership'];
 794                   $this->_defaultMemTypeId = $memType['id'];
 795                 }
 796               }
 797             }
 798             $membershipTypes[] = $memType;
 799           }
 800         }
 801       }
 802
 803       $this->assign('membershipBlock', $this->_membershipBlock);
 804       $this->assign('showRadio', FALSE);
 805       $this->assign('membershipTypes', $membershipTypes);
 806       $this->assign('allowAutoRenewMembership', $allowAutoRenewMembership);
 807       $this->assign('autoRenewMembershipTypeOptions', json_encode($autoRenewMembershipTypeOptions));
 808       //give preference to user submitted auto_renew value.
 809       $takeUserSubmittedAutoRenew = (!empty($_POST) || $this->isSubmitted());
 810       $this->assign('takeUserSubmittedAutoRenew', $takeUserSubmittedAutoRenew);
 811
 812       // Assign autorenew option (0:hide,1:optional,2:required) so we can use it in confirmation etc.
 813       $autoRenewOption = CRM_Price_BAO_PriceSet::checkAutoRenewForPriceSet($this->_priceSetId);
 814       //$selectedMembershipTypeID is retrieved as an array for membership priceset if multiple
 815       //options for different organisation is selected on the contribution page.
 816       if (is_numeric($selectedMembershipTypeID) && isset($membershipTypeValues[$selectedMembershipTypeID]['auto_renew'])) {
 817         $this->assign('autoRenewOption', $membershipTypeValues[$selectedMembershipTypeID]['auto_renew']);
 818       }
 819       else {
 820         $this->assign('autoRenewOption', $autoRenewOption);
 821       }
 822     }
 823
 824     return $separateMembershipPayment;
 825   }
 826
 827   /**
 828    * Overwrite action.
 829    *
 830    * Since we are only showing elements in frozen mode no help display needed.
 831    *
 832    * @return int
 833    */
 834   public function getAction() {
 835     if ($this->_action & CRM_Core_Action::PREVIEW) {
 836       return CRM_Core_Action::VIEW | CRM_Core_Action::PREVIEW;
 837     }
 838     else {
 839       return CRM_Core_Action::VIEW;
 840     }
 841   }
 842
 843   /**
 844    * Set default values for the form.
 845    *
 846    * Note that in edit/view mode
 847    * the default values are retrieved from the database
 848    */
 849   public function setDefaultValues() {
 850   }
 851
 852   /**
 853    * Process the form.
 854    */
 855   public function postProcess() {
 856     $contactID = $this->getContactID();
 857     try {
 858       $result = $this->processFormSubmission($contactID);
 859     }
 860     catch (CRM_Core_Exception $e) {
 861       $this->bounceOnError($e->getMessage());
 862     }
 863
 864     if (is_array($result) && !empty($result['is_payment_failure'])) {
 865       $this->bounceOnError($result['error']->getMessage());
 866     }
 867     // Presumably this is for hooks to access? Not quite clear & perhaps not required.
 868     $this->set('params', $this->_params);
 869   }
 870
 871   /**
 872    * Wrangle financial type ID.
 873    *
 874    * 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
 875    * Pledges are not relevant to the membership code so that portion will not go onto the membership form.
 876    *
 877    * Comments from previous refactor indicate doubt as to what was going on.
 878    *
 879    * @param int $financialTypeID
 880    *
 881    * @return null|string
 882    */
 883   public function wrangleFinancialTypeID($financialTypeID) {
 884     if (empty($financialTypeID) && !empty($this->_values['pledge_id'])) {
 885       $financialTypeID = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_Pledge',
 886         $this->_values['pledge_id'],
 887         'financial_type_id'
 888       );
 889     }
 890     return $financialTypeID;
 891   }
 892
 893   /**
 894    * Process the form.
 895    *
 896    * @param array $premiumParams
 897    * @param CRM_Contribute_BAO_Contribution $contribution
 898    */
 899   protected function postProcessPremium($premiumParams, $contribution) {
 900     $hour = $minute = $second = 0;
 901     // assigning Premium information to receipt tpl
 902     $selectProduct = $premiumParams['selectProduct'] ?? NULL;
 903     if ($selectProduct &&
 904       $selectProduct != 'no_thanks'
 905     ) {
 906       $startDate = $endDate = "";
 907       $this->assign('selectPremium', TRUE);
 908       $productDAO = new CRM_Contribute_DAO_Product();
 909       $productDAO->id = $selectProduct;
 910       $productDAO->find(TRUE);
 911       $this->assign('product_name', $productDAO->name);
 912       $this->assign('price', $productDAO->price);
 913       $this->assign('sku', $productDAO->sku);
 914       $this->assign('option', $premiumParams['options_' . $premiumParams['selectProduct']] ?? NULL);
 915
 916       $periodType = $productDAO->period_type;
 917
 918       if ($periodType) {
 919         $fixed_period_start_day = $productDAO->fixed_period_start_day;
 920         $duration_unit = $productDAO->duration_unit;
 921         $duration_interval = $productDAO->duration_interval;
 922         if ($periodType === 'rolling') {
 923           $startDate = date('Y-m-d');
 924         }
 925         elseif ($periodType === 'fixed') {
 926           if ($fixed_period_start_day) {
 927             $date = explode('-', date('Y-m-d'));
 928             $month = substr($fixed_period_start_day, 0, strlen($fixed_period_start_day) - 2);
 929             $day = substr($fixed_period_start_day, -2) . "<br/>";
 930             $year = $date[0];
 931             $startDate = $year . '-' . $month . '-' . $day;
 932           }
 933           else {
 934             $startDate = date('Y-m-d');
 935           }
 936         }
 937
 938         $date = explode('-', $startDate);
 939         $year = $date[0];
 940         $month = $date[1];
 941         $day = $date[2];
 942
 943         switch ($duration_unit) {
 944           case 'year':
 945             $year += $duration_interval;
 946             break;
 947
 948           case 'month':
 949             $month += $duration_interval;
 950             break;
 951
 952           case 'day':
 953             $day += $duration_interval;
 954             break;
 955
 956           case 'week':
 957             $day += ($duration_interval * 7);
 958         }
 959         $endDate = date('Y-m-d H:i:s', mktime($hour, $minute, $second, $month, $day, $year));
 960         $this->assign('start_date', $startDate);
 961         $this->assign('end_date', $endDate);
 962       }
 963
 964       $dao = new CRM_Contribute_DAO_Premium();
 965       $dao->entity_table = 'civicrm_contribution_page';
 966       $dao->entity_id = $this->_id;
 967       $dao->find(TRUE);
 968       $this->assign('contact_phone', $dao->premiums_contact_phone);
 969       $this->assign('contact_email', $dao->premiums_contact_email);
 970
 971       //create Premium record
 972       $params = [
 973         'product_id' => $premiumParams['selectProduct'],
 974         'contribution_id' => $contribution->id,
 975         'product_option' => $premiumParams['options_' . $premiumParams['selectProduct']] ?? NULL,
 976         'quantity' => 1,
 977         'start_date' => CRM_Utils_Date::customFormat($startDate, '%Y%m%d'),
 978         'end_date' => CRM_Utils_Date::customFormat($endDate, '%Y%m%d'),
 979       ];
 980       if (!empty($premiumParams['selectProduct'])) {
 981         $daoPremiumsProduct = new CRM_Contribute_DAO_PremiumsProduct();
 982         $daoPremiumsProduct->product_id = $premiumParams['selectProduct'];
 983         $daoPremiumsProduct->premiums_id = $dao->id;
 984         $daoPremiumsProduct->find(TRUE);
 985         $params['financial_type_id'] = $daoPremiumsProduct->financial_type_id;
 986       }
 987       //Fixed For CRM-3901
 988       $daoContrProd = new CRM_Contribute_DAO_ContributionProduct();
 989       $daoContrProd->contribution_id = $contribution->id;
 990       if ($daoContrProd->find(TRUE)) {
 991         $params['id'] = $daoContrProd->id;
 992       }
 993
 994       CRM_Contribute_BAO_Contribution::addPremium($params);
 995       if ($productDAO->cost && !empty($params['financial_type_id'])) {
 996         $trxnParams = [
 997           'cost' => $productDAO->cost,
 998           'currency' => $productDAO->currency,
 999           'financial_type_id' => $params['financial_type_id'],
1000           'contributionId' => $contribution->id,
1001         ];
1002         CRM_Core_BAO_FinancialTrxn::createPremiumTrxn($trxnParams);
1003       }
1004     }
1005     elseif ($selectProduct === 'no_thanks') {
1006       //Fixed For CRM-3901
1007       $daoContrProd = new CRM_Contribute_DAO_ContributionProduct();
1008       $daoContrProd->contribution_id = $contribution->id;
1009       if ($daoContrProd->find(TRUE)) {
1010         $daoContrProd->delete();
1011       }
1012     }
1013   }
1014
1015   /**
1016    * Process the contribution.
1017    *
1018    * @param CRM_Core_Form $form
1019    * @param array $params
1020    * @param array $result
1021    * @param array $contributionParams
1022    *   Parameters to be passed to contribution create action.
1023    *   This differs from params in that we are currently adding params to it and 1) ensuring they are being
1024    *   passed consistently & 2) documenting them here.
1025    *   - contact_id
1026    *   - line_item
1027    *   - is_test
1028    *   - campaign_id
1029    *   - contribution_page_id
1030    *   - source
1031    *   - payment_type_id
1032    *   - thankyou_date (not all forms will set this)
1033    *
1034    * @param CRM_Financial_DAO_FinancialType $financialType
1035    * @param bool $online
1036    *   Is the form a front end form? If so set a bunch of unpredictable things that should be passed in from the form.
1037    *
1038    * @param int $billingLocationID
1039    *   ID of billing location type.
1040    * @param bool $isRecur
1041    *   Is this recurring?
1042    *
1043    * @return \CRM_Contribute_DAO_Contribution
1044    *
1045    * @throws \CRM_Core_Exception
1046    * @throws \CiviCRM_API3_Exception
1047    */
1048   public static function processFormContribution(
1049     &$form,
1050     $params,
1051     $result,
1052     $contributionParams,
1053     $financialType,
1054     $online,
1055     $billingLocationID,
1056     $isRecur
1057   ) {
1058     $transaction = new CRM_Core_Transaction();
1059     $contactID = $contributionParams['contact_id'];
1060
1061     $isEmailReceipt = !empty($form->_values['is_email_receipt']);
1062     $isSeparateMembershipPayment = !empty($params['separate_membership_payment']);
1063     $pledgeID = !empty($params['pledge_id']) ? $params['pledge_id'] : $form->_values['pledge_id'] ?? NULL;
1064     if (!$isSeparateMembershipPayment && !empty($form->_values['pledge_block_id']) &&
1065       (!empty($params['is_pledge']) || $pledgeID)) {
1066       $isPledge = TRUE;
1067     }
1068     else {
1069       $isPledge = FALSE;
1070     }
1071
1072     // add these values for the recurringContrib function ,CRM-10188
1073     $params['financial_type_id'] = $financialType->id;
1074
1075     $contributionParams['address_id'] = CRM_Contribute_BAO_Contribution::createAddress($params, $billingLocationID);
1076
1077     //@todo - this is being set from the form to resolve CRM-10188 - an
1078     // eNotice caused by it not being set @ the front end
1079     // however, we then get it being over-written with null for backend contributions
1080     // a better fix would be to set the values in the respective forms rather than require
1081     // a function being shared by two forms to deal with their respective values
1082     // moving it to the BAO & not taking the $form as a param would make sense here.
1083     if (!isset($params['is_email_receipt']) && $isEmailReceipt) {
1084       $params['is_email_receipt'] = $isEmailReceipt;
1085     }
1086     $params['is_recur'] = $isRecur;
1087     $params['payment_instrument_id'] = $contributionParams['payment_instrument_id'] ?? NULL;
1088     $recurringContributionID = self::processRecurringContribution($form, $params, $contactID, $financialType);
1089
1090     $now = date('YmdHis');
1091     $receiptDate = $params['receipt_date'] ?? NULL;
1092     if ($isEmailReceipt) {
1093       $receiptDate = $now;
1094     }
1095
1096     if (isset($params['amount'])) {
1097       $contributionParams = array_merge(self::getContributionParams(
1098         $params, $financialType->id,
1099         $result, $receiptDate,
1100         $recurringContributionID), $contributionParams
1101       );
1102       $contributionParams['non_deductible_amount'] = self::getNonDeductibleAmount($params, $financialType, $online, $form);
1103       $contributionParams['skipCleanMoney'] = TRUE;
1104       // @todo this is the wrong place for this - it should be done as close to form submission
1105       // as possible
1106       $contributionParams['total_amount'] = $params['amount'];
1107
1108       $contribution = CRM_Contribute_BAO_Contribution::add($contributionParams);
1109
1110       $invoiceSettings = Civi::settings()->get('contribution_invoice_settings');
1111       $invoicing = $invoiceSettings['invoicing'] ?? NULL;
1112       if ($invoicing) {
1113         $dataArray = [];
1114         // @todo - interrogate the line items passed in on the params array.
1115         // No reason to assume line items will be set on the form.
1116         foreach ($form->_lineItem as $lineItemKey => $lineItemValue) {
1117           foreach ($lineItemValue as $key => $value) {
1118             if (isset($value['tax_amount']) && isset($value['tax_rate'])) {
1119               if (isset($dataArray[$value['tax_rate']])) {
1120                 $dataArray[$value['tax_rate']] = $dataArray[$value['tax_rate']] + $value['tax_amount'];
1121               }
1122               else {
1123                 $dataArray[$value['tax_rate']] = $value['tax_amount'];
1124               }
1125             }
1126           }
1127         }
1128         $smarty = CRM_Core_Smarty::singleton();
1129         $smarty->assign('dataArray', $dataArray);
1130         $smarty->assign('totalTaxAmount', $params['tax_amount'] ?? NULL);
1131       }
1132
1133       // lets store it in the form variable so postProcess hook can get to this and use it
1134       $form->_contributionID = $contribution->id;
1135     }
1136
1137     // process soft credit / pcp params first
1138     CRM_Contribute_BAO_ContributionSoft::formatSoftCreditParams($params, $form);
1139
1140     //CRM-13981, processing honor contact into soft-credit contribution
1141     CRM_Contribute_BAO_ContributionSoft::processSoftContribution($params, $contribution);
1142
1143     if ($isPledge) {
1144       $form = self::handlePledge($form, $params, $contributionParams, $pledgeID, $contribution, $isEmailReceipt);
1145     }
1146
1147     if ($online && $contribution) {
1148       CRM_Core_BAO_CustomValueTable::postProcess($params,
1149         'civicrm_contribution',
1150         $contribution->id,
1151         'Contribution'
1152       );
1153     }
1154     elseif ($contribution) {
1155       //handle custom data.
1156       $params['contribution_id'] = $contribution->id;
1157       if (!empty($params['custom']) &&
1158         is_array($params['custom'])
1159       ) {
1160         CRM_Core_BAO_CustomValueTable::store($params['custom'], 'civicrm_contribution', $contribution->id);
1161       }
1162     }
1163     // Save note
1164     if ($contribution && !empty($params['contribution_note'])) {
1165       $noteParams = [
1166         'entity_table' => 'civicrm_contribution',
1167         'note' => $params['contribution_note'],
1168         'entity_id' => $contribution->id,
1169         'contact_id' => $contribution->contact_id,
1170       ];
1171
1172       CRM_Core_BAO_Note::add($noteParams, []);
1173     }
1174
1175     //create contribution activity w/ individual and target
1176     //activity w/ organisation contact id when onbelf, CRM-4027
1177     $actParams = [];
1178     $targetContactID = NULL;
1179     if (!empty($params['onbehalf_contact_id'])) {
1180       $actParams = [
1181         'source_contact_id' => $params['onbehalf_contact_id'],
1182         'on_behalf' => TRUE,
1183       ];
1184       $targetContactID = $contribution->contact_id;
1185     }
1186
1187     // create an activity record
1188     if ($contribution) {
1189       CRM_Activity_BAO_Activity::addActivity($contribution, 'Contribution', $targetContactID, $actParams);
1190     }
1191
1192     $transaction->commit();
1193     return $contribution;
1194   }
1195
1196   /**
1197    * Create the recurring contribution record.
1198    *
1199    * @param CRM_Core_Form $form
1200    * @param array $params
1201    * @param int $contactID
1202    * @param string $contributionType
1203    *
1204    * @return int|null
1205    */
1206   public static function processRecurringContribution(&$form, &$params, $contactID, $contributionType) {
1207
1208     if (empty($params['is_recur'])) {
1209       return NULL;
1210     }
1211
1212     $recurParams = ['contact_id' => $contactID];
1213     $recurParams['amount'] = $params['amount'] ?? NULL;
1214     $recurParams['auto_renew'] = $params['auto_renew'] ?? NULL;
1215     $recurParams['frequency_unit'] = $params['frequency_unit'] ?? NULL;
1216     $recurParams['frequency_interval'] = $params['frequency_interval'] ?? NULL;
1217     $recurParams['installments'] = $params['installments'] ?? NULL;
1218     $recurParams['financial_type_id'] = $params['financial_type_id'] ?? NULL;
1219     $recurParams['currency'] = $params['currency'] ?? NULL;
1220     $recurParams['payment_instrument_id'] = $params['payment_instrument_id'];
1221
1222     // CRM-14354: For an auto-renewing membership with an additional contribution,
1223     // if separate payments is not enabled, make sure only the membership fee recurs
1224     if (!empty($form->_membershipBlock)
1225       && $form->_membershipBlock['is_separate_payment'] === '0'
1226       && isset($params['selectMembership'])
1227       && $form->_values['is_allow_other_amount'] == '1'
1228       // CRM-16331
1229       && !empty($form->_membershipTypeValues)
1230       && !empty($form->_membershipTypeValues[$params['selectMembership']]['minimum_fee'])
1231     ) {
1232       $recurParams['amount'] = $form->_membershipTypeValues[$params['selectMembership']]['minimum_fee'];
1233     }
1234
1235     $recurParams['is_test'] = 0;
1236     if (($form->_action & CRM_Core_Action::PREVIEW) ||
1237       (isset($form->_mode) && ($form->_mode == 'test'))
1238     ) {
1239       $recurParams['is_test'] = 1;
1240     }
1241
1242     $recurParams['start_date'] = $recurParams['create_date'] = $recurParams['modified_date'] = date('YmdHis');
1243     if (!empty($params['receive_date'])) {
1244       $recurParams['start_date'] = date('YmdHis', strtotime($params['receive_date']));
1245     }
1246     $recurParams['invoice_id'] = $params['invoiceID'] ?? NULL;
1247     $recurParams['contribution_status_id'] = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
1248     $recurParams['payment_processor_id'] = $params['payment_processor_id'] ?? NULL;
1249     $recurParams['is_email_receipt'] = (bool) ($params['is_email_receipt'] ?? FALSE);
1250     // we need to add a unique trxn_id to avoid a unique key error
1251     // in paypal IPN we reset this when paypal sends us the real trxn id, CRM-2991
1252     $recurParams['trxn_id'] = $params['trxn_id'] ?? $params['invoiceID'];
1253     $recurParams['financial_type_id'] = $contributionType->id;
1254
1255     $campaignId = $params['campaign_id'] ?? $form->_values['campaign_id'] ?? NULL;
1256     $recurParams['campaign_id'] = $campaignId;
1257     $recurring = CRM_Contribute_BAO_ContributionRecur::add($recurParams);
1258     if (is_a($recurring, 'CRM_Core_Error')) {
1259       CRM_Core_Error::displaySessionError($recurring);
1260       $urlString = 'civicrm/contribute/transact';
1261       $urlParams = '_qf_Main_display=true';
1262       if (get_class($form) == 'CRM_Contribute_Form_Contribution') {
1263         $urlString = 'civicrm/contact/view/contribution';
1264         $urlParams = "action=add&cid={$form->_contactID}";
1265         if ($form->_mode) {
1266           $urlParams .= "&mode={$form->_mode}";
1267         }
1268       }
1269       CRM_Utils_System::redirect(CRM_Utils_System::url($urlString, $urlParams));
1270     }
1271     $form->_params['contributionRecurID'] = $recurring->id;
1272
1273     return $recurring->id;
1274   }
1275
1276   /**
1277    * Add on behalf of organization and it's location.
1278    *
1279    * This situation occurs when on behalf of is enabled for the contribution page and the person
1280    * signing up does so on behalf of an organization.
1281    *
1282    * @param array $behalfOrganization
1283    *   array of organization info.
1284    * @param int $contactID
1285    *   individual contact id. One.
1286    *   who is doing the process of signup / contribution.
1287    *
1288    * @param array $values
1289    *   form values array.
1290    * @param array $params
1291    * @param array $fields
1292    *   Array of fields from the onbehalf profile relevant to the organization.
1293    */
1294   public static function processOnBehalfOrganization(&$behalfOrganization, &$contactID, &$values, &$params, $fields = NULL) {
1295     $isNotCurrentEmployer = FALSE;
1296     $dupeIDs = [];
1297     $orgID = NULL;
1298     if (!empty($behalfOrganization['organization_id'])) {
1299       $orgID = $behalfOrganization['organization_id'];
1300       unset($behalfOrganization['organization_id']);
1301     }
1302     // create employer relationship with $contactID only when new organization is there
1303     // else retain the existing relationship
1304     else {
1305       $isNotCurrentEmployer = TRUE;
1306     }
1307
1308     if (!$orgID) {
1309       // check if matching organization contact exists
1310       $dupeIDs = CRM_Contact_BAO_Contact::getDuplicateContacts($behalfOrganization, 'Organization', 'Unsupervised', [], FALSE);
1311
1312       // CRM-6243 says to pick the first org even if more than one match
1313       if (count($dupeIDs) >= 1) {
1314         $behalfOrganization['contact_id'] = $orgID = $dupeIDs[0];
1315         // don't allow name edit
1316         unset($behalfOrganization['organization_name']);
1317       }
1318     }
1319     else {
1320       // if found permissioned related organization, allow location edit
1321       $behalfOrganization['contact_id'] = $orgID;
1322       // don't allow name edit
1323       unset($behalfOrganization['organization_name']);
1324     }
1325
1326     // handling for image url
1327     if (!empty($behalfOrganization['image_URL'])) {
1328       CRM_Contact_BAO_Contact::processImageParams($behalfOrganization);
1329     }
1330
1331     // create organization, add location
1332     $behalfOrganization['contact_type'] = 'Organization';
1333     $orgID = CRM_Contact_BAO_Contact::createProfileContact($behalfOrganization, $fields, $orgID,
1334       NULL, NULL, 'Organization'
1335     );
1336     // create relationship
1337     if ($isNotCurrentEmployer) {
1338       try {
1339         \Civi\Api4\Relationship::create(FALSE)
1340           ->addValue('contact_id_a', $contactID)
1341           ->addValue('contact_id_b', $orgID)
1342           ->addValue('relationship_type_id', CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_RelationshipType', 'Employee of', 'id', 'name_a_b'))
1343           ->addValue('is_permission_a_b:name', 'View and update')
1344           ->execute();
1345       }
1346       catch (CRM_Core_Exception $e) {
1347         // Ignore if duplicate relationship.
1348         if ($e->getMessage() !== 'Duplicate Relationship') {
1349           throw $e;
1350         }
1351       }
1352     }
1353
1354     // if multiple match - send a duplicate alert
1355     if ($dupeIDs && (count($dupeIDs) > 1)) {
1356       $values['onbehalf_dupe_alert'] = 1;
1357       // required for IPN
1358       $params['onbehalf_dupe_alert'] = 1;
1359     }
1360
1361     // make sure organization-contact-id is considered for recording
1362     // contribution/membership etc..
1363     if ($contactID != $orgID) {
1364       // take a note of contact-id, so we can send the
1365       // receipt to individual contact as well.
1366
1367       // required for mailing/template display ..etc
1368       $values['related_contact'] = $contactID;
1369
1370       //CRM-19172: Create CMS user for individual on whose behalf organization is doing contribution
1371       $params['onbehalf_contact_id'] = $contactID;
1372
1373       //make this employee of relationship as current
1374       //employer / employee relationship,  CRM-3532
1375       if ($isNotCurrentEmployer &&
1376         ($orgID != CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contactID, 'employer_id'))
1377       ) {
1378         $isNotCurrentEmployer = FALSE;
1379       }
1380
1381       if (!$isNotCurrentEmployer && $orgID) {
1382         //build current employer params
1383         $currentEmpParams[$contactID] = $orgID;
1384         CRM_Contact_BAO_Contact_Utils::setCurrentEmployer($currentEmpParams);
1385       }
1386
1387       // contribution / signup will be done using this
1388       // organization id.
1389       $contactID = $orgID;
1390     }
1391   }
1392
1393   /**
1394    * Function used to send notification mail to pcp owner.
1395    *
1396    * This is used by contribution and also event PCPs.
1397    *
1398    * @param object $contribution
1399    * @param array $contributionSoft
1400    *   Contribution object.
1401    *
1402    * @throws \API_Exception
1403    * @throws \CRM_Core_Exception
1404    */
1405   public static function pcpNotifyOwner($contribution, array $contributionSoft) {
1406     $params = ['id' => $contributionSoft['pcp_id']];
1407     CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $params, $pcpInfo);
1408     $ownerNotifyID = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCPBlock', $pcpInfo['pcp_block_id'], 'owner_notify_id');
1409     $ownerNotifyOption = CRM_Core_PseudoConstant::getName('CRM_PCP_DAO_PCPBlock', 'owner_notify_id', $ownerNotifyID);
1410
1411     if ($ownerNotifyOption != 'no_notifications' &&
1412         (($ownerNotifyOption == 'owner_chooses' &&
1413         CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP', $contributionSoft['pcp_id'], 'is_notify')) ||
1414         $ownerNotifyOption == 'all_owners')) {
1415       $pcpInfoURL = CRM_Utils_System::url('civicrm/pcp/info',
1416         "reset=1&id={$contributionSoft['pcp_id']}",
1417         TRUE, NULL, FALSE, TRUE
1418       );
1419       // set email in the template here
1420
1421       if (CRM_Core_BAO_LocationType::getBilling()) {
1422         [$donorName, $email] = CRM_Contact_BAO_Contact_Location::getEmailDetails($contribution->contact_id,
1423           FALSE, CRM_Core_BAO_LocationType::getBilling());
1424       }
1425       // get primary location email if no email exist( for billing location).
1426       if (!$email) {
1427         [$donorName, $email] = CRM_Contact_BAO_Contact_Location::getEmailDetails($contribution->contact_id);
1428       }
1429       [$ownerName, $ownerEmail] = CRM_Contact_BAO_Contact_Location::getEmailDetails($contributionSoft['contact_id']);
1430       $tplParams = [
1431         'page_title' => $pcpInfo['title'],
1432         'receive_date' => $contribution->receive_date,
1433         'total_amount' => $contributionSoft['amount'],
1434         'donors_display_name' => $donorName,
1435         'donors_email' => $email,
1436         'pcpInfoURL' => $pcpInfoURL,
1437         'is_honor_roll_enabled' => $contributionSoft['pcp_display_in_roll'],
1438         'currency' => $contributionSoft['currency'],
1439       ];
1440       $domainValues = CRM_Core_BAO_Domain::getNameAndEmail();
1441       $sendTemplateParams = [
1442         'groupName' => 'msg_tpl_workflow_contribution',
1443         'valueName' => 'pcp_owner_notify',
1444         'contactId' => $contributionSoft['contact_id'],
1445         'toEmail' => $ownerEmail,
1446         'toName' => $ownerName,
1447         'from' => "$domainValues[0] <$domainValues[1]>",
1448         'tplParams' => $tplParams,
1449         'PDFFilename' => 'receipt.pdf',
1450       ];
1451       CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
1452     }
1453   }
1454
1455   /**
1456    * Function used to se pcp related defaults / params.
1457    *
1458    * This is used by contribution and also event PCPs
1459    *
1460    * @param CRM_Core_Form $page
1461    *   Form object.
1462    * @param array $params
1463    *
1464    * @return array
1465    */
1466   public static function processPcp(&$page, $params): array {
1467     $params['pcp_made_through_id'] = $page->_pcpId;
1468     $page->assign('pcpBlock', TRUE);
1469     if (!empty($params['pcp_display_in_roll']) && empty($params['pcp_roll_nickname'])) {
1470       $params['pcp_roll_nickname'] = ts('Anonymous');
1471       $params['pcp_is_anonymous'] = 1;
1472     }
1473     else {
1474       $params['pcp_is_anonymous'] = 0;
1475     }
1476     foreach ([
1477       'pcp_display_in_roll',
1478       'pcp_is_anonymous',
1479       'pcp_roll_nickname',
1480       'pcp_personal_note',
1481     ] as $val) {
1482       if (!empty($params[$val])) {
1483         $page->assign($val, $params[$val]);
1484       }
1485     }
1486
1487     return $params;
1488   }
1489
1490   /**
1491    * Process membership.
1492    *
1493    * @param array $membershipParams
1494    * @param int $contactID
1495    * @param array $customFieldsFormatted
1496    * @param array $fieldTypes
1497    * @param array $premiumParams
1498    * @param array $membershipLineItems
1499    *   Line items specifically relating to memberships.
1500    */
1501   protected function processMembership($membershipParams, $contactID, $customFieldsFormatted, $fieldTypes, $premiumParams,
1502                                 $membershipLineItems): void {
1503
1504     $membershipTypeIDs = (array) $membershipParams['selectMembership'];
1505     $membershipTypes = CRM_Member_BAO_Membership::buildMembershipTypeValues($this, $membershipTypeIDs);
1506     $membershipType = empty($membershipTypes) ? [] : reset($membershipTypes);
1507
1508     $this->assign('membership_name', $membershipType['name']);
1509     $this->_values['membership_name'] = $membershipType['name'] ?? NULL;
1510
1511     $isPaidMembership = FALSE;
1512     if ($this->_amount >= 0.0 && isset($membershipParams['amount'])) {
1513       //amount must be greater than zero for
1514       //adding contribution record  to contribution table.
1515       //this condition arises when separate membership payment is
1516       //enabled and contribution amount is not selected. fix for CRM-3010
1517       $isPaidMembership = TRUE;
1518     }
1519     $isProcessSeparateMembershipTransaction = $this->isSeparateMembershipTransaction($this->_id, $this->_values['amount_block_is_active']);
1520
1521     if ($this->_values['amount_block_is_active']) {
1522       $financialTypeID = $this->_values['financial_type_id'];
1523     }
1524     else {
1525       $financialTypeID = $membershipType['financial_type_id'] ?? $membershipParams['financial_type_id'] ?? NULL;
1526     }
1527
1528     if (!empty($this->_params['membership_source'])) {
1529       $membershipParams['contribution_source'] = $this->_params['membership_source'];
1530     }
1531
1532     $this->postProcessMembership($membershipParams, $contactID,
1533       $this, $premiumParams, $customFieldsFormatted, $fieldTypes, $membershipType, $membershipTypeIDs, $isPaidMembership, $this->_membershipId, $isProcessSeparateMembershipTransaction, $financialTypeID,
1534       $membershipLineItems);
1535
1536     $this->assign('membership_assign', TRUE);
1537     $this->set('membershipTypeID', $membershipParams['selectMembership']);
1538   }
1539
1540   /**
1541    * Process the Memberships.
1542    *
1543    * @param array $membershipParams
1544    *   Array of membership fields.
1545    * @param int $contactID
1546    *   Contact id.
1547    * @param CRM_Contribute_Form_Contribution_Confirm $form
1548    *   Confirmation form object.
1549    *
1550    * @param array $premiumParams
1551    * @param null $customFieldsFormatted
1552    * @param null $includeFieldTypes
1553    *
1554    * @param array $membershipDetails
1555    *
1556    * @param array $membershipTypeIDs
1557    *
1558    * @param bool $isPaidMembership
1559    * @param array $membershipID
1560    *
1561    * @param bool $isProcessSeparateMembershipTransaction
1562    *
1563    * @param int $financialTypeID
1564    * @param array $unprocessedLineItems
1565    *   Line items for payment options chosen on the form.
1566    *
1567    * @throws \CRM_Core_Exception
1568    * @throws \CiviCRM_API3_Exception
1569    * @throws \Civi\Payment\Exception\PaymentProcessorException
1570    */
1571   protected function postProcessMembership(
1572     $membershipParams, $contactID, &$form, $premiumParams,
1573     $customFieldsFormatted = NULL, $includeFieldTypes = NULL, $membershipDetails, $membershipTypeIDs, $isPaidMembership, $membershipID,
1574     $isProcessSeparateMembershipTransaction, $financialTypeID, $unprocessedLineItems) {
1575
1576     $membershipContribution = NULL;
1577     $isTest = $membershipParams['is_test'] ?? FALSE;
1578     $errors = $paymentResults = [];
1579     $form->_values['isMembership'] = TRUE;
1580     $isRecurForFirstTransaction = $form->_params['is_recur'] ?? $membershipParams['is_recur'] ?? NULL;
1581
1582     $totalAmount = $membershipParams['amount'];
1583
1584     if ($isPaidMembership) {
1585       if ($isProcessSeparateMembershipTransaction) {
1586         // If we have 2 transactions only one can use the invoice id.
1587         $membershipParams['invoiceID'] .= '-2';
1588         if (!empty($membershipParams['auto_renew'])) {
1589           $isRecurForFirstTransaction = FALSE;
1590         }
1591       }
1592
1593       if (!$isProcessSeparateMembershipTransaction) {
1594         // Skip line items in the contribution processing transaction.
1595         // We will create them with the membership for proper linking.
1596         $membershipParams['skipLineItem'] = 1;
1597       }
1598       else {
1599         $membershipParams['total_amount'] = $totalAmount;
1600         $membershipParams['skipLineItem'] = 0;
1601         CRM_Price_BAO_LineItem::getLineItemArray($membershipParams);
1602
1603       }
1604       $paymentResult = $form->processConfirm(
1605         $membershipParams,
1606         $contactID,
1607         $financialTypeID,
1608         $isTest,
1609         $isRecurForFirstTransaction
1610       );
1611       if (!empty($paymentResult['contribution'])) {
1612         $paymentResults[] = ['contribution_id' => $paymentResult['contribution']->id, 'result' => $paymentResult];
1613         $this->postProcessPremium($premiumParams, $paymentResult['contribution']);
1614         //note that this will be over-written if we are using a separate membership transaction. Otherwise there is only one
1615         $membershipContribution = $paymentResult['contribution'];
1616         // Save the contribution ID so that I can be used in email receipts
1617         // For example, if you need to generate a tax receipt for the donation only.
1618         $form->_values['contribution_other_id'] = $membershipContribution->id;
1619       }
1620     }
1621
1622     if ($isProcessSeparateMembershipTransaction) {
1623       try {
1624         $form->_lineItem = $unprocessedLineItems;
1625         if (empty($form->_params['auto_renew']) && !empty($membershipParams['is_recur'])) {
1626           unset($membershipParams['is_recur']);
1627         }
1628         [$membershipContribution, $secondPaymentResult] = $this->processSecondaryFinancialTransaction($contactID, $form, array_merge($membershipParams, ['skipLineItem' => 1]),
1629           $isTest, $unprocessedLineItems, $membershipDetails['minimum_fee'] ?? 0, $membershipDetails['financial_type_id'] ?? NULL);
1630         $paymentResults[] = ['contribution_id' => $membershipContribution->id, 'result' => $secondPaymentResult];
1631         $totalAmount = $membershipContribution->total_amount;
1632       }
1633       catch (CRM_Core_Exception $e) {
1634         $errors[2] = $e->getMessage();
1635         $membershipContribution = NULL;
1636       }
1637     }
1638
1639     $membership = NULL;
1640     if (!empty($membershipContribution) && !is_a($membershipContribution, 'CRM_Core_Error')) {
1641       $membershipContributionID = $membershipContribution->id;
1642     }
1643
1644     //@todo - why is this nested so deep? it seems like it could be just set on the calling function on the form layer
1645     if (isset($membershipParams['onbehalf']) && !empty($membershipParams['onbehalf']['member_campaign_id'])) {
1646       $form->_params['campaign_id'] = $membershipParams['onbehalf']['member_campaign_id'];
1647     }
1648     //@todo it should no longer be possible for it to get to this point & membership to not be an array
1649     if (is_array($membershipTypeIDs) && !empty($membershipContributionID)) {
1650       $typesTerms = $membershipParams['types_terms'] ?? [];
1651
1652       $membershipLines = $nonMembershipLines = [];
1653       foreach ($unprocessedLineItems as $priceSetID => $lines) {
1654         foreach ($lines as $line) {
1655           if (!empty($line['membership_type_id'])) {
1656             $membershipLines[$line['membership_type_id']] = $line['price_field_value_id'];
1657           }
1658         }
1659       }
1660
1661       $i = 1;
1662       $form->_params['createdMembershipIDs'] = [];
1663       foreach ($membershipTypeIDs as $memType) {
1664         $membershipLineItems = [];
1665         if ($i < count($membershipTypeIDs)) {
1666           $membershipLineItems[$priceSetID][$membershipLines[$memType]] = $unprocessedLineItems[$priceSetID][$membershipLines[$memType]];
1667           unset($unprocessedLineItems[$priceSetID][$membershipLines[$memType]]);
1668         }
1669         else {
1670           $membershipLineItems = $unprocessedLineItems;
1671         }
1672         $i++;
1673         $numTerms = $typesTerms[$memType] ?? 1;
1674         $contributionRecurID = $form->_params['contributionRecurID'] ?? NULL;
1675
1676         $membershipSource = NULL;
1677         if (!empty($form->_params['membership_source'])) {
1678           $membershipSource = $form->_params['membership_source'];
1679         }
1680         elseif ((isset($form->_values['title']) && !empty($form->_values['title'])) || (isset($form->_values['frontend_title']) && !empty($form->_values['frontend_title']))) {
1681           $title = !empty($form->_values['frontend_title']) ? $form->_values['frontend_title'] : $form->_values['title'];
1682           $membershipSource = ts('Online Contribution:') . ' ' . $title;
1683         }
1684         $isPayLater = NULL;
1685         if (isset($form->_params)) {
1686           $isPayLater = $form->_params['is_pay_later'] ?? NULL;
1687         }
1688         $memParams = [
1689           'campaign_id' => $form->_params['campaign_id'] ?? ($form->_values['campaign_id'] ?? NULL),
1690         ];
1691
1692         // @todo Move this into CRM_Member_BAO_Membership::processMembership
1693         if (!empty($membershipContribution)) {
1694           $pending = $membershipContribution->contribution_status_id == CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending');
1695         }
1696         else {
1697           // The concept of contributeMode is deprecated.
1698           // the is_monetary concept probably should be too as it can be calculated from
1699           // the existence of 'amount' & seems fragile.
1700           if (((isset($this->_contributeMode)) || !empty($this->_params['is_pay_later'])
1701             ) &&
1702             (($this->_values['is_monetary'] && $this->_amount > 0.0))
1703           ) {
1704             $pending = TRUE;
1705           }
1706           $pending = FALSE;
1707         }
1708
1709         [$membership, $renewalMode, $dates] = CRM_Member_BAO_Membership::processMembership(
1710           $contactID, $memType, $isTest,
1711           date('YmdHis'), $membershipParams['cms_contactID'] ?? NULL,
1712           $customFieldsFormatted,
1713           $numTerms, $membershipID, $pending,
1714           $contributionRecurID, $membershipSource, $isPayLater, $memParams, [], $membershipContribution,
1715           $membershipLineItems
1716         );
1717
1718         $form->set('renewal_mode', $renewalMode);
1719         if (!empty($dates)) {
1720           $form->assign('mem_start_date', CRM_Utils_Date::customFormat($dates['start_date'], '%Y%m%d'));
1721           $form->assign('mem_end_date', CRM_Utils_Date::customFormat($dates['end_date'], '%Y%m%d'));
1722         }
1723
1724         if (!empty($membershipContribution)) {
1725           // Next line is probably redundant. Checks prevent it happening twice.
1726           $membershipPaymentParams = [
1727             'membership_id' => $membership->id,
1728             'membership_type_id' => $membership->membership_type_id,
1729             'contribution_id' => $membershipContribution->id,
1730           ];
1731           civicrm_api3('MembershipPayment', 'create', $membershipPaymentParams);
1732         }
1733         if ($membership) {
1734           CRM_Core_BAO_CustomValueTable::postProcess($form->_params, 'civicrm_membership', $membership->id, 'Membership');
1735           $form->_params['createdMembershipIDs'][] = $membership->id;
1736           $form->_params['membershipID'] = $membership->id;
1737
1738           //CRM-15232: Check if membership is created and on the basis of it use
1739           //membership receipt template to send payment receipt
1740           $form->_values['isMembership'] = TRUE;
1741         }
1742       }
1743       if ($form->_priceSetId && !empty($form->_useForMember) && !empty($form->_lineItem)) {
1744         foreach ($form->_lineItem[$form->_priceSetId] as & $priceFieldOp) {
1745           if (!empty($priceFieldOp['membership_type_id']) && $membership->membership_type_id == $priceFieldOp['membership_type_id']) {
1746             $membershipOb = $membership;
1747             $priceFieldOp['start_date'] = $membershipOb->start_date ? CRM_Utils_Date::formatDateOnlyLong($membershipOb->start_date) : '-';
1748             $priceFieldOp['end_date'] = $membershipOb->end_date ? CRM_Utils_Date::formatDateOnlyLong($membershipOb->end_date) : '-';
1749           }
1750           else {
1751             $priceFieldOp['start_date'] = $priceFieldOp['end_date'] = 'N/A';
1752           }
1753         }
1754         $form->_values['lineItem'] = $form->_lineItem;
1755         $form->assign('lineItem', $form->_lineItem);
1756       }
1757     }
1758
1759     if (!empty($errors)) {
1760       $message = $this->compileErrorMessage($errors);
1761       throw new CRM_Core_Exception($message);
1762     }
1763
1764     if (isset($membershipContributionID)) {
1765       $form->_values['contribution_id'] = $membershipContributionID;
1766     }
1767
1768     if (empty($form->_params['is_pay_later']) && $form->_paymentProcessor) {
1769       // the is_monetary concept probably should be deprecated as it can be calculated from
1770       // the existence of 'amount' & seems fragile.
1771       if ($form->_values['is_monetary'] && $form->_amount > 0.0 && !$form->_params['is_pay_later']) {
1772         // call postProcess hook before leaving
1773         $form->postProcessHook();
1774       }
1775
1776       $payment = Civi\Payment\System::singleton()->getByProcessor($form->_paymentProcessor);
1777       // The contribution_other_id is effectively the ID for the only contribution or the non-membership contribution.
1778       // Since we have called the membership contribution (in a 2 contribution scenario) this is out
1779       // primary-contribution compared to that - but let's face it - it's all just too hard & confusing at the moment!
1780       $paymentParams = array_merge($form->_params, ['contributionID' => $form->_values['contribution_other_id']]);
1781
1782       // CRM-19792 : set necessary fields for payment processor
1783       CRM_Core_Payment_Form::mapParams($form->_bltID, $paymentParams, $paymentParams, TRUE);
1784
1785       // If this is a single membership-related contribution, it won't have
1786       // be performed yet, so do it now.
1787       if ($isPaidMembership && !$isProcessSeparateMembershipTransaction) {
1788         $paymentActionResult = $payment->doPayment($paymentParams, 'contribute');
1789         $paymentResults[] = ['contribution_id' => $paymentResult['contribution']->id, 'result' => $paymentActionResult];
1790       }
1791       // Do not send an email if Recurring transaction is done via Direct Mode
1792       // Email will we sent when the IPN is received.
1793       foreach ($paymentResults as $result) {
1794         //CRM-18211: Fix situation where second contribution doesn't exist because it is optional.
1795         if ($result['contribution_id']) {
1796           $this->completeTransaction($result['result'], $result['contribution_id']);
1797         }
1798       }
1799       return;
1800     }
1801
1802     $emailValues = array_merge($membershipParams, $form->_values);
1803     $emailValues['membership_assign'] = 1;
1804     $emailValues['useForMember'] = !empty($form->_useForMember);
1805
1806     // Finally send an email receipt for pay-later scenario (although it might sometimes be caught above!)
1807     if ($totalAmount == 0) {
1808       // This feels like a bizarre hack as the variable name doesn't seem to be directly connected to it's use in the template.
1809       $emailValues['useForMember'] = 0;
1810       $emailValues['amount'] = 0;
1811
1812       //CRM-18071, where on selecting $0 free membership payment section got hidden and
1813       // also it reset any payment processor selection result into pending free membership
1814       // so its a kind of hack to complete free membership at this point since there is no $form->_paymentProcessor info
1815       if (!empty($membershipContribution) && !is_a($membershipContribution, 'CRM_Core_Error')) {
1816         if (empty($form->_paymentProcessor)) {
1817           // @todo this can maybe go now we are setting payment_processor_id = 0 more reliably.
1818           $paymentProcessorIDs = explode(CRM_Core_DAO::VALUE_SEPARATOR, $this->_values['payment_processor'] ?? NULL);
1819           $this->_paymentProcessor['id'] = $paymentProcessorIDs[0];
1820         }
1821         $result = ['payment_status_id' => 1, 'contribution' => $membershipContribution];
1822         $this->completeTransaction($result, $result['contribution']->id);
1823       }
1824       // return as completeTransaction() already sends the receipt mail.
1825       return;
1826     }
1827
1828     CRM_Contribute_BAO_ContributionPage::sendMail($contactID,
1829       $emailValues,
1830       $isTest, FALSE,
1831       $includeFieldTypes
1832     );
1833   }
1834
1835   /**
1836    * Turn array of errors into message string.
1837    *
1838    * @param array $errors
1839    *
1840    * @return string
1841    */
1842   protected function compileErrorMessage($errors) {
1843     foreach ($errors as $error) {
1844       if (is_string($error)) {
1845         $message[] = $error;
1846       }
1847     }
1848     return ts('Payment Processor Error message') . ': ' . implode('<br/>', $message);
1849   }
1850
1851   /**
1852    * Where a second separate financial transaction is supported we will process it here.
1853    *
1854    * @param int $contactID
1855    * @param CRM_Contribute_Form_Contribution_Confirm $form
1856    * @param array $tempParams
1857    * @param bool $isTest
1858    * @param array $lineItems
1859    * @param $minimumFee
1860    * @param int $financialTypeID
1861    *
1862    * @throws CRM_Core_Exception
1863    * @throws Exception
1864    * @return CRM_Contribute_BAO_Contribution
1865    */
1866   protected function processSecondaryFinancialTransaction($contactID, &$form, $tempParams, $isTest, $lineItems, $minimumFee,
1867                                                    $financialTypeID) {
1868     $financialType = new CRM_Financial_DAO_FinancialType();
1869     $financialType->id = $financialTypeID;
1870     $financialType->find(TRUE);
1871     $tempParams['amount'] = $minimumFee;
1872     $tempParams['invoiceID'] = md5(uniqid(rand(), TRUE));
1873     $isRecur = $tempParams['is_recur'] ?? NULL;
1874
1875     //assign receive date when separate membership payment
1876     //and contribution amount not selected.
1877     if ($form->_amount == 0) {
1878       $now = date('YmdHis');
1879       $form->_params['receive_date'] = $now;
1880       $receiveDate = CRM_Utils_Date::mysqlToIso($now);
1881       $form->set('params', $form->_params);
1882       $form->assign('receive_date', $receiveDate);
1883     }
1884
1885     $form->set('membership_amount', $minimumFee);
1886     $form->assign('membership_amount', $minimumFee);
1887
1888     //set this variable as we are not creating pledge for
1889     //separate membership payment contribution.
1890     //so for differentiating membership contribution from
1891     //main contribution.
1892     $form->_params['separate_membership_payment'] = 1;
1893     $contributionParams = [
1894       'contact_id' => $contactID,
1895       'line_item' => $lineItems,
1896       'is_test' => $isTest,
1897       'campaign_id' => $tempParams['campaign_id'] ?? $form->_values['campaign_id'] ?? NULL,
1898       'contribution_page_id' => $form->_id,
1899       'source' => $tempParams['source'] ?? $tempParams['description'] ?? NULL,
1900     ];
1901     $isMonetary = !empty($form->_values['is_monetary']);
1902     if ($isMonetary) {
1903       if (empty($paymentParams['is_pay_later'])) {
1904         $contributionParams['payment_instrument_id'] = $form->_paymentProcessor['payment_instrument_id'];
1905       }
1906     }
1907
1908     // CRM-19792 : set necessary fields for payment processor
1909     CRM_Core_Payment_Form::mapParams($form->_bltID, $form->_params, $tempParams, TRUE);
1910
1911     $membershipContribution = CRM_Contribute_Form_Contribution_Confirm::processFormContribution($form,
1912       $tempParams,
1913       $tempParams,
1914       $contributionParams,
1915       $financialType,
1916       TRUE,
1917       $form->_bltID,
1918       $isRecur
1919     );
1920
1921     $result = [];
1922
1923     // We're not processing the line item here because we are processing a membership.
1924     // To ensure processing of the correct parameters, replace relevant parameters
1925     // in $tempParams with those in $membershipContribution.
1926     $tempParams['amount_level'] = $membershipContribution->amount_level;
1927     $tempParams['total_amount'] = $membershipContribution->total_amount;
1928     $tempParams['tax_amount'] = $membershipContribution->tax_amount;
1929     $tempParams['contactID'] = $membershipContribution->contact_id;
1930     $tempParams['financialTypeID'] = $membershipContribution->financial_type_id;
1931     $tempParams['invoiceID'] = $membershipContribution->invoice_id;
1932     $tempParams['trxn_id'] = $membershipContribution->trxn_id;
1933     $tempParams['contributionID'] = $membershipContribution->id;
1934
1935     if ($form->_values['is_monetary'] && !$form->_params['is_pay_later'] && $minimumFee > 0.0) {
1936       // At the moment our tests are calling this form in a way that leaves 'object' empty. For
1937       // now we compensate here.
1938       if (empty($form->_paymentProcessor['object'])) {
1939         $payment = Civi\Payment\System::singleton()->getByProcessor($this->_paymentProcessor);
1940       }
1941       else {
1942         $payment = $form->_paymentProcessor['object'];
1943       }
1944       $result = $payment->doPayment($tempParams, 'contribute');
1945       $form->set('membership_trx_id', $result['trxn_id']);
1946       $form->assign('membership_trx_id', $result['trxn_id']);
1947     }
1948
1949     return [$membershipContribution, $result];
1950   }
1951
1952   /**
1953    * Are we going to do 2 financial transactions.
1954    *
1955    * Ie the membership block supports a separate transactions AND the contribution form has been configured for a
1956    * contribution
1957    * transaction AND a membership transaction AND the payment processor supports double financial transactions (ie. NOT doTransferCheckout style)
1958    *
1959    * @param int $formID
1960    * @param bool $amountBlockActiveOnForm
1961    *
1962    * @return bool
1963    */
1964   public function isSeparateMembershipTransaction($formID, $amountBlockActiveOnForm) {
1965     $memBlockDetails = CRM_Member_BAO_Membership::getMembershipBlock($formID);
1966     if (!empty($memBlockDetails['is_separate_payment']) && $amountBlockActiveOnForm) {
1967       return TRUE;
1968     }
1969     return FALSE;
1970   }
1971
1972   /**
1973    * This function sets the fields.
1974    *
1975    * - $this->_params['amount_level']
1976    * - $this->_params['selectMembership']
1977    * And under certain circumstances sets
1978    * $this->_params['amount'] = null;
1979    *
1980    * @param int $priceSetID
1981    */
1982   public function setFormAmountFields($priceSetID) {
1983     $isQuickConfig = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_params['priceSetId'], 'is_quick_config');
1984     $priceField = new CRM_Price_DAO_PriceField();
1985     $priceField->price_set_id = $priceSetID;
1986     $priceField->orderBy('weight');
1987     $priceField->find();
1988     $paramWeDoNotUnderstand = NULL;
1989
1990     while ($priceField->fetch()) {
1991       if ($priceField->name == "contribution_amount") {
1992         $paramWeDoNotUnderstand = $priceField->id;
1993       }
1994       if ($isQuickConfig && !empty($this->_params["price_{$priceField->id}"])) {
1995         if ($this->_values['fee'][$priceField->id]['html_type'] != 'Text') {
1996           // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
1997           // function to get correct amount level consistently. Remove setting of the amount level in
1998           // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
1999           // to cover all variants.
2000           $this->_params['amount_level'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue',
2001             $this->_params["price_{$priceField->id}"], 'label');
2002         }
2003         if ($priceField->name == "membership_amount") {
2004           $this->_params['selectMembership'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue',
2005             $this->_params["price_{$priceField->id}"], 'membership_type_id');
2006         }
2007       }
2008       // If separate payment we set contribution amount to be null, so that it will not show contribution amount same
2009       // as membership amount.
2010       // @todo - this needs more documentation - it appears the setting to null is tied up with separate membership payments
2011       // but the circumstances are very confusing. Many of these conditions are repeated in the next conditional
2012       // so we should merge them together
2013       // the quick config seems like a red-herring - if this is about a separate membership payment then there
2014       // are 2 types of line items - membership ones & non-membership ones - regardless of whether quick config is set
2015       elseif (
2016         !empty($this->_membershipBlock['is_separate_payment'])
2017         && !empty($this->_values['fee'][$priceField->id])
2018         && ($this->_values['fee'][$priceField->id]['name'] == "other_amount")
2019         && ($this->_params["price_{$paramWeDoNotUnderstand}"] ?? NULL) < 1
2020         && empty($this->_params["price_{$priceField->id}"])
2021       ) {
2022         $this->_params['amount'] = NULL;
2023       }
2024
2025       // Fix for CRM-14375 - If we are using separate payments and "no
2026       // thank you" is selected for the additional contribution, set
2027       // contribution amount to be null, so that it will not show
2028       // contribution amount same as membership amount.
2029       //@todo - merge with section above
2030       if (!empty($this->_membershipBlock['is_separate_payment'])
2031         && !empty($this->_values['fee'][$priceField->id])
2032         && ($this->_values['fee'][$priceField->id]['name'] ?? NULL) == 'contribution_amount'
2033         && ($this->_params["price_{$priceField->id}"] ?? NULL) == '-1'
2034       ) {
2035         $this->_params['amount'] = NULL;
2036       }
2037     }
2038   }
2039
2040   /**
2041    * Submit function.
2042    *
2043    * @param array $params
2044    *
2045    * @throws CiviCRM_API3_Exception
2046    */
2047   public static function submit($params) {
2048     $form = new CRM_Contribute_Form_Contribution_Confirm();
2049     $form->_id = $params['id'];
2050
2051     CRM_Contribute_BAO_ContributionPage::setValues($form->_id, $form->_values);
2052     $form->_separateMembershipPayment = CRM_Contribute_BAO_ContributionPage::getIsMembershipPayment($form->_id);
2053     //this way the mocked up controller ignores the session stuff
2054     $_SERVER['REQUEST_METHOD'] = 'GET';
2055     $form->controller = new CRM_Contribute_Controller_Contribution();
2056     $params['invoiceID'] = md5(uniqid(rand(), TRUE));
2057
2058     // We want to move away from passing in amount as it is calculated by the actually-submitted params.
2059     if ($form->getMainContributionAmount($params)) {
2060       $params['amount'] = $form->getMainContributionAmount($params);
2061     }
2062     $paramsProcessedForForm = $form->_params = self::getFormParams($params['id'], $params);
2063
2064     $order = new CRM_Financial_BAO_Order();
2065     $order->setPriceSelectionFromUnfilteredInput($params);
2066     if (isset($params['amount'])) {
2067       // @todo deprecate receiving amount, calculate on the form.
2068       $order->setOverrideTotalAmount($params['amount']);
2069     }
2070     $amount = $order->getTotalAmount();
2071     $form->_amount = $params['amount'] = $form->_params['amount'] = $params['amount'] ?? $amount;
2072     // hack these in for test support.
2073     $form->_fields['billing_first_name'] = 1;
2074     $form->_fields['billing_last_name'] = 1;
2075     // CRM-18854 - Set form values to allow pledge to be created for api test.
2076     if (!empty($params['pledge_block_id'])) {
2077       $form->_values['pledge_id'] = $params['pledge_id'] ?? NULL;
2078       $form->_values['pledge_block_id'] = $params['pledge_block_id'];
2079       $pledgeBlock = CRM_Pledge_BAO_PledgeBlock::getPledgeBlock($params['id']);
2080       $form->_values['max_reminders'] = $pledgeBlock['max_reminders'];
2081       $form->_values['initial_reminder_day'] = $pledgeBlock['initial_reminder_day'];
2082       $form->_values['additional_reminder_day'] = $pledgeBlock['additional_reminder_day'];
2083       $form->_values['is_email_receipt'] = FALSE;
2084     }
2085     $priceSetID = $form->_params['priceSetId'] = $paramsProcessedForForm['price_set_id'];
2086     $priceFields = CRM_Price_BAO_PriceSet::getSetDetail($priceSetID);
2087     $priceSetFields = reset($priceFields);
2088     $form->_values['fee'] = $priceSetFields['fields'];
2089     $form->_priceSetId = $priceSetID;
2090     $form->setFormAmountFields($priceSetID);
2091     $capabilities = [];
2092     if ($form->_mode) {
2093       $capabilities[] = (ucfirst($form->_mode) . 'Mode');
2094     }
2095     $form->_paymentProcessors = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors($capabilities);
2096     $form->_params['payment_processor_id'] = $params['payment_processor_id'] ?? 0;
2097     if ($form->_params['payment_processor_id'] !== '') {
2098       // It can be blank with a $0 transaction - then no processor needs to be selected
2099       $form->_paymentProcessor = $form->_paymentProcessors[$form->_params['payment_processor_id']];
2100     }
2101     if (!empty($params['payment_processor_id'])) {
2102       // The concept of contributeMode is deprecated as is the billing_mode concept.
2103       if ($form->_paymentProcessor['billing_mode'] == 1) {
2104         $form->_contributeMode = 'direct';
2105       }
2106       else {
2107         $form->_contributeMode = 'notify';
2108       }
2109     }
2110
2111     if (!empty($params['useForMember'])) {
2112       $form->set('useForMember', 1);
2113       $form->_useForMember = 1;
2114     }
2115     $priceFields = $priceFields[$priceSetID]['fields'];
2116     $lineItems = [];
2117     $form->processAmountAndGetAutoRenew($priceFields, $paramsProcessedForForm, $lineItems, $priceSetID);
2118     $form->_lineItem = [$priceSetID => $lineItems];
2119     $membershipPriceFieldIDs = [];
2120     foreach ((array) $lineItems as $lineItem) {
2121       if (!empty($lineItem['membership_type_id'])) {
2122         $form->set('useForMember', 1);
2123         $form->_useForMember = 1;
2124         $membershipPriceFieldIDs['id'] = $priceSetID;
2125         $membershipPriceFieldIDs[] = $lineItem['price_field_value_id'];
2126       }
2127     }
2128     $form->set('memberPriceFieldIDS', $membershipPriceFieldIDs);
2129     $form->setRecurringMembershipParams();
2130     $form->processFormSubmission($params['contact_id'] ?? NULL);
2131   }
2132
2133   /**
2134    * Helper function for static submit function.
2135    *
2136    * Set relevant params - help us to build up an array that we can pass in.
2137    *
2138    * @param int $id
2139    * @param array $params
2140    *
2141    * @return array
2142    * @throws CiviCRM_API3_Exception
2143    */
2144   public static function getFormParams($id, array $params) {
2145     if (!isset($params['is_pay_later'])) {
2146       if (!empty($params['payment_processor_id'])) {
2147         $params['is_pay_later'] = 0;
2148       }
2149       elseif (($params['amount'] ?? 0) !== 0) {
2150         $params['is_pay_later'] = civicrm_api3('contribution_page', 'getvalue', [
2151           'id' => $id,
2152           'return' => 'is_pay_later',
2153         ]);
2154       }
2155     }
2156     if (empty($params['price_set_id'])) {
2157       $params['price_set_id'] = CRM_Price_BAO_PriceSet::getFor('civicrm_contribution_page', $params['id']);
2158     }
2159     return $params;
2160   }
2161
2162   /**
2163    * Post form submission handling.
2164    *
2165    * This is also called from the test suite.
2166    *
2167    * @param int $contactID
2168    *
2169    * @return array
2170    *
2171    * @throws \CRM_Core_Exception
2172    * @throws \CiviCRM_API3_Exception
2173    * @throws \Civi\API\Exception\UnauthorizedException
2174    */
2175   protected function processFormSubmission($contactID) {
2176     if (!isset($this->_params['payment_processor_id'])) {
2177       // If there is no processor we are using the pay-later manual pseudo-processor.
2178       // (note it might make sense to make this a row in the processor table in the db).
2179       $this->_params['payment_processor_id'] = 0;
2180     }
2181     if (isset($this->_params['payment_processor_id']) && $this->_params['payment_processor_id'] === 0) {
2182       $this->_params['is_pay_later'] = $isPayLater = TRUE;
2183     }
2184
2185     if (!empty($this->_ccid)) {
2186       $this->_params['contribution_id'] = $this->_ccid;
2187     }
2188     //Set email-bltID if pre/post profile contains an email.
2189     if ($this->_emailExists == TRUE) {
2190       foreach ($this->_params as $key => $val) {
2191         if (substr($key, 0, 6) == 'email-' && empty($this->_params["email-{$this->_bltID}"])) {
2192           $this->_params["email-{$this->_bltID}"] = $this->_params[$key];
2193         }
2194       }
2195     }
2196     // add a description field at the very beginning
2197     $title = !empty($this->_values['frontend_title']) ? $this->_values['frontend_title'] : $this->_values['title'];
2198     $this->_params['description'] = ts('Online Contribution') . ': ' . (!empty($this->_pcpInfo['title']) ? $this->_pcpInfo['title'] : $title);
2199
2200     $this->_params['accountingCode'] = $this->_values['accountingCode'] ?? NULL;
2201
2202     // fix currency ID
2203     $this->_params['currencyID'] = CRM_Core_Config::singleton()->defaultCurrency;
2204
2205     CRM_Contribute_Form_AbstractEditPayment::formatCreditCardDetails($this->_params);
2206
2207     // CRM-18854
2208     if (!empty($this->_params['is_pledge']) && empty($this->_values['pledge_id']) && !empty($this->_values['adjust_recur_start_date'])) {
2209       $pledgeBlock = CRM_Pledge_BAO_PledgeBlock::getPledgeBlock($this->_id);
2210       if (!empty($this->_params['start_date']) || empty($pledgeBlock['is_pledge_start_date_visible'])
2211           || empty($pledgeBlock['is_pledge_start_date_editable'])) {
2212         $pledgeStartDate = $this->_params['start_date'] ?? NULL;
2213         $this->_params['receive_date'] = CRM_Pledge_BAO_Pledge::getPledgeStartDate($pledgeStartDate, $pledgeBlock);
2214         $recurParams = CRM_Pledge_BAO_Pledge::buildRecurParams($this->_params);
2215         $this->_params = array_merge($this->_params, $recurParams);
2216       }
2217     }
2218
2219     //carry payment processor id.
2220     if (!empty($this->_paymentProcessor['id'])) {
2221       $this->_params['payment_processor_id'] = $this->_paymentProcessor['id'];
2222     }
2223
2224     $premiumParams = $membershipParams = $params = $this->_params;
2225     if (!empty($params['image_URL'])) {
2226       CRM_Contact_BAO_Contact::processImageParams($params);
2227     }
2228
2229     $fields = ['email-Primary' => 1];
2230
2231     // get the add to groups
2232     $addToGroups = [];
2233
2234     // now set the values for the billing location.
2235     foreach ($this->_fields as $name => $value) {
2236       $fields[$name] = 1;
2237
2238       // get the add to groups for uf fields
2239       if (!empty($value['add_to_group_id'])) {
2240         $addToGroups[$value['add_to_group_id']] = $value['add_to_group_id'];
2241       }
2242     }
2243
2244     $fields = $this->formatParamsForPaymentProcessor($fields);
2245
2246     // billing email address
2247     $fields["email-{$this->_bltID}"] = 1;
2248
2249     // if onbehalf-of-organization contribution, take out
2250     // organization params in a separate variable, to make sure
2251     // normal behavior is continued. And use that variable to
2252     // process on-behalf-of functionality.
2253     if (!empty($this->_values['onbehalf_profile_id']) && empty($this->_ccid)) {
2254       $behalfOrganization = [];
2255       $orgFields = ['organization_name', 'organization_id', 'org_option'];
2256       foreach ($orgFields as $fld) {
2257         if (array_key_exists($fld, $params)) {
2258           $behalfOrganization[$fld] = $params[$fld];
2259           unset($params[$fld]);
2260         }
2261       }
2262
2263       if (is_array($params['onbehalf']) && !empty($params['onbehalf'])) {
2264         foreach ($params['onbehalf'] as $fld => $values) {
2265           if (strstr($fld, 'custom_')) {
2266             $behalfOrganization[$fld] = $values;
2267           }
2268           elseif (!(strstr($fld, '-'))) {
2269             if (in_array($fld, [
2270               'contribution_campaign_id',
2271               'member_campaign_id',
2272             ])) {
2273               $fld = 'campaign_id';
2274             }
2275             else {
2276               $behalfOrganization[$fld] = $values;
2277             }
2278             $this->_params[$fld] = $values;
2279           }
2280         }
2281       }
2282
2283       if (array_key_exists('onbehalf_location', $params) && is_array($params['onbehalf_location'])) {
2284         foreach ($params['onbehalf_location'] as $block => $vals) {
2285           //fix for custom data (of type checkbox, multi-select)
2286           if (substr($block, 0, 7) == 'custom_') {
2287             continue;
2288           }
2289           // fix the index of block elements
2290           if (is_array($vals)) {
2291             foreach ($vals as $key => $val) {
2292               //dont adjust the index of address block as
2293               //it's index is WRT to location type
2294               $newKey = ($block == 'address') ? $key : ++$key;
2295               $behalfOrganization[$block][$newKey] = $val;
2296             }
2297           }
2298         }
2299         unset($params['onbehalf_location']);
2300       }
2301       if (!empty($params['onbehalf[image_URL]'])) {
2302         $behalfOrganization['image_URL'] = $params['onbehalf[image_URL]'];
2303       }
2304     }
2305
2306     // check for profile double opt-in and get groups to be subscribed
2307     $subscribeGroupIds = CRM_Core_BAO_UFGroup::getDoubleOptInGroupIds($params, $contactID);
2308
2309     // since we are directly adding contact to group lets unset it from mailing
2310     if (!empty($addToGroups)) {
2311       foreach ($addToGroups as $groupId) {
2312         if (isset($subscribeGroupIds[$groupId])) {
2313           unset($subscribeGroupIds[$groupId]);
2314         }
2315       }
2316     }
2317
2318     foreach ($addToGroups as $k) {
2319       if (array_key_exists($k, $subscribeGroupIds)) {
2320         unset($addToGroups[$k]);
2321       }
2322     }
2323
2324     if (empty($contactID)) {
2325       $dupeParams = $params;
2326       if (!empty($dupeParams['onbehalf'])) {
2327         unset($dupeParams['onbehalf']);
2328       }
2329       if (!empty($dupeParams['honor'])) {
2330         unset($dupeParams['honor']);
2331       }
2332
2333       $contactID = CRM_Contact_BAO_Contact::getFirstDuplicateContact($dupeParams, 'Individual', 'Unsupervised', [], FALSE);
2334
2335       // Fetch default greeting id's if creating a contact
2336       if (!$contactID) {
2337         foreach (CRM_Contact_BAO_Contact::$_greetingTypes as $greeting) {
2338           if (!isset($params[$greeting])) {
2339             $params[$greeting] = CRM_Contact_BAO_Contact_Utils::defaultGreeting('Individual', $greeting);
2340           }
2341         }
2342       }
2343       $contactType = NULL;
2344     }
2345     else {
2346       $contactType = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $contactID, 'contact_type');
2347     }
2348     $contactID = CRM_Contact_BAO_Contact::createProfileContact(
2349       $params,
2350       $fields,
2351       $contactID,
2352       $addToGroups,
2353       NULL,
2354       $contactType,
2355       TRUE
2356     );
2357
2358     // Make the contact ID associated with the contribution available at the Class level.
2359     // Also make available to the session.
2360     //@todo consider handling this in $this->getContactID();
2361     $this->set('contactID', $contactID);
2362     $this->_contactID = $contactID;
2363
2364     //get email primary first if exist
2365     $subscriptionEmail = ['email' => $params['email-Primary'] ?? NULL];
2366     if (!$subscriptionEmail['email']) {
2367       $subscriptionEmail['email'] = $params["email-{$this->_bltID}"] ?? NULL;
2368     }
2369     // subscribing contact to groups
2370     if (!empty($subscribeGroupIds) && $subscriptionEmail['email']) {
2371       CRM_Mailing_Event_BAO_Subscribe::commonSubscribe($subscribeGroupIds, $subscriptionEmail, $contactID);
2372     }
2373
2374     // If onbehalf-of-organization contribution / signup, add organization
2375     // and it's location.
2376     if (isset($this->_values['onbehalf_profile_id']) &&
2377       isset($behalfOrganization['organization_name']) &&
2378       ($this->_values['is_for_organization'] == 2 ||
2379         !empty($this->_params['is_for_organization'])
2380       )
2381     ) {
2382       $ufFields = [];
2383       foreach ($this->_fields['onbehalf'] as $name => $value) {
2384         $ufFields[$name] = 1;
2385       }
2386       self::processOnBehalfOrganization($behalfOrganization, $contactID, $this->_values,
2387         $this->_params, $ufFields
2388       );
2389     }
2390     elseif (!empty($this->_membershipContactID) && $contactID != $this->_membershipContactID) {
2391       // this is an onbehalf renew case for inherited membership. For e.g a permissioned member of household,
2392       // store current user id as related contact for later use for mailing / activity..
2393       $this->_values['related_contact'] = $contactID;
2394       $this->_params['related_contact'] = $contactID;
2395       // swap contact like we do for on-behalf-org case, so parent/primary membership is affected
2396       $contactID = $this->_membershipContactID;
2397     }
2398
2399     // lets store the contactID in the session
2400     // for things like tell a friend
2401     $session = CRM_Core_Session::singleton();
2402     if (!$session->get('userID')) {
2403       $session->set('transaction.userID', $contactID);
2404     }
2405     else {
2406       $session->set('transaction.userID', NULL);
2407     }
2408
2409     $this->_useForMember = $this->get('useForMember');
2410
2411     // store the fact that this is a membership and membership type is selected
2412     if ($this->isMembershipSelected($membershipParams)) {
2413       if (!$this->_useForMember) {
2414         $this->assign('membership_assign', TRUE);
2415         $this->set('membershipTypeID', $this->_params['selectMembership']);
2416       }
2417
2418       if ($this->_action & CRM_Core_Action::PREVIEW) {
2419         $membershipParams['is_test'] = 1;
2420       }
2421       if ($this->_params['is_pay_later']) {
2422         $membershipParams['is_pay_later'] = 1;
2423       }
2424
2425       if (isset($this->_params['onbehalf_contact_id'])) {
2426         $membershipParams['onbehalf_contact_id'] = $this->_params['onbehalf_contact_id'];
2427       }
2428       //inherit campaign from contribution page.
2429       if (!array_key_exists('campaign_id', $membershipParams)) {
2430         $membershipParams['campaign_id'] = $this->_values['campaign_id'] ?? NULL;
2431       }
2432
2433       $this->_params = CRM_Core_Payment_Form::mapParams($this->_bltID, $this->_params, $membershipParams, TRUE);
2434       $this->doMembershipProcessing($contactID, $membershipParams, $premiumParams, $this->_lineItem);
2435     }
2436     else {
2437       // at this point we've created a contact and stored its address etc
2438       // all the payment processors expect the name and address to be in the
2439       // so we copy stuff over to first_name etc.
2440       $paymentParams = $this->_params;
2441       // Make it explict that we are letting the processConfirm function figure out the line items.
2442       $paymentParams['skipLineItem'] = 0;
2443
2444       if (!isset($paymentParams['line_item'])) {
2445         $paymentParams['line_item'] = $this->_lineItem;
2446       }
2447
2448       if (!empty($paymentParams['onbehalf']) &&
2449         is_array($paymentParams['onbehalf'])
2450       ) {
2451         foreach ($paymentParams['onbehalf'] as $key => $value) {
2452           if (strstr($key, 'custom_')) {
2453             $this->_params[$key] = $value;
2454           }
2455         }
2456       }
2457
2458       $result = $this->processConfirm($paymentParams,
2459         $contactID,
2460         $this->wrangleFinancialTypeID($this->_values['financial_type_id']),
2461         ($this->_mode == 'test') ? 1 : 0,
2462         $paymentParams['is_recur'] ?? NULL
2463       );
2464
2465       if (empty($result['is_payment_failure'])) {
2466         // @todo move premium processing to complete transaction if it truly is an 'after' action.
2467         $this->postProcessPremium($premiumParams, $result['contribution']);
2468       }
2469       if (!empty($result['contribution'])) {
2470         // It seems this line is hit when there is a zero dollar transaction & in tests, not sure when else.
2471         $this->completeTransaction($result, $result['contribution']->id);
2472       }
2473       return $result;
2474     }
2475   }
2476
2477   /**
2478    * Return True/False if we have a membership selected on the contribution page
2479    * @param array $membershipParams
2480    *
2481    * @return bool
2482    */
2483   private function isMembershipSelected($membershipParams) {
2484     $priceFieldIds = $this->get('memberPriceFieldIDS');
2485     if ((!empty($membershipParams['selectMembership']) && $membershipParams['selectMembership'] != 'no_thanks')
2486         && empty($priceFieldIds)) {
2487       return TRUE;
2488     }
2489     else {
2490       $membershipParams = $this->getMembershipParamsFromPriceSet($membershipParams);
2491     }
2492     return !empty($membershipParams['selectMembership']);
2493   }
2494
2495   /**
2496    * Extract the selected memberships from a priceSet
2497    *
2498    * @param array $membershipParams
2499    *
2500    * @return array
2501    */
2502   private function getMembershipParamsFromPriceSet($membershipParams) {
2503     $priceFieldIds = $this->get('memberPriceFieldIDS');
2504     if (empty($priceFieldIds)) {
2505       return $membershipParams;
2506     }
2507     $membershipParams['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $priceFieldIds['id'], 'financial_type_id');
2508     unset($priceFieldIds['id']);
2509     $membershipTypeIds = [];
2510     $membershipTypeTerms = [];
2511     foreach ($priceFieldIds as $priceFieldId) {
2512       $membershipTypeId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_type_id');
2513       if ($membershipTypeId) {
2514         $membershipTypeIds[] = $membershipTypeId;
2515         $term = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $priceFieldId, 'membership_num_terms') ?: 1;
2516         $membershipTypeTerms[$membershipTypeId] = ($term > 1) ? $term : 1;
2517       }
2518     }
2519     $membershipParams['selectMembership'] = $membershipTypeIds;
2520     $membershipParams['types_terms'] = $membershipTypeTerms;
2521     return $membershipParams;
2522   }
2523
2524   /**
2525    * Membership processing section.
2526    *
2527    * This is in a separate function as part of a move towards refactoring.
2528    *
2529    * @param int $contactID
2530    * @param array $membershipParams
2531    * @param array $premiumParams
2532    * @param array $formLineItems
2533    */
2534   protected function doMembershipProcessing($contactID, $membershipParams, $premiumParams, $formLineItems) {
2535     // This could be set by a hook.
2536     if (!empty($this->_params['installments'])) {
2537       $membershipParams['installments'] = $this->_params['installments'];
2538     }
2539     // added new parameter for cms user contact id, needed to distinguish behaviour for on behalf of sign-ups
2540     if (isset($this->_params['related_contact'])) {
2541       $membershipParams['cms_contactID'] = $this->_params['related_contact'];
2542     }
2543     else {
2544       $membershipParams['cms_contactID'] = $contactID;
2545     }
2546
2547     if (!empty($membershipParams['onbehalf']) &&
2548       is_array($membershipParams['onbehalf']) && !empty($membershipParams['onbehalf']['member_campaign_id'])
2549     ) {
2550       $this->_params['campaign_id'] = $membershipParams['onbehalf']['member_campaign_id'];
2551     }
2552
2553     $customFieldsFormatted = $fieldTypes = [];
2554     if (!empty($membershipParams['onbehalf']) &&
2555       is_array($membershipParams['onbehalf'])
2556     ) {
2557       foreach ($membershipParams['onbehalf'] as $key => $value) {
2558         if (strstr($key, 'custom_')) {
2559           $customFieldId = explode('_', $key);
2560           CRM_Core_BAO_CustomField::formatCustomField(
2561             $customFieldId[1],
2562             $customFieldsFormatted,
2563             $value,
2564             'Membership',
2565             NULL,
2566             $contactID
2567           );
2568         }
2569       }
2570       $fieldTypes = ['Contact', 'Organization', 'Membership'];
2571     }
2572
2573     $membershipParams = $this->getMembershipParamsFromPriceSet($membershipParams);
2574     if (!empty($membershipParams['selectMembership'])) {
2575       // CRM-12233
2576       $membershipLineItems = $formLineItems;
2577       if ($this->_separateMembershipPayment && $this->_values['amount_block_is_active']) {
2578         $membershipLineItems = [];
2579         foreach ($this->_values['fee'] as $key => $feeValues) {
2580           if ($feeValues['name'] == 'membership_amount') {
2581             $fieldId = $this->_params['price_' . $key];
2582             $membershipLineItems[$this->_priceSetId][$fieldId] = $this->_lineItem[$this->_priceSetId][$fieldId];
2583             unset($this->_lineItem[$this->_priceSetId][$fieldId]);
2584             break;
2585           }
2586         }
2587       }
2588       try {
2589         $this->processMembership($membershipParams, $contactID, $customFieldsFormatted, $fieldTypes, $premiumParams, $membershipLineItems);
2590       }
2591       catch (\Civi\Payment\Exception\PaymentProcessorException $e) {
2592         CRM_Core_Session::singleton()->setStatus($e->getMessage());
2593         if (!empty($this->_contributionID)) {
2594           CRM_Contribute_BAO_Contribution::failPayment($this->_contributionID,
2595             $contactID, $e->getMessage());
2596         }
2597         CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/transact', "_qf_Main_display=true&qfKey={$this->_params['qfKey']}"));
2598       }
2599       catch (CRM_Core_Exception $e) {
2600         CRM_Core_Session::singleton()->setStatus($e->getMessage());
2601         CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/transact', "_qf_Main_display=true&qfKey={$this->_params['qfKey']}"));
2602       }
2603       if (!$this->_amount > 0.0 || !$membershipParams['amount']) {
2604         // we need to explicitly create a CMS user in case of free memberships
2605         // since it is done under processConfirm for paid memberships
2606         CRM_Contribute_BAO_Contribution_Utils::createCMSUser($membershipParams,
2607           $membershipParams['cms_contactID'],
2608           'email-' . $this->_bltID
2609         );
2610       }
2611     }
2612   }
2613
2614   /**
2615    * Complete transaction if payment has been processed.
2616    *
2617    * Check the result for a success outcome & if paid then complete the transaction.
2618    *
2619    * Completing will trigger update of related entities and emails.
2620    *
2621    * @param array $result
2622    * @param int $contributionID
2623    *
2624    * @throws \CiviCRM_API3_Exception
2625    * @throws \Exception
2626    */
2627   protected function completeTransaction($result, $contributionID) {
2628     if (($result['payment_status_id'] ?? NULL) == 1) {
2629       try {
2630         civicrm_api3('contribution', 'completetransaction', [
2631           'id' => $contributionID,
2632           'trxn_id' => $result['trxn_id'] ?? NULL,
2633           'payment_processor_id' => $result['payment_processor_id'] ?? $this->_paymentProcessor['id'],
2634           'is_transactional' => FALSE,
2635           'fee_amount' => $result['fee_amount'] ?? NULL,
2636           'receive_date' => $result['receive_date'] ?? NULL,
2637           'card_type_id' => $result['card_type_id'] ?? NULL,
2638           'pan_truncation' => $result['pan_truncation'] ?? NULL,
2639         ]);
2640       }
2641       catch (CiviCRM_API3_Exception $e) {
2642         if ($e->getErrorCode() != 'contribution_completed') {
2643           throw new CRM_Core_Exception('Failed to update contribution in database');
2644         }
2645       }
2646     }
2647   }
2648
2649   /**
2650    * Bounce the user back to retry when an error occurs.
2651    *
2652    * @param string $message
2653    */
2654   protected function bounceOnError($message) {
2655     CRM_Core_Session::singleton()
2656       ->setStatus(ts("Payment Processor Error message :") .
2657         $message);
2658     CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/transact',
2659       "_qf_Main_display=true&qfKey={$this->_params['qfKey']}"
2660     ));
2661   }
2662
2663   /**
2664    * Is a payment being made.
2665    *
2666    * Note that setting is_monetary on the form is somewhat legacy and the behaviour around this setting is confusing. It would be preferable
2667    * to look for the amount only (assuming this cannot refer to payment in goats or other non-monetary currency
2668    * @param CRM_Core_Form $form
2669    *
2670    * @return bool
2671    */
2672   protected static function isPaymentTransaction($form) {
2673     return $form->_amount >= 0.0;
2674   }
2675
2676   /**
2677    * Process payment after confirmation.
2678    *
2679    * @param array $paymentParams
2680    *   Array with payment related key.
2681    *   value pairs
2682    * @param int $contactID
2683    *   Contact id.
2684    * @param int $financialTypeID
2685    *   Financial type id.
2686    * @param bool $isTest
2687    * @param bool $isRecur
2688    *
2689    * @throws CRM_Core_Exception
2690    * @throws Exception
2691    * @return array
2692    *   associated array
2693    */
2694   public function processConfirm(
2695     &$paymentParams,
2696     $contactID,
2697     $financialTypeID,
2698     $isTest,
2699     $isRecur
2700   ): array {
2701     $form = $this;
2702     CRM_Core_Payment_Form::mapParams($form->_bltID, $form->_params, $paymentParams, TRUE);
2703     $isPaymentTransaction = self::isPaymentTransaction($form);
2704
2705     $financialType = new CRM_Financial_DAO_FinancialType();
2706     $financialType->id = $financialTypeID;
2707     $financialType->find(TRUE);
2708     if ($financialType->is_deductible) {
2709       $form->assign('is_deductible', TRUE);
2710       $form->set('is_deductible', TRUE);
2711     }
2712
2713     // add some financial type details to the params list
2714     // if folks need to use it
2715     $paymentParams['financial_type_id'] = $paymentParams['financialTypeID'] = $financialType->id;
2716     //CRM-15297 - contributionType is obsolete - pass financial type as well so people can deprecate it
2717     $paymentParams['financialType_name'] = $paymentParams['contributionType_name'] = $form->_params['contributionType_name'] = $financialType->name;
2718     //CRM-11456
2719     $paymentParams['financialType_accounting_code'] = $paymentParams['contributionType_accounting_code'] = $form->_params['contributionType_accounting_code'] = CRM_Financial_BAO_FinancialAccount::getAccountingCode($financialTypeID);
2720     $paymentParams['contributionPageID'] = $form->_params['contributionPageID'] = $form->_values['id'];
2721     $paymentParams['contactID'] = $form->_params['contactID'] = $contactID;
2722
2723     //fix for CRM-16317
2724     if (empty($form->_params['receive_date'])) {
2725       $form->_params['receive_date'] = date('YmdHis');
2726     }
2727     if (!empty($form->_params['start_date'])) {
2728       $form->_params['start_date'] = date('YmdHis');
2729     }
2730     $form->assign('receive_date',
2731       CRM_Utils_Date::mysqlToIso($form->_params['receive_date'])
2732     );
2733
2734     if (empty($form->_values['amount'])) {
2735       // If the amount is not in _values[], set it
2736       $form->_values['amount'] = $form->_params['amount'];
2737     }
2738
2739     if (isset($paymentParams['contribution_source'])) {
2740       $paymentParams['source'] = $paymentParams['contribution_source'];
2741     }
2742     if ($isPaymentTransaction) {
2743       $contributionParams = [
2744         'id' => $paymentParams['contribution_id'] ?? NULL,
2745         'contact_id' => $contactID,
2746         'is_test' => $isTest,
2747         'source' => CRM_Utils_Array::value('source', $paymentParams, CRM_Utils_Array::value('description', $paymentParams)),
2748       ];
2749
2750       // CRM-21200: Don't overwrite contribution details during 'Pay now' payment
2751       if (empty($form->_params['contribution_id'])) {
2752         $contributionParams['contribution_page_id'] = $form->_id;
2753         $contributionParams['campaign_id'] = CRM_Utils_Array::value('campaign_id', $paymentParams, CRM_Utils_Array::value('campaign_id', $form->_values));
2754       }
2755       // In case of 'Pay now' payment, append the contribution source with new text 'Paid later via page ID: N.'
2756       else {
2757         // contribution.source only allows 255 characters so we are using ellipsify(...) to ensure it.
2758         $contributionParams['source'] = CRM_Utils_String::ellipsify(
2759           ts('Paid later via page ID: %1. %2', [
2760             1 => $form->_id,
2761             2 => $contributionParams['source'],
2762           ]),
2763           // eventually activity.description append price information to source text so keep it 220 to ensure string length doesn't exceed 255 characters.
2764           220
2765         );
2766       }
2767
2768       if (isset($paymentParams['line_item'])) {
2769         // @todo make sure this is consisently set at this point.
2770         $contributionParams['line_item'] = $paymentParams['line_item'];
2771       }
2772       if (!empty($form->_paymentProcessor)) {
2773         $contributionParams['payment_instrument_id'] = $paymentParams['payment_instrument_id'] = $form->_paymentProcessor['payment_instrument_id'];
2774       }
2775
2776       // @todo this is the wrong place for this - it should be done as close to form submission
2777       // as possible
2778       $paymentParams['amount'] = CRM_Utils_Rule::cleanMoney($paymentParams['amount']);
2779       $contribution = CRM_Contribute_Form_Contribution_Confirm::processFormContribution(
2780         $form,
2781         $paymentParams,
2782         NULL,
2783         $contributionParams,
2784         $financialType,
2785         TRUE,
2786         $form->_bltID,
2787         $isRecur
2788       );
2789       // CRM-13074 - create the CMSUser after the transaction is completed as it
2790       // is not appropriate to delete a valid contribution if a user create problem occurs
2791       if (isset($params['related_contact'])) {
2792         $contactID = $params['related_contact'];
2793       }
2794       elseif (isset($params['cms_contactID'])) {
2795         $contactID = $params['cms_contactID'];
2796       }
2797       CRM_Contribute_BAO_Contribution_Utils::createCMSUser($params,
2798         $contactID,
2799         'email-' . $form->_bltID
2800       );
2801
2802       $paymentParams['item_name'] = $form->_params['description'];
2803
2804       $paymentParams['qfKey'] = empty($paymentParams['qfKey']) ? $form->controller->_key : $paymentParams['qfKey'];
2805       if ($paymentParams['skipLineItem']) {
2806         // We are not processing the line item here because we are processing a membership.
2807         // Do not continue with contribution processing in this function.
2808         return ['contribution' => $contribution];
2809       }
2810
2811       $paymentParams['contributionID'] = $contribution->id;
2812       $paymentParams['contributionPageID'] = $contribution->contribution_page_id;
2813
2814       if (!empty($form->_params['is_recur']) && $contribution->contribution_recur_id) {
2815         $paymentParams['contributionRecurID'] = $contribution->contribution_recur_id;
2816       }
2817       if (isset($paymentParams['contribution_source'])) {
2818         $form->_params['source'] = $paymentParams['contribution_source'];
2819       }
2820
2821       // get the price set values for receipt.
2822       if ($form->_priceSetId && $form->_lineItem) {
2823         $form->_values['lineItem'] = $form->_lineItem;
2824         $form->_values['priceSetID'] = $form->_priceSetId;
2825       }
2826
2827       $form->_values['contribution_id'] = $contribution->id;
2828       $form->_values['contribution_page_id'] = $contribution->contribution_page_id;
2829
2830       if (!empty($form->_paymentProcessor)) {
2831         try {
2832           $payment = Civi\Payment\System::singleton()->getByProcessor($form->_paymentProcessor);
2833           if ($form->_contributeMode == 'notify') {
2834             // We want to get rid of this & make it generic - eg. by making payment processing the last thing
2835             // and always calling it first.
2836             $form->postProcessHook();
2837           }
2838           $result = $payment->doPayment($paymentParams);
2839           $form->_params = array_merge($form->_params, $result);
2840           $form->assign('trxn_id', CRM_Utils_Array::value('trxn_id', $result));
2841           if (!empty($result['trxn_id'])) {
2842             $contribution->trxn_id = $result['trxn_id'];
2843           }
2844           if (!empty($result['payment_status_id'])) {
2845             $contribution->payment_status_id = $result['payment_status_id'];
2846           }
2847           $result['contribution'] = $contribution;
2848           if ($result['payment_status_id'] == CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Pending')
2849             && $payment->isSendReceiptForPending()) {
2850             CRM_Contribute_BAO_ContributionPage::sendMail($contactID,
2851               $form->_values,
2852               $contribution->is_test
2853             );
2854           }
2855           return $result;
2856         }
2857         catch (\Civi\Payment\Exception\PaymentProcessorException $e) {
2858           // Clean up DB as appropriate.
2859           if (!empty($paymentParams['contributionID'])) {
2860             CRM_Contribute_BAO_Contribution::failPayment($paymentParams['contributionID'],
2861               $paymentParams['contactID'], $e->getMessage());
2862           }
2863           if (!empty($paymentParams['contributionRecurID'])) {
2864             CRM_Contribute_BAO_ContributionRecur::deleteRecurContribution($paymentParams['contributionRecurID']);
2865           }
2866
2867           $result['is_payment_failure'] = TRUE;
2868           $result['error'] = $e;
2869           return $result;
2870         }
2871       }
2872     }
2873
2874     // Only pay later or unpaid should reach this point, although pay later likely does not & is handled via the
2875     // manual processor, so it's unclear what this set is for and whether the following send ever fires.
2876     $form->set('params', $form->_params);
2877
2878     if ($form->_params['amount'] == 0) {
2879       // This is kind of a back-up for pay-later $0 transactions.
2880       // In other flows they pick up the manual processor & get dealt with above (I
2881       // think that might be better...).
2882       return [
2883         'payment_status_id' => 1,
2884         'contribution' => $contribution,
2885         'payment_processor_id' => 0,
2886       ];
2887     }
2888
2889     CRM_Contribute_BAO_ContributionPage::sendMail($contactID,
2890       $form->_values,
2891       $contribution->is_test
2892     );
2893   }
2894
2895 }