Changeset 12112

Timestamp:

05/23/2018 02:37:41 AM (6 years ago)

Author:

boonebgorges

Message:

Privacy: Data exporter for Activity.

See #7818.

Location:

trunk

Files:

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

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

@@ -109 +109 @@
 
 add_filter( 'bp_activity_get_embed_excerpt', 'bp_activity_embed_excerpt_onclick_location_filter', 9 );
+
+// Personal data export.
+add_filter( 'wp_privacy_personal_data_exporters', 'bp_activity_register_personal_data_exporter' );
 
 /* Actions *******************************************************************/
@@ -803 +806 @@
 }
 add_filter( 'bp_activity_set_mentions_scope_args', 'bp_activity_filter_mentions_scope', 10, 2 );
+
+/**
+ * Registers Activity 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_activity_register_personal_data_exporter( $exporters ) {
+    $exporters['buddypress-activity'] = array(
+        'exporter_friendly_name' => __( 'BuddyPress Activity Data', 'buddypress' ),
+        'callback'               => 'bp_activity_personal_data_exporter',
+    );
+
+    return $exporters;
+}

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

@@ -4156 +4156 @@
 }
 add_action( 'transition_comment_status', 'bp_activity_transition_post_type_comment_status', 10, 3 );
+
+/**
+ * Finds and exports personal data associated with an email address from the Activity tables.
+ *
+ * @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_activity_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,
+        );
+    }
+
+    $activities = bp_activity_get( array(
+        'display_comments' => 'stream',
+        'per_page'         => $number,
+        'page'             => $page,
+        'show_hidden'      => true,
+        'filter'           => array(
+            'user_id' => $user->ID,
+        ),
+    ) );
+
+    $user_data_to_export = array();
+    $activity_actions    = bp_activity_get_actions();
+
+    foreach ( $activities['activities'] as $activity ) {
+        if ( ! empty( $activity_actions->{$activity->component}->{$activity->type}['format_callback'] ) ) {
+            $description = call_user_func( $activity_actions->{$activity->component}->{$activity->type}['format_callback'], '', $activity );
+        } elseif ( ! empty( $activity->action ) ) {
+            $description = $activity->action;
+        } else {
+            $description = $activity->type;
+        }
+
+        $item_data = array(
+            array(
+                'name'  => __( 'Activity Date', 'buddypress' ),
+                'value' => $activity->date_recorded,
+            ),
+            array(
+                'name'  => __( 'Activity Description', 'buddypress' ),
+                'value' => $description,
+            ),
+            array(
+                'name'  => __( 'Activity URL', 'buddypress' ),
+                'value' => bp_activity_get_permalink( $activity->id, $activity ),
+            ),
+        );
+
+        if ( ! empty( $activity->content ) ) {
+            $item_data[] = array(
+                'name'  => __( 'Activity Content', 'buddypress' ),
+                'value' => $activity->content,
+            );
+        }
+
+        /**
+         * Filters the data associated with an activity item when assembled for a WP personal data export.
+         *
+         * Plugins that register activity types whose `action` string doesn't adequately
+         * describe the activity item for the purposes of data export may filter the activity
+         * item data here.
+         *
+         * @since 4.0.0
+         *
+         * @param array                $item_data Array of data describing the activity item.
+         * @param BP_Activity_Activity $activity  Activity item.
+         */
+        $item_data = apply_filters( 'bp_activity_personal_data_export_item_data', $item_data, $activity );
+
+        $data_to_export[] = array(
+            'group_id'    => 'bp_activity',
+            'group_label' => __( 'Activity' ),
+            'item_id'     => "bp-activity-{$activity->id}",
+            'data'        => $item_data,
+        );
+    }
+
+    // Tell core if we have more items to process.
+    $done = count( $activities['activities'] ) < $number;
+
+    return array(
+        'data' => $data_to_export,
+        'done' => $done,
+    );
+}

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

@@ -1608 +1608 @@
         }
     }
+
+    /**
+     * @ticket BP7818
+     * @ticket BP7698
+     */
+    public function test_bp_activity_personal_data_exporter() {
+        $u = self::factory()->user->create();
+
+        $a1 = self::factory()->activity->create(
+            array(
+                'user_id'   => $u,
+                'component' => 'activity',
+                'type'      => 'activity_update',
+            )
+        );
+
+        $a2 = self::factory()->activity->create(
+            array(
+                'user_id'           => $u,
+                'component'         => 'activity',
+                'type'              => 'activity_comment',
+                'item_id'           => $a1,
+                'secondary_item_id' => $a1,
+            )
+        );
+
+        $g = self::factory()->group->create(
+            array(
+                'name' => 'My Cool Group',
+            )
+        );
+
+        $a3 = self::factory()->activity->create(
+            array(
+                'user_id'   => $u,
+                'component' => 'groups',
+                'type'      => 'activity_update',
+                'item_id'   => $g,
+            )
+        );
+
+        $test_user = new WP_User( $u );
+
+        $actual = bp_activity_personal_data_exporter( $test_user->user_email, 1 );
+
+        $this->assertTrue( $actual['done'] );
+
+        // Number of exported activity items.
+        $this->assertSame( 3, count( $actual['data'] ) );
+    }
 }