CRM/Core/Payment/Form.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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  * Class for constructing the payment processor block.
  30  *
  31  * @package CRM
  32  * @copyright CiviCRM LLC (c) 2004-2016
  33  */
  34 class CRM_Core_Payment_Form {
  35
  36
  37   /**
  38    * Add payment fields depending on payment processor.
  39    *
  40    * The payment processor can implement the following functions to override the built in fields.
  41    *
  42    *  - getPaymentFormFields()
  43    *  - getPaymentFormFieldsMetadata()
  44    *  (planned - getBillingDetailsFormFields(), getBillingDetailsFormFieldsMetadata()
  45    *
  46    *  Note that this code is written to accommodate the possibility CiviCRM will switch to implementing pay later as a manual processor in future
  47    *
  48    * @param CRM_Contribute_Form_AbstractEditPayment|CRM_Contribute_Form_Contribution_Main $form
  49    * @param array $processor
  50    *   Array of properties including 'object' as loaded from CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors.
  51    * @param int $billing_profile_id
  52    *   Display billing fields even for pay later.
  53    * @param bool $isBackOffice
  54    *   Is this a back office function? If so the option to suppress the cvn needs to be evaluated.
  55    */
  56   static public function setPaymentFieldsByProcessor(&$form, $processor, $billing_profile_id = NULL, $isBackOffice = FALSE) {
  57     $form->billingFieldSets = array();
  58     // Load the pay-later processor
  59     // @todo load this right up where the other processors are loaded initially.
  60     if (empty($processor)) {
  61       $processor = CRM_Financial_BAO_PaymentProcessor::getPayment(0);
  62     }
  63
  64     $processor['object']->setBillingProfile($billing_profile_id);
  65     $paymentTypeName = self::getPaymentTypeName($processor);
  66     $paymentTypeLabel = self::getPaymentTypeLabel($processor);
  67     $form->assign('paymentTypeName', $paymentTypeName);
  68     $form->assign('paymentTypeLabel', $paymentTypeLabel);
  69     $form->_paymentFields = $form->billingFieldSets[$paymentTypeName]['fields'] = self::getPaymentFieldMetadata($processor);
  70     $form->_paymentFields = array_merge($form->_paymentFields, self::getBillingAddressMetadata($processor, $form->_bltID));
  71     $form->assign('paymentFields', self::getPaymentFields($processor));
  72     self::setBillingAddressFields($form, $processor);
  73     // @todo - this may be obsolete - although potentially it could be used to re-order things in the form.
  74     $form->billingFieldSets['billing_name_address-group']['fields'] = array();
  75   }
  76
  77   /**
  78    * Add general billing fields.
  79    *
  80    * @param CRM_Core_Form $form
  81    * @param CRM_Core_Payment $processor
  82    */
  83   static protected function setBillingAddressFields(&$form, $processor) {
  84     $billingID = $form->_bltID;
  85     $smarty = CRM_Core_Smarty::singleton();
  86     $smarty->assign('billingDetailsFields', self::getBillingAddressFields($processor, $billingID));
  87   }
  88
  89   /**
  90    * Add the payment fields to the template.
  91    *
  92    * Generally this is the payment processor fields & the billing fields required
  93    * for the payment processor. However, this has been complicated by adding
  94    * pay later billing fields into this mix
  95    *
  96    * We now have the situation where the required fields cannot be set as required
  97    * on the form level if they are required for the payment processor, as another
  98    * processor might be selected and the validation will then be incorrect.
  99    *
 100    * However, if they are required for pay later we DO set them on the form level,
 101    * presumably assuming they will be required whatever happens.
 102    *
 103    * As a side-note this seems to re-enforce the argument for making pay later
 104    * operate as a payment processor rather than as a 'special thing on its own'.
 105    *
 106    * @param CRM_Core_Form $form
 107    *   Form that the payment fields are to be added to.
 108    * @param array $paymentFields
 109    *   Fields that are to be shown on the payment form.
 110    */
 111   protected static function addCommonFields(&$form, $paymentFields) {
 112     $requiredPaymentFields = array();
 113     foreach ($paymentFields as $name => $field) {
 114       if (!empty($field['cc_field'])) {
 115         if ($field['htmlType'] == 'chainSelect') {
 116           $form->addChainSelect($field['name'], array('required' => FALSE));
 117         }
 118         else {
 119           $form->add($field['htmlType'],
 120             $field['name'],
 121             $field['title'],
 122             $field['attributes'],
 123             FALSE
 124           );
 125         }
 126       }
 127       // This will cause the fields to be marked as required - but it is up to the payment processor to
 128       // validate it.
 129       $requiredPaymentFields[$field['name']] = $field['is_required'];
 130     }
 131     $form->assign('requiredPaymentFields', $requiredPaymentFields);
 132   }
 133
 134   /**
 135    * Get the payment fields that apply to this processor.
 136    *
 137    * @param array $paymentProcessor
 138    *
 139    * @todo sometimes things like the country alter the required fields (e.g direct debit fields). We should possibly
 140    * set these before calling getPaymentFormFields (as we identify them).
 141    *
 142    * @return array
 143    */
 144   public static function getPaymentFields($paymentProcessor) {
 145     $paymentProcessorObject = Civi\Payment\System::singleton()->getByProcessor($paymentProcessor);
 146     return $paymentProcessorObject->getPaymentFormFields();
 147   }
 148
 149   /**
 150    * @param array $paymentProcessor
 151    *
 152    * @return array
 153    */
 154   public static function getPaymentFieldMetadata($paymentProcessor) {
 155     $paymentProcessorObject = Civi\Payment\System::singleton()->getByProcessor($paymentProcessor);
 156     return array_intersect_key($paymentProcessorObject->getPaymentFormFieldsMetadata(), array_flip(self::getPaymentFields($paymentProcessor)));
 157   }
 158
 159   /**
 160    * Get the billing fields that apply to this processor.
 161    *
 162    * @param array $paymentProcessor
 163    * @param int $billingLocationID
 164    *   ID of billing location type.
 165    *
 166    * @todo sometimes things like the country alter the required fields (e.g postal code). We should possibly
 167    * set these before calling getPaymentFormFields (as we identify them).
 168    *
 169    * @return array
 170    */
 171   public static function getBillingAddressFields($paymentProcessor, $billingLocationID) {
 172     return $paymentProcessor['object']->getBillingAddressFields($billingLocationID);
 173   }
 174
 175   /**
 176    * @param array $paymentProcessor
 177    *
 178    * @param int $billingLocationID
 179    *
 180    * @return array
 181    * @throws \CRM_Core_Exception
 182    */
 183   public static function getBillingAddressMetadata($paymentProcessor, $billingLocationID) {
 184     $paymentProcessorObject = Civi\Payment\System::singleton()->getByProcessor($paymentProcessor);
 185     return array_intersect_key(
 186       $paymentProcessorObject->getBillingAddressFieldsMetadata($billingLocationID),
 187       array_flip(self::getBillingAddressFields($paymentProcessor, $billingLocationID))
 188     );
 189   }
 190
 191   /**
 192    * @param array $paymentProcessor
 193    *
 194    * @return string
 195    */
 196   public static function getPaymentTypeName($paymentProcessor) {
 197     return $paymentProcessor['object']->getPaymentTypeName();
 198   }
 199
 200   /**
 201    * @param array $paymentProcessor
 202    *
 203    * @return string
 204    */
 205   public static function getPaymentTypeLabel($paymentProcessor) {
 206     $paymentProcessorObject = Civi\Payment\System::singleton()->getByProcessor($paymentProcessor);
 207     return ts(($paymentProcessorObject->getPaymentTypeLabel()) . ' Information');
 208   }
 209
 210   /**
 211    * @param CRM_Contribute_Form_AbstractEditPayment|CRM_Contribute_Form_Contribution_Main|CRM_Core_Payment_ProcessorForm|CRM_Contribute_Form_UpdateBilling $form
 212    * @param array $processor
 213    *   Array of properties including 'object' as loaded from CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors.
 214    * @param int|string $billing_profile_id
 215    *   Id of a profile to be passed to the processor for the processor to merge with it's required fields.
 216    *   (currently only implemented by manual/ pay-later processor)
 217    *
 218    * @param bool $isBackOffice
 219    *   Is this a backoffice form. This could affect the display of the cvn or whether some processors show,
 220    *   although the distinction is losing it's meaning as front end forms are used for back office and a permission
 221    *   for the 'enter without cvn' is probably more appropriate. Paypal std does not support another user
 222    *   entering details but once again the issue is not back office but 'another user'.
 223    *
 224    * @return bool
 225    */
 226   public static function buildPaymentForm(&$form, $processor, $billing_profile_id, $isBackOffice) {
 227     //if the form has address fields assign to the template so the js can decide what billing fields to show
 228     $profileAddressFields = $form->get('profileAddressFields');
 229     if (!empty($profileAddressFields)) {
 230       $form->assign('profileAddressFields', $profileAddressFields);
 231     }
 232
 233     if (!empty($processor['object']) && $processor['object']->buildForm($form)) {
 234       return NULL;
 235     }
 236
 237     self::setPaymentFieldsByProcessor($form, $processor, $billing_profile_id, $isBackOffice);
 238     self::addCommonFields($form, $form->_paymentFields);
 239     self::addRules($form, $form->_paymentFields);
 240     return (!empty($form->_paymentFields));
 241   }
 242
 243   /**
 244    * @param CRM_Core_Form $form
 245    * @param array $paymentFields
 246    *   Array of properties including 'object' as loaded from CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors.
 247    * @param $paymentFields
 248    */
 249   protected static function addRules(&$form, $paymentFields) {
 250     foreach ($paymentFields as $paymentField => $fieldSpecs) {
 251       if (!empty($fieldSpecs['rules'])) {
 252         foreach ($fieldSpecs['rules'] as $rule) {
 253           $form->addRule($paymentField,
 254             $rule['rule_message'],
 255             $rule['rule_name'],
 256             $rule['rule_parameters']
 257           );
 258         }
 259       }
 260     }
 261   }
 262
 263   /**
 264    * Validate the payment instrument values before passing it to the payment processor.
 265    *
 266    * We want this to be able to be overridden by the payment processor, and default to using
 267    * this object's validCreditCard for credit cards (implemented as the default in the Payment class).
 268    *
 269    * @param int $payment_processor_id
 270    * @param array $values
 271    * @param array $errors
 272    * @param int $billing_profile_id
 273    */
 274   public static function validatePaymentInstrument($payment_processor_id, $values, &$errors, $billing_profile_id) {
 275     $payment = Civi\Payment\System::singleton()->getById($payment_processor_id);
 276     $payment->setBillingProfile($billing_profile_id);
 277     $payment->validatePaymentInstrument($values, $errors);
 278   }
 279
 280   /**
 281    * The credit card pseudo constant results only the CC label, not the key ID
 282    * So we normalize the name to use it as a CSS class.
 283    */
 284   public static function getCreditCardCSSNames($creditCards = array()) {
 285     $creditCardTypes = array();
 286     if (empty($creditCards)) {
 287       $creditCards = CRM_Contribute_PseudoConstant::creditCard();
 288     }
 289     foreach ($creditCards as $key => $name) {
 290       // Replace anything not css-friendly by an underscore
 291       // Non-latin names will not like this, but so many things are wrong with
 292       // the credit-card type configurations already.
 293       $key = str_replace(' ', '', $key);
 294       $key = preg_replace('/[^a-zA-Z0-9]/', '_', $key);
 295       $key = strtolower($key);
 296       $creditCardTypes[$key] = $name;
 297     }
 298     return $creditCardTypes;
 299   }
 300
 301   /**
 302    * Set default values for the form.
 303    *
 304    * @param CRM_Core_Form $form
 305    * @param int $contactID
 306    */
 307   public static function setDefaultValues(&$form, $contactID) {
 308     $billingDefaults = $form->getProfileDefaults('Billing', $contactID);
 309     $form->_defaults = array_merge($form->_defaults, $billingDefaults);
 310
 311     // set default country & state from config if no country set
 312     // note the effect of this is to set the billing country to default to the site default
 313     // country if the person has an address but no country (for anonymous country is set above)
 314     // this could have implications if the billing profile is filled but hidden.
 315     // this behaviour has been in place for a while but the use of js to hide things has increased
 316     if (empty($form->_defaults["billing_country_id-{$form->_bltID}"])) {
 317       $form->_defaults["billing_country_id-{$form->_bltID}"] = CRM_Core_Config::singleton()->defaultContactCountry;
 318     }
 319     if (empty($form->_defaults["billing_state_province_id-{$form->_bltID}"])) {
 320       $form->_defaults["billing_state_province_id-{$form->_bltID}"] = CRM_Core_Config::singleton()
 321         ->defaultContactStateProvince;
 322     }
 323   }
 324
 325   /**
 326    * Make sure that credit card number and cvv are valid.
 327    * Called within the scope of a QF formRule function
 328    *
 329    * @param array $values
 330    * @param array $errors
 331    */
 332   public static function validateCreditCard($values, &$errors) {
 333     if (!empty($values['credit_card_type']) || !empty($values['credit_card_number'])) {
 334       if (!empty($values['credit_card_number']) &&
 335         !CRM_Utils_Rule::creditCardNumber($values['credit_card_number'], $values['credit_card_type'])
 336       ) {
 337         $errors['credit_card_number'] = ts('Please enter a valid Card Number');
 338       }
 339       if (!empty($values['cvv2']) &&
 340         !CRM_Utils_Rule::cvv($values['cvv2'], $values['credit_card_type'])
 341       ) {
 342         $errors['cvv2'] = ts('Please enter a valid Card Verification Number');
 343       }
 344     }
 345   }
 346
 347   /**
 348    * Map address fields.
 349    *
 350    * @param int $id
 351    * @param array $src
 352    * @param array $dst
 353    * @param bool $reverse
 354    */
 355   public static function mapParams($id, $src, &$dst, $reverse = FALSE) {
 356     // Set text version of state & country if present.
 357     if (isset($src["billing_state_province_id-{$id}"])) {
 358       $src["billing_state_province-{$id}"] = CRM_Core_PseudoConstant::stateProvinceAbbreviation($src["billing_state_province_id-{$id}"]);
 359     }
 360     if (isset($src["billing_country_id-{$id}"])) {
 361       $src["billing_country-{$id}"] = CRM_Core_PseudoConstant::countryIsoCode($src["billing_country_id-{$id}"]);;
 362     };
 363     $map = array(
 364       'first_name' => 'billing_first_name',
 365       'middle_name' => 'billing_middle_name',
 366       'last_name' => 'billing_last_name',
 367       'email' => "email-$id",
 368       'street_address' => "billing_street_address-$id",
 369       'supplemental_address_1' => "billing_supplemental_address_1-$id",
 370       'city' => "billing_city-$id",
 371       'state_province' => "billing_state_province-$id",
 372       'postal_code' => "billing_postal_code-$id",
 373       'country' => "billing_country-$id",
 374       'contactID' => 'contact_id',
 375     );
 376
 377     foreach ($map as $n => $v) {
 378       if (!$reverse) {
 379         if (isset($src[$n])) {
 380           $dst[$v] = $src[$n];
 381         }
 382       }
 383       else {
 384         if (isset($src[$v])) {
 385           $dst[$n] = $src[$v];
 386         }
 387       }
 388     }
 389   }
 390
 391   /**
 392    * Get the credit card expiration month.
 393    * The date format for this field should typically be "M Y" (ex: Feb 2011) or "m Y" (02 2011)
 394    * See CRM-9017
 395    *
 396    * @param $src
 397    *
 398    * @return int
 399    */
 400   public static function getCreditCardExpirationMonth($src) {
 401     if ($month = CRM_Utils_Array::value('M', $src['credit_card_exp_date'])) {
 402       return $month;
 403     }
 404
 405     return CRM_Utils_Array::value('m', $src['credit_card_exp_date']);
 406   }
 407
 408   /**
 409    * Get the credit card expiration year.
 410    * The date format for this field should typically be "M Y" (ex: Feb 2011) or "m Y" (02 2011)
 411    * This function exists only to make it consistent with getCreditCardExpirationMonth
 412    *
 413    * @param $src
 414    *
 415    * @return int
 416    */
 417   public static function getCreditCardExpirationYear($src) {
 418     return CRM_Utils_Array::value('Y', $src['credit_card_exp_date']);
 419   }
 420
 421 }