<!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>[39295] trunk: REST API: Check read permissions on posts when viewing comments.</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/39295">39295</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/39295","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>joehoyle</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-11-18 19:06:26 +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: Check read permissions on posts when viewing comments.
With a few tests for getting / creating comments to reflect core behaviour.
Props timmyc.</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 19:04:25 UTC (rev 39294)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 2016-11-18 19:06:26 UTC (rev 39295)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1454,7 +1454,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function check_read_post_permission( $post ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $posts_controller = new WP_REST_Posts_Controller( $post->post_type );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post_type = get_post_type_object( $post->post_type );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( post_password_required( $post ) ) {
+ return current_user_can( $post_type->cap->edit_post, $post->ID );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $posts_controller->check_read_permission( $post );
</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="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 19:04:25 UTC (rev 39294)
+++ trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php 2016-11-18 19:06:26 UTC (rev 39295)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,6 +17,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $author_id;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $post_id;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected static $password_id;
</ins><span class="cx" style="display: block; padding: 0 10px"> protected static $private_id;
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $draft_id;
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $trash_id;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -52,6 +53,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> self::$private_id = $factory->post->create( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_status' => 'private',
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::$password_id = $factory->post->create( array(
+ 'post_password' => 'toomanysecrets',
+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> self::$draft_id = $factory->post->create( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_status' => 'draft',
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -78,6 +82,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_delete_post( self::$post_id, true );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_delete_post( self::$private_id, true );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_delete_post( self::$password_id, true );
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_delete_post( self::$draft_id, true );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_delete_post( self::$trash_id, true );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_delete_post( self::$approved_id, true );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -162,6 +167,42 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertCount( 7, $comments );
</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_get_password_items_without_edit_post_permission() {
+ wp_set_current_user( 0 );
+
+ $args = array(
+ 'comment_approved' => 1,
+ 'comment_post_ID' => self::$password_id,
+ );
+ $password_comment = $this->factory->comment->create( $args );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/comments' );
+
+ $response = $this->server->dispatch( $request );
+ $this->assertEquals( 200, $response->get_status() );
+
+ $collection_data = $response->get_data();
+ $this->assertFalse( in_array( $password_comment, wp_list_pluck( $collection_data, 'id' ), true ) );
+ }
+
+ public function test_get_password_items_with_edit_post_permission() {
+ wp_set_current_user( self::$admin_id );
+
+ $args = array(
+ 'comment_approved' => 1,
+ 'comment_post_ID' => self::$password_id,
+ );
+ $password_comment = $this->factory->comment->create( $args );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/comments' );
+
+ $response = $this->server->dispatch( $request );
+ $this->assertEquals( 200, $response->get_status() );
+
+ $collection_data = $response->get_data();
+ $this->assertTrue( in_array( $password_comment, wp_list_pluck( $collection_data, 'id' ), true ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_items_without_private_post_permission() {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( 0 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -800,6 +841,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayNotHasKey( 'children', $response->get_links() );
</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_get_comment_with_password_without_edit_post_permission() {
+ wp_set_current_user( 0 );
+ $args = array(
+ 'comment_approved' => 1,
+ 'comment_post_ID' => self::$password_id,
+ );
+ $password_comment = $this->factory->comment->create( $args );
+ $request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/comments/%s', $password_comment ) );
+ $response = $this->server->dispatch( $request );
+ $this->assertErrorResponse( 'rest_cannot_read', $response, 401 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_create_item() {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( 0 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1372,6 +1425,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_cannot_read_post', $response, 403 );
</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_password_post_invalid_permission() {
+ wp_set_current_user( self::$subscriber_id );
+
+ $params = array(
+ 'post' => self::$password_id,
+ 'author_name' => 'Homer Jay Simpson',
+ 'author_email' => 'chunkylover53@aol.com',
+ 'author_url' => 'http://compuglobalhypermeganet.com',
+ 'content' => 'I\’d be a vegetarian if bacon grew on trees.',
+ 'author' => self::$subscriber_id,
+ );
+ $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_cannot_read_post', $response, 403 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_create_item_duplicate() {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->factory->comment->create(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span></span></pre>
</div>
</div>
</body>
</html>