<!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>[49302] trunk: REST API: Don't validate status if it hasn't changed.</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/49302">49302</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/49302","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-10-24 16:02:34 +0000 (Sat, 24 Oct 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: Don't validate status if it hasn't changed.
In particular, this allows for sending `status=inherit` to an attachment if it's current status is `inherit`. This status would be rejected because it is an "internal" post status which isn't exposed.
As a general rule, a developer should always be able to PUT back a GET response without error.
Props dfenton, pputzer, TimothyBlynJacobs.
Fixes <a href="https://core.trac.wordpress.org/ticket/40399">#40399</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestattachmentscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp"></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-posts-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-posts-controller.php 2020-10-24 14:10:26 UTC (rev 49301)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2020-10-24 16:02:34 UTC (rev 49302)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1052,7 +1052,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return stdClass|WP_Error Post object or WP_Error.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function prepare_item_for_database( $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $prepared_post = new stdClass();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $prepared_post = new stdClass();
+ $current_status = '';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Post ID.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $request['id'] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1062,6 +1063,7 @@
</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"> $prepared_post->ID = $existing_post->ID;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $current_status = $existing_post->post_status;
</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"> $schema = $this->get_item_schema();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1105,7 +1107,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $post_type = get_post_type_object( $prepared_post->post_type );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Post status.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $schema['properties']['status'] ) && isset( $request['status'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (
+ ! empty( $schema['properties']['status'] ) &&
+ isset( $request['status'] ) &&
+ ( ! $current_status || $current_status !== $request['status'] )
+ ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $status = $this->handle_status_param( $request['status'], $post_type );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $status ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1256,6 +1262,32 @@
</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 whether the status is valid for the given post.
+ *
+ * Allows for sending an update request with the current status, even if that status would not be acceptable.
+ *
+ * @since 5.6.0
+ *
+ * @param string $status The provided status.
+ * @param WP_REST_Request $request The request object.
+ * @param string $param The parameter name.
+ * @return true|WP_Error True if the status is valid, or WP_Error if not.
+ */
+ public function check_status( $status, $request, $param ) {
+ if ( $request['id'] ) {
+ $post = $this->get_post( $request['id'] );
+
+ if ( ! is_wp_error( $post ) && $post->post_status === $status ) {
+ return true;
+ }
+ }
+
+ $args = $request->get_attributes()['args'][ $param ];
+
+ return rest_validate_value_from_schema( $status, $args, $param );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Determines validity and normalizes the given status parameter.
</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="lines" style="display: block; padding: 0 10px; color: #888">@@ -2115,6 +2147,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</span><span class="cx" style="display: block; padding: 0 10px"> 'enum' => array_keys( get_post_stati( array( 'internal' => false ) ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'view', 'edit' ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'arg_options' => array(
+ 'validate_callback' => array( $this, 'check_status' ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'Type of Post for the object.' ),
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestattachmentscontrollerphp"></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-attachments-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-attachments-controller.php 2020-10-24 14:10:26 UTC (rev 49301)
+++ trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2020-10-24 16:02:34 UTC (rev 49302)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1007,6 +1007,53 @@
</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">+ /**
+ * @ticket 40399
+ */
+ public function test_update_item_with_existing_inherit_status() {
+ wp_set_current_user( self::$editor_id );
+ $parent_id = self::factory()->post->create( array() );
+ $attachment_id = self::factory()->attachment->create_object(
+ $this->test_file,
+ $parent_id,
+ array(
+ 'post_mime_type' => 'image/jpeg',
+ 'post_excerpt' => 'A sample caption',
+ 'post_author' => self::$editor_id,
+ )
+ );
+
+ $request = new WP_REST_Request( 'POST', '/wp/v2/media/' . $attachment_id );
+ $request->set_param( 'status', 'inherit' );
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertNotWPError( $response->as_error() );
+ $this->assertEquals( 'inherit', $response->get_data()['status'] );
+ }
+
+ /**
+ * @ticket 40399
+ */
+ public function test_update_item_with_new_inherit_status() {
+ wp_set_current_user( self::$editor_id );
+ $attachment_id = self::factory()->attachment->create_object(
+ $this->test_file,
+ 0,
+ array(
+ 'post_mime_type' => 'image/jpeg',
+ 'post_excerpt' => 'A sample caption',
+ 'post_author' => self::$editor_id,
+ 'post_status' => 'private',
+ )
+ );
+
+ $request = new WP_REST_Request( 'POST', '/wp/v2/media/' . $attachment_id );
+ $request->set_param( 'status', 'inherit' );
+ $response = rest_get_server()->dispatch( $request );
+
+ $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function verify_attachment_roundtrip( $input = array(), $expected_output = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Create the post.
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'POST', '/wp/v2/media' );
</span></span></pre>
</div>
</div>
</body>
</html>