Changeset 12163

Timestamp:

06/04/2018 08:52:12 PM (8 years ago)

Author:

boonebgorges

Message:

Add data exporters for Groups component.

See #7820.

Location:

trunk

Files:

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

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

@@ -74 +74 @@
 add_filter( 'bp_core_avatar_default',       'bp_groups_default_avatar', 10, 3 );
 add_filter( 'bp_core_avatar_default_thumb', 'bp_groups_default_avatar', 10, 3 );
+
+// Personal data export.
+add_filter( 'wp_privacy_personal_data_exporters', 'bp_groups_register_personal_data_exporters' );
 
 /**
@@ -363 +366 @@
 }
 add_filter( 'bp_user_can', 'bp_groups_user_can_filter', 10, 5 );
+
+/**
+ * Registers Groups personal data exporters.
+ *
+ * @since 4.0.0
+ *
+ * @param array $exporters  An array of personal data exporters.
+ * @return array An array of personal data exporters.
+ */
+function bp_groups_register_personal_data_exporters( $exporters ) {
+        $exporters['buddypress-groups-memberships'] = array(
+                'exporter_friendly_name' => __( 'BuddyPress Group Memberships', 'buddypress' ),
+                'callback'               => 'bp_groups_memberships_personal_data_exporter',
+        );
+
+        $exporters['buddypress-groups-pending-requests'] = array(
+                'exporter_friendly_name' => __( 'BuddyPress Pending Group Membership Requests', 'buddypress' ),
+                'callback'               => 'bp_groups_pending_requests_personal_data_exporter',
+        );
+
+        $exporters['buddypress-groups-pending-received-invitations'] = array(
+                'exporter_friendly_name' => __( 'BuddyPress Pending Group Invitations (Received)', 'buddypress' ),
+                'callback'               => 'bp_groups_pending_received_invitations_personal_data_exporter',
+        );
+
+        $exporters['buddypress-groups-pending-sent-invitations'] = array(
+                'exporter_friendly_name' => __( 'BuddyPress Pending Group Invitations (Sent)', 'buddypress' ),
+                'callback'               => 'bp_groups_pending_sent_invitations_personal_data_exporter',
+        );
+
+        return $exporters;
+}

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

@@ -2639 +2639 @@
 }
 add_action( 'groups_delete_group', 'bp_remove_group_type_on_group_delete' );
