Changeset 43110

Timestamp:

05/02/2018 03:43:37 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Privacy: improve wp_privacy_erase_personal_data(), return boolean values.

Props ericdaams.
Merges [43061] to the 4.9 branch.
See #43602.

Location:

branches/4.9

Files:

• . (modified) (1 prop)
• src/wp-admin/includes/ajax-actions.php (modified) (4 diffs)
• src/wp-admin/js/xfn.js (modified) (4 diffs)
• src/wp-includes/comment.php (modified) (4 diffs)
• tests/phpunit/tests/comment.php (modified) (5 diffs)

branches/4.9/src/wp-admin/includes/ajax-actions.php

@@ -4256 +4256 @@
      *
      *         @type string $callback               Callable eraser that accepts an email address and
-     *                                              a page and returns an array with the number of items
-     *                                              removed, the number of items retained and any messages
+     *                                              a page and returns an array with boolean values for
+     *                                              whether items were removed or retained and any messages
      *                                              from the eraser, as well as if additional pages are
      *                                              available.
@@ -4324 +4324 @@
         }
 
-        if ( ! array_key_exists( 'num_items_removed', $response ) ) {
+        if ( ! array_key_exists( 'items_removed', $response ) ) {
             wp_send_json_error(
                 sprintf(
                     /* translators: 1: eraser friendly name, 2: array index */
-                    __( 'Expected num_items_removed key in response array from %1$s eraser (index %2$d).' ),
+                    __( 'Expected items_removed key in response array from %1$s eraser (index %2$d).' ),
                     esc_html( $eraser_friendly_name ),
                     $eraser_index
@@ -4335 +4335 @@
         }
 
-        if ( ! array_key_exists( 'num_items_retained', $response ) ) {
+        if ( ! array_key_exists( 'items_retained', $response ) ) {
             wp_send_json_error(
                 sprintf(
                     /* translators: 1: eraser friendly name, 2: array index */
-                    __( 'Expected num_items_retained key in response array from %1$s eraser (index %2$d).' ),
+                    __( 'Expected items_retained key in response array from %1$s eraser (index %2$d).' ),
                     esc_html( $eraser_friendly_name ),
                     $eraser_index
@@ -4381 +4381 @@
         // No erasers, so we're done.
         $response = array(
-            'num_items_removed'  => 0,
-            'num_items_retained' => 0,
-            'messages'           => array(),
-            'done'               => true,
+            'items_removed'  => false,
+            'items_retained' => false,
+            'messages'       => array(),
+            'done'           => true,
         );
     }

branches/4.9/src/wp-admin/js/xfn.js

@@ -137 +137 @@
         var erasersCount  = $action.data( 'erasers-count' );
 
-        var removedCount  = 0;
-        var retainedCount = 0;
+        var hasRemoved    = false;
+        var hasRetained   = false;
         var messages      = [];
 
@@ -148 +148 @@
             var summaryMessage = strings.noDataFound;
             var classes = 'notice-success';
-            if ( 0 === removedCount ) {
-                if ( 0 === retainedCount ) {
+            if ( false === hasRemoved ) {
+                if ( false === hasRetained ) {
                     summaryMessage = strings.noDataFound;
                 } else {
@@ -156 +156 @@
                 }
             } else {
-                if ( 0 === retainedCount ) {
+                if ( false === hasRetained ) {
                     summaryMessage = strings.foundAndRemoved;
                 } else {
@@ -188 +188 @@
                 }
                 var responseData = response.data;
-                if ( responseData.num_items_removed ) {
-                    removedCount += responseData.num_items_removed;
-                }
-                if ( responseData.num_items_retained ) {
-                    retainedCount += responseData.num_items_removed;
+                if ( responseData.items_removed ) {
+                    hasRemoved = hasRemoved || responseData.items_removed;
+                }
+                if ( responseData.items_retained ) {
+                    hasRetained = hasRetained || responseData.items_retained;
                 }
                 if ( responseData.messages ) {

branches/4.9/src/wp-includes/comment.php

@@ -3283 +3283 @@
     if ( empty( $email_address ) ) {
         return array(
-            'num_items_removed'  => 0,
-            'num_items_retained' => 0,
-            'messages'           => array(),
-            'done'               => true,
+            'items_removed'  => false,
+            'items_retained' => false,
+            'messages'       => array(),
+            'done'           => true,
         );
     }
 
     // Limit us to 500 comments at a time to avoid timing out.
-    $number            = 500;
-    $page              = (int) $page;
-    $num_items_removed = 0;
+    $number         = 500;
+    $page           = (int) $page;
+    $items_removed  = false;
+    $items_retained = false;
 
     $comments = get_comments(
@@ -3340 +3341 @@
             }
 
+            $items_retained = true;
+
             continue;
         }
@@ -3350 +3353 @@
 
         if ( $updated ) {
-            $num_items_removed++;
+            $items_removed = true;
             clean_comment_cache( $comment_id );
+        } else {
+            $items_retained = true;
         }
     }
@@ -3358 +3363 @@
 
     return array(
-        'num_items_removed'  => $num_items_removed,
-        'num_items_retained' => count( $comments ) - $num_items_removed,
-        'messages'           => $messages,
-        'done'               => $done,
+        'items_removed'  => $items_removed,
+        'items_retained' => $items_retained,
+        'messages'       => $messages,
+        'done'           => $done,
     );
 }
+

branches/4.9/tests/phpunit/tests/comment.php

@@ -766 +766 @@
         $actual   = wp_comments_personal_data_eraser( 'nocommentsfound@local.host' );
         $expected = array(
-            'num_items_removed'  => 0,
-            'num_items_retained' => 0,
-            'messages'           => array(),
-            'done'               => true,
+            'items_removed'  => false,
+            'items_retained' => false,
+            'messages'       => array(),
+            'done'           => true,
         );
 
@@ -797 +797 @@
         $actual   = wp_comments_personal_data_eraser( $args['comment_author_email'] );
         $expected = array(
-            'num_items_removed'  => 1,
-            'num_items_retained' => 0,
-            'messages'           => array(),
-            'done'               => true,
+            'items_removed'  => true,
+            'items_retained' => false,
+            'messages'       => array(),
+            'done'           => true,
         );
 
@@ -828 +828 @@
         $actual   = wp_comments_personal_data_eraser( $args['comment_author_email'], 2 );
         $expected = array(
-            'num_items_removed'  => 0,
-            'num_items_retained' => 0,
-            'messages'           => array(),
-            'done'               => true,
+            'items_removed'  => false,
+            'items_retained' => false,
+            'messages'       => array(),
+            'done'           => true,
         );
 
@@ -864 +864 @@
 
         $expected = array(
-            'num_items_removed'  => 0,
-            'num_items_retained' => 1,
-            'messages'           => array( $message ),
-            'done'               => true,
+            'items_removed'  => false,
+            'items_retained' => true,
+            'messages'       => array( $message ),
+            'done'           => true,
         );
 
@@ -900 +900 @@
 
         $expected = array(
-            'num_items_removed'  => 0,
-            'num_items_retained' => 1,
-            'messages'           => array( $message ),
-            'done'               => true,
+            'items_removed'  => false,
+            'items_retained' => true,
+            'messages'       => array( $message ),
+            'done'           => true,
         );