<!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][12160] trunk: Add data exporters for Friends 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/12160">12160</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/12160","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:02:30 +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 Friends component.
See <a href="http://buddypress.trac.wordpress.org/ticket/7821">#7821</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpfriendsbpfriendsfiltersphp">trunk/src/bp-friends/bp-friends-filters.php</a></li>
<li><a href="#trunksrcbpfriendsbpfriendsfunctionsphp">trunk/src/bp-friends/bp-friends-functions.php</a></li>
<li><a href="#trunktestsphpunittestcasesfriendsfunctionsphp">trunk/tests/phpunit/testcases/friends/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpfriendsbpfriendsfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-friends/bp-friends-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-friends/bp-friends-filters.php 2018-06-04 20:01:09 UTC (rev 12159)
+++ trunk/src/bp-friends/bp-friends-filters.php 2018-06-04 20:02:30 UTC (rev 12160)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -47,3 +47,31 @@
</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_query_populate_extras', 'bp_friends_filter_user_query_populate_extras', 4, 2 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * 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' );
</ins></span></pre></div>
<a id="trunksrcbpfriendsbpfriendsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-friends/bp-friends-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-friends/bp-friends-functions.php 2018-06-04 20:01:09 UTC (rev 12159)
+++ trunk/src/bp-friends/bp-friends-functions.php 2018-06-04 20:02:30 UTC (rev 12160)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -897,3 +897,203 @@
</span><span class="cx" style="display: block; padding: 0 10px"> bp_send_email( 'friends-request-accepted', $initiator_id, $args );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'friends_friendship_accepted', 'friends_notification_accepted_request', 10, 3 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * 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,
+ );
+}
</ins></span></pre></div>
<a id="trunktestsphpunittestcasesfriendsfunctionsphp"></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/friends/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/friends/functions.php 2018-06-04 20:01:09 UTC (rev 12159)
+++ trunk/tests/phpunit/testcases/friends/functions.php 2018-06-04 20:02:30 UTC (rev 12160)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -413,4 +413,74 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $newest['users'][1]->id, $u3 );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $newest['users'][2]->id, $u2 );
</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 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' ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>