<!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>[38982] trunk: REST API: Return `WP_Error` when a client is attempting to update an option with a non-scalar value to `null`.</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/38982">38982</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/38982","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>rachelbaker</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-10-27 16:07:06 +0000 (Thu, 27 Oct 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: Return `WP_Error` when a client is attempting to update an option with a non-scalar value to `null`.
A `null` value is returned in the response for any option that has a non-scalar value.
To protect clients from accidentally including the `null` values from a response object in a request, we do not allow options with non-scalar values to be updated to `null`. Without this added protection a client could mistakenly delete all options that have non-scalar values from the database.
Props joehoyle, rachelbaker.
Fixes <a href="https://core.trac.wordpress.org/ticket/38527">#38527</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestsettingscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestsettingscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-settings-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestsettingscontrollerphp"></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-settings-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-settings-controller.php 2016-10-27 15:22:52 UTC (rev 38981)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php 2016-10-27 16:07:06 UTC (rev 38982)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -95,6 +95,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return mixed
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function prepare_value( $value, $schema ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If the value is not a scalar, it's not possible to cast it to
+ // anything.
+ if ( ! is_scalar( $value ) ) {
+ return null;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> switch ( $schema['type'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'string':
</span><span class="cx" style="display: block; padding: 0 10px"> return (string) $value;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -141,9 +147,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</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">- // A null value means reset the option, which is essentially deleting it
- // from the database and then relying on the default value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * A `null` value for an option would have the same effect as
+ * deleting the option from the database, and relying on the
+ * default value.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_null( $request[ $name ] ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * A `null` value is returned in the response for any option
+ * that has a non-scalar value.
+ *
+ * To protect clients from accidentally including the `null`
+ * values from a response object in a request, we do not allow
+ * options with non-scalar values to be updated to `null`.
+ * Without this added protection a client could mistakenly
+ * delete all options that have non-scalar values from the
+ * database.
+ */
+ if ( ! is_scalar( get_option( $args['option_name'], false ) ) ) {
+ return new WP_Error(
+ 'rest_invalid_stored_value', sprintf( __( 'The %s property has an invalid stored value, and cannot be updated to null.' ), $name ), array( 'status' => 500 )
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> delete_option( $args['option_name'] );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( $args['option_name'], $request[ $name ] );
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestsettingscontrollerphp"></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-settings-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-settings-controller.php 2016-10-27 15:22:52 UTC (rev 38981)
+++ trunk/tests/phpunit/tests/rest-api/rest-settings-controller.php 2016-10-27 16:07:06 UTC (rev 38982)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -159,6 +159,51 @@
</span><span class="cx" style="display: block; padding: 0 10px"> remove_all_filters( 'rest_pre_get_setting' );
</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 test_get_item_with_invalid_value_array_in_options() {
+ wp_set_current_user( self::$administrator );
+
+ register_setting( 'somegroup', 'mycustomsetting', array(
+ 'show_in_rest' => array(
+ 'name' => 'mycustomsettinginrest',
+ 'schema' => array(
+ 'enum' => array( 'validvalue1', 'validvalue2' ),
+ 'default' => 'validvalue1',
+ ),
+ ),
+ 'type' => 'string',
+ ) );
+
+ update_option( 'mycustomsetting', array( 'A sneaky array!' ) );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $this->assertEquals( null, $data['mycustomsettinginrest'] );
+ }
+
+ public function test_get_item_with_invalid_object_array_in_options() {
+ wp_set_current_user( self::$administrator );
+
+ register_setting( 'somegroup', 'mycustomsetting', array(
+ 'show_in_rest' => array(
+ 'name' => 'mycustomsettinginrest',
+ 'schema' => array(
+ 'enum' => array( 'validvalue1', 'validvalue2' ),
+ 'default' => 'validvalue1',
+ ),
+ ),
+ 'type' => 'string',
+ ) );
+
+ update_option( 'mycustomsetting', (object) array( 'A sneaky array!' ) );
+
+ $request = new WP_REST_Request( 'GET', '/wp/v2/settings' );
+ $response = $this->server->dispatch( $request );
+ $data = $response->get_data();
+ $this->assertEquals( null, $data['mycustomsettinginrest'] );
+ }
+
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_create_item() {
</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">@@ -248,6 +293,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_invalid_param', $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 test_update_item_with_invalid_stored_value_in_options() {
+ wp_set_current_user( self::$administrator );
+
+ register_setting( 'somegroup', 'mycustomsetting', array(
+ 'show_in_rest' => true,
+ 'type' => 'string',
+ ) );
+ update_option( 'mycustomsetting', array( 'A sneaky array!' ) );
+
+ wp_set_current_user( self::$administrator );
+ $request = new WP_REST_Request( 'PUT', '/wp/v2/settings' );
+ $request->set_param( 'mycustomsetting', null );
+ $response = $this->server->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_invalid_stored_value', $response, 500 );
+ }
+
</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"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>