Changeset 43117

Timestamp:

05/02/2018 04:20:35 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Privacy: add user information to the personal data export file.

Props TZ-Media, desrosj.
Merges [43055] and [43116] to the 4.9 branch.
See #43547.

Location:

branches/4.9

Files:

• . (modified) (1 prop)
• src/wp-includes/default-filters.php (modified) (1 diff)
• src/wp-includes/user.php (modified) (1 diff)
• tests/phpunit/tests/user.php (modified) (2 diffs)

branches/4.9/src/wp-includes/default-filters.php

@@ -326 +326 @@
 add_filter( 'wp_privacy_personal_data_exporters', 'wp_register_comment_personal_data_exporter' );
 add_filter( 'wp_privacy_personal_data_exporters', 'wp_register_media_personal_data_exporter' );
+add_filter( 'wp_privacy_personal_data_exporters', 'wp_register_user_personal_data_exporter' );
 add_filter( 'wp_privacy_personal_data_erasers', 'wp_register_comment_personal_data_eraser' );
 add_action( 'init', 'wp_schedule_delete_old_privacy_export_files' );

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

@@ -2749 +2749 @@
 
 /**
+ * Registers the personal data exporter for users.
+ *
+ * @since 4.9.6
+ *
+ * @param array $exporters  An array of personal data exporters.
+ * @return array An array of personal data exporters.
+ */
+function wp_register_user_personal_data_exporter( $exporters ) {
+    $exporters[] = array(
+        'exporter_friendly_name' => __( 'WordPress User' ),
+        'callback'               => 'wp_user_personal_data_exporter',
+    );
+
+    return $exporters;
+}
+
+/**
+ * Finds and exports personal data associated with an email address from the user and user_meta table.
+ *
+ * @since 4.9.6
+ *
+ * @param string $email_address  The users email address.
+ * @return array An array of personal data.
+ */
+function wp_user_personal_data_exporter( $email_address ) {
+    $email_address = trim( $email_address );
+
+    $data_to_export = array();
+
+    $user = get_user_by( 'email', $email_address );
+
+    if ( ! $user ) {
+        return array(
+            'data' => array(),
+            'done' => true,
+        );
+    }
+
+    $user_meta = get_user_meta( $user->ID );
+
+    $user_prop_to_export = array(
+        'ID'              => __( 'User ID' ),
+        'user_login'      => __( 'User Login Name' ),
+        'user_nicename'   => __( 'User Nice Name' ),
+        'user_email'      => __( 'User Email' ),
+        'user_url'        => __( 'User URL' ),
+        'user_registered' => __( 'User Registration Date' ),
+        'display_name'    => __( 'User Display Name' ),
+        'nickname'        => __( 'User Nickname' ),
+        'first_name'      => __( 'User First Name' ),
+        'last_name'       => __( 'User Last Name' ),
+        'description'     => __( 'User Description' ),
+    );
+
+    $user_data_to_export = array();
+
+    foreach ( $user_prop_to_export as $key => $name ) {
+        $value = '';
+
+        switch ( $key ) {
+            case 'ID':
+            case 'user_login':
+            case 'user_nicename':
+            case 'user_email':
+            case 'user_url':
+            case 'user_registered':
+            case 'display_name':
+                $value = $user->data->$key;
+                break;
+            case 'nickname':
+            case 'first_name':
+            case 'last_name':
+            case 'description':
+                $value = $user_meta[ $key ][0];
+                break;
+        }
+
+        if ( ! empty( $value ) ) {
+            $user_data_to_export[] = array(
+                'name'  => $name,
+                'value' => $value,
+            );
+        }
+    }
+
+    $data_to_export[] = array(
+        'group_id'    => 'user',
+        'group_label' => __( 'User' ),
+        'item_id'     => "user-{$user->ID}",
+        'data'        => $user_data_to_export,
+    );
+
+    return array(
+        'data' => $data_to_export,
+        'done' => true,
+    );
+}
+
+/**
  * Update log when privacy request is confirmed.
  *

branches/4.9/tests/phpunit/tests/user.php

@@ -28 +28 @@
             'user_email' => 'blackburn@battlefield3.com',
             'user_url' => 'http://tacos.com',
-            'role' => 'contributor'
+            'role' => 'contributor',
+            'nickname' => 'Johnny',
+            'description' => 'I am a WordPress user that cares about privacy.',
         ) );
 
@@ -1450 +1452 @@
         $this->assertNotContains( ''Test' blog's "name" has <html entities> &', $email->subject, 'Email subject does contains HTML entities' );
     }
+
+    /**
+     * Testing the `wp_user_personal_data_exporter_no_user` function when no user exists.
+     *
+     * @ticket 43547
+     */
+    function test_wp_user_personal_data_exporter_no_user() {
+        $actual = wp_user_personal_data_exporter( 'not-a-user-email@test.com' );
+
+        $expected = array(
+            'data' => array(),
+            'done' => true,
+        );
+
+        $this->assertSame( $expected, $actual );
+    }
+
+    /**
+     * Testing the `wp_user_personal_data_exporter_no_user` function when the requested
+     * user exists.
+     *
+     * @ticket 43547
+     */
+    function test_wp_user_personal_data_exporter() {
+        $test_user = new WP_User( self::$contrib_id );
+
+        $actual = wp_user_personal_data_exporter( $test_user->user_email );
+
+        $this->assertTrue( $actual['done'] );
+
+        // Number of exported users.
+        $this->assertSame( 1, count( $actual['data'] ) );
+
+        // Number of exported user properties.
+        $this->assertSame( 11, count( $actual['data'][0]['data'] ) );
+    }
 }