<!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>[57267] trunk: Media: Fix handling of multibyte exif description metadata.</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/57267">57267</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/57267","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>joedolson</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-01-10 21:57:50 +0000 (Wed, 10 Jan 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: Fix handling of multibyte exif description metadata.
The exif standards expect the UserComment field to be used as a substitute for ImageDescription if multibyte characters are needed. WordPress media only mapped the ImageDescription field and did not correctly handle descriptions with multibyte characters.
Fix metadata saving to better handle media with multibyte characters in metadata and update unit tests.
Props fotodrachen, antpb, joedolson, mikinc860, azaozz, nicolefurlan.
Fixes <a href="https://core.trac.wordpress.org/ticket/58082">#58082</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesimagephp">trunk/src/wp-admin/includes/image.php</a></li>
<li><a href="#trunktestsphpunittestsimagemetaphp">trunk/tests/phpunit/tests/image/meta.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesimagephp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/image.php 2024-01-10 21:12:07 UTC (rev 57266)
+++ trunk/src/wp-admin/includes/image.php 2024-01-10 21:57:50 UTC (rev 57267)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -863,23 +863,52 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $exif = array();
</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">+ $exif_description = '';
+ $exif_usercomment = '';
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $exif['ImageDescription'] ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $exif_description = trim( $exif['ImageDescription'] );
+ }
+
+ if ( ! empty( $exif['COMPUTED']['UserComment'] ) ) {
+ $exif_usercomment = trim( $exif['COMPUTED']['UserComment'] );
+ }
+
+ if ( $exif_description ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> mbstring_binary_safe_encoding();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $description_length = strlen( $exif['ImageDescription'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $description_length = strlen( $exif_description );
</ins><span class="cx" style="display: block; padding: 0 10px"> reset_mbstring_encoding();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $meta['title'] ) && $description_length < 80 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Assume the title is stored in ImageDescription.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $meta['title'] = trim( $exif['ImageDescription'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $meta['title'] = $exif_description;
</ins><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">- if ( empty( $meta['caption'] ) && ! empty( $exif['COMPUTED']['UserComment'] ) ) {
- $meta['caption'] = trim( $exif['COMPUTED']['UserComment'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If both user comments and description are present.
+ if ( empty( $meta['caption'] ) && $exif_description && $exif_usercomment ) {
+ if ( ! empty( $meta['title'] ) && $exif_description === $meta['title'] ) {
+ $caption = $exif_usercomment;
+ } else {
+ if ( $exif_description === $exif_usercomment ) {
+ $caption = $exif_description;
+ } else {
+ $caption = trim( $exif_description . ' ' . $exif_usercomment );
+ }
+ }
+ $meta['caption'] = $caption;
</ins><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">+ if ( empty( $meta['caption'] ) && $exif_usercomment ) {
+ $meta['caption'] = $exif_usercomment;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $meta['caption'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $meta['caption'] = trim( $exif['ImageDescription'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $meta['caption'] = $exif_description;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( empty( $meta['caption'] ) && $exif_usercomment ) {
+ $meta['caption'] = $exif_usercomment;
+ $description_length = strlen( $exif_usercomment );
+ if ( empty( $meta['title'] ) && $description_length < 80 ) {
+ $meta['title'] = trim( $exif_usercomment );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( empty( $meta['caption'] ) && ! empty( $exif['Comments'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $meta['caption'] = trim( $exif['Comments'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsimagemetaphp"></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/image/meta.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/image/meta.php 2024-01-10 21:12:07 UTC (rev 57266)
+++ trunk/tests/phpunit/tests/image/meta.php 2024-01-10 21:57:50 UTC (rev 57267)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -51,13 +51,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( '0', $out['aperture'], 'Aperture value not the same' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( '', $out['credit'], 'Credit value not the same' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'NIKON D70', $out['camera'], 'Camera value not the same' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( '', $out['caption'], 'Caption value not the same' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 'Copyright Alex Shiels', $out['caption'], 'Caption value not the same' );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( strtotime( '2007-06-17 21:18:00' ), $out['created_timestamp'], 'Timestamp value not equivalent' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( '', $out['copyright'], 'Copyright value not the same' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 0, $out['focal_length'], 'Focal length value not equivalent' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 0, $out['iso'], 'Iso value not equivalent' ); // Interesting - a Nikon bug?
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 1 / 500, $out['shutter_speed'], 'Shutter speed value not equivalent' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( '', $out['title'], 'Title value not the same' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 'Copyright Alex Shiels', $out['title'], 'Title value not the same' );
</ins><span class="cx" style="display: block; padding: 0 10px"> // $this->assertSame( array( 'Flowers' ), $out['keywords'] );
</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>