Changeset 58849

Timestamp:

08/05/2024 04:11:40 AM (2 months ago)

Author:

noisysocks

Message:

Media: Automatically convert HEIC images to JPEG

Automatically create a JPEG version of uploaded HEIC images if the server has
a version of Imagick that supports HEIC. Conversion is done silently through
the existing WP_Image_Editor infrastructure that creates multiple sizes of
uploaded images.

This allows users to view HEIC images in WP Admin and use them in their posts
and pages regardless of whether their browser supports HEIC. Browser support
for HEIC is relatively low (only Safari) while the occurrence of HEIC images is
relatively common. The original HEIC image can be downloaded via a link on
the attachment page.

Props adamsilverstein, noisysocks, swissspidy, spacedmonkey, peterwilsoncc.
Fixes #53645.

Location:

trunk

Files:

• src/js/media/controllers/library.js (modified) (1 diff)
• src/wp-admin/includes/image.php (modified) (2 diffs)
• src/wp-includes/class-wp-image-editor-imagick.php (modified) (2 diffs)
• src/wp-includes/class-wp-image-editor.php (modified) (2 diffs)
• src/wp-includes/compat.php (modified) (1 diff)
• src/wp-includes/functions.php (modified) (4 diffs)
• src/wp-includes/media.php (modified) (6 diffs)
• src/wp-includes/post.php (modified) (1 diff)
• src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php (modified) (1 diff)
• tests/phpunit/data/images/test-image.heic (added)
• tests/phpunit/tests/functions.php (modified) (3 diffs)
• tests/phpunit/tests/image/functions.php (modified) (1 diff)
• tests/phpunit/tests/image/resize.php (modified) (2 diffs)

trunk/src/js/media/controllers/library.js

@@ -197 +197 @@
         // If uploading, we know the filename but not the mime type.
         if ( attachment.get('uploading') ) {
-            return /\.(jpe?g|png|gif|webp|avif)$/i.test( attachment.get('filename') );
+            return /\.(jpe?g|png|gif|webp|avif|heic)$/i.test( attachment.get('filename') );
         }
 

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

@@ -544 +544 @@
  * @since 2.1.0
  * @since 6.0.0 The `$filesize` value was added to the returned array.
+ * @since 6.7.0 The 'image/heic' mime type is supported.
  *
  * @param int    $attachment_id Attachment ID to process.
@@ -556 +557 @@
     $mime_type = get_post_mime_type( $attachment );
 
