anonymous_subscriptions.module

<?php

/**
 * @file
 * The Anonymous Subscriptions module.
 *
 * Module allows a non-registered user to your site
 * the ability to register for email notifications to certain pre-defined
 * content types. These notifications are optional on the pre-defined
 * content types with a flag displayed as to whether to send e-mails or not.
 */

use Drupal\Core\Url;
use Drupal\anonymous_subscriptions\Form\SettingsForm;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Link;

/**
 * Implements hook_help().
 */
function anonymous_subscriptions_help($route_name) {
  switch ($route_name) {
    case 'help.page.anonymous_subscriptions':
      $output = '<p>';
      $output .= '<p>' . t('Anonymous Subscriptions allows anonymous visitors to your site to subscribe to updates to nodes. The <a href="@anon">anonymous subscriptions administration page</a> allows you to configure options including whether emails need to be verified and which content types the option should appear to send notifications for.', [
        '@anon' => Url::fromRoute('anonymous_subscriptions.settings_form'),
      ]);
      $output .= '</p>';

      return $output;
  }

}

/**
 * Implements hook_theme().
 */
function anonymous_subscriptions_theme() {
  return [
    'anonymous_subscriptions_message' => [
      'variables' => [
        'title' => FALSE,
        'message' => FALSE,
        'link' => FALSE,
        'subscription' => FALSE,
      ],
      'template' => 'anonymous-subscriptions-message',
    ],
    'anonymous_subscriptions_notification_email' => [
      'variables' => [
        'body' => FALSE,
        'subscription_reason_text' => FALSE,
        'unsubscribe_url' => FALSE,
        'unsubscribe_all_url' => FALSE
      ],
      'template' => 'anonymous-subscriptions-notification-email',
    ],
  ];
}

/**
 * Implements hook_mail().
 */
function anonymous_subscriptions_mail($key, &$message, $params) {
  switch ($key) {
    case 'anonymous_subscriptions_key':
      $message['subject'] = $params['subject'];
      $message['body'][] = $params['body'];

      if (!isset($params['from'])) {
        $params['from'] = \Drupal::config('system.site')->get('mail');
      }

      if (!isset($params['sender'])) {
        $params['sender'] = \Drupal::config('system.site')->get('name');
      }
      $params['sender'] = '=?UTF-8?B?' . base64_encode($params['sender']) . '?=';

      $message['headers'] = array_merge($message['headers'], [
        'Content-Type' => 'text/html; charset=UTF-8;',
        'Content-Transfer-Encoding' => '8Bit',
        'MIME-Version' => '1.0',
        'From' => $params['from'],
        'Sender' => $params['from'],
      ]);

      if (isset($params['Cc'])) {
        $message['headers']['Cc'] = $params['Cc'];
      }

      if (isset($params['Bcc'])) {
        $message['headers']['Bcc'] = $params['Bcc'];
      }

      break;
  }
}

/**
 * Implements hook_form_BASE_FORM_ID_alter() for node_form().
 *
 * This is used to display the checkbox as to whether or not send the
 * notification for this particular node.
 */
function anonymous_subscriptions_form_node_form_alter(&$form, $form_state, $form_id) {
  $form_object = $form_state->getFormObject();
  /** @var \Drupal\node\NodeInterface $node */
  $node = $form_object->getEntity();
  $config = \Drupal::config(SettingsForm::$configName);
  $valid_types = $config->get('anonymous_subscriptions_node_types') ?: [];
  if (!empty($valid_types[$node->getType()])) {
    /** @var \Drupal\Core\Session\AccountInterface $current_user */
    $current_user = \Drupal::service('current_user');
    $form['options']['send_emails'] = [
      '#type' => 'checkbox',
      '#title' => t('Send e-mails to subscribers'),
      '#default_value' => $config->get('anonymous_subscriptions_send_default'),
      '#group' => 'options',
      '#access' => $current_user->hasPermission('alter anonymous_subscriptions') || $current_user->hasPermission('administer anonymous_subscriptions'),
      '#weight' => 10,
    ];
    $form['options']['send_test_email'] = [
      '#type' => 'checkbox',
      '#title' => t('Send test e-mails'),
      '#group' => 'options',
      '#access' => $current_user->hasPermission('alter anonymous_subscriptions') || $current_user->hasPermission('administer anonymous_subscriptions'),
      '#weight' => 11,
    ];
    $form['options']['send_test_email_emails'] = [
      '#type' => 'textfield',
      '#title' => t('Recipients of the test email'),
      '#group' => 'options',
      '#access' => $current_user->hasPermission('alter anonymous_subscriptions') || $current_user->hasPermission('administer anonymous_subscriptions'),
      '#weight' => 12,
      '#states' => [
        'visible' => [
          ':input[name="send_test_email"]' => ['checked' => TRUE],
        ],
      ],
    ];

    array_unshift($form['actions']['submit']['#submit'], 'anonymous_subscriptions_form_node_form_alter_submit');
  }
}

