<!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>[39157] trunk: REST API: Respect unfiltered_html for HTML comment fields.</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/39157">39157</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/39157","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>rmccue</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-11-08 06:35:51 +0000 (Tue, 08 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: Respect unfiltered_html for HTML comment fields.
Same as <a href="https://core.trac.wordpress.org/changeset/39155">[39155]</a>, but for comments, natch.
Props jnylen0.
Fixes <a href="https://core.trac.wordpress.org/ticket/38704">#38704</a>, see <a href="https://core.trac.wordpress.org/ticket/38609">#38609</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-08 06:25:36 UTC (rev 39156)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php 2016-11-08 06:35:51 UTC (rev 39157)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -520,7 +520,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_comment = apply_filters( 'rest_pre_insert_comment', $prepared_comment, $request );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $comment_id = wp_insert_comment( $prepared_comment );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $comment_id = wp_insert_comment( wp_filter_comment( wp_slash( (array) $prepared_comment ) ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $comment_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'rest_comment_failed_create', __( 'Creating comment failed.' ), array( 'status' => 500 ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -644,7 +644,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( $error_code, __( 'Comment field exceeds maximum length allowed.' ), array( 'status' => 400 ) );
</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">- $updated = wp_update_comment( $prepared_args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $updated = wp_update_comment( wp_slash( (array) $prepared_args ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 0 === $updated ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'rest_comment_failed_edit', __( 'Updating comment failed.' ), array( 'status' => 500 ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -995,9 +995,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * the 'content.raw' properties of the Request object.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $request['content'] ) && is_string( $request['content'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $prepared_comment['comment_content'] = wp_filter_kses( $request['content'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $prepared_comment['comment_content'] = $request['content'];
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( isset( $request['content']['raw'] ) && is_string( $request['content']['raw'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $prepared_comment['comment_content'] = wp_filter_kses( $request['content']['raw'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $prepared_comment['comment_content'] = $request['content']['raw'];
</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 ( isset( $request['post'] ) ) {
</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-08 06:25:36 UTC (rev 39156)
+++ trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php 2016-11-08 06:35:51 UTC (rev 39157)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -10,8 +10,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @group restapi
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class WP_Test_REST_Comments_Controller extends WP_Test_REST_Controller_Testcase {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected static $superadmin_id;
</ins><span class="cx" style="display: block; padding: 0 10px"> protected static $admin_id;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected static $editor_id;
</ins><span class="cx" style="display: block; padding: 0 10px"> protected static $subscriber_id;
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -25,9 +26,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected $endpoint;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public static function wpSetUpBeforeClass( $factory ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::$superadmin_id = $factory->user->create( array(
+ 'role' => 'administrator',
+ 'user_login' => 'superadmin',
+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> self::$admin_id = $factory->user->create( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'role' => 'administrator',
</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::$editor_id = $factory->user->create( array(
+ 'role' => 'editor',
+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> self::$subscriber_id = $factory->user->create( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'role' => 'subscriber',
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -79,6 +87,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function setUp() {
</span><span class="cx" style="display: block; padding: 0 10px"> parent::setUp();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->endpoint = new WP_REST_Comments_Controller;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_multisite() ) {
+ update_site_option( 'site_admins', array( 'superadmin' ) );
+ }
</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"> public function tearDown() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1880,6 +1891,141 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'comment_content_column_length', $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 verify_comment_roundtrip( $input = array(), $expected_output = array() ) {
+ // Create the comment
+ $request = new WP_REST_Request( 'POST', '/wp/v2/comments' );
+ $request->set_param( 'author_email', 'cbg@androidsdungeon.com' );
+ $request->set_param( 'post', self::$post_id );
+ foreach ( $input as $name => $value ) {
+ $request->set_param( $name, $value );
+ }
+ $response = $this->server->dispatch( $request );
+ $this->assertEquals( 201, $response->get_status() );
+ $actual_output = $response->get_data();
+
+ // Compare expected API output to actual API output
+ $this->assertInternalType( 'array', $actual_output['content'] );
+ $this->assertArrayHasKey( 'raw', $actual_output['content'] );
+ $this->assertEquals( $expected_output['content']['raw'] , $actual_output['content']['raw'] );
+ $this->assertEquals( $expected_output['content']['rendered'], trim( $actual_output['content']['rendered'] ) );
+ $this->assertEquals( $expected_output['author_name'] , $actual_output['author_name'] );
+ $this->assertEquals( $expected_output['author_user_agent'] , $actual_output['author_user_agent'] );
+
+ // Compare expected API output to WP internal values
+ $comment = get_comment( $actual_output['id'] );
+ $this->assertEquals( $expected_output['content']['raw'] , $comment->comment_content );
+ $this->assertEquals( $expected_output['author_name'] , $comment->comment_author );
+ $this->assertEquals( $expected_output['author_user_agent'], $comment->comment_agent );
+
+ // Update the comment
+ $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/comments/%d', $actual_output['id'] ) );
+ foreach ( $input as $name => $value ) {
+ $request->set_param( $name, $value );
+ }
+ // FIXME at least one value must change, or update fails
+ // See https://core.trac.wordpress.org/ticket/38700
+ $request->set_param( 'author_ip', '127.0.0.2' );
+ $response = $this->server->dispatch( $request );
+ $this->assertEquals( 200, $response->get_status() );
+ $actual_output = $response->get_data();
+
+ // Compare expected API output to actual API output
+ $this->assertEquals( $expected_output['content']['raw'] , $actual_output['content']['raw'] );
+ $this->assertEquals( $expected_output['content']['rendered'], trim( $actual_output['content']['rendered'] ) );
+ $this->assertEquals( $expected_output['author_name'] , $actual_output['author_name'] );
+ $this->assertEquals( $expected_output['author_user_agent'] , $actual_output['author_user_agent'] );
+
+ // Compare expected API output to WP internal values
+ $comment = get_comment( $actual_output['id'] );
+ $this->assertEquals( $expected_output['content']['raw'] , $comment->comment_content );
+ $this->assertEquals( $expected_output['author_name'] , $comment->comment_author );
+ $this->assertEquals( $expected_output['author_user_agent'], $comment->comment_agent );
+ }
+
+ public function test_comment_roundtrip_as_editor() {
+ wp_set_current_user( self::$editor_id );
+ $this->assertEquals( ! is_multisite(), current_user_can( 'unfiltered_html' ) );
+ $this->verify_comment_roundtrip( array(
+ 'content' => '\o/ ¯\_(ツ)_/¯',
+ 'author_name' => '\o/ ¯\_(ツ)_/¯',
+ 'author_user_agent' => '\o/ ¯\_(ツ)_/¯',
+ ), array(
+ 'content' => array(
+ 'raw' => '\o/ ¯\_(ツ)_/¯',
+ 'rendered' => '<p>\o/ ¯\_(ツ)_/¯</p>',
+ ),
+ 'author_name' => '\o/ ¯\_(ツ)_/¯',
+ 'author_user_agent' => '\o/ ¯\_(ツ)_/¯',
+ ) );
+ }
+
+ public function test_comment_roundtrip_as_editor_unfiltered_html() {
+ wp_set_current_user( self::$editor_id );
+ if ( is_multisite() ) {
+ $this->assertFalse( current_user_can( 'unfiltered_html' ) );
+ $this->verify_comment_roundtrip( array(
+ 'content' => '<div>div</div> <strong>strong</strong> <script>oh noes</script>',
+ 'author_name' => '<div>div</div> <strong>strong</strong> <script>oh noes</script>',
+ 'author_user_agent' => '<div>div</div> <strong>strong</strong> <script>oh noes</script>',
+ ), array(
+ 'content' => array(
+ 'raw' => 'div <strong>strong</strong> oh noes',
+ 'rendered' => '<p>div <strong>strong</strong> oh noes</p>',
+ ),
+ 'author_name' => 'div strong',
+ 'author_user_agent' => 'div strong',
+ ) );
+ } else {
+ $this->assertTrue( current_user_can( 'unfiltered_html' ) );
+ $this->verify_comment_roundtrip( array(
+ 'content' => '<div>div</div> <strong>strong</strong> <script>oh noes</script>',
+ 'author_name' => '<div>div</div> <strong>strong</strong> <script>oh noes</script>',
+ 'author_user_agent' => '<div>div</div> <strong>strong</strong> <script>oh noes</script>',
+ ), array(
+ 'content' => array(
+ 'raw' => '<div>div</div> <strong>strong</strong> <script>oh noes</script>',
+ 'rendered' => "<div>div</div>\n<p> <strong>strong</strong> <script>oh noes</script></p>",
+ ),
+ 'author_name' => 'div strong',
+ 'author_user_agent' => 'div strong',
+ ) );
+ }
+ }
+
+ public function test_comment_roundtrip_as_superadmin() {
+ wp_set_current_user( self::$superadmin_id );
+ $this->assertTrue( current_user_can( 'unfiltered_html' ) );
+ $this->verify_comment_roundtrip( array(
+ 'content' => '\\\&\\\ & &invalid; < < &lt;',
+ 'author_name' => '\\\&\\\ & &invalid; < < &lt;',
+ 'author_user_agent' => '\\\&\\\ & &invalid; < < &lt;',
+ ), array(
+ 'content' => array(
+ 'raw' => '\\\&\\\ & &invalid; < < &lt;',
+ 'rendered' => '<p>\\\&\\\ & &invalid; < < &lt;' . "\n</p>",
+ ),
+ 'author_name' => '\\\&\\\ & &invalid; < < &lt;',
+ 'author_user_agent' => '\\\&\\\ & &invalid; < < &lt;',
+ ) );
+ }
+
+ public function test_comment_roundtrip_as_superadmin_unfiltered_html() {
+ wp_set_current_user( self::$superadmin_id );
+ $this->assertTrue( current_user_can( 'unfiltered_html' ) );
+ $this->verify_comment_roundtrip( array(
+ 'content' => '<div>div</div> <strong>strong</strong> <script>oh noes</script>',
+ 'author_name' => '<div>div</div> <strong>strong</strong> <script>oh noes</script>',
+ 'author_user_agent' => '<div>div</div> <strong>strong</strong> <script>oh noes</script>',
+ ), array(
+ 'content' => array(
+ 'raw' => '<div>div</div> <strong>strong</strong> <script>oh noes</script>',
+ 'rendered' => "<div>div</div>\n<p> <strong>strong</strong> <script>oh noes</script></p>",
+ ),
+ 'author_name' => 'div strong',
+ 'author_user_agent' => 'div strong',
+ ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_delete_item() {
</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></pre>
</div>
</div>
</body>
</html>