<!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>[54130] trunk: Autosave/REST API: Block autosaving from overwriting changes when locked from editing.</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/54130">54130</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/54130","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>antpb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-09-11 22:33:29 +0000 (Sun, 11 Sep 2022)</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'>Autosave/REST API: Block autosaving from overwriting changes when locked from editing.
Previously when a user was locked from editing a post in the block editor, autosave functionality was allowed to overwrite changes made by the editor that has taken control. This patch honors the lock status keeping autosave from conflicitng with other content editors.
Props jhart35, adamsilverstein, sathyapulse, chanthaboune, primetimejas, joemcgill, kadamwhite.
Fixes <a href="https://core.trac.wordpress.org/ticket/55659">#55659</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestautosavescontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestautosavescontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-autosaves-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestautosavescontrollerphp"></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-autosaves-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-autosaves-controller.php 2022-09-11 22:23:48 UTC (rev 54129)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php 2022-09-11 22:33:29 UTC (rev 54130)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -220,7 +220,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_post->ID = $post->ID;
</span><span class="cx" style="display: block; padding: 0 10px"> $user_id = get_current_user_id();
</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 ( ( 'draft' === $post->post_status || 'auto-draft' === $post->post_status ) && $post->post_author == $user_id ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // We need to check post lock to ensure the original author didn't leave their browser tab open.
+ if ( ! function_exists( 'wp_check_post_lock' ) ) {
+ require_once ABSPATH . 'wp-admin/includes/post.php';
+ }
+
+ $post_lock = wp_check_post_lock( $post->ID );
+ $is_draft = 'draft' === $post->post_status || 'auto-draft' === $post->post_status;
+
+ if ( $is_draft && (int) $post->post_author === $user_id && ! $post_lock ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> // Draft posts for the same author: autosaving updates the post and does not create a revision.
</span><span class="cx" style="display: block; padding: 0 10px"> // Convert the post object to an array and add slashes, wp_update_post() expects escaped array.
</span><span class="cx" style="display: block; padding: 0 10px"> $autosave_id = wp_update_post( wp_slash( (array) $prepared_post ), true );
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestautosavescontrollerphp"></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-autosaves-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-autosaves-controller.php 2022-09-11 22:23:48 UTC (rev 54129)
+++ trunk/tests/phpunit/tests/rest-api/rest-autosaves-controller.php 2022-09-11 22:33:29 UTC (rev 54130)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -607,4 +607,71 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_get_server()->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotEquals( 'garbage', get_post( self::$draft_page_id )->comment_status );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Test ensuring that autosave from the original author doesn't overwrite changes after it has been taken over by a 2nd author.
+ *
+ * @ticket 55659
+ */
+ public function test_rest_autosave_draft_post_locked_to_different_author() {
+
+ // Create a post by the editor.
+ $post_data = array(
+ 'post_content' => 'Test post content',
+ 'post_title' => 'Test post title',
+ 'post_excerpt' => 'Test post excerpt',
+ 'post_author' => self::$editor_id,
+ 'post_status' => 'draft',
+ );
+ $post_id = wp_insert_post( $post_data );
+
+ // Set the post lock to the contributor, simulating a takeover of the post.
+ wp_set_current_user( self::$contributor_id );
+ wp_set_post_lock( $post_id );
+
+ // Update the post with new data from the contributor.
+ $updated_post_data = array(
+ 'ID' => $post_id,
+ 'post_content' => 'New post content from the contributor',
+ 'post_title' => 'New post title',
+ );
+ wp_update_post( $updated_post_data );
+
+ // Set the current user to the editor and initiate an autosave with some new data.
+ wp_set_current_user( self::$editor_id );
+ $autosave_data = array(
+ 'id' => $post_id,
+ 'content' => 'Updated post content',
+ 'excerpt' => 'A new excerpt to test',
+ 'title' => $post_data['post_title'],
+ );
+
+ // Initiate an autosave via the REST API as Gutenberg does.
+ $request = new WP_REST_Request( 'POST', '/wp/v2/posts/' . self::$post_id . '/autosaves' );
+ $request->add_header( 'content-type', 'application/json' );
+ $request->set_body( wp_json_encode( $autosave_data ) );
+
+ $response = rest_get_server()->dispatch( $request );
+ $new_data = $response->get_data();
+
+ // The current version of our test post.
+ $current_post = get_post( $post_id );
+
+ // The new data from the autosave should have its parent ID set to the original post ID.
+ $this->assertSame( $post_id, $new_data['parent'] );
+
+ // The post title and content should still be the updated versions from the contributor.
+ $this->assertSame( $current_post->post_title, $updated_post_data['post_title'] );
+ $this->assertSame( $current_post->post_content, $updated_post_data['post_content'] );
+
+ // The excerpt should have stayed the same.
+ $this->assertSame( $current_post->post_excerpt, $post_data['post_excerpt'] );
+
+ $autosave_post = wp_get_post_autosave( $post_id );
+
+ // Has changes.
+ $this->assertSame( $autosave_data['content'], $autosave_post->post_content );
+
+ wp_delete_post( $post_id );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>