<!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>[42987] trunk: Privacy: fix docs, formatting, white space, add tests for the personal data from comments exporter.</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/42987">42987</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/42987","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-18 22:54:23 +0000 (Wed, 18 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: fix docs, formatting, white space, add tests for the personal data from comments exporter.
Props birgire.
See <a href="https://core.trac.wordpress.org/ticket/43440">#43440</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.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="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-18 22:29:59 UTC (rev 42986)
+++ trunk/src/wp-includes/comment.php 2018-04-18 22:54:23 UTC (rev 42987)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3276,10 +3276,12 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Registers the personal data exporter for comments
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Registers the personal data exporter for comments.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $exporters An array of personal data exporters.
- * @return array An array of personal data exporters.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.9.6
+ *
+ * @param array $exporters An array of personal data exporters.
+ * @return array $exporters An array of personal data exporters.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_register_comment_personal_data_exporter( $exporters ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $exporters[] = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3293,19 +3295,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Finds and exports personal data associated with an email address from the comments table.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $email_address The comment author email address.
- * @param int $page Comment page.
- * @return array An array of personal data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.9.6
+ *
+ * @param string $email_address The comment author email address.
+ * @param int $page Comment page.
+ * @return array $return An array of personal data.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_comments_personal_data_exporter( $email_address, $page = 1 ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Technically, strtolower isn't necessary since get_comments will match email insensitive
- // But it is a good example for plugin developers whose targets might not be as generous
- $email_address = trim( strtolower( $email_address ) );
-
- // Limit us to 500 comments at a time to avoid timing out
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Limit us to 500 comments at a time to avoid timing out.
</ins><span class="cx" style="display: block; padding: 0 10px"> $number = 500;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $page = (int) $page;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $page = (int) $page;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $data_to_export = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3336,7 +3336,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $comment_prop_to_export as $key => $name ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $value = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- switch( $key ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ switch ( $key ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> case 'comment_author':
</span><span class="cx" style="display: block; padding: 0 10px"> case 'comment_author_email':
</span><span class="cx" style="display: block; padding: 0 10px"> case 'comment_author_url':
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3356,7 +3356,10 @@
</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"> if ( ! empty( $value ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $comment_data_to_export[] = array( 'name' => $name, 'value' => $value );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $comment_data_to_export[] = array(
+ 'name' => $name,
+ 'value' => $value,
+ );
</ins><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></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-18 22:29:59 UTC (rev 42986)
+++ trunk/tests/phpunit/tests/comment.php 2018-04-18 22:54:23 UTC (rev 42987)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -891,4 +891,123 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( '1', $comment->comment_approved );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Testing the `wp_comments_personal_data_exporter()` function.
+ *
+ * @ticket 43440
+ */
+ public function test_wp_comments_personal_data_exporter() {
+ $args = array(
+ 'comment_post_ID' => self::$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_agent' => 'SOME_AGENT',
+ 'comment_date' => '2018-03-28 20:05:00',
+ 'comment_content' => 'Comment',
+ );
+
+ $c = self::factory()->comment->create( $args );
+
+ $actual = wp_comments_personal_data_exporter( $args['comment_author_email'] );
+ $expected = $args;
+
+ $this->assertTrue( $actual['done'] );
+
+ // Number of exported comments.
+ $this->assertSame( 1, count( $actual['data'] ) );
+
+ // Number of exported comment properties.
+ $this->assertSame( 8, count( $actual['data'][0]['data'] ) );
+
+ // Exported group.
+ $this->assertSame( 'comments', $actual['data'][0]['group_id'] );
+ $this->assertSame( 'Comments', $actual['data'][0]['group_label'] );
+
+ // Exported comment properties.
+ $this->assertSame( $expected['comment_author'], $actual['data'][0]['data'][0]['value'] );
+ $this->assertSame( $expected['comment_author_email'], $actual['data'][0]['data'][1]['value'] );
+ $this->assertSame( $expected['comment_author_url'], $actual['data'][0]['data'][2]['value'] );
+ $this->assertSame( $expected['comment_author_IP'], $actual['data'][0]['data'][3]['value'] );
+ $this->assertSame( $expected['comment_agent'], $actual['data'][0]['data'][4]['value'] );
+ $this->assertSame( $expected['comment_date'], $actual['data'][0]['data'][5]['value'] );
+ $this->assertSame( $expected['comment_content'], $actual['data'][0]['data'][6]['value'] );
+ $this->assertSame( get_comment_link( $c ), $actual['data'][0]['data'][7]['value'] );
+ }
+
+ /**
+ * Testing the `wp_comments_personal_data_exporter()` function for no comments found.
+ *
+ * @ticket 43440
+ */
+ public function test_wp_comments_personal_data_exporter_no_comments_found() {
+
+ $actual = wp_comments_personal_data_exporter( 'nocommentsfound@local.host' );
+
+ $expected = array(
+ 'data' => array(),
+ 'done' => true,
+ );
+
+ $this->assertSame( $expected, $actual );
+ }
+
+ /**
+ * Testing the `wp_comments_personal_data_exporter()` function for an empty comment property.
+ *
+ * @ticket 43440
+ */
+ public function test_wp_comments_personal_data_exporter_empty_comment_prop() {
+ $args = array(
+ 'comment_post_ID' => self::$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-03-28 20:05:00',
+ 'comment_agent' => '',
+ 'comment_content' => 'Comment',
+ );
+
+ $c = self::factory()->comment->create( $args );
+
+ $actual = wp_comments_personal_data_exporter( $args['comment_author_email'] );
+
+ $this->assertTrue( $actual['done'] );
+
+ // Number of exported comments.
+ $this->assertSame( 1, count( $actual['data'] ) );
+
+ // Number of exported comment properties.
+ $this->assertSame( 7, count( $actual['data'][0]['data'] ) );
+ }
+
+ /**
+ * Testing the `wp_comments_personal_data_exporter()` function with an empty second page.
+ *
+ * @ticket 43440
+ */
+ public function test_wp_comments_personal_data_exporter_empty_second_page() {
+ $args = array(
+ 'comment_post_ID' => self::$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-03-28 20:05:00',
+ 'comment_agent' => 'SOME_AGENT',
+ 'comment_content' => 'Comment',
+ );
+
+ $c = self::factory()->comment->create( $args );
+
+ $actual = wp_comments_personal_data_exporter( $args['comment_author_email'], 2 );
+
+ $this->assertTrue( $actual['done'] );
+
+ // Number of exported comments.
+ $this->assertSame( 0, count( $actual['data'] ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>