Changeset 12110

Timestamp:

05/23/2018 01:40:06 AM (8 years ago)

Author:

boonebgorges

Message:

Privacy: Data exporter for XProfile.

See #7817.

Location:

trunk

Files:

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

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

@@ -77 +77 @@
 add_filter( 'xprofile_field_options_before_save', 'bp_xprofile_sanitize_field_options' );
 add_filter( 'xprofile_field_default_before_save', 'bp_xprofile_sanitize_field_default' );
+
+// Privacy data export.
+add_filter( 'wp_privacy_personal_data_exporters', 'bp_register_xprofile_personal_data_exporter' );
 
 /**
@@ -624 +627 @@
         return $q;
 }
+
+/**
+ * Register XProfile 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_xprofile_personal_data_exporter( $exporters ) {
+        $exporters['buddypress-xprofile'] = array(
+                'exporter_friendly_name' => __( 'BuddyPress XProfile Data', 'buddypress' ),
+                'callback'               => 'bp_xprofile_personal_data_exporter',
+        );
+
+        return $exporters;
+}

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

@@ -1337 +1337 @@
         }
 }
+
+/**
+ * Finds and exports personal data associated with an email address from the XProfile tables.
+ *
+ * @since 4.0.0
+ *
+ * @param string $email_address  The userss email address.
+ * @return array An array of personal data.
+ */
+function bp_xprofile_personal_data_exporter( $email_address ) {
+        $email_address = trim( $email_address );
+
+        $data_to_export = array();
+
+        $user = get_user_by( 'email', $email_address );
+
+        if ( ! $user ) {
+                return array(
+                        'data' => array(),
+                        'done' => true,
+                );
+        }
+
+        $user_data_to_export = array();
+
+        $user_profile_data = BP_XProfile_ProfileData::get_all_for_user( $user->ID );
+        foreach ( $user_profile_data as $field_name => $field ) {
+                // Skip non-array fields, which don't belong to XProfile.
+                if ( ! is_array( $field ) ) {
+                        continue;
+                }
+
+                // Re-pull the data so that BuddyPress formats and sanitizes properly.
+                $value = xprofile_get_field_data( $field['field_id'], $user->ID, 'comma' );
+                $user_data_to_export[] = array(
+                        'name'  => $field_name,
+                        'value' => $value,
+                );
+        }
+
+        $data_to_export[] = array(
+                'group_id'    => 'bp_xprofile',
+                'group_label' => __( 'Extended Profile Data', 'buddypress' ),
+                'item_id'     => "bp-xprofile-{$user->ID}",
+                'data'        => $user_data_to_export,
+        );
+
+        return array(
+                'data' => $data_to_export,
+                'done' => true,
+        );
+}

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

@@ -1075 +1075 @@
                 unset( $GLOBALS['field'] );
         }
+
+        /**
+         * @ticket BP7817
+         * @ticket BP7698
+         */
+        public function test_bp_xprofile_personal_data_exporter() {
+                $u = self::factory()->user->create();
+
+                $field_group_id = self::factory()->xprofile_group->create();
+                $f1 = self::factory()->xprofile_field->create(
+                        array(
+                                'field_group_id' => $field_group_id,
+                        )
+                );
+                $f2 = self::factory()->xprofile_field->create(
+                        array(
+                                'field_group_id' => $field_group_id,
+                                'type'           => 'checkbox',
+                        )
+                );
+
+                $option1 = xprofile_insert_field( array(
+                        'field_group_id' => $field_group_id,
+                        'parent_id'      => $f2,
+                        'type'           => 'option',
+                        'name'           => 'Option 1',
+                ) );
+
+                $option2 = xprofile_insert_field( array(
+                        'field_group_id' => $field_group_id,
+                        'parent_id'      => $f2,
+                        'type'           => 'option',
+                        'name'           => 'Option 2',
+                ) );
+
+                $option3 = xprofile_insert_field( array(
+                        'field_group_id' => $field_group_id,
+                        'parent_id'      => $f2,
+                        'type'           => 'option',
+                        'name'           => 'Option 3',
+                ) );
+
+                xprofile_set_field_data( $f1, $u, 'foo' );
+                xprofile_set_field_data( $f2, $u, array( 'Option 1', 'Option 3' ) );
+
+                $test_user = new WP_User( $u );
+
+                $actual = bp_xprofile_personal_data_exporter( $test_user->user_email );
+
+                $this->assertTrue( $actual['done'] );
+
+                // Number of exported users.
+                $this->assertSame( 1, count( $actual['data'] ) );
+
+                // Number of exported user properties.
+                $this->assertSame( 3, count( $actual['data'][0]['data'] ) );
+        }
 }