<!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>[47758] trunk: REST API: Support more JSON Schemas when filtering a response by context.</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/47758">47758</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/47758","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-05-04 02:44:44 +0000 (Mon, 04 May 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 more JSON Schemas when filtering a response by context.
The array type, multi-types, and the additional properties keyword are now supported. Additionally, the filter recurses to an infinite depth.
Fixes <a href="https://core.trac.wordpress.org/ticket/48819">#48819</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestcontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapiphp">trunk/src/wp-includes/rest-api.php</a></li>
<li><a href="#trunktestsphpunittestsrestapiphp">trunk/tests/phpunit/tests/rest-api.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestcontrollerphp"></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-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-controller.php 2020-05-04 00:26:52 UTC (rev 47757)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php 2020-05-04 02:44:44 UTC (rev 47758)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -288,7 +288,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0
</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 array $data Response data to fiter.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $data Response data to filter.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $context Context defined in the schema.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Filtered response.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -296,32 +296,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $schema = $this->get_item_schema();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $data as $key => $value ) {
- if ( empty( $schema['properties'][ $key ] ) || empty( $schema['properties'][ $key ]['context'] ) ) {
- continue;
- }
-
- if ( ! in_array( $context, $schema['properties'][ $key ]['context'], true ) ) {
- unset( $data[ $key ] );
- continue;
- }
-
- if ( 'object' === $schema['properties'][ $key ]['type'] && ! empty( $schema['properties'][ $key ]['properties'] ) ) {
- foreach ( $schema['properties'][ $key ]['properties'] as $attribute => $details ) {
- if ( empty( $details['context'] ) ) {
- continue;
- }
-
- if ( ! in_array( $context, $details['context'], true ) ) {
- if ( isset( $data[ $key ][ $attribute ] ) ) {
- unset( $data[ $key ][ $attribute ] );
- }
- }
- }
- }
- }
-
- return $data;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return rest_filter_response_by_context( $data, $schema, $context );
</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="trunksrcwpincludesrestapiphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api.php 2020-05-04 00:26:52 UTC (rev 47757)
+++ trunk/src/wp-includes/rest-api.php 2020-05-04 02:44:44 UTC (rev 47758)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1658,3 +1658,63 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $rels;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Filters the response to remove any fields not available in the given context.
+ *
+ * @since 5.5.0
+ *
+ * @param array|object $data The response data to modify.
+ * @param array $schema The schema for the endpoint used to filter the response.
+ * @param string $context The requested context.
+ * @return array|object The filtered response data.
+ */
+function rest_filter_response_by_context( $data, $schema, $context ) {
+ if ( ! is_array( $data ) && ! is_object( $data ) ) {
+ return $data;
+ }
+
+ if ( isset( $schema['type'] ) ) {
+ $type = $schema['type'];
+ } elseif ( isset( $schema['properties'] ) ) {
+ $type = 'object'; // Back compat if a developer accidentally omitted the type.
+ } else {
+ return $data;
+ }
+
+ foreach ( $data as $key => $value ) {
+ $check = array();
+
+ if ( 'array' === $type || ( is_array( $type ) && in_array( 'array', $type, true ) ) ) {
+ $check = isset( $schema['items'] ) ? $schema['items'] : array();
+ } elseif ( 'object' === $type || ( is_array( $type ) && in_array( 'object', $type, true ) ) ) {
+ if ( isset( $schema['properties'][ $key ] ) ) {
+ $check = $schema['properties'][ $key ];
+ } elseif ( isset( $schema['additionalProperties'] ) && is_array( $schema['additionalProperties'] ) ) {
+ $check = $schema['additionalProperties'];
+ }
+ }
+
+ if ( ! isset( $check['context'] ) ) {
+ continue;
+ }
+
+ if ( ! in_array( $context, $check['context'], true ) ) {
+ if ( is_object( $data ) ) {
+ unset( $data->$key );
+ } else {
+ unset( $data[ $key ] );
+ }
+ } elseif ( is_array( $value ) || is_object( $value ) ) {
+ $new_value = rest_filter_response_by_context( $value, $check, $context );
+
+ if ( is_object( $data ) ) {
+ $data->$key = $new_value;
+ } else {
+ $data[ $key ] = $new_value;
+ }
+ }
+ }
+
+ return $data;
+}
</ins></span></pre></div>
<a id="trunktestsphpunittestsrestapiphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api.php 2020-05-04 00:26:52 UTC (rev 47757)
+++ trunk/tests/phpunit/tests/rest-api.php 2020-05-04 02:44:44 UTC (rev 47758)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -975,4 +975,324 @@
</span><span class="cx" style="display: block; padding: 0 10px"> array( array( 'https://api.w.org/term', 'https://api.w.org/attachment' ), array( 'https://api.w.org/term', 'https://api.w.org/attachment' ) ),
</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 48819
+ *
+ * @dataProvider _dp_rest_filter_response_by_context
+ */
+ public function test_rest_filter_response_by_context( $schema, $data, $expected ) {
+ $this->assertEquals( $expected, rest_filter_response_by_context( $data, $schema, 'view' ) );
+ }
+
+ public function _dp_rest_filter_response_by_context() {
+ return array(
+ 'default' => array(
+ array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'type' => 'object',
+ 'properties' => array(
+ 'first' => array(
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ ),
+ 'second' => array(
+ 'type' => 'string',
+ 'context' => array( 'edit' ),
+ ),
+ ),
+ ),
+ array(
+ 'first' => 'a',
+ 'second' => 'b',
+ ),
+ array( 'first' => 'a' ),
+ ),
+ 'keeps missing context' => array(
+ array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'type' => 'object',
+ 'properties' => array(
+ 'first' => array(
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ ),
+ 'second' => array(
+ 'type' => 'string',
+ ),
+ ),
+ ),
+ array(
+ 'first' => 'a',
+ 'second' => 'b',
+ ),
+ array(
+ 'first' => 'a',
+ 'second' => 'b',
+ ),
+ ),
+ 'removes empty context' => array(
+ array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'type' => 'object',
+ 'properties' => array(
+ 'first' => array(
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ ),
+ 'second' => array(
+ 'type' => 'string',
+ 'context' => array(),
+ ),
+ ),
+ ),
+ array(
+ 'first' => 'a',
+ 'second' => 'b',
+ ),
+ array( 'first' => 'a' ),
+ ),
+ 'nested properties' => array(
+ array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'type' => 'object',
+ 'properties' => array(
+ 'parent' => array(
+ 'type' => 'object',
+ 'context' => array( 'view', 'edit' ),
+ 'properties' => array(
+ 'child' => array(
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ ),
+ 'hidden' => array(
+ 'type' => 'string',
+ 'context' => array( 'edit' ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ array(
+ 'parent' => array(
+ 'child' => 'hi',
+ 'hidden' => 'there',
+ ),
+ ),
+ array( 'parent' => array( 'child' => 'hi' ) ),
+ ),
+ 'grand child properties' => array(
+ array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'type' => 'object',
+ 'properties' => array(
+ 'parent' => array(
+ 'type' => 'object',
+ 'context' => array( 'view', 'edit' ),
+ 'properties' => array(
+ 'child' => array(
+ 'type' => 'object',
+ 'context' => array( 'view', 'edit' ),
+ 'properties' => array(
+ 'grand' => array(
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ ),
+ 'hidden' => array(
+ 'type' => 'string',
+ 'context' => array( 'edit' ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ array(
+ 'parent' => array(
+ 'child' => array(
+ 'grand' => 'hi',
+ ),
+ ),
+ ),
+ array( 'parent' => array( 'child' => array( 'grand' => 'hi' ) ) ),
+ ),
+ 'array' => array(
+ array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'type' => 'object',
+ 'properties' => array(
+ 'arr' => array(
+ 'type' => 'array',
+ 'context' => array( 'view', 'edit' ),
+ 'items' => array(
+ 'type' => 'object',
+ 'context' => array( 'view', 'edit' ),
+ 'properties' => array(
+ 'visible' => array(
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ ),
+ 'hidden' => array(
+ 'type' => 'string',
+ 'context' => array( 'edit' ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ array(
+ 'arr' => array(
+ array(
+ 'visible' => 'hi',
+ 'hidden' => 'there',
+ ),
+ ),
+ ),
+ array( 'arr' => array( array( 'visible' => 'hi' ) ) ),
+ ),
+ 'additional properties' => array(
+ array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'type' => 'object',
+ 'properties' => array(
+ 'additional' => array(
+ 'type' => 'object',
+ 'context' => array( 'view', 'edit' ),
+ 'properties' => array(
+ 'a' => array(
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ ),
+ 'b' => array(
+ 'type' => 'string',
+ 'context' => array( 'edit' ),
+ ),
+ ),
+ 'additionalProperties' => array(
+ 'type' => 'string',
+ 'context' => array( 'edit' ),
+ ),
+ ),
+ ),
+ ),
+ array(
+ 'additional' => array(
+ 'a' => '1',
+ 'b' => '2',
+ 'c' => '3',
+ ),
+ ),
+ array( 'additional' => array( 'a' => '1' ) ),
+ ),
+ 'multiple types object' => array(
+ array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'type' => 'object',
+ 'properties' => array(
+ 'multi' => array(
+ 'type' => array( 'object', 'string' ),
+ 'context' => array( 'view', 'edit' ),
+ 'properties' => array(
+ 'a' => array(
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ ),
+ 'b' => array(
+ 'type' => 'string',
+ 'context' => array( 'edit' ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ array(
+ 'multi' => array(
+ 'a' => '1',
+ 'b' => '2',
+ ),
+ ),
+ array( 'multi' => array( 'a' => '1' ) ),
+ ),
+ 'multiple types array' => array(
+ array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'type' => 'object',
+ 'properties' => array(
+ 'multi' => array(
+ 'type' => array( 'array', 'string' ),
+ 'context' => array( 'view', 'edit' ),
+ 'items' => array(
+ 'type' => 'object',
+ 'context' => array( 'view', 'edit' ),
+ 'properties' => array(
+ 'visible' => array(
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ ),
+ 'hidden' => array(
+ 'type' => 'string',
+ 'context' => array( 'edit' ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ array(
+ 'multi' => array(
+ array(
+ 'visible' => '1',
+ 'hidden' => '2',
+ ),
+ ),
+ ),
+ array( 'multi' => array( array( 'visible' => '1' ) ) ),
+ ),
+ 'grand child properties does not traverses missing context' => array(
+ array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'type' => 'object',
+ 'properties' => array(
+ 'parent' => array(
+ 'type' => 'object',
+ 'context' => array( 'view', 'edit' ),
+ 'properties' => array(
+ 'child' => array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'grand' => array(
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ ),
+ 'hidden' => array(
+ 'type' => 'string',
+ 'context' => array( 'edit' ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ array(
+ 'parent' => array(
+ 'child' => array(
+ 'grand' => 'hi',
+ 'hidden' => 'there',
+ ),
+ ),
+ ),
+ array(
+ 'parent' => array(
+ 'child' => array(
+ 'grand' => 'hi',
+ 'hidden' => 'there',
+ ),
+ ),
+ ),
+ ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>