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('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     CRM_Utils_System::setTitle($this->_mid ? ts('Cancel Auto-renewal') : ts('Cancel Recurring Contribution'));
 101     $this->assign('mode', $this->_mode);
 102
 103     if ($this->isSelfService()) {
 104       unset($this->entityFields['send_cancel_request'], $this->entityFields['is_notify']);
 105     }
 106
 107     if ($this->getSubscriptionDetails()->contact_id) {
 108       list($this->_donorDisplayName, $this->_donorEmail)
 109         = CRM_Contact_BAO_Contact::getContactDetails($this->getSubscriptionDetails()->contact_id);
 110     }
 111   }
 112
 113   /**
 114    * Set entity fields for this cancellation.
 115    */
 116   public function setEntityFields() {
 117     $this->entityFields = [
 118       'cancel_reason' => ['name' => 'cancel_reason'],
 119     ];
 120     $this->entityFields['send_cancel_request'] = [
 121       'title' => ts('Send cancellation request?'),
 122       'name' => 'send_cancel_request',
 123       'not-auto-addable' => TRUE,
 124     ];
 125     $this->entityFields['is_notify'] = [
 126       'title' => ts('Notify Contributor?'),
 127       'name' => 'is_notify',
 128       'not-auto-addable' => TRUE,
 129     ];
 130   }
 131
 132   /**
 133    * Build the form object.
 134    */
 135   public function buildQuickForm() {
 136     $this->buildQuickEntityForm();
 137     // Determine if we can cancel recurring contribution via API with this processor
 138     if ($this->_paymentProcessorObj->supports('CancelRecurringNotifyOptional')) {
 139       $searchRange = [];
 140       $searchRange[] = $this->createElement('radio', NULL, NULL, ts('Yes'), '1');
 141       $searchRange[] = $this->createElement('radio', NULL, NULL, ts('No'), '0');
 142
 143       $this->addGroup(
 144         $searchRange,
 145         'send_cancel_request',
 146         ts('Send cancellation request to %1 ?',
 147           [1 => $this->_paymentProcessorObj->getTitle()])
 148       );
 149     }
 150     else {
 151       $this->assign('cancelRecurNotSupportedText', $this->_paymentProcessorObj->getText('cancelRecurNotSupportedText', []));
 152     }
 153
 154     if (!empty($this->_donorEmail)) {
 155       $this->add('checkbox', 'is_notify', ts('Notify Contributor?') . " ({$this->_donorEmail})");
 156     }
 157     if ($this->_mid) {
 158       $cancelButton = ts('Cancel Automatic Membership Renewal');
 159     }
 160     else {
 161       $cancelButton = ts('Cancel Recurring Contribution');
 162     }
 163
 164     $type = 'next';
 165     if ($this->isSelfService()) {
 166       $type = 'submit';
 167     }
 168
 169     $this->addButtons([
 170       [
 171         'type' => $type,
 172         'name' => $cancelButton,
 173         'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 174         'isDefault' => TRUE,
 175       ],
 176       [
 177         'type' => 'cancel',
 178         'name' => ts('Not Now'),
 179       ],
 180     ]);
 181   }
 182
 183   /**
 184    * Set default values for the form.
 185    *
 186    * @return array
 187    *   array of default values
 188    */
 189   public function setDefaultValues() {
 190     return [
 191       'is_notify' => 1,
 192       'send_cancel_request' => 1,
 193     ];
 194   }
 195
 196   /**
 197    * Process the form submission.
 198    *
 199    * @throws \CRM_Core_Exception
 200    * @throws \API_Exception
 201    */
 202   public function postProcess() {
 203     $message = NULL;
 204     $params = $this->controller->exportValues($this->_name);
 205
 206     if ($this->isSelfService()) {
 207       // for self service force sending-request & notify
 208       if ($this->_paymentProcessorObj->supports('cancelRecurring')) {
 209         $params['send_cancel_request'] = 1;
 210       }
 211
 212       if (!empty($this->_donorEmail)) {
 213         $params['is_notify'] = 1;
 214       }
 215     }
 216
 217     try {
 218       $propertyBag = new PropertyBag();
 219       if (isset($params['send_cancel_request'])) {
 220         $propertyBag->setIsNotifyProcessorOnCancelRecur(!empty($params['send_cancel_request']));
 221       }
 222       $propertyBag->setContributionRecurID($this->getSubscriptionDetails()->recur_id);
 223       $propertyBag->setRecurProcessorID($this->getSubscriptionDetails()->processor_id);
 224       $message = $this->_paymentProcessorObj->doCancelRecurring($propertyBag)['message'];
 225     }
 226     catch (PaymentProcessorException $e) {
 227       CRM_Core_Error::statusBounce($e->getMessage());
 228     }
 229
 230     try {
 231       civicrm_api3('ContributionRecur', 'cancel', [
 232         'id' => $this->getSubscriptionDetails()->recur_id,
 233         'membership_id' => $this->_mid,
 234         'processor_message' => $message,
 235         'cancel_reason' => $params['cancel_reason'],
 236       ]);
 237
 238       $tplParams = [];
 239       if ($this->_mid) {
 240         $inputParams = ['id' => $this->_mid];
 241         CRM_Member_BAO_Membership::getValues($inputParams, $tplParams);
 242         $tplParams = $tplParams[$this->_mid];
 243         $tplParams['membership_status']
 244           = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus', $tplParams['status_id']);
 245         $tplParams['membershipType']
 246           = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $tplParams['membership_type_id']);
 247         $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']]);
 248         $msgTitle = 'Membership Renewal Cancelled';
 249         $msgType = 'info';
 250       }
 251       else {
 252         $tplParams['recur_frequency_interval'] = $this->getSubscriptionDetails()->frequency_interval;
 253         $tplParams['recur_frequency_unit'] = $this->getSubscriptionDetails()->frequency_unit;
 254         $tplParams['amount'] = CRM_Utils_Money::format($this->getSubscriptionDetails()->amount, $this->getSubscriptionDetails()->currency);
 255         $tplParams['contact'] = ['display_name' => $this->_donorDisplayName];
 256         $status = ts('The recurring contribution of %1, every %2 %3 has been cancelled.',
 257           [
 258             1 => $tplParams['amount'],
 259             2 => $tplParams['recur_frequency_interval'],
 260             3 => $tplParams['recur_frequency_unit'],
 261           ]
 262         );
 263         $msgTitle = 'Contribution Cancelled';
 264         $msgType = 'success';
 265       }
 266
 267       if (CRM_Utils_Array::value('is_notify', $params) == 1) {
 268         if ($this->getSubscriptionDetails()->contribution_page_id) {
 269           CRM_Core_DAO::commonRetrieveAll(
 270             'CRM_Contribute_DAO_ContributionPage',
 271             'id',
 272             $this->getSubscriptionDetails()->contribution_page_id,
 273             $value,
 274             ['title', 'receipt_from_name', 'receipt_from_email']
 275           );
 276           $receiptFrom
 277             = '"' . CRM_Utils_Array::value('receipt_from_name', $value[$this->getSubscriptionDetails()->contribution_page_id]) .
 278             '" <' .
 279             $value[$this->getSubscriptionDetails()->contribution_page_id]['receipt_from_email'] .
 280             '>';
 281         }
 282         else {
 283           $domainValues = CRM_Core_BAO_Domain::getNameAndEmail();
 284           $receiptFrom = "$domainValues[0] <$domainValues[1]>";
 285         }
 286
 287         // send notification
 288         $sendTemplateParams
 289           = [
 290             'groupName' => $this->_mode == 'auto_renew' ? 'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
 291             'valueName' => $this->_mode == 'auto_renew' ? 'membership_autorenew_cancelled' : 'contribution_recurring_cancelled',
 292             'contactId' => $this->getSubscriptionDetails()->contact_id,
 293             'tplParams' => $tplParams,
 294             //'isTest'    => $isTest, set this from _objects
 295             'PDFFilename' => 'receipt.pdf',
 296             'from' => $receiptFrom,
 297             'toName' => $this->_donorDisplayName,
 298             'toEmail' => $this->_donorEmail,
 299           ];
 300         list($sent) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
 301       }
 302     }
 303     catch (CiviCRM_API3_Exception $e) {
 304       $msgType = 'error';
 305       $msgTitle = ts('Error');
 306       if ($params['send_cancel_request'] == 1) {
 307         $status = ts('Recurring contribution was cancelled successfully by the processor, but could not be marked as cancelled in the database.');
 308       }
 309       else {
 310         $status = ts('Recurring contribution could not be cancelled in the database.');
 311       }
 312     }
 313
 314     $userID = CRM_Core_Session::getLoggedInContactID();
 315     if ($userID && $status) {
 316       CRM_Core_Session::singleton()->setStatus($status, $msgTitle, $msgType);
 317     }
 318     elseif (!$userID) {
 319       if ($status) {
 320         CRM_Utils_System::setUFMessage($status);
 321         // keep result as 1, since we not displaying anything on the redirected page anyway
 322         CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/subscriptionstatus',
 323           'reset=1&task=cancel&result=1'));
 324       }
 325     }
 326   }
 327
 328 }