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