CRM/Mailing/Form/Unsubscribe.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 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17 class CRM_Mailing_Form_Unsubscribe extends CRM_Core_Form {
  18
  19   /**
  20    * Prevent people double-submitting the form (e.g. by double-clicking).
  21    * https://lab.civicrm.org/dev/core/-/issues/1773
  22    *
  23    * @var bool
  24    */
  25   public $submitOnce = TRUE;
  26
  27   /**
  28    * @var int
  29    */
  30   private $_job_id;
  31
  32   /**
  33    * @var int
  34    */
  35   private $_queue_id;
  36
  37   /**
  38    * @var string
  39    */
  40   private $_hash;
  41
  42   /**
  43    * @var string
  44    */
  45   private $_email;
  46
  47   public function preProcess() {
  48     $this->_job_id = $job_id = CRM_Utils_Request::retrieve('jid', 'Integer', $this);
  49     $this->_queue_id = $queue_id = CRM_Utils_Request::retrieve('qid', 'Integer', $this);
  50     $this->_hash = $hash = CRM_Utils_Request::retrieve('h', 'String', $this);
  51     $isConfirm = CRM_Utils_Request::retrieveValue('confirm', 'Boolean', FALSE, FALSE, 'GET');
  52
  53     if (!$job_id || !$queue_id || !$hash) {
  54       throw new CRM_Core_Exception(ts('Missing Parameters'));
  55     }
  56
  57     // verify that the three numbers above match
  58     $q = CRM_Mailing_Event_BAO_Queue::verify($job_id, $queue_id, $hash);
  59     if (!$q) {
  60       throw new CRM_Core_Exception(ts("There was an error in your request"));
  61     }
  62
  63     list($displayName, $email) = CRM_Mailing_Event_BAO_Queue::getContactInfo($queue_id);
  64     $this->assign('display_name', $displayName);
  65     $emailMasked = CRM_Utils_String::maskEmail($email);
  66     $this->assign('email_masked', $emailMasked);
  67     $this->assign('email', $email);
  68     $this->_email = $email;
  69
  70     $groups = CRM_Mailing_Event_BAO_Unsubscribe::unsub_from_mailing($job_id, $queue_id, $hash, TRUE);
  71     $this->assign('groups', $groups);
  72     $groupExist = NULL;
  73     foreach ($groups as $value) {
  74       if ($value) {
  75         $groupExist = TRUE;
  76       }
  77     }
  78     if (!$groupExist && !$isConfirm) {
  79       $statusMsg = ts('%1 has already been unsubscribed.', [1 => $email]);
  80       CRM_Core_Session::setStatus($statusMsg, '', 'error');
  81     }
  82     $this->assign('groupExist', $groupExist);
  83   }
  84
  85   public function buildQuickForm() {
  86     CRM_Utils_System::addHTMLHead('<META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">');
  87     $this->setTitle(ts('Unsubscribe Confirmation'));
  88
  89     $buttons = [
  90       [
  91         'type' => 'next',
  92         'name' => ts('Unsubscribe'),
  93         'isDefault' => TRUE,
  94       ],
  95       [
  96         'type' => 'cancel',
  97         'name' => ts('Cancel'),
  98       ],
  99     ];
 100
 101     $this->addButtons($buttons);
 102   }
 103
 104   public function postProcess() {
 105     $confirmURL = CRM_Utils_System::url("civicrm/mailing/unsubscribe", "reset=1&jid={$this->_job_id}&qid={$this->_queue_id}&h={$this->_hash}&confirm=1");
 106     $this->assign('confirmURL', $confirmURL);
 107     CRM_Core_Session::singleton()->pushUserContext($confirmURL);
 108
 109     // Email address verified
 110     $groups = CRM_Mailing_Event_BAO_Unsubscribe::unsub_from_mailing($this->_job_id, $this->_queue_id, $this->_hash);
 111
 112     if (count($groups)) {
 113       CRM_Mailing_Event_BAO_Unsubscribe::send_unsub_response($this->_queue_id, $groups, FALSE, $this->_job_id);
 114     }
 115
 116     $statusMsg = ts('%1 has been unsubscribed successfully.', [1 => $this->_email]);
 117     CRM_Core_Session::setStatus($statusMsg, '', 'success');
 118   }
 119
 120 }