CRM/Contribute/Form/CancelSubscription.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 use Civi\Payment\PropertyBag;
  13 use Civi\Payment\Exception\PaymentProcessorException;
  14
  15 /**
  16  * This class provides support for canceling recurring subscriptions.
  17  */
  18 class CRM_Contribute_Form_CancelSubscription extends CRM_Contribute_Form_ContributionRecur {
  19
  20   protected $_userContext;
  21
  22   protected $_mode;
  23
  24   /**
  25    * The contributor email
  26    *
  27    * @var string
  28    */
  29   protected $_donorEmail = '';
  30
  31   /**
  32    * Should custom data be suppressed on this form.
  33    *
  34    * We override to suppress custom data because historically it has not been
  35    * shown on this form & we don't want to expose it as a by-product of
  36    * other change without establishing that it would be good on this form.
  37    *
  38    * @return bool
  39    */
  40   protected function isSuppressCustomData() {
  41     return TRUE;
  42   }
  43
  44   /**
  45    * Set variables up before form is built.
  46    *
  47    * @throws \CRM_Core_Exception
  48    */
  49   public function preProcess() {
  50     parent::preProcess();
  51
  52     $cancelRecurTextParams = [
  53       'mode' => $this->_mode,
  54       'amount' => $this->getSubscriptionDetails()->amount,
  55       'currency' => $this->getSubscriptionDetails()->currency,
  56       'frequency_interval' => $this->getSubscriptionDetails()->frequency_interval,
  57       'frequency_unit' => $this->getSubscriptionDetails()->frequency_unit,
  58       'installments' => $this->getSubscriptionDetails()->installments,
  59       'selfService' => $this->isSelfService(),
  60     ];
  61
  62     if ($this->_crid) {
  63       // Are we cancelling a recurring contribution that is linked to an auto-renew membership?
  64       if ($this->getSubscriptionDetails()->membership_id) {
  65         $this->_mid = $this->getSubscriptionDetails()->membership_id;
  66       }
  67     }
  68
  69     if ($this->_mid) {
  70       $this->_mode = 'auto_renew';
  71       // CRM-18468: crid is more accurate than mid for getting
  72       // subscriptionDetails, so don't get them again.
  73
  74       $membershipTypes = CRM_Member_PseudoConstant::membershipType();
  75       $membershipTypeId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_mid, 'membership_type_id');
  76       $membershipType = $membershipTypes[$membershipTypeId] ?? '';
  77       $this->assign('membershipType', $membershipType);
  78       $cancelRecurTextParams['membershipType'] = $membershipType;
  79     }
  80
  81     if ($this->_coid) {
  82       if (CRM_Contribute_BAO_Contribution::isSubscriptionCancelled($this->_coid)) {
  83         CRM_Core_Error::statusBounce(ts('The recurring contribution looks to have been cancelled already.'));
  84       }
  85       $this->_paymentProcessorObj = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_coid, 'contribute', 'obj');
  86     }
  87
  88     if (
  89       (!$this->_crid && !$this->_coid && !$this->_mid) ||
  90       (!$this->getSubscriptionDetails())
  91     ) {
  92       CRM_Core_Error::statusBounce(ts('Required information missing.'));
  93     }
  94
  95     $this->assign('cancelRecurDetailText', $this->_paymentProcessorObj->getText('cancelRecurDetailText', $cancelRecurTextParams));
  96
  97     // handle context redirection
  98     CRM_Contribute_BAO_ContributionRecur::setSubscriptionContext();
  99
 100     $this->setTitle($this->_mid ? ts('Cancel Auto-renewal') : ts('Cancel Recurring Contribution'));
 101     $this->assign('mode', $this->_mode);
 102
 103     if ($this->isSelfService() || !$this->_paymentProcessorObj->supports('cancelRecurring')) {
 104       // If we are self service (contact is cancelling for themselves via a cancel link)
 105       // or the processor does not support cancellation then remove the fields
 106       // specifying whether to notify the processor.
 107       unset($this->entityFields['send_cancel_request']);
 108     }
 109     if ($this->isSelfService()) {
 110       // Arguably the is_notify field should be removed in self-service mode.
 111       // Historically this has been the case...
 112       unset($this->entityFields['is_notify']);
 113     }
 114
 115     if ($this->getSubscriptionDetails()->contact_id) {
 116       list($this->_donorDisplayName, $this->_donorEmail)
 117         = CRM_Contact_BAO_Contact::getContactDetails($this->getSubscriptionDetails()->contact_id);
 118     }
 119   }
 120
 121   /**
 122    * Set entity fields for this cancellation.
 123    */
 124   public function setEntityFields() {
 125     $this->entityFields = [
 126       'cancel_reason' => ['name' => 'cancel_reason'],
 127     ];
 128     $this->entityFields['send_cancel_request'] = [
 129       'title' => ts('Send cancellation request?'),
 130       'name' => 'send_cancel_request',
 131       'not-auto-addable' => TRUE,
 132     ];
 133     $this->entityFields['is_notify'] = [
 134       'title' => ts('Notify Contributor?'),
 135       'name' => 'is_notify',
 136       'not-auto-addable' => TRUE,
 137     ];
 138   }
 139
 140   /**
 141    * Build the form object.
 142    */
 143   public function buildQuickForm() {
 144     $this->buildQuickEntityForm();
 145     // Determine if we can cancel recurring contribution via API with this processor
 146     if ($this->_paymentProcessorObj->supports('CancelRecurringNotifyOptional')) {
 147       $this->addRadio('send_cancel_request', ts('Send cancellation request to %1 ?', [1 => $this->_paymentProcessorObj->getTitle()]), [ts('No'), ts('Yes')]);
 148     }
 149     else {
 150       $this->assign('cancelRecurNotSupportedText', $this->_paymentProcessorObj->getText('cancelRecurNotSupportedText', []));
 151     }
 152
 153     if (!empty($this->_donorEmail)) {
 154       $this->add('checkbox', 'is_notify', ts('Notify Contributor?') . " ({$this->_donorEmail})");
 155     }
 156     if ($this->_mid) {
 157       $cancelButton = ts('Cancel Automatic Membership Renewal');
 158     }
 159     else {
 160       $cancelButton = ts('Cancel Recurring Contribution');
 161     }
 162
 163     $type = 'next';
 164     if ($this->isSelfService()) {
 165       $type = 'submit';
 166     }
 167
 168     $this->addButtons([
 169       [
 170         'type' => $type,
 171         'name' => $cancelButton,
 172         'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 173         'isDefault' => TRUE,
 174       ],
 175       [
 176         'type' => 'cancel',
 177         'name' => ts('Not Now'),
 178       ],
 179     ]);
 180   }
 181
 182   /**
 183    * Set default values for the form.
 184    *
 185    * @return array
 186    *   array of default values
 187    */
 188   public function setDefaultValues() {
 189     return [
 190       'send_cancel_request' => 1,
 191     ];
 192   }
 193
 194   /**
 195    * Process the form submission.
 196    *
 197    * @throws \CRM_Core_Exception
 198    * @throws \API_Exception
 199    */
 200   public function postProcess() {
 201     $message = NULL;
 202     $params = $this->controller->exportValues($this->_name);
 203
 204     if ($this->isSelfService()) {
 205       // for self service force sending-request & notify
 206       if ($this->_paymentProcessorObj->supports('cancelRecurring')) {
 207         $params['send_cancel_request'] = 1;
 208       }
 209
 210       if (!empty($this->_donorEmail)) {
 211         $params['is_notify'] = 1;
 212       }
 213     }
 214
 215     try {
 216       $propertyBag = new PropertyBag();
 217       if (isset($params['send_cancel_request'])) {
 218         $propertyBag->setIsNotifyProcessorOnCancelRecur(!empty($params['send_cancel_request']));
 219       }
 220       $propertyBag->setContributionRecurID($this->getSubscriptionDetails()->recur_id);
 221       $propertyBag->setRecurProcessorID($this->getSubscriptionDetails()->processor_id);
 222       $message = $this->_paymentProcessorObj->doCancelRecurring($propertyBag)['message'];
 223     }
 224     catch (PaymentProcessorException $e) {
 225       CRM_Core_Error::statusBounce($e->getMessage());
 226     }
 227
 228     try {
 229       civicrm_api3('ContributionRecur', 'cancel', [
 230         'id' => $this->getSubscriptionDetails()->recur_id,
 231         'membership_id' => $this->_mid,
 232         'processor_message' => $message,
 233         'cancel_reason' => $this->getSubmittedValue('cancel_reason'),
 234       ]);
 235
 236       $tplParams = [];
 237       if ($this->_mid) {
 238         $inputParams = ['id' => $this->_mid];
 239         CRM_Member_BAO_Membership::getValues($inputParams, $tplParams);
 240         $tplParams = $tplParams[$this->_mid];
 241         $tplParams['membership_status']
 242           = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus', $tplParams['status_id']);
 243         $tplParams['membershipType']
 244           = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $tplParams['membership_type_id']);
 245         $status = ts('The automatic renewal of your %1 membership has been cancelled as requested. This does not affect the status of your membership - you will receive a separate notification when your membership is up for renewal.', [1 => $tplParams['membershipType']]);
 246         $msgTitle = 'Membership Renewal Cancelled';
 247         $msgType = 'info';
 248       }
 249       else {
 250         $status = ts('The recurring contribution of %1, every %2 %3 has been cancelled.',
 251           [
 252             1 => CRM_Utils_Money::format($this->getSubscriptionDetails()->amount, $this->getSubscriptionDetails()->currency),
 253             2 => $this->getSubscriptionDetails()->frequency_interval,
 254             3 => $this->getSubscriptionDetails()->frequency_unit,
 255           ]
 256         );
 257         $msgTitle = 'Contribution Cancelled';
 258         $msgType = 'success';
 259       }
 260
 261       if (CRM_Utils_Array::value('is_notify', $params) == 1) {
 262         // send notification
 263         $sendTemplateParams
 264           = [
 265             'groupName' => $this->_mode == 'auto_renew' ? 'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
 266             'valueName' => $this->_mode == 'auto_renew' ? 'membership_autorenew_cancelled' : 'contribution_recurring_cancelled',
 267             'contactId' => $this->getSubscriptionDetails()->contact_id,
 268             'tplParams' => $tplParams,
 269             'tokenContext' => ['contribution_recurId' => $this->getContributionRecurID()],
 270             //'isTest'    => $isTest, set this from _objects
 271             'PDFFilename' => 'receipt.pdf',
 272             'from' => CRM_Contribute_BAO_ContributionRecur::getRecurFromAddress($this->getContributionRecurID()),
 273             'toName' => $this->_donorDisplayName,
 274             'toEmail' => $this->_donorEmail,
 275           ];
 276         list($sent) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
 277       }
 278     }
 279     catch (CiviCRM_API3_Exception $e) {
 280       $msgType = 'error';
 281       $msgTitle = ts('Error');
 282       if ($params['send_cancel_request'] == 1) {
 283         $status = ts('Recurring contribution was cancelled successfully by the processor, but could not be marked as cancelled in the database.');
 284       }
 285       else {
 286         $status = ts('Recurring contribution could not be cancelled in the database.');
 287       }
 288     }
 289
 290     $userID = CRM_Core_Session::getLoggedInContactID();
 291     if ($userID && $status) {
 292       CRM_Core_Session::singleton()->setStatus($status, $msgTitle, $msgType);
 293     }
 294     elseif (!$userID) {
 295       if ($status) {
 296         CRM_Utils_System::setUFMessage($status);
 297         // keep result as 1, since we not displaying anything on the redirected page anyway
 298         CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/subscriptionstatus',
 299           'reset=1&task=cancel&result=1'));
 300       }
 301     }
 302   }
 303
 304 }