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
  14 /**
  15  * This class provides support for canceling recurring subscriptions.
  16  */
  17 class CRM_Contribute_Form_CancelSubscription extends CRM_Contribute_Form_ContributionRecur {
  18
  19   protected $_userContext = NULL;
  20
  21   protected $_mode = NULL;
  22
  23   /**
  24    * The contributor email
  25    *
  26    * @var string
  27    */
  28   protected $_donorEmail = '';
  29
  30   /**
  31    * Should custom data be suppressed on this form.
  32    *
  33    * We override to suppress custom data because historically it has not been
  34    * shown on this form & we don't want to expose it as a by-product of
  35    * other change without establishing that it would be good on this form.
  36    *
  37    * @return bool
  38    */
  39   protected function isSuppressCustomData() {
  40     return TRUE;
  41   }
  42
  43   /**
  44    * Set variables up before form is built.
  45    *
  46    * @throws \CRM_Core_Exception
  47    */
  48   public function preProcess() {
  49     parent::preProcess();
  50
  51     $cancelRecurTextParams = [
  52       'mode' => $this->_mode,
  53       'amount' => $this->getSubscriptionDetails()->amount,
  54       'currency' => $this->getSubscriptionDetails()->currency,
  55       'frequency_interval' => $this->getSubscriptionDetails()->frequency_interval,
  56       'frequency_unit' => $this->getSubscriptionDetails()->frequency_unit,
  57       'installments' => $this->getSubscriptionDetails()->installments,
  58       'selfService' => $this->isSelfService(),
  59     ];
  60
  61     if ($this->_crid) {
  62       // Are we cancelling a recurring contribution that is linked to an auto-renew membership?
  63       if ($this->getSubscriptionDetails()->membership_id) {
  64         $this->_mid = $this->getSubscriptionDetails()->membership_id;
  65       }
  66     }
  67
  68     if ($this->_mid) {
  69       $this->_mode = 'auto_renew';
  70       // CRM-18468: crid is more accurate than mid for getting
  71       // subscriptionDetails, so don't get them again.
  72
  73       $membershipTypes = CRM_Member_PseudoConstant::membershipType();
  74       $membershipTypeId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_mid, 'membership_type_id');
  75       $membershipType = $membershipTypes[$membershipTypeId] ?? '';
  76       $this->assign('membershipType', $membershipType);
  77       $cancelRecurTextParams['membershipType'] = $membershipType;
  78     }
  79
  80     if ($this->_coid) {
  81       if (CRM_Contribute_BAO_Contribution::isSubscriptionCancelled($this->_coid)) {
  82         CRM_Core_Error::statusBounce(ts('The recurring contribution looks to have been cancelled already.'));
  83       }
  84       $this->_paymentProcessorObj = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_coid, 'contribute', 'obj');
  85     }
  86
  87     if (
  88       (!$this->_crid && !$this->_coid && !$this->_mid) ||
  89       (!$this->getSubscriptionDetails())
  90     ) {
  91       CRM_Core_Error::statusBounce('Required information missing.');
  92     }
  93
  94     $this->assign('cancelRecurDetailText', $this->_paymentProcessorObj->getText('cancelRecurDetailText', $cancelRecurTextParams));
  95
  96     // handle context redirection
  97     CRM_Contribute_BAO_ContributionRecur::setSubscriptionContext();
  98
  99     CRM_Utils_System::setTitle($this->_mid ? ts('Cancel Auto-renewal') : ts('Cancel Recurring Contribution'));
 100     $this->assign('mode', $this->_mode);
 101
 102     if ($this->isSelfService()) {
 103       unset($this->entityFields['send_cancel_request'], $this->entityFields['is_notify']);
 104     }
 105
 106     if ($this->getSubscriptionDetails()->contact_id) {
 107       list($this->_donorDisplayName, $this->_donorEmail)
 108         = CRM_Contact_BAO_Contact::getContactDetails($this->getSubscriptionDetails()->contact_id);
 109     }
 110   }
 111
 112   /**
 113    * Set entity fields for this cancellation.
 114    */
 115   public function setEntityFields() {
 116     $this->entityFields = [
 117       'cancel_reason' => ['name' => 'cancel_reason'],
 118     ];
 119     $this->entityFields['send_cancel_request'] = [
 120       'title' => ts('Send cancellation request?'),
 121       'name' => 'send_cancel_request',
 122       'not-auto-addable' => TRUE,
 123     ];
 124     $this->entityFields['is_notify'] = [
 125       'title' => ts('Notify Contributor?'),
 126       'name' => 'is_notify',
 127       'not-auto-addable' => TRUE,
 128     ];
 129   }
 130
 131   /**
 132    * Build the form object.
 133    */
 134   public function buildQuickForm() {
 135     $this->buildQuickEntityForm();
 136     // Determine if we can cancel recurring contribution via API with this processor
 137     if ($this->_paymentProcessorObj->supports('CancelRecurringNotifyOptional')) {
 138       $searchRange = [];
 139       $searchRange[] = $this->createElement('radio', NULL, NULL, ts('Yes'), '1');
 140       $searchRange[] = $this->createElement('radio', NULL, NULL, ts('No'), '0');
 141
 142       $this->addGroup(
 143         $searchRange,
 144         'send_cancel_request',
 145         ts('Send cancellation request to %1 ?',
 146           [1 => $this->_paymentProcessorObj->getTitle()])
 147       );
 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       'is_notify' => 1,
 191       'send_cancel_request' => 1,
 192     ];
 193   }
 194
 195   /**
 196    * Process the form submission.
 197    *
 198    * @throws \CRM_Core_Exception
 199    */
 200   public function postProcess() {
 201     $message = NULL;
 202     $cancelSubscription = TRUE;
 203     $params = $this->controller->exportValues($this->_name);
 204
 205     if ($this->isSelfService()) {
 206       // for self service force sending-request & notify
 207       if ($this->_paymentProcessorObj->supports('cancelRecurring')) {
 208         $params['send_cancel_request'] = 1;
 209       }
 210
 211       if (!empty($this->_donorEmail)) {
 212         $params['is_notify'] = 1;
 213       }
 214     }
 215
 216     try {
 217       $propertyBag = new PropertyBag();
 218       if (isset($params['send_cancel_request'])) {
 219         $propertyBag->setIsNotifyProcessorOnCancelRecur(!empty($params['send_cancel_request']));
 220       }
 221       $propertyBag->setContributionRecurID($this->getSubscriptionDetails()->recur_id);
 222       $propertyBag->setRecurProcessorID($this->getSubscriptionDetails()->processor_id);
 223       $message = $this->_paymentProcessorObj->doCancelRecurring($propertyBag)['message'];
 224     }
 225     catch (\Civi\Payment\Exception\PaymentProcessorException $e) {
 226       CRM_Core_Error::statusBounce($e->getMessage());
 227     }
 228
 229     if ($cancelSubscription) {
 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     else {
 315       $status = ts('The recurring contribution could not be cancelled.');
 316       $msgTitle = 'Error Cancelling Contribution';
 317       $msgType = 'error';
 318     }
 319
 320     $session = CRM_Core_Session::singleton();
 321     $userID = $session->get('userID');
 322     if ($userID && $status) {
 323       $session->setStatus($status, $msgTitle, $msgType);
 324     }
 325     elseif (!$userID) {
 326       if ($status) {
 327         CRM_Utils_System::setUFMessage($status);
 328         // keep result as 1, since we not displaying anything on the redirected page anyway
 329         return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/subscriptionstatus',
 330         "reset=1&task=cancel&result=1"));
 331       }
 332     }
 333   }
 334
 335 }