<!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][12158] trunk: Add data exporter for Notifications 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/12158">12158</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/12158","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 19:58: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 exporter for Notifications component.
See <a href="http://buddypress.trac.wordpress.org/ticket/7827">#7827</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpnotificationsbpnotificationsfunctionsphp">trunk/src/bp-notifications/bp-notifications-functions.php</a></li>
<li><a href="#trunksrcbpnotificationsclassesclassbpnotificationscomponentphp">trunk/src/bp-notifications/classes/class-bp-notifications-component.php</a></li>
<li><a href="#trunktestsphpunittestcasesnotificationsfunctionsphp">trunk/tests/phpunit/testcases/notifications/functions.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunksrcbpnotificationsbpnotificationsfiltersphp">trunk/src/bp-notifications/bp-notifications-filters.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpnotificationsbpnotificationsfiltersphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/bp-notifications/bp-notifications-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-notifications/bp-notifications-filters.php (rev 0)
+++ trunk/src/bp-notifications/bp-notifications-filters.php 2018-06-04 19:58:30 UTC (rev 12158)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,28 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Filters related to the Activity component.
+ *
+ * @package BuddyPress
+ * @subpackage Notifications
+ * @since 4.0.0
+ */
+
+// Privacy data export.
+add_filter( 'wp_privacy_personal_data_exporters', 'bp_register_notifications_personal_data_exporter' );
+
+/**
+ * Register Notifications 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_register_notifications_personal_data_exporter( $exporters ) {
+ $exporters['buddypress-notifications'] = array(
+ 'exporter_friendly_name' => __( 'BuddyPress Notifications Data', 'buddypress' ),
+ 'callback' => 'bp_notifications_personal_data_exporter',
+ );
+
+ return $exporters;
+}
</ins></span></pre></div>
<a id="trunksrcbpnotificationsbpnotificationsfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-notifications/bp-notifications-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-notifications/bp-notifications-functions.php 2018-06-03 11:09:56 UTC (rev 12157)
+++ trunk/src/bp-notifications/bp-notifications-functions.php 2018-06-04 19:58:30 UTC (rev 12158)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -794,3 +794,97 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $retval;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Finds and exports personal data associated with an email address from the Notifications tables.
+ *
+ * @since 4.0.0
+ *
+ * @param string $email_address The users email address.
+ * @param int $page Batch number.
+ * @return array An array of personal data.
+ */
+function bp_notifications_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,
+ );
+ }
+
+ $notifications = BP_Notifications_Notification::get( array(
+ 'is_new' => null,
+ 'per_page' => $number,
+ 'page' => $page,
+ 'user_id' => $user->ID,
+ 'order' => 'DESC',
+ ) );
+
+ $user_data_to_export = array();
+
+ foreach ( $notifications as $notification ) {
+ if ( 'xprofile' === $notification->component_name ) {
+ $component_name = 'profile';
+ } else {
+ $component_name = $notification->component_name;
+ }
+
+ // Format notifications.
+ if ( isset( buddypress()->{$component_name}->notification_callback ) && is_callable( buddypress()->{$component_name}->notification_callback ) ) {
+ $content = call_user_func( buddypress()->{$component_name}->notification_callback, $notification->component_action, $notification->item_id, $notification->secondary_item_id, 1, 'string', $notification->id );
+ } else {
+ // The array to reference with apply_filters_ref_array().
+ $ref_array = array(
+ $notification->component_action,
+ $notification->item_id,
+ $notification->secondary_item_id,
+ $notification->total_count,
+ 'string',
+ $notification->component_action,
+ $component_name,
+ $notification_item->id,
+ );
+
+ /** This filter is documented in bp-notifications/bp-notifications-functions.php */
+ $content = apply_filters_ref_array( 'bp_notifications_get_notifications_for_user', $ref_array );
+ }
+
+ $item_data = array(
+ array(
+ 'name' => __( 'Notification Content', 'buddypress' ),
+ 'value' => $content,
+ ),
+ array(
+ 'name' => __( 'Notification Date', 'buddypress' ),
+ 'value' => $notification->date_notified,
+ ),
+ array(
+ 'name' => __( 'Status', 'buddypress' ),
+ 'value' => $notification->is_new ? __( 'Unread', 'buddypress' ) : __( 'Read', 'buddypress' ),
+ ),
+ );
+
+ $data_to_export[] = array(
+ 'group_id' => 'bp_notifications',
+ 'group_label' => __( 'Notifications' ),
+ 'item_id' => "bp-notifications-{$notification->id}",
+ 'data' => $item_data,
+ );
+ }
+
+ // Tell core if we have more items to process.
+ $done = count( $notifications ) < $number;
+
+ return array(
+ 'data' => $data_to_export,
+ 'done' => $done,
+ );
+}
</ins></span></pre></div>
<a id="trunksrcbpnotificationsclassesclassbpnotificationscomponentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-notifications/classes/class-bp-notifications-component.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-notifications/classes/class-bp-notifications-component.php 2018-06-03 11:09:56 UTC (rev 12157)
+++ trunk/src/bp-notifications/classes/class-bp-notifications-component.php 2018-06-04 19:58:30 UTC (rev 12158)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -46,6 +46,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $includes = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'adminbar',
</span><span class="cx" style="display: block; padding: 0 10px"> 'template',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'filters',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'functions',
</span><span class="cx" style="display: block; padding: 0 10px"> 'cache',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span></span></pre></div>
<a id="trunktestsphpunittestcasesnotificationsfunctionsphp"></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/notifications/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/notifications/functions.php 2018-06-03 11:09:56 UTC (rev 12157)
+++ trunk/tests/phpunit/testcases/notifications/functions.php 2018-06-04 19:58:30 UTC (rev 12158)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -432,4 +432,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $found = bp_notifications_get_grouped_notifications_for_user( $u );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 2, $found[0]->total_count );
</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 BP7827
+ */
+ public function test_bp_notifications_personal_data_exporter() {
+ $u = self::factory()->user->create();
+
+ // Create notifications
+ $n1 = self::factory()->notification->create( array(
+ 'component_name' => 'messages',
+ 'component_action' => 'new_message',
+ 'item_id' => 99,
+ 'user_id' => $u,
+ ) );
+
+ $n2 = self::factory()->notification->create( array(
+ 'component_name' => 'activity',
+ 'component_action' => 'new_at_mention',
+ 'item_id' => 99,
+ 'user_id' => $u,
+ ) );
+
+ $test_user = new WP_User( $u );
+
+ $actual = bp_notifications_personal_data_exporter( $test_user->user_email, 1 );
+
+ $this->assertTrue( $actual['done'] );
+
+ // Number of exported notification items.
+ $this->assertSame( 2, count( $actual['data'] ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>