Changeset 40133

Timestamp:

02/27/2017 07:24:50 PM (8 years ago)

Author:

joemcgill

Message:

Media: Keep PDF previews from overwriting files.

Since support for PDF previews were added in [38949], 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, desrosj, mikeschroder, joemcgill.
Merges [40130] and [40131] to the 4.7 branch.
Fixes #39875. See #31050.

Location:

branches/4.7

Files:

• . (modified) (1 prop)
• src/wp-admin/includes/image.php (modified) (1 diff)
• tests/phpunit/tests/image/functions.php (modified) (9 diffs)

branches/4.7/src/wp-admin/includes/image.php

@@ -252 +252 @@
 
             if ( ! is_wp_error( $editor ) ) { // No support for this type of file
-                $uploaded = $editor->save( $file, 'image/jpeg' );
+                /*
+                 * 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' );
                 unset( $editor );
 

branches/4.7/tests/phpunit/tests/image/functions.php

@@ -19 +19 @@
 
         include_once( DIR_TESTDATA . '/../includes/mock-image-editor.php' );
+
+        // Ensure no legacy / failed tests detritus.
+        $folder = '/tmp/wordpress-gsoc-flyer*.{jpg,pdf}';
+
+        foreach ( glob( $folder, GLOB_BRACE ) as $file ) {
+            unlink( $file );
+        }
     }
 
@@ -374 +381 @@
             'sizes' => array(
                 'thumbnail' => array(
-                    'file'      => "wordpress-gsoc-flyer-116x150.jpg",
+                    'file'      => "wordpress-gsoc-flyer-pdf-116x150.jpg",
                     'width'     => 116,
                     'height'    => 150,
@@ -380 +387 @@
                 ),
                 'medium'    => array(
-                    'file'      => "wordpress-gsoc-flyer-232x300.jpg",
+                    'file'      => "wordpress-gsoc-flyer-pdf-232x300.jpg",
                     'width'     => 232,
                     'height'    => 300,
@@ -386 +393 @@
                 ),
                 'large'     => array(
-                    'file'      => "wordpress-gsoc-flyer-791x1024.jpg",
+                    'file'      => "wordpress-gsoc-flyer-pdf-791x1024.jpg",
                     'width'     => 791,
                     'height'    => 1024,
@@ -392 +399 @@
                 ),
                 'full'      => array(
-                    'file'      => "wordpress-gsoc-flyer.jpg",
+                    'file'      => "wordpress-gsoc-flyer-pdf.jpg",
                     'width'     => 1088,
                     'height'    => 1408,
@@ -404 +411 @@
 
         unlink( $test_file );
+        foreach ( $metadata['sizes'] as $size ) {
+            unlink ( '/tmp/' . $size['file'] );
+        }
     }
 
@@ -428 +438 @@
 
         $expected = array(
-            'file'      => 'wordpress-gsoc-flyer-77x100.jpg',
+            'file'      => 'wordpress-gsoc-flyer-pdf-77x100.jpg',
             'width'     => 77,
             'height'    => 100,
@@ -442 +452 @@
 
         unlink( $test_file );
+        foreach ( $metadata['sizes'] as $size ) {
+            unlink ( '/tmp/' . $size['file'] );
+        }
     }
 
@@ -450 +463 @@
         return $fallback_sizes;
     }
+
+    /**
+     * Test PDF preview doesn't overwrite existing JPEG.
+     * @ticket 39875
+     */
+    public function test_pdf_preview_doesnt_overwrite_existing_jpeg() {
+        if ( ! wp_image_editor_supports( array( 'mime_type' => 'application/pdf' ) ) ) {
+            $this->markTestSkipped( 'Rendering PDFs is not supported on this system.' );
+        }
+
+        // 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'] );
+        }
+    }
 }