Changeset 12164

Timestamp:

06/04/2018 08:54:02 PM (6 years ago)

Author:

boonebgorges

Message:

Add data exporter for Messages component.

See #7819.

Location:

trunk

Files:

• src/bp-messages/bp-messages-filters.php (modified) (2 diffs)
• src/bp-messages/bp-messages-functions.php (modified) (1 diff)
• tests/phpunit/testcases/messages/functions.php (modified) (1 diff)

trunk/src/bp-messages/bp-messages-filters.php

@@ -80 +80 @@
 add_filter( 'bp_get_message_thread_content',          'stripslashes_deep', 1 );
 
+// Personal data export.
+add_filter( 'wp_privacy_personal_data_exporters', 'bp_messages_register_personal_data_exporter' );
+
 /**
  * Enforce limitations on viewing private message contents
@@ -127 +130 @@
     return wp_kses( $content, $messages_allowedtags );
 }
+
+/**
+ * Register Messages personal data exporter.
+ *
+ * @since 4.0.0
+ *
+ * @param array $exporters  An array of personal data exporters.
+ * @return array An array of personal data exporters.
+ */
+function bp_messages_register_personal_data_exporter( $exporters ) {
+    $exporters['buddypress-messages'] = array(
+        'exporter_friendly_name' => __( 'BuddyPress Messages', 'buddypress' ),
+        'callback'               => 'bp_messages_personal_data_exporter',
+    );
+
+    return $exporters;
+}

trunk/src/bp-messages/bp-messages-functions.php

@@ -631 +631 @@
 }
 add_action( 'messages_message_sent', 'messages_notification_new_message', 10 );
+
+/**
+ * Finds and exports personal data associated with an email address from the Messages tables.
+ *
+ * @since 4.0.0
+ *
+ * @param string $email_address  The user's email address.
+ * @param int    $page           Batch number.
+ * @return array An array of personal data.
+ */
+function bp_messages_personal_data_exporter( $email_address, $page ) {
+    $number = 10;
+
+    $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_data_to_export = array();
+
+    $user_threads = BP_Messages_Thread::get_current_threads_for_user( array(
+        'user_id' => $user->ID,
+        'box'     => 'sentbox',
+        'type'    => null,
+        'limit'   => $number,
+        'page'    => $page,
+    ) );
+
+    foreach ( $user_threads['threads'] as $thread ) {
+        $recipient_links = array();
+        foreach ( $thread->recipients as $recipient ) {
+            if ( $recipient->user_id === $user->ID ) {
+                continue;
+            }
+
+            $recipient_links[] = bp_core_get_userlink( $recipient->user_id );
+        }
+        $recipients = implode( ', ', $recipient_links );
+
+        $thread_link = bp_get_message_thread_view_link( $thread->thread_id, $user->ID );
+
+        foreach ( $thread->messages as $message_index => $message ) {
+            // Only include messages written by the user.
+            if ( $recipient->user_id !== $message->sender_id ) {
+                continue;
+            }
+
+            $message_data = array(
+                array(
+                    'name'  => __( 'Message Subject', 'buddypress' ),
+                    'value' => $message->subject,
+                ),
+                array(
+                    'name'  => __( 'Message Content', 'buddypress' ),
+                    'value' => $message->message,
+                ),
+                array(
+                    'name'  => __( 'Date Sent', 'buddypress' ),
+                    'value' => $message->date_sent,
+                ),
+                array(
+                    'name' => __( 'Recipients', 'buddypress' ),
+                    'value' => $recipients,
+                ),
+                array(
+                    'name'  => __( 'Thread URL', 'buddypress' ),
+                    'value' => $thread_link,
+                ),
+            );
+
+            $data_to_export[] = array(
+                'group_id'    => 'bp_messages',
+                'group_label' => __( 'Private Messages', 'buddypress' ),
+                'item_id'     => "bp-messages-{$message->id}",
+                'data'        => $message_data,
+            );
+        }
+    }
+
+    return array(
+        'data' => $data_to_export,
+        'done' => true,
+    );
+}

trunk/tests/phpunit/testcases/messages/functions.php

@@ -90 +90 @@
         $message->recipients = array();
     }
+
+    /**
+     * @ticket BP7819
+     * @ticket BP7698
+     */
+    public function test_bp_messages_personal_data_exporter() {
+        $u1 = self::factory()->user->create();
+        $u2 = self::factory()->user->create();
+
+        $time = time();
+
+        $t1 = messages_new_message( array(
+            'sender_id'  => $u1,
+            'recipients' => array( $u2 ),
+            'subject'    => 'A new message',
+            'content'    => 'Hey there!',
+            'date_sent'  => date( 'Y-m-d H:i:s', $time - ( 3 * HOUR_IN_SECONDS ) ),
+        ) );
+
+        $t1m1 = messages_new_message( array(
+            'sender_id'  => $u2,
+            'thread_id'  => $t1,
+            'recipients' => array( $u1 ),
+            'subject'    => 'Reply to ' . $t1,
+            'content'    => 'Hey there!',
+            'date_sent'  => date( 'Y-m-d H:i:s', $time - ( 2 * HOUR_IN_SECONDS ) ),
+        ) );
+
+        $t1m2 = messages_new_message( array(
+            'sender_id'  => $u1,
+            'thread_id'  => $t1,
+            'recipients' => array( $u2 ),
+            'subject'    => 'Reply to ' . $t1,
+            'content'    => 'Hey there!',
+            'date_sent'  => date( 'Y-m-d H:i:s', $time - ( 2 * HOUR_IN_SECONDS ) ),
+        ) );
+
+        $t2 = messages_new_message( array(
+            'sender_id'  => $u2,
+            'recipients' => array( $u1 ),
+            'subject'    => 'A new message',
+            'content'    => 'Hey there!',
+            'date_sent'  => date( 'Y-m-d H:i:s', $time - ( 5 * HOUR_IN_SECONDS ) ),
+        ) );
+
+        $t2m1 = messages_new_message( array(
+            'sender_id'  => $u1,
+            'thread_id'  => $t2,
+            'recipients' => array( $u2 ),
+            'subject'    => 'Reply to ' . $t2,
+            'content'    => 'Hey there!',
+            'date_sent'  => date( 'Y-m-d H:i:s', $time - ( 4 * HOUR_IN_SECONDS ) ),
+        ) );
+
+        $test_user = new WP_User( $u1 );
+
+        $actual = bp_messages_personal_data_exporter( $test_user->user_email, 1 );
+
+        $this->assertTrue( $actual['done'] );
+
+        // Number of exported messages.
+        $this->assertSame( 3, count( $actual['data'] ) );
+    }
 }