CRM/Contribute/Form/AdditionalPayment.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 form records additional payments needed when event/contribution is partially paid.
  36  */
  37 class CRM_Contribute_Form_AdditionalPayment extends CRM_Contribute_Form_AbstractEditPayment {
  38   public $_contributeMode = 'direct';
  39
  40   /**
  41    * Id of the component entity
  42    */
  43   public $_id = NULL;
  44
  45   protected $entity = 'Contribution';
  46
  47   protected $_owed = NULL;
  48
  49   protected $_refund = NULL;
  50
  51   /**
  52    * @deprecated - use parent $this->contactID
  53    *
  54    * @var int
  55    */
  56   protected $_contactId = NULL;
  57
  58   protected $_contributorDisplayName = NULL;
  59
  60   protected $_contributorEmail = NULL;
  61
  62   protected $_toDoNotEmail = NULL;
  63
  64   protected $_paymentType = NULL;
  65
  66   protected $_contributionId = NULL;
  67
  68   protected $fromEmailId = NULL;
  69
  70   protected $_fromEmails = NULL;
  71
  72   protected $_view = NULL;
  73
  74   public $_action = NULL;
  75
  76   public function preProcess() {
  77
  78     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE);
  79     parent::preProcess();
  80     $this->_contactId = $this->_contactID;
  81     $this->_component = CRM_Utils_Request::retrieve('component', 'String', $this, FALSE, 'contribution');
  82     $this->_view = CRM_Utils_Request::retrieve('view', 'String', $this, FALSE);
  83     $this->assign('component', $this->_component);
  84     $this->assign('id', $this->_id);
  85     $this->assign('suppressPaymentFormButtons', $this->isBeingCalledFromSelectorContext());
  86
  87     if ($this->_view == 'transaction' && ($this->_action & CRM_Core_Action::BROWSE)) {
  88       $title = $this->assignPaymentInfoBlock();
  89       CRM_Utils_System::setTitle($title);
  90       return;
  91     }
  92     $this->_fromEmails = CRM_Core_BAO_Email::getFromEmail();
  93
  94     $entityType = 'contribution';
  95     if ($this->_component == 'event') {
  96       $entityType = 'participant';
  97       $this->_contributionId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_ParticipantPayment', $this->_id, 'contribution_id', 'participant_id');
  98       $eventId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $this->_id, 'event_id', 'id');
  99       $this->_fromEmails = CRM_Event_BAO_Event::getFromEmailIds($eventId);
 100     }
 101     else {
 102       $this->_contributionId = $this->_id;
 103       $this->_fromEmails['from_email_id'] = CRM_Core_BAO_Email::getFromEmail();
 104     }
 105
 106     $paymentInfo = CRM_Core_BAO_FinancialTrxn::getPartialPaymentWithType($this->_id, $entityType);
 107     $paymentDetails = CRM_Contribute_BAO_Contribution::getPaymentInfo($this->_id, $this->_component, FALSE, TRUE);
 108
 109     $this->_amtPaid = $paymentDetails['paid'];
 110     $this->_amtTotal = $paymentDetails['total'];
 111
 112     if (!empty($paymentInfo['refund_due'])) {
 113       $paymentAmt = $this->_refund = $paymentInfo['refund_due'];
 114       $this->_paymentType = 'refund';
 115     }
 116     elseif (!empty($paymentInfo['amount_owed'])) {
 117       $paymentAmt = $this->_owed = $paymentInfo['amount_owed'];
 118       $this->_paymentType = 'owed';
 119     }
 120     else {
 121       CRM_Core_Error::fatal(ts('No payment information found for this record'));
 122     }
 123
 124     if (!empty($this->_mode) && $this->_paymentType == 'refund') {
 125       CRM_Core_Error::fatal(ts('Credit card payment is not for Refund payments use'));
 126     }
 127
 128     list($this->_contributorDisplayName, $this->_contributorEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 129
 130     $this->assign('contributionMode', $this->_mode);
 131     $this->assign('contactId', $this->_contactID);
 132     $this->assign('paymentType', $this->_paymentType);
 133     $this->assign('paymentAmt', abs($paymentAmt));
 134
 135     $this->setPageTitle($this->_refund ? ts('Refund') : ts('Payment'));
 136   }
 137
 138   /**
 139    * Is this function being called from a datatable selector.
 140    *
 141    * If so we don't want to show the buttons.
 142    */
 143   protected function isBeingCalledFromSelectorContext() {
 144     return CRM_Utils_Request::retrieve('selector', 'Positive');
 145   }
 146
 147   /**
 148    * This virtual function is used to set the default values of
 149    * various form elements
 150    *
 151    * access        public
 152    *
 153    * @return array
 154    *   reference to the array of default values
 155    */
 156   /**
 157    * @return array
 158    */
 159   public function setDefaultValues() {
 160     if ($this->_view == 'transaction' && ($this->_action & CRM_Core_Action::BROWSE)) {
 161       return NULL;
 162     }
 163     $defaults = array();
 164     if ($this->_mode) {
 165       CRM_Core_Payment_Form::setDefaultValues($this, $this->_contactId);
 166       $defaults = array_merge($defaults, $this->_defaults);
 167     }
 168
 169     if (empty($defaults['trxn_date'])) {
 170       $defaults['trxn_date'] = date('Y-m-d H:i:s');
 171     }
 172
 173     if ($this->_refund) {
 174       $defaults['total_amount'] = CRM_Utils_Money::format(abs($this->_refund), NULL, NULL, TRUE);
 175     }
 176     elseif ($this->_owed) {
 177       $defaults['total_amount'] = CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($this->_owed);
 178     }
 179
 180     // Set $newCredit variable in template to control whether link to credit card mode is included
 181     $this->assign('newCredit', CRM_Core_Config::isEnabledBackOfficeCreditCardPayments());
 182     return $defaults;
 183   }
 184
 185   /**
 186    * Build the form object.
 187    */
 188   public function buildQuickForm() {
 189     if ($this->_view == 'transaction' && ($this->_action & CRM_Core_Action::BROWSE)) {
 190       $this->addButtons(array(
 191           array(
 192             'type' => 'cancel',
 193             'name' => ts('Done'),
 194             'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 195             'isDefault' => TRUE,
 196           ),
 197         )
 198       );
 199       return;
 200     }
 201
 202     CRM_Core_Payment_Form::buildPaymentForm($this, $this->_paymentProcessor, FALSE, TRUE, CRM_Utils_Request::retrieve('payment_instrument_id', 'Integer'));
 203     $this->add('select', 'payment_processor_id', ts('Payment Processor'), $this->_processors, NULL);
 204
 205     $attributes = CRM_Core_DAO::getAttribute('CRM_Financial_DAO_FinancialTrxn');
 206
 207     $label = ($this->_refund) ? ts('Refund Amount') : ts('Payment Amount');
 208     $this->addMoney('total_amount',
 209       $label,
 210       TRUE,
 211       $attributes['total_amount'],
 212       TRUE, 'currency', NULL
 213     );
 214
 215     //add receipt for offline contribution
 216     $this->addElement('checkbox', 'is_email_receipt', ts('Send Receipt?'));
 217
 218     $this->add('select', 'from_email_address', ts('Receipt From'), $this->_fromEmails['from_email_id']);
 219
 220     $this->add('textarea', 'receipt_text', ts('Confirmation Message'));
 221
 222     $dateLabel = ($this->_refund) ? ts('Refund Date') : ts('Date Received');
 223     $this->addField('trxn_date', array('entity' => 'FinancialTrxn', 'label' => $dateLabel, 'context' => 'Contribution'), FALSE, FALSE);
 224
 225     if ($this->_contactId && $this->_id) {
 226       if ($this->_component == 'event') {
 227         $eventId = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Participant', $this->_id, 'event_id', 'id');
 228         $event = CRM_Event_BAO_Event::getEvents(0, $eventId);
 229         $this->assign('eventName', $event[$eventId]);
 230       }
 231     }
 232
 233     $this->assign('displayName', $this->_contributorDisplayName);
 234     $this->assign('component', $this->_component);
 235     $this->assign('email', $this->_contributorEmail);
 236
 237     $js = NULL;
 238     // render backoffice payment fields only on offline mode
 239     if (!$this->_mode) {
 240       $js = array('onclick' => "return verify( );");
 241
 242       $this->add('select', 'payment_instrument_id',
 243         ts('Payment Method'),
 244         array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::paymentInstrument(),
 245         TRUE,
 246         array('onChange' => "return showHideByValue('payment_instrument_id','4','checkNumber','table-row','select',false);")
 247       );
 248
 249       $this->add('text', 'check_number', ts('Check Number'), $attributes['financial_trxn_check_number']);
 250       $this->add('text', 'trxn_id', ts('Transaction ID'), array('class' => 'twelve') + $attributes['trxn_id']);
 251
 252       $this->add('text', 'fee_amount', ts('Fee Amount'),
 253         $attributes['fee_amount']
 254       );
 255       $this->addRule('fee_amount', ts('Please enter a valid monetary value for Fee Amount.'), 'money');
 256
 257       $this->add('text', 'net_amount', ts('Net Amount'),
 258         $attributes['net_amount']
 259       );
 260       $this->addRule('net_amount', ts('Please enter a valid monetary value for Net Amount.'), 'money');
 261     }
 262
 263     $buttonName = $this->_refund ? 'Record Refund' : 'Record Payment';
 264     $this->addButtons(array(
 265         array(
 266           'type' => 'upload',
 267           'name' => ts('%1', array(1 => $buttonName)),
 268           'js' => $js,
 269           'isDefault' => TRUE,
 270         ),
 271         array(
 272           'type' => 'cancel',
 273           'name' => ts('Cancel'),
 274         ),
 275       )
 276     );
 277     $mailingInfo = Civi::settings()->get('mailing_backend');
 278     $this->assign('outBound_option', $mailingInfo['outBound_option']);
 279
 280     $this->addFormRule(array('CRM_Contribute_Form_AdditionalPayment', 'formRule'), $this);
 281   }
 282
 283   /**
 284    * @param $fields
 285    * @param $files
 286    * @param $self
 287    *
 288    * @return array
 289    */
 290   public static function formRule($fields, $files, $self) {
 291     $errors = array();
 292     if ($self->_paymentType == 'owed' && $fields['total_amount'] > $self->_owed) {
 293       $errors['total_amount'] = ts('Payment amount cannot be greater than owed amount');
 294     }
 295     if ($self->_paymentType == 'refund' && $fields['total_amount'] != abs($self->_refund)) {
 296       $errors['total_amount'] = ts('Refund amount must equal refund due amount.');
 297     }
 298     $netAmt = $fields['total_amount'] - CRM_Utils_Array::value('fee_amount', $fields, 0);
 299     if (!empty($fields['net_amount']) && $netAmt != $fields['net_amount']) {
 300       $errors['net_amount'] = ts('Net amount should be equal to the difference between payment amount and fee amount.');
 301     }
 302     if ($self->_paymentProcessor['id'] === 0 && empty($fields['payment_instrument_id'])) {
 303       $errors['payment_instrument_id'] = ts('Payment method is a required field');
 304     }
 305
 306     return $errors;
 307   }
 308
 309   /**
 310    * Process the form submission.
 311    */
 312   public function postProcess() {
 313     $submittedValues = $this->controller->exportValues($this->_name);
 314     $this->submit($submittedValues);
 315     $childTab = 'contribute';
 316     if ($this->_component == 'event') {
 317       $childTab = 'participant';
 318     }
 319     $session = CRM_Core_Session::singleton();
 320     $session->replaceUserContext(CRM_Utils_System::url('civicrm/contact/view',
 321       "reset=1&cid={$this->_contactId}&selectedChild={$childTab}"
 322     ));
 323   }
 324
 325   /**
 326    * Process Payments.
 327    * @param array $submittedValues
 328    *
 329    */
 330   public function submit($submittedValues) {
 331     $this->_params = $submittedValues;
 332     $this->beginPostProcess();
 333     $this->_contributorContactID = $this->_contactID;
 334     $this->processBillingAddress();
 335     $participantId = NULL;
 336     if ($this->_component == 'event') {
 337       $participantId = $this->_id;
 338     }
 339     $contributionStatuses = CRM_Core_PseudoConstant::get('CRM_Contribute_DAO_Contribution',
 340       'contribution_status_id',
 341       array('labelColumn' => 'name')
 342     );
 343     $contributionStatusID = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $this->_contributionId, 'contribution_status_id');
 344     if ($contributionStatuses[$contributionStatusID] == 'Pending') {
 345       civicrm_api3('Contribution', 'create',
 346         array(
 347           'id' => $this->_contributionId,
 348           'contribution_status_id' => array_search('Partially paid', $contributionStatuses),
 349           'is_pay_later' => 0,
 350         )
 351       );
 352     }
 353
 354     if ($this->_mode) {
 355       // process credit card
 356       $this->assign('contributeMode', 'direct');
 357       $this->processCreditCard();
 358     }
 359
 360     $defaults = array();
 361     $contribution = civicrm_api3('Contribution', 'getsingle', array(
 362       'return' => array("contribution_status_id"),
 363       'id' => $this->_contributionId,
 364     ));
 365     $contributionStatusId = CRM_Utils_Array::value('contribution_status_id', $contribution);
 366     $result = CRM_Contribute_BAO_Contribution::recordAdditionalPayment($this->_contributionId, $this->_params, $this->_paymentType, $participantId);
 367     // Fetch the contribution & do proportional line item assignment
 368     $params = array('id' => $this->_contributionId);
 369     $contribution = CRM_Contribute_BAO_Contribution::retrieve($params, $defaults, $params);
 370     CRM_Contribute_BAO_Contribution::addPayments(array($contribution), $contributionStatusId);
 371     if ($this->_contributionId && CRM_Core_Permission::access('CiviMember')) {
 372       $membershipPaymentCount = civicrm_api3('MembershipPayment', 'getCount', array('contribution_id' => $this->_contributionId));
 373       if ($membershipPaymentCount) {
 374         $this->ajaxResponse['updateTabs']['#tab_member'] = CRM_Contact_BAO_Contact::getCountComponent('membership', $this->_contactID);
 375       }
 376     }
 377     if ($this->_contributionId && CRM_Core_Permission::access('CiviEvent')) {
 378       $participantPaymentCount = civicrm_api3('ParticipantPayment', 'getCount', array('contribution_id' => $this->_contributionId));
 379       if ($participantPaymentCount) {
 380         $this->ajaxResponse['updateTabs']['#tab_participant'] = CRM_Contact_BAO_Contact::getCountComponent('participant', $this->_contactID);
 381       }
 382     }
 383
 384     $statusMsg = ts('The payment record has been processed.');
 385     // send email
 386     if (!empty($result) && !empty($this->_params['is_email_receipt'])) {
 387       $sendResult = civicrm_api3('Payment', 'sendconfirmation', ['id' => $result->id])['values'][$result->id];
 388       if ($sendResult['is_sent']) {
 389         $statusMsg .= ' ' . ts('A receipt has been emailed to the contributor.');
 390       }
 391     }
 392
 393     CRM_Core_Session::setStatus($statusMsg, ts('Saved'), 'success');
 394   }
 395
 396   public function processCreditCard() {
 397     $config = CRM_Core_Config::singleton();
 398     $session = CRM_Core_Session::singleton();
 399
 400     $now = date('YmdHis');
 401     $fields = array();
 402
 403     // we need to retrieve email address
 404     if ($this->_context == 'standalone' && !empty($this->_params['is_email_receipt'])) {
 405       list($this->userDisplayName,
 406         $this->userEmail
 407         ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactId);
 408       $this->assign('displayName', $this->userDisplayName);
 409     }
 410
 411     $this->formatParamsForPaymentProcessor($this->_params);
 412
 413     $this->_params['amount'] = $this->_params['total_amount'];
 414     // @todo - stop setting amount level in this function & call the CRM_Price_BAO_PriceSet::getAmountLevel
 415     // function to get correct amount level consistently. Remove setting of the amount level in
 416     // CRM_Price_BAO_PriceSet::processAmount. Extend the unit tests in CRM_Price_BAO_PriceSetTest
 417     // to cover all variants.
 418     $this->_params['amount_level'] = 0;
 419     $this->_params['currencyID'] = CRM_Utils_Array::value('currency',
 420       $this->_params,
 421       $config->defaultCurrency
 422     );
 423
 424     if (!empty($this->_params['trxn_date'])) {
 425       $this->_params['receive_date'] = $this->_params['trxn_date'];
 426     }
 427
 428     if (empty($this->_params['receive_date'])) {
 429       $this->_params['receive_date'] = date('YmdHis');
 430     }
 431
 432     if (empty($this->_params['invoice_id'])) {
 433       $this->_params['invoiceID'] = md5(uniqid(rand(), TRUE));
 434     }
 435     else {
 436       $this->_params['invoiceID'] = $this->_params['invoice_id'];
 437     }
 438
 439     $this->assign('address', CRM_Utils_Address::getFormattedBillingAddressFieldsFromParameters(
 440       $this->_params,
 441       $this->_bltID
 442     ));
 443
 444     //Add common data to formatted params
 445     $params = $this->_params;
 446     CRM_Contribute_Form_AdditionalInfo::postProcessCommon($params, $this->_params, $this);
 447     // at this point we've created a contact and stored its address etc
 448     // all the payment processors expect the name and address to be in the
 449     // so we copy stuff over to first_name etc.
 450     $paymentParams = $this->_params;
 451     $paymentParams['contactID'] = $this->_contactId;
 452     CRM_Core_Payment_Form::mapParams($this->_bltID, $this->_params, $paymentParams, TRUE);
 453
 454     $paymentParams['contributionPageID'] = NULL;
 455     if (!empty($this->_params['is_email_receipt'])) {
 456       $paymentParams['email'] = $this->_contributorEmail;
 457       $paymentParams['is_email_receipt'] = TRUE;
 458     }
 459     else {
 460       $paymentParams['is_email_receipt'] = $this->_params['is_email_receipt'] = FALSE;
 461     }
 462
 463     $result = NULL;
 464
 465     if ($paymentParams['amount'] > 0.0) {
 466       try {
 467         // force a reget of the payment processor in case the form changed it, CRM-7179
 468         $payment = Civi\Payment\System::singleton()->getByProcessor($this->_paymentProcessor);
 469         $result = $payment->doPayment($paymentParams);
 470       }
 471       catch (\Civi\Payment\Exception\PaymentProcessorException $e) {
 472         Civi::log()->error('Payment processor exception: ' . $e->getMessage());
 473         $urlParams = "action=add&cid={$this->_contactId}&id={$this->_contributionId}&component={$this->_component}&mode={$this->_mode}";
 474         CRM_Core_Error::statusBounce(CRM_Utils_System::url($e->getMessage(), 'civicrm/payment/add', $urlParams));
 475       }
 476     }
 477
 478     if (!empty($result)) {
 479       $this->_params = array_merge($this->_params, $result);
 480     }
 481
 482     if (empty($this->_params['receive_date'])) {
 483       $this->_params['receive_date'] = $now;
 484     }
 485
 486     $this->set('params', $this->_params);
 487
 488     // set source if not set
 489     if (empty($this->_params['source'])) {
 490       $userID = $session->get('userID');
 491       $userSortName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact', $userID,
 492         'sort_name'
 493       );
 494       $this->_params['source'] = ts('Submit Credit Card Payment by: %1', array(1 => $userSortName));
 495     }
 496   }
 497
 498   /**
 499    * Wrapper for unit testing the post process submit function.
 500    *
 501    * @param array $params
 502    * @param string|null $creditCardMode
 503    * @param string $entityType
 504    *
 505    * @throws \CiviCRM_API3_Exception
 506    */
 507   public function testSubmit($params, $creditCardMode = NULL, $entityType = 'contribute') {
 508     $this->_bltID = 5;
 509     // Required because processCreditCard calls set method on this.
 510     $_SERVER['REQUEST_METHOD'] = 'GET';
 511     $this->controller = new CRM_Core_Controller();
 512
 513     $this->assignPaymentRelatedVariables();
 514
 515     if (!empty($params['contribution_id'])) {
 516       $this->_contributionId = $params['contribution_id'];
 517
 518       $paymentInfo = CRM_Core_BAO_FinancialTrxn::getPartialPaymentWithType($this->_contributionId, $entityType);
 519       $paymentDetails = CRM_Contribute_BAO_Contribution::getPaymentInfo($this->_contributionId, $entityType, FALSE, TRUE);
 520
 521       $this->_amtPaid = $paymentDetails['paid'];
 522       $this->_amtTotal = $paymentDetails['total'];
 523
 524       if (!empty($paymentInfo['refund_due'])) {
 525         $this->_refund = $paymentInfo['refund_due'];
 526         $this->_paymentType = 'refund';
 527       }
 528       elseif (!empty($paymentInfo['amount_owed'])) {
 529         $this->_owed = $paymentInfo['amount_owed'];
 530         $this->_paymentType = 'owed';
 531       }
 532     }
 533
 534     if (!empty($params['contact_id'])) {
 535       $this->_contactId = $params['contact_id'];
 536     }
 537
 538     if ($creditCardMode) {
 539       $this->_mode = $creditCardMode;
 540     }
 541
 542     $this->_fields = array();
 543     $this->set('cid', $this->_contactId);
 544     parent::preProcess();
 545     $this->submit($params);
 546   }
 547
 548 }