CRM/Contribute/Form/ContributionBase.php

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