<!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>[43568] trunk: Privacy: Ensure the user request email is sent in the requested user's locale (or the site's default locale if they are not a registered user) when the administrator creating the request uses a different locale.</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 { white-space: pre-line; 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/43568">43568</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/43568","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-08-13 16:31:31 +0000 (Mon, 13 Aug 2018)</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'>Privacy: Ensure the user request email is sent in the requested user's locale (or the site's default locale if they are not a registered user) when the administrator creating the request uses a different locale.
Props desrosj, Chouby, iandunn, lbenicio, birgire, earnjam, swissspidy, garrett-eclipse.
Fixes <a href="https://core.trac.wordpress.org/ticket/43985">#43985</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesfilephp">trunk/src/wp-admin/includes/file.php</a></li>
<li><a href="#trunksrcwpincludesuserphp">trunk/src/wp-includes/user.php</a></li>
<li><a href="#trunktestsphpunitdatalanguagesde_DEmo">trunk/tests/phpunit/data/languages/de_DE.mo</a></li>
<li><a href="#trunktestsphpunitdatalanguagesde_DEpo">trunk/tests/phpunit/data/languages/de_DE.po</a></li>
<li><a href="#trunktestsphpunitdatalanguageses_ESmo">trunk/tests/phpunit/data/languages/es_ES.mo</a></li>
<li><a href="#trunktestsphpunitdatalanguageses_ESpo">trunk/tests/phpunit/data/languages/es_ES.po</a></li>
<li><a href="#trunktestsphpunittestsprivacywpPrivacySendPersonalDataExportEmailphp">trunk/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsuserwpSendUserRequestphp">trunk/tests/phpunit/tests/user/wpSendUserRequest.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesfilephp"></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/file.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/file.php 2018-08-12 00:05:39 UTC (rev 43567)
+++ trunk/src/wp-admin/includes/file.php 2018-08-13 16:31:31 UTC (rev 43568)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2196,7 +2196,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request = wp_get_user_request_data( $request_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $request || 'export_personal_data' !== $request->action_name ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return new WP_Error( 'invalid', __( 'Invalid request ID when sending personal data export email.' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return new WP_Error( 'invalid_request', __( 'Invalid request ID when sending personal data export email.' ) );
</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"> /** This filter is documented in wp-includes/functions.php */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2256,7 +2256,7 @@
</span><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"> if ( ! $mail_success ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return new WP_Error( 'error', __( 'Unable to send personal data export email.' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return new WP_Error( 'privacy_email_error', __( 'Unable to send personal data export email.' ) );
</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"> return true;
</span></span></pre></div>
<a id="trunksrcwpincludesuserphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/user.php 2018-08-12 00:05:39 UTC (rev 43567)
+++ trunk/src/wp-includes/user.php 2018-08-13 16:31:31 UTC (rev 43568)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3357,7 +3357,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.6
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $request_id ID of the request created via wp_create_user_request().
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return WP_Error|bool Will return true/false based on the success of sending the email, or a WP_Error object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool|WP_Error True on success, `WP_Error` on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_send_user_request( $request_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $request_id = absint( $request_id );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3364,9 +3364,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request = wp_get_user_request_data( $request_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return new WP_Error( 'user_request_error', __( 'Invalid request.' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return new WP_Error( 'invalid_request', __( 'Invalid user request.' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Localize message content for user; fallback to site default for visitors.
+ if ( ! empty( $request->user_id ) ) {
+ $locale = get_user_locale( $request->user_id );
+ } else {
+ $locale = get_locale();
+ }
+
+ $switched_locale = switch_to_locale( $locale );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $email_data = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'request' => $request,
</span><span class="cx" style="display: block; padding: 0 10px"> 'email' => $request->email,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3454,7 +3463,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $subject = apply_filters( 'user_request_action_email_subject', $subject, $email_data['sitename'], $email_data );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return wp_mail( $email_data['email'], $subject, $content );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $email_sent = wp_mail( $email_data['email'], $subject, $content );
+
+ if ( $switched_locale ) {
+ restore_previous_locale();
+ }
+
+ if ( ! $email_sent ) {
+ return new WP_Error( 'privacy_email_error', __( 'Unable to send personal data export confirmation email.' ) );
+ }
+
+ return true;
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3504,7 +3523,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request = wp_get_user_request_data( $request_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return new WP_Error( 'user_request_error', __( 'Invalid request.' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return new WP_Error( 'invalid_request', __( 'Invalid request.' ) );
</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"> if ( ! in_array( $request->status, array( 'request-pending', 'request-failed' ), true ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3591,7 +3610,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @var int
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> public $user_id = 0;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunitdatalanguagesde_DEmo"></a>
<div class="binary"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/data/languages/de_DE.mo</h4>
<pre class="diff"><span>
<span class="cx">(Binary files differ)
</span></span></pre></div>
<a id="trunktestsphpunitdatalanguagesde_DEpo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/data/languages/de_DE.po</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/data/languages/de_DE.po 2018-08-12 00:05:39 UTC (rev 43567)
+++ trunk/tests/phpunit/data/languages/de_DE.po 2018-08-13 16:31:31 UTC (rev 43568)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,15 +1,18 @@
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-# Translation of 4.6.x in German
-# This file is distributed under the same license as the 4.6.x package.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+# Translation of 4.9.x in German
+# This file is distributed under the same license as the 4.9.x package.
</ins><span class="cx" style="display: block; padding: 0 10px"> msgid ""
</span><span class="cx" style="display: block; padding: 0 10px"> msgstr ""
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-"PO-Revision-Date: 2016-10-25 18:27+0200\n"
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+"PO-Revision-Date: 2018-08-13 19:19+0300\n"
</ins><span class="cx" style="display: block; padding: 0 10px"> "MIME-Version: 1.0\n"
</span><span class="cx" style="display: block; padding: 0 10px"> "Content-Type: text/plain; charset=UTF-8\n"
</span><span class="cx" style="display: block; padding: 0 10px"> "Content-Transfer-Encoding: 8bit\n"
</span><span class="cx" style="display: block; padding: 0 10px"> "Plural-Forms: nplurals=2; plural=n != 1;\n"
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-"X-Generator: Poedit 1.8.10\n"
-"Project-Id-Version: 4.6.x\n"
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+"X-Generator: Poedit 2.1.1\n"
+"Project-Id-Version: Development (4.9.x)\n"
</ins><span class="cx" style="display: block; padding: 0 10px"> "Language: de_DE\n"
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+"POT-Creation-Date: \n"
+"Last-Translator: \n"
+"Language-Team: \n"
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> #. translators: Translate this to the correct language tag for your locale, see
</span><span class="cx" style="display: block; padding: 0 10px"> #. https://www.w3.org/International/articles/language-tags/ for reference. Do
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -40,3 +43,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> #: wp-includes/script-loader.php:620
</span><span class="cx" style="display: block; padding: 0 10px"> msgid "Update %s now"
</span><span class="cx" style="display: block; padding: 0 10px"> msgstr "Jetzt %s aktualisieren"
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+#. translators: Privacy data request subject. 1: Site name, 2: Name of the action
+#: wp-includes/user.php:3445
+msgid "[%1$s] Confirm Action: %2$s"
+msgstr "[%1$s] Aktion bestätigen: %2$s"
</ins></span></pre></div>
<a id="trunktestsphpunitdatalanguageses_ESmo"></a>
<div class="binary"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/data/languages/es_ES.mo</h4>
<pre class="diff"><span>
<span class="cx">(Binary files differ)
</span></span></pre></div>
<a id="trunktestsphpunitdatalanguageses_ESpo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/data/languages/es_ES.po</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/data/languages/es_ES.po 2018-08-12 00:05:39 UTC (rev 43567)
+++ trunk/tests/phpunit/data/languages/es_ES.po 2018-08-13 16:31:31 UTC (rev 43568)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,15 +1,18 @@
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-# Translation of Development (4.4.x) in Spanish (Spain)
-# This file is distributed under the same license as the Development (4.4.x) package.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+# Translation of Development (4.9.x) in Spanish (Spain)
+# This file is distributed under the same license as the Development (4.9.x) package.
</ins><span class="cx" style="display: block; padding: 0 10px"> msgid ""
</span><span class="cx" style="display: block; padding: 0 10px"> msgstr ""
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-"PO-Revision-Date: 2016-10-25 18:28+0200\n"
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+"PO-Revision-Date: 2018-08-13 19:19+0300\n"
</ins><span class="cx" style="display: block; padding: 0 10px"> "MIME-Version: 1.0\n"
</span><span class="cx" style="display: block; padding: 0 10px"> "Content-Type: text/plain; charset=UTF-8\n"
</span><span class="cx" style="display: block; padding: 0 10px"> "Content-Transfer-Encoding: 8bit\n"
</span><span class="cx" style="display: block; padding: 0 10px"> "Plural-Forms: nplurals=2; plural=n != 1;\n"
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-"X-Generator: Poedit 1.8.10\n"
-"Project-Id-Version: Development (4.4.x)\n"
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+"X-Generator: Poedit 2.1.1\n"
+"Project-Id-Version: Development (4.9.x)\n"
</ins><span class="cx" style="display: block; padding: 0 10px"> "Language: es_ES\n"
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+"POT-Creation-Date: \n"
+"Last-Translator: \n"
+"Language-Team: \n"
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> #. translators: 'rtl' or 'ltr'. This sets the text direction for WordPress.
</span><span class="cx" style="display: block; padding: 0 10px"> #: wp-includes/locale.php:201
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -36,3 +39,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> msgctxt "menu"
</span><span class="cx" style="display: block; padding: 0 10px"> msgid "(Currently set to: %s)"
</span><span class="cx" style="display: block; padding: 0 10px"> msgstr "(Actualmente fijado en: %s)"
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+#. translators: Privacy data request subject. 1: Site name, 2: Name of the action
+#: wp-includes/user.php:3445
+msgid "[%1$s] Confirm Action: %2$s"
+msgstr "[%1$s] Confirma la acción: %2$s"
</ins></span></pre></div>
<a id="trunktestsphpunittestsprivacywpPrivacySendPersonalDataExportEmailphp"></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/privacy/wpPrivacySendPersonalDataExportEmail.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php 2018-08-12 00:05:39 UTC (rev 43567)
+++ trunk/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php 2018-08-13 16:31:31 UTC (rev 43568)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,7 +39,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.6
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function setUp() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function setUp() {
</ins><span class="cx" style="display: block; padding: 0 10px"> parent::setUp();
</span><span class="cx" style="display: block; padding: 0 10px"> reset_phpmailer_instance();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -49,7 +49,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.9.6
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- function tearDown() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function tearDown() {
</ins><span class="cx" style="display: block; padding: 0 10px"> reset_phpmailer_instance();
</span><span class="cx" style="display: block; padding: 0 10px"> parent::tearDown();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -95,12 +95,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request_id = 0;
</span><span class="cx" style="display: block; padding: 0 10px"> $email_sent = wp_privacy_send_personal_data_export_email( $request_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertWPError( $email_sent );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( 'invalid', $email_sent->get_error_code() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 'invalid_request', $email_sent->get_error_code() );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request_id = PHP_INT_MAX;
</span><span class="cx" style="display: block; padding: 0 10px"> $email_sent = wp_privacy_send_personal_data_export_email( $request_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertWPError( $email_sent );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( 'invalid', $email_sent->get_error_code() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 'invalid_request', $email_sent->get_error_code() );
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -111,10 +111,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_return_wp_error_when_send_fails() {
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'wp_mail_from', '__return_empty_string' ); // Cause `wp_mail()` to return false.
</span><span class="cx" style="display: block; padding: 0 10px"> $email_sent = wp_privacy_send_personal_data_export_email( self::$request_id );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- remove_filter( 'wp_mail_from', '__return_empty_string' );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertWPError( $email_sent );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( 'error', $email_sent->get_error_code() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 'privacy_email_error', $email_sent->get_error_code() );
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -125,7 +124,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_export_expiration_should_be_filterable() {
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'wp_privacy_export_expiration', array( $this, 'modify_export_expiration' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_privacy_send_personal_data_export_email( self::$request_id );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- remove_filter( 'wp_privacy_export_expiration', array( $this, 'modify_export_expiration' ) );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $mailer = tests_retrieve_phpmailer_instance();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( 'we will automatically delete the file on December 18, 2017,', $mailer->get_sent()->body );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -152,7 +150,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_email_content_should_be_filterable() {
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'wp_privacy_personal_data_email_content', array( $this, 'modify_email_content' ), 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_privacy_send_personal_data_export_email( self::$request_id );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- remove_filter( 'wp_privacy_personal_data_email_content', array( $this, 'modify_email_content' ) );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $mailer = tests_retrieve_phpmailer_instance();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( 'Custom content for request ID: ' . self::$request_id, $mailer->get_sent()->body );
</span></span></pre></div>
<a id="trunktestsphpunittestsuserwpSendUserRequestphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/user/wpSendUserRequest.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/user/wpSendUserRequest.php (rev 0)
+++ trunk/tests/phpunit/tests/user/wpSendUserRequest.php 2018-08-13 16:31:31 UTC (rev 43568)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,372 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Test cases for the `wp_send_user_request()` function.
+ *
+ * @package WordPress
+ * @since 4.9.9
+ */
+
+/**
+ * Tests_User_WpSendUserRequest class.
+ *
+ * @since 4.9.9
+ *
+ * @group privacy
+ * @group user
+ * @covers wp_send_user_request
+ */
+class Tests_User_WpSendUserRequest extends WP_UnitTestCase {
+
+ /**
+ * Test administrator user.
+ *
+ * @since 4.9.9
+ *
+ * @var WP_User $admin_user
+ */
+ protected static $admin_user;
+
+ /**
+ * Test subscriber user.
+ *
+ * @since 4.9.9
+ *
+ * @var WP_User $test_user
+ */
+ protected static $test_user;
+
+ /**
+ * Create users for tests.
+ *
+ * @since 4.9.9
+ *
+ * @param WP_UnitTest_Factory $factory Test fixture factory.
+ */
+ public static function wpSetUpBeforeClass( $factory ) {
+ self::$admin_user = $factory->user->create_and_get(
+ array(
+ 'user_email' => 'admin@local.dev',
+ 'role' => 'administrator',
+ )
+ );
+
+ self::$test_user = $factory->user->create_and_get(
+ array(
+ 'user_email' => 'export-user@local.dev',
+ 'role' => 'subscriber',
+ )
+ );
+ }
+
+ /**
+ * Reset the mocked phpmailer instance before each test method.
+ *
+ * @since 4.9.9
+ */
+ public function setUp() {
+ parent::setUp();
+
+ set_current_screen( 'dashboard' );
+ reset_phpmailer_instance();
+ }
+
+ /**
+ * Reset the mocked phpmailer instance after each test method.
+ *
+ * @since 4.9.9
+ */
+ public function tearDown() {
+ delete_option( 'WPLANG' );
+ reset_phpmailer_instance();
+
+ unset( $GLOBALS['locale'] );
+ unset( $GLOBALS['current_screen'] );
+ unset( $GLOBALS['taxnow'] );
+ unset( $GLOBALS['typenow'] );
+
+ restore_previous_locale();
+ parent::tearDown();
+ }
+
+ /**
+ * The function should error when the request ID is invalid.
+ *
+ * @ticket 43985
+ */
+ public function test_should_error_when_invalid_request_id() {
+ $result = wp_send_user_request( null );
+
+ $this->assertWPError( $result );
+ $this->assertSame( 'invalid_request', $result->get_error_code() );
+ }
+
+ /**
+ * The function should send a user request export email when the requester is a registered user.
+ *
+ * @ticket 43985
+ */
+ public function test_should_send_user_request_export_email_when_requester_registered_user() {
+ $request_id = wp_create_user_request( self::$test_user->user_email, 'export_personal_data' );
+
+ $result = wp_send_user_request( $request_id );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertTrue( $result );
+ $this->assertSame( self::$test_user->user_email, $mailer->get_recipient( 'to' )->address );
+ $this->assertContains( 'Confirm Action: Export Personal Data', $mailer->get_sent()->subject );
+ $this->assertContains( 'action=confirmaction&request_id=', $mailer->get_sent()->body );
+ $this->assertContains( 'Export Personal Data', $mailer->get_sent()->body );
+ }
+
+ /**
+ * The function should send a user request erase email when the requester is a registered user.
+ *
+ * @ticket 43985
+ */
+ public function test_should_send_user_request_erase_email_when_requester_registered_user() {
+ $request_id = wp_create_user_request( self::$test_user->user_email, 'remove_personal_data' );
+
+ $result = wp_send_user_request( $request_id );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertTrue( $result );
+ $this->assertSame( self::$test_user->user_email, $mailer->get_recipient( 'to' )->address );
+ $this->assertContains( 'Confirm Action: Erase Personal Data', $mailer->get_sent()->subject );
+ $this->assertContains( 'action=confirmaction&request_id=', $mailer->get_sent()->body );
+ $this->assertContains( 'Erase Personal Data', $mailer->get_sent()->body );
+ }
+
+ /**
+ * The function should send a user request export email when the requester is an un-registered user.
+ *
+ * @ticket 43985
+ */
+ public function test_should_send_user_request_export_email_when_user_not_registered() {
+ $request_id = wp_create_user_request( self::$test_user->user_email, 'export_personal_data' );
+
+ $result = wp_send_user_request( $request_id );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertTrue( $result );
+ $this->assertSame( self::$test_user->user_email, $mailer->get_recipient( 'to' )->address );
+ $this->assertContains( 'Confirm Action: Export Personal Data', $mailer->get_sent()->subject );
+ $this->assertContains( 'action=confirmaction&request_id=', $mailer->get_sent()->body );
+ $this->assertContains( 'Export Personal Data', $mailer->get_sent()->body );
+ }
+
+ /**
+ * The function should send a user request erase email when the requester is an un-registered user.
+ *
+ * @ticket 43985
+ */
+ public function test_should_send_user_request_erase_email_when_user_not_registered() {
+ $request_id = wp_create_user_request( self::$test_user->user_email, 'remove_personal_data' );
+
+ $result = wp_send_user_request( $request_id );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertTrue( $result );
+ $this->assertSame( self::$test_user->user_email, $mailer->get_recipient( 'to' )->address );
+ $this->assertContains( 'Confirm Action: Erase Personal Data', $mailer->get_sent()->subject );
+ $this->assertContains( 'action=confirmaction&request_id=', $mailer->get_sent()->body );
+ $this->assertContains( 'Erase Personal Data', $mailer->get_sent()->body );
+ }
+
+ /**
+ * The email subject should be filterable.
+ *
+ * @ticket 43985
+ */
+ public function test_email_subject_should_be_filterable() {
+ $request_id = wp_create_user_request( self::$test_user->user_email, 'remove_personal_data' );
+
+ add_filter( 'user_request_action_email_subject', array( $this, 'modify_email_subject' ) );
+ $result = wp_send_user_request( $request_id );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertTrue( $result );
+ $this->assertSame( 'Custom Email Subject', $mailer->get_sent()->subject );
+ }
+
+ /**
+ * Filter callback to modify the subject of the email sent when an account action is attempted.
+ *
+ * @since 4.9.9
+ *
+ * @param string $subject The email subject.
+ * @return string Filtered email subject.
+ */
+ public function modify_email_subject( $subject ) {
+ return 'Custom Email Subject';
+ }
+
+ /**
+ * The email content should be filterable.
+ *
+ * @ticket 43985
+ */
+ public function test_email_content_should_be_filterable() {
+ $request_id = wp_create_user_request( self::$test_user->user_email, 'remove_personal_data' );
+
+ add_filter( 'user_request_action_email_content', array( $this, 'modify_email_content' ), 10, 2 );
+ $result = wp_send_user_request( $request_id );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertTrue( $result );
+ $this->assertContains( 'Custom Email Content.', $mailer->get_sent()->body );
+ }
+
+ /**
+ * Filter callback to modify the content of the email sent when an account action is attempted.
+ *
+ * @since 4.9.9
+ *
+ * @param string $email_text Confirmation email text.
+ * @return string $email_text Filtered email text.
+ */
+ public function modify_email_content( $email_text ) {
+ return 'Custom Email Content.';
+ }
+
+ /**
+ * The function should error when the email was not sent.
+ *
+ * @ticket 43985
+ */
+ public function test_return_wp_error_when_sending_fails() {
+ $request_id = wp_create_user_request( 'erase.request.from.unregistered.user@example.com', 'remove_personal_data' );
+
+ add_filter( 'wp_mail_from', '__return_empty_string' ); // Cause `wp_mail()` to return false.
+ $result = wp_send_user_request( $request_id );
+
+ $this->assertWPError( $result );
+ $this->assertSame( 'privacy_email_error', $result->get_error_code() );
+ }
+
+ /**
+ * The function should respect the user locale settings when the site uses the default locale.
+ *
+ * @ticket 43985
+ * @group l10n
+ */
+ public function test_should_send_user_request_email_in_user_locale() {
+ update_user_meta( self::$test_user->ID, 'locale', 'es_ES' );
+
+ wp_set_current_user( self::$admin_user->ID );
+ $request_id = wp_create_user_request( self::$test_user->user_email, 'export_personal_data' );
+
+ wp_send_user_request( $request_id );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertContains( 'Confirma la', $mailer->get_sent()->subject );
+ }
+
+ /**
+ * The function should respect the user locale settings when the site does not use en_US, the administrator
+ * uses the site's default locale, and the user has a different locale.
+ *
+ * @ticket 43985
+ * @group l10n
+ */
+ public function test_should_send_user_request_email_in_user_locale_when_site_is_not_en_us() {
+ update_option( 'WPLANG', 'es_ES' );
+ switch_to_locale( 'es_ES' );
+
+ update_user_meta( self::$test_user->ID, 'locale', 'de_DE' );
+
+ wp_set_current_user( self::$admin_user->ID );
+ $request_id = wp_create_user_request( self::$test_user->user_email, 'remove_personal_data' );
+
+ wp_send_user_request( $request_id );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertContains( 'Aktion bestätigen', $mailer->get_sent()->subject );
+ }
+
+ /**
+ * The function should respect the user locale settings when the site is not en_US, the administrator
+ * has a different selected locale, and the user uses the site's default locale.
+ *
+ * @ticket 43985
+ * @group l10n
+ */
+ public function test_should_send_user_request_email_in_user_locale_when_admin_and_site_have_different_locales() {
+ update_option( 'WPLANG', 'es_ES' );
+ switch_to_locale( 'es_ES' );
+
+ update_user_meta( self::$admin_user->ID, 'locale', 'de_DE' );
+ wp_set_current_user( self::$admin_user->ID );
+
+ $request_id = wp_create_user_request( self::$test_user->user_email, 'export_personal_data' );
+
+ wp_send_user_request( $request_id );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertContains( 'Confirma la', $mailer->get_sent()->subject );
+ }
+
+ /**
+ * The function should respect the user locale settings when the site is not en_US and both the
+ * administrator and the user use different locales.
+ *
+ * @ticket 43985
+ * @group l10n
+ */
+ public function test_should_send_user_request_email_in_user_locale_when_both_have_different_locales_than_site() {
+ update_option( 'WPLANG', 'es_ES' );
+ switch_to_locale( 'es_ES' );
+
+ update_user_meta( self::$admin_user->ID, 'locale', 'de_DE' );
+ update_user_meta( self::$test_user->ID, 'locale', 'en_US' );
+
+ wp_set_current_user( self::$admin_user->ID );
+
+ $request_id = wp_create_user_request( self::$test_user->user_email, 'export_personal_data' );
+
+ wp_send_user_request( $request_id );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertContains( 'Confirm Action', $mailer->get_sent()->subject );
+ }
+
+ /**
+ * The function should respect the site's locale when the request is for an unregistered user and the
+ * administrator does not use the site's locale.
+ *
+ * @ticket 43985
+ * @group l10n
+ */
+ public function test_should_send_user_request_email_in_site_locale() {
+ update_user_meta( self::$admin_user->ID, 'locale', 'es_ES' );
+ wp_set_current_user( self::$admin_user->ID );
+
+ $request_id = wp_create_user_request( 'erase-user-not-registered@example.com', 'erase_personal_data' );
+
+ wp_send_user_request( $request_id );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertContains( 'Confirm Action', $mailer->get_sent()->subject );
+ }
+
+ /**
+ * The function should respect the site's locale when it is not en_US, the request is for an
+ * unregistered user, and the administrator does not use the site's default locale.
+ *
+ * @ticket 43985
+ * @group l10n
+ */
+ public function test_should_send_user_request_email_in_site_locale_when_not_en_us_and_admin_has_different_locale() {
+ update_option( 'WPLANG', 'es_ES' );
+ switch_to_locale( 'es_ES' );
+
+ update_user_meta( self::$admin_user->ID, 'locale', 'de_DE' );
+ wp_set_current_user( self::$admin_user->ID );
+
+ $request_id = wp_create_user_request( 'export-user-not-registered@example.com', 'erase_personal_data' );
+
+ wp_send_user_request( $request_id );
+ $mailer = tests_retrieve_phpmailer_instance();
+
+ $this->assertContains( 'Confirma la', $mailer->get_sent()->subject );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>