/**
 * Custom form submit callback.
 */
function anonymous_subscriptions_form_node_form_alter_submit(&$form, &$form_state) {
  /** @var \Drupal\node\NodeInterface $node */
  $node = $form_state->getFormObject()->getEntity();

  $tempStore = \Drupal::service('tempstore.shared')->get('anonymous_subscriptions');
  $id = $node->id() ?: 'new';

  if ($form_state->getValue('send_test_email')) {
    $test_emails = $form_state->getValue('send_test_email_emails');
    $emails = explode(',', $test_emails);
    if (!empty($emails)) {
      $tempStore->set('send_test_mail_emails:' . $node->getType() . ':' . $id, $emails);
    }
  }

  // Saving send email flag to temporary shared storage.
  $tempStore->set('send_mail:' . $node->getType() . ':' . $id, $form_state->getValue('send_emails'));
}

/**
 * Implements hook_node_insert().
 */
function anonymous_subscriptions_node_insert(\Drupal\node\NodeInterface $node) {
  $config = \Drupal::config(SettingsForm::$configName);
  $valid_types = $config->get('anonymous_subscriptions_node_types') ?: [];
  if (!empty($valid_types[$node->getType()])) {
    /** @var \Drupal\Core\TempStore\SharedTempStore $tempStore */
    $tempStore = \Drupal::service('tempstore.shared')->get('anonymous_subscriptions');

    // Getting the flag for the test email.
    $testEmails = $tempStore->get('send_test_mail_emails:' . $node->getType() . ':new');
    if ($testEmails) {
      \Drupal::service('anonymous_subscriptions.default')->sendTestEmail($node, $testEmails);
      // Deleting the flag.
      $tempStore->delete('send_test_mail_emails:' . $node->getType() . ':new');
    }

    // Getting the flag for the new node notification.
    $sendEmail = $tempStore->get('send_mail:' . $node->getType() . ':new');

    // Flag is present - we are dealing with node added via form.
    if (isset($sendEmail)) {
      // Checking the flag is TRUE.
      if ($sendEmail) {
        $tempStore->set('send_mail:' . $node->getType() . ':' . $node->id(), 'send_mail:' . $node->getType() . ':new');
      }
      // Deleting the flag.
      $tempStore->delete('send_mail:' . $node->getType() . ':new');
    }
    // Flag is missing - we are dealing with automatic creation, force email to be sent.
    else {
      $tempStore->set('send_mail:' . $node->getType() . ':' . $node->id(), 'send_mail:' . $node->getType() . ':new');
    }

    \Drupal::service('anonymous_subscriptions.default')->addPendingEmails($node);
  }
}

/**
 * Implements hook_node_update().
 */
function anonymous_subscriptions_node_update($node) {
  /** @var \Drupal\Core\TempStore\SharedTempStore $tempStore */
  $tempStore = \Drupal::service('tempstore.shared')->get('anonymous_subscriptions');

  // Getting the flag for the test email.
  $testEmails = $tempStore->get('send_test_mail_emails:' . $node->getType() . ':' . $node->id());
  if ($testEmails) {
    \Drupal::service('anonymous_subscriptions.default')->sendTestEmail($node, $testEmails);
    // Deleting the flag.
    $tempStore->delete('send_test_mail_emails:' . $node->getType() . ':' . $node->id());
  }

  \Drupal::service('anonymous_subscriptions.default')->addPendingEmails($node);
}

/**
 * Implements hook_module_implements_alter().
 */
function anonymous_subscriptions_module_implements_alter(&$implementations, $hook) {
  if ($hook == 'node_insert') {
    // Move anonymous_subscriptions_node_insert() to the end of the list.
    $group = $implementations['anonymous_subscriptions'];
    unset($implementations['anonymous_subscriptions']);
    $implementations['anonymous_subscriptions'] = $group;
  }
}

/**
 * Implements hook_form_FORM_ID_alter().
 */
