<!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>[59202] trunk: Media: Update file size meta data when editing images.</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/59202">59202</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/59202","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-10-09 23:30:05 +0000 (Wed, 09 Oct 2024)</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'>Media: Update file size meta data when editing images.
Fixes an error in which the file size meta data retained the original upload's values follow a user editing the images in the media screen.
The original images' file sizes are now stored in the backup image data to allow for them to be restored when a user restores the original image.
Props ankit-k-gupta, antpb, audrasjb, chaion07, gauravsingh7, joedolson, oglekler, pls78, rajinsharwar, sayedulsayem, vertisoft.
Fixes <a href="https://core.trac.wordpress.org/ticket/59684">#59684</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesimageeditphp">trunk/src/wp-admin/includes/image-edit.php</a></li>
<li><a href="#trunktestsphpunittestsajaxwpAjaxImageEditorphp">trunk/tests/phpunit/tests/ajax/wpAjaxImageEditor.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesimageeditphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/image-edit.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/image-edit.php 2024-10-09 22:09:30 UTC (rev 59201)
+++ trunk/src/wp-admin/includes/image-edit.php 2024-10-09 23:30:05 UTC (rev 59202)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -826,9 +826,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( isset( $meta['width'], $meta['height'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $backup_sizes[ "full-$suffix" ] = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'width' => $meta['width'],
- 'height' => $meta['height'],
- 'file' => $parts['basename'],
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'width' => $meta['width'],
+ 'height' => $meta['height'],
+ 'filesize' => $meta['filesize'],
+ 'file' => $parts['basename'],
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -839,6 +840,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $meta['file'] = _wp_relative_upload_path( $restored_file );
</span><span class="cx" style="display: block; padding: 0 10px"> $meta['width'] = $data['width'];
</span><span class="cx" style="display: block; padding: 0 10px"> $meta['height'] = $data['height'];
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $data['filesize'] ) ) {
+ /*
+ * Restore the original filesize if it was backed up.
+ *
+ * See https://core.trac.wordpress.org/ticket/59684.
+ */
+ $meta['filesize'] = $data['filesize'];
+ }
</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"> foreach ( $default_sizes as $default_size ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -997,8 +1006,9 @@
</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">+ $saved_image = wp_save_image_file( $new_path, $img, $post->post_mime_type, $post_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> // Save the full-size file, also needed to create sub-sizes.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! wp_save_image_file( $new_path, $img, $post->post_mime_type, $post_id ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $saved_image ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $return->error = esc_js( __( 'Unable to save the image.' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> return $return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1018,9 +1028,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $tag ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $backup_sizes[ $tag ] = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'width' => $meta['width'],
- 'height' => $meta['height'],
- 'file' => $basename,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'width' => $meta['width'],
+ 'height' => $meta['height'],
+ 'filesize' => $meta['filesize'],
+ 'file' => $basename,
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1028,9 +1039,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $meta['file'] = _wp_relative_upload_path( $new_path );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $size = $img->get_size();
- $meta['width'] = $size['width'];
- $meta['height'] = $size['height'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $size = $img->get_size();
+ $meta['width'] = $size['width'];
+ $meta['height'] = $size['height'];
+ $meta['filesize'] = $saved_image['filesize'];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $success && ( 'nothumb' === $target || 'all' === $target ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $sizes = get_intermediate_image_sizes();
</span></span></pre></div>
<a id="trunktestsphpunittestsajaxwpAjaxImageEditorphp"></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/ajax/wpAjaxImageEditor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/ajax/wpAjaxImageEditor.php 2024-10-09 22:09:30 UTC (rev 59201)
+++ trunk/tests/phpunit/tests/ajax/wpAjaxImageEditor.php 2024-10-09 23:30:05 UTC (rev 59202)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -114,4 +114,84 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( array(), $files_that_should_not_exist );
</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">+
+ /**
+ * Ensure the filesize is updated after editing an image.
+ *
+ * Tests that the image meta data file size is updated after editing an image,
+ * this includes both the full size image and all the generated sizes.
+ *
+ * @ticket 59684
+ */
+ public function test_filesize_updated_after_editing_an_image() {
+ require_once ABSPATH . 'wp-admin/includes/image-edit.php';
+
+ $filename = DIR_TESTDATA . '/images/canola.jpg';
+ $contents = file_get_contents( $filename );
+
+ $upload = wp_upload_bits( wp_basename( $filename ), null, $contents );
+ $id = $this->_make_attachment( $upload );
+ $original_image_meta = wp_get_attachment_metadata( $id );
+
+ $_REQUEST['action'] = 'image-editor';
+ $_REQUEST['context'] = 'edit-attachment';
+ $_REQUEST['postid'] = $id;
+ $_REQUEST['target'] = 'all';
+ $_REQUEST['do'] = 'save';
+ $_REQUEST['history'] = '[{"c":{"x":5,"y":8,"w":289,"h":322}}]';
+
+ wp_save_image( $id );
+
+ $post_edit_meta = wp_get_attachment_metadata( $id );
+
+ $pre_file_sizes = array_combine( array_keys( $original_image_meta['sizes'] ), array_column( $original_image_meta['sizes'], 'filesize' ) );
+ $pre_file_sizes['full'] = $original_image_meta['filesize'];
+
+ $post_file_sizes = array_combine( array_keys( $post_edit_meta['sizes'] ), array_column( $post_edit_meta['sizes'], 'filesize' ) );
+ $post_file_sizes['full'] = $post_edit_meta['filesize'];
+
+ foreach ( $pre_file_sizes as $size => $size_filesize ) {
+ // These are asserted individually as each image size needs to be checked separately.
+ $this->assertNotSame( $size_filesize, $post_file_sizes[ $size ], "Filesize for $size should have changed after editing an image." );
+ }
+ }
+
+ /**
+ * Ensure the filesize is restored after restoring the original image.
+ *
+ * Tests that the image meta data file size is restored after restoring the original image,
+ * this includes both the full size image and all the generated sizes.
+ *
+ * @ticket 59684
+ */
+ public function test_filesize_restored_after_restoring_original_image() {
+ require_once ABSPATH . 'wp-admin/includes/image-edit.php';
+
+ $filename = DIR_TESTDATA . '/images/canola.jpg';
+ $contents = file_get_contents( $filename );
+
+ $upload = wp_upload_bits( wp_basename( $filename ), null, $contents );
+ $id = $this->_make_attachment( $upload );
+ $original_image_meta = wp_get_attachment_metadata( $id );
+
+ $_REQUEST['action'] = 'image-editor';
+ $_REQUEST['context'] = 'edit-attachment';
+ $_REQUEST['postid'] = $id;
+ $_REQUEST['target'] = 'all';
+ $_REQUEST['do'] = 'save';
+ $_REQUEST['history'] = '[{"c":{"x":5,"y":8,"w":289,"h":322}}]';
+
+ wp_save_image( $id );
+ wp_restore_image( $id );
+
+ $post_restore_meta = wp_get_attachment_metadata( $id );
+
+ $pre_file_sizes = array_combine( array_keys( $original_image_meta['sizes'] ), array_column( $original_image_meta['sizes'], 'filesize' ) );
+ $pre_file_sizes['full'] = $original_image_meta['filesize'];
+
+ $post_restore_file_sizes = array_combine( array_keys( $post_restore_meta['sizes'] ), array_column( $post_restore_meta['sizes'], 'filesize' ) );
+ $post_restore_file_sizes['full'] = $post_restore_meta['filesize'];
+
+ $this->assertSameSetsWithIndex( $pre_file_sizes, $post_restore_file_sizes, 'Filesize should have restored after restoring the original image.' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>