<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][12163] trunk: Add data exporters for Groups component.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/12163">12163</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/12163","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-06-04 20:52:12 +0000 (Mon, 04 Jun 2018)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Add data exporters for Groups component.
See <a href="http://buddypress.trac.wordpress.org/ticket/7820">#7820</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpgroupsbpgroupsfiltersphp">trunk/src/bp-groups/bp-groups-filters.php</a></li>
<li><a href="#trunksrcbpgroupsbpgroupsfunctionsphp">trunk/src/bp-groups/bp-groups-functions.php</a></li>
<li><a href="#trunktestsphpunittestcasesgroupsfunctionsphp">trunk/tests/phpunit/testcases/groups/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpgroupsbpgroupsfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/bp-groups-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/bp-groups-filters.php 2018-06-04 20:43:08 UTC (rev 12162)
+++ trunk/src/bp-groups/bp-groups-filters.php 2018-06-04 20:52:12 UTC (rev 12163)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -74,6 +74,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_core_avatar_default', 'bp_groups_default_avatar', 10, 3 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_core_avatar_default_thumb', 'bp_groups_default_avatar', 10, 3 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Personal data export.
+add_filter( 'wp_privacy_personal_data_exporters', 'bp_groups_register_personal_data_exporters' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filter output of Group Description through WordPress's KSES API.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -362,3 +365,35 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_user_can', 'bp_groups_user_can_filter', 10, 5 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * 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;
+}
</ins></span></pre></div>
<a id="trunksrcbpgroupsbpgroupsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-groups/bp-groups-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-groups/bp-groups-functions.php 2018-06-04 20:43:08 UTC (rev 12162)
+++ trunk/src/bp-groups/bp-groups-functions.php 2018-06-04 20:52:12 UTC (rev 12163)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2638,3 +2638,298 @@
</span><span class="cx" style="display: block; padding: 0 10px"> bp_groups_set_group_type( $group_id, '' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'groups_delete_group', 'bp_remove_group_type_on_group_delete' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * 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,
+ );
+}
</ins></span></pre></div>
<a id="trunktestsphpunittestcasesgroupsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/groups/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/groups/functions.php 2018-06-04 20:43:08 UTC (rev 12162)
+++ trunk/tests/phpunit/testcases/groups/functions.php 2018-06-04 20:52:12 UTC (rev 12163)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5,6 +5,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @group functions
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class BP_Tests_Groups_Functions extends BP_UnitTestCase {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_creating_new_group_as_authenticated_user() {
</span><span class="cx" style="display: block; padding: 0 10px"> $u = self::factory()->user->create();
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( $u );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -849,4 +864,75 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNull( groups_get_id_by_previous_slug( 'woohoo' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @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'] );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>