function anonymous_subscriptions_form_field_config_edit_form_alter(array &$form, FormStateInterface $form_state) {
  /** @var \Drupal\field\FieldConfigInterface $field */
  $field = $form_state->getFormObject()->getEntity();
  if ($field->getTargetEntityTypeId() != 'node'
    || $field->getType() != 'entity_reference'
    || $field->getSetting('handler') != 'default:taxonomy_term') {
    return;
  }

  $config = \Drupal::config(SettingsForm::$configName);
  $valid_types = $config->get('anonymous_subscriptions_node_types') ?: [];
  $form['anonymous_subscriptions'] = [
    '#type' => 'checkbox',
    '#title' => t('Enable anonymous subscription for this reference'),
    '#default_value' => $field->getThirdPartySetting('anonymous_subscriptions', 'enabled', FALSE),
    '#disabled' => empty($valid_types[$field->getTargetBundle()]),
    '#description' => t('Be sure you have enabled content type for using anonymous subscriptions on @settings_link', [
      '@settings_link' => Link::fromTextAndUrl(t('settings page'), Url::fromRoute('anonymous_subscriptions.settings_form', ['destination' => Drupal::service('path.current')->getPath()]))->toString(),
    ]),
    '#weight' => -1,
  ];
  $form['actions']['submit']['#submit'][] = 'anonymous_subscriptions_field_config_edit_form_submit';
}

/**
 * Form submission handler for "field_config_edit_form" alter.
 *
 * @param array $form
 *   The form array.
 * @param \Drupal\Core\Form\FormStateInterface $form_state
 *   The form state.
 */
function anonymous_subscriptions_field_config_edit_form_submit(array $form, FormStateInterface $form_state) {
  $field = $form_state->getFormObject()->getEntity();
  $form_fields = &$form_state->getValues();

  // If the anonymous_subscription option is checked, update settings.
  if ($form_fields['anonymous_subscriptions']) {
    $field->setThirdPartySetting('anonymous_subscriptions', 'enabled', TRUE);
    $field->save();
  }
  else {
    $field->unsetThirdPartySetting('anonymous_subscriptions', 'enabled');
    $field->save();
  }
}

/**
 * Implements hook_form_BASE_FORM_ID_alter() for taxonomy_term_form().
 *
 * This is used to display the "Disable anonymous subscription" checkbox.
 */
function anonymous_subscriptions_form_taxonomy_term_form_alter(&$form, $form_state, $form_id) {
  $form_object = $form_state->getFormObject();
  /** @var Drupal\taxonomy\TermInterface $term */
  $term = $form_object->getEntity();
  /** @var Drupal\anonymous_subscriptions\DefaultService $service */
  $service = \Drupal::service('anonymous_subscriptions.default');

  if (!$service->isVocabularyAllowed($term->bundle()) || empty($term->id())) {
    return;
  }

  $config = \Drupal::config(SettingsForm::$configName);
  $anonymous_subscription_disabled_terms = $config->get('anonymous_subscription_disabled_terms') ?: [];
  $form['anonymous_subscription'] = [
    '#type' => 'details',
    '#title' => t('Anonymous subscription'),
    '#open' => in_array($term->id(), $anonymous_subscription_disabled_terms),
  ];

  $form['anonymous_subscription']['anonymous_subscription_disabled_terms'] = [
    '#type' => 'checkbox',
    '#title' => t('Disable subscription for this taxonomy term'),
    '#default_value' => in_array($term->id(), $anonymous_subscription_disabled_terms),
    '#weight' => 10,
    '#groups' => 'anonymous_subscription',
  ];

  array_unshift($form['actions']['submit']['#submit'], 'anonymous_subscriptions_form_taxonomy_term_form_alter_submit');

}

/**
 * Custom form submit callback for taxonomy_term_form.
 */
function anonymous_subscriptions_form_taxonomy_term_form_alter_submit(&$form, &$form_state) {
  $form_fields = &$form_state->getValues();

  /** @var Drupal\taxonomy\TermInterface $term */
  $term = $form_state->getFormObject()->getEntity();
  $config = \Drupal::configFactory()->getEditable(SettingsForm::$configName);
  $anonymous_subscription_disabled_terms = $config->get('anonymous_subscription_disabled_terms') ?: [];

  // Update disabled terms array.
  if ($form_fields['anonymous_subscription_disabled_terms']) {
    if (!in_array($term->id(), $anonymous_subscription_disabled_terms)) {
      $anonymous_subscription_disabled_terms[] = $term->id();
      $config->set('anonymous_subscription_disabled_terms', $anonymous_subscription_disabled_terms);
      $config->save();
    }
  }
  else {
    if (in_array($term->id(), $anonymous_subscription_disabled_terms)) {
      $key = array_search($term->id(), $anonymous_subscription_disabled_terms);
      unset($anonymous_subscription_disabled_terms[$key]);
      $config->set('anonymous_subscription_disabled_terms', $anonymous_subscription_disabled_terms);
      $config->save();
    }
  }
}