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
  52     if (!$job_id || !$queue_id || !$hash) {
  53       throw new CRM_Core_Exception(ts('Missing Parameters'));
  54     }
  55
  56     // verify that the three numbers above match
  57     $q = CRM_Mailing_Event_BAO_Queue::verify($job_id, $queue_id, $hash);
  58     if (!$q) {
  59       throw new CRM_Core_Exception(ts("There was an error in your request"));
  60     }
  61
  62     list($displayName, $email) = CRM_Mailing_Event_BAO_Queue::getContactInfo($queue_id);
  63     $this->assign('display_name', $displayName);
  64     $emailMasked = CRM_Utils_String::maskEmail($email);
  65     $this->assign('email_masked', $emailMasked);
  66     $this->assign('email', $email);
  67     $this->_email = $email;
  68
  69     $groups = CRM_Mailing_Event_BAO_Unsubscribe::unsub_from_mailing($job_id, $queue_id, $hash, TRUE);
  70     $this->assign('groups', $groups);
  71     $groupExist = NULL;
  72     foreach ($groups as $value) {
  73       if ($value) {
  74         $groupExist = TRUE;
  75       }
  76     }
  77     if (!$groupExist) {
  78       $statusMsg = ts('%1 has been unsubscribed.', [1 => $email]);
  79       CRM_Core_Session::setStatus($statusMsg, '', 'error');
  80     }
  81     $this->assign('groupExist', $groupExist);
  82   }
  83
  84   public function buildQuickForm() {
  85     CRM_Utils_System::addHTMLHead('<META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">');
  86     $this->setTitle(ts('Unsubscribe Confirmation'));
  87
  88     $buttons = [
  89       [
  90         'type' => 'next',
  91         'name' => ts('Unsubscribe'),
  92         'isDefault' => TRUE,
  93       ],
  94       [
  95         'type' => 'cancel',
  96         'name' => ts('Cancel'),
  97       ],
  98     ];
  99
 100     $this->addButtons($buttons);
 101   }
 102
 103   public function postProcess() {
 104     $confirmURL = CRM_Utils_System::url("civicrm/mailing/unsubscribe", "reset=1&jid={$this->_job_id}&qid={$this->_queue_id}&h={$this->_hash}&confirm=1");
 105     $this->assign('confirmURL', $confirmURL);
 106     CRM_Core_Session::singleton()->pushUserContext($confirmURL);
 107
 108     // Email address verified
 109     $groups = CRM_Mailing_Event_BAO_Unsubscribe::unsub_from_mailing($this->_job_id, $this->_queue_id, $this->_hash);
 110
 111     if (count($groups)) {
 112       CRM_Mailing_Event_BAO_Unsubscribe::send_unsub_response($this->_queue_id, $groups, FALSE, $this->_job_id);
 113     }
 114
 115     $statusMsg = ts('%1 is unsubscribed.', [1 => CRM_Utils_String::maskEmail($this->_email)]);
 116     CRM_Core_Session::setStatus($statusMsg, '', 'success');
 117   }
 118
 119 }