Changeset 12160

Timestamp:

06/04/2018 08:02:30 PM (7 years ago)

Author:

boonebgorges

Message:

Add data exporters for Friends component.

See #7821.

Location:

trunk

Files:

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

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

@@ -48 +48 @@
 }
 add_filter( 'bp_user_query_populate_extras', 'bp_friends_filter_user_query_populate_extras', 4, 2 );
+
+/**
+ * Registers Friends 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_friends_register_personal_data_exporters( $exporters ) {
+    $exporters['buddypress-friends'] = array(
+        'exporter_friendly_name' => __( 'BuddyPress Friends', 'buddypress' ),
+        'callback'               => 'bp_friends_personal_data_exporter',
+    );
+
+    $exporters['buddypress-friends-pending-sent-requests'] = array(
+        'exporter_friendly_name' => __( 'BuddyPress Friend Requests (Sent)', 'buddypress' ),
+        'callback'               => 'bp_friends_pending_sent_requests_personal_data_exporter',
+    );
+
+    $exporters['buddypress-friends-pending-received-requests'] = array(
+        'exporter_friendly_name' => __( 'BuddyPress Friend Requests (Received)', 'buddypress' ),
+        'callback'               => 'bp_friends_pending_received_requests_personal_data_exporter',
+    );
+
+    return $exporters;
+}
+add_filter( 'wp_privacy_personal_data_exporters', 'bp_friends_register_personal_data_exporters' );

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

@@ -898 +898 @@
 }
 add_action( 'friends_friendship_accepted', 'friends_notification_accepted_request', 10, 3 );
+
+/**
+ * Finds and exports friendship data associated with an email address.
+ *
+ * @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_friends_personal_data_exporter( $email_address, $page ) {
+    $number = 50;
+
+    $email_address = trim( $email_address );
+
+    $data_to_export = array();
+
+    $user = get_user_by( 'email', $email_address );
+
+    if ( ! $user ) {
+        return array(
+            'data' => array(),
+            'done' => true,
+        );
+    }
+
+    $friendships = BP_Friends_Friendship::get_friendships( $user->ID, array(
+        'is_confirmed' => true,
+        'page'         => $page,
+        'per_page'     => $number,
+    ) );
+
+    $user_data_to_export = array();
+
+    foreach ( $friendships as $friendship ) {
+        if ( (int) $user->ID === (int) $friendship->initiator_user_id ) {
+            $friend_id         = $friendship->friend_user_id;
+            $user_is_initiator = true;
+        } else {
+            $friend_id         = $friendship->initiator_user_id;
+            $user_is_initiator = false;
+        }
+
+        $item_data = array(
+            array(
+                'name'  => __( 'Friend', 'buddypress' ),
+                'value' => bp_core_get_userlink( $friend_id ),
+            ),
+            array(
+                'name'  => __( 'Initiated By Me', 'buddypress' ),
+                'value' => $user_is_initiator ? __( 'Yes', 'buddypress' ) : __( 'No', 'buddypress' ),
+            ),
+            array(
+                'name'  => __( 'Friendship Date', 'buddypress' ),
+                'value' => $friendship->date_created,
+            ),
+        );
+
+        $data_to_export[] = array(
+            'group_id'    => 'bp_friends',
+            'group_label' => __( 'Friends', 'buddypress' ),
+            'item_id'     => "bp-friends-{$friend_id}",
+            'data'        => $item_data,
+        );
+    }
+
+    // Tell core if we have more items to process.
+    $done = count( $friendships ) < $number;
+
+    return array(
+        'data' => $data_to_export,
+        'done' => $done,
+    );
+}
+
+/**
+ * Finds and exports pending sent friendship request data associated with an email address.
+ *
+ * @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_friends_pending_sent_requests_personal_data_exporter( $email_address, $page ) {
+    $number = 50;
+
+    $email_address = trim( $email_address );
+
+    $data_to_export = array();
+
+    $user = get_user_by( 'email', $email_address );
+
+    if ( ! $user ) {
+        return array(
+            'data' => array(),
+            'done' => true,
+        );
+    }
+
+    $friendships = BP_Friends_Friendship::get_friendships( $user->ID, array(
+        'is_confirmed'      => false,
+        'initiator_user_id' => $user->ID,
+        'page'              => $page,
+        'per_page'          => $number,
+    ) );
+
+    $user_data_to_export = array();
+
+    foreach ( $friendships as $friendship ) {
+        $item_data = array(
+            array(
+                'name'  => __( 'Recipient', 'buddypress' ),
+                'value' => bp_core_get_userlink( $friendship->friend_user_id ),
+            ),
+            array(
+                'name'  => __( 'Date Sent', 'buddypress' ),
+                'value' => $friendship->date_created,
+            ),
+        );
+
+        $data_to_export[] = array(
+            'group_id'    => 'bp_friends_pending_sent_requests',
+            'group_label' => __( 'Pending Friend Requests (Sent)', 'buddypress' ),
+            'item_id'     => "bp-friends-pending-sent-request-{$friendship->friend_user_id}",
+            'data'        => $item_data,
+        );
+    }
+
+    // Tell core if we have more items to process.
+    $done = count( $friendships ) < $number;
+
+    return array(
+        'data' => $data_to_export,
+        'done' => $done,
+    );
+}
+
+/**
+ * Finds and exports pending received friendship request data associated with an email address.
+ *
+ * @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_friends_pending_received_requests_personal_data_exporter( $email_address, $page ) {
+    $number = 50;
+
+    $email_address = trim( $email_address );
+
+    $data_to_export = array();
+
+    $user = get_user_by( 'email', $email_address );
+
+    if ( ! $user ) {
+        return array(
+            'data' => array(),
+            'done' => true,
+        );
+    }
+
+    $friendships = BP_Friends_Friendship::get_friendships( $user->ID, array(
+        'is_confirmed'   => false,
+        'friend_user_id' => $user->ID,
+        'page'           => $page,
+        'per_page'       => $number,
+    ) );
+
+    $user_data_to_export = array();
+
+    foreach ( $friendships as $friendship ) {
+        $item_data = array(
+            array(
+                'name'  => __( 'Requester', 'buddypress' ),
+                'value' => bp_core_get_userlink( $friendship->initiator_user_id ),
+            ),
+            array(
+                'name'  => __( 'Date Sent', 'buddypress' ),
+                'value' => $friendship->date_created,
+            ),
+        );
+
+        $data_to_export[] = array(
+            'group_id'    => 'bp_friends_pending_received_requests',
+            'group_label' => __( 'Pending Friend Requests (Received)', 'buddypress' ),
+            'item_id'     => "bp-friends-pending-received-request-{$friendship->initiator_user_id}",
+            'data'        => $item_data,
+        );
+    }
+
+    // Tell core if we have more items to process.
+    $done = count( $friendships ) < $number;
+
+    return array(
+        'data' => $data_to_export,
+        'done' => $done,
+    );
+}

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

@@ -414 +414 @@
         $this->assertEquals( $newest['users'][2]->id, $u2 );
     }
+
+    /**
+     * @ticket BP7821
+     * @ticket BP7698
+     */
+    public function test_bp_friends_personal_data_exporter() {
+        friends_add_friend( self::$user_ids[0], self::$user_ids[1], true );
+        friends_add_friend( self::$user_ids[0], self::$user_ids[2], false );
+        friends_add_friend( self::$user_ids[3], self::$user_ids[0], true );
+        friends_add_friend( self::$user_ids[4], self::$user_ids[0], false );
+
+        $test_user = new WP_User( self::$user_ids[0] );
+
+        $actual = bp_friends_personal_data_exporter( $test_user->user_email, 1 );
+
+        $this->assertTrue( $actual['done'] );
+        $this->assertCount( 2, $actual['data'] );
+
+        $expected_ids = array(
+            'bp-friends-' . self::$user_ids[1],
+            'bp-friends-' . self::$user_ids[3],
+        );
+        $this->assertEqualSets( $expected_ids, wp_list_pluck( $actual['data'], 'item_id' ) );
+    }
+
+    /**
+     * @ticket BP7821
+     * @ticket BP7698
+     */
+    public function test_bp_friends_pending_sent_requests_personal_data_exporter() {
+        friends_add_friend( self::$user_ids[0], self::$user_ids[1], true );
+        friends_add_friend( self::$user_ids[0], self::$user_ids[2], false );
+        friends_add_friend( self::$user_ids[3], self::$user_ids[0], true );
+        friends_add_friend( self::$user_ids[4], self::$user_ids[0], false );
+
+        $test_user = new WP_User( self::$user_ids[0] );
+
+        $actual = bp_friends_pending_sent_requests_personal_data_exporter( $test_user->user_email, 1 );
+
+        $this->assertTrue( $actual['done'] );
+        $this->assertCount( 1, $actual['data'] );
+
+        $expected_ids = array(
+            'bp-friends-pending-sent-request-' . self::$user_ids[2],
+        );
+        $this->assertEqualSets( $expected_ids, wp_list_pluck( $actual['data'], 'item_id' ) );
+    }
+
+    /**
+     * @ticket BP7821
+     * @ticket BP7698
+     */
+    public function test_bp_friends_pending_received_requests_personal_data_exporter() {
+        friends_add_friend( self::$user_ids[0], self::$user_ids[1], true );
+        friends_add_friend( self::$user_ids[0], self::$user_ids[2], false );
+        friends_add_friend( self::$user_ids[3], self::$user_ids[0], true );
+        friends_add_friend( self::$user_ids[4], self::$user_ids[0], false );
+
+        $test_user = new WP_User( self::$user_ids[0] );
+
+        $actual = bp_friends_pending_received_requests_personal_data_exporter( $test_user->user_email, 1 );
+
+        $this->assertTrue( $actual['done'] );
+        $this->assertCount( 1, $actual['data'] );
+
+        $expected_ids = array(
+            'bp-friends-pending-received-request-' . self::$user_ids[4],
+        );
+        $this->assertEqualSets( $expected_ids, wp_list_pluck( $actual['data'], 'item_id' ) );
+    }
 }