CRM/Contribute/Form/UpdateSubscription.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  * @package CRM
  30  * @copyright CiviCRM LLC (c) 2004-2019
  31  */
  32
  33 /**
  34  * This class generates form components generic to recurring contributions.
  35  *
  36  * It delegates the work to lower level subclasses and integrates the changes
  37  * back in. It also uses a lot of functionality with the CRM API's, so any change
  38  * made here could potentially affect the API etc. Be careful, be aware, use unit tests.
  39  */
  40 class CRM_Contribute_Form_UpdateSubscription extends CRM_Core_Form {
  41
  42   /**
  43    * The recurring contribution id, used when editing the recurring contribution.
  44    *
  45    * @var int
  46    */
  47   protected $contributionRecurID = NULL;
  48
  49   protected $_coid = NULL;
  50
  51   protected $_subscriptionDetails = NULL;
  52
  53   protected $_selfService = FALSE;
  54
  55   public $_paymentProcessor = NULL;
  56
  57   public $_paymentProcessorObj = NULL;
  58
  59   /**
  60    * Fields that affect the schedule and are defined as editable by the processor.
  61    *
  62    * @var array
  63    */
  64   protected $editableScheduleFields = array();
  65
  66   /**
  67    * The id of the contact associated with this recurring contribution.
  68    *
  69    * @var int
  70    */
  71   public $_contactID;
  72
  73   /**
  74    * Pre-processing for the form.
  75    *
  76    * @throws \Exception
  77    */
  78   public function preProcess() {
  79
  80     $this->setAction(CRM_Core_Action::UPDATE);
  81
  82     $this->contributionRecurID = CRM_Utils_Request::retrieve('crid', 'Integer', $this, FALSE);
  83     if ($this->contributionRecurID) {
  84       try {
  85         $this->_paymentProcessorObj = CRM_Financial_BAO_PaymentProcessor::getPaymentProcessorForRecurringContribution($this->contributionRecurID);
  86       }
  87       catch (CRM_Core_Exception $e) {
  88         CRM_Core_Error::statusBounce(ts('There is no valid processor for this subscription so it cannot be edited.'));
  89       }
  90       catch (CiviCRM_API3_Exception $e) {
  91         CRM_Core_Error::statusBounce(ts('There is no valid processor for this subscription so it cannot be edited.'));
  92       }
  93       $this->_subscriptionDetails = CRM_Contribute_BAO_ContributionRecur::getSubscriptionDetails($this->contributionRecurID);
  94     }
  95
  96     $this->_coid = CRM_Utils_Request::retrieve('coid', 'Integer', $this, FALSE);
  97     if ($this->_coid) {
  98       $this->_paymentProcessor = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_coid, 'contribute', 'info');
  99       // @todo test & replace with $this->_paymentProcessorObj =  Civi\Payment\System::singleton()->getById($this->_paymentProcessor['id']);
 100       $this->_paymentProcessorObj = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_coid, 'contribute', 'obj');
 101       $this->_subscriptionDetails = CRM_Contribute_BAO_ContributionRecur::getSubscriptionDetails($this->_coid, 'contribution');
 102       $this->contributionRecurID = $this->_subscriptionDetails->recur_id;
 103     }
 104     elseif ($this->contributionRecurID) {
 105       $this->_coid = CRM_Core_DAO::getFieldValue('CRM_Contribute_DAO_Contribution', $this->contributionRecurID, 'id', 'contribution_recur_id');
 106     }
 107
 108     if (!$this->contributionRecurID || !$this->_subscriptionDetails) {
 109       CRM_Core_Error::statusBounce(ts('Required information missing.'));
 110     }
 111
 112     if ($this->_subscriptionDetails->membership_id && $this->_subscriptionDetails->auto_renew) {
 113       // Add Membership details to form
 114       $membership = civicrm_api3('Membership', 'get', array(
 115         'contribution_recur_id' => $this->contributionRecurID,
 116       ));
 117       if (!empty($membership['count'])) {
 118         $membershipDetails = reset($membership['values']);
 119         $values['membership_id'] = $membershipDetails['id'];
 120         $values['membership_name'] = $membershipDetails['membership_name'];
 121       }
 122       $this->assign('recurMembership', $values);
 123       $this->assign('contactId', $this->_subscriptionDetails->contact_id);
 124     }
 125
 126     if (!CRM_Core_Permission::check('edit contributions')) {
 127       if ($this->_subscriptionDetails->contact_id != $this->getContactID()) {
 128         CRM_Core_Error::statusBounce(ts('You do not have permission to update subscription.'));
 129       }
 130       $this->_selfService = TRUE;
 131     }
 132     $this->assign('self_service', $this->_selfService);
 133
 134     $this->editableScheduleFields = $this->_paymentProcessorObj->getEditableRecurringScheduleFields();
 135
 136     $changeHelpText = $this->_paymentProcessorObj->getRecurringScheduleUpdateHelpText();
 137     if (!in_array('amount', $this->editableScheduleFields)) {
 138       // Not sure if this is good behaviour - maintaining this existing behaviour for now.
 139       CRM_Core_Session::setStatus($changeHelpText, ts('Warning'), 'alert');
 140     }
 141     else {
 142       $this->assign('changeHelpText', $changeHelpText);
 143     }
 144     $alreadyHardCodedFields = array('amount', 'installments');
 145     foreach ($this->editableScheduleFields as $editableScheduleField) {
 146       if (!in_array($editableScheduleField, $alreadyHardCodedFields)) {
 147         $this->addField($editableScheduleField, array('entity' => 'ContributionRecur'), FALSE, FALSE);
 148       }
 149     }
 150
 151     // when custom data is included in this page
 152     if (!empty($_POST['hidden_custom'])) {
 153       CRM_Custom_Form_CustomData::preProcess($this, NULL, NULL, 1, 'ContributionRecur', $this->contributionRecurID);
 154       CRM_Custom_Form_CustomData::buildQuickForm($this);
 155       CRM_Custom_Form_CustomData::setDefaultValues($this);
 156     }
 157
 158     $this->assign('editableScheduleFields', array_diff($this->editableScheduleFields, $alreadyHardCodedFields));
 159
 160     if ($this->_subscriptionDetails->contact_id) {
 161       list($this->_donorDisplayName, $this->_donorEmail) = CRM_Contact_BAO_Contact::getContactDetails($this->_subscriptionDetails->contact_id);
 162     }
 163
 164     CRM_Utils_System::setTitle(ts('Update Recurring Contribution'));
 165
 166     // Handle context redirection.
 167     CRM_Contribute_BAO_ContributionRecur::setSubscriptionContext();
 168   }
 169
 170   /**
 171    * Set default values for the form.
 172    *
 173    * Note that in edit/view mode the default values are retrieved from the database.
 174    */
 175   public function setDefaultValues() {
 176     $this->_defaults = array();
 177     $this->_defaults['amount'] = $this->_subscriptionDetails->amount;
 178     $this->_defaults['installments'] = $this->_subscriptionDetails->installments;
 179     $this->_defaults['campaign_id'] = $this->_subscriptionDetails->campaign_id;
 180     $this->_defaults['financial_type_id'] = $this->_subscriptionDetails->financial_type_id;
 181     $this->_defaults['is_notify'] = 1;
 182     foreach ($this->editableScheduleFields as $field) {
 183       $this->_defaults[$field] = isset($this->_subscriptionDetails->$field) ? $this->_subscriptionDetails->$field : NULL;
 184     }
 185
 186     return $this->_defaults;
 187   }
 188
 189   /**
 190    * Actually build the components of the form.
 191    */
 192   public function buildQuickForm() {
 193     // CRM-16398: If current recurring contribution got > 1 lineitems then make amount field readonly
 194     $amtAttr = array('size' => 20);
 195     $lineItems = CRM_Price_BAO_LineItem::getLineItemsByContributionID($this->_coid);
 196     if (count($lineItems) > 1) {
 197       $amtAttr += array('readonly' => TRUE);
 198     }
 199     $this->addMoney('amount', ts('Recurring Contribution Amount'), TRUE, $amtAttr,
 200       TRUE, 'currency', $this->_subscriptionDetails->currency, TRUE
 201     );
 202
 203     $this->add('text', 'installments', ts('Number of Installments'), array('size' => 20), FALSE);
 204
 205     if ($this->_donorEmail) {
 206       $this->add('checkbox', 'is_notify', ts('Notify Contributor?'));
 207     }
 208
 209     if (CRM_Core_Permission::check('edit contributions')) {
 210       CRM_Campaign_BAO_Campaign::addCampaign($this, $this->_subscriptionDetails->campaign_id);
 211     }
 212
 213     if (CRM_Contribute_BAO_ContributionRecur::supportsFinancialTypeChange($this->contributionRecurID)) {
 214       $this->addEntityRef('financial_type_id', ts('Financial Type'), array('entity' => 'FinancialType'), !$this->_selfService);
 215     }
 216
 217     // Add custom data
 218     $this->assign('customDataType', 'ContributionRecur');
 219     $this->assign('entityID', $this->contributionRecurID);
 220
 221     $type = 'next';
 222     if ($this->_selfService) {
 223       $type = 'submit';
 224     }
 225
 226     // define the buttons
 227     $this->addButtons(array(
 228         array(
 229           'type' => $type,
 230           'name' => ts('Save'),
 231           'isDefault' => TRUE,
 232         ),
 233         array(
 234           'type' => 'cancel',
 235           'name' => ts('Cancel'),
 236         ),
 237       )
 238     );
 239   }
 240
 241   /**
 242    * Called after the user submits the form.
 243    */
 244   public function postProcess() {
 245     // store the submitted values in an array
 246     $params = $this->exportValues();
 247
 248     if ($this->_selfService && $this->_donorEmail) {
 249       // for self service force notify
 250       $params['is_notify'] = 1;
 251     }
 252
 253     // if this is an update of an existing recurring contribution, pass the ID
 254     $params['id'] = $this->_subscriptionDetails->recur_id;
 255     $message = '';
 256
 257     $params['subscriptionId'] = $this->_subscriptionDetails->subscription_id;
 258     $updateSubscription = TRUE;
 259     if ($this->_paymentProcessorObj->supports('changeSubscriptionAmount')) {
 260       $updateSubscription = $this->_paymentProcessorObj->changeSubscriptionAmount($message, $params);
 261     }
 262     if (is_a($updateSubscription, 'CRM_Core_Error')) {
 263       CRM_Core_Error::displaySessionError($updateSubscription);
 264       $status = ts('Could not update the Recurring contribution details');
 265       $msgTitle = ts('Update Error');
 266       $msgType = 'error';
 267     }
 268     elseif ($updateSubscription) {
 269       // Handle custom data
 270       $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params, $this->contributionRecurID, 'ContributionRecur');
 271       // save the changes
 272       CRM_Contribute_BAO_ContributionRecur::add($params);
 273       $status = ts('Recurring contribution has been updated to: %1, every %2 %3(s) for %4 installments.',
 274         array(
 275           1 => CRM_Utils_Money::format($params['amount'], $this->_subscriptionDetails->currency),
 276           2 => $this->_subscriptionDetails->frequency_interval,
 277           3 => $this->_subscriptionDetails->frequency_unit,
 278           4 => $params['installments'],
 279         )
 280       );
 281
 282       $msgTitle = ts('Update Success');
 283       $msgType = 'success';
 284       $msg = ts('Recurring Contribution Updated');
 285       $contactID = $this->_subscriptionDetails->contact_id;
 286
 287       if ($this->_subscriptionDetails->amount != $params['amount']) {
 288         $message .= "<br /> " . ts("Recurring contribution amount has been updated from %1 to %2 for this subscription.",
 289             array(
 290               1 => CRM_Utils_Money::format($this->_subscriptionDetails->amount, $this->_subscriptionDetails->currency),
 291               2 => CRM_Utils_Money::format($params['amount'], $this->_subscriptionDetails->currency),
 292             )) . ' ';
 293         if ($this->_subscriptionDetails->amount < $params['amount']) {
 294           $msg = ts('Recurring Contribution Updated - increased installment amount');
 295         }
 296         else {
 297           $msg = ts('Recurring Contribution Updated - decreased installment amount');
 298         }
 299       }
 300
 301       if ($this->_subscriptionDetails->installments != $params['installments']) {
 302         $message .= "<br /> " . ts("Recurring contribution installments have been updated from %1 to %2 for this subscription.", array(
 303               1 => $this->_subscriptionDetails->installments,
 304               2 => $params['installments'],
 305             )) . ' ';
 306       }
 307
 308       $activityParams = array(
 309         'source_contact_id' => $contactID,
 310         'activity_type_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Update Recurring Contribution'),
 311         'subject' => $msg,
 312         'details' => $message,
 313         'activity_date_time' => date('YmdHis'),
 314         'status_id' => CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_status_id', 'Completed'),
 315       );
 316
 317       $session = CRM_Core_Session::singleton();
 318       $cid = $session->get('userID');
 319
 320       if ($cid) {
 321         $activityParams['target_contact_id'][] = $activityParams['source_contact_id'];
 322         $activityParams['source_contact_id'] = $cid;
 323       }
 324       CRM_Activity_BAO_Activity::create($activityParams);
 325
 326       if (!empty($params['is_notify'])) {
 327         // send notification
 328         if ($this->_subscriptionDetails->contribution_page_id) {
 329           CRM_Core_DAO::commonRetrieveAll('CRM_Contribute_DAO_ContributionPage', 'id',
 330             $this->_subscriptionDetails->contribution_page_id, $value, array(
 331               'title',
 332               'receipt_from_name',
 333               'receipt_from_email',
 334             )
 335           );
 336           $receiptFrom = '"' . CRM_Utils_Array::value('receipt_from_name', $value[$this->_subscriptionDetails->contribution_page_id]) . '" <' . $value[$this->_subscriptionDetails->contribution_page_id]['receipt_from_email'] . '>';
 337         }
 338         else {
 339           $domainValues = CRM_Core_BAO_Domain::getNameAndEmail();
 340           $receiptFrom = "$domainValues[0] <$domainValues[1]>";
 341         }
 342
 343         list($donorDisplayName, $donorEmail) = CRM_Contact_BAO_Contact::getContactDetails($contactID);
 344
 345         $tplParams = array(
 346           'recur_frequency_interval' => $this->_subscriptionDetails->frequency_interval,
 347           'recur_frequency_unit' => $this->_subscriptionDetails->frequency_unit,
 348           'amount' => CRM_Utils_Money::format($params['amount']),
 349           'installments' => $params['installments'],
 350         );
 351
 352         $tplParams['contact'] = array('display_name' => $donorDisplayName);
 353         $tplParams['receipt_from_email'] = $receiptFrom;
 354
 355         $sendTemplateParams = array(
 356           'groupName' => 'msg_tpl_workflow_contribution',
 357           'valueName' => 'contribution_recurring_edit',
 358           'contactId' => $contactID,
 359           'tplParams' => $tplParams,
 360           'isTest' => $this->_subscriptionDetails->is_test,
 361           'PDFFilename' => 'receipt.pdf',
 362           'from' => $receiptFrom,
 363           'toName' => $donorDisplayName,
 364           'toEmail' => $donorEmail,
 365         );
 366         list($sent) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
 367       }
 368     }
 369
 370     $session = CRM_Core_Session::singleton();
 371     $userID = $session->get('userID');
 372     if ($userID && $status) {
 373       CRM_Core_Session::setStatus($status, $msgTitle, $msgType);
 374     }
 375     elseif (!$userID) {
 376       if ($status) {
 377         CRM_Utils_System::setUFMessage($status);
 378       }
 379       // keep result as 1, since we not displaying anything on the redirected page anyway
 380       return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/subscriptionstatus',
 381         "reset=1&task=update&result=1"));
 382     }
 383   }
 384
 385   /**
 386    * Explicitly declare the form context.
 387    */
 388   public function getDefaultContext() {
 389     return 'create';
 390   }
 391
 392 }