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 = array();
  96
  97   /**
  98    * The fields involved in this contribution page
  99    *
 100    * @var array
 101    */
 102   public $_fields = array();
 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 = array();
 312       $this->_fields = array();
 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 = array(
 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 = array();
 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 = array(
 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, array(
 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, array(
 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
 584     //fix for CRM-3767
 585     $isMonetary = FALSE;
 586     if ($this->_amount > 0.0) {
 587       $isMonetary = TRUE;
 588     }
 589     elseif (!empty($this->_params['selectMembership'])) {
 590       $memFee = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $this->_params['selectMembership'], 'minimum_fee');
 591       if ($memFee > 0.0) {
 592         $isMonetary = TRUE;
 593       }
 594     }
 595
 596     // The concept of contributeMode is deprecated.
 597     // The payment processor object can provide info about the fields it shows.
 598     if ($isMonetary && is_a($this->_paymentProcessor['object'], 'CRM_Core_Payment')) {
 599       /** @var  $paymentProcessorObject \CRM_Core_Payment */
 600       $paymentProcessorObject = $this->_paymentProcessor['object'];
 601
 602       $paymentFields = $paymentProcessorObject->getPaymentFormFields();
 603       foreach ($paymentFields as $index => $paymentField) {
 604         if (!isset($this->_params[$paymentField])) {
 605           unset($paymentFields[$index]);
 606           continue;
 607         }
 608         if ($paymentField === 'credit_card_exp_date') {
 609           $date = CRM_Utils_Date::format(CRM_Utils_Array::value('credit_card_exp_date', $this->_params));
 610           $date = CRM_Utils_Date::mysqlToIso($date);
 611           $this->assign('credit_card_exp_date', $date);
 612         }
 613         elseif ($paymentField === 'credit_card_number') {
 614           $this->assign('credit_card_number',
 615             CRM_Utils_System::mungeCreditCard(CRM_Utils_Array::value('credit_card_number', $this->_params))
 616           );
 617         }
 618         elseif ($paymentField === 'credit_card_type') {
 619           $this->assign('credit_card_type', CRM_Core_PseudoConstant::getLabel(
 620             'CRM_Core_BAO_FinancialTrxn',
 621             'card_type_id',
 622             CRM_Core_PseudoConstant::getKey('CRM_Core_BAO_FinancialTrxn', 'card_type_id', $this->_params['credit_card_type'])
 623           ));
 624         }
 625         else {
 626           $this->assign($paymentField, $this->_params[$paymentField]);
 627         }
 628       }
 629       $this->assign('paymentFieldsetLabel', CRM_Core_Payment_Form::getPaymentLabel($paymentProcessorObject));
 630       $this->assign('paymentFields', $paymentFields);
 631
 632     }
 633
 634     $this->assign('email',
 635       $this->controller->exportValue('Main', "email-{$this->_bltID}")
 636     );
 637
 638     // also assign the receipt_text
 639     if (isset($this->_values['receipt_text'])) {
 640       $this->assign('receipt_text', $this->_values['receipt_text']);
 641     }
 642   }
 643
 644   /**
 645    * Add the custom fields.
 646    *
 647    * @param int $id
 648    * @param string $name
 649    * @param bool $viewOnly
 650    * @param null $profileContactType
 651    * @param array $fieldTypes
 652    */
 653   public function buildCustom($id, $name, $viewOnly = FALSE, $profileContactType = NULL, $fieldTypes = NULL) {
 654     if ($id) {
 655       $contactID = $this->getContactID();
 656
 657       // we don't allow conflicting fields to be
 658       // configured via profile - CRM 2100
 659       $fieldsToIgnore = array(
 660         'receive_date' => 1,
 661         'trxn_id' => 1,
 662         'invoice_id' => 1,
 663         'net_amount' => 1,
 664         'fee_amount' => 1,
 665         'non_deductible_amount' => 1,
 666         'total_amount' => 1,
 667         'amount_level' => 1,
 668         'contribution_status_id' => 1,
 669         // @todo replace payment_instrument with payment instrument id.
 670         // both are available now but the id field is the most consistent.
 671         'payment_instrument' => 1,
 672         'payment_instrument_id' => 1,
 673         'contribution_check_number' => 1,
 674         'financial_type' => 1,
 675       );
 676
 677       $fields = CRM_Core_BAO_UFGroup::getFields($id, FALSE, CRM_Core_Action::ADD, NULL, NULL, FALSE,
 678         NULL, FALSE, NULL, CRM_Core_Permission::CREATE, NULL
 679       );
 680
 681       if ($fields) {
 682         // determine if email exists in profile so we know if we need to manually insert CRM-2888, CRM-15067
 683         foreach ($fields as $key => $field) {
 684           if (substr($key, 0, 6) == 'email-' &&
 685               !in_array($profileContactType, array('honor', 'onbehalf'))
 686           ) {
 687             $this->_emailExists = TRUE;
 688             $this->set('emailExists', TRUE);
 689           }
 690         }
 691
 692         if (array_intersect_key($fields, $fieldsToIgnore)) {
 693           $fields = array_diff_key($fields, $fieldsToIgnore);
 694           CRM_Core_Session::setStatus(ts('Some of the profile fields cannot be configured for this page.'), ts('Warning'), 'alert');
 695         }
 696
 697         //remove common fields only if profile is not configured for onbehalf/honor
 698         if (!in_array($profileContactType, array('honor', 'onbehalf'))) {
 699           $fields = array_diff_key($fields, $this->_fields);
 700         }
 701
 702         CRM_Core_BAO_Address::checkContactSharedAddressFields($fields, $contactID);
 703         $addCaptcha = FALSE;
 704         // fetch file preview when not submitted yet, like in online contribution Confirm and ThankYou page
 705         $viewOnlyFileValues = empty($profileContactType) ? array() : array($profileContactType => array());
 706         foreach ($fields as $key => $field) {
 707           if ($viewOnly &&
 708             isset($field['data_type']) &&
 709             $field['data_type'] == 'File' || ($viewOnly && $field['name'] == 'image_URL')
 710           ) {
 711             //retrieve file value from submitted values on basis of $profileContactType
 712             $fileValue = CRM_Utils_Array::value($key, $this->_params);
 713             if (!empty($profileContactType) && !empty($this->_params[$profileContactType])) {
 714               $fileValue = CRM_Utils_Array::value($key, $this->_params[$profileContactType]);
 715             }
 716
 717             if ($fileValue) {
 718               $path = CRM_Utils_Array::value('name', $fileValue);
 719               $fileType = CRM_Utils_Array::value('type', $fileValue);
 720               $fileValue = CRM_Utils_File::getFileURL($path, $fileType);
 721             }
 722
 723             // format custom file value fetched from submitted value
 724             if ($profileContactType) {
 725               $viewOnlyFileValues[$profileContactType][$key] = $fileValue;
 726             }
 727             else {
 728               $viewOnlyFileValues[$key] = $fileValue;
 729             }
 730
 731             // On viewOnly use-case (as in online contribution Confirm page) we no longer need to set
 732             // required property because being required file is already uploaded while registration
 733             $field['is_required'] = FALSE;
 734           }
 735           if ($profileContactType) {
 736             //Since we are showing honoree name separately so we are removing it from honoree profile just for display
 737             if ($profileContactType == 'honor') {
 738               $honoreeNamefields = array(
 739                 'prefix_id',
 740                 'first_name',
 741                 'last_name',
 742                 'suffix_id',
 743                 'organization_name',
 744                 'household_name',
 745               );
 746               if (in_array($field['name'], $honoreeNamefields)) {
 747                 unset($fields[$field['name']]);
 748                 continue;
 749               }
 750             }
 751             if (!empty($fieldTypes) && in_array($field['field_type'], $fieldTypes)) {
 752               CRM_Core_BAO_UFGroup::buildProfile(
 753                 $this,
 754                 $field,
 755                 CRM_Profile_Form::MODE_CREATE,
 756                 $contactID,
 757                 TRUE,
 758                 $profileContactType
 759               );
 760               $this->_fields[$profileContactType][$key] = $field;
 761             }
 762             else {
 763               unset($fields[$key]);
 764             }
 765           }
 766           else {
 767             CRM_Core_BAO_UFGroup::buildProfile(
 768               $this,
 769               $field,
 770               CRM_Profile_Form::MODE_CREATE,
 771               $contactID,
 772               TRUE
 773             );
 774             $this->_fields[$key] = $field;
 775           }
 776           // CRM-11316 Is ReCAPTCHA enabled for this profile AND is this an anonymous visitor
 777           if ($field['add_captcha'] && !$this->_userID) {
 778             $addCaptcha = TRUE;
 779           }
 780         }
 781
 782         $this->assign($name, $fields);
 783
 784         if ($profileContactType && count($viewOnlyFileValues[$profileContactType])) {
 785           $this->assign('viewOnlyPrefixFileValues', $viewOnlyFileValues);
 786         }
 787         elseif (count($viewOnlyFileValues)) {
 788           $this->assign('viewOnlyFileValues', $viewOnlyFileValues);
 789         }
 790
 791         if ($addCaptcha && !$viewOnly) {
 792           $this->enableCaptchaOnForm();
 793         }
 794       }
 795     }
 796   }
 797
 798   /**
 799    * Enable ReCAPTCHA on Contribution form
 800    */
 801   protected function enableCaptchaOnForm() {
 802     $captcha = CRM_Utils_ReCAPTCHA::singleton();
 803     if ($captcha->hasSettingsAvailable()) {
 804       $captcha->add($this);
 805       $this->assign('isCaptcha', TRUE);
 806     }
 807   }
 808
 809   /**
 810    * Display ReCAPTCHA warning on Contribution form
 811    */
 812   protected function displayCaptchaWarning() {
 813     if (CRM_Core_Permission::check("administer CiviCRM")) {
 814       $captcha = CRM_Utils_ReCAPTCHA::singleton();
 815       if (!$captcha->hasSettingsAvailable()) {
 816         $this->assign('displayCaptchaWarning', TRUE);
 817       }
 818     }
 819   }
 820
 821   /**
 822    * Check if ReCAPTCHA has to be added on Contribution form forcefully.
 823    */
 824   protected function hasToAddForcefully() {
 825     $captcha = CRM_Utils_ReCAPTCHA::singleton();
 826     return $captcha->hasToAddForcefully();
 827   }
 828
 829   /**
 830    * Add onbehalf/honoree profile fields and native module fields.
 831    *
 832    * @param int $id
 833    * @param CRM_Core_Form $form
 834    */
 835   public function buildComponentForm($id, $form) {
 836     if (empty($id)) {
 837       return;
 838     }
 839
 840     $contactID = $this->getContactID();
 841
 842     foreach (array('soft_credit', 'on_behalf') as $module) {
 843       if ($module == 'soft_credit') {
 844         if (empty($form->_values['honoree_profile_id'])) {
 845           continue;
 846         }
 847
 848         if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $form->_values['honoree_profile_id'], 'is_active')) {
 849           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.'));
 850         }
 851
 852         $profileContactType = CRM_Core_BAO_UFGroup::getContactType($form->_values['honoree_profile_id']);
 853         $requiredProfileFields = array(
 854           'Individual' => array('first_name', 'last_name'),
 855           'Organization' => array('organization_name', 'email'),
 856           'Household' => array('household_name', 'email'),
 857         );
 858         $validProfile = CRM_Core_BAO_UFGroup::checkValidProfile($form->_values['honoree_profile_id'], $requiredProfileFields[$profileContactType]);
 859         if (!$validProfile) {
 860           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.'));
 861         }
 862
 863         foreach (array('honor_block_title', 'honor_block_text') as $name) {
 864           $form->assign($name, $form->_values[$name]);
 865         }
 866
 867         $softCreditTypes = CRM_Core_OptionGroup::values("soft_credit_type", FALSE);
 868
 869         // radio button for Honor Type
 870         foreach ($form->_values['soft_credit_types'] as $value) {
 871           $honorTypes[$value] = $form->createElement('radio', NULL, NULL, $softCreditTypes[$value], $value);
 872         }
 873         $form->addGroup($honorTypes, 'soft_credit_type_id', NULL)->setAttribute('allowClear', TRUE);
 874
 875         $honoreeProfileFields = CRM_Core_BAO_UFGroup::getFields(
 876           $this->_values['honoree_profile_id'], FALSE,
 877           NULL, NULL,
 878           NULL, FALSE,
 879           NULL, TRUE,
 880           NULL, CRM_Core_Permission::CREATE
 881         );
 882         $form->assign('honoreeProfileFields', $honoreeProfileFields);
 883
 884         // add the form elements
 885         foreach ($honoreeProfileFields as $name => $field) {
 886           // If soft credit type is not chosen then make omit requiredness from honoree profile fields
 887           if (count($form->_submitValues) &&
 888             empty($form->_submitValues['soft_credit_type_id']) &&
 889             !empty($field['is_required'])
 890           ) {
 891             $field['is_required'] = FALSE;
 892           }
 893           CRM_Core_BAO_UFGroup::buildProfile($form, $field, CRM_Profile_Form::MODE_CREATE, NULL, FALSE, FALSE, NULL, 'honor');
 894         }
 895       }
 896       else {
 897         if (empty($form->_values['onbehalf_profile_id'])) {
 898           continue;
 899         }
 900
 901         if (!CRM_Core_DAO::getFieldValue('CRM_Core_DAO_UFGroup', $form->_values['onbehalf_profile_id'], 'is_active')) {
 902           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.'));
 903         }
 904
 905         $member = CRM_Member_BAO_Membership::getMembershipBlock($form->_id);
 906         if (empty($member['is_active'])) {
 907           $msg = ts('Mixed profile not allowed for on behalf of registration/sign up.');
 908           $onBehalfProfile = CRM_Core_BAO_UFGroup::profileGroups($form->_values['onbehalf_profile_id']);
 909           foreach (
 910             array(
 911               'Individual',
 912               'Organization',
 913               'Household',
 914             ) as $contactType
 915           ) {
 916             if (in_array($contactType, $onBehalfProfile) &&
 917               (in_array('Membership', $onBehalfProfile) ||
 918                 in_array('Contribution', $onBehalfProfile)
 919               )
 920             ) {
 921               CRM_Core_Error::fatal($msg);
 922             }
 923           }
 924         }
 925
 926         if ($contactID) {
 927           // retrieve all permissioned organizations of contact $contactID
 928           $organizations = CRM_Contact_BAO_Relationship::getPermissionedContacts($contactID, NULL, NULL, 'Organization');
 929
 930           if (count($organizations)) {
 931             // Related org url - pass checksum if needed
 932             $args = array(
 933               'ufId' => $form->_values['onbehalf_profile_id'],
 934               'cid' => '',
 935             );
 936             if (!empty($_GET['cs'])) {
 937               $args = array(
 938                 'ufId' => $form->_values['onbehalf_profile_id'],
 939                 'uid' => $this->_contactID,
 940                 'cs' => $_GET['cs'],
 941                 'cid' => '',
 942               );
 943             }
 944             $locDataURL = CRM_Utils_System::url('civicrm/ajax/permlocation', $args, FALSE, NULL, FALSE);
 945             $form->assign('locDataURL', $locDataURL);
 946           }
 947           if (count($organizations) > 0) {
 948             $form->add('select', 'onbehalfof_id', '', CRM_Utils_Array::collect('name', $organizations));
 949
 950             $orgOptions = array(
 951               0 => ts('Select an existing organization'),
 952               1 => ts('Enter a new organization'),
 953             );
 954             $form->addRadio('org_option', ts('options'), $orgOptions);
 955             $form->setDefaults(array('org_option' => 0));
 956           }
 957         }
 958
 959         $form->assign('fieldSetTitle', ts(CRM_Core_BAO_UFGroup::getTitle($form->_values['onbehalf_profile_id'])));
 960
 961         if (CRM_Utils_Array::value('is_for_organization', $form->_values)) {
 962           if ($form->_values['is_for_organization'] == 2) {
 963             $form->assign('onBehalfRequired', TRUE);
 964           }
 965           else {
 966             $form->addElement('checkbox', 'is_for_organization',
 967               $form->_values['for_organization'],
 968               NULL
 969             );
 970           }
 971         }
 972
 973         $profileFields = CRM_Core_BAO_UFGroup::getFields(
 974           $form->_values['onbehalf_profile_id'],
 975           FALSE, CRM_Core_Action::VIEW, NULL,
 976           NULL, FALSE, NULL, FALSE, NULL,
 977           CRM_Core_Permission::CREATE, NULL
 978         );
 979
 980         $form->assign('onBehalfOfFields', $profileFields);
 981         if (!empty($form->_submitValues['onbehalf'])) {
 982           if (!empty($form->_submitValues['onbehalfof_id'])) {
 983             $form->assign('submittedOnBehalf', $form->_submitValues['onbehalfof_id']);
 984           }
 985           $form->assign('submittedOnBehalfInfo', json_encode(str_replace('"', '\"', $form->_submitValues['onbehalf']), JSON_HEX_APOS));
 986         }
 987
 988         $fieldTypes = array('Contact', 'Organization');
 989         if (!empty($form->_membershipBlock)) {
 990           $fieldTypes = array_merge($fieldTypes, array('Membership'));
 991         }
 992         $contactSubType = CRM_Contact_BAO_ContactType::subTypes('Organization');
 993         $fieldTypes = array_merge($fieldTypes, $contactSubType);
 994
 995         foreach ($profileFields as $name => $field) {
 996           if (in_array($field['field_type'], $fieldTypes)) {
 997             list($prefixName, $index) = CRM_Utils_System::explode('-', $name, 2);
 998             if (in_array($prefixName, array('organization_name', 'email')) && empty($field['is_required'])) {
 999               $field['is_required'] = 1;
1000             }
1001             if (count($form->_submitValues) &&
1002               empty($form->_submitValues['is_for_organization']) &&
1003               $form->_values['is_for_organization'] == 1 &&
1004               !empty($field['is_required'])
1005             ) {
1006               $field['is_required'] = FALSE;
1007             }
1008             CRM_Core_BAO_UFGroup::buildProfile($form, $field, NULL, NULL, FALSE, 'onbehalf', NULL, 'onbehalf');
1009           }
1010         }
1011       }
1012     }
1013
1014   }
1015
1016   /**
1017    * Check template file exists.
1018    *
1019    * @param string $suffix
1020    *
1021    * @return null|string
1022    */
1023   public function checkTemplateFileExists($suffix = NULL) {
1024     if ($this->_id) {
1025       $templateFile = "CRM/Contribute/Form/Contribution/{$this->_id}/{$this->_name}.{$suffix}tpl";
1026       $template = CRM_Core_Form::getTemplate();
1027       if ($template->template_exists($templateFile)) {
1028         return $templateFile;
1029       }
1030     }
1031     return NULL;
1032   }
1033
1034   /**
1035    * Use the form name to create the tpl file name.
1036    *
1037    * @return string
1038    */
1039   public function getTemplateFileName() {
1040     $fileName = $this->checkTemplateFileExists();
1041     return $fileName ? $fileName : parent::getTemplateFileName();
1042   }
1043
1044   /**
1045    * Add the extra.tpl in.
1046    *
1047    * Default extra tpl file basically just replaces .tpl with .extra.tpl
1048    * i.e. we do not override - why isn't this done at the CRM_Core_Form level?
1049    *
1050    * @return string
1051    */
1052   public function overrideExtraTemplateFileName() {
1053     $fileName = $this->checkTemplateFileExists('extra.');
1054     return $fileName ? $fileName : parent::overrideExtraTemplateFileName();
1055   }
1056
1057   /**
1058    * Authenticate pledge user during online payment.
1059    */
1060   public function authenticatePledgeUser() {
1061     //get the userChecksum and contact id
1062     $userChecksum = CRM_Utils_Request::retrieve('cs', 'String', $this);
1063     $contactID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
1064
1065     //get pledge status and contact id
1066     $pledgeValues = array();
1067     $pledgeParams = array('id' => $this->_values['pledge_id']);
1068     $returnProperties = array('contact_id', 'status_id');
1069     CRM_Core_DAO::commonRetrieve('CRM_Pledge_DAO_Pledge', $pledgeParams, $pledgeValues, $returnProperties);
1070
1071     //get all status
1072     $allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
1073     $validStatus = array(
1074       array_search('Pending', $allStatus),
1075       array_search('In Progress', $allStatus),
1076       array_search('Overdue', $allStatus),
1077     );
1078
1079     $validUser = FALSE;
1080     if ($this->_userID &&
1081       $this->_userID == $pledgeValues['contact_id']
1082     ) {
1083       //check for authenticated  user.
1084       $validUser = TRUE;
1085     }
1086     elseif ($userChecksum && $pledgeValues['contact_id']) {
1087       //check for anonymous user.
1088       $validUser = CRM_Contact_BAO_Contact_Utils::validChecksum($pledgeValues['contact_id'], $userChecksum);
1089
1090       //make sure cid is same as pledge contact id
1091       if ($validUser && ($pledgeValues['contact_id'] != $contactID)) {
1092         $validUser = FALSE;
1093       }
1094     }
1095
1096     if (!$validUser) {
1097       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."));
1098     }
1099
1100     //check for valid pledge status.
1101     if (!in_array($pledgeValues['status_id'], $validStatus)) {
1102       CRM_Core_Error::fatal(ts('Oops. You cannot make a payment for this pledge - pledge status is %1.', array(1 => CRM_Utils_Array::value($pledgeValues['status_id'], $allStatus))));
1103     }
1104   }
1105
1106   /**
1107    * Cancel recurring contributions.
1108    *
1109    * In case user cancel recurring contribution,
1110    * When we get the control back from payment gate way
1111    * lets delete the recurring and related contribution.
1112    */
1113   public function cancelRecurring() {
1114     $isCancel = CRM_Utils_Request::retrieve('cancel', 'Boolean');
1115     if ($isCancel) {
1116       $isRecur = CRM_Utils_Request::retrieve('isRecur', 'Boolean');
1117       $recurId = CRM_Utils_Request::retrieve('recurId', 'Positive');
1118       //clean db for recurring contribution.
1119       if ($isRecur && $recurId) {
1120         CRM_Contribute_BAO_ContributionRecur::deleteRecurContribution($recurId);
1121       }
1122       $contribId = CRM_Utils_Request::retrieve('contribId', 'Positive');
1123       if ($contribId) {
1124         CRM_Contribute_BAO_Contribution::deleteContribution($contribId);
1125       }
1126     }
1127   }
1128
1129   /**
1130    * Build Membership  Block in Contribution Pages.
1131    *
1132    * @param int $cid
1133    *   Contact checked for having a current membership for a particular membership.
1134    * @param bool $isContributionMainPage
1135    *   Is this the main page? If so add form input fields.
1136    *   (or better yet don't have this functionality in a function shared with forms that don't share it).
1137    * @param int|array $selectedMembershipTypeID
1138    *   Selected membership id.
1139    * @param bool $thankPage
1140    *   Thank you page.
1141    * @param null $isTest
1142    *
1143    * @return bool
1144    *   Is this a separate membership payment
1145    */
1146   protected function buildMembershipBlock(
1147     $cid,
1148     $isContributionMainPage = FALSE,
1149     $selectedMembershipTypeID = NULL,
1150     $thankPage = FALSE,
1151     $isTest = NULL
1152   ) {
1153
1154     $separateMembershipPayment = FALSE;
1155     if ($this->_membershipBlock) {
1156       $this->_currentMemberships = array();
1157
1158       $membershipTypeIds = $membershipTypes = $radio = array();
1159       $membershipPriceset = (!empty($this->_priceSetId) && $this->_useForMember) ? TRUE : FALSE;
1160
1161       $allowAutoRenewMembership = $autoRenewOption = FALSE;
1162       $autoRenewMembershipTypeOptions = array();
1163
1164       $separateMembershipPayment = CRM_Utils_Array::value('is_separate_payment', $this->_membershipBlock);
1165
1166       if ($membershipPriceset) {
1167         foreach ($this->_priceSet['fields'] as $pField) {
1168           if (empty($pField['options'])) {
1169             continue;
1170           }
1171           foreach ($pField['options'] as $opId => $opValues) {
1172             if (empty($opValues['membership_type_id'])) {
1173               continue;
1174             }
1175             $membershipTypeIds[$opValues['membership_type_id']] = $opValues['membership_type_id'];
1176           }
1177         }
1178       }
1179       elseif (!empty($this->_membershipBlock['membership_types'])) {
1180         $membershipTypeIds = explode(',', $this->_membershipBlock['membership_types']);
1181       }
1182
1183       if (!empty($membershipTypeIds)) {
1184         //set status message if wrong membershipType is included in membershipBlock
1185         if (isset($this->_mid) && !$membershipPriceset) {
1186           $membershipTypeID = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership',
1187             $this->_mid,
1188             'membership_type_id'
1189           );
1190           if (!in_array($membershipTypeID, $membershipTypeIds)) {
1191             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');
1192           }
1193         }
1194
1195         $membershipTypeValues = CRM_Member_BAO_Membership::buildMembershipTypeValues($this, $membershipTypeIds);
1196         $this->_membershipTypeValues = $membershipTypeValues;
1197         $endDate = NULL;
1198
1199         // Check if we support auto-renew on this contribution page
1200         // FIXME: If any of the payment processors do NOT support recurring you cannot setup an
1201         //   auto-renew payment even if that processor is not selected.
1202         $allowAutoRenewOpt = TRUE;
1203         if (is_array($this->_paymentProcessors)) {
1204           foreach ($this->_paymentProcessors as $id => $val) {
1205             if ($id && !$val['is_recur']) {
1206               $allowAutoRenewOpt = FALSE;
1207             }
1208           }
1209         }
1210         foreach ($membershipTypeIds as $value) {
1211           $memType = $membershipTypeValues[$value];
1212           if ($selectedMembershipTypeID != NULL) {
1213             if ($memType['id'] == $selectedMembershipTypeID) {
1214               $this->assign('minimum_fee',
1215                 CRM_Utils_Array::value('minimum_fee', $memType)
1216               );
1217               $this->assign('membership_name', $memType['name']);
1218               if (!$thankPage && $cid) {
1219                 $membership = new CRM_Member_DAO_Membership();
1220                 $membership->contact_id = $cid;
1221                 $membership->membership_type_id = $memType['id'];
1222                 if ($membership->find(TRUE)) {
1223                   $this->assign('renewal_mode', TRUE);
1224                   $memType['current_membership'] = $membership->end_date;
1225                   $this->_currentMemberships[$membership->membership_type_id] = $membership->membership_type_id;
1226                 }
1227               }
1228               $membershipTypes[] = $memType;
1229             }
1230           }
1231           elseif ($memType['is_active']) {
1232
1233             if ($allowAutoRenewOpt) {
1234               $javascriptMethod = array('onclick' => "return showHideAutoRenew( this.value );");
1235               $autoRenewMembershipTypeOptions["autoRenewMembershipType_{$value}"] = (int) $memType['auto_renew'] * CRM_Utils_Array::value($value, CRM_Utils_Array::value('auto_renew', $this->_membershipBlock));
1236               $allowAutoRenewMembership = TRUE;
1237             }
1238             else {
1239               $javascriptMethod = NULL;
1240               $autoRenewMembershipTypeOptions["autoRenewMembershipType_{$value}"] = 0;
1241             }
1242
1243             //add membership type.
1244             $radio[$memType['id']] = $this->createElement('radio', NULL, NULL, NULL,
1245               $memType['id'], $javascriptMethod
1246             );
1247             if ($cid) {
1248               $membership = new CRM_Member_DAO_Membership();
1249               $membership->contact_id = $cid;
1250               $membership->membership_type_id = $memType['id'];
1251
1252               //show current membership, skip pending and cancelled membership records,
1253               //because we take first membership record id for renewal
1254               $membership->whereAdd('status_id != 5 AND status_id !=6');
1255
1256               if (!is_null($isTest)) {
1257                 $membership->is_test = $isTest;
1258               }
1259
1260               //CRM-4297
1261               $membership->orderBy('end_date DESC');
1262
1263               if ($membership->find(TRUE)) {
1264                 if (!$membership->end_date) {
1265                   unset($radio[$memType['id']]);
1266                   $this->assign('islifetime', TRUE);
1267                   continue;
1268                 }
1269                 $this->assign('renewal_mode', TRUE);
1270                 $this->_currentMemberships[$membership->membership_type_id] = $membership->membership_type_id;
1271                 $memType['current_membership'] = $membership->end_date;
1272                 if (!$endDate) {
1273                   $endDate = $memType['current_membership'];
1274                   $this->_defaultMemTypeId = $memType['id'];
1275                 }
1276                 if ($memType['current_membership'] < $endDate) {
1277                   $endDate = $memType['current_membership'];
1278                   $this->_defaultMemTypeId = $memType['id'];
1279                 }
1280               }
1281             }
1282             $membershipTypes[] = $memType;
1283           }
1284         }
1285       }
1286
1287       $this->assign('membershipBlock', $this->_membershipBlock);
1288       $this->assign('showRadio', $isContributionMainPage);
1289       $this->assign('membershipTypes', $membershipTypes);
1290       $this->assign('allowAutoRenewMembership', $allowAutoRenewMembership);
1291       $this->assign('autoRenewMembershipTypeOptions', json_encode($autoRenewMembershipTypeOptions));
1292       //give preference to user submitted auto_renew value.
1293       $takeUserSubmittedAutoRenew = (!empty($_POST) || $this->isSubmitted()) ? TRUE : FALSE;
1294       $this->assign('takeUserSubmittedAutoRenew', $takeUserSubmittedAutoRenew);
1295
1296       // Assign autorenew option (0:hide,1:optional,2:required) so we can use it in confirmation etc.
1297       $autoRenewOption = CRM_Price_BAO_PriceSet::checkAutoRenewForPriceSet($this->_priceSetId);
1298       //$selectedMembershipTypeID is retrieved as an array for membership priceset if multiple
1299       //options for different organisation is selected on the contribution page.
1300       if (is_numeric($selectedMembershipTypeID) && isset($membershipTypeValues[$selectedMembershipTypeID]['auto_renew'])) {
1301         $this->assign('autoRenewOption', $membershipTypeValues[$selectedMembershipTypeID]['auto_renew']);
1302       }
1303       else {
1304         $this->assign('autoRenewOption', $autoRenewOption);
1305       }
1306
1307       if ($isContributionMainPage) {
1308         if (!$membershipPriceset) {
1309           if (!$this->_membershipBlock['is_required']) {
1310             $this->assign('showRadioNoThanks', TRUE);
1311             $radio[''] = $this->createElement('radio', NULL, NULL, NULL, 'no_thanks', NULL);
1312             $this->addGroup($radio, 'selectMembership', NULL);
1313           }
1314           elseif ($this->_membershipBlock['is_required'] && count($radio) == 1) {
1315             $temp = array_keys($radio);
1316             $this->add('hidden', 'selectMembership', $temp[0], array('id' => 'selectMembership'));
1317             $this->assign('singleMembership', TRUE);
1318             $this->assign('showRadio', FALSE);
1319           }
1320           else {
1321             $this->addGroup($radio, 'selectMembership', NULL);
1322           }
1323
1324           $this->addRule('selectMembership', ts('Please select one of the memberships.'), 'required');
1325         }
1326
1327         if ((!$this->_values['is_pay_later'] || is_array($this->_paymentProcessors)) && ($allowAutoRenewMembership || $autoRenewOption)) {
1328           if ($autoRenewOption == 2) {
1329             $this->addElement('hidden', 'auto_renew', ts('Please renew my membership automatically.'));
1330           }
1331           else {
1332             $this->addElement('checkbox', 'auto_renew', ts('Please renew my membership automatically.'));
1333           }
1334         }
1335
1336       }
1337     }
1338
1339     return $separateMembershipPayment;
1340   }
1341
1342   /**
1343    * Determine if recurring parameters need to be added to the form parameters.
1344    *
1345    *  - is_recur
1346    *  - frequency_interval
1347    *  - frequency_unit
1348    *
1349    * For membership this is based on the membership type.
1350    *
1351    * This needs to be done before processing the pre-approval redirect where relevant on the main page or before any payment processing.
1352    *
1353    * Arguably the form should start to build $this->_params in the pre-process main page & use that array consistently throughout.
1354    */
1355   protected function setRecurringMembershipParams() {
1356     $selectedMembershipTypeID = CRM_Utils_Array::value('selectMembership', $this->_params);
1357     if ($selectedMembershipTypeID) {
1358       // @todo the price_x fields will ALWAYS allow us to determine the membership - so we should ignore
1359       // 'selectMembership' and calculate from the price_x fields so we have one method that always works
1360       // this is lazy & only catches when selectMembership is set, but the worst of all worlds would be to fix
1361       // this with an else (calculate for price set).
1362       $membershipTypes = CRM_Price_BAO_PriceSet::getMembershipTypesFromPriceSet($this->_priceSetId);
1363       if (in_array($selectedMembershipTypeID, $membershipTypes['autorenew_required'])
1364         || (in_array($selectedMembershipTypeID, $membershipTypes['autorenew_optional']) &&
1365           !empty($this->_params['is_recur']))
1366       ) {
1367         $this->_params['auto_renew'] = TRUE;
1368       }
1369     }
1370     if ((!empty($this->_params['selectMembership']) || !empty($this->_params['priceSetId']))
1371       && !empty($this->_paymentProcessor['is_recur']) &&
1372       CRM_Utils_Array::value('auto_renew', $this->_params)
1373       && empty($this->_params['is_recur']) && empty($this->_params['frequency_interval'])
1374     ) {
1375
1376       $this->_params['is_recur'] = $this->_values['is_recur'] = 1;
1377       // check if price set is not quick config
1378       if (!empty($this->_params['priceSetId']) && !CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $this->_params['priceSetId'], 'is_quick_config')) {
1379         list($this->_params['frequency_interval'], $this->_params['frequency_unit']) = CRM_Price_BAO_PriceSet::getRecurDetails($this->_params['priceSetId']);
1380       }
1381       else {
1382         // FIXME: set interval and unit based on selected membership type
1383         $this->_params['frequency_interval'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
1384           $this->_params['selectMembership'], 'duration_interval'
1385         );
1386         $this->_params['frequency_unit'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
1387           $this->_params['selectMembership'], 'duration_unit'
1388         );
1389       }
1390     }
1391   }
1392
1393 }