<!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>[46202] trunk/src: Media/Upload: rotate images on upload according to EXIF Orientation.</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/46202">46202</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/46202","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>2019-09-20 18:20:26 +0000 (Fri, 20 Sep 2019)</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/Upload: rotate images on upload according to EXIF Orientation.
Props msaggiorato, wpdavis, markoheijnen, dhuyvetter, msaggiorato, n7studios, triplejumper12, pbiron, mikeschroder, joemcgill, azaozz.
Fixes <a href="https://core.trac.wordpress.org/ticket/14459">#14459</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesimagephp">trunk/src/wp-admin/includes/image.php</a></li>
<li><a href="#trunksrcwpincludesclasswpimageeditorimagickphp">trunk/src/wp-includes/class-wp-image-editor-imagick.php</a></li>
<li><a href="#trunksrcwpincludesclasswpimageeditorphp">trunk/src/wp-includes/class-wp-image-editor.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 2019-09-20 17:43:13 UTC (rev 46201)
+++ trunk/src/wp-admin/includes/image.php 2019-09-20 18:20:26 UTC (rev 46202)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -159,6 +159,37 @@
</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">+ * Updates the attached file and image meta data when the original image was edited.
+ *
+ * @since 5.3.0
+ * @access private
+ *
+ * @param array $saved_data The data retirned from WP_Image_Editor after successfully saving an image.
+ * @param string $original_file Path to the original file.
+ * @param array $image_meta The image meta data.
+ * @param int $attachment_id The attachment post ID.
+ * @return array The updated image meta data.
+ */
+function _wp_image_meta_replace_original( $saved_data, $original_file, $image_meta, $attachment_id ) {
+ $new_file = $saved_data['path'];
+
+ // Update the attached file meta.
+ update_attached_file( $attachment_id, $new_file );
+
+ // Width and height of the new image.
+ $image_meta['width'] = $saved_data['width'];
+ $image_meta['height'] = $saved_data['height'];
+
+ // Make the file path relative to the upload dir.
+ $image_meta['file'] = _wp_relative_upload_path( $new_file );
+
+ // Store the original image file name in image_meta.
+ $image_meta['original_image'] = wp_basename( $original_file );
+
+ return $image_meta;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Creates image sub-sizes, adds the new data to the image meta `sizes` array, and updates the image metadata.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Intended for use after an image is uploaded. Saves/updates the image metadata after each
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -222,30 +253,58 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Resize the image
</span><span class="cx" style="display: block; padding: 0 10px"> $resized = $editor->resize( $threshold, $threshold );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $rotated = null;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If there is EXIF data, rotate according to EXIF Orientation.
+ if ( ! is_wp_error( $resized ) && is_array( $exif_meta ) ) {
+ $resized = $editor->maybe_exif_rotate();
+ $rotated = $resized;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_wp_error( $resized ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // TODO: EXIF rotate here.
- // By default the editor will append `{width}x{height}` to the file name of the resized image.
- // Better to append the threshold size instead so the image file name would be like "my-image-2560.jpg"
- // and not look like a "regular" sub-size.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Append the threshold size to the image file name. It will look like "my-image-2560.jpg".
</ins><span class="cx" style="display: block; padding: 0 10px"> // This doesn't affect the sub-sizes names as they are generated from the original image (for best quality).
</span><span class="cx" style="display: block; padding: 0 10px"> $saved = $editor->save( $editor->generate_filename( $threshold ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_wp_error( $saved ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $new_file = $saved['path'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $image_meta = _wp_image_meta_replace_original( $saved, $file, $image_meta, $attachment_id );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Update the attached file meta.
- update_attached_file( $attachment_id, $new_file );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If the image was rotated update the stored EXIF data.
+ if ( true === $rotated && ! empty( $image_meta['image_meta']['orientation'] ) ) {
+ $image_meta['image_meta']['orientation'] = 1;
+ }
+ } else {
+ // TODO: handle errors.
+ }
+ } else {
+ // TODO: handle errors.
+ }
+ } elseif ( ! empty( $exif_meta['orientation'] ) && (int) $exif_meta['orientation'] !== 1 ) {
+ // Rotate the whole original image if there is EXIF data and "orientation" is not 1.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Width and height of the new image.
- $image_meta['width'] = $saved['width'];
- $image_meta['height'] = $saved['height'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $editor = wp_get_image_editor( $file );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Make the file path relative to the upload dir.
- $image_meta['file'] = _wp_relative_upload_path( $new_file );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_wp_error( $editor ) ) {
+ // This image cannot be edited.
+ return $image_meta;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Store the original image file name in image_meta.
- $image_meta['original_image'] = wp_basename( $file );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Rotate the image
+ $rotated = $editor->maybe_exif_rotate();
+
+ if ( true === $rotated ) {
+ // Append `-rotated` to the image file name.
+ $saved = $editor->save( $editor->generate_filename( 'rotated' ) );
+
+ if ( ! is_wp_error( $saved ) ) {
+ $image_meta = _wp_image_meta_replace_original( $saved, $file, $image_meta, $attachment_id );
+
+ // Update the stored EXIF data.
+ if ( ! empty( $image_meta['image_meta']['orientation'] ) ) {
+ $image_meta['image_meta']['orientation'] = 1;
+ }
+ } else {
+ // TODO: handle errors.
</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">@@ -327,6 +386,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $image_meta;
</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">+ // If stored EXIF data exists, rotate the source image before creating sub-sizes.
+ if ( ! empty( $image_meta['image_meta'] ) ) {
+ $rotated = $editor->maybe_exif_rotate();
+
+ if ( is_wp_error( $rotated ) ) {
+ // TODO: handle errors.
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( method_exists( $editor, 'make_subsize' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $new_sizes as $new_size_name => $new_size_data ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $new_size_meta = $editor->make_subsize( $new_size_data );
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpimageeditorimagickphp"></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/class-wp-image-editor-imagick.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-image-editor-imagick.php 2019-09-20 17:43:13 UTC (rev 46201)
+++ trunk/src/wp-includes/class-wp-image-editor-imagick.php 2019-09-20 18:20:26 UTC (rev 46202)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -566,7 +566,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> try {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->image->rotateImage( new ImagickPixel( 'none' ), 360 - $angle );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Normalise Exif orientation data so that display is consistent across devices.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Normalise EXIF orientation data so that display is consistent across devices.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_callable( array( $this->image, 'setImageOrientation' ) ) && defined( 'Imagick::ORIENTATION_TOPLEFT' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->image->setImageOrientation( Imagick::ORIENTATION_TOPLEFT );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -602,13 +602,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $vert ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->image->flopImage();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Normalise EXIF orientation data so that display is consistent across devices.
+ if ( is_callable( array( $this->image, 'setImageOrientation' ) ) && defined( 'Imagick::ORIENTATION_TOPLEFT' ) ) {
+ $this->image->setImageOrientation( Imagick::ORIENTATION_TOPLEFT );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> } catch ( Exception $e ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'image_flip_error', $e->getMessage() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</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">+ * Check if a JPEG image has EXIF Orientation tag and rotate it if needed.
+ *
+ * As ImageMagick copies the EXIF data to the flipped/rotated image, proceed only
+ * if EXIF Orientation can be reset afterwards.
+ *
+ * @since 5.3.0
+ *
+ * @return bool|WP_Error True if the image was rotated. False if no EXIF data or if the image doesn't need rotation.
+ * WP_Error if error while rotating.
+ */
+ public function maybe_exif_rotate() {
+ if ( is_callable( array( $this->image, 'setImageOrientation' ) ) && defined( 'Imagick::ORIENTATION_TOPLEFT' ) ) {
+ return parent::maybe_exif_rotate();
+ } else {
+ return new WP_Error( 'write_exif_error', __( 'The image cannot be rotated because the embedded meta data cannot be updated.' ) );
+ }
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Saves current image to file.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.5.0
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpimageeditorphp"></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/class-wp-image-editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-image-editor.php 2019-09-20 17:43:13 UTC (rev 46201)
+++ trunk/src/wp-includes/class-wp-image-editor.php 2019-09-20 18:20:26 UTC (rev 46202)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -385,6 +385,84 @@
</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">+ * Check if a JPEG image has EXIF Orientation tag and rotate it if needed.
+ *
+ * @since 5.3.0
+ *
+ * @return bool|WP_Error True if the image was rotated. False if not rotated (no EXIF data or the image doesn't need to be rotated).
+ * WP_Error if error while rotating.
+ */
+ public function maybe_exif_rotate() {
+ $orientation = null;
+
+ if ( is_callable( 'exif_read_data' ) && 'image/jpeg' === $this->mime_type ) {
+ $exif_data = @exif_read_data( $this->file );
+
+ if ( ! empty( $exif_data['Orientation'] ) ) {
+ $orientation = (int) $exif_data['Orientation'];
+ }
+ }
+
+ /**
+ * Filters the `$orientation` value to correct it before rotating or to prevemnt rotating the image.
+ *
+ * @since 5.3.0
+ *
+ * @param int $orientation EXIF Orientation value as retrieved from the image file.
+ * @param string $file Path to the image file.
+ */
+ $orientation = apply_filters( 'wp_image_maybe_exif_rotate', $orientation, $this->file );
+
+ if ( ! $orientation || $orientation === 1 ) {
+ return false;
+ }
+
+ switch ( $orientation ) {
+ case 2:
+ // Flip horizontally.
+ $result = $this->flip( true, false );
+ break;
+ case 3:
+ // Rotate 180 degrees or flip horizontally and vertically.
+ // Flipping seems faster/uses less resources.
+ $result = $this->flip( true, true );
+ break;
+ case 4:
+ // Flip vertically.
+ $result = $this->flip( false, true );
+ break;
+ case 5:
+ // Rotate 90 degrees counter-clockwise and flip vertically.
+ $result = $this->rotate( 90 );
+
+ if ( ! is_wp_error( $result ) ) {
+ $result = $this->flip( false, true );
+ }
+
+ break;
+ case 6:
+ // Rotate 90 degrees clockwise (270 counter-clockwise).
+ $result = $this->rotate( 270 );
+ break;
+ case 7:
+ // Rotate 90 degrees counter-clockwise and flip horizontally.
+ $result = $this->rotate( 90 );
+
+ if ( ! is_wp_error( $result ) ) {
+ $result = $this->flip( true, false );
+ }
+
+ break;
+ case 8:
+ // Rotate 90 degrees counter-clockwise.
+ $result = $this->rotate( 90 );
+ break;
+ }
+
+ return $result;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Either calls editor's save function or handles file as a stream.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.5.0
</span></span></pre>
</div>
</div>
</body>
</html>