/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state, $snid = NULL, $timestamp = NULL, $hash = NULL)
{
$user = \Drupal::currentUser();
if ($subscriber = simplenews_subscriber_load_by_uid($user->id())) {
$this->setEntity($subscriber);
} elseif ($mail = $user->getEmail()) {
$this->setEntity(Subscriber::create(array('mail' => $mail)));
} elseif ($snid && $timestamp && $hash) {
$subscriber = simplenews_subscriber_load($snid);
if ($subscriber && $hash == simplenews_generate_hash($subscriber->getMail(), 'manage', $timestamp)) {
$this->setEntity($subscriber);
} else {
throw new NotFoundHttpException();
}
}
return parent::buildForm($form, $form_state);
}
/**
* 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();
}
/**
* 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 sending a newsletter to 100 recipients with caching enabled.
*/
function testSendCaching()
{
$this->setUpSubscribers(100);
$edit = array('title[0][value]' => $this->randomString(10), 'body[0][value]' => "Mail token: <strong>[simplenews-subscriber:mail]</strong>", 'simplenews_issue' => 'default');
$this->drupalPostForm('node/add/simplenews_issue', $edit, 'Save and publish');
$this->assertTrue(preg_match('|node/(\\d+)$|', $this->getUrl(), $matches), 'Node created');
$node = Node::load($matches[1]);
// Add node to spool.
\Drupal::service('simplenews.spool_storage')->addFromEntity($node);
// Unsubscribe one of the recipients to make sure that he doesn't receive
// the mail.
\Drupal::service('simplenews.subscription_manager')->unsubscribe(array_shift($this->subscribers), $this->getRandomNewsletter(), FALSE, 'test');
$before = microtime(TRUE);
\Drupal::service('simplenews.mailer')->sendSpool();
$after = microtime(TRUE);
// Make sure that 99 mails have been sent.
$this->assertEqual(99, count($this->drupalGetMails()));
// Test that tokens are correctly replaced.
foreach (array_slice($this->drupalGetMails(), 0, 3) as $mail) {
// Make sure that the same mail was used in the body token as it has been
// sent to. Also verify that the mail is plaintext.
$this->assertTrue(strpos($mail['body'], '*' . $mail['to'] . '*') !== FALSE);
$this->assertFalse(strpos($mail['body'], '<strong>'));
// Make sure the body is only attached once.
$this->assertEqual(1, preg_match_all('/Mail token/', $mail['body'], $matches));
$this->assertTrue(strpos($mail['body'], (string) t('Unsubscribe from this newsletter')));
// Make sure the mail has the correct unsubscribe hash.
$hash = simplenews_generate_hash($mail['to'], 'remove');
$this->assertTrue(strpos($mail['body'], $hash), 'Correct hash is used in footer');
$this->assertTrue(strpos($mail['headers']['List-Unsubscribe'], $hash), 'Correct hash is used in header');
}
// Report time. @todo: Find a way to actually do some assertions here.
$this->pass(t('Mails have been sent in @sec seconds with build caching enabled.', array('@sec' => round($after - $before, 3))));
}
