<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[42994] trunk: Privacy: add functionality to anonymize commenters.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/42994">42994</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/42994","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>azaozz</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-04-20 12:18:35 +0000 (Fri, 20 Apr 2018)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Privacy: add functionality to anonymize commenters.
Props xkon, fclaussen, allendav, birgire, azaozz.
See <a href="https://core.trac.wordpress.org/ticket/43442">#43442</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminjsxfnjs">trunk/src/wp-admin/js/xfn.js</a></li>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.php</a></li>
<li><a href="#trunksrcwpincludesdefaultfiltersphp">trunk/src/wp-includes/default-filters.php</a></li>
<li><a href="#trunktestsphpunittestscommentphp">trunk/tests/phpunit/tests/comment.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminjsxfnjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/js/xfn.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/xfn.js 2018-04-19 14:01:48 UTC (rev 42993)
+++ trunk/src/wp-admin/js/xfn.js 2018-04-20 12:18:35 UTC (rev 42994)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -72,8 +72,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> set_action_state( $action, 'remove_personal_data_idle' );
</span><span class="cx" style="display: block; padding: 0 10px"> var summaryMessage = strings.noDataFound;
</span><span class="cx" style="display: block; padding: 0 10px"> var classes = 'notice-success';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 0 == removedCount ) {
- if ( 0 == retainedCount ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 0 === removedCount ) {
+ if ( 0 === retainedCount ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> summaryMessage = strings.noDataFound;
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> summaryMessage = strings.noneRemoved;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -80,7 +80,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> classes = 'notice-warning';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 0 == retainedCount ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 0 === retainedCount ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> summaryMessage = strings.foundAndRemoved;
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> summaryMessage = strings.someNotRemoved;
</span></span></pre></div>
<a id="trunksrcwpincludescommentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/comment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment.php 2018-04-19 14:01:48 UTC (rev 42993)
+++ trunk/src/wp-includes/comment.php 2018-04-20 12:18:35 UTC (rev 42994)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3378,3 +3378,116 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'done' => $done,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Registers the personal data eraser for comments.
+ *
+ * @since 4.9.6
+ *
+ * @param array $erasers An array of personal data erasers.
+ * @return array $erasers An array of personal data erasers.
+ */
+function wp_register_comment_personal_data_eraser( $erasers ) {
+ $erasers[] = array(
+ 'eraser_friendly_name' => __( 'WordPress Comments' ),
+ 'callback' => 'wp_comments_personal_data_eraser',
+ );
+
+ return $erasers;
+}
+
+/**
+ * Erases personal data associated with an email address from the comments table.
+ *
+ * @since 4.9.6
+ *
+ * @param string $email_address The comment author email address.
+ * @param int $page Comment page.
+ * @return array
+ */
+function wp_comments_personal_data_eraser( $email_address, $page = 1 ) {
+ global $wpdb;
+
+ if ( empty( $email_address ) ) {
+ return array(
+ 'num_items_removed' => 0,
+ 'num_items_retained' => 0,
+ '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;
+
+ $comments = get_comments(
+ array(
+ 'author_email' => $email_address,
+ 'number' => $number,
+ 'paged' => $page,
+ 'order_by' => 'comment_ID',
+ 'order' => 'ASC',
+ 'include_unapproved' => true,
+ )
+ );
+
+ $anon_author = __( 'Anonymous' );
+ $messages = array();
+
+ foreach ( (array) $comments as $comment ) {
+ $anonymized_comment = array();
+ $anonymized_comment['comment_agent'] = '';
+ $anonymized_comment['comment_author'] = $anon_author;
+ $anonymized_comment['comment_author_email'] = wp_privacy_anonymize_data( 'email', $comment->comment_author_email );
+ $anonymized_comment['comment_author_IP'] = wp_privacy_anonymize_data( 'ip', $comment->comment_author_IP );
+ $anonymized_comment['comment_author_url'] = wp_privacy_anonymize_data( 'url', $comment->comment_author_url );
+ $anonymized_comment['user_id'] = 0;
+
+ $comment_id = (int) $comment->comment_ID;
+
+ /**
+ * Filters whether to anonymize the comment.
+ *
+ * @since 4.9.6
+ *
+ * @param bool|string Whether to apply the comment anonymization (bool).
+ * Custom prevention message (string). Default true.
+ * @param WP_Comment $comment WP_Comment object.
+ * @param array $anonymized_comment Anonymized comment data.
+ */
+ $anon_message = apply_filters( 'wp_anonymize_comment', true, $comment, $anonymized_comment );
+
+ if ( true !== $anon_message ) {
+ if ( $anon_message && is_string( $anon_message ) ) {
+ $messages[] = esc_html( $anon_message );
+ } else {
+ /* translators: %d: Comment ID */
+ $messages[] = sprintf( __( 'Comment %d contains personal data but could not be anonymized.' ), $comment_id );
+ }
+
+ continue;
+ }
+
+ $args = array(
+ 'comment_ID' => $comment_id,
+ );
+
+ $updated = $wpdb->update( $wpdb->comments, $anonymized_comment, $args );
+
+ if ( $updated ) {
+ $num_items_removed++;
+ clean_comment_cache( $comment_id );
+ }
+ }
+
+ $done = count( $comments ) < $number;
+
+ return array(
+ 'num_items_removed' => $num_items_removed,
+ 'num_items_retained' => count( $comments ) - $num_items_removed,
+ 'messages' => $messages,
+ 'done' => $done,
+ );
+}
</ins></span></pre></div>
<a id="trunksrcwpincludesdefaultfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/default-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/default-filters.php 2018-04-19 14:01:48 UTC (rev 42993)
+++ trunk/src/wp-includes/default-filters.php 2018-04-20 12:18:35 UTC (rev 42994)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -329,6 +329,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'do_robots', 'do_robots' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'set_comment_cookies', 'wp_set_comment_cookies', 10, 3 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'wp_privacy_personal_data_exporters', 'wp_register_comment_personal_data_exporter', 10 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_filter( 'wp_privacy_personal_data_erasers', 'wp_register_comment_personal_data_eraser', 10 );
</ins><span class="cx" style="display: block; padding: 0 10px"> add_action( 'sanitize_comment_cookies', 'sanitize_comment_cookies' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'admin_print_scripts', 'print_emoji_detection_script' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'admin_print_scripts', 'print_head_scripts', 20 );
</span></span></pre></div>
<a id="trunktestsphpunittestscommentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/comment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/comment.php 2018-04-19 14:01:48 UTC (rev 42993)
+++ trunk/tests/phpunit/tests/comment.php 2018-04-20 12:18:35 UTC (rev 42994)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -812,6 +812,227 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * The `wp_comments_personal_data_eraser()` function should erase user's comments.
+ *
+ * @ticket 43442
+ */
+ public function test_wp_comments_personal_data_eraser() {
+
+ $post_id = self::factory()->post->create();
+ $user_id = self::factory()->user->create();
+
+ $args = array(
+ 'user_id' => $user_id,
+ 'comment_post_ID' => $post_id,
+ 'comment_author' => 'Comment Author',
+ 'comment_author_email' => 'personal@local.host',
+ 'comment_author_url' => 'https://local.host/',
+ 'comment_author_IP' => '192.168.0.1',
+ 'comment_date' => '2018-04-14 17:20:00',
+ 'comment_agent' => 'COMMENT_AGENT',
+ 'comment_content' => 'Comment Content',
+ );
+ $comment_id = self::factory()->comment->create( $args );
+
+ wp_comments_personal_data_eraser( $args['comment_author_email'] );
+
+ $comment = get_comment( $comment_id );
+
+ $actual = array(
+ 'comment_ID' => $comment->comment_ID,
+ 'user_id' => $comment->user_id,
+ 'comment_author' => $comment->comment_author,
+ 'comment_author_email' => $comment->comment_author_email,
+ 'comment_author_url' => $comment->comment_author_url,
+ 'comment_author_IP' => $comment->comment_author_IP,
+ 'comment_date' => $comment->comment_date,
+ 'comment_date_gmt' => $comment->comment_date_gmt,
+ 'comment_agent' => $comment->comment_agent,
+ 'comment_content' => $comment->comment_content,
+ );
+
+ $expected = array(
+ 'comment_ID' => (string) $comment_id,
+ 'user_id' => '0', // Anonymized.
+ 'comment_author' => 'Anonymous', // Anonymized.
+ 'comment_author_email' => 'deleted@site.invalid', // Anonymized.
+ 'comment_author_url' => 'https://site.invalid', // Anonymized.
+ 'comment_author_IP' => '192.168.0.0', // Anonymized.
+ 'comment_date' => '2018-04-14 17:20:00',
+ 'comment_date_gmt' => '2018-04-14 17:20:00',
+ 'comment_agent' => '', // Anonymized.
+ 'comment_content' => 'Comment Content',
+ );
+
+ $this->assertSame( $expected, $actual );
+ }
+
+ /**
+ * Testing the `wp_comments_personal_data_eraser()` function's output on an empty first page.
+ *
+ * @ticket 43442
+ */
+ public function test_wp_comments_personal_data_eraser_empty_first_page_output() {
+
+ $actual = wp_comments_personal_data_eraser( 'nocommentsfound@local.host' );
+ $expected = array(
+ 'num_items_removed' => 0,
+ 'num_items_retained' => 0,
+ 'messages' => array(),
+ 'done' => true,
+ );
+
+ $this->assertSame( $expected, $actual );
+ }
+
+ /**
+ * Testing the `wp_comments_personal_data_eraser()` function's output, for the non-empty first page.
+ *
+ * @ticket 43442
+ */
+ public function test_wp_comments_personal_data_eraser_non_empty_first_page_output() {
+
+ $post_id = self::factory()->post->create();
+ $args = array(
+ 'comment_post_ID' => $post_id,
+ 'comment_author' => 'Comment Author',
+ 'comment_author_email' => 'personal@local.host',
+ 'comment_author_url' => 'https://local.host/',
+ 'comment_author_IP' => '192.168.0.1',
+ 'comment_date' => '2018-04-14 17:20:00',
+ 'comment_agent' => 'COMMENT_AGENT',
+ 'comment_content' => 'Comment Content',
+ );
+ self::factory()->comment->create( $args );
+
+ $actual = wp_comments_personal_data_eraser( $args['comment_author_email'] );
+ $expected = array(
+ 'num_items_removed' => 1,
+ 'num_items_retained' => 0,
+ 'messages' => array(),
+ 'done' => true,
+ );
+
+ $this->assertSame( $expected, $actual );
+ }
+
+ /**
+ * Testing the `wp_comments_personal_data_eraser()` function's output, for an empty second page.
+ *
+ * @ticket 43442
+ */
+ public function test_wp_comments_personal_data_eraser_empty_second_page_output() {
+
+ $post_id = self::factory()->post->create();
+ $args = array(
+ 'comment_post_ID' => $post_id,
+ 'comment_author' => 'Comment Author',
+ 'comment_author_email' => 'personal@local.host',
+ 'comment_author_url' => 'https://local.host/',
+ 'comment_author_IP' => '192.168.0.1',
+ 'comment_date' => '2018-04-14 17:20:00',
+ 'comment_agent' => 'COMMENT_AGENT',
+ 'comment_content' => 'Comment Content',
+ );
+ self::factory()->comment->create( $args );
+
+ $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,
+ );
+
+ $this->assertSame( $expected, $actual );
+ }
+
+ /**
+ * Testing the `wp_anonymize_comment` filter, to prevent comment anonymization.
+ *
+ * @ticket 43442
+ */
+ public function test_wp_anonymize_comment_filter_to_prevent_comment_anonymization() {
+
+ $post_id = self::factory()->post->create();
+ $args = array(
+ 'comment_post_ID' => $post_id,
+ 'comment_author' => 'Comment Author',
+ 'comment_author_email' => 'personal@local.host',
+ 'comment_author_url' => 'https://local.host/',
+ 'comment_author_IP' => '192.168.0.1',
+ 'comment_date' => '2018-04-14 17:20:00',
+ 'comment_agent' => 'COMMENT_AGENT',
+ 'comment_content' => 'Comment Content',
+ );
+ $comment_id = self::factory()->comment->create( $args );
+
+ add_filter( 'wp_anonymize_comment', '__return_false' );
+ $actual = wp_comments_personal_data_eraser( $args['comment_author_email'] );
+ remove_filter( 'wp_anonymize_comment', '__return_false' );
+
+ $message = sprintf( 'Comment %d contains personal data but could not be anonymized.', $comment_id );
+
+ $expected = array(
+ 'num_items_removed' => 0,
+ 'num_items_retained' => 1,
+ 'messages' => array( $message ),
+ 'done' => true,
+ );
+
+ $this->assertSame( $expected, $actual );
+ }
+
+ /**
+ * Testing the `wp_anonymize_comment` filter, to prevent comment anonymization, with a custom message.
+ *
+ * @ticket 43442
+ */
+ public function test_wp_anonymize_comment_filter_to_prevent_comment_anonymization_with_custom_message() {
+
+ $post_id = self::factory()->post->create();
+ $args = array(
+ 'comment_post_ID' => $post_id,
+ 'comment_author' => 'Comment Author',
+ 'comment_author_email' => 'personal@local.host',
+ 'comment_author_url' => 'https://local.host/',
+ 'comment_author_IP' => '192.168.0.1',
+ 'comment_date' => '2018-04-14 17:20:00',
+ 'comment_agent' => 'COMMENT_AGENT',
+ 'comment_content' => 'Comment Content',
+ );
+ $comment_id = self::factory()->comment->create( $args );
+
+ add_filter( 'wp_anonymize_comment', array( $this, 'wp_anonymize_comment_custom_message' ), 10, 3 );
+ $actual = wp_comments_personal_data_eraser( $args['comment_author_email'] );
+ remove_filter( 'wp_anonymize_comment', array( $this, 'wp_anonymize_comment_custom_message' ) );
+
+ $message = sprintf( 'Some custom message for comment %d.', $comment_id );
+
+ $expected = array(
+ 'num_items_removed' => 0,
+ 'num_items_retained' => 1,
+ 'messages' => array( $message ),
+ 'done' => true,
+ );
+
+ $this->assertSame( $expected, $actual );
+ }
+
+ /**
+ * Callback for the `wp_anonymize_comment` filter.
+ *
+ * @param bool|string $anonymize Whether to apply the comment anonymization (bool).
+ * Custom prevention message (string). Default true.
+ * @param WP_Comment $comment WP_Comment object.
+ * @param array $anonymized_comment Anonymized comment data.
+ * @return string
+ */
+ public function wp_anonymize_comment_custom_message( $anonymize, $comment, $anonymized_comment ) {
+ return sprintf( 'Some custom message for comment %d.', $comment->comment_ID );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_update_should_invalidate_comment_cache() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>