-    if ( preg_match( '!^image/!', $mime_type ) && file_is_displayable_image( $file ) ) {
+    if ( 'image/heic' === $mime_type || ( preg_match( '!^image/!', $mime_type ) && file_is_displayable_image( $file ) ) ) {
         // Make thumbnails and other intermediate sizes.
         $metadata = wp_create_image_subsizes( $file, $attachment_id );

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

@@ -220 +220 @@
                     }
                     break;
-                case 'image/avif':
                 default:
                     $this->image->setImageCompressionQuality( $quality );
@@ -259 +258 @@
 
         /*
-         * If we still don't have the image size, fall back to `wp_getimagesize`. This ensures AVIF images
+         * If we still don't have the image size, fall back to `wp_getimagesize`. This ensures AVIF and HEIC images
          * are properly sized without affecting previous `getImageGeometry` behavior.
          */
-        if ( ( ! $width || ! $height ) && 'image/avif' === $this->mime_type ) {
+        if ( ( ! $width || ! $height ) && ( 'image/avif' === $this->mime_type || 'image/heic' === $this->mime_type ) ) {
             $size   = wp_getimagesize( $this->file );
             $width  = $size[0];

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

@@ -319 +319 @@
                 break;
             case 'image/jpeg':
-            case 'image/avif':
             default:
                 $quality = $this->default_quality;
@@ -367 +366 @@
         }
 
-        /**
-         * Filters the image editor output format mapping.
-         *
-         * Enables filtering the mime type used to save images. By default,
-         * the mapping array is empty, so the mime type matches the source image.
-         *
-         * @see WP_Image_Editor::get_output_format()
-         *
-         * @since 5.8.0
-         *
-         * @param string[] $output_format {
-         *     An array of mime type mappings. Maps a source mime type to a new
-         *     destination mime type. Default empty array.
-         *
-         *     @type string ...$0 The new mime type.
-         * }
-         * @param string $filename  Path to the image.
-         * @param string $mime_type The source image mime type.
-         */
-        $output_format = apply_filters( 'image_editor_output_format', array(), $filename, $mime_type );
+        $output_format = wp_get_image_editor_output_format( $filename, $mime_type );
 
         if ( isset( $output_format[ $mime_type ] )

trunk/src/wp-includes/compat.php

@@ -550 +550 @@
     define( 'IMG_AVIF', IMAGETYPE_AVIF );
 }
+
+// IMAGETYPE_HEIC constant is not yet defined in PHP as of PHP 8.3.
+if ( ! defined( 'IMAGETYPE_HEIC' ) ) {
+    define( 'IMAGETYPE_HEIC', 99 );
+}

trunk/src/wp-includes/functions.php

@@ -2707 +2707 @@
          */
         if ( $is_image ) {
-            /** This filter is documented in wp-includes/class-wp-image-editor.php */
-            $output_formats = apply_filters( 'image_editor_output_format', array(), $_dir . $filename, $mime_type );
+            $output_formats = wp_get_image_editor_output_format( $_dir . $filename, $mime_type );
             $alt_types      = array();
 
@@ -3121 +3120 @@
                     'image/webp' => 'webp',
                     'image/avif' => 'avif',
+                    'image/heic' => 'heic',
                 )
             );
@@ -3300 +3300 @@
  * @since 5.8.0 Added support for WebP images.
  * @since 6.5.0 Added support for AVIF images.
+ * @since 6.7.0 Added support for HEIC images.
  *
  * @param string $file Full path to the file.
@@ -3372 +3373 @@
         ) {
             $mime = 'image/avif';
+        }
+
+        if (
+            isset( $magic[1] ) &&
+            isset( $magic[2] ) &&
+            'ftyp' === hex2bin( $magic[1] ) &&
+            ( 'heic' === hex2bin( $magic[2] ) || 'heif' === hex2bin( $magic[2] ) )
+        ) {
+            $mime = 'image/heic';
         }
     } catch ( Exception $e ) {

trunk/src/wp-includes/media.php

@@ -4065 +4065 @@
     // Check and set the output mime type mapped to the input type.
     if ( isset( $args['mime_type'] ) ) {
-        /** This filter is documented in wp-includes/class-wp-image-editor.php */
-        $output_format = apply_filters( 'image_editor_output_format', array(), $path, $args['mime_type'] );
+        $output_format = wp_get_image_editor_output_format( $path, $args['mime_type'] );
         if ( isset( $output_format[ $args['mime_type'] ] ) ) {
             $args['output_mime_type'] = $output_format[ $args['mime_type'] ];
@@ -4223 +4222 @@
     if ( ! wp_image_editor_supports( array( 'mime_type' => 'image/avif' ) ) ) {
         $defaults['avif_upload_error'] = true;
+    }
+
+    // Check if HEIC images can be edited.
+    if ( ! wp_image_editor_supports( array( 'mime_type' => 'image/heic' ) ) ) {
+        $defaults['heic_upload_error'] = true;
     }
 
@@ -5484 +5488 @@
  *
  * @since 5.5.0
+ * @since 6.7.0 The default behavior is to enable heic uplooads as long as the server
+ *              supports the format. The uploads are converted to JPEG's by default.
  *
  * @param array[] $plupload_settings The settings for Plupload.js.
@@ -5489 +5495 @@
  */
 function wp_show_heic_upload_error( $plupload_settings ) {
-    $plupload_settings['heic_upload_error'] = true;
+    // Check if HEIC images can be edited.
+    if ( ! wp_image_editor_supports( array( 'mime_type' => 'image/heic' ) ) ) {
+        $plupload_init['heic_upload_error'] = true;
+    }
     return $plupload_settings;
 }
@@ -5583 +5592 @@
                 ),
                 'mime' => 'image/avif',
+            );
+        }
+    }
+
+    // For PHP versions that don't support HEIC images, extract the size info using Imagick when available.
+    if ( 'image/heic' === wp_get_image_mime( $filename ) ) {
+        $editor = wp_get_image_editor( $filename );
+        if ( is_wp_error( $editor ) ) {
+            return false;
+        }
+        // If the editor for HEICs is Imagick, use it to get the image size.
+        if ( $editor instanceof WP_Image_Editor_Imagick ) {
+            $size = $editor->get_size();
+            return array(
+                $size['width'],
+                $size['height'],
+                IMAGETYPE_HEIC,
+                sprintf(
+                    'width="%d" height="%d"',
+                    $size['width'],
+                    $size['height']
+                ),
+                'mime' => 'image/heic',
             );
         }
@@ -6070 +6102 @@
     return $high_priority_element;
 }
