<!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>[49329] trunk: REST API: Support a broader range of JSON media types.</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/49329">49329</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/49329","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>TimothyBlynJacobs</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-10-27 16:42:38 +0000 (Tue, 27 Oct 2020)</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: Support a broader range of JSON media types.
Previously, we only supported `application/json` which prevented using subtypes like `application/activity+json`. This allows for the REST API to `json_decode` the body of requests using a JSON subtype `Content-Type`. Additionally, `wp_die()` now properly sends the error as JSON when a JSON subtype is specified in the `Accept` header.
Props pfefferle.
Fixes <a href="https://core.trac.wordpress.org/ticket/49404">#49404</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesloadphp">trunk/src/wp-includes/load.php</a></li>
<li><a href="#trunksrcwpincludesrestapiclasswprestrequestphp">trunk/src/wp-includes/rest-api/class-wp-rest-request.php</a></li>
<li><a href="#trunktestsphpunittestsfunctionsphp">trunk/tests/phpunit/tests/functions.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestrequestphp">trunk/tests/phpunit/tests/rest-api/rest-request.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesloadphp"></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/load.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/load.php 2020-10-27 16:40:35 UTC (rev 49328)
+++ trunk/src/wp-includes/load.php 2020-10-27 16:42:38 UTC (rev 49329)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1595,11 +1595,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_is_json_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">- if ( isset( $_SERVER['HTTP_ACCEPT'] ) && false !== strpos( $_SERVER['HTTP_ACCEPT'], 'application/json' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $_SERVER['HTTP_ACCEPT'] ) && wp_is_json_media_type( $_SERVER['HTTP_ACCEPT'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</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( $_SERVER['CONTENT_TYPE'] ) && 'application/json' === $_SERVER['CONTENT_TYPE'] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $_SERVER['CONTENT_TYPE'] ) && wp_is_json_media_type( $_SERVER['CONTENT_TYPE'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1636,6 +1636,24 @@
</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">+ * Checks whether a string is a valid JSON Media Type.
+ *
+ * @since 5.6.0
+ *
+ * @param string $media_type A Media Type string to check.
+ * @return bool True if string is a valid JSON Media Type.
+ */
+function wp_is_json_media_type( $media_type ) {
+ static $cache = array();
+
+ if ( ! isset( $cache[ $media_type ] ) ) {
+ $cache[ $media_type ] = (bool) preg_match( '/(^|\s|,)application\/([\w!#\$&-\^\.\+]+\+)?json(\+oembed)?($|\s|;|,)/i', $media_type );
+ }
+
+ return $cache[ $media_type ];
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Checks whether current request is an XML request, or is expecting an XML response.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.2.0
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiclasswprestrequestphp"></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/class-wp-rest-request.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/class-wp-rest-request.php 2020-10-27 16:40:35 UTC (rev 49328)
+++ trunk/src/wp-includes/rest-api/class-wp-rest-request.php 2020-10-27 16:42:38 UTC (rev 49329)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -324,6 +324,19 @@
</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">+ * Checks if the request has specified a JSON content-type.
+ *
+ * @since 5.6.0
+ *
+ * @return bool True if the content-type header is JSON.
+ */
+ public function is_json_content_type() {
+ $content_type = $this->get_content_type();
+
+ return isset( $content_type['value'] ) && wp_is_json_media_type( $content_type['value'] );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Retrieves the parameter priority order.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Used when checking parameters in get_param().
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -335,8 +348,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected function get_parameter_order() {
</span><span class="cx" style="display: block; padding: 0 10px"> $order = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $content_type = $this->get_content_type();
- if ( isset( $content_type['value'] ) && 'application/json' === $content_type['value'] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $this->is_json_content_type() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $order[] = 'JSON';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -658,9 +670,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->parsed_json = true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Check that we actually got JSON.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $content_type = $this->get_content_type();
-
- if ( empty( $content_type ) || 'application/json' !== $content_type['value'] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $this->is_json_content_type() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</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="trunktestsphpunittestsfunctionsphp"></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/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/functions.php 2020-10-27 16:40:35 UTC (rev 49328)
+++ trunk/tests/phpunit/tests/functions.php 2020-10-27 16:42:38 UTC (rev 49329)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1728,4 +1728,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> array( '03:61:59', false ), // Out of bound.
</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">+
+ /**
+ * @ticket 49404
+ * @dataProvider data_test_wp_is_json_media_type
+ */
+ public function test_wp_is_json_media_type( $input, $expected ) {
+ $this->assertEquals( $expected, wp_is_json_media_type( $input ) );
+ }
+
+
+ public function data_test_wp_is_json_media_type() {
+ return array(
+ array( 'application/ld+json', true ),
+ array( 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"', true ),
+ array( 'application/activity+json', true ),
+ array( 'application/json+oembed', true ),
+ array( 'application/json', true ),
+ array( 'application/nojson', false ),
+ array( 'application/no.json', false ),
+ array( 'text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, */*;q=0.8', false ),
+ array( 'application/activity+json, application/nojson', true ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestrequestphp"></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-request.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-request.php 2020-10-27 16:40:35 UTC (rev 49328)
+++ trunk/tests/phpunit/tests/rest-api/rest-request.php 2020-10-27 16:42:38 UTC (rev 49329)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -178,6 +178,87 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEmpty( $this->request->get_param( 'has_json_params' ) );
</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 static function alternate_json_content_type_provider() {
+ return array(
+ array( 'application/ld+json', 'json', true ),
+ array( 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"', 'json', true ),
+ array( 'application/activity+json', 'json', true ),
+ array( 'application/json+oembed', 'json', true ),
+ array( 'application/nojson', 'body', false ),
+ array( 'application/no.json', 'body', false ),
+ );
+ }
+
+ /**
+ * @ticket 49404
+ * @dataProvider alternate_json_content_type_provider
+ *
+ * @param string $content_type The content-type
+ * @param string $source The source value.
+ * @param boolean $accept_json The accept_json value.
+ */
+ public function test_alternate_json_content_type( $content_type, $source, $accept_json ) {
+ $this->request_with_parameters();
+
+ $this->request->set_method( 'POST' );
+ $this->request->set_header( 'Content-Type', $content_type );
+ $this->request->set_attributes( array( 'accept_json' => true ) );
+
+ // Check that JSON takes precedence.
+ $this->assertEquals( $source, $this->request->get_param( 'source' ) );
+ $this->assertEquals( $accept_json, $this->request->get_param( 'has_json_params' ) );
+ }
+
+ public static function is_json_content_type_provider() {
+ return array(
+ array( 'application/ld+json', true ),
+ array( 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"', true ),
+ array( 'application/activity+json', true ),
+ array( 'application/json+oembed', true ),
+ array( 'application/nojson', false ),
+ array( 'application/no.json', false ),
+ );
+ }
+
+ /**
+ * @ticket 49404
+ * @dataProvider is_json_content_type_provider
+ *
+ * @param string $content_type The content-type
+ * @param boolean $is_json The is_json value.
+ */
+ public function test_is_json_content_type( $content_type, $is_json ) {
+ $this->request_with_parameters();
+
+ $this->request->set_header( 'Content-Type', $content_type );
+
+ // Check for JSON content-type.
+ $this->assertEquals( $is_json, $this->request->is_json_content_type() );
+ }
+
+ /**
+ * @ticket 49404
+ */
+ public function test_content_type_cache() {
+ $this->request_with_parameters();
+ $this->assertFalse( $this->request->is_json_content_type() );
+
+ $this->request->set_header( 'Content-Type', 'application/json' );
+ $this->assertTrue( $this->request->is_json_content_type() );
+
+ $this->request->set_header( 'Content-Type', 'application/activity+json' );
+ $this->assertTrue( $this->request->is_json_content_type() );
+
+ $this->request->set_header( 'Content-Type', 'application/nojson' );
+ $this->assertFalse( $this->request->is_json_content_type() );
+
+ $this->request->set_header( 'Content-Type', 'application/json' );
+ $this->assertTrue( $this->request->is_json_content_type() );
+
+ $this->request->remove_header( 'Content-Type' );
+ $this->assertFalse( $this->request->is_json_content_type() );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_parameter_order_json() {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->request_with_parameters();
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>