<!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>[48300] trunk: REST API: Only validate the format keyword if the type is a string.</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/48300">48300</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/48300","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-07-04 19:51:10 +0000 (Sat, 04 Jul 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: Only validate the format keyword if the type is a string.
This allows for using multi-type support with a string that has a format. For backwards compatibility support, the format validation will still apply if the type is not specified, or it is invalid.
Two new doing it wrong notices are issued when omitting a type, or using an invalid type.
Props ryotsun.
Fixes <a href="https://core.trac.wordpress.org/ticket/50189">#50189</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiphp">trunk/src/wp-includes/rest-api.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestschemasanitizationphp">trunk/tests/phpunit/tests/rest-api/rest-schema-sanitization.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 2020-07-04 19:33:06 UTC (rev 48299)
+++ trunk/src/wp-includes/rest-api.php 2020-07-04 19:51:10 UTC (rev 48300)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1281,6 +1281,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return true|WP_Error
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function rest_validate_value_from_schema( $value, $args, $param = '' ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $allowed_types = array( 'array', 'object', 'string', 'number', 'integer', 'boolean', 'null' );
+
+ if ( ! isset( $args['type'] ) ) {
+ _doing_it_wrong( __FUNCTION__, __( 'The "type" schema keyword is required.' ), '5.5.0' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $args['type'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $args['type'] as $type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $type_args = $args;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1295,6 +1301,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, implode( ',', $args['type'] ) ) );
</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 ( ! in_array( $args['type'], $allowed_types, true ) ) {
+ _doing_it_wrong(
+ __FUNCTION__,
+ /* translators: 1. The list of allowed types. */
+ wp_sprintf( __( 'The "type" schema keyword can only be on of the built-in types: %l.' ), $allowed_types ),
+ '5.5.0'
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'array' === $args['type'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_null( $value ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $value = wp_parse_list( $value );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1449,7 +1464,9 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( isset( $args['format'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // The "format" keyword should only be applied to strings. However, for backwards compatibility,
+ // we allow the "format" keyword if the type keyword was not specified, or was set to an invalid value.
+ if ( isset( $args['format'] ) && ( ! isset( $args['type'] ) || 'string' === $args['type'] || ! in_array( $args['type'], $allowed_types, true ) ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> switch ( $args['format'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'hex-color':
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! rest_parse_hex_color( $value ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1538,6 +1555,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return true|WP_Error
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function rest_sanitize_value_from_schema( $value, $args ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $allowed_types = array( 'array', 'object', 'string', 'number', 'integer', 'boolean', 'null' );
+
+ if ( ! isset( $args['type'] ) ) {
+ _doing_it_wrong( __FUNCTION__, __( 'The "type" schema keyword is required.' ), '5.5.0' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $args['type'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Determine which type the value was validated against,
</span><span class="cx" style="display: block; padding: 0 10px"> // and use that type when performing sanitization.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1560,6 +1583,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $args['type'] = $validated_type;
</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 ( ! in_array( $args['type'], $allowed_types, true ) ) {
+ _doing_it_wrong(
+ __FUNCTION__,
+ /* translators: 1. The list of allowed types. */
+ wp_sprintf( __( 'The "type" schema keyword can only be on of the built-in types: %l.' ), $allowed_types ),
+ '5.5.0'
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'array' === $args['type'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $args['items'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return (array) $value;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1619,7 +1651,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return rest_sanitize_boolean( $value );
</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( $args['format'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // This behavior matches rest_validate_value_from_schema().
+ if ( isset( $args['format'] ) && ( ! isset( $args['type'] ) || 'string' === $args['type'] || ! in_array( $args['type'], $allowed_types, true ) ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> switch ( $args['format'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'hex-color':
</span><span class="cx" style="display: block; padding: 0 10px"> return (string) sanitize_hex_color( $value );
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestschemasanitizationphp"></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-sanitization.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-sanitization.php 2020-07-04 19:33:06 UTC (rev 48299)
+++ trunk/tests/phpunit/tests/rest-api/rest-schema-sanitization.php 2020-07-04 19:51:10 UTC (rev 48300)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -312,6 +312,8 @@
</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"> public function test_type_unknown() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->setExpectedIncorrectUsage( 'rest_sanitize_value_from_schema' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $schema = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'lalala',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -321,6 +323,8 @@
</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"> public function test_no_type() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->setExpectedIncorrectUsage( 'rest_sanitize_value_from_schema' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $schema = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => null,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -340,6 +344,44 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNull( rest_sanitize_value_from_schema( 'lalala', $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 50189
+ */
+ public function test_format_validation_is_skipped_if_non_string_type() {
+ $schema = array(
+ 'type' => 'array',
+ 'format' => 'hex-color',
+ );
+ $this->assertEquals( array( '#fff' ), rest_sanitize_value_from_schema( '#fff', $schema ) );
+ $this->assertEquals( array( '#qrst' ), rest_sanitize_value_from_schema( '#qrst', $schema ) );
+ }
+
+ /**
+ * @ticket 50189
+ */
+ public function test_format_validation_is_applied_if_missing_type() {
+ $this->expectException( 'PHPUnit_Framework_Error_Notice' ); // For the undefined index.
+ $this->setExpectedIncorrectUsage( 'rest_sanitize_value_from_schema' );
+
+ $schema = array( 'format' => 'hex-color' );
+ $this->assertEquals( '#abc', rest_sanitize_value_from_schema( '#abc', $schema ) );
+ $this->assertEquals( '', rest_sanitize_value_from_schema( '#jkl', $schema ) );
+ }
+
+ /**
+ * @ticket 50189
+ */
+ public function test_format_validation_is_applied_if_unknown_type() {
+ $this->setExpectedIncorrectUsage( 'rest_sanitize_value_from_schema' );
+
+ $schema = array(
+ 'format' => 'hex-color',
+ 'type' => 'str',
+ );
+ $this->assertEquals( '#abc', rest_sanitize_value_from_schema( '#abc', $schema ) );
+ $this->assertEquals( '', rest_sanitize_value_from_schema( '#jkl', $schema ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_object_or_string() {
</span><span class="cx" style="display: block; padding: 0 10px"> $schema = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => array( 'object', 'string' ),
</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 2020-07-04 19:33:06 UTC (rev 48299)
+++ trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php 2020-07-04 19:51:10 UTC (rev 48300)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -137,6 +137,47 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertWPError( rest_validate_value_from_schema( 'FF01::101::2', $schema ) ); // Multicast, compressed.
</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 50189
+ */
+ public function test_format_validation_is_skipped_if_non_string_type() {
+ $schema = array(
+ 'type' => 'array',
+ 'items' => array(
+ 'type' => 'string',
+ ),
+ 'format' => 'email',
+ );
+ $this->assertTrue( rest_validate_value_from_schema( 'email@example.com', $schema ) );
+ $this->assertTrue( rest_validate_value_from_schema( 'email', $schema ) );
+ }
+
+ /**
+ * @ticket 50189
+ */
+ public function test_format_validation_is_applied_if_missing_type() {
+ $this->expectException( 'PHPUnit_Framework_Error_Notice' ); // For the undefined index.
+ $this->setExpectedIncorrectUsage( 'rest_validate_value_from_schema' );
+
+ $schema = array( 'format' => 'email' );
+ $this->assertTrue( rest_validate_value_from_schema( 'email@example.com', $schema ) );
+ $this->assertWPError( rest_validate_value_from_schema( 'email', $schema ) );
+ }
+
+ /**
+ * @ticket 50189
+ */
+ public function test_format_validation_is_applied_if_unknown_type() {
+ $this->setExpectedIncorrectUsage( 'rest_validate_value_from_schema' );
+
+ $schema = array(
+ 'format' => 'email',
+ 'type' => 'str',
+ );
+ $this->assertTrue( rest_validate_value_from_schema( 'email@example.com', $schema ) );
+ $this->assertWPError( rest_validate_value_from_schema( 'email', $schema ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_type_array() {
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -322,6 +363,8 @@
</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"> public function test_type_unknown() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->setExpectedIncorrectUsage( 'rest_validate_value_from_schema' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $schema = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'lalala',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span></span></pre>
</div>
</div>
</body>
</html>