<!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>[48329] trunk: Media:</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/48329">48329</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/48329","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-05 23:30:36 +0000 (Sun, 05 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'>Media:
- Introduce `wp_image_file_matches_image_meta()` utility function to check whether the image meta (retrieved by attachment ID) matches an image path or URI. A mismatch may happen in some cases, for example after the posts have been exported from one website and imported in another.
- Add unit tests for the new function.
- Improve `wp_image_src_get_dimensions()` a bit and use the new function to prevent these edge cases.
Fixes <a href="https://core.trac.wordpress.org/ticket/50543">#50543</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmediaphp">trunk/src/wp-includes/media.php</a></li>
<li><a href="#trunktestsphpunittestsmediaphp">trunk/tests/phpunit/tests/media.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesmediaphp"></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/media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/media.php 2020-07-05 21:32:26 UTC (rev 48328)
+++ trunk/src/wp-includes/media.php 2020-07-05 23:30:36 UTC (rev 48329)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1498,6 +1498,65 @@
</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">+ * Determines if the image meta data is for the image source file.
+ *
+ * The image meta data is retrieved by attachment post ID. In some cases the post IDs may change.
+ * For example when the website is exported and imported at another website. Then the
+ * attachment post IDs that are in post_content for the exported website may not match
+ * the same attachments at the new website.
+ *
+ * @since 5.5.0
+ *
+ * @param string $image_location The full path or URI to the image file.
+ * @param array $image_meta The attachment meta data as returned by 'wp_get_attachment_metadata()'.
+ * @return bool Whether the image meta is for this image file.
+ */
+function wp_image_file_matches_image_meta( $image_location, $image_meta ) {
+ $match = false;
+
+ // Ensure the $image_meta is valid.
+ if ( isset( $image_meta['file'] ) && strlen( $image_meta['file'] ) > 4 ) {
+ // Remove quiery args if image URI.
+ list( $image_location ) = explode( '?', $image_location );
+
+ // Check if the relative image path from the image meta is at the end of $image_location.
+ if ( strrpos( $image_location, $image_meta['file'] ) === strlen( $image_location ) - strlen( $image_meta['file'] ) ) {
+ $match = true;
+ }
+
+ if ( ! empty( $image_meta['sizes'] ) ) {
+ // Retrieve the uploads sub-directory from the full size image.
+ $dirname = _wp_get_attachment_relative_path( $image_meta['file'] );
+
+ if ( $dirname ) {
+ $dirname = trailingslashit( $dirname );
+ }
+
+ foreach ( $image_meta['sizes'] as $image_size_data ) {
+ $relative_path = $dirname . $image_size_data['file'];
+
+ if ( strrpos( $image_location, $relative_path ) === strlen( $image_location ) - strlen( $relative_path ) ) {
+ $match = true;
+ break;
+ }
+ }
+ }
+ }
+
+ /**
+ * Filter whether an image path or URI matches image meta.
+ *
+ * @since 5.5.0
+ *
+ * @param bool $match Whether the image relative path from the image meta
+ * matches the end of the URI or path to the image file.
+ * @param string $image_location Full path or URI to the tested image file.
+ * @param array $image_meta The image meta data being tested.
+ */
+ return apply_filters( 'wp_image_file_matches_image_meta', $match, $image_location, $image_meta );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Determines an image's width and height dimensions based on the source file.
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1508,9 +1567,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * or false if dimensions cannot be determined.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_image_src_get_dimensions( $image_src, $image_meta ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $image_filename = wp_basename( $image_src );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! wp_image_file_matches_image_meta( $image_src, $image_meta ) ) {
+ return false;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( wp_basename( $image_meta['file'] ) === $image_filename ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Is it a full size image?
+ if ( strpos( $image_src, $image_meta['file'] ) !== false ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><span class="cx" style="display: block; padding: 0 10px"> (int) $image_meta['width'],
</span><span class="cx" style="display: block; padding: 0 10px"> (int) $image_meta['height'],
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1517,12 +1579,16 @@
</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">- foreach ( $image_meta['sizes'] as $image_size_data ) {
- if ( $image_filename === $image_size_data['file'] ) {
- return array(
- (int) $image_size_data['width'],
- (int) $image_size_data['height'],
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $image_meta['sizes'] ) ) {
+ $src_filename = wp_basename( $image_src );
+
+ foreach ( $image_meta['sizes'] as $image_size_data ) {
+ if ( $src_filename === $image_size_data['file'] ) {
+ return array(
+ (int) $image_size_data['width'],
+ (int) $image_size_data['height'],
+ );
+ }
</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="trunktestsphpunittestsmediaphp"></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/media.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/media.php 2020-07-05 21:32:26 UTC (rev 48328)
+++ trunk/tests/phpunit/tests/media.php 2020-07-05 23:30:36 UTC (rev 48329)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2808,6 +2808,49 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'arbitrary context => true' => array( 'something_completely_arbitrary', true ),
</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 50543
+ */
+ function test_wp_image_file_matches_image_meta() {
+ $image_meta = wp_get_attachment_metadata( self::$large_id );
+ $image_src_full = wp_get_attachment_image_url( self::$large_id, 'full' );
+ $image_src_medium = wp_get_attachment_image_url( self::$large_id, 'medium' );
+
+ $this->assertTrue( wp_image_file_matches_image_meta( $image_src_full, $image_meta ) );
+ $this->assertTrue( wp_image_file_matches_image_meta( $image_src_medium, $image_meta ) );
+ }
+
+ /**
+ * @ticket 50543
+ */
+ function test_wp_image_file_matches_image_meta_no_subsizes() {
+ $image_meta = wp_get_attachment_metadata( self::$large_id );
+ $image_src = wp_get_attachment_image_url( self::$large_id, 'full' );
+ $image_meta['sizes'] = array();
+
+ $this->assertTrue( wp_image_file_matches_image_meta( $image_src, $image_meta ) );
+ }
+
+ /**
+ * @ticket 50543
+ */
+ function test_wp_image_file_matches_image_meta_invalid_meta() {
+ $image_meta = ''; // Attachment is not an image.
+ $image_src = $this->img_url;
+
+ $this->assertFalse( wp_image_file_matches_image_meta( $image_src, $image_meta ) );
+ }
+
+ /**
+ * @ticket 50543
+ */
+ function test_wp_image_file_matches_image_meta_different_meta() {
+ $image_meta = wp_get_attachment_metadata( self::$large_id );
+ $image_src = $this->img_url; // Different image.
+
+ $this->assertFalse( wp_image_file_matches_image_meta( $image_src, $image_meta ) );
+ }
</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>