/sites/all/modules/contrib/civicrm/CRM/Mailing/Event/BAO/Resubscribe.php
PHP | 290 lines | 183 code | 36 blank | 71 comment | 28 complexity | 4f974fab30c238df992ff9b8c4e769bd MD5 | raw file
- <?php
- /*
- +--------------------------------------------------------------------+
- | CiviCRM version 5 |
- +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2019 |
- +--------------------------------------------------------------------+
- | This file is a part of CiviCRM. |
- | |
- | CiviCRM is free software; you can copy, modify, and distribute it |
- | under the terms of the GNU Affero General Public License |
- | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
- | |
- | CiviCRM is distributed in the hope that it will be useful, but |
- | WITHOUT ANY WARRANTY; without even the implied warranty of |
- | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
- | See the GNU Affero General Public License for more details. |
- | |
- | You should have received a copy of the GNU Affero General Public |
- | License and the CiviCRM Licensing Exception along |
- | with this program; if not, contact CiviCRM LLC |
- | at info[AT]civicrm[DOT]org. If you have questions about the |
- | GNU Affero General Public License or the licensing of CiviCRM, |
- | see the CiviCRM license FAQ at http://civicrm.org/licensing |
- +--------------------------------------------------------------------+
- */
- /**
- *
- * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2019
- */
- require_once 'Mail/mime.php';
- /**
- * Class CRM_Mailing_Event_BAO_Resubscribe
- */
- class CRM_Mailing_Event_BAO_Resubscribe {
- /**
- * Resubscribe a contact to the groups, he/she was unsubscribed from.
- *
- * @param int $job_id
- * The job ID.
- * @param int $queue_id
- * The Queue Event ID of the recipient.
- * @param string $hash
- * The hash.
- *
- * @return array|null
- * $groups Array of all groups to which the contact was added, or null if the queue event could not be found.
- */
- public static function &resub_to_mailing($job_id, $queue_id, $hash) {
- // First make sure there's a matching queue event.
- $q = CRM_Mailing_Event_BAO_Queue::verify($job_id, $queue_id, $hash);
- $success = NULL;
- if (!$q) {
- return $success;
- }
- // check if this queue_id was actually unsubscribed
- $ue = new CRM_Mailing_Event_BAO_Unsubscribe();
- $ue->event_queue_id = $queue_id;
- $ue->org_unsubscribe = 0;
- if (!$ue->find(TRUE)) {
- return $success;
- }
- $contact_id = $q->contact_id;
- $transaction = new CRM_Core_Transaction();
- $do = new CRM_Core_DAO();
- $mg = CRM_Mailing_DAO_MailingGroup::getTableName();
- $job = CRM_Mailing_BAO_MailingJob::getTableName();
- $mailing = CRM_Mailing_BAO_Mailing::getTableName();
- $group = CRM_Contact_BAO_Group::getTableName();
- $gc = CRM_Contact_BAO_GroupContact::getTableName();
- // We Need the mailing Id for the hook...
- $do->query("SELECT $job.mailing_id as mailing_id
- FROM $job
- WHERE $job.id = " . CRM_Utils_Type::escape($job_id, 'Integer'));
- $do->fetch();
- $mailing_id = $do->mailing_id;
- $do->query("
- SELECT $mg.entity_table as entity_table,
- $mg.entity_id as entity_id
- FROM $mg
- INNER JOIN $job
- ON $job.mailing_id = $mg.mailing_id
- INNER JOIN $group
- ON $mg.entity_id = $group.id
- WHERE $job.id = " . CRM_Utils_Type::escape($job_id, 'Integer') . "
- AND $mg.group_type IN ( 'Include', 'Base' )
- AND $group.is_hidden = 0"
- );
- // Make a list of groups and a list of prior mailings that received
- // this mailing.
- $groups = [];
- $mailings = [];
- while ($do->fetch()) {
- if ($do->entity_table == $group) {
- $groups[$do->entity_id] = NULL;
- }
- elseif ($do->entity_table == $mailing) {
- $mailings[] = $do->entity_id;
- }
- }
- // As long as we have prior mailings, find their groups and add to the
- // list.
- while (!empty($mailings)) {
- $do->query("
- SELECT $mg.entity_table as entity_table,
- $mg.entity_id as entity_id
- FROM $mg
- WHERE $mg.mailing_id IN (" . implode(', ', $mailings) . ")
- AND $mg.group_type = 'Include'");
- $mailings = [];
- while ($do->fetch()) {
- if ($do->entity_table == $group) {
- $groups[$do->entity_id] = TRUE;
- }
- elseif ($do->entity_table == $mailing) {
- $mailings[] = $do->entity_id;
- }
- }
- }
- $group_ids = array_keys($groups);
- $base_groups = NULL;
- CRM_Utils_Hook::unsubscribeGroups('resubscribe', $mailing_id, $contact_id, $group_ids, $base_groups);
- // Now we have a complete list of recipient groups. Filter out all
- // those except smart groups and those that the contact belongs to.
- $do->query("
- SELECT $group.id as group_id,
- $group.title as title
- FROM $group
- LEFT JOIN $gc
- ON $gc.group_id = $group.id
- WHERE $group.id IN (" . implode(', ', $group_ids) . ")
- AND ($group.saved_search_id is not null
- OR ($gc.contact_id = $contact_id
- AND $gc.status = 'Removed')
- )");
- while ($do->fetch()) {
- $groups[$do->group_id] = $do->title;
- }
- $contacts = [$contact_id];
- foreach ($groups as $group_id => $group_name) {
- $notadded = 0;
- if ($group_name) {
- list($total, $added, $notadded) = CRM_Contact_BAO_GroupContact::addContactsToGroup($contacts, $group_id, 'Email');
- }
- if ($notadded) {
- unset($groups[$group_id]);
- }
- }
- // remove entry from Unsubscribe table.
- $ue = new CRM_Mailing_Event_BAO_Unsubscribe();
- $ue->event_queue_id = $queue_id;
- $ue->org_resubscribe = 0;
- if ($ue->find(TRUE)) {
- $ue->delete();
- }
- $transaction->commit();
- return $groups;
- }
- /**
- * Send a response email informing the contact of the groups to which he/she
- * has been resubscribed.
- *
- * @param string $queue_id
- * The queue event ID.
- * @param array $groups
- * List of group IDs.
- * @param bool $is_domain
- * Is this domain-level?.
- * @param int $job
- * The job ID.
- */
- public static function send_resub_response($queue_id, $groups, $is_domain = FALSE, $job) {
- // param is_domain is not supported as of now.
- $config = CRM_Core_Config::singleton();
- $domain = CRM_Core_BAO_Domain::getDomain();
- $jobTable = CRM_Mailing_BAO_MailingJob::getTableName();
- $mailingTable = CRM_Mailing_DAO_Mailing::getTableName();
- $contacts = CRM_Contact_DAO_Contact::getTableName();
- $email = CRM_Core_DAO_Email::getTableName();
- $queue = CRM_Mailing_Event_BAO_Queue::getTableName();
- //get the default domain email address.
- list($domainEmailName, $domainEmailAddress) = CRM_Core_BAO_Domain::getNameAndEmail();
- $dao = new CRM_Mailing_BAO_Mailing();
- $dao->query(" SELECT * FROM $mailingTable
- INNER JOIN $jobTable ON
- $jobTable.mailing_id = $mailingTable.id
- WHERE $jobTable.id = $job");
- $dao->fetch();
- $component = new CRM_Mailing_BAO_MailingComponent();
- $component->id = $dao->resubscribe_id;
- $component->find(TRUE);
- $html = $component->body_html;
- if ($component->body_text) {
- $text = $component->body_text;
- }
- else {
- $text = CRM_Utils_String::htmlToText($component->body_html);
- }
- $eq = new CRM_Core_DAO();
- $eq->query(
- "SELECT $contacts.preferred_mail_format as format,
- $contacts.id as contact_id,
- $email.email as email,
- $queue.hash as hash
- FROM $contacts
- INNER JOIN $queue ON $queue.contact_id = $contacts.id
- INNER JOIN $email ON $queue.email_id = $email.id
- WHERE $queue.id = " . CRM_Utils_Type::escape($queue_id, 'Integer')
- );
- $eq->fetch();
- foreach ($groups as $key => $value) {
- if (!$value) {
- unset($groups[$key]);
- }
- }
- $message = new Mail_mime("\n");
- list($addresses, $urls) = CRM_Mailing_BAO_Mailing::getVerpAndUrls($job, $queue_id, $eq->hash, $eq->email);
- $bao = new CRM_Mailing_BAO_Mailing();
- $bao->body_text = $text;
- $bao->body_html = $html;
- $tokens = $bao->getTokens();
- if ($eq->format == 'HTML' || $eq->format == 'Both') {
- $html = CRM_Utils_Token::replaceDomainTokens($html, $domain, TRUE, $tokens['html']);
- $html = CRM_Utils_Token::replaceResubscribeTokens($html, $domain, $groups, TRUE, $eq->contact_id, $eq->hash);
- $html = CRM_Utils_Token::replaceActionTokens($html, $addresses, $urls, TRUE, $tokens['html']);
- $html = CRM_Utils_Token::replaceMailingTokens($html, $dao, NULL, $tokens['html']);
- $message->setHTMLBody($html);
- }
- if (!$html || $eq->format == 'Text' || $eq->format == 'Both') {
- $text = CRM_Utils_Token::replaceDomainTokens($text, $domain, TRUE, $tokens['text']);
- $text = CRM_Utils_Token::replaceResubscribeTokens($text, $domain, $groups, FALSE, $eq->contact_id, $eq->hash);
- $text = CRM_Utils_Token::replaceActionTokens($text, $addresses, $urls, FALSE, $tokens['text']);
- $text = CRM_Utils_Token::replaceMailingTokens($text, $dao, NULL, $tokens['text']);
- $message->setTxtBody($text);
- }
- $headers = [
- 'Subject' => $component->subject,
- 'From' => "\"$domainEmailName\" <" . CRM_Core_BAO_Domain::getNoReplyEmailAddress() . '>',
- 'To' => $eq->email,
- 'Reply-To' => CRM_Core_BAO_Domain::getNoReplyEmailAddress(),
- 'Return-Path' => CRM_Core_BAO_Domain::getNoReplyEmailAddress(),
- ];
- CRM_Mailing_BAO_Mailing::addMessageIdHeader($headers, 'e', $job, $queue_id, $eq->hash);
- $b = CRM_Utils_Mail::setMimeParams($message);
- $h = $message->headers($headers);
- $mailer = \Civi::service('pear_mail');
- if (is_object($mailer)) {
- $errorScope = CRM_Core_TemporaryErrorScope::ignoreException();
- $mailer->send($eq->email, $h, $b);
- unset($errorScope);
- }
- }
- }