CRM/Contribute/Form/CancelSubscription.php

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