Changeset 43614

Timestamp:

09/03/2018 09:00:16 PM (6 years ago)

Author:

SergeyBiryukov

Message:

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.
Merges [43568] to the 4.9 branch.
Fixes #43985.

Location:

branches/4.9

Files:

• . (modified) (1 prop)
• src/wp-admin/includes/file.php (modified) (2 diffs)
• src/wp-includes/user.php (modified) (5 diffs)
• tests/phpunit/data/languages/de_DE.mo (modified) (previous)
• tests/phpunit/data/languages/de_DE.po (modified) (2 diffs)
• tests/phpunit/data/languages/es_ES.mo (modified) (previous)
• tests/phpunit/data/languages/es_ES.po (modified) (2 diffs)
• tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php (modified) (6 diffs)
• tests/phpunit/tests/user/wpSendUserRequest.php (copied) (copied from trunk/tests/phpunit/tests/user/wpSendUserRequest.php)

branches/4.9/src/wp-admin/includes/file.php

@@ -2060 +2060 @@
 
     if ( ! $request || 'export_personal_data' !== $request->action_name ) {
-        return new WP_Error( 'invalid', __( 'Invalid request ID when sending personal data export email.' ) );
+        return new WP_Error( 'invalid_request', __( 'Invalid request ID when sending personal data export email.' ) );
     }
 
@@ -2120 +2120 @@
 
     if ( ! $mail_success ) {
-        return new WP_Error( 'error', __( 'Unable to send personal data export email.' ) );
+        return new WP_Error( 'privacy_email_error', __( 'Unable to send personal data export email.' ) );
     }
 

branches/4.9/src/wp-includes/user.php

@@ -3280 +3280 @@
  *
  * @param string $request_id ID of the request created via wp_create_user_request().
- * @return WP_Error|bool Will return true/false based on the success of sending the email, or a WP_Error object.
+ * @return bool|WP_Error True on success, `WP_Error` on failure.
  */
 function wp_send_user_request( $request_id ) {
@@ -3287 +3287 @@
 
     if ( ! $request ) {
-        return new WP_Error( 'user_request_error', __( 'Invalid request.' ) );
-    }
+        return new WP_Error( 'invalid_request', __( 'Invalid user request.' ) );
+    }
+
+    // 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 );
 
     $email_data = array(
@@ -3377 +3386 @@
     $subject = apply_filters( 'user_request_action_email_subject', $subject, $email_data['sitename'], $email_data );
 
-    return wp_mail( $email_data['email'], $subject, $content );
+    $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;
 }
 
@@ -3427 +3446 @@
 
     if ( ! $request ) {
-        return new WP_Error( 'user_request_error', __( 'Invalid request.' ) );
+        return new WP_Error( 'invalid_request', __( 'Invalid request.' ) );
     }
 
@@ -3514 +3533 @@
      * @var int
      */
-
     public $user_id = 0;
 

branches/4.9/tests/phpunit/data/languages/de_DE.po

@@ -1 @@
-# Translation of 4.6.x in German
-# This file is distributed under the same license as the 4.6.x package.
+# Translation of 4.9.x in German
+# This file is distributed under the same license as the 4.9.x package.
 msgid ""
 msgstr ""
-"PO-Revision-Date: 2016-10-25 18:27+0200\n"
+"PO-Revision-Date: 2018-08-13 19:19+0300\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=n != 1;\n"
-"X-Generator: Poedit 1.8.10\n"
-"Project-Id-Version: 4.6.x\n"
+"X-Generator: Poedit 2.1.1\n"
+"Project-Id-Version: Development (4.9.x)\n"
 "Language: de_DE\n"
+"POT-Creation-Date: \n"
+"Last-Translator: \n"
+"Language-Team: \n"
 
 #. translators: Translate this to the correct language tag for your locale, see
@@ -41 +44 @@
 msgid "Update %s now"
 msgstr "Jetzt %s aktualisieren"
+
+#. 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"

branches/4.9/tests/phpunit/data/languages/es_ES.po

@@ -1 @@
-# Translation of Development (4.4.x) in Spanish (Spain)
-# This file is distributed under the same license as the Development (4.4.x) package.
+# Translation of Development (4.9.x) in Spanish (Spain)
+# This file is distributed under the same license as the Development (4.9.x) package.
 msgid ""
 msgstr ""
-"PO-Revision-Date: 2016-10-25 18:28+0200\n"
+"PO-Revision-Date: 2018-08-13 19:19+0300\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=n != 1;\n"
-"X-Generator: Poedit 1.8.10\n"
-"Project-Id-Version: Development (4.4.x)\n"
+"X-Generator: Poedit 2.1.1\n"
+"Project-Id-Version: Development (4.9.x)\n"
 "Language: es_ES\n"
+"POT-Creation-Date: \n"
+"Last-Translator: \n"
+"Language-Team: \n"
 
 #. translators: 'rtl' or 'ltr'. This sets the text direction for WordPress.
@@ -37 +40 @@
 msgid "(Currently set to: %s)"
 msgstr "(Actualmente fijado en: %s)"
+
+#. 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"

branches/4.9/tests/phpunit/tests/privacy/wpPrivacySendPersonalDataExportEmail.php

@@ -40 +40 @@
      * @since 4.9.6
      */
-    function setUp() {
+    public function setUp() {
         parent::setUp();
         reset_phpmailer_instance();
@@ -50 +50 @@
      * @since 4.9.6
      */
-    function tearDown() {
+    public function tearDown() {
         reset_phpmailer_instance();
         parent::tearDown();
@@ -96 +96 @@
         $email_sent = wp_privacy_send_personal_data_export_email( $request_id );
         $this->assertWPError( $email_sent );
-        $this->assertSame( 'invalid', $email_sent->get_error_code() );
+        $this->assertSame( 'invalid_request', $email_sent->get_error_code() );
 
         $request_id = PHP_INT_MAX;
         $email_sent = wp_privacy_send_personal_data_export_email( $request_id );
         $this->assertWPError( $email_sent );
-        $this->assertSame( 'invalid', $email_sent->get_error_code() );
+        $this->assertSame( 'invalid_request', $email_sent->get_error_code() );
     }
 
@@ -112 +112 @@
         add_filter( 'wp_mail_from', '__return_empty_string' ); // Cause `wp_mail()` to return false.
         $email_sent = wp_privacy_send_personal_data_export_email( self::$request_id );
-        remove_filter( 'wp_mail_from', '__return_empty_string' );
 
         $this->assertWPError( $email_sent );
-        $this->assertSame( 'error', $email_sent->get_error_code() );
+        $this->assertSame( 'privacy_email_error', $email_sent->get_error_code() );
     }
 
@@ -126 +125 @@
         add_filter( 'wp_privacy_export_expiration', array( $this, 'modify_export_expiration' ) );
         wp_privacy_send_personal_data_export_email( self::$request_id );
-        remove_filter( 'wp_privacy_export_expiration', array( $this, 'modify_export_expiration' ) );
 
         $mailer = tests_retrieve_phpmailer_instance();
@@ -153 +151 @@
         add_filter( 'wp_privacy_personal_data_email_content', array( $this, 'modify_email_content' ), 10, 2 );
         wp_privacy_send_personal_data_export_email( self::$request_id );
-        remove_filter( 'wp_privacy_personal_data_email_content', array( $this, 'modify_email_content' ) );
 
         $mailer = tests_retrieve_phpmailer_instance();