-
Notifications
You must be signed in to change notification settings - Fork 127
Fixes palette-based PNG uploads failing original full-size AVIF/WebP conversion under GD #2024
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: trunk
Are you sure you want to change the base?
Changes from 3 commits
4d54810
82cf154
cf97730
8ad675c
85482bc
ef9a9f9
7443e68
731d3b0
7f757c7
e646941
56e8dac
9ff40f2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -803,3 +803,62 @@ | |
return $allowed_sizes; | ||
} | ||
add_filter( 'webp_uploads_image_sizes_with_additional_mime_type_support', 'webp_uploads_enable_additional_mime_type_support_for_all_sizes' ); | ||
|
||
/** | ||
* Converts palette PNG images to true color PNG images. | ||
* | ||
* GD cannot convert palette-based PNG to WebP/AVIF formats, causing conversion failures. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I wonder if this fix belongs in core itself sice we inherently support this type of conversion with a simple filter. If we don't fix automatically, at the very least, we should inform the user why the upload failed and how to fix it. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I located the Trac ticket: #59339 "Conversion to webp causes fatal error when original image is a palette image (as opposed to truecolor)" Should we post an update there and start the discussion on where to go next? |
||
* This function detects and converts palette PNG to truecolor during upload. | ||
* | ||
* @since n.e.x.t | ||
* | ||
* @param array<string, mixed> $file The uploaded file data. | ||
* @return array<string, mixed> The modified file data. | ||
*/ | ||
function webp_uploads_convert_palette_png_to_truecolor( array $file ): array { | ||
b1ink0 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if ( ! isset( $file['tmp_name'], $file['name'] ) ) { | ||
return $file; | ||
} | ||
|
||
if ( 'png' !== strtolower( pathinfo( $file['name'], PATHINFO_EXTENSION ) ) ) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should this look at the attachment metadata instead to see if the MIME type is There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, we can just check if There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done in 7443e68. |
||
return $file; | ||
} | ||
|
||
$editor = wp_get_image_editor( $file['tmp_name'] ); | ||
|
||
if ( is_wp_error( $editor ) || ! $editor instanceof WP_Image_Editor_GD ) { | ||
return $file; | ||
} | ||
|
||
// Check if required GD functions exist. | ||
if ( | ||
! function_exists( 'imagecreatefrompng' ) || | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. +1 to defensive programming; however all of these functions have been around since PHP4/5 as as far as I know should be available to all WordPress installs with GD. So maybe we can remove this check? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That would address the code coverage issue as well, if it is impossible to create a scenario where any of these functions don't exist. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh, but actually will these functions be available if GD is not installed? If PHP is not compiled with There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
! function_exists( 'imageistruecolor' ) || | ||
! function_exists( 'imagealphablending' ) || | ||
! function_exists( 'imagesavealpha' ) || | ||
! function_exists( 'imagepalettetotruecolor' ) || | ||
! function_exists( 'imagepng' ) || | ||
! function_exists( 'imagedestroy' ) | ||
) { | ||
return $file; | ||
} | ||
|
||
$image = imagecreatefrompng( $file['tmp_name'] ); | ||
if ( false === $image || imageistruecolor( $image ) ) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm confused by this check. If $image is false, the conversion failed. In that case, don't we want to continue to the processing below? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. When I also combined two different checks in that condition, which I realize makes the logic less clear. Separate those out in 7f757c7 to improve readability. |
||
return $file; | ||
} | ||
|
||
// Preserve transparency. | ||
imagealphablending( $image, false ); | ||
imagesavealpha( $image, true ); | ||
|
||
// Convert the palette to truecolor. | ||
if ( imagepalettetotruecolor( $image ) ) { | ||
// Overwrite the upload with the new truecolor PNG. | ||
imagepng( $image, $file['tmp_name'] ); | ||
} | ||
imagedestroy( $image ); | ||
|
||
return $file; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we set $file['name'] to the new file name before returning $file? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If you're asking whether the conversion has changed the name of the file, it has not - we simply overwrote the same file with the converted version. However, if you're suggesting that users should see a different filename when an image is converted to truecolor, we could add a suffix like |
||
} | ||
add_filter( 'wp_handle_upload_prefilter', 'webp_uploads_convert_palette_png_to_truecolor' ); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You're already using this in the test, but wouldn't it make sense to also add the same function as a hook callback to There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, it makes sense. At first, I thought There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done in 8ad675c |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1116,4 +1116,130 @@ public function test_that_it_should_convert_webp_to_avif_on_upload(): void { | |
} | ||
wp_delete_attachment( $attachment_id ); | ||
} | ||
|
||
/** | ||
* Tests converting a palette PNG to a truecolor PNG. | ||
* | ||
* @dataProvider data_to_test_webp_uploads_convert_palette_png_to_truecolor | ||
* | ||
* @covers ::webp_uploads_convert_palette_png_to_truecolor | ||
* | ||
* @param string|null $image_path The path to the image file to test. | ||
* @param bool $expect_changed Whether the png should be converted to truecolor. | ||
* @param callable|null $set_up Optional setup function to run before the test. | ||
* @param callable|null $tear_down Optional teardown function to run after the test. | ||
*/ | ||
public function test_webp_uploads_convert_palette_png_to_truecolor( ?string $image_path, bool $expect_changed, ?callable $set_up, ?callable $tear_down ): void { | ||
if ( null !== $set_up ) { | ||
$set_up(); | ||
} | ||
|
||
// Temp file will be copied and unlinked by WordPress core during sideload processing. | ||
$tmp_file = wp_tempnam(); | ||
copy( $image_path, $tmp_file ); | ||
$file = array( | ||
'name' => basename( $image_path ), | ||
'tmp_name' => $tmp_file, | ||
'type' => wp_check_filetype( $image_path )['type'], | ||
'size' => filesize( $tmp_file ), | ||
'error' => UPLOAD_ERR_OK, | ||
); | ||
|
||
// Store the original file hash to compare later. | ||
$original_file_hash = isset( $file['tmp_name'] ) ? md5_file( $file['tmp_name'] ) : ''; | ||
|
||
// Need to use wp_handle_sideload_prefilter for simulated upload as wp_handle_upload_prefilter is not called in this case. | ||
add_filter( 'wp_handle_sideload_prefilter', 'webp_uploads_convert_palette_png_to_truecolor' ); | ||
$attachment_id = media_handle_sideload( $file ); | ||
remove_filter( 'wp_handle_sideload_prefilter', 'webp_uploads_convert_palette_png_to_truecolor' ); | ||
|
||
try { | ||
$this->assertIsNumeric( $attachment_id ); | ||
|
||
// For getting a original image path for computation of the file hash. | ||
$meta = wp_get_attachment_metadata( $attachment_id ); | ||
$upload_dir = wp_get_upload_dir(); | ||
$path = null; | ||
if ( isset( $meta['original_image'], $meta['file'] ) ) { | ||
$path = path_join( | ||
$upload_dir['basedir'], | ||
dirname( $meta['file'] ) . '/' . $meta['original_image'] | ||
); | ||
} | ||
$this->assertNotNull( $path ); | ||
$this->assertFileExists( $path ); | ||
|
||
// Hash will be modified if the image was converted to truecolor. | ||
$modified_file_hash = md5_file( $path ); | ||
|
||
if ( ! $expect_changed ) { | ||
$this->assertSame( $original_file_hash, $modified_file_hash ); | ||
} else { | ||
$this->assertNotSame( $original_file_hash, $modified_file_hash ); | ||
$img = imagecreatefrompng( $path ); | ||
$this->assertTrue( imageistruecolor( $img ) ); | ||
imagedestroy( $img ); | ||
|
||
// Make sure the image converted to modern image format is not 0 bytes. | ||
$modern_image_format_path = get_attached_file( $attachment_id ); | ||
$this->assertNotFalse( $modern_image_format_path ); | ||
$this->assertFileExists( $modern_image_format_path ); | ||
$this->assertGreaterThan( 0, (int) filesize( $modern_image_format_path ) ); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can we also add an assertion that the new image filesize isn't larger than the original image? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done in 56e8dac. |
||
} | ||
} finally { | ||
if ( null !== $tear_down ) { | ||
$tear_down(); | ||
} | ||
wp_delete_attachment( $attachment_id ); | ||
} | ||
} | ||
|
||
/** | ||
* Data provider for `test_webp_uploads_convert_palette_png_to_truecolor`. | ||
* | ||
* @return array<string, mixed> Returns an array of test cases. | ||
*/ | ||
public function data_to_test_webp_uploads_convert_palette_png_to_truecolor(): array { | ||
$non_palette_png = TESTS_PLUGIN_DIR . '/tests/data/images/dice.png'; | ||
$palette_png = TESTS_PLUGIN_DIR . '/tests/data/images/dice-palette.png'; | ||
$test_jpg = TESTS_PLUGIN_DIR . '/tests/data/images/leaves.jpg'; | ||
|
||
return array( | ||
'wrong_extension' => array( | ||
'image_path' => $test_jpg, | ||
'expected_changed' => false, | ||
'set_up' => null, | ||
'tear_down' => null, | ||
), | ||
'non_palette_png' => array( | ||
'image_path' => $non_palette_png, | ||
'expected_changed' => false, | ||
'set_up' => function (): void { | ||
add_filter( 'wp_image_editors', array( $this, 'use_gd_image_editor' ) ); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. can the test just add this filter always, without needing a "set_up" attribute? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done in e646941. |
||
}, | ||
'tear_down' => function (): void { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. tear_down should not be required as all hooks should be reset between test runs as far as I know. Can you try removing? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah, we can remove this. I had added them because I was also testing using the ImageMagick editor, and since filters don't get removed between iterations of the data provider, I had to add setup and teardown. But I removed the test for ImageMagick as I noticed ImageMagick wasn't working correctly when I ran the tests. When I tried to log There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done in e646941. |
||
remove_filter( 'wp_image_editors', array( $this, 'use_gd_image_editor' ) ); | ||
}, | ||
), | ||
'palette_png' => array( | ||
'image_path' => $palette_png, | ||
'expected_changed' => true, | ||
'set_up' => function (): void { | ||
add_filter( 'wp_image_editors', array( $this, 'use_gd_image_editor' ) ); | ||
}, | ||
'tear_down' => function (): void { | ||
remove_filter( 'wp_image_editors', array( $this, 'use_gd_image_editor' ) ); | ||
}, | ||
), | ||
); | ||
} | ||
|
||
/** | ||
* Use GD image editor. | ||
* | ||
* @return array<string> | ||
*/ | ||
public function use_gd_image_editor(): array { | ||
return array( 'WP_Image_Editor_GD' ); | ||
} | ||
} |
Uh oh!
There was an error while loading. Please reload this page.