Changeset 12272

Timestamp:

11/02/2018 02:17:03 PM (6 years ago)

Author:

boonebgorges

Message:

Privacy: Introduce 'Export Data' settings panel.

This new panel allows users to request a data export. It also has
information on deleting one's personal data, which in BuddyPress means
deleting one's account.

Props r-a-y.
Fixes #7826.

Location:

trunk/src

Files:

• bp-settings/actions/data.php (added)
• bp-settings/bp-settings-functions.php (modified) (1 diff)
• bp-settings/classes/class-bp-settings-component.php (modified) (3 diffs)
• bp-settings/screens/data.php (added)
• bp-templates/bp-legacy/buddypress/members/single/settings.php (modified) (1 diff)
• bp-templates/bp-legacy/buddypress/members/single/settings/data.php (added)
• bp-templates/bp-nouveau/buddypress/members/single/settings.php (modified) (2 diffs)
• bp-templates/bp-nouveau/buddypress/members/single/settings/data.php (added)
• bp-templates/bp-nouveau/buddypress/members/single/settings/delete-account.php (modified) (2 diffs)

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

@@ -216 +216 @@
     );
 }
+
+/**
+ * Fetches a user's personal data request.
+ *
+ * @since 4.0.0
+ *
+ * @param int WP user ID.
+ * @return WP_User_Request|false WP_User_Request object on success, boolean false on failure.
+ */
+function bp_settings_get_personal_data_request( $user_id = 0 ) {
+    if ( empty( $user_id ) ) {
+        $user_id = bp_displayed_user_id();
+    }
+
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+
+    $user = get_userdata( $user_id );
+    if ( empty( $user ) ) {
+        return false;
+    }
+
+    $query = new WP_Query( array(
+        'author'        => (int) $user_id,
+        'post_type'     => 'user_request',
+        'post_status'   => 'any',
+        'post_name__in' => array(
+            'export_personal_data',
+        ),
+    ) );
+
+    if ( ! empty( $query->post ) ) {
+        return wp_get_user_request_data( $query->post->ID );
+    } else {
+        return false;
+    }
+}
+
+/**
+ * Fetches the expiration date for when a user request expires.
+ *
+ * @since 4.0.0
+ *
+ * @param WP_User_Request $request User request object.
+ * @return string Formatted date.
+ */
+function bp_settings_get_personal_data_expiration_date( WP_User_Request $request ) {
+    /** This filter is documented in wp-admin/includes/file.php */
+    $expiration = apply_filters( 'wp_privacy_export_expiration', 3 * DAY_IN_SECONDS );
+
+    return bp_format_time( $request->completed_timestamp + $expiration, true );
+}
+
+/**
+ * Fetches the confirmation date for a user request object.
+ *
+ * @since 4.0.0
+ *
+ * @param WP_User_Request $request User request object.
+ * @return string Formatted date for the confirmation date.
+ */
+function bp_settings_get_personal_data_confirmation_date( WP_User_Request $request ) {
+    return bp_format_time( $request->confirmed_timestamp, true );
+}
+
+/**
+ * Fetches the URL for a personal data export file.
+ *
+ * @since 4.0.0
+ *
+ * @param WP_User_Request $request User request object.
+ * @return string Export file URL.
+ */
+function bp_settings_get_personal_data_export_url( WP_User_Request $request ) {
+    return get_post_meta( $request->ID, '_export_file_url', true );
+}
+
+/**
+ * Check if the generated data export file still exists or not.
+ *
+ * @since 4.0.0
+ *
+ * @param  WP_User_Request $request User request object.
+ * @return bool
+ */
+function bp_settings_personal_data_export_exists( WP_User_Request $request ) {
+    $file = get_post_meta( $request->ID, '_export_file_path', true );
+    if ( file_exists( $file ) ) {
+        return true;
+    } else {
+        return false;
+    }
+}
+
+/**
+ * Template tag to output a list of data exporter items.
+ *
+ * Piggybacks off of the 'wp_privacy_personal_data_exporters' filter and the
+ * 'exporter_friendly_name' key, which is meant for the admin area.
+ *
+ * @todo We should look for a custom key like 'exporter_frontend_name' if available.
+ *
+ * @since 4.0.0
+ */
+function bp_settings_data_exporter_items() {
+    /** This filter is documented in /wp-admin/includes/ajax-actions.php */
+    $exporters = apply_filters( 'wp_privacy_personal_data_exporters', array() );
+
+?>
+    <ul>
+    <?php foreach ( $exporters as $exporter => $data ) :
+        /**
+         * Filters the data exporter name for display on the "Settings > Data" page.
+         *
+         * @since 4.0.0
+         *
+         * @param string $name     Data exporter friendly name.
+         * @param string $exporter Internal exporter name.
+         */
+        $item = apply_filters( 'bp_settings_data_exporter_name', esc_html( $data['exporter_friendly_name'] ), $exporter );
+    ?>
+
+        <li><?php echo $item; ?></li>
+
+    <?php endforeach; ?>
+    </ul>
+
+<?php
+}

