<!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>[40130] trunk: Media: Keep PDF previews from overwriting files.</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 { 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/40130">40130</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/40130","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>joemcgill</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-02-27 15:38:30 +0000 (Mon, 27 Feb 2017)</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: Keep PDF previews from overwriting files.
Since support for PDF previews were added in <a href="https://core.trac.wordpress.org/changeset/38949">[38949]</a>, it's possible
that the generated image file could overwrite an existing image file
with the same name. This uses `wp_unique_filename()` to avoid this
issue and adds a '-pdf' identifier on the end of filenames.
Props gitlost, derosj, mikeschroder, joemcgill.
Fixes <a href="https://core.trac.wordpress.org/ticket/39875">#39875</a>. See <a href="https://core.trac.wordpress.org/ticket/31050">#31050</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesimagephp">trunk/src/wp-admin/includes/image.php</a></li>
<li><a href="#trunktestsphpunittestsimagefunctionsphp">trunk/tests/phpunit/tests/image/functions.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 2017-02-27 04:21:41 UTC (rev 40129)
+++ trunk/src/wp-admin/includes/image.php 2017-02-27 15:38:30 UTC (rev 40130)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -251,7 +251,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $editor = wp_get_image_editor( $file );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_wp_error( $editor ) ) { // No support for this type of file
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $uploaded = $editor->save( $file, 'image/jpeg' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * PDFs may have the same file filename as JPEGs.
+ * Ensure the PDF preview image does not overwrite any JPEG images that already exist.
+ */
+ $dirname = dirname( $file ) . '/';
+ $ext = '.' . pathinfo( $file, PATHINFO_EXTENSION );
+ $preview_file = $dirname . wp_unique_filename( $dirname, wp_basename( $file, $ext ) . '-pdf.jpg' );
+
+ $uploaded = $editor->save( $preview_file, 'image/jpeg' );
</ins><span class="cx" style="display: block; padding: 0 10px"> unset( $editor );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Resize based on the full size image, rather than the source.
</span></span></pre></div>
<a id="trunktestsphpunittestsimagefunctionsphp"></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/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/image/functions.php 2017-02-27 04:21:41 UTC (rev 40129)
+++ trunk/tests/phpunit/tests/image/functions.php 2017-02-27 15:38:30 UTC (rev 40130)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -18,6 +18,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require_once( ABSPATH . WPINC . '/class-wp-image-editor-imagick.php' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> include_once( DIR_TESTDATA . '/../includes/mock-image-editor.php' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Ensure no legacy / failed tests detritus.
+ $folder = '/tmp/wordpress-gsoc-flyer*.{jpg,pdf}';
+
+ foreach ( glob( $folder, GLOB_BRACE ) as $file ) {
+ unlink( $file );
+ }
</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">@@ -373,25 +380,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $expected = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'sizes' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'thumbnail' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'file' => "wordpress-gsoc-flyer-116x150.jpg",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'file' => "wordpress-gsoc-flyer-pdf-116x150.jpg",
</ins><span class="cx" style="display: block; padding: 0 10px"> 'width' => 116,
</span><span class="cx" style="display: block; padding: 0 10px"> 'height' => 150,
</span><span class="cx" style="display: block; padding: 0 10px"> 'mime-type' => "image/jpeg",
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'medium' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'file' => "wordpress-gsoc-flyer-232x300.jpg",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'file' => "wordpress-gsoc-flyer-pdf-232x300.jpg",
</ins><span class="cx" style="display: block; padding: 0 10px"> 'width' => 232,
</span><span class="cx" style="display: block; padding: 0 10px"> 'height' => 300,
</span><span class="cx" style="display: block; padding: 0 10px"> 'mime-type' => "image/jpeg",
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'large' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'file' => "wordpress-gsoc-flyer-791x1024.jpg",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'file' => "wordpress-gsoc-flyer-pdf-791x1024.jpg",
</ins><span class="cx" style="display: block; padding: 0 10px"> 'width' => 791,
</span><span class="cx" style="display: block; padding: 0 10px"> 'height' => 1024,
</span><span class="cx" style="display: block; padding: 0 10px"> 'mime-type' => "image/jpeg",
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'full' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'file' => "wordpress-gsoc-flyer.jpg",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'file' => "wordpress-gsoc-flyer-pdf.jpg",
</ins><span class="cx" style="display: block; padding: 0 10px"> 'width' => 1088,
</span><span class="cx" style="display: block; padding: 0 10px"> 'height' => 1408,
</span><span class="cx" style="display: block; padding: 0 10px"> 'mime-type' => "image/jpeg",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -403,6 +410,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $expected, $metadata );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> unlink( $test_file );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $metadata['sizes'] as $size ) {
+ unlink ( '/tmp/' . $size['file'] );
+ }
</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">@@ -427,7 +437,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'fallback_intermediate_image_sizes', array( $this, 'filter_fallback_intermediate_image_sizes' ), 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $expected = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'file' => 'wordpress-gsoc-flyer-77x100.jpg',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'file' => 'wordpress-gsoc-flyer-pdf-77x100.jpg',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'width' => 77,
</span><span class="cx" style="display: block; padding: 0 10px"> 'height' => 100,
</span><span class="cx" style="display: block; padding: 0 10px"> 'mime-type' => 'image/jpeg',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -441,6 +451,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'fallback_intermediate_image_sizes', array( $this, 'filter_fallback_intermediate_image_sizes' ), 10 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> unlink( $test_file );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $metadata['sizes'] as $size ) {
+ unlink ( '/tmp/' . $size['file'] );
+ }
</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"> function filter_fallback_intermediate_image_sizes( $fallback_sizes, $metadata ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -449,4 +462,44 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $fallback_sizes;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Test PDF preview doesn't overwrite existing JPEG.
+ * @ticket 39875
+ */
+ public function test_pdf_preview_doesnt_overwrite_existing_jpeg() {
+ // Dummy JPEGs.
+ $jpg1_path = '/tmp/test.jpg'; // Straight.
+ file_put_contents( $jpg1_path, 'asdf' );
+ $jpg2_path = '/tmp/test-pdf.jpg'; // With PDF marker.
+ file_put_contents( $jpg2_path, 'fdsa' );
+
+ // PDF with same name as JPEG.
+ $pdf_path = '/tmp/test.pdf';
+ copy( DIR_TESTDATA . '/images/wordpress-gsoc-flyer.pdf', $pdf_path );
+
+ $attachment_id = $this->factory->attachment->create_object( $pdf_path, 0, array(
+ 'post_mime_type' => 'application/pdf',
+ ) );
+
+ $metadata = wp_generate_attachment_metadata( $attachment_id, $pdf_path );
+ $preview_path = '/tmp/' . $metadata['sizes']['full']['file'];
+
+ // PDF preview didn't overwrite PDF.
+ $this->assertNotEquals( $pdf_path, $preview_path );
+ // PDF preview didn't overwrite JPG with same name.
+ $this->assertNotEquals( $jpg1_path, $preview_path );
+ $this->assertSame( 'asdf', file_get_contents( $jpg1_path ) );
+ // PDF preview didn't overwrite PDF preview with same name.
+ $this->assertNotEquals( $jpg2_path, $preview_path );
+ $this->assertSame( 'fdsa', file_get_contents( $jpg2_path ) );
+
+ // Cleanup.
+ unlink( $jpg1_path );
+ unlink( $jpg2_path );
+ unlink( $pdf_path );
+ foreach ( $metadata['sizes'] as $size ) {
+ unlink( '/tmp/' . $size['file'] );
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>