<!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>[48498] trunk: REST API: Prevent attachment ID/image source mismatch when editing an image.</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/48498">48498</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/48498","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>azaozz</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-07-16 21:54:37 +0000 (Thu, 16 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: Prevent attachment ID/image source mismatch when editing an image.
Fixes <a href="https://core.trac.wordpress.org/ticket/50565">#50565</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestattachmentscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestattachmentscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php</a></li>
<li><a href="#trunktestsqunitfixtureswpapigeneratedjs">trunk/tests/qunit/fixtures/wp-api-generated.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestattachmentscontrollerphp"></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-attachments-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-attachments-controller.php 2020-07-16 21:42:48 UTC (rev 48497)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php 2020-07-16 21:54:37 UTC (rev 48498)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -421,7 +421,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $image_file = wp_get_original_image_path( $attachment_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $image_meta = wp_get_attachment_metadata( $attachment_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 ( ! $image_meta || ! $image_file ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (
+ ! $image_meta ||
+ ! $image_file ||
+ ! wp_image_file_matches_image_meta( $request['src'], $image_meta )
+ ) {
</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_unknown_attachment',
</span><span class="cx" style="display: block; padding: 0 10px"> __( 'Unable to get meta information for file.' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1289,6 +1293,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'minimum' => 0,
</span><span class="cx" style="display: block; padding: 0 10px"> 'maximum' => 100,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'src' => array(
+ 'description' => __( 'URL to the edited image file.' ),
+ 'type' => 'string',
+ 'format' => 'uri',
+ 'required' => true,
+ ),
</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">
</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-07-16 21:42:48 UTC (rev 48497)
+++ trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2020-07-16 21:54:37 UTC (rev 48498)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1798,9 +1798,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 44405
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_edit_image_returns_error_if_logged_out() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $attachment = self::factory()->attachment->create();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attachment = self::factory()->attachment->create_upload_object( $this->test_file );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'POST', "/wp/v2/media/{$attachment}/edit" );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request->set_body_params( array( 'src' => wp_get_attachment_image_url( $attachment, 'full' ) ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = rest_do_request( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_cannot_edit_image', $response, 401 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1813,9 +1814,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $user->add_cap( 'upload_files', false );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( $user->ID );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $attachment = self::factory()->attachment->create( array( 'post_author' => $user->ID ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attachment = self::factory()->attachment->create_upload_object( $this->test_file );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'POST', "/wp/v2/media/{$attachment}/edit" );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request->set_body_params( array( 'src' => wp_get_attachment_image_url( $attachment, 'full' ) ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = rest_do_request( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_cannot_edit_image', $response, 403 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1825,9 +1827,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_edit_image_returns_error_if_cannot_edit() {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( self::$uploader_id );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $attachment = self::factory()->attachment->create();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attachment = self::factory()->attachment->create_upload_object( $this->test_file );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'POST', "/wp/v2/media/{$attachment}/edit" );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request->set_body_params( array( 'src' => wp_get_attachment_image_url( $attachment, 'full' ) ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = rest_do_request( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_cannot_edit', $response, 403 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1840,6 +1843,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $attachment = self::factory()->attachment->create();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'POST', "/wp/v2/media/{$attachment}/edit" );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request->set_body_params( array( 'src' => '/wp-content/uploads/2020/07/canola.jpg' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = rest_do_request( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_unknown_attachment', $response, 404 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1858,6 +1862,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"> $request = new WP_REST_Request( 'POST', "/wp/v2/media/{$attachment}/edit" );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request->set_body_params( array( 'src' => wp_get_attachment_image_url( $attachment, 'full' ) ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = rest_do_request( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_cannot_edit_file_type', $response, 400 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1870,6 +1875,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $attachment = self::factory()->attachment->create_upload_object( $this->test_file );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'POST', "/wp/v2/media/{$attachment}/edit" );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request->set_body_params( array( 'src' => wp_get_attachment_image_url( $attachment, 'full' ) ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = rest_do_request( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_image_not_edited', $response, 400 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1884,8 +1890,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->setup_mock_editor();
</span><span class="cx" style="display: block; padding: 0 10px"> WP_Image_Editor_Mock::$edit_return['rotate'] = new WP_Error();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $params = array(
+ 'rotation' => 60,
+ 'src' => wp_get_attachment_image_url( $attachment, 'full' ),
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'POST', "/wp/v2/media/{$attachment}/edit" );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $request->set_body_params( array( 'rotation' => 60 ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request->set_body_params( $params );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = rest_do_request( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_image_rotation_failed', $response, 500 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1915,6 +1926,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'y' => 10,
</span><span class="cx" style="display: block; padding: 0 10px"> 'width' => 10,
</span><span class="cx" style="display: block; padding: 0 10px"> 'height' => 5,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'src' => wp_get_attachment_image_url( $attachment, 'full' ),
+
</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"> $response = rest_do_request( $request );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1934,8 +1947,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( self::$superadmin_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $attachment = self::factory()->attachment->create_upload_object( $this->test_file );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $params = array(
+ 'rotation' => 60,
+ 'src' => wp_get_attachment_image_url( $attachment, 'full' ),
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'POST', "/wp/v2/media/{$attachment}/edit" );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $request->set_body_params( array( 'rotation' => 60 ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request->set_body_params( $params );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = rest_do_request( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $item = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1949,6 +1967,41 @@
</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 50565
+ */
+ public function test_edit_image_returns_error_if_mismatched_src() {
+ wp_set_current_user( self::$superadmin_id );
+ $attachment_id_image1 = self::factory()->attachment->create_upload_object( $this->test_file );
+ $attachment_id_image2 = self::factory()->attachment->create_upload_object( $this->test_file2 );
+ $attachment_id_file = self::factory()->attachment->create();
+
+ // URL to the first uploaded image.
+ $image_src = wp_get_attachment_image_url( $attachment_id_image1, 'large' );
+
+ // Test: attachment ID points to a different, non-image attachment.
+ $request_1 = new WP_REST_Request( 'POST', "/wp/v2/media/{$attachment_id_file}/edit" );
+ $request_1->set_body_params( array( 'src' => $image_src ) );
+
+ $response_1 = rest_do_request( $request_1 );
+ $this->assertErrorResponse( 'rest_unknown_attachment', $response_1, 404 );
+
+ // Test: attachment ID points to a different image attachment.
+ $request_2 = new WP_REST_Request( 'POST', "/wp/v2/media/{$attachment_id_image2}/edit" );
+ $request_2->set_body_params( array( 'src' => $image_src ) );
+
+ $response_2 = rest_do_request( $request_2 );
+ $this->assertErrorResponse( 'rest_unknown_attachment', $response_2, 404 );
+
+ // Test: attachment src points to a sub-size of the image.
+ $request_3 = new WP_REST_Request( 'POST', "/wp/v2/media/{$attachment_id_image1}/edit" );
+ $request_3->set_body_params( array( 'src' => wp_get_attachment_image_url( $attachment_id_image1, 'medium' ) ) );
+
+ $response_3 = rest_do_request( $request_3 );
+ // 'rest_image_not_edited' as the file wasn't edited.
+ $this->assertErrorResponse( 'rest_image_not_edited', $response_3, 400 );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Sets up the mock image editor.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span></span></pre></div>
<a id="trunktestsqunitfixtureswpapigeneratedjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/fixtures/wp-api-generated.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/fixtures/wp-api-generated.js 2020-07-16 21:42:48 UTC (rev 48497)
+++ trunk/tests/qunit/fixtures/wp-api-generated.js 2020-07-16 21:54:37 UTC (rev 48498)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2377,6 +2377,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "required": false,
</span><span class="cx" style="display: block; padding: 0 10px"> "description": "As a percentage of the image, the height to crop the image to.",
</span><span class="cx" style="display: block; padding: 0 10px"> "type": "number"
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ },
+ "src": {
+ "required": true,
+ "description": "URL to the edited image file.",
+ "type": "string"
</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"> }
</span></span></pre>
</div>
</div>
</body>
</html>