trunk/src/bp-settings/classes/class-bp-settings-component.php

@@ -67 +67 @@
         }
 
-        $actions = array( 'notifications', 'capabilities', 'delete-account' );
+        $actions = array( 'notifications', 'capabilities', 'data', 'delete-account' );
 
         // Authenticated actions.
@@ -184 +184 @@
         }
 
+        /**
+         * Filter whether the site should show the "Settings > Data" page.
+         *
+         * @since 4.0.0
+         *
+         * @param bool $show Defaults to true.
+         */
+        $show_data_page = apply_filters( 'bp_settings_show_user_data_page', true );
+
+        // Export Data - only available for WP 4.9.6+.
+        if ( true === $show_data_page && version_compare( $GLOBALS['wp_version'], '4.9.6', '>=' ) ) {
+            $sub_nav[] = array(
+                'name'            => __( 'Export Data', 'buddypress' ),
+                'slug'            => 'data',
+                'parent_url'      => $settings_link,
+                'parent_slug'     => $slug,
+                'screen_function' => 'bp_settings_screen_data',
+                'position'        => 89,
+                'user_has_access' => $access,
+            );
+        }
+
         // Add Delete Account nav item.
         if ( ( ! bp_disable_account_deletion() && bp_is_my_profile() ) || bp_current_user_can( 'delete_users' ) ) {
@@ -243 +265 @@
             }
 
+            /** This filter is documented in bp-settings/classes/class-bp-settings-component.php */
+            $show_data_page = apply_filters( 'bp_settings_show_user_data_page', true );
+
+            // Export Data.
+            if ( true === $show_data_page && version_compare( $GLOBALS['wp_version'], '4.9.6', '>=' ) ) {
+                $wp_admin_nav[] = array(
+                    'parent'   => 'my-account-' . $this->id,
+                    'id'       => 'my-account-' . $this->id . '-data',
+                    'title'    => __( 'Export Data', 'buddypress' ),
+                    'href'     => trailingslashit( $settings_link . 'data' ),
+                    'position' => 89,
+                );
+            }
+
             // Delete Account
             if ( !bp_current_user_can( 'bp_moderate' ) && ! bp_core_get_root_option( 'bp-disable-account-deletion' ) ) {

trunk/src/bp-templates/bp-legacy/buddypress/members/single/settings.php

@@ -38 +38 @@
         bp_get_template_part( 'members/single/settings/profile'        );
         break;
+    case 'data'           :
+        bp_get_template_part( 'members/single/settings/data'           );
+        break;
     default:
         bp_get_template_part( 'members/single/plugins'                 );

trunk/src/bp-templates/bp-nouveau/buddypress/members/single/settings.php

@@ -3 +3 @@
  * BuddyPress - Users Settings
  *
- * @version 3.0.0
+ * @version 4.0.0
  */
 
@@ -40 +40 @@
         bp_get_template_part( 'members/single/settings/group-invites' );
         break;
+    case 'data':
+        bp_get_template_part( 'members/single/settings/data' );
+        break;
     default:
         bp_get_template_part( 'members/single/plugins' );

trunk/src/bp-templates/bp-nouveau/buddypress/members/single/settings/delete-account.php

@@ -4 +4 @@
  *
  * @since 3.0.0
- * @version 3.1.0
+ * @version 4.0.0
  */
 
@@ -17 +17 @@
 <form action="<?php echo esc_url( bp_displayed_user_domain() . bp_get_settings_slug() . '/delete-account' ); ?>" name="account-delete-form" id="#account-delete-form" class="standard-form" method="post">
 
-    <label class="warn" for="delete-account-understand">
-        <input id="delete-account-understand" class="disabled" type="checkbox" name="delete-account-understand" value="1" data-bp-disable-input="#delete-account-button" />
+    <label id="delete-account-understand" class="warn" for="delete-account-understand">
+        <input class="disabled" type="checkbox" name="delete-account-understand" value="1" data-bp-disable-input="#delete-account-button" />
         <?php esc_html_e( 'I understand the consequences.', 'buddypress' ); ?>
     </label>