CRM/Contribute/Form/ContributionBase.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  * This class generates form components for processing a contribution.
  20  */
  21 class CRM_Contribute_Form_ContributionBase extends CRM_Core_Form {
  22   use CRM_Financial_Form_FrontEndPaymentFormTrait;
  23
  24   /**
  25    * The id of the contribution page that we are processing.
  26    *
  27    * @var int
  28    */
  29   public $_id;
  30
  31   /**
  32    * The mode that we are in
  33    *
  34    * @var string
  35    * @protect
  36    */
  37   public $_mode;
  38
  39   /**
  40    * The contact id related to a membership
  41    *
  42    * @var int
  43    */
  44   public $_membershipContactID;
  45
  46   /**
  47    * The values for the contribution db object
  48    *
  49    * @var array
  50    */
  51   public $_values;
  52
  53   /**
  54    * The paymentProcessor attributes for this page
  55    *
  56    * @var array
  57    */
  58   public $_paymentProcessor;
  59
  60   public $_paymentObject = NULL;
  61
  62   /**
  63    * The membership block for this page
  64    *
  65    * @var array
  66    */
  67   public $_membershipBlock = NULL;
  68
  69   /**
  70    * Does this form support a separate membership payment
  71    * @var bool
  72    */
  73   protected $_separateMembershipPayment;
  74
  75   /**
  76    * The params submitted by the form and computed by the app
  77    *
  78    * @var array
  79    */
  80   public $_params = [];
  81
  82   /**
  83    * The fields involved in this contribution page
  84    *
  85    * @var array
  86    */
  87   public $_fields = [];
  88
  89   /**
  90    * The billing location id for this contribution page.
  91    *
  92    * @var int
  93    */
  94   public $_bltID;
  95
  96   /**
  97    * Cache the amount to make things easier
  98    *
  99    * @var float
 100    */
 101   public $_amount;
 102
 103   /**
 104    * Pcp id
 105    *
 106    * @var int
 107    */
 108   public $_pcpId;
 109
 110   /**
 111    * Pcp block
 112    *
 113    * @var array
 114    */
 115   public $_pcpBlock;
 116
 117   /**
 118    * Pcp info
 119    *
 120    * @var array
 121    */
 122   public $_pcpInfo;
 123
 124   /**
 125    * The contact id of the person for whom membership is being added or renewed based on the cid in the url,
 126    * checksum, or session
 127    * @var int
 128    */
 129   public $_contactID;
 130
 131   protected $_userID;
 132
 133   /**
 134    * The Membership ID for membership renewal
 135    *
 136    * @var int
 137    */
 138   public $_membershipId;
 139
 140   /**
 141    * Price Set ID, if the new price set method is used
 142    *
 143    * @var int
 144    */
 145   public $_priceSetId;
 146
 147   /**
 148    * Array of fields for the price set
 149    *
 150    * @var array
 151    */
 152   public $_priceSet;
 153
 154   public $_action;
 155
 156   /**
 157    * Contribution mode.
 158    *
 159    * In general we are trying to deprecate this parameter but some templates and processors still
 160    * require it to denote whether the processor redirects offsite (notify) or not.
 161    *
 162    * The intent is that this knowledge should not be required and all contributions should
 163    * be created in a pending state and updated based on the payment result without needing to be
 164    * aware of the processor workings.
 165    *
 166    * @var string
 167    *
 168    * @deprecated
 169    */
 170   public $_contributeMode;
 171
 172   /**
 173    * Contribution page supports memberships
 174    * @var bool
 175    */
 176   public $_useForMember;
 177
 178   /**
 179    * @var bool
 180    * @deprecated
 181    */
 182   public $_isBillingAddressRequiredForPayLater;
 183
 184   /**
 185    * Flag if email field exists in embedded profile
 186    *
 187    * @var bool
 188    */
 189   public $_emailExists = FALSE;
 190
 191   /**
 192    * Is this a backoffice form.
 193    *
 194    * Processors may display different options to backoffice users.
 195    *
 196    * @var bool
 197    */
 198   public $isBackOffice = FALSE;
 199
 200   /**
 201    * Payment instrument if for the transaction.
 202    *
 203    * This will generally be drawn from the payment processor and is ignored for
 204    * front end forms.
 205    *
 206    * @var int
 207    */
 208   public $paymentInstrumentID;
 209
 210   /**
 211    * Is the price set quick config.
 212    * @return bool
 213    */
 214   public function isQuickConfig() {
 215     return self::$_quickConfig ?? FALSE;
 216   }
 217
 218   /**
 219    * Set variables up before form is built.
 220    *
 221    * @throws \CRM_Contribute_Exception_InactiveContributionPageException
 222    * @throws \Exception
 223    */
 224   public function preProcess() {
 225
 226     // current contribution page id
 227     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
 228     $this->_ccid = CRM_Utils_Request::retrieve('ccid', 'Positive', $this);
 229     if (!$this->_id) {
 230       // seems like the session is corrupted and/or we lost the id trail
 231       // lets just bump this to a regular session error and redirect user to main page
 232       $this->controller->invalidKeyRedirect();
 233     }
 234     $this->_emailExists = $this->get('emailExists');
 235
 236     // this was used prior to the cleverer this_>getContactID - unsure now
 237     $this->_userID = CRM_Core_Session::getLoggedInContactID();
 238
 239     $this->_contactID = $this->_membershipContactID = $this->getContactID();
 240     $this->_mid = NULL;
 241     if ($this->_contactID) {
 242       $this->_mid = CRM_Utils_Request::retrieve('mid', 'Positive', $this);
 243       if ($this->_mid) {
 244         $membership = new CRM_Member_DAO_Membership();
 245         $membership->id = $this->_mid;
 246
 247         if ($membership->find(TRUE)) {
 248           $this->_defaultMemTypeId = $membership->membership_type_id;
 249           if ($membership->contact_id != $this->_contactID) {
 250             $validMembership = FALSE;
 251             $organizations = CRM_Contact_BAO_Relationship::getPermissionedContacts($this->_userID, NULL, NULL, 'Organization');
 252             if (!empty($organizations) && array_key_exists($membership->contact_id, $organizations)) {
 253               $this->_membershipContactID = $membership->contact_id;
 254               $this->assign('membershipContactID', $this->_membershipContactID);
 255               $this->assign('membershipContactName', $organizations[$this->_membershipContactID]['name']);
 256               $validMembership = TRUE;
 257             }
 258             else {
 259               $membershipType = new CRM_Member_BAO_MembershipType();
 260               $membershipType->id = $membership->membership_type_id;
 261               if ($membershipType->find(TRUE)) {
 262                 // CRM-14051 - membership_type.relationship_type_id is a CTRL-A padded string w one or more ID values.
 263                 // Convert to comma separated list.
 264                 $inheritedRelTypes = implode(CRM_Utils_Array::explodePadded($membershipType->relationship_type_id), ',');
 265                 $permContacts = CRM_Contact_BAO_Relationship::getPermissionedContacts($this->_userID, $membershipType->relationship_type_id);
 266                 if (array_key_exists($membership->contact_id, $permContacts)) {
 267                   $this->_membershipContactID = $membership->contact_id;
 268                   $validMembership = TRUE;
 269                 }
 270               }
 271             }
 272             if (!$validMembership) {
 273               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('Membership Invalid'), 'alert');
 274             }
 275           }
 276         }
 277         else {
 278           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('Membership Invalid'), 'alert');
 279         }
 280         unset($membership);
 281       }
 282     }
 283
 284     // we do not want to display recently viewed items, so turn off
 285     $this->assign('displayRecent', FALSE);
 286
 287     // action
 288     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add');
 289     $this->assign('action', $this->_action);
 290
 291     // current mode
 292     $this->_mode = ($this->_action == 1024) ? 'test' : 'live';
 293
 294     $this->_values = $this->get('values');
 295     $this->_fields = $this->get('fields');
 296     $this->_bltID = $this->get('bltID');
 297     $this->_paymentProcessor = $this->get('paymentProcessor');
 298
 299     $this->_priceSetId = $this->get('priceSetId');
 300     $this->_priceSet = $this->get('priceSet');
 301
 302     if (!$this->_values) {
 303       // get all the values from the dao object
 304       $this->_values = [];
 305       $this->_fields = [];
 306
 307       CRM_Contribute_BAO_ContributionPage::setValues($this->_id, $this->_values);
 308       if (CRM_Financial_BAO_FinancialType::isACLFinancialTypeStatus()
 309         && !CRM_Core_Permission::check('add contributions of type ' . CRM_Contribute_PseudoConstant::financialType($this->_values['financial_type_id']))
 310       ) {
 311         CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
 312       }
 313       if (empty($this->_values['is_active'])) {
 314         throw new CRM_Contribute_Exception_InactiveContributionPageException(ts('The page you requested is currently unavailable.'), $this->_id);
 315       }
 316
 317       $endDate = CRM_Utils_Date::processDate(CRM_Utils_Array::value('end_date', $this->_values));
 318       $now = date('YmdHis');
 319       if ($endDate && $endDate < $now) {
 320         throw new CRM_Contribute_Exception_PastContributionPageException(ts('The page you requested has past its end date on %1', [1 => CRM_Utils_Date::customFormat($endDate)]), $this->_id);
 321       }
 322
 323       $startDate = CRM_Utils_Date::processDate(CRM_Utils_Array::value('start_date', $this->_values));
 324       if ($startDate && $startDate > $now) {
 325         throw new CRM_Contribute_Exception_FutureContributionPageException(ts('The page you requested will be active from %1', [1 => CRM_Utils_Date::customFormat($startDate)]), $this->_id);
 326       }
 327
 328       $this->assignBillingType();
 329
 330       // check for is_monetary status
 331       $isMonetary = $this->_values['is_monetary'] ?? NULL;
 332       $isPayLater = $this->_values['is_pay_later'] ?? NULL;
 333       if (!empty($this->_ccid)) {
 334         $this->_values['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution',
 335           $this->_ccid,
 336           'financial_type_id'
 337         );
 338         if ($isPayLater) {
 339           $isPayLater = FALSE;
 340           $this->_values['is_pay_later'] = FALSE;
 341         }
 342       }
 343       if ($isPayLater) {
 344         $this->setPayLaterLabel($this->_values['pay_later_text']);
 345       }
 346
 347       if ($isMonetary) {
 348         $this->_paymentProcessorIDs = array_filter(explode(
 349           CRM_Core_DAO::VALUE_SEPARATOR,
 350           CRM_Utils_Array::value('payment_processor', $this->_values)
 351         ));
 352
 353         $this->assignPaymentProcessor($isPayLater);
 354       }
 355
 356       // get price info
 357       // CRM-5095
 358       $priceSetId = CRM_Price_BAO_PriceSet::getFor('civicrm_contribution_page', $this->_id);
 359       CRM_Price_BAO_PriceSet::initSet($this, 'civicrm_contribution_page', FALSE, $priceSetId);
 360
 361       // this avoids getting E_NOTICE errors in php
 362       $setNullFields = [
 363         'amount_block_is_active',
 364         'is_allow_other_amount',
 365         'footer_text',
 366       ];
 367       foreach ($setNullFields as $f) {
 368         if (!isset($this->_values[$f])) {
 369           $this->_values[$f] = NULL;
 370         }
 371       }
 372
 373       //check if Membership Block is enabled, if Membership Fields are included in profile
 374       //get membership section for this contribution page
 375       $this->_membershipBlock = CRM_Member_BAO_Membership::getMembershipBlock($this->_id);
 376       $this->set('membershipBlock', $this->_membershipBlock);
 377
 378       if (!empty($this->_values['custom_pre_id'])) {
 379         $preProfileType = CRM_Core_BAO_UFField::getProfileType($this->_values['custom_pre_id']);
 380       }
 381
 382       if (!empty($this->_values['custom_post_id'])) {
 383         $postProfileType = CRM_Core_BAO_UFField::getProfileType($this->_values['custom_post_id']);
 384       }
 385
 386       if (((isset($postProfileType) && $postProfileType === 'Membership') ||
 387           (isset($preProfileType) && $preProfileType === 'Membership')
 388         ) &&
 389         !$this->_membershipBlock['is_active']
 390       ) {
 391         CRM_Core_Error::statusBounce(ts('This page includes a Profile with Membership fields - but the Membership Block is NOT enabled. Please notify the site administrator.'));
 392       }
 393
 394       $pledgeBlock = CRM_Pledge_BAO_PledgeBlock::getPledgeBlock($this->_id);
 395
 396       if ($pledgeBlock) {
 397         $this->_values['pledge_block_id'] = $pledgeBlock['id'] ?? NULL;
 398         $this->_values['max_reminders'] = $pledgeBlock['max_reminders'] ?? NULL;
 399         $this->_values['initial_reminder_day'] = $pledgeBlock['initial_reminder_day'] ?? NULL;
 400         $this->_values['additional_reminder_day'] = $pledgeBlock['additional_reminder_day'] ?? NULL;
 401
 402         //set pledge id in values
 403         $pledgeId = CRM_Utils_Request::retrieve('pledgeId', 'Positive', $this);
 404
 405         //authenticate pledge user for pledge payment.
 406         if ($pledgeId) {
 407           $this->_values['pledge_id'] = $pledgeId;
 408
 409           //lets override w/ pledge campaign.
 410           $this->_values['campaign_id'] = CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_Pledge',
 411             $pledgeId,
 412             'campaign_id'
 413           );
 414           self::authenticatePledgeUser();
 415         }
 416       }
 417       $this->set('values', $this->_values);
 418       $this->set('fields', $this->_fields);
 419     }
 420
 421     // Handle PCP
 422     $pcpId = CRM_Utils_Request::retrieve('pcpId', 'Positive', $this);
 423     if ($pcpId) {
 424       $pcp = CRM_PCP_BAO_PCP::handlePcp($pcpId, 'contribute', $this->_values);
 425       $this->_pcpId = $pcp['pcpId'];
 426       $this->_pcpBlock = $pcp['pcpBlock'];
 427       $this->_pcpInfo = $pcp['pcpInfo'];
 428     }
 429
 430     // Link (button) for users to create their own Personal Campaign page
 431     if ($linkText = CRM_PCP_BAO_PCP::getPcpBlockStatus($this->_id, 'contribute')) {
 432       $linkTextUrl = CRM_Utils_System::url('civicrm/contribute/campaign',
 433         "action=add&reset=1&pageId={$this->_id}&component=contribute",
 434         FALSE, NULL, TRUE
 435       );
 436       $this->assign('linkTextUrl', $linkTextUrl);
 437       $this->assign('linkText', $linkText);
 438     }
 439
 440     //set pledge block if block id is set
 441     if (!empty($this->_values['pledge_block_id'])) {
 442       $this->assign('pledgeBlock', TRUE);
 443     }
 444
 445     // check if one of the (amount , membership)  blocks is active or not.
 446     $this->_membershipBlock = $this->get('membershipBlock');
 447
 448     if (!$this->_values['amount_block_is_active'] &&
 449       !$this->_membershipBlock['is_active'] &&
 450       !$this->_priceSetId
 451     ) {
 452       CRM_Core_Error::statusBounce(ts('The requested online contribution page is missing a required Contribution Amount section or Membership section or Price Set. Please check with the site administrator for assistance.'));
 453     }
 454
 455     if ($this->_values['amount_block_is_active']) {
 456       $this->set('amount_block_is_active', $this->_values['amount_block_is_active']);
 457     }
 458
 459     $this->_contributeMode = $this->get('contributeMode');
 460     $this->assign('contributeMode', $this->_contributeMode);
 461
 462     //assigning is_monetary and is_email_receipt to template
 463     $this->assign('is_monetary', $this->_values['is_monetary']);
 464     $this->assign('is_email_receipt', $this->_values['is_email_receipt']);
 465     $this->assign('bltID', $this->_bltID);
 466
 467     //assign cancelSubscription URL to templates
 468     $this->assign('cancelSubscriptionUrl',
 469       CRM_Utils_Array::value('cancelSubscriptionUrl', $this->_values)
 470     );
 471
 472     $title = !empty($this->_values['frontend_title']) ? $this->_values['frontend_title'] : $this->_values['title'];
 473
 474     $this->setTitle(($this->_pcpId ? $this->_pcpInfo['title'] : $title));
 475     $this->_defaults = [];
 476
 477     $this->_amount = $this->get('amount');
 478     // Assigning this to the template means it will be passed through to the payment form.
 479     // This can, for example, by used by payment processors using client side encryption
 480     $this->assign('currency', $this->getCurrency());
 481
 482     CRM_Contribute_BAO_Contribution_Utils::overrideDefaultCurrency($this->_values);
 483
 484     //lets allow user to override campaign.
 485     $campID = CRM_Utils_Request::retrieve('campID', 'Positive', $this);
 486     if ($campID && CRM_Core_DAO::getFieldValue('CRM_Campaign_DAO_Campaign', $campID)) {
 487       $this->_values['campaign_id'] = $campID;
 488     }
 489
 490     //do check for cancel recurring and clean db, CRM-7696
 491     if (CRM_Utils_Request::retrieve('cancel', 'Boolean')) {
 492       self::cancelRecurring();
 493     }
 494
 495     // check if billing block is required for pay later
 496     if (!empty($this->_values['is_pay_later'])) {
 497       $this->_isBillingAddressRequiredForPayLater = $this->_values['is_billing_required'] ?? NULL;
 498       $this->assign('isBillingAddressRequiredForPayLater', $this->_isBillingAddressRequiredForPayLater);
 499     }
 500   }
 501
 502   /**
 503    * Set the default values.
 504    */
 505   public function setDefaultValues() {
 506     return $this->_defaults;
 507   }
 508
 509   /**
 510    * Assign the minimal set of variables to the template.
 511    */
 512   public function assignToTemplate() {
 513     $this->set('name', $this->assignBillingName($this->_params));
 514
 515     $this->assign('paymentProcessor', $this->_paymentProcessor);
 516     $vars = [
 517       'amount',
 518       'currencyID',
 519       'credit_card_type',
 520       'trxn_id',
 521       'amount_level',
 522     ];
 523
 524     $config = CRM_Core_Config::singleton();
 525     if (isset($this->_values['is_recur']) && !empty($this->_paymentProcessor['is_recur'])) {
 526       $this->assign('is_recur_enabled', 1);
 527       $vars = array_merge($vars, [
 528         'is_recur',
 529         'frequency_interval',
 530         'frequency_unit',
 531         'installments',
 532       ]);
 533     }
 534
 535     if (in_array('CiviPledge', $config->enableComponents) &&
 536       CRM_Utils_Array::value('is_pledge', $this->_params) == 1
 537     ) {
 538       $this->assign('pledge_enabled', 1);
 539
 540       $vars = array_merge($vars, [
 541         'is_pledge',
 542         'pledge_frequency_interval',
 543         'pledge_frequency_unit',
 544         'pledge_installments',
 545       ]);
 546     }
 547
 548     // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
 549     // function to get correct amount level consistently. Remove setting of the amount level in
 550     // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
 551     // to cover all variants.
 552     if (isset($this->_params['amount_other']) || isset($this->_params['selectMembership'])) {
 553       $this->_params['amount_level'] = '';
 554     }
 555
 556     foreach ($vars as $v) {
 557       if (isset($this->_params[$v])) {
 558         if ($v == "amount" && $this->_params[$v] === 0) {
 559           $this->_params[$v] = CRM_Utils_Money::format($this->_params[$v], NULL, NULL, TRUE);
 560         }
 561         $this->assign($v, $this->_params[$v]);
 562       }
 563     }
 564
 565     $this->assign('address', CRM_Utils_Address::getFormattedBillingAddressFieldsFromParameters(
 566       $this->_params,
 567       $this->_bltID
 568     ));
 569
 570     if (!empty($this->_params['onbehalf_profile_id']) && !empty($this->_params['onbehalf'])) {
 571       $this->assign('onBehalfName', $this->_params['organization_name']);
 572       $locTypeId = array_keys($this->_params['onbehalf_location']['email']);
 573       $this->assign('onBehalfEmail', $this->_params['onbehalf_location']['email'][$locTypeId[0]]['email']);
 574     }
 575     $this->assignPaymentFields();
 576     $this->assignEmailField();
 577
 578     // also assign the receipt_text
 579     if (isset($this->_values['receipt_text'])) {
 580       $this->assign('receipt_text', $this->_values['receipt_text']);
 581     }
 582   }
 583
 584   /**
 585    * Assign email variable in the template.
 586    */
 587   public function assignEmailField() {
 588     //If email exist in a profile, the default billing email field is not loaded on the page.
 589     //Hence, assign the existing location type email by iterating through the params.
 590     if ($this->_emailExists && empty($this->_params["email-{$this->_bltID}"])) {
 591       foreach ($this->_params as $key => $val) {
 592         if (substr($key, 0, 6) === 'email-') {
 593           $this->assign('email', $this->_params[$key]);
 594           break;
 595         }
 596       }
 597     }
 598     else {
 599       $this->assign('email', CRM_Utils_Array::value("email-{$this->_bltID}", $this->_params));
 600     }
 601   }
 602
 603   /**
 604    * Add the custom fields.
 605    *
 606    * @param int $id
 607    * @param string $name
 608    * @param bool $viewOnly
 609    * @param null $profileContactType
 610    * @param array $fieldTypes
 611    */
 612   public function buildCustom($id, $name, $viewOnly = FALSE, $profileContactType = NULL, $fieldTypes = NULL) {
 613     if ($id) {
 614       $contactID = $this->getContactID();
 615
 616       // we don't allow conflicting fields to be
 617       // configured via profile - CRM 2100
 618       $fieldsToIgnore = [
 619         'receive_date' => 1,
 620         'trxn_id' => 1,
 621         'invoice_id' => 1,
 622         'net_amount' => 1,
 623         'fee_amount' => 1,
 624         'non_deductible_amount' => 1,
 625         'total_amount' => 1,
 626         'amount_level' => 1,
 627         'contribution_status_id' => 1,
 628         // @todo replace payment_instrument with payment instrument id.
 629         // both are available now but the id field is the most consistent.
 630         'payment_instrument' => 1,
 631         'payment_instrument_id' => 1,
 632         'contribution_check_number' => 1,
 633         'financial_type' => 1,
 634       ];
 635
 636       $fields = CRM_Core_BAO_UFGroup::getFields($id, FALSE, CRM_Core_Action::ADD, NULL, NULL, FALSE,
 637         NULL, FALSE, NULL, CRM_Core_Permission::CREATE, NULL
 638       );
 639
 640       if ($fields) {
 641         // determine if email exists in profile so we know if we need to manually insert CRM-2888, CRM-15067
 642         foreach ($fields as $key => $field) {
 643           if (substr($key, 0, 6) == 'email-' &&
 644               !in_array($profileContactType, ['honor', 'onbehalf'])
 645           ) {
 646             $this->_emailExists = TRUE;
 647             $this->set('emailExists', TRUE);
 648           }
 649         }
 650
 651         if (array_intersect_key($fields, $fieldsToIgnore)) {
 652           $fields = array_diff_key($fields, $fieldsToIgnore);
 653           CRM_Core_Session::setStatus(ts('Some of the profile fields cannot be configured for this page.'), ts('Warning'), 'alert');
 654         }
 655
 656         //remove common fields only if profile is not configured for onbehalf/honor
 657         if (!in_array($profileContactType, ['honor', 'onbehalf'])) {
 658           $fields = array_diff_key($fields, $this->_fields);
 659         }
 660
 661         CRM_Core_BAO_Address::checkContactSharedAddressFields($fields, $contactID);
 662         $addCaptcha = FALSE;
 663         // fetch file preview when not submitted yet, like in online contribution Confirm and ThankYou page
 664         $viewOnlyFileValues = empty($profileContactType) ? [] : [$profileContactType => []];
 665         foreach ($fields as $key => $field) {
 666           if ($viewOnly &&
 667             isset($field['data_type']) &&
 668             $field['data_type'] == 'File' || ($viewOnly && $field['name'] == 'image_URL')
 669           ) {
 670             //retrieve file value from submitted values on basis of $profileContactType
 671             $fileValue = $this->_params[$key] ?? NULL;
 672             if (!empty($profileContactType) && !empty($this->_params[$profileContactType])) {
 673               $fileValue = $this->_params[$profileContactType][$key] ?? NULL;
 674             }
 675
 676             if ($fileValue) {
 677               $path = $fileValue['name'] ?? NULL;
 678               $fileType = $fileValue['type'] ?? NULL;
 679               $fileValue = CRM_Utils_File::getFileURL($path, $fileType);
 680             }
 681
 682             // format custom file value fetched from submitted value
 683             if ($profileContactType) {
 684               $viewOnlyFileValues[$profileContactType][$key] = $fileValue;
 685             }
 686             else {
 687               $viewOnlyFileValues[$key] = $fileValue;
 688             }
 689
 690             // On viewOnly use-case (as in online contribution Confirm page) we no longer need to set
 691             // required property because being required file is already uploaded while registration
 692             $field['is_required'] = FALSE;
 693           }
 694           if ($profileContactType) {
 695             //Since we are showing honoree name separately so we are removing it from honoree profile just for display
 696             if ($profileContactType == 'honor') {
 697               $honoreeNamefields = [
 698                 'prefix_id',
 699                 'first_name',
 700                 'last_name',
 701                 'suffix_id',
 702                 'organization_name',
 703                 'household_name',
 704               ];
 705               if (in_array($field['name'], $honoreeNamefields)) {
 706                 unset($fields[$field['name']]);
 707                 continue;
 708               }
 709             }
 710             if (!empty($fieldTypes) && in_array($field['field_type'], $fieldTypes)) {
 711               CRM_Core_BAO_UFGroup::buildProfile(
 712                 $this,
 713                 $field,
 714                 CRM_Profile_Form::MODE_CREATE,
 715                 $contactID,
 716                 TRUE,
 717                 $profileContactType
 718               );
 719               $this->_fields[$profileContactType][$key] = $field;
 720             }
 721             else {
 722               unset($fields[$key]);
 723             }
 724           }
 725           else {
 726             CRM_Core_BAO_UFGroup::buildProfile(
 727               $this,
 728               $field,
 729               CRM_Profile_Form::MODE_CREATE,
 730               $contactID,
 731               TRUE
 732             );
 733             $this->_fields[$key] = $field;
 734           }
 735           // CRM-11316 Is ReCAPTCHA enabled for this profile AND is this an anonymous visitor
 736           if ($field['add_captcha'] && !$this->_userID) {
 737             $addCaptcha = TRUE;
 738           }
 739         }
 740
 741         $this->assign($name, $fields);
 742
 743         if ($profileContactType && count($viewOnlyFileValues[$profileContactType])) {
 744           $this->assign('viewOnlyPrefixFileValues', $viewOnlyFileValues);
 745         }
 746         elseif (count($viewOnlyFileValues)) {
 747           $this->assign('viewOnlyFileValues', $viewOnlyFileValues);
 748         }
 749
 750         if ($addCaptcha && !$viewOnly) {
 751           $this->enableCaptchaOnForm();
 752         }
 753       }
 754     }
 755   }
 756
 757   /**
 758    * Enable ReCAPTCHA on Contribution form
 759    */
 760   protected function enableCaptchaOnForm() {
 761     CRM_Utils_ReCAPTCHA::enableCaptchaOnForm($this);
 762   }
 763
 764   /**
 765    * Assign payment field information to the template.
 766    *
 767    * @throws \CRM_Core_Exception
 768    * @throws \CiviCRM_API3_Exception
 769    */
 770   public function assignPaymentFields() {
 771     //fix for CRM-3767
 772     $isMonetary = FALSE;
 773     if ($this->_amount > 0.0) {
 774       $isMonetary = TRUE;
 775     }
 776     elseif (!empty($this->_params['selectMembership'])) {
 777       $memFee = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $this->_params['selectMembership'], 'minimum_fee');
 778       if ($memFee > 0.0) {
 779         $isMonetary = TRUE;
 780       }
 781     }
 782
 783     // The concept of contributeMode is deprecated.
 784     // The payment processor object can provide info about the fields it shows.
 785     if ($isMonetary && is_a($this->_paymentProcessor['object'], 'CRM_Core_Payment')) {
 786       /** @var  \CRM_Core_Payment $paymentProcessorObject */
 787       $paymentProcessorObject = $this->_paymentProcessor['object'];
 788
 789       $paymentFields = $paymentProcessorObject->getPaymentFormFields();
 790       foreach ($paymentFields as $index => $paymentField) {
 791         if (!isset($this->_params[$paymentField])) {
 792           unset($paymentFields[$index]);
 793           continue;
 794         }
 795         if ($paymentField === 'credit_card_exp_date') {
 796           $date = CRM_Utils_Date::format(CRM_Utils_Array::value('credit_card_exp_date', $this->_params));
 797           $date = CRM_Utils_Date::mysqlToIso($date);
 798           $this->assign('credit_card_exp_date', $date);
 799         }
 800         elseif ($paymentField === 'credit_card_number') {
 801           $this->assign('credit_card_number',
 802             CRM_Utils_System::mungeCreditCard(CRM_Utils_Array::value('credit_card_number', $this->_params))
 803           );
 804         }
 805         elseif ($paymentField === 'credit_card_type') {
 806           $this->assign('credit_card_type', CRM_Core_PseudoConstant::getLabel(
 807             'CRM_Core_BAO_FinancialTrxn',
 808             'card_type_id',
 809             CRM_Core_PseudoConstant::getKey('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $this->_params['credit_card_type'])
 810           ));
 811         }
 812         else {
 813           $this->assign($paymentField, $this->_params[$paymentField]);
 814         }
 815       }
 816       $this->assign('paymentFieldsetLabel', CRM_Core_Payment_Form::getPaymentLabel($paymentProcessorObject));
 817       $this->assign('paymentFields', $paymentFields);
 818
 819     }
 820   }
 821
 822   /**
 823    * Display ReCAPTCHA warning on Contribution form
 824    */
 825   protected function displayCaptchaWarning() {
 826     if (CRM_Core_Permission::check("administer CiviCRM")) {
 827       if (!CRM_Utils_ReCAPTCHA::hasSettingsAvailable()) {
 828         $this->assign('displayCaptchaWarning', TRUE);
 829       }
 830     }
 831   }
 832
 833   /**
 834    * Check if ReCAPTCHA has to be added on Contribution form forcefully.
 835    */
 836   protected function hasToAddForcefully() {
 837     return CRM_Utils_ReCAPTCHA::hasToAddForcefully();
 838   }
 839
 840   /**
 841    * Add onbehalf/honoree profile fields and native module fields.
 842    *
 843    * @param int $id
 844    * @param CRM_Core_Form $form
 845    *
 846    * @throws \API_Exception
 847    * @throws \CRM_Core_Exception
 848    * @throws \CiviCRM_API3_Exception
 849    */
 850   public function buildComponentForm($id, $form): void {
 851     if (empty($id)) {
 852       return;
 853     }
 854
 855     $contactID = $this->getContactID();
 856
 857     foreach (['soft_credit', 'on_behalf'] as $module) {
 858       if ($module === 'soft_credit') {
 859         if (empty($form->_values['honoree_profile_id'])) {
 860           continue;
 861         }
 862
 863         if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $form->_values['honoree_profile_id'], 'is_active')) {
 864           CRM_Core_Error::statusBounce(ts('This contribution page has been configured for contribution on behalf of honoree and the selected honoree profile is either disabled or not found.'));
 865         }
 866
 867         $profileContactType = CRM_Core_BAO_UFGroup::getContactType($form->_values['honoree_profile_id']);
 868         $requiredProfileFields = [
 869           'Individual' => ['first_name', 'last_name'],
 870           'Organization' => ['organization_name', 'email'],
 871           'Household' => ['household_name', 'email'],
 872         ];
 873         $validProfile = CRM_Core_BAO_UFGroup::checkValidProfile($form->_values['honoree_profile_id'], $requiredProfileFields[$profileContactType]);
 874         if (!$validProfile) {
 875           CRM_Core_Error::statusBounce(ts('This contribution page has been configured for contribution on behalf of honoree and the required fields of the selected honoree profile are disabled or doesn\'t exist.'));
 876         }
 877
 878         foreach (['honor_block_title', 'honor_block_text'] as $name) {
 879           $form->assign($name, $form->_values[$name]);
 880         }
 881
 882         $softCreditTypes = CRM_Core_OptionGroup::values("soft_credit_type", FALSE);
 883
 884         // radio button for Honor Type
 885         foreach ($form->_values['soft_credit_types'] as $value) {
 886           $honorTypes[$value] = $softCreditTypes[$value];
 887         }
 888         $form->addRadio('soft_credit_type_id', NULL, $honorTypes, ['allowClear' => TRUE]);
 889
 890         $honoreeProfileFields = CRM_Core_BAO_UFGroup::getFields(
 891           $this->_values['honoree_profile_id'], FALSE,
 892           NULL, NULL,
 893           NULL, FALSE,
 894           NULL, TRUE,
 895           NULL, CRM_Core_Permission::CREATE
 896         );
 897         $form->assign('honoreeProfileFields', $honoreeProfileFields);
 898
 899         // add the form elements
 900         foreach ($honoreeProfileFields as $name => $field) {
 901           // If soft credit type is not chosen then make omit requiredness from honoree profile fields
 902           if (count($form->_submitValues) &&
 903             empty($form->_submitValues['soft_credit_type_id']) &&
 904             !empty($field['is_required'])
 905           ) {
 906             $field['is_required'] = FALSE;
 907           }
 908           CRM_Core_BAO_UFGroup::buildProfile($form, $field, CRM_Profile_Form::MODE_CREATE, NULL, FALSE, FALSE, NULL, 'honor');
 909         }
 910       }
 911       else {
 912         if (empty($form->_values['onbehalf_profile_id'])) {
 913           continue;
 914         }
 915
 916         if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $form->_values['onbehalf_profile_id'], 'is_active')) {
 917           CRM_Core_Error::statusBounce(ts('This contribution page has been configured for contribution on behalf of an organization and the selected onbehalf profile is either disabled or not found.'));
 918         }
 919
 920         $member = CRM_Member_BAO_Membership::getMembershipBlock($form->_id);
 921         if (empty($member['is_active'])) {
 922           $msg = ts('Mixed profile not allowed for on behalf of registration/sign up.');
 923           $onBehalfProfile = CRM_Core_BAO_UFGroup::profileGroups($form->_values['onbehalf_profile_id']);
 924           foreach (
 925             [
 926               'Individual',
 927               'Organization',
 928               'Household',
 929             ] as $contactType
 930           ) {
 931             if (in_array($contactType, $onBehalfProfile) &&
 932               (in_array('Membership', $onBehalfProfile) ||
 933                 in_array('Contribution', $onBehalfProfile)
 934               )
 935             ) {
 936               CRM_Core_Error::statusBounce($msg);
 937             }
 938           }
 939         }
 940
 941         if ($contactID) {
 942           // retrieve all permissioned organizations of contact $contactID
 943           $organizations = CRM_Contact_BAO_Relationship::getPermissionedContacts($contactID, NULL, NULL, 'Organization');
 944
 945           if (count($organizations)) {
 946             // Related org url - pass checksum if needed
 947             $args = [
 948               'ufId' => $form->_values['onbehalf_profile_id'],
 949               'cid' => '',
 950             ];
 951             if (!empty($_GET['cs'])) {
 952               $args = [
 953                 'ufId' => $form->_values['onbehalf_profile_id'],
 954                 'uid' => $this->_contactID,
 955                 'cs' => $_GET['cs'],
 956                 'cid' => '',
 957               ];
 958             }
 959             $locDataURL = CRM_Utils_System::url('civicrm/ajax/permlocation', $args, FALSE, NULL, FALSE);
 960             $form->assign('locDataURL', $locDataURL);
 961           }
 962           if (count($organizations) > 0) {
 963             $form->add('select', 'onbehalfof_id', '', CRM_Utils_Array::collect('name', $organizations));
 964
 965             $orgOptions = [
 966               0 => ts('Select an existing organization'),
 967               1 => ts('Enter a new organization'),
 968             ];
 969             $form->addRadio('org_option', ts('options'), $orgOptions);
 970             $form->setDefaults(['org_option' => 0]);
 971           }
 972         }
 973
 974         $form->assign('fieldSetTitle', CRM_Core_BAO_UFGroup::getFrontEndTitle($form->_values['onbehalf_profile_id']));
 975
 976         if (!empty($form->_values['is_for_organization'])) {
 977           if ($form->_values['is_for_organization'] == 2) {
 978             $form->assign('onBehalfRequired', TRUE);
 979           }
 980           else {
 981             $form->addElement('checkbox', 'is_for_organization',
 982               $form->_values['for_organization'],
 983               NULL
 984             );
 985           }
 986         }
 987
 988         $profileFields = CRM_Core_BAO_UFGroup::getFields(
 989           $form->_values['onbehalf_profile_id'],
 990           FALSE, CRM_Core_Action::VIEW, NULL,
 991           NULL, FALSE, NULL, FALSE, NULL,
 992           CRM_Core_Permission::CREATE, NULL
 993         );
 994
 995         $form->assign('onBehalfOfFields', $profileFields);
 996         if (!empty($form->_submitValues['onbehalf'])) {
 997           if (!empty($form->_submitValues['onbehalfof_id'])) {
 998             $form->assign('submittedOnBehalf', $form->_submitValues['onbehalfof_id']);
 999           }
1000           $form->assign('submittedOnBehalfInfo', json_encode(str_replace('"', '\"', $form->_submitValues['onbehalf']), JSON_HEX_APOS));
1001         }
1002
1003         $fieldTypes = ['Contact', 'Organization'];
1004         if (!empty($form->_membershipBlock)) {
1005           $fieldTypes = array_merge($fieldTypes, ['Membership']);
1006         }
1007         $contactSubType = CRM_Contact_BAO_ContactType::subTypes('Organization');
1008         $fieldTypes = array_merge($fieldTypes, $contactSubType);
1009
1010         foreach ($profileFields as $name => $field) {
1011           if (in_array($field['field_type'], $fieldTypes)) {
1012             [$prefixName, $index] = CRM_Utils_System::explode('-', $name, 2);
1013             if (in_array($prefixName, ['organization_name', 'email']) && empty($field['is_required'])) {
1014               $field['is_required'] = 1;
1015             }
1016             if (count($form->_submitValues) &&
1017               empty($form->_submitValues['is_for_organization']) &&
1018               $form->_values['is_for_organization'] == 1 &&
1019               !empty($field['is_required'])
1020             ) {
1021               $field['is_required'] = FALSE;
1022             }
1023             CRM_Core_BAO_UFGroup::buildProfile($form, $field, NULL, NULL, FALSE, 'onbehalf', NULL, 'onbehalf');
1024           }
1025         }
1026       }
1027     }
1028
1029   }
1030
1031   /**
1032    * Check template file exists.
1033    *
1034    * @param string $suffix
1035    *
1036    * @return null|string
1037    */
1038   public function checkTemplateFileExists($suffix = NULL) {
1039     if ($this->_id) {
1040       $templateFile = "CRM/Contribute/Form/Contribution/{$this->_id}/{$this->_name}.{$suffix}tpl";
1041       $template = CRM_Core_Form::getTemplate();
1042       if ($template->template_exists($templateFile)) {
1043         return $templateFile;
1044       }
1045     }
1046     return NULL;
1047   }
1048
1049   /**
1050    * Use the form name to create the tpl file name.
1051    *
1052    * @return string
1053    */
1054   public function getTemplateFileName() {
1055     $fileName = $this->checkTemplateFileExists();
1056     return $fileName ?: parent::getTemplateFileName();
1057   }
1058
1059   /**
1060    * Add the extra.tpl in.
1061    *
1062    * Default extra tpl file basically just replaces .tpl with .extra.tpl
1063    * i.e. we do not override - why isn't this done at the CRM_Core_Form level?
1064    *
1065    * @return string
1066    */
1067   public function overrideExtraTemplateFileName() {
1068     $fileName = $this->checkTemplateFileExists('extra.');
1069     return $fileName ? $fileName : parent::overrideExtraTemplateFileName();
1070   }
1071
1072   /**
1073    * Authenticate pledge user during online payment.
1074    *
1075    * @throws \CRM_Core_Exception
1076    */
1077   public function authenticatePledgeUser() {
1078     //get the userChecksum and contact id
1079     $userChecksum = CRM_Utils_Request::retrieve('cs', 'String', $this);
1080     $contactID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
1081
1082     //get pledge status and contact id
1083     $pledgeValues = [];
1084     $pledgeParams = ['id' => $this->_values['pledge_id']];
1085     $returnProperties = ['contact_id', 'status_id'];
1086     CRM_Core_DAO::commonRetrieve('CRM_Pledge_DAO_Pledge', $pledgeParams, $pledgeValues, $returnProperties);
1087
1088     //get all status
1089     $allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
1090     $validStatus = [
1091       array_search('Pending', $allStatus),
1092       array_search('In Progress', $allStatus),
1093       array_search('Overdue', $allStatus),
1094     ];
1095
1096     $validUser = FALSE;
1097     if ($this->_userID &&
1098       $this->_userID == $pledgeValues['contact_id']
1099     ) {
1100       //check for authenticated  user.
1101       $validUser = TRUE;
1102     }
1103     elseif ($userChecksum && $pledgeValues['contact_id']) {
1104       //check for anonymous user.
1105       $validUser = CRM_Contact_BAO_Contact_Utils::validChecksum($pledgeValues['contact_id'], $userChecksum);
1106
1107       //make sure cid is same as pledge contact id
1108       if ($validUser && ($pledgeValues['contact_id'] != $contactID)) {
1109         $validUser = FALSE;
1110       }
1111     }
1112
1113     if (!$validUser) {
1114       CRM_Core_Error::statusBounce(ts("Oops. It looks like you have an incorrect or incomplete link (URL). Please make sure you've copied the entire link, and try again. Contact the site administrator if this error persists."));
1115     }
1116
1117     //check for valid pledge status.
1118     if (!in_array($pledgeValues['status_id'], $validStatus)) {
1119       CRM_Core_Error::statusBounce(ts('Oops. You cannot make a payment for this pledge - pledge status is %1.', [1 => CRM_Utils_Array::value($pledgeValues['status_id'], $allStatus)]));
1120     }
1121   }
1122
1123   /**
1124    * Cancel recurring contributions.
1125    *
1126    * In case user cancel recurring contribution,
1127    * When we get the control back from payment gate way
1128    * lets delete the recurring and related contribution.
1129    *
1130    * @throws \CRM_Core_Exception
1131    */
1132   public function cancelRecurring() {
1133     $isCancel = CRM_Utils_Request::retrieve('cancel', 'Boolean');
1134     if ($isCancel) {
1135       $isRecur = CRM_Utils_Request::retrieve('isRecur', 'Boolean');
1136       $recurId = CRM_Utils_Request::retrieve('recurId', 'Positive');
1137       //clean db for recurring contribution.
1138       if ($isRecur && $recurId) {
1139         CRM_Contribute_BAO_ContributionRecur::deleteRecurContribution($recurId);
1140       }
1141       $contribId = CRM_Utils_Request::retrieve('contribId', 'Positive');
1142       if ($contribId) {
1143         CRM_Contribute_BAO_Contribution::deleteContribution($contribId);
1144       }
1145     }
1146   }
1147
1148   /**
1149    * Build Membership  Block in Contribution Pages.
1150    *
1151    * @param int $cid
1152    *   Contact checked for having a current membership for a particular membership.
1153    * @param bool $isContributionMainPage
1154    *   Is this the main page? If so add form input fields.
1155    *   (or better yet don't have this functionality in a function shared with forms that don't share it).
1156    * @param int|array $selectedMembershipTypeID
1157    *   Selected membership id.
1158    * @param bool $thankPage
1159    *   Thank you page.
1160    * @param null $isTest
1161    *
1162    * @return bool
1163    *   Is this a separate membership payment
1164    *
1165    * @throws \CiviCRM_API3_Exception
1166    * @throws \CRM_Core_Exception
1167    */
1168   protected function buildMembershipBlock(
1169     $cid,
1170     $isContributionMainPage = FALSE,
1171     $selectedMembershipTypeID = NULL,
1172     $thankPage = FALSE,
1173     $isTest = NULL
1174   ) {
1175
1176     $separateMembershipPayment = FALSE;
1177     if ($this->_membershipBlock) {
1178       $this->_currentMemberships = [];
1179
1180       $membershipTypeIds = $membershipTypes = $radio = $radioOptAttrs = [];
1181       $membershipPriceset = (!empty($this->_priceSetId) && $this->_useForMember);
1182
1183       $allowAutoRenewMembership = $autoRenewOption = FALSE;
1184       $autoRenewMembershipTypeOptions = [];
1185
1186       $separateMembershipPayment = $this->_membershipBlock['is_separate_payment'] ?? NULL;
1187
1188       if ($membershipPriceset) {
1189         foreach ($this->_priceSet['fields'] as $pField) {
1190           if (empty($pField['options'])) {
1191             continue;
1192           }
1193           foreach ($pField['options'] as $opId => $opValues) {
1194             if (empty($opValues['membership_type_id'])) {
1195               continue;
1196             }
1197             $membershipTypeIds[$opValues['membership_type_id']] = $opValues['membership_type_id'];
1198           }
1199         }
1200       }
1201       elseif (!empty($this->_membershipBlock['membership_types'])) {
1202         $membershipTypeIds = explode(',', $this->_membershipBlock['membership_types']);
1203       }
1204
1205       if (!empty($membershipTypeIds)) {
1206         //set status message if wrong membershipType is included in membershipBlock
1207         if (isset($this->_mid) && !$membershipPriceset) {
1208           $membershipTypeID = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
1209             $this->_mid,
1210             'membership_type_id'
1211           );
1212           if (!in_array($membershipTypeID, $membershipTypeIds)) {
1213             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');
1214           }
1215         }
1216
1217         $membershipTypeValues = CRM_Member_BAO_Membership::buildMembershipTypeValues($this, $membershipTypeIds);
1218         $this->_membershipTypeValues = $membershipTypeValues;
1219         $endDate = NULL;
1220
1221         // Check if we support auto-renew on this contribution page
1222         // FIXME: If any of the payment processors do NOT support recurring you cannot setup an
1223         //   auto-renew payment even if that processor is not selected.
1224         $allowAutoRenewOpt = TRUE;
1225         if (is_array($this->_paymentProcessors)) {
1226           foreach ($this->_paymentProcessors as $id => $val) {
1227             if ($id && !$val['is_recur']) {
1228               $allowAutoRenewOpt = FALSE;
1229             }
1230           }
1231         }
1232         foreach ($membershipTypeIds as $value) {
1233           $memType = $membershipTypeValues[$value];
1234           if ($selectedMembershipTypeID != NULL) {
1235             if ($memType['id'] == $selectedMembershipTypeID) {
1236               $this->assign('minimum_fee', $memType['minimum_fee'] ?? NULL);
1237               $this->assign('membership_name', $memType['name']);
1238               if (!$thankPage && $cid) {
1239                 $membership = new CRM_Member_DAO_Membership();
1240                 $membership->contact_id = $cid;
1241                 $membership->membership_type_id = $memType['id'];
1242                 if ($membership->find(TRUE)) {
1243                   $this->assign('renewal_mode', TRUE);
1244                   $memType['current_membership'] = $membership->end_date;
1245                   $this->_currentMemberships[$membership->membership_type_id] = $membership->membership_type_id;
1246                 }
1247               }
1248               $membershipTypes[] = $memType;
1249             }
1250           }
1251           elseif ($memType['is_active']) {
1252
1253             if ($allowAutoRenewOpt) {
1254               $javascriptMethod = ['onclick' => "return showHideAutoRenew( this.value );"];
1255               $isAvailableAutoRenew = $this->_membershipBlock['auto_renew'][$value] ?? 1;
1256               $autoRenewMembershipTypeOptions["autoRenewMembershipType_{$value}"] = (int) $memType['auto_renew'] * $isAvailableAutoRenew;
1257               $allowAutoRenewMembership = TRUE;
1258             }
1259             else {
1260               $javascriptMethod = NULL;
1261               $autoRenewMembershipTypeOptions["autoRenewMembershipType_{$value}"] = 0;
1262             }
1263
1264             //add membership type.
1265             $radio[$memType['id']] = NULL;
1266             $radioOptAttrs[$memType['id']] = $javascriptMethod;
1267             if ($cid) {
1268               $membership = new CRM_Member_DAO_Membership();
1269               $membership->contact_id = $cid;
1270               $membership->membership_type_id = $memType['id'];
1271
1272               //show current membership, skip pending and cancelled membership records,
1273               //because we take first membership record id for renewal
1274               $membership->whereAdd('status_id != 5 AND status_id !=6');
1275
1276               if (!is_null($isTest)) {
1277                 $membership->is_test = $isTest;
1278               }
1279
1280               //CRM-4297
1281               $membership->orderBy('end_date DESC');
1282
1283               if ($membership->find(TRUE)) {
1284                 if (!$membership->end_date) {
1285                   unset($radio[$memType['id']]);
1286                   unset($radioOptAttrs[$memType['id']]);
1287                   $this->assign('islifetime', TRUE);
1288                   continue;
1289                 }
1290                 $this->assign('renewal_mode', TRUE);
1291                 $this->_currentMemberships[$membership->membership_type_id] = $membership->membership_type_id;
1292                 $memType['current_membership'] = $membership->end_date;
1293                 if (!$endDate) {
1294                   $endDate = $memType['current_membership'];
1295                   $this->_defaultMemTypeId = $memType['id'];
1296                 }
1297                 if ($memType['current_membership'] < $endDate) {
1298                   $endDate = $memType['current_membership'];
1299                   $this->_defaultMemTypeId = $memType['id'];
1300                 }
1301               }
1302             }
1303             $membershipTypes[] = $memType;
1304           }
1305         }
1306       }
1307
1308       $this->assign('membershipBlock', $this->_membershipBlock);
1309       $this->assign('showRadio', $isContributionMainPage);
1310       $this->assign('membershipTypes', $membershipTypes);
1311       $this->assign('allowAutoRenewMembership', $allowAutoRenewMembership);
1312       $this->assign('autoRenewMembershipTypeOptions', json_encode($autoRenewMembershipTypeOptions));
1313       //give preference to user submitted auto_renew value.
1314       $takeUserSubmittedAutoRenew = (!empty($_POST) || $this->isSubmitted());
1315       $this->assign('takeUserSubmittedAutoRenew', $takeUserSubmittedAutoRenew);
1316
1317       // Assign autorenew option (0:hide,1:optional,2:required) so we can use it in confirmation etc.
1318       $autoRenewOption = CRM_Price_BAO_PriceSet::checkAutoRenewForPriceSet($this->_priceSetId);
1319       //$selectedMembershipTypeID is retrieved as an array for membership priceset if multiple
1320       //options for different organisation is selected on the contribution page.
1321       if (is_numeric($selectedMembershipTypeID) && isset($membershipTypeValues[$selectedMembershipTypeID]['auto_renew'])) {
1322         $this->assign('autoRenewOption', $membershipTypeValues[$selectedMembershipTypeID]['auto_renew']);
1323       }
1324       else {
1325         $this->assign('autoRenewOption', $autoRenewOption);
1326       }
1327
1328       if ($isContributionMainPage) {
1329         if (!$membershipPriceset) {
1330           if (!$this->_membershipBlock['is_required']) {
1331             $this->assign('showRadioNoThanks', TRUE);
1332             $radio['no_thanks'] = NULL;
1333             $this->addRadio('selectMembership', NULL, $radio, [], NULL, FALSE, $radioOptAttrs);
1334           }
1335           elseif ($this->_membershipBlock['is_required'] && count($radio) == 1) {
1336             $temp = array_keys($radio);
1337             $this->add('hidden', 'selectMembership', $temp[0], ['id' => 'selectMembership']);
1338             $this->assign('singleMembership', TRUE);
1339             $this->assign('showRadio', FALSE);
1340           }
1341           else {
1342             foreach ($radioOptAttrs as $opt => $attrs) {
1343               $attrs['class'] = ' required';
1344             }
1345             $this->addRadio('selectMembership', NULL, $radio, [], NULL, FALSE, $radioOptAttrs);
1346           }
1347
1348           $this->addRule('selectMembership', ts('Please select one of the memberships.'), 'required');
1349         }
1350
1351         if ((!$this->_values['is_pay_later'] || is_array($this->_paymentProcessors)) && ($allowAutoRenewMembership || $autoRenewOption)) {
1352           if ($autoRenewOption == 2) {
1353             $this->addElement('hidden', 'auto_renew', ts('Please renew my membership automatically.'));
1354           }
1355           else {
1356             $this->addElement('checkbox', 'auto_renew', ts('Please renew my membership automatically.'));
1357           }
1358         }
1359
1360       }
1361     }
1362
1363     return $separateMembershipPayment;
1364   }
1365
1366   /**
1367    * Determine if recurring parameters need to be added to the form parameters.
1368    *
1369    *  - is_recur
1370    *  - frequency_interval
1371    *  - frequency_unit
1372    *
1373    * For membership this is based on the membership type.
1374    *
1375    * This needs to be done before processing the pre-approval redirect where relevant on the main page or before any payment processing.
1376    *
1377    * Arguably the form should start to build $this->_params in the pre-process main page & use that array consistently throughout.
1378    */
1379   protected function setRecurringMembershipParams() {
1380     $selectedMembershipTypeID = $this->_params['selectMembership'] ?? NULL;
1381     if ($selectedMembershipTypeID) {
1382       // @todo the price_x fields will ALWAYS allow us to determine the membership - so we should ignore
1383       // 'selectMembership' and calculate from the price_x fields so we have one method that always works
1384       // this is lazy & only catches when selectMembership is set, but the worst of all worlds would be to fix
1385       // this with an else (calculate for price set).
1386       $membershipTypes = CRM_Price_BAO_PriceSet::getMembershipTypesFromPriceSet($this->_priceSetId);
1387       if (in_array($selectedMembershipTypeID, $membershipTypes['autorenew_required'])
1388         || (in_array($selectedMembershipTypeID, $membershipTypes['autorenew_optional']) &&
1389           !empty($this->_params['is_recur']))
1390       ) {
1391         $this->_params['auto_renew'] = TRUE;
1392       }
1393     }
1394     if ((!empty($this->_params['selectMembership']) || !empty($this->_params['priceSetId']))
1395       && !empty($this->_paymentProcessor['is_recur']) &&
1396       !empty($this->_params['auto_renew'])
1397       && empty($this->_params['is_recur']) && empty($this->_params['frequency_interval'])
1398     ) {
1399
1400       $this->_params['is_recur'] = $this->_values['is_recur'] = 1;
1401       // check if price set is not quick config
1402       if (!empty($this->_params['priceSetId']) && !CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_params['priceSetId'], 'is_quick_config')) {
1403         list($this->_params['frequency_interval'], $this->_params['frequency_unit']) = CRM_Price_BAO_PriceSet::getRecurDetails($this->_params['priceSetId']);
1404       }
1405       else {
1406         // FIXME: set interval and unit based on selected membership type
1407         $this->_params['frequency_interval'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
1408           $this->_params['selectMembership'], 'duration_interval'
1409         );
1410         $this->_params['frequency_unit'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
1411           $this->_params['selectMembership'], 'duration_unit'
1412         );
1413       }
1414     }
1415   }
1416
1417   /**
1418    * Get the payment processor object for the submission, returning the manual one for offline payments.
1419    *
1420    * @return CRM_Core_Payment
1421    */
1422   protected function getPaymentProcessorObject() {
1423     if (!empty($this->_paymentProcessor)) {
1424       return $this->_paymentProcessor['object'];
1425     }
1426     return new CRM_Core_Payment_Manual();
1427   }
1428
1429   /**
1430    * Get the amount for the main contribution.
1431    *
1432    * The goal is to expand this function so that all the argy-bargy of figuring out the amount
1433    * winds up here as the main spaghetti shrinks.
1434    *
1435    * If there is a separate membership contribution this is the 'other one'. Otherwise there
1436    * is only one.
1437    *
1438    * @param $params
1439    *
1440    * @return float
1441    *
1442    * @throws \CiviCRM_API3_Exception
1443    */
1444   protected function getMainContributionAmount($params) {
1445     if (!empty($params['selectMembership'])) {
1446       if (empty($params['amount']) && !$this->_separateMembershipPayment) {
1447         return CRM_Member_BAO_MembershipType::getMembershipType($params['selectMembership'])['minimum_fee'] ?? 0;
1448       }
1449     }
1450     return $params['amount'] ?? 0;
1451   }
1452
1453   /**
1454    * Wrapper for processAmount that also sets autorenew.
1455    *
1456    * @param $fields
1457    *   This is the output of the function CRM_Price_BAO_PriceSet::getSetDetail($priceSetID, FALSE, FALSE);
1458    *   And, it would make sense to introduce caching into that function and call it from here rather than
1459    *   require the $fields array which is passed from pillar to post around the form in order to pass it in here.
1460    * @param array $params
1461    *   Params reflecting form input e.g with fields 'price_5' => 7, 'price_8' => array(7, 8)
1462    * @param $lineItems
1463    *   Line item array to be altered.
1464    * @param int $priceSetID
1465    */
1466   public function processAmountAndGetAutoRenew($fields, &$params, &$lineItems, $priceSetID = NULL) {
1467     CRM_Price_BAO_PriceSet::processAmount($fields, $params, $lineItems, $priceSetID);
1468     $autoRenew = [];
1469     $autoRenew[0] = $autoRenew[1] = $autoRenew[2] = 0;
1470     foreach ($lineItems as $lineItem) {
1471       if (!empty($lineItem['auto_renew']) &&
1472         is_numeric($lineItem['auto_renew'])
1473       ) {
1474         $autoRenew[$lineItem['auto_renew']] += $lineItem['line_total'];
1475       }
1476     }
1477     if (count($autoRenew) > 1) {
1478       $params['autoRenew'] = $autoRenew;
1479     }
1480   }
1481
1482 }