Changeset 38949

Timestamp:

10/26/2016 07:27:51 AM (8 years ago)

Author:

mikeschroder

Message:

Media: Add support for rendering PDF thumbnails.

When support for PDFs is available, on upload,
render 'Thumbnail', 'Medium', 'Large', and 'Full' sizes of
the first page, and save them in attachment meta.

Use these renders within Add Media, Media Gallery and List views,
Attachment Details, Post/Attachment Edit screens, and Attachment pages.

Support available by default via Imagick -> ImageMagick -> Ghostscript,
but can be provided by any WP_Image_Editor that supports PDFs.

Props adamsilverstein, azaozz, celloexpressions, desrosj, dglingren, ericlewis, ipstenu, joemcgill, joyously, markoheijnen, melchoyce, mikeschroder, tomauger.
Fixes #31050.

Location:

trunk

Files:

• src/wp-admin/includes/image.php (modified) (2 diffs)
• src/wp-admin/includes/media.php (modified) (1 diff)
• src/wp-includes/class-wp-image-editor-imagick.php (modified) (2 diffs)
• src/wp-includes/media-template.php (modified) (2 diffs)
• src/wp-includes/media.php (modified) (6 diffs)
• tests/phpunit/data/images/wordpress-gsoc-flyer.pdf (added)
• tests/phpunit/tests/image/functions.php (modified) (1 diff)

trunk/src/wp-admin/includes/image.php

@@ -77 +77 @@
     $metadata = array();
     $support = false;
-    if ( preg_match('!^image/!', get_post_mime_type( $attachment )) && file_is_displayable_image($file) ) {
+    $mime_type = get_post_mime_type( $attachment );
+
+    if ( preg_match( '!^image/!', $mime_type ) && file_is_displayable_image( $file ) ) {
         $imagesize = getimagesize( $file );
         $metadata['width'] = $imagesize[0];
@@ -202 +204 @@
         }
     }
+    // Try to create image thumbnails for PDFs
+    else if ( 'application/pdf' === $mime_type ) {
+        $editor = wp_get_image_editor( $file );
+
+        $fallback_sizes = array(
+            'thumbnail',
+            'medium',
+            'large',
+        );
+
+        $sizes = array();
+
+        foreach ( $fallback_sizes as $s ) {
+            $sizes[$s]['width']  = get_option( "{$s}_size_w" );
+            $sizes[$s]['height'] = get_option( "{$s}_size_h" );
+
+            // Force thumbnails to be soft crops.
+            if ( ! 'thumbnail' === $s ) {
+                $sizes[$s]['crop'] = get_option( "{$s}_crop" );
+            }
+        }
+
+        if ( ! is_wp_error( $editor ) ) { // No support for this type of file
+            $uploaded = $editor->save( $file, 'image/jpeg' );
+            unset( $editor );
+
+            // Resize based on the full size image, rather than the source.
+            if ( ! is_wp_error( $uploaded ) ) {
+                $editor = wp_get_image_editor( $uploaded['path'] );
+                unset( $uploaded['path'] );
+
+                if ( ! is_wp_error( $editor ) ) {
+                    $metadata['sizes'] = $editor->multi_resize( $sizes );
+                    $metadata['sizes']['full'] = $uploaded;
+                }
+            }
+        }
+    }
 
     // Remove the blob of binary data from the array.

trunk/src/wp-admin/includes/media.php

@@ -2767 +2767 @@
         echo wp_video_shortcode( $attr );
 
