CRM/Contribute/Form/CancelSubscription.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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33
  34 /**
  35  * This class provides support for canceling recurring subscriptions.
  36  */
  37 class CRM_Contribute_Form_CancelSubscription extends CRM_Core_Form {
  38   protected $_paymentProcessorObj = NULL;
  39
  40   protected $_userContext = NULL;
  41
  42   protected $_mode = NULL;
  43
  44   protected $_mid = NULL;
  45
  46   protected $_coid = NULL;
  47
  48   protected $_crid = NULL;
  49
  50   protected $_selfService = FALSE;
  51
  52   /**
  53    * Set variables up before form is built.
  54    */
  55   public function preProcess() {
  56     $this->_mid = CRM_Utils_Request::retrieve('mid', 'Integer', $this, FALSE);
  57
  58     $this->_crid = CRM_Utils_Request::retrieve('crid', 'Integer', $this, FALSE);
  59     if ($this->_crid) {
  60       $this->_paymentProcessorObj = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_crid, 'recur', 'obj');
  61       $this->_subscriptionDetails = CRM_Contribute_BAO_ContributionRecur::getSubscriptionDetails($this->_crid);
  62       $this->assign('frequency_unit', $this->_subscriptionDetails->frequency_unit);
  63       $this->assign('frequency_interval', $this->_subscriptionDetails->frequency_interval);
  64       $this->assign('amount', $this->_subscriptionDetails->amount);
  65       $this->assign('installments', $this->_subscriptionDetails->installments);
  66
  67       // Are we cancelling a recurring contribution that is linked to an auto-renew membership?
  68       if ($this->_subscriptionDetails->membership_id) {
  69         $this->_mid = $this->_subscriptionDetails->membership_id;
  70       }
  71     }
  72
  73     if ($this->_mid) {
  74       $this->_mode = 'auto_renew';
  75       // CRM-18468: crid is more accurate than mid for getting
  76       // subscriptionDetails, so don't get them again.
  77       if (!$this->_crid) {
  78         $this->_paymentProcessorObj = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_mid, 'membership', 'obj');
  79         $this->_subscriptionDetails = CRM_Contribute_BAO_ContributionRecur::getSubscriptionDetails($this->_mid, 'membership');
  80       }
  81
  82       $membershipTypes = CRM_Member_PseudoConstant::membershipType();
  83       $membershipTypeId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_mid, 'membership_type_id');
  84       $this->assign('membershipType', CRM_Utils_Array::value($membershipTypeId, $membershipTypes));
  85     }
  86
  87     $this->_coid = CRM_Utils_Request::retrieve('coid', 'Integer', $this, FALSE);
  88     if ($this->_coid) {
  89       if (CRM_Contribute_BAO_Contribution::isSubscriptionCancelled($this->_coid)) {
  90         CRM_Core_Error::fatal(ts('The recurring contribution looks to have been cancelled already.'));
  91       }
  92       $this->_paymentProcessorObj = CRM_Financial_BAO_PaymentProcessor::getProcessorForEntity($this->_coid, 'contribute', 'obj');
  93       $this->_subscriptionDetails = CRM_Contribute_BAO_ContributionRecur::getSubscriptionDetails($this->_coid, 'contribution');
  94
  95       $this->assign('frequency_unit', $this->_subscriptionDetails->frequency_unit);
  96       $this->assign('frequency_interval', $this->_subscriptionDetails->frequency_interval);
  97       $this->assign('amount', $this->_subscriptionDetails->amount);
  98       $this->assign('installments', $this->_subscriptionDetails->installments);
  99     }
 100
 101     if (
 102       (!$this->_crid && !$this->_coid && !$this->_mid) ||
 103       (!$this->_subscriptionDetails)
 104     ) {
 105       CRM_Core_Error::fatal('Required information missing.');
 106     }
 107
 108     if (!CRM_Core_Permission::check('edit contributions')) {
 109       $userChecksum = CRM_Utils_Request::retrieve('cs', 'String', $this, FALSE);
 110       if (!CRM_Contact_BAO_Contact_Utils::validChecksum($this->_subscriptionDetails->contact_id, $userChecksum)) {
 111         CRM_Core_Error::fatal(ts('You do not have permission to cancel this recurring contribution.'));
 112       }
 113       $this->_selfService = TRUE;
 114     }
 115     $this->assign('self_service', $this->_selfService);
 116
 117     // handle context redirection
 118     CRM_Contribute_BAO_ContributionRecur::setSubscriptionContext();
 119
 120     CRM_Utils_System::setTitle($this->_mid ? ts('Cancel Auto-renewal') : ts('Cancel Recurring Contribution'));
 121     $this->assign('mode', $this->_mode);
 122
 123     if ($this->_subscriptionDetails->contact_id) {
 124       list($this->_donorDisplayName, $this->_donorEmail)
 125         = CRM_Contact_BAO_Contact::getContactDetails($this->_subscriptionDetails->contact_id);
 126     }
 127   }
 128
 129   /**
 130    * Build the form object.
 131    */
 132   public function buildQuickForm() {
 133     // Determine if we can cancel recurring contribution via API with this processor
 134     $cancelSupported = $this->_paymentProcessorObj->supports('CancelRecurring');
 135     if ($cancelSupported) {
 136       $searchRange = array();
 137       $searchRange[] = $this->createElement('radio', NULL, NULL, ts('Yes'), '1');
 138       $searchRange[] = $this->createElement('radio', NULL, NULL, ts('No'), '0');
 139
 140       $this->addGroup(
 141         $searchRange,
 142         'send_cancel_request',
 143         ts('Send cancellation request to %1 ?',
 144           array(1 => $this->_paymentProcessorObj->_processorName))
 145       );
 146     }
 147     $this->assign('cancelSupported', $cancelSupported);
 148
 149     if ($this->_donorEmail) {
 150       $this->add('checkbox', 'is_notify', ts('Notify Contributor?'));
 151     }
 152     if ($this->_mid) {
 153       $cancelButton = ts('Cancel Automatic Membership Renewal');
 154     }
 155     else {
 156       $cancelButton = ts('Cancel Recurring Contribution');
 157     }
 158
 159     $type = 'next';
 160     if ($this->_selfService) {
 161       $type = 'submit';
 162     }
 163
 164     $this->addButtons(array(
 165         array(
 166           'type' => $type,
 167           'name' => $cancelButton,
 168           'spacing' => '&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;',
 169           'isDefault' => TRUE,
 170         ),
 171         array(
 172           'type' => 'cancel',
 173           'name' => ts('Not Now'),
 174         ),
 175       )
 176     );
 177   }
 178
 179   /**
 180    * Set default values for the form.
 181    *
 182    * @return array
 183    *   array of default values
 184    */
 185   public function setDefaultValues() {
 186     return array(
 187       'is_notify' => 1,
 188       'send_cancel_request' => 1,
 189     );
 190   }
 191
 192   /**
 193    * Process the form submission.
 194    */
 195   public function postProcess() {
 196     $status = $message = NULL;
 197     $cancelSubscription = TRUE;
 198     $params = $this->controller->exportValues($this->_name);
 199
 200     if ($this->_selfService) {
 201       // for self service force sending-request & notify
 202       if ($this->_paymentProcessorObj->supports('cancelRecurring')) {
 203         $params['send_cancel_request'] = 1;
 204       }
 205
 206       if ($this->_donorEmail) {
 207         $params['is_notify'] = 1;
 208       }
 209     }
 210
 211     if (CRM_Utils_Array::value('send_cancel_request', $params) == 1) {
 212       $cancelParams = array('subscriptionId' => $this->_subscriptionDetails->subscription_id);
 213       $cancelSubscription = $this->_paymentProcessorObj->cancelSubscription($message, $cancelParams);
 214     }
 215
 216     if (is_a($cancelSubscription, 'CRM_Core_Error')) {
 217       CRM_Core_Error::displaySessionError($cancelSubscription);
 218     }
 219     elseif ($cancelSubscription) {
 220       $activityParams
 221         = array(
 222           'subject' => $this->_mid ? ts('Auto-renewal membership cancelled') : ts('Recurring contribution cancelled'),
 223           'details' => $message,
 224         );
 225       $cancelStatus = CRM_Contribute_BAO_ContributionRecur::cancelRecurContribution(
 226         $this->_subscriptionDetails->recur_id,
 227         $activityParams
 228       );
 229
 230       if ($cancelStatus) {
 231         $tplParams = array();
 232         if ($this->_mid) {
 233           $inputParams = array('id' => $this->_mid);
 234           CRM_Member_BAO_Membership::getValues($inputParams, $tplParams);
 235           $tplParams = $tplParams[$this->_mid];
 236           $tplParams['membership_status']
 237             = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipStatus', $tplParams['status_id']);
 238           $tplParams['membershipType']
 239             = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $tplParams['membership_type_id']);
 240           $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.', array(1 => $tplParams['membershipType']));
 241           $msgTitle = 'Membership Renewal Cancelled';
 242           $msgType = 'info';
 243         }
 244         else {
 245           $tplParams['recur_frequency_interval'] = $this->_subscriptionDetails->frequency_interval;
 246           $tplParams['recur_frequency_unit'] = $this->_subscriptionDetails->frequency_unit;
 247           $tplParams['amount'] = $this->_subscriptionDetails->amount;
 248           $tplParams['contact'] = array('display_name' => $this->_donorDisplayName);
 249           $status = ts('The recurring contribution of %1, every %2 %3 has been cancelled.',
 250             array(
 251               1 => $this->_subscriptionDetails->amount,
 252               2 => $this->_subscriptionDetails->frequency_interval,
 253               3 => $this->_subscriptionDetails->frequency_unit,
 254             )
 255           );
 256           $msgTitle = 'Contribution Cancelled';
 257           $msgType = 'success';
 258         }
 259
 260         if (CRM_Utils_Array::value('is_notify', $params) == 1) {
 261           if ($this->_subscriptionDetails->contribution_page_id) {
 262             CRM_Core_DAO::commonRetrieveAll(
 263               'CRM_Contribute_DAO_ContributionPage',
 264               'id',
 265               $this->_subscriptionDetails->contribution_page_id,
 266               $value,
 267               array('title', 'receipt_from_name', 'receipt_from_email')
 268             );
 269             $receiptFrom
 270               = '"' . CRM_Utils_Array::value('receipt_from_name', $value[$this->_subscriptionDetails->contribution_page_id]) .
 271               '" <' .
 272               $value[$this->_subscriptionDetails->contribution_page_id]['receipt_from_email'] .
 273               '>';
 274           }
 275           else {
 276             $domainValues = CRM_Core_BAO_Domain::getNameAndEmail();
 277             $receiptFrom = "$domainValues[0] <$domainValues[1]>";
 278           }
 279
 280           // send notification
 281           $sendTemplateParams
 282             = array(
 283               'groupName' => $this->_mode == 'auto_renew' ? 'msg_tpl_workflow_membership' : 'msg_tpl_workflow_contribution',
 284               'valueName' => $this->_mode == 'auto_renew' ? 'membership_autorenew_cancelled' : 'contribution_recurring_cancelled',
 285               'contactId' => $this->_subscriptionDetails->contact_id,
 286               'tplParams' => $tplParams,
 287               //'isTest'    => $isTest, set this from _objects
 288               'PDFFilename' => 'receipt.pdf',
 289               'from' => $receiptFrom,
 290               'toName' => $this->_donorDisplayName,
 291               'toEmail' => $this->_donorEmail,
 292             );
 293           list($sent) = CRM_Core_BAO_MessageTemplate::sendTemplate($sendTemplateParams);
 294         }
 295       }
 296       else {
 297         $msgType = 'error';
 298         $msgTitle = ts('Error');
 299         if ($params['send_cancel_request'] == 1) {
 300           $status = ts('Recurring contribution was cancelled successfully by the processor, but could not be marked as cancelled in the database.');
 301         }
 302         else {
 303           $status = ts('Recurring contribution could not be cancelled in the database.');
 304         }
 305       }
 306     }
 307     else {
 308       $status = ts('The recurring contribution could not be cancelled.');
 309       $msgTitle = 'Error Cancelling Contribution';
 310       $msgType = 'error';
 311     }
 312
 313     $session = CRM_Core_Session::singleton();
 314     $userID = $session->get('userID');
 315     if ($userID && $status) {
 316       $session->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         return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/contribute/subscriptionstatus',
 323         "reset=1&task=cancel&result=1"));
 324       }
 325     }
 326   }
 327
 328 }