+
+/**
+ * Determines the output format for the image editor.
+ *
+ * @since 6.7.0
+ * @access private
+ *
+ * @param string $filename  Path to the image.
+ * @param string $mime_type The source image mime type.
+ * @return string[] An array of mime type mappings.
+ */
+function wp_get_image_editor_output_format( $filename, $mime_type ) {
+    /**
+     * Filters the image editor output format mapping.
+     *
+     * Enables filtering the mime type used to save images. By default,
+     * the mapping array is empty, so the mime type matches the source image.
+     *
+     * @see WP_Image_Editor::get_output_format()
+     *
+     * @since 5.8.0
+     * @since 6.7.0 The default was changed from array() to array( 'image/heic' => 'image/jpeg' ).
+     *
+     * @param string[] $output_format {
+     *     An array of mime type mappings. Maps a source mime type to a new
+     *     destination mime type. Default maps uploaded HEIC images to JPEG output.
+     *
+     *     @type string ...$0 The new mime type.
+     * }
+     * @param string $filename  Path to the image.
+     * @param string $mime_type The source image mime type.
+     */
+    return apply_filters( 'image_editor_output_format', array( 'image/heic' => 'image/jpeg' ), $filename, $mime_type );
+}

trunk/src/wp-includes/post.php

@@ -6830 +6830 @@
     switch ( $type ) {
         case 'image':
-            $image_exts = array( 'jpg', 'jpeg', 'jpe', 'gif', 'png', 'webp', 'avif' );
+            $image_exts = array( 'jpg', 'jpeg', 'jpe', 'gif', 'png', 'webp', 'avif', 'heic' );
             return in_array( $ext, $image_exts, true );
 

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

@@ -532 +532 @@
         }
 
-        $supported_types = array( 'image/jpeg', 'image/png', 'image/gif', 'image/webp', 'image/avif' );
+        $supported_types = array( 'image/jpeg', 'image/png', 'image/gif', 'image/webp', 'image/avif', 'image/heic' );
         $mime_type       = get_post_mime_type( $attachment_id );
         if ( ! in_array( $mime_type, $supported_types, true ) ) {

trunk/tests/phpunit/tests/functions.php

@@ -1356 +1356 @@
                 'image/avif',
             ),
+            // HEIC.
+            array(
+                DIR_TESTDATA . '/images/test-image.heic',
+                'image/heic',
+            ),
         );
 
@@ -1385 +1390 @@
 
     /**
-     * Data profider for test_wp_getimagesize().
+     * Data provider for test_wp_getimagesize().
      */
     public function data_wp_getimagesize() {
@@ -1541 +1546 @@
         return $data;
     }
+
+    /**
+     * Tests that wp_getimagesize() correctly handles HEIC image files.
+     *
+     * @ticket 53645
+     */
+    public function test_wp_getimagesize_heic() {
+        if ( ! is_callable( 'exif_imagetype' ) && ! function_exists( 'getimagesize' ) ) {
+            $this->markTestSkipped( 'The exif PHP extension is not loaded.' );
+        }
+
+        $file = DIR_TESTDATA . '/images/test-image.heic';
+
+        $editor = wp_get_image_editor( $file );
+        if ( is_wp_error( $editor ) || ! $editor->supports_mime_type( 'image/heic' ) ) {
+            $this->markTestSkipped( 'No HEIC support in the editor engine on this system.' );
+        }
+
+        $expected = array(
+            50,
+            50,
+            IMAGETYPE_HEIC,
+            'width="50" height="50"',
+            'mime' => 'image/heic',
+        );
+        $result   = wp_getimagesize( $file );
+        $this->assertSame( $expected, $result );
+    }
+
 
     /**

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

@@ -238 +238 @@
             'test-image.psd',
             'test-image-zip.tiff',
+            'test-image.heic',
         );
 

trunk/tests/phpunit/tests/image/resize.php

@@ -115 +115 @@
     }
 
+    /**
+     * Test resizing HEIC image.
+     *
+     * @ticket 53645
+     */
+    public function test_resize_heic() {
+        $file   = DIR_TESTDATA . '/images/test-image.heic';
+        $editor = wp_get_image_editor( $file );
+
+        // Check if the editor supports the HEIC mime type.
+        if ( is_wp_error( $editor ) || ! $editor->supports_mime_type( 'image/heic' ) ) {
+            $this->markTestSkipped( 'No HEIC support in the editor engine on this system.' );
+        }
+
+        $image = $this->resize_helper( $file, 25, 25 );
+
+        list( $w, $h, $type ) = wp_getimagesize( $image );
+
+        unlink( $image );
+
+        $this->assertSame( 'test-image-25x25.jpg', wp_basename( $image ) );
+        $this->assertSame( 25, $w );
+        $this->assertSame( 25, $h );
+        $this->assertSame( IMAGETYPE_JPEG, $type );
+    }
+
     public function test_resize_larger() {
         // image_resize() should refuse to make an image larger.
@@ -236 +262 @@
         }
 
-        return $dest_file;
+        return $saved['path'];
     }
 }