-    else :
+    elseif ( isset( $thumb_url[0] ) ):
+
+        ?>
+        <div class="wp_attachment_image wp-clearfix" id="media-head-<?php echo $attachment_id; ?>">
+            <p id="thumbnail-head-<?php echo $attachment_id; ?>">
+                <img class="thumbnail" src="<?php echo set_url_scheme( $thumb_url[0] ); ?>" style="max-width:100%" alt="" />
+            </p>
+        </div>
+        <?php
+
+    else:
 
         /**

trunk/src/wp-includes/class-wp-image-editor-imagick.php

@@ -74 +74 @@
             'flipimage',
             'flopimage',
+            'readimage',
         );
 
@@ -145 +146 @@
 
         try {
-            $this->image = new Imagick( $this->file );
+            $this->image = new Imagick();
+            $file_parts = pathinfo( $this->file );
+
+            // By default, PDFs are rendered in a very low resolution.
+            // We want the thumbnail to be readable, so increase the rendering dpi.
+            if ( 'pdf' == strtolower( $file_parts['extension'] ) ) {
+                $this->image->setResolution( 128, 128 );
+            }
+
+            // Reading image after Imagick instantiation because `setResolution`
+            // only applies correctly before the image is read.
+            $this->image->readImage( $this->file );
 
             if ( ! $this->image->valid() )

trunk/src/wp-includes/media-template.php

@@ -291 +291 @@
                 <# if ( data.uploading ) { #>
                     <div class="media-progress-bar"><div></div></div>
-                <# } else if ( 'image' === data.type && data.sizes && data.sizes.large ) { #>
+                <# } else if ( data.sizes && data.sizes.large ) { #>
                     <img class="details-image" src="{{ data.sizes.large.url }}" draggable="false" alt="" />
-                <# } else if ( 'image' === data.type && data.sizes && data.sizes.full ) { #>
+                <# } else if ( data.sizes && data.sizes.full ) { #>
                     <img class="details-image" src="{{ data.sizes.full.url }}" draggable="false" alt="" />
                 <# } else if ( -1 === jQuery.inArray( data.type, [ 'audio', 'video' ] ) ) { #>
@@ -455 +455 @@
                         <# if ( data.image && data.image.src && data.image.src !== data.icon ) { #>
                             <img src="{{ data.image.src }}" class="thumbnail" draggable="false" alt="" />
+                        <# } else if ( data.sizes && data.sizes.medium ) { #>
+                            <img src="{{ data.sizes.medium.url }}" class="thumbnail" draggable="false" alt="" />
                         <# } else { #>
                             <img src="{{ data.icon }}" class="icon" draggable="false" alt="" />

trunk/src/wp-includes/media.php

@@ -184 +184 @@
  */
 function image_downsize( $id, $size = 'medium' ) {
-
-    if ( !wp_attachment_is_image($id) )
-        return false;
+    $is_image = wp_attachment_is_image( $id );
 
     /**
@@ -210 +208 @@
     $is_intermediate = false;
     $img_url_basename = wp_basename($img_url);
+
+    // If the file isn't an image, attempt to replace its URL with a rendered image from its meta.
+    // Otherwise, a non-image type could be returned.
+    if ( ! $is_image ) {
+        if ( ! empty( $meta['sizes'] ) ) {
+            $img_url = str_replace( $img_url_basename, $meta['sizes']['full']['file'], $img_url );
+            $img_url_basename = $meta['sizes']['full']['file'];
+            $width = $meta['sizes']['full']['width'];
+            $height = $meta['sizes']['full']['height'];
+        } else {
+            return false;
+        }
+    }
 
     // try for a new style intermediate size
@@ -685 +696 @@
     if ( is_array( $size ) ) {
         $candidates = array();
+
+        if ( ! isset( $imagedata['file'] ) && isset( $imagedata['sizes']['full'] ) ) {
+            $imagedata['height'] = $imagedata['sizes']['full']['height'];
+            $imagedata['width']  = $imagedata['sizes']['full']['width'];
+        }
 
         foreach ( $imagedata['sizes'] as $_size => $data ) {
@@ -739 +755 @@
 
     // include the full filesystem path of the intermediate file
-    if ( empty($data['path']) && !empty($data['file']) ) {
+    if ( empty( $data['path'] ) && ! empty( $data['file'] ) && ! empty( $imagedata['file'] ) ) {
         $file_url = wp_get_attachment_url($post_id);
         $data['path'] = path_join( dirname($imagedata['file']), $data['file'] );
@@ -3124 +3140 @@
         $response['nonces']['delete'] = wp_create_nonce( 'delete-post_' . $attachment->ID );
 
-    if ( $meta && 'image' === $type ) {
+    if ( $meta && ! empty( $meta['sizes'] ) ) {
         $sizes = array();
 
@@ -3172 +3188 @@
         }
 
-        $sizes['full'] = array( 'url' => $attachment_url );
-
-        if ( isset( $meta['height'], $meta['width'] ) ) {
-            $sizes['full']['height'] = $meta['height'];
-            $sizes['full']['width'] = $meta['width'];
-            $sizes['full']['orientation'] = $meta['height'] > $meta['width'] ? 'portrait' : 'landscape';
-        }
-
-        $response = array_merge( $response, array( 'sizes' => $sizes ), $sizes['full'] );
-    } elseif ( $meta && 'video' === $type ) {
+        if ( 'image' === $type ) {
+            $sizes['full'] = array( 'url' => $attachment_url );
+
+            if ( isset( $meta['height'], $meta['width'] ) ) {
+                $sizes['full']['height'] = $meta['height'];
+                $sizes['full']['width'] = $meta['width'];
+                $sizes['full']['orientation'] = $meta['height'] > $meta['width'] ? 'portrait' : 'landscape';
+            }
+
+            $response = array_merge( $response, $sizes['full'] );
+        } elseif ( $meta['sizes']['full']['file'] ) {
+            $sizes['full'] = array(
+                'url'         => $base_url . $meta['sizes']['full']['file'],
+                'height'      => $meta['sizes']['full']['height'],
+                'width'       => $meta['sizes']['full']['width'],
+                'orientation' => $meta['sizes']['full']['height'] > $meta['sizes']['full']['width'] ? 'portrait' : 'landscape'
+            );
+        }
+
+        $response = array_merge( $response, array( 'sizes' => $sizes ) );
+    }
+
+    if ( $meta && 'video' === $type ) {
         if ( isset( $meta['width'] ) )
             $response['width'] = (int) $meta['width'];

trunk/tests/phpunit/tests/image/functions.php

@@ -352 +352 @@
         WP_Image_Editor_Mock::$save_return = array();
     }
+
+    /**
+     * @ticket 31050
+     */
+    public function test_wp_generate_attachment_metadata_pdf() {
+        if ( ! wp_image_editor_supports( array( 'mime_type' => 'application/pdf' ) ) ) {
+            $this->markTestSkipped( 'Rendering PDFs is not supported on this system.' );
+        }
+
+        $orig_file = DIR_TESTDATA . '/images/wordpress-gsoc-flyer.pdf';
+        $test_file = '/tmp/wordpress-gsoc-flyer.pdf';
+        copy( $orig_file, $test_file );
+
+        $attachment_id = $this->factory->attachment->create_object( $test_file, 0, array(
+            'post_mime_type' => 'application/pdf',
+        ) );
+
+        $this->assertNotEmpty( $attachment_id );
+
+        $expected = array(
+            'sizes' => array(
+                'thumbnail' => array(
+                    'file'      => "wordpress-gsoc-flyer-116x150.jpg",
+                    'width'     => 116,
+                    'height'    => 150,
+                    'mime-type' => "image/jpeg",
+                ),
+                'medium'    => array(
+                    'file'      => "wordpress-gsoc-flyer-232x300.jpg",
+                    'width'     => 232,
+                    'height'    => 300,
+                    'mime-type' => "image/jpeg",
+                ),
+                'large'     => array(
+                    'file'      => "wordpress-gsoc-flyer-791x1024.jpg",
+                    'width'     => 791,
+                    'height'    => 1024,
+                    'mime-type' => "image/jpeg",
+                ),
+                'full'      => array(
+                    'file'      => "wordpress-gsoc-flyer.jpg",
+                    'width'     => 1088,
+                    'height'    => 1408,
+                    'mime-type' => "image/jpeg",
+                ),
+            ),
+        );
+
+        $metadata = wp_generate_attachment_metadata( $attachment_id, $test_file );
+        $this->assertSame( $expected, $metadata );
+
+        unlink( $test_file );
+    }
 }