+
+/**
+ * Finds and exports group membership 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_groups_memberships_personal_data_exporter( $email_address, $page ) {
+        $number = 20;
+
+        $email_address = trim( $email_address );
+
+        $data_to_export = array();
+
+        $user = get_user_by( 'email', $email_address );
+
+        if ( ! $user ) {
+                return array(
+                        'data' => array(),
+                        'done' => true,
+                );
+        }
+
+        $memberships = BP_Groups_Member::get_user_memberships( $user->ID, array(
+                'type'     => 'membership',
+                'page'     => $page,
+                'per_page' => $number,
+        ) );
+
+        foreach ( $memberships as $membership ) {
+                $group = groups_get_group( $membership->group_id );
+
+                $item_data = array(
+                        array(
+                                'name'  => __( 'Group Name', 'buddypress' ),
+                                'value' => bp_get_group_name( $group ),
+                        ),
+                        array(
+                                'name'  => __( 'Group URL', 'buddypress' ),
+                                'value' => bp_get_group_permalink( $group ),
+                        ),
+                );
+
+                if ( $membership->inviter_id ) {
+                        $item_data[] = array(
+                                'name'  => __( 'Invited By', 'buddypress' ),
+                                'value' => bp_core_get_userlink( $membership->inviter_id ),
+                        );
+                }
+
+                if ( $group->creator_id === $user->ID ) {
+                        $group_role = __( 'Creator', 'buddypress' );
+                } elseif ( $membership->is_admin ) {
+                        $group_role = __( 'Admin', 'buddypress' );
+                } elseif ( $membership->is_mod ) {
+                        $group_role = __( 'Moderator', 'buddypress' );
+                } else {
+                        $group_role = __( 'Member', 'buddypress' );
+                }
+
+                $item_data[] = array(
+                        'name'  => __( 'Group Role', 'buddypress' ),
+                        'value' => $group_role,
+                );
+
+                $item_data[] = array(
+                        'name'  => __( 'Date Joined', 'buddypress' ),
+                        'value' => $membership->date_modified,
+                );
+
+                $data_to_export[] = array(
+                        'group_id'    => 'bp_groups_memberships',
+                        'group_label' => __( 'Group Memberships', 'buddypress' ),
+                        'item_id'     => "bp-group-membership-{$group->id}",
+                        'data'        => $item_data,
+                );
+        }
+
+        // Tell core if we have more items to process.
+        $done = count( $memberships ) < $number;
+
+        return array(
+                'data' => $data_to_export,
+                'done' => $done,
+        );
+}
+
+/**
+ * Finds and exports data on pending group membership requests 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_groups_pending_requests_personal_data_exporter( $email_address, $page ) {
+        $number = 20;
+
+        $email_address = trim( $email_address );
+
+        $data_to_export = array();
+
+        $user = get_user_by( 'email', $email_address );
+
+        if ( ! $user ) {
+                return array(
+                        'data' => array(),
+                        'done' => true,
+                );
+        }
+
+        $requests = BP_Groups_Member::get_user_memberships( $user->ID, array(
+                'type'     => 'pending_request',
+                'page'     => $page,
+                'per_page' => $number,
+        ) );
+
+        foreach ( $requests as $request ) {
+                $group = groups_get_group( $request->group_id );
+
+                $item_data = array(
+                        array(
+                                'name'  => __( 'Group Name', 'buddypress' ),
+                                'value' => bp_get_group_name( $group ),
+                        ),
+                        array(
+                                'name'  => __( 'Group URL', 'buddypress' ),
+                                'value' => bp_get_group_permalink( $group ),
+                        ),
+                        array(
+                                'name'  => __( 'Date Sent', 'buddypress' ),
+                                'value' => $request->date_modified,
+                        ),
+                );
+
+                $data_to_export[] = array(
+                        'group_id'    => 'bp_groups_pending_requests',
+                        'group_label' => __( 'Pending Group Membership Requests', 'buddypress' ),
+                        'item_id'     => "bp-group-pending-request-{$group->id}",
+                        'data'        => $item_data,
+                );
+        }
+
+        // Tell core if we have more items to process.
+        $done = count( $requests ) < $number;
+
+        return array(
+                'data' => $data_to_export,
+                'done' => $done,
+        );
+}
+
+/**
+ * Finds and exports data on pending group invitations sent by a user 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_groups_pending_sent_invitations_personal_data_exporter( $email_address, $page ) {
+        $number = 20;
+
+        $email_address = trim( $email_address );
+
+        $data_to_export = array();
+
+        $user = get_user_by( 'email', $email_address );
+
+        if ( ! $user ) {
+                return array(
+                        'data' => array(),
+                        'done' => true,
+                );
+        }
+
+        $invitations = BP_Groups_Member::get_user_memberships( $user->ID, array(
+                'type'     => 'pending_sent_invitation',
+                'page'     => $page,
+                'per_page' => $number,
+        ) );
+
+        foreach ( $invitations as $invitation ) {
+                $group = groups_get_group( $invitation->group_id );
+
+                $item_data = array(
+                        array(
+                                'name'  => __( 'Group Name', 'buddypress' ),
+                                'value' => bp_get_group_name( $group ),
+                        ),
+                        array(
+                                'name'  => __( 'Group URL', 'buddypress' ),
+                                'value' => bp_get_group_permalink( $group ),
+                        ),
+                        array(
+                                'name'  => __( 'Sent To', 'buddypress' ),
+                                'value' => bp_core_get_userlink( $invitation->user_id ),
+                        ),
+                        array(
+                                'name'  => __( 'Date Sent', 'buddypress' ),
+                                'value' => $invitation->date_modified,
+                        ),
+                );
+
+                $data_to_export[] = array(
+                        'group_id'    => 'bp_groups_pending_sent_invitations',
+                        'group_label' => __( 'Pending Group Invitations (Sent)', 'buddypress' ),
+                        'item_id'     => "bp-group-pending-sent-invitation-{$group->id}",
+                        'data'        => $item_data,
+                );
+        }
+
+        // Tell core if we have more items to process.
+        $done = count( $invitations ) < $number;
+
+        return array(
+                'data' => $data_to_export,
+                'done' => $done,
+        );
+}
+
+/**
+ * Finds and exports data on pending group invitations received by a user 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_groups_pending_received_invitations_personal_data_exporter( $email_address, $page ) {
+        $number = 20;
+
+        $email_address = trim( $email_address );
+
+        $data_to_export = array();
+
+        $user = get_user_by( 'email', $email_address );
+
+        if ( ! $user ) {
+                return array(
+                        'data' => array(),
+                        'done' => true,
+                );
+        }
+
+        $invitations = BP_Groups_Member::get_user_memberships( $user->ID, array(
+                'type'     => 'pending_received_invitation',
+                'page'     => $page,
+                'per_page' => $number,
+        ) );
+
+        foreach ( $invitations as $invitation ) {
+                $group = groups_get_group( $invitation->group_id );
+
+                $item_data = array(
+                        array(
+                                'name'  => __( 'Group Name', 'buddypress' ),
+                                'value' => bp_get_group_name( $group ),
+                        ),
+                        array(
+                                'name'  => __( 'Group URL', 'buddypress' ),
+                                'value' => bp_get_group_permalink( $group ),
+                        ),
+                        array(
+                                'name'  => __( 'Invited By', 'buddypress' ),
+                                'value' => bp_core_get_userlink( $invitation->inviter_id ),
+                        ),
+                        array(
+                                'name'  => __( 'Date Sent', 'buddypress' ),
+                                'value' => $invitation->date_modified,
+                        ),
+                );
+
+                $data_to_export[] = array(
+                        'group_id'    => 'bp_groups_pending_received_invitations',
+                        'group_label' => __( 'Pending Group Invitations (Received)', 'buddypress' ),
+                        'item_id'     => "bp-group-pending-received-invitation-{$group->id}",
+                        'data'        => $item_data,
+                );
+        }
+
+        // Tell core if we have more items to process.
+        $done = count( $invitations ) < $number;
+
+        return array(
+                'data' => $data_to_export,
+                'done' => $done,
+        );
+}

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

@@ -6 +6 @@
  */
 class BP_Tests_Groups_Functions extends BP_UnitTestCase {
+        static public $group_ids;
+        static public $user_ids;
+
+        static public function wpSetUpBeforeClass( $factory ) {
+                self::$user_ids  = $factory->user->create_many( 3 );
+                self::$group_ids = $factory->group->create_many( 2, array(
+                        'creator_id' => self::$user_ids[2],
+                ) );
+        }
+
+        static public function wpTearDownAfterClass() {
+                array_map( array( __CLASS__, 'delete_user' ), self::$user_ids );
+                array_map( 'groups_delete_group', self::$group_ids );
+        }
+
         public function test_creating_new_group_as_authenticated_user() {
                 $u = self::factory()->user->create();
@@ -850 +865 @@
         }
 
+        /**
+         * @ticket BP7820
+         * @ticket BP7698
+         */
+        public function test_bp_groups_memberships_personal_data_exporter() {
+                groups_join_group( self::$group_ids[0], self::$user_ids[0] );
+
+                $test_user = new WP_User( self::$user_ids[0] );
+
+                $actual = bp_groups_memberships_personal_data_exporter( $test_user->user_email, 1 );
+
+                $this->assertTrue( $actual['done'] );
+                $this->assertCount( 1, $actual['data'] );
+                $this->assertSame( 'bp-group-membership-' . self::$group_ids[0], $actual['data'][0]['item_id'] );
+        }
+
+        /**
+         * @ticket BP7820
+         * @ticket BP7698
+         */
+        public function test_bp_groups_pending_requests_personal_data_exporter() {
+                groups_send_membership_request( self::$user_ids[0], self::$group_ids[0] );
+
+                $test_user = new WP_User( self::$user_ids[0] );
+
+                $actual = bp_groups_pending_requests_personal_data_exporter( $test_user->user_email, 1 );
+
+                $this->assertTrue( $actual['done'] );
+                $this->assertCount( 1, $actual['data'] );
+                $this->assertSame( 'bp-group-pending-request-' . self::$group_ids[0], $actual['data'][0]['item_id'] );
+        }
+
+        /**
+         * @ticket BP7820
+         * @ticket BP7698
+         */
+        public function test_bp_groups_pending_sent_invitations_personal_data_exporter() {
+                groups_invite_user( array(
+                        'user_id'    => self::$user_ids[1],
+                        'group_id'   => self::$group_ids[0],
+                        'inviter_id' => self::$user_ids[0],
+                ) );
+
+                $test_user = new WP_User( self::$user_ids[0] );
+
+                $actual = bp_groups_pending_sent_invitations_personal_data_exporter( $test_user->user_email, 1 );
+
+                $this->assertTrue( $actual['done'] );
+                $this->assertCount( 1, $actual['data'] );
+                $this->assertSame( 'bp-group-pending-sent-invitation-' . self::$group_ids[0], $actual['data'][0]['item_id'] );
+        }
+
+        /**
+         * @ticket BP7820
+         * @ticket BP7698
+         */
+        public function test_bp_groups_pending_received_invitations_personal_data_exporter() {
+                groups_invite_user( array(
+                        'user_id'    => self::$user_ids[0],
+                        'group_id'   => self::$group_ids[0],
+                        'inviter_id' => self::$user_ids[1],
+                ) );
+
+                $test_user = new WP_User( self::$user_ids[0] );
+
+                $actual = bp_groups_pending_received_invitations_personal_data_exporter( $test_user->user_email, 1 );
+
+                $this->assertTrue( $actual['done'] );
+                $this->assertCount( 1, $actual['data'] );
+                $this->assertSame( 'bp-group-pending-received-invitation-' . self::$group_ids[0], $actual['data'][0]['item_id'] );
+        }
 }