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