<!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>[50010] trunk: REST API: Support type coercion when validating the `enum` JSON Schema keyword.</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/50010">50010</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/50010","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>2021-01-24 16:50:39 +0000 (Sun, 24 Jan 2021)</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 type coercion when validating the `enum` JSON Schema keyword.
Previously, the `enum` keyword was validated by perform a strict equality check. For `string` types this is generally ok, but it prevented using alternative types like `number` when rich type support isn't available.
Now the same level of type coercion/sanitization is applied when validating `enum` as all other validation checks. This means that a value of `"1"` will be accepted for an `enum` of `[ 0, 1 ]`. Additionally, `object` types now properly ignore key order when checking for equality.
Props yakimun.
Fixes <a href="https://core.trac.wordpress.org/ticket/51911">#51911</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiphp">trunk/src/wp-includes/rest-api.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestschemavalidationphp">trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2021-01-24 14:06:15 UTC (rev 50009)
+++ trunk/src/wp-includes/rest-api.php 2021-01-24 16:50:39 UTC (rev 50010)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1875,6 +1875,73 @@
</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 the equality of two values, following JSON Schema semantics.
+ *
+ * Property order is ignored for objects.
+ *
+ * Values must have been previously sanitized/coerced to their native types.
+ *
+ * @since 5.7.0
+ *
+ * @param mixed $value1 The first value to check.
+ * @param mixed $value2 The second value to check.
+ * @return bool True if the values are equal or false otherwise.
+ */
+function rest_are_values_equal( $value1, $value2 ) {
+ if ( is_array( $value1 ) && is_array( $value2 ) ) {
+ if ( count( $value1 ) !== count( $value2 ) ) {
+ return false;
+ }
+
+ foreach ( $value1 as $index => $value ) {
+ if ( ! array_key_exists( $index, $value2 ) || ! rest_are_values_equal( $value, $value2[ $index ] ) ) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ return $value1 === $value2;
+}
+
+/**
+ * Validates that the given value is a member of the JSON Schema "enum".
+ *
+ * @since 5.7.0
+ *
+ * @param mixed $value The value to validate.
+ * @param array $args The schema array to use.
+ * @param string $param The parameter name, used in error messages.
+ * @return true|WP_Error True if the "enum" contains the value or a WP_Error instance otherwise.
+ */
+function rest_validate_enum( $value, $args, $param ) {
+ $sanitized_value = rest_sanitize_value_from_schema( $value, $args, $param );
+ if ( is_wp_error( $sanitized_value ) ) {
+ return $sanitized_value;
+ }
+
+ foreach ( $args['enum'] as $enum_value ) {
+ if ( rest_are_values_equal( $sanitized_value, $enum_value ) ) {
+ return true;
+ }
+ }
+
+ $encoded_enum_values = array();
+ foreach ( $args['enum'] as $enum_value ) {
+ $encoded_enum_values[] = is_scalar( $enum_value ) ? $enum_value : wp_json_encode( $enum_value );
+ }
+
+ if ( count( $encoded_enum_values ) === 1 ) {
+ /* translators: 1: Parameter, 2: Valid values. */
+ return new WP_Error( 'rest_not_in_enum', wp_sprintf( __( '%1$s is not %2$s.' ), $param, $encoded_enum_values[0] ) );
+ }
+
+ /* translators: 1: Parameter, 2: List of valid values. */
+ return new WP_Error( 'rest_not_in_enum', wp_sprintf( __( '%1$s is not one of %2$l.' ), $param, $encoded_enum_values ) );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Get all valid JSON schema properties.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.6.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2153,13 +2220,6 @@
</span><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 ( ! empty( $args['enum'] ) ) {
- if ( ! in_array( $value, $args['enum'], true ) ) {
- /* translators: 1: Parameter, 2: List of valid values. */
- return new WP_Error( 'rest_not_in_enum', sprintf( __( '%1$s is not one of %2$s.' ), $param, implode( ', ', $args['enum'] ) ) );
- }
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( in_array( $args['type'], array( 'integer', 'number' ), true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_numeric( $value ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2234,6 +2294,13 @@
</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">+ if ( ! empty( $args['enum'] ) ) {
+ $enum_contains_value = rest_validate_enum( $value, $args, $param );
+ if ( is_wp_error( $enum_contains_value ) ) {
+ return $enum_contains_value;
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // The "format" keyword should only be applied to strings. However, for backward compatibility,
</span><span class="cx" style="display: block; padding: 0 10px"> // we allow the "format" keyword if the type keyword was not specified, or was set to an invalid value.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $args['format'] )
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestschemavalidationphp"></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-schema-validation.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php 2021-01-24 14:06:15 UTC (rev 50009)
+++ trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php 2021-01-24 16:50:39 UTC (rev 50010)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -248,6 +248,512 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( rest_validate_value_from_schema( '', $schema ) );
</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 51911
+ *
+ * @dataProvider data_different_types_of_value_and_enum_elements
+ *
+ * @param mixed $value
+ * @param array $args
+ * @param bool $expected
+ */
+ public function test_different_types_of_value_and_enum_elements( $value, $args, $expected ) {
+ $result = rest_validate_value_from_schema( $value, $args );
+ if ( $expected ) {
+ $this->assertTrue( $result );
+ } else {
+ $this->assertWPError( $result );
+ }
+ }
+
+ /**
+ * @return array
+ */
+ public function data_different_types_of_value_and_enum_elements() {
+ return array(
+ // enum with integers
+ array(
+ 0,
+ array(
+ 'type' => 'integer',
+ 'enum' => array( 0, 1 ),
+ ),
+ true,
+ ),
+ array(
+ 0.0,
+ array(
+ 'type' => 'integer',
+ 'enum' => array( 0, 1 ),
+ ),
+ true,
+ ),
+ array(
+ '0',
+ array(
+ 'type' => 'integer',
+ 'enum' => array( 0, 1 ),
+ ),
+ true,
+ ),
+ array(
+ 1,
+ array(
+ 'type' => 'integer',
+ 'enum' => array( 0, 1 ),
+ ),
+ true,
+ ),
+ array(
+ 1.0,
+ array(
+ 'type' => 'integer',
+ 'enum' => array( 0, 1 ),
+ ),
+ true,
+ ),
+ array(
+ '1',
+ array(
+ 'type' => 'integer',
+ 'enum' => array( 0, 1 ),
+ ),
+ true,
+ ),
+ array(
+ 2,
+ array(
+ 'type' => 'integer',
+ 'enum' => array( 0, 1 ),
+ ),
+ false,
+ ),
+ array(
+ 2.0,
+ array(
+ 'type' => 'integer',
+ 'enum' => array( 0, 1 ),
+ ),
+ false,
+ ),
+ array(
+ '2',
+ array(
+ 'type' => 'integer',
+ 'enum' => array( 0, 1 ),
+ ),
+ false,
+ ),
+
+ // enum with floats
+ array(
+ 0,
+ array(
+ 'type' => 'number',
+ 'enum' => array( 0.0, 1.0 ),
+ ),
+ true,
+ ),
+ array(
+ 0.0,
+ array(
+ 'type' => 'number',
+ 'enum' => array( 0.0, 1.0 ),
+ ),
+ true,
+ ),
+ array(
+ '0',
+ array(
+ 'type' => 'number',
+ 'enum' => array( 0.0, 1.0 ),
+ ),
+ true,
+ ),
+ array(
+ 1,
+ array(
+ 'type' => 'number',
+ 'enum' => array( 0.0, 1.0 ),
+ ),
+ true,
+ ),
+ array(
+ 1.0,
+ array(
+ 'type' => 'number',
+ 'enum' => array( 0.0, 1.0 ),
+ ),
+ true,
+ ),
+ array(
+ '1',
+ array(
+ 'type' => 'number',
+ 'enum' => array( 0.0, 1.0 ),
+ ),
+ true,
+ ),
+ array(
+ 2,
+ array(
+ 'type' => 'number',
+ 'enum' => array( 0.0, 1.0 ),
+ ),
+ false,
+ ),
+ array(
+ 2.0,
+ array(
+ 'type' => 'number',
+ 'enum' => array( 0.0, 1.0 ),
+ ),
+ false,
+ ),
+ array(
+ '2',
+ array(
+ 'type' => 'number',
+ 'enum' => array( 0.0, 1.0 ),
+ ),
+ false,
+ ),
+
+ // enum with booleans
+ array(
+ true,
+ array(
+ 'type' => 'boolean',
+ 'enum' => array( true ),
+ ),
+ true,
+ ),
+ array(
+ 1,
+ array(
+ 'type' => 'boolean',
+ 'enum' => array( true ),
+ ),
+ true,
+ ),
+ array(
+ 'true',
+ array(
+ 'type' => 'boolean',
+ 'enum' => array( true ),
+ ),
+ true,
+ ),
+ array(
+ false,
+ array(
+ 'type' => 'boolean',
+ 'enum' => array( true ),
+ ),
+ false,
+ ),
+ array(
+ 0,
+ array(
+ 'type' => 'boolean',
+ 'enum' => array( true ),
+ ),
+ false,
+ ),
+ array(
+ 'false',
+ array(
+ 'type' => 'boolean',
+ 'enum' => array( true ),
+ ),
+ false,
+ ),
+ array(
+ false,
+ array(
+ 'type' => 'boolean',
+ 'enum' => array( false ),
+ ),
+ true,
+ ),
+ array(
+ 0,
+ array(
+ 'type' => 'boolean',
+ 'enum' => array( false ),
+ ),
+ true,
+ ),
+ array(
+ 'false',
+ array(
+ 'type' => 'boolean',
+ 'enum' => array( false ),
+ ),
+ true,
+ ),
+ array(
+ true,
+ array(
+ 'type' => 'boolean',
+ 'enum' => array( false ),
+ ),
+ false,
+ ),
+ array(
+ 1,
+ array(
+ 'type' => 'boolean',
+ 'enum' => array( false ),
+ ),
+ false,
+ ),
+ array(
+ 'true',
+ array(
+ 'type' => 'boolean',
+ 'enum' => array( false ),
+ ),
+ false,
+ ),
+
+ // enum with arrays
+ array(
+ array( 0, 1 ),
+ array(
+ 'type' => 'array',
+ 'items' => array( 'type' => 'integer' ),
+ 'enum' => array( array( 0, 1 ), array( 1, 2 ) ),
+ ),
+ true,
+ ),
+ array(
+ array( '0', 1 ),
+ array(
+ 'type' => 'array',
+ 'items' => array( 'type' => 'integer' ),
+ 'enum' => array( array( 0, 1 ), array( 1, 2 ) ),
+ ),
+ true,
+ ),
+ array(
+ array( 0, '1' ),
+ array(
+ 'type' => 'array',
+ 'items' => array( 'type' => 'integer' ),
+ 'enum' => array( array( 0, 1 ), array( 1, 2 ) ),
+ ),
+ true,
+ ),
+ array(
+ array( '0', '1' ),
+ array(
+ 'type' => 'array',
+ 'items' => array( 'type' => 'integer' ),
+ 'enum' => array( array( 0, 1 ), array( 1, 2 ) ),
+ ),
+ true,
+ ),
+ array(
+ array( 1, 2 ),
+ array(
+ 'type' => 'array',
+ 'items' => array( 'type' => 'integer' ),
+ 'enum' => array( array( 0, 1 ), array( 1, 2 ) ),
+ ),
+ true,
+ ),
+ array(
+ array( 2, 3 ),
+ array(
+ 'type' => 'array',
+ 'items' => array( 'type' => 'integer' ),
+ 'enum' => array( array( 0, 1 ), array( 1, 2 ) ),
+ ),
+ false,
+ ),
+ array(
+ array( 1, 0 ),
+ array(
+ 'type' => 'array',
+ 'items' => array( 'type' => 'integer' ),
+ 'enum' => array( array( 0, 1 ), array( 1, 2 ) ),
+ ),
+ false,
+ ),
+
+ // enum with objects
+ array(
+ array(
+ 'a' => 1,
+ 'b' => 2,
+ ),
+ array(
+ 'type' => 'object',
+ 'additionalProperties' => array( 'type' => 'integer' ),
+ 'enum' => array(
+ array(
+ 'a' => 1,
+ 'b' => 2,
+ ),
+ array(
+ 'b' => 2,
+ 'c' => 3,
+ ),
+ ),
+ ),
+ true,
+ ),
+ array(
+ array(
+ 'a' => '1',
+ 'b' => 2,
+ ),
+ array(
+ 'type' => 'object',
+ 'additionalProperties' => array( 'type' => 'integer' ),
+ 'enum' => array(
+ array(
+ 'a' => 1,
+ 'b' => 2,
+ ),
+ array(
+ 'b' => 2,
+ 'c' => 3,
+ ),
+ ),
+ ),
+ true,
+ ),
+ array(
+ array(
+ 'a' => 1,
+ 'b' => '2',
+ ),
+ array(
+ 'type' => 'object',
+ 'additionalProperties' => array( 'type' => 'integer' ),
+ 'enum' => array(
+ array(
+ 'a' => 1,
+ 'b' => 2,
+ ),
+ array(
+ 'b' => 2,
+ 'c' => 3,
+ ),
+ ),
+ ),
+ true,
+ ),
+ array(
+ array(
+ 'a' => '1',
+ 'b' => '2',
+ ),
+ array(
+ 'type' => 'object',
+ 'additionalProperties' => array( 'type' => 'integer' ),
+ 'enum' => array(
+ array(
+ 'a' => 1,
+ 'b' => 2,
+ ),
+ array(
+ 'b' => 2,
+ 'c' => 3,
+ ),
+ ),
+ ),
+ true,
+ ),
+ array(
+ array(
+ 'b' => 2,
+ 'a' => 1,
+ ),
+ array(
+ 'type' => 'object',
+ 'additionalProperties' => array( 'type' => 'integer' ),
+ 'enum' => array(
+ array(
+ 'a' => 1,
+ 'b' => 2,
+ ),
+ array(
+ 'b' => 2,
+ 'c' => 3,
+ ),
+ ),
+ ),
+ true,
+ ),
+ array(
+ array(
+ 'b' => 2,
+ 'c' => 3,
+ ),
+ array(
+ 'type' => 'object',
+ 'additionalProperties' => array( 'type' => 'integer' ),
+ 'enum' => array(
+ array(
+ 'a' => 1,
+ 'b' => 2,
+ ),
+ array(
+ 'b' => 2,
+ 'c' => 3,
+ ),
+ ),
+ ),
+ true,
+ ),
+ array(
+ array(
+ 'a' => 1,
+ 'b' => 3,
+ ),
+ array(
+ 'type' => 'object',
+ 'additionalProperties' => array( 'type' => 'integer' ),
+ 'enum' => array(
+ array(
+ 'a' => 1,
+ 'b' => 2,
+ ),
+ array(
+ 'b' => 2,
+ 'c' => 3,
+ ),
+ ),
+ ),
+ false,
+ ),
+ array(
+ array(
+ 'c' => 3,
+ 'd' => 4,
+ ),
+ array(
+ 'type' => 'object',
+ 'additionalProperties' => array( 'type' => 'integer' ),
+ 'enum' => array(
+ array(
+ 'a' => 1,
+ 'b' => 2,
+ ),
+ array(
+ 'b' => 2,
+ 'c' => 3,
+ ),
+ ),
+ ),
+ false,
+ ),
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_type_array_is_associative() {
</span><span class="cx" style="display: block; padding: 0 10px"> $schema = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'array',
</span></span></pre>
</div>
</div>
</body>
</html>