X-Git-Url: http://aleph1.co.uk/gitweb/?a=blobdiff_plain;f=web%2Fcore%2Fmodules%2Fsystem%2Ftests%2Fsrc%2FFunctional%2FMail%2FMailTest.php;h=6f32539243f5042b57f66a9cdf1e6ecf77c3983a;hb=0bf8d09d2542548982e81a441b1f16e75873a04f;hp=74549a3211e36130d3c7d1edb3be4d5a4d49eb01;hpb=a2bd1bf0c2c1f1a17d188f4dc0726a45494cefae;p=yaffs-website diff --git a/web/core/modules/system/tests/src/Functional/Mail/MailTest.php b/web/core/modules/system/tests/src/Functional/Mail/MailTest.php index 74549a321..6f3253924 100644 --- a/web/core/modules/system/tests/src/Functional/Mail/MailTest.php +++ b/web/core/modules/system/tests/src/Functional/Mail/MailTest.php @@ -2,7 +2,13 @@ namespace Drupal\Tests\system\Functional\Mail; +use Drupal\Component\Utility\Random; +use Drupal\Component\Utility\Unicode; +use Drupal\Core\Mail\MailFormatHelper; use Drupal\Core\Mail\Plugin\Mail\TestMailCollector; +use Drupal\Core\Render\Markup; +use Drupal\Core\Url; +use Drupal\file\Entity\File; use Drupal\Tests\BrowserTestBase; use Drupal\system_mail_failure_test\Plugin\Mail\TestPhpMailFailure; @@ -18,7 +24,7 @@ class MailTest extends BrowserTestBase { * * @var array */ - public static $modules = ['simpletest', 'system_mail_failure_test']; + public static $modules = ['simpletest', 'system_mail_failure_test', 'mail_html_test', 'file', 'image']; /** * Assert that the pluggable mail system is functional. @@ -90,13 +96,191 @@ class MailTest extends BrowserTestBase { $this->assertEqual($reply_email, $sent_message['headers']['Reply-to'], 'Message reply-to headers are set.'); $this->assertFalse(isset($sent_message['headers']['Errors-To']), 'Errors-to header must not be set, it is deprecated.'); + // Test that long site names containing characters that need MIME encoding + // works as expected. + $this->config('system.site')->set('name', 'Drépal this is a very long test sentence to test what happens with very long site names')->save(); // Send an email and check that the From-header contains the site name. \Drupal::service('plugin.manager.mail')->mail('simpletest', 'from_test', 'from_test@example.com', $language); $captured_emails = \Drupal::state()->get('system.test_mail_collector'); $sent_message = end($captured_emails); - $this->assertEqual($from_email, $sent_message['headers']['From'], 'Message is sent from the site email account.'); + $this->assertEquals('=?UTF-8?B?RHLDqXBhbCB0aGlzIGlzIGEgdmVyeSBsb25nIHRlc3Qgc2VudGVuY2UgdG8gdGU=?= ', $sent_message['headers']['From'], 'From header is correctly encoded.'); + $this->assertEquals('Drépal this is a very long test sentence to te ', Unicode::mimeHeaderDecode($sent_message['headers']['From']), 'From header is correctly encoded.'); $this->assertFalse(isset($sent_message['headers']['Reply-to']), 'Message reply-to is not set if not specified.'); $this->assertFalse(isset($sent_message['headers']['Errors-To']), 'Errors-to header must not be set, it is deprecated.'); } + /** + * Checks that relative paths in mails are converted into absolute URLs. + */ + public function testConvertRelativeUrlsIntoAbsolute() { + $language_interface = \Drupal::languageManager()->getCurrentLanguage(); + + // Use the HTML compatible state system collector mail backend. + $this->config('system.mail')->set('interface.default', 'test_html_mail_collector')->save(); + + // Fetch the hostname and port for matching against. + $http_host = \Drupal::request()->getSchemeAndHttpHost(); + + // Random generator. + $random = new Random(); + + // One random tag name. + $tag_name = strtolower($random->name(8, TRUE)); + + // Test root relative urls. + foreach (['href', 'src'] as $attribute) { + // Reset the state variable that holds sent messages. + \Drupal::state()->set('system.test_mail_collector', []); + + $html = "<$tag_name $attribute=\"/root-relative\">root relative url in mail test"; + $expected_html = "<$tag_name $attribute=\"{$http_host}/root-relative\">root relative url in mail test"; + + // Prepare render array. + $render = ['#markup' => Markup::create($html)]; + + // Send a test message that simpletest_mail_alter should cancel. + \Drupal::service('plugin.manager.mail')->mail('mail_html_test', 'render_from_message_param', 'relative_url@example.com', $language_interface->getId(), ['message' => $render]); + // Retrieve sent message. + $captured_emails = \Drupal::state()->get('system.test_mail_collector'); + $sent_message = end($captured_emails); + + // Wrap the expected HTML and assert. + $expected_html = MailFormatHelper::wrapMail($expected_html); + $this->assertSame($expected_html, $sent_message['body'], "Asserting that {$attribute} is properly converted for mails."); + } + + // Test protocol relative urls. + foreach (['href', 'src'] as $attribute) { + // Reset the state variable that holds sent messages. + \Drupal::state()->set('system.test_mail_collector', []); + + $html = "<$tag_name $attribute=\"//example.com/protocol-relative\">protocol relative url in mail test"; + $expected_html = "<$tag_name $attribute=\"//example.com/protocol-relative\">protocol relative url in mail test"; + + // Prepare render array. + $render = ['#markup' => Markup::create($html)]; + + // Send a test message that simpletest_mail_alter should cancel. + \Drupal::service('plugin.manager.mail')->mail('mail_html_test', 'render_from_message_param', 'relative_url@example.com', $language_interface->getId(), ['message' => $render]); + // Retrieve sent message. + $captured_emails = \Drupal::state()->get('system.test_mail_collector'); + $sent_message = end($captured_emails); + + // Wrap the expected HTML and assert. + $expected_html = MailFormatHelper::wrapMail($expected_html); + $this->assertSame($expected_html, $sent_message['body'], "Asserting that {$attribute} is properly converted for mails."); + } + + // Test absolute urls. + foreach (['href', 'src'] as $attribute) { + // Reset the state variable that holds sent messages. + \Drupal::state()->set('system.test_mail_collector', []); + + $html = "<$tag_name $attribute=\"http://example.com/absolute\">absolute url in mail test"; + $expected_html = "<$tag_name $attribute=\"http://example.com/absolute\">absolute url in mail test"; + + // Prepare render array. + $render = ['#markup' => Markup::create($html)]; + + // Send a test message that simpletest_mail_alter should cancel. + \Drupal::service('plugin.manager.mail')->mail('mail_html_test', 'render_from_message_param', 'relative_url@example.com', $language_interface->getId(), ['message' => $render]); + // Retrieve sent message. + $captured_emails = \Drupal::state()->get('system.test_mail_collector'); + $sent_message = end($captured_emails); + + // Wrap the expected HTML and assert. + $expected_html = MailFormatHelper::wrapMail($expected_html); + $this->assertSame($expected_html, $sent_message['body'], "Asserting that {$attribute} is properly converted for mails."); + } + } + + /** + * Checks that mails built from render arrays contain absolute paths. + * + * By default Drupal uses relative paths for images and links. When sending + * emails, absolute paths should be used instead. + */ + public function testRenderedElementsUseAbsolutePaths() { + $language_interface = \Drupal::languageManager()->getCurrentLanguage(); + + // Use the HTML compatible state system collector mail backend. + $this->config('system.mail')->set('interface.default', 'test_html_mail_collector')->save(); + + // Fetch the hostname and port for matching against. + $http_host = \Drupal::request()->getSchemeAndHttpHost(); + + // Random generator. + $random = new Random(); + $image_name = $random->name(); + + // Create an image file. + $file = File::create(['uri' => "public://{$image_name}.png", 'filename' => "{$image_name}.png"]); + $file->save(); + + $base_path = base_path(); + + $path_pairs = [ + 'root relative' => [$file->getFileUri(), "{$http_host}{$base_path}{$this->publicFilesDirectory}/{$image_name}.png"], + 'protocol relative' => ['//example.com/image.png', '//example.com/image.png'], + 'absolute' => ['http://example.com/image.png', 'http://example.com/image.png'], + ]; + + // Test images. + foreach ($path_pairs as $test_type => $paths) { + list($input_path, $expected_path) = $paths; + + // Reset the state variable that holds sent messages. + \Drupal::state()->set('system.test_mail_collector', []); + + // Build the render array. + $render = [ + '#theme' => 'image', + '#uri' => $input_path, + ]; + $expected_html = "\"\""; + + // Send a test message that simpletest_mail_alter should cancel. + \Drupal::service('plugin.manager.mail')->mail('mail_html_test', 'render_from_message_param', 'relative_url@example.com', $language_interface->getId(), ['message' => $render]); + // Retrieve sent message. + $captured_emails = \Drupal::state()->get('system.test_mail_collector'); + $sent_message = end($captured_emails); + + // Wrap the expected HTML and assert. + $expected_html = MailFormatHelper::wrapMail($expected_html); + $this->assertSame($expected_html, $sent_message['body'], "Asserting that {$test_type} paths are converted properly."); + } + + // Test links. + $path_pairs = [ + 'root relative' => [Url::fromUserInput('/path/to/something'), "{$http_host}{$base_path}path/to/something"], + 'protocol relative' => [Url::fromUri('//example.com/image.png'), '//example.com/image.png'], + 'absolute' => [Url::fromUri('http://example.com/image.png'), 'http://example.com/image.png'], + ]; + + foreach ($path_pairs as $paths) { + list($input_path, $expected_path) = $paths; + + // Reset the state variable that holds sent messages. + \Drupal::state()->set('system.test_mail_collector', []); + + // Build the render array. + $render = [ + '#title' => 'Link', + '#type' => 'link', + '#url' => $input_path, + ]; + $expected_html = "Link"; + + // Send a test message that simpletest_mail_alter should cancel. + \Drupal::service('plugin.manager.mail')->mail('mail_html_test', 'render_from_message_param', 'relative_url@example.com', $language_interface->getId(), ['message' => $render]); + // Retrieve sent message. + $captured_emails = \Drupal::state()->get('system.test_mail_collector'); + $sent_message = end($captured_emails); + + // Wrap the expected HTML and assert. + $expected_html = MailFormatHelper::wrapMail($expected_html); + $this->assertSame($expected_html, $sent_message['body']); + } + } + }