Towards CRM-20392 form cleanup, shared setting of ->mode
[civicrm-core.git] / CRM / Contribute / Form / AbstractEditPayment.php
1 <?php
2 /*
3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 usefusul, 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-2017
32 */
33
34 /**
35 * This class generates form components for processing a contribution
36 * CRM-16229 - During the event registration bulk action via search we
37 * need to inherit CRM_Contact_Form_Task so that we can inherit functions
38 * like getContactIds and make use of controller state. But this is not possible
39 * because CRM_Event_Form_Participant inherits this class.
40 * Ideal situation would be something like
41 * CRM_Event_Form_Participant extends CRM_Contact_Form_Task,
42 * CRM_Contribute_Form_AbstractEditPayment
43 * However this is not possible. Currently PHP does not support multiple
44 * inheritance. So work around solution is to extend this class with
45 * CRM_Contact_Form_Task which further extends CRM_Core_Form.
46 *
47 */
48 class CRM_Contribute_Form_AbstractEditPayment extends CRM_Contact_Form_Task {
49 public $_mode;
50
51 public $_action;
52
53 public $_bltID;
54
55 public $_fields = array();
56
57 /**
58 * @var array current payment processor including a copy of the object in 'object' key
59 */
60 public $_paymentProcessor;
61
62 /**
63 * Available recurring processors.
64 *
65 * @var array
66 */
67 public $_recurPaymentProcessors = array();
68
69 /**
70 * Array of processor options in the format id => array($id => $label)
71 * WARNING it appears that the format used to differ to this and there are places in the code that
72 * expect the old format. $this->_paymentProcessors provides the additional data which this
73 * array seems to have provided in the past
74 * @var array
75 */
76 public $_processors;
77
78 /**
79 * Available payment processors with full details including the key 'object' indexed by their id
80 * @var array
81 */
82 protected $_paymentProcessors = array();
83
84 /**
85 * Instance of the payment processor object.
86 *
87 * @var CRM_Core_Payment
88 */
89 protected $_paymentObject;
90
91 /**
92 * The id of the contribution that we are processing.
93 *
94 * @var int
95 */
96 public $_id;
97
98 /**
99 * The id of the premium that we are proceessing.
100 *
101 * @var int
102 */
103 public $_premiumID = NULL;
104
105 /**
106 * @var CRM_Contribute_DAO_ContributionProduct
107 */
108 public $_productDAO = NULL;
109
110 /**
111 * The id of the note
112 *
113 * @var int
114 */
115 public $_noteID;
116
117 /**
118 * The id of the contact associated with this contribution
119 *
120 * @var int
121 */
122 public $_contactID;
123
124 /**
125 * The id of the pledge payment that we are processing
126 *
127 * @var int
128 */
129 public $_ppID;
130
131 /**
132 * The id of the pledge that we are processing
133 *
134 * @var int
135 */
136 public $_pledgeID;
137
138 /**
139 * Is this contribution associated with an online
140 * financial transaction
141 *
142 * @var boolean
143 */
144 public $_online = FALSE;
145
146 /**
147 * Stores all product option
148 *
149 * @var array
150 */
151 public $_options;
152
153 /**
154 * Stores the honor id
155 *
156 * @var int
157 */
158 public $_honorID = NULL;
159
160 /**
161 * Store the financial Type ID
162 *
163 * @var array
164 */
165 public $_contributionType;
166
167 /**
168 * The contribution values if an existing contribution
169 */
170 public $_values;
171
172 /**
173 * The pledge values if this contribution is associated with pledge
174 */
175 public $_pledgeValues;
176
177 public $_contributeMode = 'direct';
178
179 public $_context;
180
181 public $_compId;
182
183 /**
184 * Store the line items if price set used.
185 */
186 public $_lineItems;
187
188 /**
189 * Is this a backoffice form
190 * (this will affect whether paypal express code is displayed)
191 * @var bool
192 */
193 public $isBackOffice = TRUE;
194
195 protected $_formType;
196
197 /**
198 * Array of fields to display on billingBlock.tpl - this is not fully implemented but basically intent is the panes/fieldsets on this page should
199 * be all in this array in order like
200 * 'credit_card' => array('credit_card_number' ...
201 * 'billing_details' => array('first_name' ...
202 *
203 * such that both the fields and the order can be more easily altered by payment processors & other extensions
204 * @var array
205 */
206 public $billingFieldSets = array();
207
208 /**
209 * Pre process function with common actions.
210 */
211 public function preProcess() {
212 $this->_contactID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
213 $this->assign('contactID', $this->_contactID);
214 CRM_Core_Resources::singleton()->addVars('coreForm', array('contact_id' => (int) $this->_contactID));
215 $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this, FALSE, 'add');
216 $this->_mode = CRM_Utils_Request::retrieve('mode', 'String', $this);
217 }
218
219 /**
220 * @param int $id
221 */
222 public function showRecordLinkMesssage($id) {
223 $statusId = CRM_Core_DAO::getFieldValue('CRM_Contribute_BAO_Contribution', $id, 'contribution_status_id');
224 if (CRM_Contribute_PseudoConstant::contributionStatus($statusId, 'name') == 'Partially paid') {
225 if ($pid = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_ParticipantPayment', $id, 'participant_id', 'contribution_id')) {
226 $recordPaymentLink = CRM_Utils_System::url('civicrm/payment',
227 "reset=1&id={$pid}&cid={$this->_contactID}&action=add&component=event"
228 );
229 CRM_Core_Session::setStatus(ts('Please use the <a href="%1">Record Payment</a> form if you have received an additional payment for this Partially paid contribution record.', array(1 => $recordPaymentLink)), ts('Notice'), 'alert');
230 }
231 }
232 }
233
234 /**
235 * @param int $id
236 * @param $values
237 */
238 public function buildValuesAndAssignOnline_Note_Type($id, &$values) {
239 $ids = array();
240 $params = array('id' => $id);
241 CRM_Contribute_BAO_Contribution::getValues($params, $values, $ids);
242
243 //Check if this is an online transaction (financial_trxn.payment_processor_id NOT NULL)
244 $this->_online = FALSE;
245 $fids = CRM_Core_BAO_FinancialTrxn::getFinancialTrxnId($id);
246 if (!empty($fids['financialTrxnId'])) {
247 $this->_online = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_FinancialTrxn', $fids['financialTrxnId'], 'payment_processor_id');
248 }
249
250 // Also don't allow user to update some fields for recurring contributions.
251 if (!$this->_online) {
252 $this->_online = CRM_Utils_Array::value('contribution_recur_id', $values);
253 }
254
255 $this->assign('isOnline', $this->_online ? TRUE : FALSE);
256
257 //to get note id
258 $daoNote = new CRM_Core_BAO_Note();
259 $daoNote->entity_table = 'civicrm_contribution';
260 $daoNote->entity_id = $id;
261 if ($daoNote->find(TRUE)) {
262 $this->_noteID = $daoNote->id;
263 $values['note'] = $daoNote->note;
264 }
265 $this->_contributionType = $values['financial_type_id'];
266 }
267
268 /**
269 * @param string $type
270 * Eg 'Contribution'.
271 * @param string $subType
272 * @param int $entityId
273 */
274 public function applyCustomData($type, $subType, $entityId) {
275 $this->set('type', $type);
276 $this->set('subType', $subType);
277 $this->set('entityId', $entityId);
278
279 CRM_Custom_Form_CustomData::preProcess($this, NULL, $subType, 1, $type, $entityId);
280 CRM_Custom_Form_CustomData::buildQuickForm($this);
281 CRM_Custom_Form_CustomData::setDefaultValues($this);
282 }
283
284 /**
285 * @param int $id
286 * @todo - this function is a long way, non standard of saying $dao = new CRM_Contribute_DAO_ContributionProduct(); $dao->id = $id; $dao->find();
287 */
288 public function assignPremiumProduct($id) {
289 $sql = "
290 SELECT *
291 FROM civicrm_contribution_product
292 WHERE contribution_id = {$id}
293 ";
294 $dao = CRM_Core_DAO::executeQuery($sql,
295 CRM_Core_DAO::$_nullArray
296 );
297 if ($dao->fetch()) {
298 $this->_premiumID = $dao->id;
299 $this->_productDAO = $dao;
300 }
301 $dao->free();
302 }
303
304 /**
305 * @return array
306 * Array of valid processors. The array resembles the DB table but also has 'object' as a key
307 * @throws Exception
308 */
309 public function getValidProcessors() {
310 $defaultID = NULL;
311 $capabilities = array('BackOffice');
312 if ($this->_mode) {
313 $capabilities[] = (ucfirst($this->_mode) . 'Mode');
314 }
315 $processors = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessors($capabilities);
316 return $processors;
317
318 }
319
320 /**
321 * Assign $this->processors, $this->recurPaymentProcessors, and related Smarty variables
322 */
323 public function assignProcessors() {
324 //ensure that processor has a valid config
325 //only valid processors get display to user
326
327 if ($this->_mode) {
328 $this->assign('processorSupportsFutureStartDate', CRM_Financial_BAO_PaymentProcessor::hasPaymentProcessorSupporting(array('FutureRecurStartDate')));
329 $this->_paymentProcessors = $this->getValidProcessors();
330 if (!isset($this->_paymentProcessor['id'])) {
331 // if the payment processor isn't set yet (as indicated by the presence of an id,) we'll grab the first one which should be the default
332 $this->_paymentProcessor = reset($this->_paymentProcessors);
333 }
334 if (empty($this->_paymentProcessors)) {
335 throw new CRM_Core_Exception(ts('You will need to configure the %1 settings for your Payment Processor before you can submit a credit card transactions.', array(1 => $this->_mode)));
336 }
337 $this->_processors = array();
338 foreach ($this->_paymentProcessors as $id => $processor) {
339 // @todo review this. The inclusion of this IF was to address test processors being incorrectly loaded.
340 // However the function $this->getValidProcessors() is expected to only return the processors relevant
341 // to the mode (using the actual id - ie. the id of the test processor for the test processor).
342 // for some reason there was a need to filter here per commit history - but this indicates a problem
343 // somewhere else.
344 if ($processor['is_test'] == ($this->_mode == 'test')) {
345 $this->_processors[$id] = ts($processor['name']);
346 if (!empty($processor['description'])) {
347 $this->_processors[$id] .= ' : ' . ts($processor['description']);
348 }
349 if ($processor['is_recur']) {
350 $this->_recurPaymentProcessors[$id] = $this->_processors[$id];
351 }
352 }
353 }
354 CRM_Financial_Form_Payment::addCreditCardJs($id);
355 }
356 $this->assign('recurringPaymentProcessorIds',
357 empty($this->_recurPaymentProcessors) ? '' : implode(',', array_keys($this->_recurPaymentProcessors))
358 );
359
360 // this required to show billing block
361 // @todo remove this assignment the billing block is now designed to be always included but will not show fieldsets unless those sets of fields are assigned
362 $this->assign_by_ref('paymentProcessor', $processor);
363 }
364
365 /**
366 * Get current currency from DB or use default currency.
367 *
368 * @param $submittedValues
369 *
370 * @return mixed
371 */
372 public function getCurrency($submittedValues) {
373 $config = CRM_Core_Config::singleton();
374
375 $currentCurrency = CRM_Utils_Array::value('currency',
376 $this->_values,
377 $config->defaultCurrency
378 );
379
380 // use submitted currency if present else use current currency
381 $result = CRM_Utils_Array::value('currency',
382 $submittedValues,
383 $currentCurrency
384 );
385 return $result;
386 }
387
388 /**
389 * @param int $financialTypeId
390 *
391 * @return array
392 */
393 public function getFinancialAccounts($financialTypeId) {
394 $financialAccounts = array();
395 CRM_Core_PseudoConstant::populate($financialAccounts,
396 'CRM_Financial_DAO_EntityFinancialAccount',
397 $all = TRUE,
398 $retrieve = 'financial_account_id',
399 $filter = NULL,
400 " entity_id = {$financialTypeId} ", NULL, 'account_relationship');
401 return $financialAccounts;
402 }
403
404 /**
405 * @param int $financialTypeId
406 * @param int $relationTypeId
407 *
408 * @return mixed
409 */
410 public function getFinancialAccount($financialTypeId, $relationTypeId) {
411 $financialAccounts = $this->getFinancialAccounts($financialTypeId);
412 return CRM_Utils_Array::value($relationTypeId, $financialAccounts);
413 }
414
415 public function preProcessPledge() {
416 //get the payment values associated with given pledge payment id OR check for payments due.
417 $this->_pledgeValues = array();
418 if ($this->_ppID) {
419 $payParams = array('id' => $this->_ppID);
420
421 CRM_Pledge_BAO_PledgePayment::retrieve($payParams, $this->_pledgeValues['pledgePayment']);
422 $this->_pledgeID = CRM_Utils_Array::value('pledge_id', $this->_pledgeValues['pledgePayment']);
423 $paymentStatusID = CRM_Utils_Array::value('status_id', $this->_pledgeValues['pledgePayment']);
424 $this->_id = CRM_Utils_Array::value('contribution_id', $this->_pledgeValues['pledgePayment']);
425
426 //get all status
427 $allStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
428 if (!($paymentStatusID == array_search('Pending', $allStatus) || $paymentStatusID == array_search('Overdue', $allStatus))) {
429 CRM_Core_Error::fatal(ts("Pledge payment status should be 'Pending' or 'Overdue'."));
430 }
431
432 //get the pledge values associated with given pledge payment.
433
434 $ids = array();
435 $pledgeParams = array('id' => $this->_pledgeID);
436 CRM_Pledge_BAO_Pledge::getValues($pledgeParams, $this->_pledgeValues, $ids);
437 $this->assign('ppID', $this->_ppID);
438 }
439 else {
440 // Not making a pledge payment, so if adding a new contribution we should check if pledge payment(s) are due for this contact so we can alert the user. CRM-5206
441 if (isset($this->_contactID)) {
442 $contactPledges = CRM_Pledge_BAO_Pledge::getContactPledges($this->_contactID);
443
444 if (!empty($contactPledges)) {
445 $payments = $paymentsDue = NULL;
446 $multipleDue = FALSE;
447 foreach ($contactPledges as $key => $pledgeId) {
448 $payments = CRM_Pledge_BAO_PledgePayment::getOldestPledgePayment($pledgeId);
449 if ($payments) {
450 if ($paymentsDue) {
451 $multipleDue = TRUE;
452 break;
453 }
454 else {
455 $paymentsDue = $payments;
456 }
457 }
458 }
459 if ($multipleDue) {
460 // Show link to pledge tab since more than one pledge has a payment due
461 $pledgeTab = CRM_Utils_System::url('civicrm/contact/view',
462 "reset=1&force=1&cid={$this->_contactID}&selectedChild=pledge"
463 );
464 CRM_Core_Session::setStatus(ts('This contact has pending or overdue pledge payments. <a href="%1">Click here to view their Pledges tab</a> and verify whether this contribution should be applied as a pledge payment.', array(1 => $pledgeTab)), ts('Notice'), 'alert');
465 }
466 elseif ($paymentsDue) {
467 // Show user link to oldest Pending or Overdue pledge payment
468 $ppAmountDue = CRM_Utils_Money::format($payments['amount'], $payments['currency']);
469 $ppSchedDate = CRM_Utils_Date::customFormat(CRM_Core_DAO::getFieldValue('CRM_Pledge_DAO_PledgePayment', $payments['id'], 'scheduled_date'));
470 if ($this->_mode) {
471 $ppUrl = CRM_Utils_System::url('civicrm/contact/view/contribution',
472 "reset=1&action=add&cid={$this->_contactID}&ppid={$payments['id']}&context=pledge&mode=live"
473 );
474 }
475 else {
476 $ppUrl = CRM_Utils_System::url('civicrm/contact/view/contribution',
477 "reset=1&action=add&cid={$this->_contactID}&ppid={$payments['id']}&context=pledge"
478 );
479 }
480 CRM_Core_Session::setStatus(ts('This contact has a pending or overdue pledge payment of %2 which is scheduled for %3. <a href="%1">Click here to enter a pledge payment</a>.', array(
481 1 => $ppUrl,
482 2 => $ppAmountDue,
483 3 => $ppSchedDate,
484 )), ts('Notice'), 'alert');
485 }
486 }
487 }
488 }
489 }
490
491 /**
492 * @param array $submittedValues
493 *
494 * @return mixed
495 */
496 public function unsetCreditCardFields($submittedValues) {
497 //Offline Contribution.
498 $unsetParams = array(
499 'payment_processor_id',
500 "email-{$this->_bltID}",
501 'hidden_buildCreditCard',
502 'hidden_buildDirectDebit',
503 'billing_first_name',
504 'billing_middle_name',
505 'billing_last_name',
506 'street_address-5',
507 "city-{$this->_bltID}",
508 "state_province_id-{$this->_bltID}",
509 "postal_code-{$this->_bltID}",
510 "country_id-{$this->_bltID}",
511 'credit_card_number',
512 'cvv2',
513 'credit_card_exp_date',
514 'credit_card_type',
515 );
516 foreach ($unsetParams as $key) {
517 if (isset($submittedValues[$key])) {
518 unset($submittedValues[$key]);
519 }
520 }
521 return $submittedValues;
522 }
523
524 /**
525 * Common block for setting up the parts of a form that relate to credit / debit card
526 * @throws Exception
527 */
528 protected function assignPaymentRelatedVariables() {
529 try {
530 if ($this->_contactID) {
531 list($this->userDisplayName, $this->userEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
532 $this->assign('displayName', $this->userDisplayName);
533 }
534 if ($this->_mode) {
535 $this->assignProcessors();
536
537 $this->assignBillingType();
538
539 CRM_Core_Payment_Form::setPaymentFieldsByProcessor($this, $this->_paymentProcessor, FALSE, TRUE);
540 }
541 }
542 catch (CRM_Core_Exception $e) {
543 CRM_Core_Error::fatal($e->getMessage());
544 }
545 }
546
547 /**
548 * Begin post processing.
549 *
550 * This function aims to start to bring together common postProcessing functions.
551 *
552 * Eventually these are also shared with the front end forms & may need to be moved to where they can also
553 * access this function.
554 */
555 protected function beginPostProcess() {
556 if ($this->_mode) {
557 $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getPayment(
558 $this->_params['payment_processor_id'],
559 ($this->_mode == 'test')
560 );
561 if (in_array('credit_card_exp_date', array_keys($this->_params))) {
562 $this->_params['year'] = CRM_Core_Payment_Form::getCreditCardExpirationYear($this->_params);
563 $this->_params['month'] = CRM_Core_Payment_Form::getCreditCardExpirationMonth($this->_params);
564 }
565 $this->assign('credit_card_exp_date', CRM_Utils_Date::mysqlToIso(CRM_Utils_Date::format($this->_params['credit_card_exp_date'])));
566 $this->assign('credit_card_number',
567 CRM_Utils_System::mungeCreditCard($this->_params['credit_card_number'])
568 );
569 $this->assign('credit_card_type', CRM_Utils_Array::value('credit_card_type', $this->_params));
570 }
571 $this->_params['ip_address'] = CRM_Utils_System::ipAddress();
572 }
573
574
575 /**
576 * Add the billing address to the contact who paid.
577 *
578 * Note that this function works based on the presence or otherwise of billing fields & can be called regardless of
579 * whether they are 'expected' (due to assumptions about the payment processor type or the setting to collect billing
580 * for pay later.
581 */
582 protected function processBillingAddress() {
583 $fields = array();
584
585 $fields['email-Primary'] = 1;
586 $this->_params['email-5'] = $this->_params['email-Primary'] = $this->_contributorEmail;
587 // now set the values for the billing location.
588 foreach (array_keys($this->_fields) as $name) {
589 $fields[$name] = 1;
590 }
591
592 $fields["address_name-{$this->_bltID}"] = 1;
593
594 //ensure we don't over-write the payer's email with the member's email
595 if ($this->_contributorContactID == $this->_contactID) {
596 $fields["email-{$this->_bltID}"] = 1;
597 }
598
599 list($hasBillingField, $addressParams) = CRM_Contribute_BAO_Contribution::getPaymentProcessorReadyAddressParams($this->_params, $this->_bltID);
600 $fields = $this->formatParamsForPaymentProcessor($fields);
601
602 if ($hasBillingField) {
603 $addressParams = array_merge($this->_params, $addressParams);
604 // CRM-18277 don't let this get passed in because we don't want contribution source to override contact source.
605 // Ideally we wouldn't just randomly merge everything into addressParams but just pass in a relevant array.
606 // Note this source field is covered by a unit test.
607 if (isset($addressParams['source'])) {
608 unset($addressParams['source']);
609 }
610 //here we are setting up the billing contact - if different from the member they are already created
611 // but they will get billing details assigned
612 CRM_Contact_BAO_Contact::createProfileContact($addressParams, $fields,
613 $this->_contributorContactID, NULL, NULL,
614 CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $this->_contactID, 'contact_type')
615 );
616 }
617 }
618
619 /**
620 * Get default values for billing fields.
621 *
622 * @todo this function still replicates code in several other places in the code.
623 *
624 * Also - the call to getProfileDefaults possibly covers the state_province & country already.
625 *
626 * @param $defaults
627 *
628 * @return array
629 */
630 protected function getBillingDefaults($defaults) {
631 // set default country from config if no country set
632 $config = CRM_Core_Config::singleton();
633 if (empty($defaults["billing_country_id-{$this->_bltID}"])) {
634 $defaults["billing_country_id-{$this->_bltID}"] = $config->defaultContactCountry;
635 }
636
637 if (empty($defaults["billing_state_province_id-{$this->_bltID}"])) {
638 $defaults["billing_state_province_id-{$this->_bltID}"] = $config->defaultContactStateProvince;
639 }
640
641 $billingDefaults = $this->getProfileDefaults('Billing', $this->_contactID);
642 return array_merge($defaults, $billingDefaults);
643 }
644
645 }