/**
* Menu callback: confirm the user's (un)subscription request
*
* This function is called by clicking the confirm link in the confirmation
* email or the unsubscribe link in the footer of the newsletter. It handles
* both subscription addition and subscription removal.
*
* @see simplenews_confirm_add_form()
* @see simplenews_confirm_removal_form()
*
* @param $action
* Either add or remove.
* @param $snid
* The subscriber id.
* @param $newsletter_id
* The newsletter id.
* @param $timestamp
* The timestamp of the request.
* @param $hash
* The confirmation hash.
*/
function confirmSubscription($action, $snid, $newsletter_id, $timestamp, $hash, $immediate = FALSE)
{
$config = \Drupal::config('simplenews.settings');
// Prevent search engines from indexing this page.
$html_head = array(array('#tag' => 'meta', '#attributes' => array('name' => 'robots', 'content' => 'noindex')), 'simplenews-noindex');
$subscriber = simplenews_subscriber_load($snid);
if ($subscriber && $hash == simplenews_generate_hash($subscriber->getMail(), $action, $timestamp)) {
$newsletter = simplenews_newsletter_load($newsletter_id);
// If the hash is valid but timestamp is too old, display form to request
// a new hash.
if ($timestamp < REQUEST_TIME - $config->get('hash_expiration')) {
$context = array('simplenews_subscriber' => $subscriber, 'newsletter' => $newsletter);
$token = $action == 'add' ? 'subscribe' : 'unsubscribe';
$build = \Drupal::formBuilder()->getForm('\\Drupal\\simplenews\\Form\\RequestHashForm', $token, $context);
$build['#attached']['html_head'][] = $html_head;
return $build;
}
// When called with additional arguments the user will be directed to the
// (un)subscribe confirmation page. The additional arguments will be passed
// on to the confirmation page.
if (!$immediate) {
if ($action == 'remove') {
$build = \Drupal::formBuilder()->getForm('\\Drupal\\simplenews\\Form\\ConfirmRemovalForm', $subscriber->getMail(), $newsletter);
$build['#attached']['html_head'][] = $html_head;
return $build;
} elseif ($action == 'add') {
$build = \Drupal::formBuilder()->getForm('\\Drupal\\simplenews\\Form\\ConfirmAddForm', $subscriber->getMail(), $newsletter);
$build['#attached']['html_head'][] = $html_head;
return $build;
}
} else {
/** @var \Drupal\simplenews\Subscription\SubscriptionManagerInterface $subscription_manager */
$subscription_manager = \Drupal::service('simplenews.subscription_manager');
if ($action == 'remove') {
$subscription_manager->unsubscribe($subscriber->getMail(), $newsletter_id, FALSE, 'website');
if ($path = $config->get('subscription.confirm_unsubscribe_page')) {
return $this->redirect(Url::fromUri("internal:/{$path}")->getRouteName());
}
drupal_set_message(t('%user was unsubscribed from the %newsletter mailing list.', array('%user' => $subscriber->getMail(), '%newsletter' => $newsletter->name)));
return $this->redirect('<front>');
} elseif ($action == 'add') {
$subscription_manager->subscribe($subscriber->getMail(), $newsletter_id, FALSE, 'website');
if ($path = $config->get('subscription.confirm_subscribe_page')) {
return $this->redirect(Url::fromUri("internal:/{$path}")->getRouteName());
}
drupal_set_message(t('%user was added to the %newsletter mailing list.', array('%user' => $subscriber->getMail(), '%newsletter' => $newsletter->name)));
return $this->redirect('<front>');
}
}
}
throw new NotFoundHttpException();
}
/**
* {@inheritdoc}
*/
public function getChangesList(SubscriberInterface $subscriber, $changes = NULL, $langcode = NULL)
{
if (empty($langcode)) {
$language = $this->languageManager->getCurrentLanguage();
$langcode = $language->getId();
}
if (empty($changes)) {
$changes = $subscriber->getChanges();
}
$changes_list = array();
foreach ($changes as $newsletter_id => $action) {
$subscribed = $subscriber->isSubscribed($newsletter_id);
// Get text for each possible combination.
if ($action == 'subscribe' && !$subscribed) {
$line = $this->config->get('subscription.confirm_combined_line_subscribe_unsubscribed');
} elseif ($action == 'subscribe' && $subscribed) {
$line = $this->config->get('subscription.confirm_combined_line_subscribe_subscribed');
} elseif ($action == 'unsubscribe' && !$subscribed) {
$line = $this->config->get('subscription.confirm_combined_line_unsubscribe_unsubscribed');
} elseif ($action == 'unsubscribe' && $subscribed) {
$line = $this->config->get('subscription.confirm_combined_line_unsubscribe_subscribed');
}
$newsletter_context = array('simplenews_subscriber' => $subscriber, 'newsletter' => simplenews_newsletter_load($newsletter_id));
$changes_list[$newsletter_id] = $this->token->replace($line, $newsletter_context, array('sanitize' => FALSE));
}
return $changes_list;
}
/**
* {@inheritdoc}
*/
public function sendCombinedConfirmation(SubscriberInterface $subscriber)
{
$params['from'] = $this->getFrom();
$params['context']['simplenews_subscriber'] = $subscriber;
// Send multiple if there is more than one change for this subscriber
// single otherwise.
$use_combined = $this->config->get('subscription.use_combined');
$changes = $subscriber->getChanges();
if (count($changes) > 1 && $use_combined != 'never' || $use_combined == 'always') {
$key = 'subscribe_combined';
$this->mailManager->mail('simplenews', $key, $subscriber->getMail(), $subscriber->getLangcode(), $params, $params['from']['address']);
} else {
foreach ($changes as $newsletter_id => $key) {
$params['context']['newsletter'] = simplenews_newsletter_load($newsletter_id);
$this->mailManager->mail('simplenews', $key, $subscriber->getMail(), $subscriber->getLangcode(), $params, $params['from']['address']);
}
}
}
/**
* testSubscribeAnonymous
*
* Steps performed:
* 0. Preparation
* 1. Subscribe anonymous via block
* 2. Subscribe anonymous via subscription page
* 3. Subscribe anonymous via multi block
*/
function testSubscribeAnonymous()
{
// 0. Preparation
// Login admin
// Set permission for anonymous to subscribe
// Enable newsletter block
// Logout admin
$admin_user = $this->drupalCreateUser(array('administer blocks', 'administer content types', 'administer nodes', 'access administration pages', 'administer newsletters', 'administer permissions'));
$this->drupalLogin($admin_user);
// Create some newsletters for multi-sign up block.
$this->drupalGet('admin/config/services/simplenews');
for ($i = 0; $i < 5; $i++) {
$this->clickLink(t('Add newsletter'));
$name = $this->randomMachineName();
$edit = array('name' => $name, 'id' => strtolower($name), 'description' => $this->randomString(20), 'opt_inout' => 'double');
$this->drupalPostForm(NULL, $edit, t('Save'));
}
$newsletter_id = $this->getRandomNewsletter();
$this->drupalLogout();
//file_put_contents('output.html', $this->drupalGetContent());
// 1. Subscribe anonymous via block
// Subscribe + submit
// Assert confirmation message
// Assert outgoing email
//
// Confirm using mail link
// Confirm using mail link
// Assert confirmation message
// Setup subscription block with subscription form.
$block_settings = array('newsletters' => array($newsletter_id), 'message' => $this->randomMachineName(4));
$single_block = $this->setupSubscriptionBlock($block_settings);
// Testing invalid email error message.
$mail = '@example.com';
$edit = array('mail[0][value]' => $mail);
$this->drupalPostForm('', $edit, t('Subscribe'));
$this->assertText(t("The email address {$mail} is not valid"), t("Invalid email shows error."));
// Now with valid email.
$mail = $this->randomEmail(8);
$edit = array('mail[0][value]' => $mail);
$this->drupalPostForm('', $edit, t('Subscribe'));
$this->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to complete your subscription.'), t('Subscription confirmation e-mail sent.'));
$subscriber = simplenews_subscriber_load_by_mail($mail);
$this->assertNotNull($subscriber, 'New subscriber entity successfully loaded.');
$subscription = $subscriber->getSubscription($newsletter_id);
$this->assertEqual(SIMPLENEWS_SUBSCRIPTION_STATUS_UNCONFIRMED, $subscription->status, t('Subscription is unconfirmed'));
$confirm_url = $this->extractConfirmationLink($this->getMail(0));
$this->drupalGet($confirm_url);
$newsletter = simplenews_newsletter_load($newsletter_id);
$this->assertRaw(t('Are you sure you want to add %user to the %newsletter mailing list?', array('%user' => simplenews_mask_mail($mail), '%newsletter' => $newsletter->name)), t('Subscription confirmation found.'));
$this->drupalPostForm(NULL, array(), t('Subscribe'));
$this->assertRaw(t('%user was added to the %newsletter mailing list.', array('%user' => $mail, '%newsletter' => $newsletter->name)), t('Anonymous subscriber added to newsletter'));
// Test that it is possible to register with a mail address that is already
// a subscriber.
$site_config = $this->config('user.settings');
$site_config->set('register', 'visitors');
$site_config->set('verify_mail', false);
$site_config->save();
$edit = array('name' => $this->randomMachineName(), 'mail' => $mail, 'pass[pass1]' => $pass = $this->randomMachineName(), 'pass[pass2]' => $pass);
$this->drupalPostForm('user/register', $edit, t('Create new account'));
// Verify confirmation messages.
$this->assertText(t('Registration successful. You are now logged in.'));
// Verify that the subscriber has been updated and references to the correct
// user.
\Drupal::entityManager()->getStorage('simplenews_subscriber')->resetCache();
$subscriber = simplenews_subscriber_load_by_mail($mail);
$account = user_load_by_mail($mail);
$this->assertEqual($subscriber->getUserId(), $account->id());
$this->assertEqual($account->getUsername(), $edit['name']);
$this->drupalLogout();
// Disable the newsletter block.
$single_block->delete();
// 2. Subscribe anonymous via subscription page
// Subscribe + submit
// Assert confirmation message
// Assert outgoing email
//
// Confirm using mail link
// Confirm using mail link
// Assert confirmation message
$mail = $this->randomEmail(8);
$edit = array("subscriptions[{$newsletter_id}]" => '1', 'mail[0][value]' => $mail);
$this->drupalPostForm('newsletter/subscriptions', $edit, t('Subscribe'));
$this->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to complete your subscription.'), t('Subscription confirmation e-mail sent.'));
$confirm_url = $this->extractConfirmationLink($this->getMail(2));
$this->drupalGet($confirm_url);
$newsletter = simplenews_newsletter_load($newsletter_id);
$this->assertRaw(t('Are you sure you want to add %user to the %newsletter mailing list?', array('%user' => simplenews_mask_mail($mail), '%newsletter' => $newsletter->name)), t('Subscription confirmation found.'));
$this->drupalPostForm($confirm_url, array(), t('Subscribe'));
$this->assertRaw(t('%user was added to the %newsletter mailing list.', array('%user' => $mail, '%newsletter' => $newsletter->name)), t('Anonymous subscriber added to newsletter'));
// 3. Subscribe anonymous via multi block
// Setup subscription block with subscription form.
$block_settings = array('newsletters' => array_keys(simplenews_newsletter_get_all()), 'message' => $this->randomMachineName(4));
$multi_block = $this->setupSubscriptionBlock($block_settings);
// Try to submit multi-signup form without selecting a newsletter.
$mail = $this->randomEmail(8);
$edit = array('mail[0][value]' => $mail);
$this->drupalPostForm('', $edit, t('Subscribe'));
$this->assertText(t('You must select at least one newsletter.'));
// Now fill out the form and try again. The e-mail should still be listed.
$edit = array('subscriptions[' . $newsletter_id . ']' => TRUE);
$this->drupalPostForm(NULL, $edit, t('Subscribe'));
$this->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to complete your subscription.'));
$confirm_url = $this->extractConfirmationLink($this->getMail(3));
$this->drupalGet($confirm_url);
$newsletter = simplenews_newsletter_load($newsletter_id);
$this->assertRaw(t('Are you sure you want to add %user to the %newsletter mailing list?', array('%user' => simplenews_mask_mail($mail), '%newsletter' => $newsletter->name)), t('Subscription confirmation found.'));
$this->drupalPostForm($confirm_url, array(), t('Subscribe'));
$this->assertRaw(t('%user was added to the %newsletter mailing list.', array('%user' => $mail, '%newsletter' => $newsletter->name)), t('Anonymous subscriber added to newsletter'));
// Try to subscribe again, this should not re-set the status to unconfirmed.
$edit = array('mail[0][value]' => $mail, 'subscriptions[' . $newsletter_id . ']' => TRUE);
$this->drupalPostForm(NULL, $edit, t('Subscribe'));
$this->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to complete your subscription.'));
$subscriber = simplenews_subscriber_load_by_mail($mail);
$this->assertNotEqual($subscriber, FALSE, 'New subscriber entity successfully loaded.');
$subscription = $subscriber->getSubscription($newsletter_id);
$this->assertEqual(SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED, $subscription->status);
// Now the same with the newsletter/subscriptions page.
$mail = $this->randomEmail(8);
$edit = array('mail[0][value]' => $mail);
$this->drupalPostForm('newsletter/subscriptions', $edit, t('Subscribe'));
$this->assertText(t('You must select at least one newsletter.'));
// Now fill out the form and try again.
$edit = array('subscriptions[' . $newsletter_id . ']' => TRUE);
$this->drupalPostForm(NULL, $edit, t('Subscribe'));
$this->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to complete your subscription.'));
$confirm_url = $this->extractConfirmationLink($this->getMail(5));
$this->drupalGet($confirm_url);
$newsletter = simplenews_newsletter_load($newsletter_id);
$this->assertRaw(t('Are you sure you want to add %user to the %newsletter mailing list?', array('%user' => simplenews_mask_mail($mail), '%newsletter' => $newsletter->name)), t('Subscription confirmation found.'));
$this->drupalPostForm($confirm_url, array(), t('Subscribe'));
$this->assertRaw(t('%user was added to the %newsletter mailing list.', array('%user' => $mail, '%newsletter' => $newsletter->name)), t('Anonymous subscriber added to newsletter'));
// Test unsubscribe on newsletter/subscriptions page.
$edit = array('mail[0][value]' => $mail);
$this->drupalPostForm('newsletter/subscriptions', $edit, t('Unsubscribe'));
$this->assertText(t('You must select at least one newsletter.'));
// Now fill out the form and try again.
$edit = array('subscriptions[' . $newsletter_id . ']' => TRUE);
$this->drupalPostForm(NULL, $edit, t('Unsubscribe'));
$this->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to cancel your subscription.'));
$this->assertMailText(t('We have received a request to remove the @mail', array('@mail' => $mail)), 6);
$confirm_url = $this->extractConfirmationLink($this->getMail(6));
$mails = $this->drupalGetMails();
$this->assertEqual($mails[0]['from'], '*****@*****.**');
$this->assertEqual($mails[0]['headers']['From'], '"Drupal" <*****@*****.**>');
$this->drupalGet($confirm_url);
$newsletter = simplenews_newsletter_load($newsletter_id);
$this->assertRaw(t('Are you sure you want to remove %user from the %newsletter mailing list?', array('%user' => simplenews_mask_mail($mail), '%newsletter' => $newsletter->name)), t('Subscription confirmation found.'));
$this->drupalPostForm($confirm_url, array(), t('Unsubscribe'));
$this->assertRaw(t('%user was unsubscribed from the %newsletter mailing list.', array('%user' => $mail, '%newsletter' => $newsletter->name)), t('Anonymous subscriber removed from newsletter'));
// Visit the newsletter/subscriptions page with the hash.
$subscriber = simplenews_subscriber_load_by_mail($mail);
$hash = simplenews_generate_hash($subscriber->getMail(), 'manage');
$this->drupalGet('newsletter/subscriptions/' . $subscriber->id() . '/' . REQUEST_TIME . '/' . $hash);
$this->assertText(t('Subscriptions for @mail', array('@mail' => $mail)));
$edit = array('subscriptions[' . $newsletter_id . ']' => TRUE);
$this->drupalPostForm(NULL, $edit, t('Update'));
$this->assertText(t('The newsletter subscriptions for @mail have been updated.', array('@mail' => $mail)));
// Make sure the subscription is confirmed.
\Drupal::entityManager()->getStorage('simplenews_subscriber')->resetCache();
$subscriber = simplenews_subscriber_load_by_mail($mail);
$this->assertTrue($subscriber->isSubscribed($newsletter_id));
$subscription = $subscriber->getSubscription($newsletter_id);
$this->assertEqual(SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED, $subscription->status);
// Attempt to fetch the page using a wrong hash but correct format.
$hash = simplenews_generate_hash($subscriber->getMail() . 'a', 'manage');
$this->drupalGet('newsletter/subscriptions/' . $subscriber->id() . '/' . REQUEST_TIME . '/' . $hash);
$this->assertResponse(404);
// Attempt to unsubscribe a non-existing subscriber.
$mail = $this->randomEmail();
$edit = array('mail[0][value]' => $mail, 'subscriptions[' . $newsletter_id . ']' => TRUE);
$this->drupalPostForm('newsletter/subscriptions', $edit, t('Unsubscribe'));
$this->assertText(t('You will receive a confirmation e-mail shortly containing further instructions on how to cancel your subscription.'));
$this->assertMailText('is not subscribed to this mailing list', 7);
// Test expired confirmation links.
$edit = array('mail[0][value]' => $mail, 'subscriptions[' . $newsletter_id . ']' => TRUE);
$this->drupalPostForm('newsletter/subscriptions', $edit, t('Subscribe'));
$subscriber = simplenews_subscriber_load_by_mail($mail);
$expired_timestamp = REQUEST_TIME - 86401;
$hash = simplenews_generate_hash($subscriber->getMail(), 'add', $expired_timestamp);
$url = 'newsletter/confirm/add/' . $subscriber->id() . '/' . $newsletter_id . '/' . $expired_timestamp . '/' . $hash;
$this->drupalGet($url);
$this->assertText(t('This link has expired.'));
$this->drupalPostForm(NULL, array(), t('Request new confirmation mail'));
$confirm_url = $this->extractConfirmationLink($this->getMail(9));
$this->drupalGet($confirm_url);
$newsletter = simplenews_newsletter_load($newsletter_id);
$this->assertRaw(t('Are you sure you want to add %user to the %newsletter mailing list?', array('%user' => simplenews_mask_mail($mail), '%newsletter' => $newsletter->name)), t('Subscription confirmation found.'));
$this->drupalPostForm($confirm_url, array(), t('Subscribe'));
$this->assertRaw(t('%user was added to the %newsletter mailing list.', array('%user' => $mail, '%newsletter' => $newsletter->name)), t('Anonymous subscriber added to newsletter'));
// Make sure the subscription is confirmed now.
\Drupal::entityManager()->getStorage('simplenews_subscriber')->resetCache();
$subscriber = simplenews_subscriber_load_by_mail($mail);
$this->assertTrue($subscriber->isSubscribed($newsletter_id));
$subscription = $subscriber->getSubscription($newsletter_id);
$this->assertEqual(SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED, $subscription->status);
}
/**
* Test newsletter subscription management.
*
* Steps performed:
*/
function testSubscriptionManagement()
{
$admin_user = $this->drupalCreateUser(array('administer newsletters', 'administer simplenews settings', 'administer simplenews subscriptions', 'administer users'));
$this->drupalLogin($admin_user);
// Create a newsletter.
$newsletter_name = Unicode::strtolower($this->randomMachineName());
$edit = array('name' => $newsletter_name, 'id' => $newsletter_name);
$this->drupalPostForm('admin/config/services/simplenews/add', $edit, t('Save'));
// Add a number of users to each newsletter separately and then add another
// bunch to both.
$subscribers = array();
$groups = array();
$newsletters = simplenews_newsletter_get_all();
foreach ($newsletters as $newsletter) {
$groups[$newsletter->id()] = array($newsletter->id());
}
$groups['all'] = array_keys($groups);
$subscribers_flat = array();
foreach ($groups as $key => $group) {
for ($i = 0; $i < 5; $i++) {
$mail = $this->randomEmail();
$subscribers[$key][$mail] = $mail;
$subscribers_flat[$mail] = $mail;
}
}
// Create a user and assign him one of the mail addresses of the all group.
$user = $this->drupalCreateUser(array('subscribe to newsletters'));
// Make sure that user_save() does not update the user object, as it will
// override the pass_raw property which we'll need to log this user in
// later on.
$user_mail = current($subscribers['all']);
$user->setEmail($user_mail);
$user->save();
$delimiters = array(',', ' ', "\n");
// Visit subscribers by clicking menu tab in people.
$this->drupalGet('admin/people');
$this->clickLink('Subscribers');
$i = 0;
foreach ($groups as $key => $group) {
$this->clickLink(t('Mass subscribe'));
$edit = array('emails' => implode($delimiters[$i++], $subscribers[$key]));
foreach ($group as $newsletter_id) {
$edit['newsletters[' . $newsletter_id . ']'] = TRUE;
}
$this->drupalPostForm(NULL, $edit, t('Subscribe'));
}
// The user to which the mail was assigned should be listed too.
$this->assertText($user->label());
// Verify that all addresses are displayed in the table.
$rows = $this->xpath('//tbody/tr');
$mail_addresses = array();
for ($i = 0; $i < count($subscribers_flat); $i++) {
$mail_addresses[] = trim((string) $rows[$i]->td[0]);
}
$this->assertEqual(15, count($mail_addresses));
foreach ($mail_addresses as $mail_address) {
$mail_address = (string) $mail_address;
$this->assertTrue(isset($subscribers_flat[$mail_address]));
unset($subscribers_flat[$mail_address]);
}
// All entries of the array should be removed by now.
$this->assertTrue(empty($subscribers_flat));
reset($groups);
$first = 'default';
$first_mail = array_rand($subscribers[$first]);
$all_mail = array_rand($subscribers['all']);
// Limit list to subscribers of the first newsletter only.
// Build a flat list of the subscribers of this list.
$subscribers_flat = array_merge($subscribers[$first], $subscribers['all']);
$this->drupalGet('admin/people/simplenews', array('query' => array('subscriptions_target_id' => $first)));
// Verify that all addresses are displayed in the table.
$rows = $this->xpath('//tbody/tr');
$mail_addresses = array();
for ($i = 0; $i < count($subscribers_flat); $i++) {
$mail_addresses[] = trim((string) $rows[$i]->td[0]);
}
$this->assertEqual(10, count($mail_addresses));
foreach ($mail_addresses as $mail_address) {
$mail_address = (string) $mail_address;
$this->assertTrue(isset($subscribers_flat[$mail_address]));
unset($subscribers_flat[$mail_address]);
}
// All entries of the array should be removed by now.
$this->assertTrue(empty($subscribers_flat));
// Filter a single mail address, the one assigned to a user.
$edit = array('mail' => Unicode::substr(current($subscribers['all']), 0, 4));
$this->drupalGet('admin/people/simplenews', array('query' => array('mail' => $edit['mail'])));
$rows = $this->xpath('//tbody/tr');
$this->assertEqual(1, count($rows));
$this->assertEqual(current($subscribers['all']), trim((string) $rows[0]->td[0]));
$this->assertEqual($user->label(), trim((string) $rows[0]->td[1]->span));
// Reset the filter.
$this->drupalGet('admin/people/simplenews');
// Test mass-unsubscribe, unsubscribe one from the first group and one from
// the all group, but only from the first newsletter.
unset($subscribers[$first][$first_mail]);
$edit = array('emails' => $first_mail . ', ' . $all_mail, 'newsletters[' . $first . ']' => TRUE);
$this->clickLink(t('Mass unsubscribe'));
$this->drupalPostForm(NULL, $edit, t('Unsubscribe'));
// The all mail is still displayed because it's still subscribed to the
// second newsletter. Reload the page to get rid of the confirmation
// message.
$this->drupalGet('admin/people/simplenews');
$this->assertNoText($first_mail);
$this->assertText($all_mail);
// Limit to first newsletter, the all mail shouldn't be shown anymore.
$this->drupalGet('admin/people/simplenews', array('query' => array('subscriptions_target_id' => $first)));
$this->assertNoText($first_mail);
$this->assertNoText($all_mail);
// Check exporting.
$this->clickLink(t('Export'));
$this->drupalPostForm(NULL, array('newsletters[' . $first . ']' => TRUE), t('Export'));
$export_field = $this->xpath($this->constructFieldXpath('name', 'emails'));
$exported_mails = (string) $export_field[0];
foreach ($subscribers[$first] as $mail) {
$this->assertTrue(strpos($exported_mails, $mail) !== FALSE, t('Mail address exported correctly.'));
}
foreach ($subscribers['all'] as $mail) {
if ($mail != $all_mail) {
$this->assertTrue(strpos($exported_mails, $mail) !== FALSE, t('Mail address exported correctly.'));
} else {
$this->assertFALSE(strpos($exported_mails, $mail) !== FALSE, t('Unsubscribed mail address not exported.'));
}
}
// Only export unsubscribed mail addresses.
$edit = array('subscribed[subscribed]' => FALSE, 'subscribed[unsubscribed]' => TRUE, 'newsletters[' . $first . ']' => TRUE);
$this->drupalPostForm(NULL, $edit, t('Export'));
$export_field = $this->xpath($this->constructFieldXpath('name', 'emails'));
$exported_mails = (string) $export_field[0];
$exported_mails = explode(', ', $exported_mails);
$this->assertEqual(2, count($exported_mails));
$this->assertTrue(in_array($all_mail, $exported_mails));
$this->assertTrue(in_array($first_mail, $exported_mails));
/** @var \Drupal\simplenews\Subscription\SubscriptionManagerInterface $subscription_manager */
$subscription_manager = \Drupal::service('simplenews.subscription_manager');
// Make sure there are unconfirmed subscriptions.
$unconfirmed = array();
$unconfirmed[] = $this->randomEmail();
$unconfirmed[] = $this->randomEmail();
foreach ($unconfirmed as $mail) {
$subscription_manager->subscribe($mail, $first, TRUE);
}
// Only export unconfirmed mail addresses.
$edit = array('subscribed[subscribed]' => FALSE, 'subscribed[unconfirmed]' => TRUE, 'subscribed[unsubscribed]' => FALSE, 'newsletters[' . $first . ']' => TRUE);
$this->drupalPostForm(NULL, $edit, t('Export'));
$export_field = $this->xpath($this->constructFieldXpath('name', 'emails'));
$exported_mails = (string) $export_field[0];
$exported_mails = explode(', ', $exported_mails);
$this->assertEqual(2, count($exported_mails));
$this->assertTrue(in_array($unconfirmed[0], $exported_mails));
$this->assertTrue(in_array($unconfirmed[1], $exported_mails));
// Make sure the user is subscribed to the first newsletter_id.
$subscription_manager->subscribe($user_mail, $first, FALSE);
$before_count = simplenews_count_subscriptions($first);
// Block the user.
$user->block();
$user->save();
$this->drupalGet('admin/people/simplenews');
// Verify updated subscriptions count.
drupal_static_reset('simplenews_count_subscriptions');
$after_count = simplenews_count_subscriptions($first);
$this->assertEqual($before_count - 1, $after_count, t('Blocked users are not counted in subscription count.'));
// Test mass subscribe with previously unsubscribed users.
for ($i = 0; $i < 3; $i++) {
$tested_subscribers[] = $this->randomEmail();
}
$subscription_manager->subscribe($tested_subscribers[0], $first, FALSE);
$subscription_manager->subscribe($tested_subscribers[1], $first, FALSE);
$subscription_manager->unsubscribe($tested_subscribers[0], $first, FALSE);
$subscription_manager->unsubscribe($tested_subscribers[1], $first, FALSE);
$unsubscribed = implode(', ', array_slice($tested_subscribers, 0, 2));
$edit = array('emails' => implode(', ', $tested_subscribers), 'newsletters[' . $first . ']' => TRUE);
$this->drupalPostForm('admin/people/simplenews/import', $edit, t('Subscribe'));
\Drupal::entityManager()->getStorage('simplenews_subscriber')->resetCache();
$subscription_manager->reset();
$this->assertFalse($subscription_manager->isSubscribed($tested_subscribers[0], $first), t('Subscriber not resubscribed through mass subscription.'));
$this->assertFalse($subscription_manager->isSubscribed($tested_subscribers[1], $first), t('Subscriber not resubscribed through mass subscription.'));
$this->assertTrue($subscription_manager->isSubscribed($tested_subscribers[2], $first), t('Subscriber subscribed through mass subscription.'));
$substitutes = array('@name' => SafeMarkup::checkPlain(simplenews_newsletter_load($first)->label()), '@mail' => $unsubscribed);
$this->assertText(t('The following addresses were skipped because they have previously unsubscribed from @name: @mail.', $substitutes));
$this->assertText(t("If you would like to resubscribe them, use the 'Force resubscription' option."));
// Try to mass subscribe without specifying newsletters.
$tested_subscribers[2] = $this->randomEmail();
$edit = array('emails' => implode(', ', $tested_subscribers), 'resubscribe' => TRUE);
$this->drupalPostForm('admin/people/simplenews/import', $edit, t('Subscribe'));
$this->assertText('Subscribe to field is required.');
// Test mass subscribe with previously unsubscribed users and force
// resubscription.
$tested_subscribers[2] = $this->randomEmail();
$edit = array('emails' => implode(', ', $tested_subscribers), 'newsletters[' . $first . ']' => TRUE, 'resubscribe' => TRUE);
$this->drupalPostForm('admin/people/simplenews/import', $edit, t('Subscribe'));
$subscription_manager->reset();
\Drupal::entityManager()->getStorage('simplenews_subscriber')->resetCache();
$this->assertTrue($subscription_manager->isSubscribed($tested_subscribers[0], $first, t('Subscriber resubscribed trough mass subscription.')));
$this->assertTrue($subscription_manager->isSubscribed($tested_subscribers[1], $first, t('Subscriber resubscribed trough mass subscription.')));
$this->assertTrue($subscription_manager->isSubscribed($tested_subscribers[2], $first, t('Subscriber subscribed trough mass subscription.')));
// Try to mass unsubscribe without specifying newsletters.
$tested_subscribers[2] = $this->randomEmail();
$edit = array('emails' => implode(', ', $tested_subscribers));
$this->drupalPostForm('admin/people/simplenews/unsubscribe', $edit, t('Unsubscribe'));
$this->assertText('Unsubscribe from field is required.');
// Create two blocks, to ensure that they are updated/deleted when a
// newsletter is deleted.
$only_first_block = $this->setupSubscriptionBlock(['newsletters' => [$first]]);
$all_block = $this->setupSubscriptionBlock(['newsletters' => array_keys($groups)]);
$enabled_newsletters = $all_block->get('settings')['newsletters'];
$this->assertTrue(in_array($first, $enabled_newsletters));
// Delete newsletter.
\Drupal::entityManager()->getStorage('simplenews_newsletter')->resetCache();
$this->drupalGet('admin/config/services/simplenews/manage/' . $first);
$this->clickLink(t('Delete'));
$this->drupalPostForm(NULL, array(), t('Delete'));
$this->assertText(t('All subscriptions to newsletter @newsletter have been deleted.', array('@newsletter' => $newsletters[$first]->name)));
// Verify that all related data has been deleted/updated.
$this->assertNull(Newsletter::load($first));
$this->assertNull(Block::load($only_first_block->id()));
$all_block = Block::load($all_block->id());
$enabled_newsletters = $all_block->get('settings')['newsletters'];
$this->assertFalse(in_array($first, $enabled_newsletters));
// Verify that all subscriptions of that newsletter have been removed.
$this->drupalGet('admin/people/simplenews');
foreach ($subscribers[$first] as $mail) {
$this->assertNoText($mail);
}
$this->clickLink(t('Edit'), 1);
// Get the subscriber id from the path.
$this->assertTrue(preg_match('|admin/people/simplenews/edit/(\\d+)\\?destination|', $this->getUrl(), $matches), 'Subscriber found');
$subscriber = Subscriber::load($matches[1]);
$this->assertTitle(t('Edit subscriber @mail', array('@mail' => $subscriber->getMail())) . ' | Drupal');
$this->assertFieldChecked('edit-status');
// Disable account.
$edit = array('status' => FALSE);
$this->drupalPostForm(NULL, $edit, t('Save'));
\Drupal::entityManager()->getStorage('simplenews_subscriber')->resetCache();
$subscription_manager->reset();
$this->assertFalse($subscription_manager->isSubscribed($subscriber->getMail(), $this->getRandomNewsletter()), t('Subscriber is not active'));
// Re-enable account.
$this->drupalGet('admin/people/simplenews/edit/' . $subscriber->id());
$this->assertTitle(t('Edit subscriber @mail', array('@mail' => $subscriber->getMail())) . ' | Drupal');
$this->assertNoFieldChecked('edit-status');
$edit = array('status' => TRUE);
$this->drupalPostForm(NULL, $edit, t('Save'));
\Drupal::entityManager()->getStorage('simplenews_subscriber')->resetCache();
$subscription_manager->reset();
$this->assertTrue($subscription_manager->isSubscribed($subscriber->getMail(), $this->getRandomNewsletter()), t('Subscriber is active again.'));
// Remove the newsletter.
$this->drupalGet('admin/people/simplenews/edit/' . $subscriber->id());
$this->assertTitle(t('Edit subscriber @mail', array('@mail' => $subscriber->getMail())) . ' | Drupal');
\Drupal::entityManager()->getStorage('simplenews_subscriber')->resetCache();
$subscriber = Subscriber::load($subscriber->id());
$nlids = $subscriber->getSubscribedNewsletterIds();
// If the subscriber still has subscribed to newsletter, try to unsubscribe.
$newsletter_id = reset($nlids);
$edit['subscriptions[' . $newsletter_id . ']'] = FALSE;
$this->drupalPostForm(NULL, $edit, t('Save'));
\Drupal::entityManager()->getStorage('simplenews_subscriber')->resetCache();
$subscription_manager->reset();
$nlids = $subscriber->getSubscribedNewsletterIds();
$this->assertFalse($subscription_manager->isSubscribed($subscriber->getMail(), reset($nlids)), t('Subscriber not subscribed anymore.'));
// @todo Test Admin subscriber edit preferred language $subscription->language
// Register a subscriber with an insecure e-mail address through the API
// and make sure the address is correctly encoded.
$xss_mail = "<script>alert('XSS');</script>";
$subscription_manager->subscribe($xss_mail, $this->getRandomNewsletter(), FALSE);
$this->drupalGet('admin/people/simplenews');
$this->assertNoRaw($xss_mail);
$this->assertRaw(SafeMarkup::checkPlain($xss_mail));
$xss_subscriber = simplenews_subscriber_load_by_mail($xss_mail);
$this->drupalGet('admin/people/simplenews/edit/' . $xss_subscriber->id());
$this->assertNoRaw($xss_mail);
$this->assertRaw(SafeMarkup::checkPlain($xss_mail));
// Create a new user for the next test.
$new_user = $this->drupalCreateUser(array('subscribe to newsletters'));
// Test for saving the subscription for no newsletter.
$this->drupalPostForm('user/' . $new_user->id() . '/simplenews', null, t('Save'));
$this->assertText('The newsletter subscriptions for user ' . $new_user->getUsername() . ' have been updated.');
// Editing a subscriber with subscription.
$edit = array('subscriptions[' . $newsletter_name . ']' => TRUE, 'status' => TRUE, 'mail[0][value]' => '*****@*****.**');
$this->drupalPostForm('admin/people/simplenews/edit/' . $xss_subscriber->id(), $edit, t('Save'));
$this->assertText('Subscriber edit@example.com has been updated.');
// Create a second newsletter.
$second_newsletter_name = Unicode::strtolower($this->randomMachineName());
$edit2 = array('name' => $second_newsletter_name, 'id' => $second_newsletter_name);
$this->drupalPostForm('admin/config/services/simplenews/add', $edit2, t('Save'));
// Test for adding a subscriber.
$subscribe = array('newsletters[' . $newsletter_name . ']' => TRUE, 'emails' => '*****@*****.**');
$this->drupalPostForm('admin/people/simplenews/import', $subscribe, t('Subscribe'));
// The subscriber should appear once in the list.
$rows = $this->xpath('//tbody/tr');
$counter = 0;
foreach ($rows as $value) {
if (trim((string) $value->td[0]) == '*****@*****.**') {
$counter++;
}
}
$this->assertEqual(1, $counter);
$this->assertText(t('The following addresses were added or updated: @email.', ['@email' => '*****@*****.**']));
$this->assertText(t('The addresses were subscribed to the following newsletters: @newsletter.', ['@newsletter' => $newsletter_name]));
// Check exact subscription statuses.
$subscriber = simplenews_subscriber_load_by_mail('*****@*****.**');
$this->assertEqual($subscriber->getSubscription($newsletter_name)->get('status')->getValue(), SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED);
// The second newsletter was not subscribed, so there should be no
// subscription record at all.
$this->assertFalse($subscriber->getSubscription($second_newsletter_name));
}
