Changeset 43188 for branches/4.9

Timestamp:

05/09/2018 02:32:41 PM (7 years ago)

Author:

SergeyBiryukov

Message:

Privacy: Mark erasure requests as completed after processing.

r42986 introduced the beginnings of an Ajax handler for processing requests to erase personal data. At the time, a method for marking requests as completed was planned, but had not yet been created. This commit introduces that mechanism, bringing the erasure process closer to completion.

Props coreymckrill, allendav.
Merges [43185] to the 4.9 branch.
Fixes #43922.

Location:

branches/4.9

Files:

• . (modified) (1 prop)
• src/wp-admin/includes/admin-filters.php (modified) (1 diff)
• src/wp-admin/includes/user.php (modified) (1 diff)

branches/4.9/src/wp-admin/includes/admin-filters.php

@@ -134 +134 @@
 
 // Privacy hooks
+add_filter( 'wp_privacy_personal_data_erasure_page', 'wp_privacy_process_personal_data_erasure_page', 10, 5 );
 add_filter( 'wp_privacy_personal_data_export_page', 'wp_privacy_process_personal_data_export_page', 10, 7 );
 add_action( 'wp_privacy_personal_data_export_file', 'wp_privacy_generate_personal_data_export_file', 10 );

branches/4.9/src/wp-admin/includes/user.php

@@ -878 +878 @@
 
 /**
+ * Mark erasure requests as completed after processing is finished.
+ *
+ * This intercepts the Ajax responses to personal data eraser page requests, and
+ * monitors the status of a request. Once all of the processing has finished, the
+ * request is marked as completed.
+ *
+ * @since 4.9.6
+ *
+ * @see wp_privacy_personal_data_erasure_page
+ *
+ * @param array  $response      The response from the personal data eraser for
+ *                              the given page.
+ * @param int    $eraser_index  The index of the personal data eraser. Begins
+ *                              at 1.
+ * @param string $email_address The email address of the user whose personal
+ *                              data this is.
+ * @param int    $page          The page of personal data for this eraser.
+ *                              Begins at 1.
+ * @param int    $request_id    The request ID for this personal data erasure.
+ * @return array The filtered response.
+ */
+function wp_privacy_process_personal_data_erasure_page( $response, $eraser_index, $email_address, $page, $request_id ) {
+    /*
+     * If the eraser response is malformed, don't attempt to consume it; let it
+     * pass through, so that the default Ajax processing will generate a warning
+     * to the user.
+     */
+    if ( ! is_array( $response ) ) {
+        return $response;
+    }
+
+    if ( ! array_key_exists( 'done', $response ) ) {
+        return $response;
+    }
+
+    if ( ! array_key_exists( 'items_removed', $response ) ) {
+        return $response;
+    }
+
+    if ( ! array_key_exists( 'items_retained', $response ) ) {
+        return $response;
+    }
+
+    if ( ! array_key_exists( 'messages', $response ) ) {
+        return $response;
+    }
+
+    $request = wp_get_user_request_data( $request_id );
+
+    if ( ! $request || 'remove_personal_data' !== $request->action_name ) {
+        wp_send_json_error( __( 'Invalid request ID when processing eraser data.' ) );
+    }
+
+    /** This filter is documented in wp-admin/includes/ajax-actions.php */
+    $erasers        = apply_filters( 'wp_privacy_personal_data_erasers', array() );
+    $is_last_eraser = count( $erasers ) === $eraser_index;
+    $eraser_done    = $response['done'];
+
+    if ( ! $is_last_eraser || ! $eraser_done ) {
+        return $response;
+    }
+
+    _wp_privacy_completed_request( $request_id );
+
+    return $response;
+}
+
+/**
  * Add requests pages.
  *