<!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>[43740] branches/5.0: REST API: Slash existing meta values when comparing with incoming meta upates.</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/43740">43740</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/43740","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>kadamwhite</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-10-17 20:09:33 +0000 (Wed, 17 Oct 2018)</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: Slash existing meta values when comparing with incoming meta upates.
When comparing the old and new values for a meta key being set, ensure both values are sanitized using the same logic so that equal values match.
props boonebgorges, dcavins, MattGeri, pilou69, TimothyBlynJacobs.
Fixes <a href="https://core.trac.wordpress.org/ticket/42069">#42069</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches50srcwpincludesrestapifieldsclasswprestmetafieldsphp">branches/5.0/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php</a></li>
<li><a href="#branches50testsphpunittestsrestapirestpostmetafieldsphp">branches/5.0/tests/phpunit/tests/rest-api/rest-post-meta-fields.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches50srcwpincludesrestapifieldsclasswprestmetafieldsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php 2018-10-17 17:02:04 UTC (rev 43739)
+++ branches/5.0/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php 2018-10-17 20:09:33 UTC (rev 43740)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -295,19 +295,17 @@
</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">- $meta_key = wp_slash( $meta_key );
- $meta_value = wp_slash( $value );
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Do the exact same check for a duplicate value as in update_metadata() to avoid update_metadata() returning false.
</span><span class="cx" style="display: block; padding: 0 10px"> $old_value = get_metadata( $meta_type, $object_id, $meta_key );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $subtype = get_object_subtype( $meta_type, $object_id );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 1 === count( $old_value ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $old_value[0] === $meta_value ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( (string) sanitize_meta( $meta_key, $value, $meta_type, $subtype ) === $old_value[0] ) {
</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="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! update_metadata( $meta_type, $object_id, $meta_key, $meta_value ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! update_metadata( $meta_type, $object_id, wp_slash( $meta_key ), wp_slash( $value ) ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error(
</span><span class="cx" style="display: block; padding: 0 10px"> 'rest_meta_database_error',
</span><span class="cx" style="display: block; padding: 0 10px"> __( 'Could not update meta value in database.' ),
</span></span></pre></div>
<a id="branches50testsphpunittestsrestapirestpostmetafieldsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/tests/phpunit/tests/rest-api/rest-post-meta-fields.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/tests/phpunit/tests/rest-api/rest-post-meta-fields.php 2018-10-17 17:02:04 UTC (rev 43739)
+++ branches/5.0/tests/phpunit/tests/rest-api/rest-post-meta-fields.php 2018-10-17 20:09:33 UTC (rev 43740)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,7 +20,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'supports' => array( 'custom-fields' ),
</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">- self::$wp_meta_keys_saved = $GLOBALS['wp_meta_keys'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self::$wp_meta_keys_saved = isset( $GLOBALS['wp_meta_keys'] ) ? $GLOBALS['wp_meta_keys'] : array();
</ins><span class="cx" style="display: block; padding: 0 10px"> self::$post_id = $factory->post->create();
</span><span class="cx" style="display: block; padding: 0 10px"> self::$cpt_post_id = $factory->post->create( array( 'post_type' => 'cpt' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -130,6 +130,48 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'auth_callback' => '__return_false',
</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">+ register_meta(
+ 'post',
+ 'test_boolean_update',
+ array(
+ 'single' => true,
+ 'type' => 'boolean',
+ 'sanitize_callback' => 'absint',
+ 'show_in_rest' => true,
+ )
+ );
+
+ register_meta(
+ 'post',
+ 'test_textured_text_update',
+ array(
+ 'single' => true,
+ 'type' => 'string',
+ 'sanitize_callback' => 'sanitize_text_field',
+ 'show_in_rest' => true,
+ )
+ );
+
+ register_meta(
+ 'post',
+ 'test_json_encoded',
+ array(
+ 'single' => true,
+ 'type' => 'string',
+ 'show_in_rest' => true,
+ )
+ );
+
+ register_meta(
+ 'post',
+ 'test\'slashed\'key',
+ array(
+ 'single' => true,
+ 'type' => 'string',
+ 'show_in_rest' => true,
+ )
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /** @var WP_REST_Server $wp_rest_server */
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_rest_server;
</span><span class="cx" style="display: block; padding: 0 10px"> $this->server = $wp_rest_server = new Spy_REST_Server;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1162,6 +1204,56 @@
</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">+ * @ticket 42069
+ * @dataProvider data_update_value_return_success_with_same_value
+ */
+ public function test_update_value_return_success_with_same_value( $meta_key, $meta_value ) {
+ add_post_meta( self::$post_id, $meta_key, $meta_value );
+
+ $this->grant_write_permission();
+
+ $data = array(
+ 'meta' => array(
+ $meta_key => $meta_value,
+ ),
+ );
+
+ $request = new WP_REST_Request( 'POST', sprintf( '/wp/v2/posts/%d', self::$post_id ) );
+ $request->set_body_params( $data );
+
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertEquals( 200, $response->get_status() );
+ }
+
+ public function data_update_value_return_success_with_same_value() {
+ return array(
+ array( 'test_boolean_update', false ),
+ array( 'test_boolean_update', true ),
+ array( 'test_textured_text_update', 'She said, "What about the > 10,000 penguins in the kitchen?"' ),
+ array( 'test_textured_text_update', "He's about to do something rash..." ),
+ array( 'test_json_encoded', json_encode( array( 'foo' => 'bar' ) ) ),
+ array( 'test\'slashed\'key', 'Hello' ),
+ );
+ }
+
+ /**
+ * @ticket 42069
+ */
+ public function test_slashed_meta_key() {
+
+ add_post_meta( self::$post_id, 'test\'slashed\'key', 'Hello' );
+
+ $request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/posts/%d', self::$post_id ) );
+
+ $response = rest_get_server()->dispatch( $request );
+ $data = $response->get_data();
+
+ $this->assertArrayHasKey( 'test\'slashed\'key', $data['meta'] );
+ $this->assertEquals( 'Hello', $data['meta']['test\'slashed\'key'] );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Internal function used to disable an insert query which
</span><span class="cx" style="display: block; padding: 0 10px"> * will trigger a wpdb error for testing purposes.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>