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