<!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>[39302] trunk: REST API: On Comment create, limit the ability to set the `author_ip` value directly.</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 { 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/39302">39302</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/39302","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>rachelbaker</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-11-18 21:12:03 +0000 (Fri, 18 Nov 2016)</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'>REST API: On Comment create, limit the ability to set the `author_ip` value directly.
Users without the moderate_comments capability can no longer set the `author_ip` property directly, and instead receive a `WP_Error` if they attempt to do so. Otherwise, the `author_ip property` is populated from `$_SERVER['REMOTE_ADDR']` if present and a valid IP value. Finally, fallback to 127.0.0.1 as a last resort.
Props dd32, rachelbaker, joehoyle.
Fixes <a href="https://core.trac.wordpress.org/ticket/38819">#38819</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestcommentscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestcommentscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestcommentscontrollerphp"></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/rest-api/endpoints/class-wp-rest-comments-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 2016-11-18 21:05:33 UTC (rev 39301)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 2016-11-18 21:12:03 UTC (rev 39302)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -371,12 +371,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'rest_comment_login_required', __( 'Sorry, you must be logged in to comment.' ), array( 'status' => 401 ) );
</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">- // Limit who can set comment `author` or `status` to anything other than the default.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Limit who can set comment `author`, `author_ip` or `status` to anything other than the default.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $request['author'] ) && get_current_user_id() !== $request['author'] && ! current_user_can( 'moderate_comments' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: %s: request parameter */
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'rest_comment_invalid_author', sprintf( __( "Sorry, you are not allowed to edit '%s' for comments." ), 'author' ), array( 'status' => rest_authorization_required_code() ) );
</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">+ if ( isset( $request['author_ip'] ) && ! current_user_can( 'moderate_comments' ) ) {
+ if ( empty( $_SERVER['REMOTE_ADDR'] ) || $request['author_ip'] !== $_SERVER['REMOTE_ADDR'] ) {
+ return new WP_Error( 'rest_comment_invalid_author_ip', __( 'Sorry, you are not allowed to set author_ip for comments.' ), array( 'status' => rest_authorization_required_code() ) );
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $request['status'] ) && ! current_user_can( 'moderate_comments' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: %s: request parameter */
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'rest_comment_invalid_status', sprintf( __( "Sorry, you are not allowed to edit '%s' for comments." ), 'status' ), array( 'status' => rest_authorization_required_code() ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1041,8 +1047,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_comment['comment_author_url'] = $request['author_url'];
</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">- if ( isset( $request['author_ip'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $request['author_ip'] ) && current_user_can( 'moderate_comments' ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $prepared_comment['comment_author_IP'] = $request['author_ip'];
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( ! empty( $_SERVER['REMOTE_ADDR'] ) && rest_is_ip_address( $_SERVER['REMOTE_ADDR'] ) ) {
+ $prepared_comment['comment_author_IP'] = $_SERVER['REMOTE_ADDR'];
+ } else {
+ $prepared_comment['comment_author_IP'] = '127.0.0.1';
</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"> if ( ! empty( $request['author_user_agent'] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1119,7 +1129,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</span><span class="cx" style="display: block; padding: 0 10px"> 'format' => 'ip',
</span><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'edit' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'default' => '127.0.0.1',
</del><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'author_name' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'Display name for the object author.' ),
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestcommentscontrollerphp"></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/rest-api/rest-comments-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php 2016-11-18 21:05:33 UTC (rev 39301)
+++ trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php 2016-11-18 21:12:03 UTC (rev 39302)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,9 +6,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @subpackage REST API
</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">- /**
- * @group restapi
- */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * @group restapi
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> class WP_Test_REST_Comments_Controller extends WP_Test_REST_Controller_Testcase {
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $superadmin_id;
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $admin_id;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1307,10 +1307,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'Mozilla/4.0 (compatible; MSIE 5.5; AOL 4.0; Windows 95)', $new_comment->comment_agent );
</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">+ public function test_create_comment_author_ip() {
+ wp_set_current_user( self::$admin_id );
+
+ $params = array(
+ 'post' => self::$post_id,
+ 'author_name' => 'Comic Book Guy',
+ 'author_email' => 'cbg@androidsdungeon.com',
+ 'author_url' => 'http://androidsdungeon.com',
+ 'author_ip' => '127.0.0.3',
+ 'content' => 'Worst Comment Ever!',
+ 'status' => 'approved',
+ );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/comments' );
+ $request->add_header( 'content-type', 'application/json' );
+ $request->set_body( wp_json_encode( $params ) );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $new_comment = get_comment( $data['id'] );
+ $this->assertEquals( '127.0.0.3', $new_comment->comment_author_IP );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_create_comment_invalid_author_IP() {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( self::$admin_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $params = array(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'post' => self::$post_id,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'author_name' => 'Comic Book Guy',
</span><span class="cx" style="display: block; padding: 0 10px"> 'author_email' => 'cbg@androidsdungeon.com',
</span><span class="cx" style="display: block; padding: 0 10px"> 'author_url' => 'http://androidsdungeon.com',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1323,10 +1345,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_body( wp_json_encode( $params ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
</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">+ public function test_create_comment_author_ip_no_permission() {
+ $params = array(
+ 'author_name' => 'Comic Book Guy',
+ 'author_email' => 'cbg@androidsdungeon.com',
+ 'author_url' => 'http://androidsdungeon.com',
+ 'author_ip' => '10.0.10.1',
+ 'content' => 'Worst Comment Ever!',
+ 'status' => 'approved',
+ );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/comments' );
+ $request->add_header( 'content-type', 'application/json' );
+ $request->set_body( wp_json_encode( $params ) );
+ $response = $this->server->dispatch( $request );
+ $this->assertErrorResponse( 'rest_comment_invalid_author_ip', $response, 401 );
+ }
+
+ public function test_create_comment_author_ip_defaults_to_remote_addr() {
+ $_SERVER['REMOTE_ADDR'] = '127.0.0.2';
+ $params = array(
+ 'post' => self::$post_id,
+ 'author_name' => 'Comic Book Guy',
+ 'author_email' => 'cbg@androidsdungeon.com',
+ 'author_url' => 'http://androidsdungeon.com',
+ 'content' => 'Worst Comment Ever!',
+ );
+ $request = new WP_REST_Request( 'POST', '/wp/v2/comments' );
+ $request->add_header( 'content-type', 'application/json' );
+ $request->set_body( wp_json_encode( $params ) );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $new_comment = get_comment( $data['id'] );
+ $this->assertEquals( '127.0.0.2', $new_comment->comment_author_IP );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_create_comment_no_post_id() {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( self::$admin_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2268,9 +2323,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'post', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'status', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'type', $properties );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- $this->assertEquals( '127.0.0.1', $properties['author_ip']['default'] );
-
</del><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'comment', $properties['type']['default'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 0, $properties['parent']['default'] );
</span></span></pre>
</div>
</div>
</body>
</html>