<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[40632] trunk: Mail: Ensure entities are decoded in email change notifications on Multisite.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/40632">40632</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/40632","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-05-11 19:14:55 +0000 (Thu, 11 May 2017)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Mail: Ensure entities are decoded in email change notifications on Multisite.
Adds new tests to ensure this bug does not pop up again.
Props stephenharris.
Fixes <a href="https://core.trac.wordpress.org/ticket/40015">#40015</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesmsphp">trunk/src/wp-admin/includes/ms.php</a></li>
<li><a href="#trunktestsphpunittestsusermultisitephp">trunk/tests/phpunit/tests/user/multisite.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesmsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/ms.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/ms.php 2017-05-11 18:54:24 UTC (rev 40631)
+++ trunk/src/wp-admin/includes/ms.php 2017-05-11 19:14:55 UTC (rev 40632)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -325,10 +325,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $content = str_replace( '###USERNAME###', $current_user->user_login, $content );
</span><span class="cx" style="display: block; padding: 0 10px"> $content = str_replace( '###ADMIN_URL###', esc_url( self_admin_url( 'options.php?adminhash='.$hash ) ), $content );
</span><span class="cx" style="display: block; padding: 0 10px"> $content = str_replace( '###EMAIL###', $value, $content );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $content = str_replace( '###SITENAME###', get_site_option( 'site_name' ), $content );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $content = str_replace( '###SITENAME###', wp_specialchars_decode( get_site_option( 'site_name' ), ENT_QUOTES ), $content );
</ins><span class="cx" style="display: block; padding: 0 10px"> $content = str_replace( '###SITEURL###', network_home_url(), $content );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_mail( $value, sprintf( __( '[%s] New Admin Email Address' ), wp_specialchars_decode( get_option( 'blogname' ) ) ), $content );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_mail( $value, sprintf( __( '[%s] New Admin Email Address' ), wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ) ), $content );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $switched_locale ) {
</span><span class="cx" style="display: block; padding: 0 10px"> restore_previous_locale();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -410,10 +410,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $content = str_replace( '###USERNAME###', $current_user->user_login, $content );
</span><span class="cx" style="display: block; padding: 0 10px"> $content = str_replace( '###ADMIN_URL###', esc_url( self_admin_url( 'profile.php?newuseremail=' . $hash ) ), $content );
</span><span class="cx" style="display: block; padding: 0 10px"> $content = str_replace( '###EMAIL###', $_POST['email'], $content);
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $content = str_replace( '###SITENAME###', get_site_option( 'site_name' ), $content );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $content = str_replace( '###SITENAME###', wp_specialchars_decode( get_site_option( 'site_name' ), ENT_QUOTES ), $content );
</ins><span class="cx" style="display: block; padding: 0 10px"> $content = str_replace( '###SITEURL###', network_home_url(), $content );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_mail( $_POST['email'], sprintf( __( '[%s] New Email Address' ), wp_specialchars_decode( get_option( 'blogname' ) ) ), $content );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_mail( $_POST['email'], sprintf( __( '[%s] New Email Address' ), wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ) ), $content );
</ins><span class="cx" style="display: block; padding: 0 10px"> $_POST['email'] = $current_user->user_email;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $switched_locale ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsusermultisitephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/user/multisite.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/user/multisite.php 2017-05-11 18:54:24 UTC (rev 40631)
+++ trunk/tests/phpunit/tests/user/multisite.php 2017-05-11 19:14:55 UTC (rev 40632)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -424,6 +424,185 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_roles->remove_role( $role );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+
+ /**
+ * Ensure blog's admin e-mail change notification emails do not contain encoded HTML entities
+ * @ticket 40015
+ */
+ function test_ms_new_admin_email_notification_html_entities_decoded() {
+ reset_phpmailer_instance();
+
+ $existing_email = get_option( 'admin_email' );
+ $new_email = 'new-admin-email@test.dev';
+
+ // Give the site and blog a name containing HTML entities
+ update_site_option( 'site_name', ''Test' site's "name" has <html entities> &' );
+ update_option( 'blogname', ''Test' blog's "name" has <html entities> &' );
+
+ update_option_new_admin_email( $existing_email, $new_email );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $recipient = $mailer->get_recipient( 'to' );
+ $email = $mailer->get_sent();
+
+ // Assert reciepient is correct
+ $this->assertSame( $new_email, $recipient->address, 'Admin email change notification recipient not as expected' );
+
+ // Assert that HTML entites have been decode in body and subject
+ $this->assertContains( '\'Test\' site\'s "name" has <html entities> &', $email->body, 'Email body does not contain the decoded HTML entities' );
+ $this->assertNotContains( ''Test' site's "name" has <html entities> &', 'Email body does contains HTML entities' );
+ $this->assertContains( '\'Test\' blog\'s "name" has <html entities> &', $email->subject, 'Email body does not contain the decoded HTML entities' );
+ $this->assertNotContains( ''Test' blog's "name" has <html entities> &', $email->subject, $email->subject, 'Email subject does contains HTML entities' );
+ }
+
+ /**
+ * A notification e-mail should not be sent if the new admin e-mail:
+ * - Matches thee existing admin email, or
+ * - is not a valid e-mail, or
+ *
+ * @dataProvider data_user_admin_email_notification_emails
+ */
+ function test_ms_new_admin_email_notification_not_sent_when_email_invalid( $email, $message ) {
+ reset_phpmailer_instance();
+
+ update_option( 'admin_email', 'existing-email@test.dev' );
+ update_option_new_admin_email( 'existing-email@test.dev', $email );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertFalse( $mailer->get_sent(), $message );
+ }
+
+ /**
+ * Data provider for test_ms_new_admin_email_notification_not_sent_when_email_invalid().
+ *
+ * @return array {
+ * @type array {
+ * @type string $email The new e-mail for admin_email
+ * @type string $message An error message to display if the test fails
+ * }
+ * }
+ */
+ function data_user_admin_email_notification_emails() {
+ return array(
+ array(
+ 'existing-email@test.dev',
+ 'A notification e-mail should not be sent if the current admin e-mail matches the new e-mail',
+ ),
+ array(
+ 'not an email',
+ 'A notification e-mail should not be sent if it is not a valid e-mail',
+ )
+ );
+ }
+
+ /**
+ * Ensure email change confirmation emails do not contain encoded HTML entities
+ * @ticket 40015
+ */
+ function test_ms_send_confirmation_on_profile_email_html_entities_decoded() {
+
+ $old_current = get_current_user_id();
+ $user_id = self::factory()->user->create( array(
+ 'role' => 'subscriber',
+ 'user_email' => 'old-email@test.dev',
+ ) );
+ wp_set_current_user( $user_id );
+
+ reset_phpmailer_instance();
+
+ // Give the site and blog a name containing HTML entities
+ update_site_option( 'site_name', ''Test' site's "name" has <html entities> &' );
+ update_option( 'blogname', ''Test' blog's "name" has <html entities> &' );
+
+ // Set $_POST['email'] with new e-mail and $_POST['id'] with user's ID.
+ $_POST['user_id'] = $user_id;
+ $_POST['email'] = 'new-email@test.dev';
+ send_confirmation_on_profile_email( );
+
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $recipient = $mailer->get_recipient( 'to' );
+ $email = $mailer->get_sent();
+
+ // Assert reciepient is correct
+ $this->assertSame( 'new-email@test.dev', $recipient->address, 'Admin email change notification recipient not as expected' );
+
+ // Assert that HTML entites have been decode in body and subject
+ $this->assertContains( '\'Test\' site\'s "name" has <html entities> &', $email->body, 'Email body does not contain the decoded HTML entities' );
+ $this->assertNotContains( ''Test' site's "name" has <html entities> &', $email->body, 'Email body does contains HTML entities' );
+ $this->assertContains( '\'Test\' blog\'s "name" has <html entities> &', $email->subject, 'Email body does not contain the decoded HTML entities' );
+ $this->assertNotContains( ''Test' blog's "name" has <html entities> &', $email->subject, 'Email subject does contains HTML entities' );
+
+ wp_set_current_user( $old_current );
+ }
+
+ /**
+ * A confirmation e-mail should not be sent if user's new e-mail:
+ * - Matches their existing email, or
+ * - is not a valid e-mail, or
+ * - Matches another user's email
+ *
+ * @dataProvider data_user_change_email_confirmation_emails
+ */
+ function test_ms_profile_email_confirmation_not_sent_invalid_email( $email, $message ) {
+
+ $old_current = get_current_user_id();
+
+ $user_id = self::factory()->user->create( array(
+ 'role' => 'subscriber',
+ 'user_email' => 'email@test.dev',
+ ) );
+ wp_set_current_user( $user_id );
+
+ self::factory()->user->create( array(
+ 'role' => 'subscriber',
+ 'user_email' => 'another-user@test.dev',
+ ) );
+
+ reset_phpmailer_instance();
+
+ // Set $_POST['email'] with new e-mail and $_POST['id'] with user's ID.
+ $_POST['user_id'] = $user_id;
+ $_POST['email'] = $email;
+ send_confirmation_on_profile_email();
+
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertFalse( $mailer->get_sent(), $message );
+
+ wp_set_current_user( $old_current );
+ }
+
+ /**
+ * Data provider for test_ms_profile_email_confirmation_not_sent_invalid_email().
+ *
+ * @return array {
+ * @type array {
+ * @type string $email The user's new e-amil.
+ * @type string $message An error message to display if the test fails
+ * }
+ * }
+ */
+ function data_user_change_email_confirmation_emails() {
+ return array(
+ array(
+ 'email@test.dev',
+ 'Confirmation e-mail should not be sent if it matches the user\'s existing e-mail',
+ ),
+ array(
+ 'not an email',
+ 'Confirmation e-mail should not be sent if it is not a valid e-mail',
+ ),
+ array(
+ 'another-user@test.dev',
+ 'Confirmation e-mail should not be sent if it matches another user\'s e-mail',
+ ),
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> endif ;
</span></span></pre>
</div>
</div>
</body>
</html>