Changeset 12272 for trunk/src/bp-settings/bp-settings-functions.php

Timestamp:

11/02/2018 02:17:03 PM (14 months 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.

File:

• trunk/src/bp-settings/bp-settings-functions.php (modified) (1 diff)

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
+}