2012-10-01 16:59:06 -04:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* WordPress Imagick Image Editor
|
|
|
|
*
|
|
|
|
* @package WordPress
|
|
|
|
* @subpackage Image_Editor
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* WordPress Image Editor Class for Image Manipulation through Imagick PHP Module
|
|
|
|
*
|
|
|
|
* @since 3.5.0
|
2017-07-01 12:58:42 -04:00
|
|
|
*
|
|
|
|
* @see WP_Image_Editor
|
2012-10-01 16:59:06 -04:00
|
|
|
*/
|
|
|
|
class WP_Image_Editor_Imagick extends WP_Image_Editor {
|
2014-11-02 21:38:23 -05:00
|
|
|
/**
|
2015-05-23 15:20:24 -04:00
|
|
|
* Imagick object.
|
|
|
|
*
|
2014-11-02 21:38:23 -05:00
|
|
|
* @var Imagick
|
|
|
|
*/
|
2015-05-23 15:20:24 -04:00
|
|
|
protected $image;
|
2012-10-01 16:59:06 -04:00
|
|
|
|
2014-05-19 01:53:14 -04:00
|
|
|
public function __destruct() {
|
2013-07-22 13:01:00 -04:00
|
|
|
if ( $this->image instanceof Imagick ) {
|
2020-01-28 19:45:18 -05:00
|
|
|
// We don't need the original in memory anymore.
|
2012-10-01 16:59:06 -04:00
|
|
|
$this->image->clear();
|
|
|
|
$this->image->destroy();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-11-14 17:19:32 -05:00
|
|
|
* Checks to see if current environment supports Imagick.
|
|
|
|
*
|
2012-11-28 16:41:44 -05:00
|
|
|
* We require Imagick 2.2.0 or greater, based on whether the queryFormats()
|
2012-11-14 17:19:32 -05:00
|
|
|
* method can be called statically.
|
2012-10-01 16:59:06 -04:00
|
|
|
*
|
|
|
|
* @since 3.5.0
|
2015-05-29 11:43:29 -04:00
|
|
|
*
|
2015-05-22 02:18:25 -04:00
|
|
|
* @param array $args
|
2015-06-26 21:03:25 -04:00
|
|
|
* @return bool
|
2012-10-01 16:59:06 -04:00
|
|
|
*/
|
2012-11-22 04:52:16 -05:00
|
|
|
public static function test( $args = array() ) {
|
2012-11-26 17:40:34 -05:00
|
|
|
|
2012-11-27 09:52:24 -05:00
|
|
|
// First, test Imagick's extension and classes.
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! extension_loaded( 'imagick' ) || ! class_exists( 'Imagick', false ) || ! class_exists( 'ImagickPixel', false ) ) {
|
2012-11-27 09:52:24 -05:00
|
|
|
return false;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2012-11-27 09:52:24 -05:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( version_compare( phpversion( 'imagick' ), '2.2.0', '<' ) ) {
|
2012-11-28 16:41:44 -05:00
|
|
|
return false;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2012-11-28 16:41:44 -05:00
|
|
|
|
2012-11-26 17:40:34 -05:00
|
|
|
$required_methods = array(
|
|
|
|
'clear',
|
|
|
|
'destroy',
|
|
|
|
'valid',
|
|
|
|
'getimage',
|
|
|
|
'writeimage',
|
|
|
|
'getimageblob',
|
|
|
|
'getimagegeometry',
|
|
|
|
'getimageformat',
|
|
|
|
'setimageformat',
|
|
|
|
'setimagecompression',
|
|
|
|
'setimagecompressionquality',
|
|
|
|
'setimagepage',
|
2016-03-08 23:44:26 -05:00
|
|
|
'setoption',
|
2012-11-26 17:40:34 -05:00
|
|
|
'scaleimage',
|
|
|
|
'cropimage',
|
|
|
|
'rotateimage',
|
|
|
|
'flipimage',
|
|
|
|
'flopimage',
|
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.
Built from https://develop.svn.wordpress.org/trunk@38949
git-svn-id: http://core.svn.wordpress.org/trunk@38892 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 03:28:32 -04:00
|
|
|
'readimage',
|
Media: Support Stream Wrappers In `WP_Image_Editor_Imagick`
Since `WP_Image_Editor`'s introduction, stream wrappers have functioned in `WP_Image_Editor_GD`, but haven't been properly supported in `WP_Image_Editor_Imagick`.
- Detects stream wrappers and uses `file_put_contents()` along with `Imagick::read/getImageBlob()` for handling when necessary.
- Introduces private method, `WP_Image_Editor_Imagick::write_image` to handle detection and proper saving.
- Introduces `WP_Test_Stream` class for testing stream wrappers, along with new tests for Imagick's stream handling and a stream filename test.
Adds requirement for `Imagick::readImageBlob()`, available in Imagick >= 2.0.0, which aligns with the current requirement of Imagick >= 2.2.0.
Props p00ya, calin, joemcgill, pputzer, jimyaghi, mikeschroder.
Fixes #42663.
Built from https://develop.svn.wordpress.org/trunk@49230
git-svn-id: http://core.svn.wordpress.org/trunk@48992 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-20 10:37:05 -04:00
|
|
|
'readimageblob',
|
2012-11-26 17:40:34 -05:00
|
|
|
);
|
|
|
|
|
2012-11-27 09:52:24 -05:00
|
|
|
// Now, test for deep requirements within Imagick.
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! defined( 'imagick::COMPRESSION_JPEG' ) ) {
|
2012-11-28 16:41:44 -05:00
|
|
|
return false;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2012-11-26 17:40:34 -05:00
|
|
|
|
2016-03-10 00:37:27 -05:00
|
|
|
$class_methods = array_map( 'strtolower', get_class_methods( 'Imagick' ) );
|
|
|
|
if ( array_diff( $required_methods, $class_methods ) ) {
|
2012-11-26 17:40:34 -05:00
|
|
|
return false;
|
2016-03-10 00:37:27 -05:00
|
|
|
}
|
2012-11-26 17:40:34 -05:00
|
|
|
|
2012-10-01 16:59:06 -04:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2012-11-22 04:52:16 -05:00
|
|
|
/**
|
|
|
|
* Checks to see if editor supports the mime-type specified.
|
|
|
|
*
|
|
|
|
* @since 3.5.0
|
2015-05-29 11:43:29 -04:00
|
|
|
*
|
2012-11-22 04:52:16 -05:00
|
|
|
* @param string $mime_type
|
2015-06-26 21:03:25 -04:00
|
|
|
* @return bool
|
2012-11-22 04:52:16 -05:00
|
|
|
*/
|
|
|
|
public static function supports_mime_type( $mime_type ) {
|
|
|
|
$imagick_extension = strtoupper( self::get_extension( $mime_type ) );
|
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! $imagick_extension ) {
|
2012-11-22 04:52:16 -05:00
|
|
|
return false;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2012-11-22 04:52:16 -05:00
|
|
|
|
2023-07-09 17:25:23 -04:00
|
|
|
/*
|
|
|
|
* setIteratorIndex is optional unless mime is an animated format.
|
|
|
|
* Here, we just say no if you are missing it and aren't loading a jpeg.
|
|
|
|
*/
|
2020-02-09 11:55:09 -05:00
|
|
|
if ( ! method_exists( 'Imagick', 'setIteratorIndex' ) && 'image/jpeg' !== $mime_type ) {
|
2012-11-27 09:52:24 -05:00
|
|
|
return false;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2012-11-27 09:52:24 -05:00
|
|
|
|
2012-11-22 04:52:16 -05:00
|
|
|
try {
|
2019-07-09 01:45:58 -04:00
|
|
|
// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
|
2013-07-05 14:43:45 -04:00
|
|
|
return ( (bool) @Imagick::queryFormats( $imagick_extension ) );
|
2017-11-30 18:11:00 -05:00
|
|
|
} catch ( Exception $e ) {
|
2012-11-22 04:52:16 -05:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-10-01 16:59:06 -04:00
|
|
|
/**
|
2012-11-16 17:02:21 -05:00
|
|
|
* Loads image from $this->file into new Imagick Object.
|
2012-10-01 16:59:06 -04:00
|
|
|
*
|
|
|
|
* @since 3.5.0
|
|
|
|
*
|
2015-05-22 02:18:25 -04:00
|
|
|
* @return true|WP_Error True if loaded; WP_Error on failure.
|
2012-10-01 16:59:06 -04:00
|
|
|
*/
|
2012-11-22 04:52:16 -05:00
|
|
|
public function load() {
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( $this->image instanceof Imagick ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
return true;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2012-10-01 16:59:06 -04:00
|
|
|
|
Media: Support Stream Wrappers In `WP_Image_Editor_Imagick`
Since `WP_Image_Editor`'s introduction, stream wrappers have functioned in `WP_Image_Editor_GD`, but haven't been properly supported in `WP_Image_Editor_Imagick`.
- Detects stream wrappers and uses `file_put_contents()` along with `Imagick::read/getImageBlob()` for handling when necessary.
- Introduces private method, `WP_Image_Editor_Imagick::write_image` to handle detection and proper saving.
- Introduces `WP_Test_Stream` class for testing stream wrappers, along with new tests for Imagick's stream handling and a stream filename test.
Adds requirement for `Imagick::readImageBlob()`, available in Imagick >= 2.0.0, which aligns with the current requirement of Imagick >= 2.2.0.
Props p00ya, calin, joemcgill, pputzer, jimyaghi, mikeschroder.
Fixes #42663.
Built from https://develop.svn.wordpress.org/trunk@49230
git-svn-id: http://core.svn.wordpress.org/trunk@48992 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-20 10:37:05 -04:00
|
|
|
if ( ! is_file( $this->file ) && ! wp_is_stream( $this->file ) ) {
|
Administration: Replace contracted verb forms for better consistency.
This changeset replaces contracted verb forms like `doesn't`, `can't`, or `isn't` with non-contracted forms like `does not`, `cannot`, or `is not`, for better consistency across the WordPress administration. It also updates some corresponding unit tests strings.
Props Presskopp, socalchristina, aandrewdixon, francina, SergeyBiryukov, JeffPaul, audrasjb, hellofromTonya.
Fixes #38913.
See #39176.
Built from https://develop.svn.wordpress.org/trunk@52978
git-svn-id: http://core.svn.wordpress.org/trunk@52567 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-03-22 12:25:03 -04:00
|
|
|
return new WP_Error( 'error_loading_image', __( 'File does not exist?' ), $this->file );
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2012-10-01 16:59:06 -04:00
|
|
|
|
2016-05-29 22:14:30 -04:00
|
|
|
/*
|
|
|
|
* Even though Imagick uses less PHP memory than GD, set higher limit
|
|
|
|
* for users that have low PHP.ini limits.
|
|
|
|
*/
|
2016-07-08 10:37:30 -04:00
|
|
|
wp_raise_memory_limit( 'image' );
|
2012-12-03 14:44:58 -05:00
|
|
|
|
2012-10-01 16:59:06 -04:00
|
|
|
try {
|
2017-11-30 18:11:00 -05:00
|
|
|
$this->image = new Imagick();
|
2016-12-12 01:19:41 -05:00
|
|
|
$file_extension = strtolower( pathinfo( $this->file, PATHINFO_EXTENSION ) );
|
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.
Built from https://develop.svn.wordpress.org/trunk@38949
git-svn-id: http://core.svn.wordpress.org/trunk@38892 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 03:28:32 -04:00
|
|
|
|
2019-06-14 21:02:52 -04:00
|
|
|
if ( 'pdf' === $file_extension ) {
|
2020-10-16 06:48:07 -04:00
|
|
|
$pdf_loaded = $this->pdf_load_source();
|
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.
Built from https://develop.svn.wordpress.org/trunk@38949
git-svn-id: http://core.svn.wordpress.org/trunk@38892 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-26 03:28:32 -04:00
|
|
|
|
2020-10-16 06:48:07 -04:00
|
|
|
if ( is_wp_error( $pdf_loaded ) ) {
|
|
|
|
return $pdf_loaded;
|
|
|
|
}
|
|
|
|
} else {
|
Media: Support Stream Wrappers In `WP_Image_Editor_Imagick`
Since `WP_Image_Editor`'s introduction, stream wrappers have functioned in `WP_Image_Editor_GD`, but haven't been properly supported in `WP_Image_Editor_Imagick`.
- Detects stream wrappers and uses `file_put_contents()` along with `Imagick::read/getImageBlob()` for handling when necessary.
- Introduces private method, `WP_Image_Editor_Imagick::write_image` to handle detection and proper saving.
- Introduces `WP_Test_Stream` class for testing stream wrappers, along with new tests for Imagick's stream handling and a stream filename test.
Adds requirement for `Imagick::readImageBlob()`, available in Imagick >= 2.0.0, which aligns with the current requirement of Imagick >= 2.2.0.
Props p00ya, calin, joemcgill, pputzer, jimyaghi, mikeschroder.
Fixes #42663.
Built from https://develop.svn.wordpress.org/trunk@49230
git-svn-id: http://core.svn.wordpress.org/trunk@48992 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-20 10:37:05 -04:00
|
|
|
if ( wp_is_stream( $this->file ) ) {
|
|
|
|
// Due to reports of issues with streams with `Imagick::readImageFile()`, uses `Imagick::readImageBlob()` instead.
|
|
|
|
$this->image->readImageBlob( file_get_contents( $this->file ), $this->file );
|
|
|
|
} else {
|
|
|
|
$this->image->readImage( $this->file );
|
|
|
|
}
|
2020-10-16 06:48:07 -04:00
|
|
|
}
|
2012-10-01 16:59:06 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! $this->image->valid() ) {
|
|
|
|
return new WP_Error( 'invalid_image', __( 'File is not an image.' ), $this->file );
|
|
|
|
}
|
2012-10-01 16:59:06 -04:00
|
|
|
|
2020-01-28 19:45:18 -05:00
|
|
|
// Select the first frame to handle animated images properly.
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( is_callable( array( $this->image, 'setIteratorIndex' ) ) ) {
|
|
|
|
$this->image->setIteratorIndex( 0 );
|
|
|
|
}
|
2012-11-26 17:40:34 -05:00
|
|
|
|
Media: Adjust PDF upload handling to remove non-opaque alpha channels from previews.
Previously, Imagick uploads of PDF files with non-opaque alpha channels would result in a black background replacing alpha in the generated thumbnail. This patch adds a `remove_pdf_alpha_channel()` function in the Imagick classes to use a white background instead.
Props gitlost, joemcgill, joedolson, launchinteractive, emirpprime, mwtsn, ceer, maysi, madejackson, 6adminit, costdev, oglekler.
Fixes #39216.
Built from https://develop.svn.wordpress.org/trunk@56271
git-svn-id: http://core.svn.wordpress.org/trunk@55783 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-19 18:35:27 -04:00
|
|
|
if ( 'pdf' === $file_extension ) {
|
|
|
|
$this->remove_pdf_alpha_channel();
|
|
|
|
}
|
|
|
|
|
2012-10-01 16:59:06 -04:00
|
|
|
$this->mime_type = $this->get_mime_type( $this->image->getImageFormat() );
|
2017-11-30 18:11:00 -05:00
|
|
|
} catch ( Exception $e ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
return new WP_Error( 'invalid_image', $e->getMessage(), $this->file );
|
|
|
|
}
|
|
|
|
|
|
|
|
$updated_size = $this->update_size();
|
2020-10-16 06:48:07 -04:00
|
|
|
|
2014-10-04 09:12:15 -04:00
|
|
|
if ( is_wp_error( $updated_size ) ) {
|
|
|
|
return $updated_size;
|
|
|
|
}
|
2012-10-01 16:59:06 -04:00
|
|
|
|
2014-10-04 09:12:15 -04:00
|
|
|
return $this->set_quality();
|
2012-10-01 16:59:06 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets Image Compression quality on a 1-100% scale.
|
|
|
|
*
|
|
|
|
* @since 3.5.0
|
|
|
|
*
|
|
|
|
* @param int $quality Compression Quality. Range: [1,100]
|
2015-05-22 02:18:25 -04:00
|
|
|
* @return true|WP_Error True if set successfully; WP_Error on failure.
|
2012-10-01 16:59:06 -04:00
|
|
|
*/
|
|
|
|
public function set_quality( $quality = null ) {
|
2013-12-04 17:49:10 -05:00
|
|
|
$quality_result = parent::set_quality( $quality );
|
|
|
|
if ( is_wp_error( $quality_result ) ) {
|
|
|
|
return $quality_result;
|
|
|
|
} else {
|
2014-06-27 23:50:15 -04:00
|
|
|
$quality = $this->get_quality();
|
2013-12-04 17:49:10 -05:00
|
|
|
}
|
2012-10-01 16:59:06 -04:00
|
|
|
|
|
|
|
try {
|
Images: enable WebP support.
Add support for uploading, editing and saving WebP images when supported by the server.
Add 'image/webp' to supported mime types. Correctly identify WebP images and sizes even when PHP doesn't support WebP. Resize uploaded WebP files (when supported) and use for front end markup.
Props markoheijne, blobfolio, Clorith, joemcgill, atjn, desrosj, spacedmonkey, marylauc, mikeschroder, hellofromtonya, flixos90.
Fixes #35725.
Built from https://develop.svn.wordpress.org/trunk@50810
git-svn-id: http://core.svn.wordpress.org/trunk@50419 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-05-04 10:44:58 -04:00
|
|
|
switch ( $this->mime_type ) {
|
|
|
|
case 'image/jpeg':
|
|
|
|
$this->image->setImageCompressionQuality( $quality );
|
|
|
|
$this->image->setImageCompression( imagick::COMPRESSION_JPEG );
|
|
|
|
break;
|
|
|
|
case 'image/webp':
|
2021-05-06 07:10:57 -04:00
|
|
|
$webp_info = wp_get_webp_info( $this->file );
|
|
|
|
|
2021-07-14 20:43:00 -04:00
|
|
|
if ( 'lossless' === $webp_info['type'] ) {
|
Images: enable WebP support.
Add support for uploading, editing and saving WebP images when supported by the server.
Add 'image/webp' to supported mime types. Correctly identify WebP images and sizes even when PHP doesn't support WebP. Resize uploaded WebP files (when supported) and use for front end markup.
Props markoheijne, blobfolio, Clorith, joemcgill, atjn, desrosj, spacedmonkey, marylauc, mikeschroder, hellofromtonya, flixos90.
Fixes #35725.
Built from https://develop.svn.wordpress.org/trunk@50810
git-svn-id: http://core.svn.wordpress.org/trunk@50419 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-05-04 10:44:58 -04:00
|
|
|
// Use WebP lossless settings.
|
|
|
|
$this->image->setImageCompressionQuality( 100 );
|
|
|
|
$this->image->setOption( 'webp:lossless', 'true' );
|
2021-07-14 20:43:00 -04:00
|
|
|
} else {
|
|
|
|
$this->image->setImageCompressionQuality( $quality );
|
Images: enable WebP support.
Add support for uploading, editing and saving WebP images when supported by the server.
Add 'image/webp' to supported mime types. Correctly identify WebP images and sizes even when PHP doesn't support WebP. Resize uploaded WebP files (when supported) and use for front end markup.
Props markoheijne, blobfolio, Clorith, joemcgill, atjn, desrosj, spacedmonkey, marylauc, mikeschroder, hellofromtonya, flixos90.
Fixes #35725.
Built from https://develop.svn.wordpress.org/trunk@50810
git-svn-id: http://core.svn.wordpress.org/trunk@50419 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-05-04 10:44:58 -04:00
|
|
|
}
|
|
|
|
break;
|
Media: enable AVIF support.
Add support for uploading, editing and saving AVIF images when supported by the server.
Add 'image/avif' to supported mime types. Correctly identify AVIF images and sizes even when PHP doesn't support AVIF. Resize uploaded AVIF files (when supported) and use for front end markup.
Props adamsilverstein, lukefiretoss, ayeshrajans, navjotjsingh, Tyrannous, jb510, gregbenz, nickpagz, JavierCasares, mukesh27, yguyon, swissspidy.
Fixes #51228.
Built from https://develop.svn.wordpress.org/trunk@57524
git-svn-id: http://core.svn.wordpress.org/trunk@57025 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-02-02 12:48:15 -05:00
|
|
|
case 'image/avif':
|
Images: enable WebP support.
Add support for uploading, editing and saving WebP images when supported by the server.
Add 'image/webp' to supported mime types. Correctly identify WebP images and sizes even when PHP doesn't support WebP. Resize uploaded WebP files (when supported) and use for front end markup.
Props markoheijne, blobfolio, Clorith, joemcgill, atjn, desrosj, spacedmonkey, marylauc, mikeschroder, hellofromtonya, flixos90.
Fixes #35725.
Built from https://develop.svn.wordpress.org/trunk@50810
git-svn-id: http://core.svn.wordpress.org/trunk@50419 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-05-04 10:44:58 -04:00
|
|
|
default:
|
|
|
|
$this->image->setImageCompressionQuality( $quality );
|
2012-10-01 16:59:06 -04:00
|
|
|
}
|
2017-11-30 18:11:00 -05:00
|
|
|
} catch ( Exception $e ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
return new WP_Error( 'image_quality_error', $e->getMessage() );
|
|
|
|
}
|
2013-12-04 17:49:10 -05:00
|
|
|
return true;
|
2012-10-01 16:59:06 -04:00
|
|
|
}
|
|
|
|
|
Images: enable WebP support.
Add support for uploading, editing and saving WebP images when supported by the server.
Add 'image/webp' to supported mime types. Correctly identify WebP images and sizes even when PHP doesn't support WebP. Resize uploaded WebP files (when supported) and use for front end markup.
Props markoheijne, blobfolio, Clorith, joemcgill, atjn, desrosj, spacedmonkey, marylauc, mikeschroder, hellofromtonya, flixos90.
Fixes #35725.
Built from https://develop.svn.wordpress.org/trunk@50810
git-svn-id: http://core.svn.wordpress.org/trunk@50419 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2021-05-04 10:44:58 -04:00
|
|
|
|
2012-10-01 16:59:06 -04:00
|
|
|
/**
|
2012-11-16 17:02:21 -05:00
|
|
|
* Sets or updates current image size.
|
2012-10-01 16:59:06 -04:00
|
|
|
*
|
|
|
|
* @since 3.5.0
|
|
|
|
*
|
|
|
|
* @param int $width
|
|
|
|
* @param int $height
|
2014-12-20 15:56:22 -05:00
|
|
|
* @return true|WP_Error
|
2012-10-01 16:59:06 -04:00
|
|
|
*/
|
|
|
|
protected function update_size( $width = null, $height = null ) {
|
|
|
|
$size = null;
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! $width || ! $height ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
try {
|
|
|
|
$size = $this->image->getImageGeometry();
|
2017-11-30 18:11:00 -05:00
|
|
|
} catch ( Exception $e ) {
|
2015-10-05 18:40:25 -04:00
|
|
|
return new WP_Error( 'invalid_image', __( 'Could not read image size.' ), $this->file );
|
2012-10-01 16:59:06 -04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! $width ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
$width = $size['width'];
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2012-10-01 16:59:06 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! $height ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
$height = $size['height'];
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2012-10-01 16:59:06 -04:00
|
|
|
|
Media: enable AVIF support.
Add support for uploading, editing and saving AVIF images when supported by the server.
Add 'image/avif' to supported mime types. Correctly identify AVIF images and sizes even when PHP doesn't support AVIF. Resize uploaded AVIF files (when supported) and use for front end markup.
Props adamsilverstein, lukefiretoss, ayeshrajans, navjotjsingh, Tyrannous, jb510, gregbenz, nickpagz, JavierCasares, mukesh27, yguyon, swissspidy.
Fixes #51228.
Built from https://develop.svn.wordpress.org/trunk@57524
git-svn-id: http://core.svn.wordpress.org/trunk@57025 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-02-02 12:48:15 -05:00
|
|
|
/*
|
|
|
|
* If we still don't have the image size, fall back to `wp_getimagesize`. This ensures AVIF images
|
|
|
|
* are properly sized without affecting previous `getImageGeometry` behavior.
|
|
|
|
*/
|
|
|
|
if ( ( ! $width || ! $height ) && 'image/avif' === $this->mime_type ) {
|
|
|
|
$size = wp_getimagesize( $this->file );
|
|
|
|
$width = $size[0];
|
|
|
|
$height = $size[1];
|
|
|
|
}
|
|
|
|
|
2012-10-01 16:59:06 -04:00
|
|
|
return parent::update_size( $width, $height );
|
|
|
|
}
|
|
|
|
|
2023-02-22 09:25:25 -05:00
|
|
|
/**
|
|
|
|
* Sets Imagick time limit.
|
|
|
|
*
|
|
|
|
* Depending on configuration, Imagick processing may take time.
|
|
|
|
*
|
|
|
|
* Multiple problems exist if PHP times out before ImageMagick completed:
|
|
|
|
* 1. Temporary files aren't cleaned by ImageMagick garbage collection.
|
|
|
|
* 2. No clear error is provided.
|
|
|
|
* 3. The cause of such timeout can be hard to pinpoint.
|
|
|
|
*
|
|
|
|
* This function, which is expected to be run before heavy image routines, resolves
|
|
|
|
* point 1 above by aligning Imagick's timeout with PHP's timeout, assuming it is set.
|
|
|
|
*
|
Media: Stop using and deprecate `set_imagick_time_limit()`. Seems it causes more problems than it solves.
Follow-up to #52569 and [55404].
Props: dsar, antpb, audrasjb, SergeyBiryukov, hberberoglu, mtxz, densityapps, ekazda, matt_fw, soulseekah, mikeschroder, azaozz.
Fixes: #58202.
Built from https://develop.svn.wordpress.org/trunk@56250
git-svn-id: http://core.svn.wordpress.org/trunk@55762 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-17 16:04:24 -04:00
|
|
|
* However seems it introduces more problems than it fixes,
|
|
|
|
* see https://core.trac.wordpress.org/ticket/58202.
|
|
|
|
*
|
2023-02-22 09:25:25 -05:00
|
|
|
* Note:
|
|
|
|
* - Imagick resource exhaustion does not issue catchable exceptions (yet).
|
|
|
|
* See https://github.com/Imagick/imagick/issues/333.
|
|
|
|
* - The resource limit is not saved/restored. It applies to subsequent
|
|
|
|
* image operations within the time of the HTTP request.
|
|
|
|
*
|
|
|
|
* @since 6.2.0
|
Media: Stop using and deprecate `set_imagick_time_limit()`. Seems it causes more problems than it solves.
Follow-up to #52569 and [55404].
Props: dsar, antpb, audrasjb, SergeyBiryukov, hberberoglu, mtxz, densityapps, ekazda, matt_fw, soulseekah, mikeschroder, azaozz.
Fixes: #58202.
Built from https://develop.svn.wordpress.org/trunk@56250
git-svn-id: http://core.svn.wordpress.org/trunk@55762 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-17 16:04:24 -04:00
|
|
|
* @since 6.3.0 This method was deprecated.
|
2023-02-22 09:25:25 -05:00
|
|
|
*
|
|
|
|
* @return int|null The new limit on success, null on failure.
|
|
|
|
*/
|
|
|
|
public static function set_imagick_time_limit() {
|
Media: Stop using and deprecate `set_imagick_time_limit()`. Seems it causes more problems than it solves.
Follow-up to #52569 and [55404].
Props: dsar, antpb, audrasjb, SergeyBiryukov, hberberoglu, mtxz, densityapps, ekazda, matt_fw, soulseekah, mikeschroder, azaozz.
Fixes: #58202.
Built from https://develop.svn.wordpress.org/trunk@56250
git-svn-id: http://core.svn.wordpress.org/trunk@55762 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-17 16:04:24 -04:00
|
|
|
_deprecated_function( __METHOD__, '6.3.0' );
|
|
|
|
|
2023-02-22 09:25:25 -05:00
|
|
|
if ( ! defined( 'Imagick::RESOURCETYPE_TIME' ) ) {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Returns PHP_FLOAT_MAX if unset.
|
|
|
|
$imagick_timeout = Imagick::getResourceLimit( Imagick::RESOURCETYPE_TIME );
|
|
|
|
|
|
|
|
// Convert to an integer, keeping in mind that: 0 === (int) PHP_FLOAT_MAX.
|
|
|
|
$imagick_timeout = $imagick_timeout > PHP_INT_MAX ? PHP_INT_MAX : (int) $imagick_timeout;
|
|
|
|
|
|
|
|
$php_timeout = (int) ini_get( 'max_execution_time' );
|
|
|
|
|
|
|
|
if ( $php_timeout > 1 && $php_timeout < $imagick_timeout ) {
|
|
|
|
$limit = (float) 0.8 * $php_timeout;
|
|
|
|
Imagick::setResourceLimit( Imagick::RESOURCETYPE_TIME, $limit );
|
|
|
|
|
|
|
|
return $limit;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-10-01 16:59:06 -04:00
|
|
|
/**
|
|
|
|
* Resizes current image.
|
|
|
|
*
|
2014-03-27 16:40:17 -04:00
|
|
|
* At minimum, either a height or width must be provided.
|
|
|
|
* If one of the two is set to null, the resize will
|
|
|
|
* maintain aspect ratio according to the provided dimension.
|
|
|
|
*
|
2012-11-16 17:02:21 -05:00
|
|
|
* @since 3.5.0
|
|
|
|
*
|
2023-07-11 02:31:22 -04:00
|
|
|
* @param int|null $max_w Image width.
|
|
|
|
* @param int|null $max_h Image height.
|
2023-08-18 20:10:23 -04:00
|
|
|
* @param bool|array $crop {
|
|
|
|
* Optional. Image cropping behavior. If false, the image will be scaled (default).
|
2023-08-18 13:56:17 -04:00
|
|
|
* If true, image will be cropped to the specified dimensions using center positions.
|
|
|
|
* If an array, the image will be cropped using the array to specify the crop location:
|
|
|
|
*
|
|
|
|
* @type string $0 The x crop position. Accepts 'left' 'center', or 'right'.
|
|
|
|
* @type string $1 The y crop position. Accepts 'top', 'center', or 'bottom'.
|
|
|
|
* }
|
2021-01-03 17:04:04 -05:00
|
|
|
* @return true|WP_Error
|
2012-10-01 16:59:06 -04:00
|
|
|
*/
|
|
|
|
public function resize( $max_w, $max_h, $crop = false ) {
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ( $this->size['width'] == $max_w ) && ( $this->size['height'] == $max_h ) ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
return true;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2012-10-01 16:59:06 -04:00
|
|
|
|
|
|
|
$dims = image_resize_dimensions( $this->size['width'], $this->size['height'], $max_w, $max_h, $crop );
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! $dims ) {
|
|
|
|
return new WP_Error( 'error_getting_dimensions', __( 'Could not calculate resized image dimensions' ) );
|
|
|
|
}
|
2019-06-14 21:02:52 -04:00
|
|
|
|
2012-10-01 16:59:06 -04:00
|
|
|
list( $dst_x, $dst_y, $src_x, $src_y, $dst_w, $dst_h, $src_w, $src_h ) = $dims;
|
|
|
|
|
|
|
|
if ( $crop ) {
|
|
|
|
return $this->crop( $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h );
|
|
|
|
}
|
|
|
|
|
2020-01-28 19:45:18 -05:00
|
|
|
// Execute the resize.
|
2016-02-24 17:51:26 -05:00
|
|
|
$thumb_result = $this->thumbnail_image( $dst_w, $dst_h );
|
|
|
|
if ( is_wp_error( $thumb_result ) ) {
|
|
|
|
return $thumb_result;
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this->update_size( $dst_w, $dst_h );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Efficiently resize the current image
|
|
|
|
*
|
|
|
|
* This is a WordPress specific implementation of Imagick::thumbnailImage(),
|
|
|
|
* which resizes an image to given dimensions and removes any associated profiles.
|
|
|
|
*
|
|
|
|
* @since 4.5.0
|
|
|
|
*
|
|
|
|
* @param int $dst_w The destination width.
|
|
|
|
* @param int $dst_h The destination height.
|
|
|
|
* @param string $filter_name Optional. The Imagick filter to use when resizing. Default 'FILTER_TRIANGLE'.
|
|
|
|
* @param bool $strip_meta Optional. Strip all profiles, excluding color profiles, from the image. Default true.
|
2021-01-03 16:57:09 -05:00
|
|
|
* @return void|WP_Error
|
2016-02-24 17:51:26 -05:00
|
|
|
*/
|
|
|
|
protected function thumbnail_image( $dst_w, $dst_h, $filter_name = 'FILTER_TRIANGLE', $strip_meta = true ) {
|
|
|
|
$allowed_filters = array(
|
|
|
|
'FILTER_POINT',
|
|
|
|
'FILTER_BOX',
|
|
|
|
'FILTER_TRIANGLE',
|
|
|
|
'FILTER_HERMITE',
|
|
|
|
'FILTER_HANNING',
|
|
|
|
'FILTER_HAMMING',
|
|
|
|
'FILTER_BLACKMAN',
|
|
|
|
'FILTER_GAUSSIAN',
|
|
|
|
'FILTER_QUADRATIC',
|
|
|
|
'FILTER_CUBIC',
|
|
|
|
'FILTER_CATROM',
|
|
|
|
'FILTER_MITCHELL',
|
|
|
|
'FILTER_LANCZOS',
|
|
|
|
'FILTER_BESSEL',
|
|
|
|
'FILTER_SINC',
|
|
|
|
);
|
|
|
|
|
|
|
|
/**
|
General: Remove “whitelist” and “blacklist” in favor of more clear and inclusive language.
“The WordPress open source community cares about diversity. We strive to maintain a welcoming environment where everyone can feel included.”
With this commit, all occurrences of “whitelist” and “blacklist” (with the single exception of the `$new_whitelist_options` global variable) are removed. A new ticket has been opened to explore renaming the `$new_whitelist_options` variable (#50434).
Changing to more specific names or rewording sentences containing these terms not only makes the code more inclusive, but also helps provide clarity. These terms are often ambiguous. What is being blocked or allowed is not always immediately clear. This can make it more difficult for non-native English speakers to read through the codebase.
Words matter. If one contributor feels more welcome because these terms are removed, this was worth the effort.
Props strangerstudios, jorbin, desrosj, joemcgill, timothyblynjacobs, ocean90, ayeshrajans, davidbaumwald, earnjam.
See #48900, #50434.
Fixes #50413.
Built from https://develop.svn.wordpress.org/trunk@48121
git-svn-id: http://core.svn.wordpress.org/trunk@47890 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-06-22 13:26:13 -04:00
|
|
|
* Set the filter value if '$filter_name' name is in the allowed list and the related
|
|
|
|
* Imagick constant is defined or fall back to the default filter.
|
2016-02-24 17:51:26 -05:00
|
|
|
*/
|
2019-06-14 21:02:52 -04:00
|
|
|
if ( in_array( $filter_name, $allowed_filters, true ) && defined( 'Imagick::' . $filter_name ) ) {
|
2016-02-24 17:51:26 -05:00
|
|
|
$filter = constant( 'Imagick::' . $filter_name );
|
|
|
|
} else {
|
2016-03-08 23:44:26 -05:00
|
|
|
$filter = defined( 'Imagick::FILTER_TRIANGLE' ) ? Imagick::FILTER_TRIANGLE : false;
|
2016-02-24 17:51:26 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2016-05-22 14:15:28 -04:00
|
|
|
* Filters whether to strip metadata from images when they're resized.
|
2016-02-24 17:51:26 -05:00
|
|
|
*
|
|
|
|
* This filter only applies when resizing using the Imagick editor since GD
|
|
|
|
* always strips profiles by default.
|
|
|
|
*
|
|
|
|
* @since 4.5.0
|
|
|
|
*
|
|
|
|
* @param bool $strip_meta Whether to strip image metadata during resizing. Default true.
|
|
|
|
*/
|
2016-03-08 23:44:26 -05:00
|
|
|
if ( apply_filters( 'image_strip_meta', $strip_meta ) ) {
|
|
|
|
$this->strip_meta(); // Fail silently if not supported.
|
2016-02-24 17:51:26 -05:00
|
|
|
}
|
|
|
|
|
2012-10-01 16:59:06 -04:00
|
|
|
try {
|
2016-02-24 17:51:26 -05:00
|
|
|
/*
|
|
|
|
* To be more efficient, resample large images to 5x the destination size before resizing
|
|
|
|
* whenever the output size is less that 1/3 of the original image size (1/3^2 ~= .111),
|
|
|
|
* unless we would be resampling to a scale smaller than 128x128.
|
|
|
|
*/
|
2016-03-08 23:44:26 -05:00
|
|
|
if ( is_callable( array( $this->image, 'sampleImage' ) ) ) {
|
2017-11-30 18:11:00 -05:00
|
|
|
$resize_ratio = ( $dst_w / $this->size['width'] ) * ( $dst_h / $this->size['height'] );
|
2016-03-08 23:44:26 -05:00
|
|
|
$sample_factor = 5;
|
2016-02-24 17:51:26 -05:00
|
|
|
|
2016-03-08 23:44:26 -05:00
|
|
|
if ( $resize_ratio < .111 && ( $dst_w * $sample_factor > 128 && $dst_h * $sample_factor > 128 ) ) {
|
|
|
|
$this->image->sampleImage( $dst_w * $sample_factor, $dst_h * $sample_factor );
|
|
|
|
}
|
2016-02-24 17:51:26 -05:00
|
|
|
}
|
|
|
|
|
2016-03-08 23:44:26 -05:00
|
|
|
/*
|
|
|
|
* Use resizeImage() when it's available and a valid filter value is set.
|
|
|
|
* Otherwise, fall back to the scaleImage() method for resizing, which
|
|
|
|
* results in better image quality over resizeImage() with default filter
|
2016-05-13 14:41:31 -04:00
|
|
|
* settings and retains backward compatibility with pre 4.5 functionality.
|
2016-03-08 23:44:26 -05:00
|
|
|
*/
|
|
|
|
if ( is_callable( array( $this->image, 'resizeImage' ) ) && $filter ) {
|
|
|
|
$this->image->setOption( 'filter:support', '2.0' );
|
|
|
|
$this->image->resizeImage( $dst_w, $dst_h, $filter, 1 );
|
|
|
|
} else {
|
|
|
|
$this->image->scaleImage( $dst_w, $dst_h );
|
|
|
|
}
|
2016-02-24 17:51:26 -05:00
|
|
|
|
|
|
|
// Set appropriate quality settings after resizing.
|
2019-06-14 21:02:52 -04:00
|
|
|
if ( 'image/jpeg' === $this->mime_type ) {
|
2016-03-08 23:44:26 -05:00
|
|
|
if ( is_callable( array( $this->image, 'unsharpMaskImage' ) ) ) {
|
|
|
|
$this->image->unsharpMaskImage( 0.25, 0.25, 8, 0.065 );
|
|
|
|
}
|
|
|
|
|
2016-02-24 17:51:26 -05:00
|
|
|
$this->image->setOption( 'jpeg:fancy-upsampling', 'off' );
|
|
|
|
}
|
|
|
|
|
|
|
|
if ( 'image/png' === $this->mime_type ) {
|
|
|
|
$this->image->setOption( 'png:compression-filter', '5' );
|
|
|
|
$this->image->setOption( 'png:compression-level', '9' );
|
|
|
|
$this->image->setOption( 'png:compression-strategy', '1' );
|
|
|
|
$this->image->setOption( 'png:exclude-chunk', 'all' );
|
|
|
|
}
|
|
|
|
|
2016-03-08 23:44:26 -05:00
|
|
|
/*
|
2016-02-24 17:51:26 -05:00
|
|
|
* If alpha channel is not defined, set it opaque.
|
|
|
|
*
|
|
|
|
* Note that Imagick::getImageAlphaChannel() is only available if Imagick
|
|
|
|
* has been compiled against ImageMagick version 6.4.0 or newer.
|
2012-10-01 16:59:06 -04:00
|
|
|
*/
|
2016-03-08 23:44:26 -05:00
|
|
|
if ( is_callable( array( $this->image, 'getImageAlphaChannel' ) )
|
|
|
|
&& is_callable( array( $this->image, 'setImageAlphaChannel' ) )
|
2016-04-13 02:18:28 -04:00
|
|
|
&& defined( 'Imagick::ALPHACHANNEL_UNDEFINED' )
|
|
|
|
&& defined( 'Imagick::ALPHACHANNEL_OPAQUE' )
|
2016-03-08 23:44:26 -05:00
|
|
|
) {
|
|
|
|
if ( $this->image->getImageAlphaChannel() === Imagick::ALPHACHANNEL_UNDEFINED ) {
|
|
|
|
$this->image->setImageAlphaChannel( Imagick::ALPHACHANNEL_OPAQUE );
|
|
|
|
}
|
2016-02-24 17:51:26 -05:00
|
|
|
}
|
|
|
|
|
2016-03-08 23:44:26 -05:00
|
|
|
// Limit the bit depth of resized images to 8 bits per channel.
|
|
|
|
if ( is_callable( array( $this->image, 'getImageDepth' ) ) && is_callable( array( $this->image, 'setImageDepth' ) ) ) {
|
|
|
|
if ( 8 < $this->image->getImageDepth() ) {
|
|
|
|
$this->image->setImageDepth( 8 );
|
|
|
|
}
|
2016-02-24 17:51:26 -05:00
|
|
|
}
|
2017-11-30 18:11:00 -05:00
|
|
|
} catch ( Exception $e ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
return new WP_Error( 'image_resize_error', $e->getMessage() );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2019-08-25 18:21:58 -04:00
|
|
|
* Create multiple smaller images from a single source.
|
|
|
|
*
|
|
|
|
* Attempts to create all sub-sizes and returns the meta data at the end. This
|
|
|
|
* may result in the server running out of resources. When it fails there may be few
|
|
|
|
* "orphaned" images left over as the meta data is never returned and saved.
|
|
|
|
*
|
|
|
|
* As of 5.3.0 the preferred way to do this is with `make_subsize()`. It creates
|
|
|
|
* the new images one at a time and allows for the meta data to be saved after
|
|
|
|
* each new image is created.
|
2013-04-22 16:28:05 -04:00
|
|
|
*
|
2012-11-16 17:02:21 -05:00
|
|
|
* @since 3.5.0
|
|
|
|
*
|
2013-10-08 13:19:09 -04:00
|
|
|
* @param array $sizes {
|
2022-09-19 18:53:10 -04:00
|
|
|
* An array of image size data arrays.
|
2013-10-08 13:19:09 -04:00
|
|
|
*
|
2014-03-27 16:40:17 -04:00
|
|
|
* Either a height or width must be provided.
|
|
|
|
* If one of the two is set to null, the resize will
|
|
|
|
* maintain aspect ratio according to the provided dimension.
|
|
|
|
*
|
2022-04-29 15:24:09 -04:00
|
|
|
* @type array ...$0 {
|
2015-10-12 12:34:23 -04:00
|
|
|
* Array of height, width values, and whether to crop.
|
2015-10-12 12:27:24 -04:00
|
|
|
*
|
2023-07-11 02:31:22 -04:00
|
|
|
* @type int $width Image width. Optional if `$height` is specified.
|
|
|
|
* @type int $height Image height. Optional if `$width` is specified.
|
|
|
|
* @type bool|array $crop Optional. Whether to crop the image. Default false.
|
2013-10-08 13:19:09 -04:00
|
|
|
* }
|
|
|
|
* }
|
2014-03-27 16:40:17 -04:00
|
|
|
* @return array An array of resized images' metadata by size.
|
2012-10-01 16:59:06 -04:00
|
|
|
*/
|
|
|
|
public function multi_resize( $sizes ) {
|
2019-06-14 21:02:52 -04:00
|
|
|
$metadata = array();
|
2012-10-01 16:59:06 -04:00
|
|
|
|
|
|
|
foreach ( $sizes as $size => $size_data ) {
|
2019-06-14 21:02:52 -04:00
|
|
|
$meta = $this->make_subsize( $size_data );
|
2012-10-01 16:59:06 -04:00
|
|
|
|
2019-06-14 21:02:52 -04:00
|
|
|
if ( ! is_wp_error( $meta ) ) {
|
|
|
|
$metadata[ $size ] = $meta;
|
2014-03-27 16:40:17 -04:00
|
|
|
}
|
2019-06-14 21:02:52 -04:00
|
|
|
}
|
2013-04-22 16:28:05 -04:00
|
|
|
|
2019-06-14 21:02:52 -04:00
|
|
|
return $metadata;
|
|
|
|
}
|
2014-03-27 16:40:17 -04:00
|
|
|
|
2019-06-14 21:02:52 -04:00
|
|
|
/**
|
|
|
|
* Create an image sub-size and return the image meta data value for it.
|
|
|
|
*
|
|
|
|
* @since 5.3.0
|
|
|
|
*
|
2019-10-26 16:43:04 -04:00
|
|
|
* @param array $size_data {
|
|
|
|
* Array of size data.
|
|
|
|
*
|
2023-07-11 02:31:22 -04:00
|
|
|
* @type int $width The maximum width in pixels.
|
|
|
|
* @type int $height The maximum height in pixels.
|
|
|
|
* @type bool|array $crop Whether to crop the image to exact dimensions.
|
2019-10-26 16:43:04 -04:00
|
|
|
* }
|
2019-11-10 21:43:03 -05:00
|
|
|
* @return array|WP_Error The image data array for inclusion in the `sizes` array in the image meta,
|
|
|
|
* WP_Error object on error.
|
2019-06-14 21:02:52 -04:00
|
|
|
*/
|
|
|
|
public function make_subsize( $size_data ) {
|
|
|
|
if ( ! isset( $size_data['width'] ) && ! isset( $size_data['height'] ) ) {
|
|
|
|
return new WP_Error( 'image_subsize_create_error', __( 'Cannot resize the image. Both width and height are not set.' ) );
|
|
|
|
}
|
|
|
|
|
2022-09-19 18:53:10 -04:00
|
|
|
$orig_size = $this->size;
|
|
|
|
$orig_image = $this->image->getImage();
|
2019-06-14 21:02:52 -04:00
|
|
|
|
|
|
|
if ( ! isset( $size_data['width'] ) ) {
|
|
|
|
$size_data['width'] = null;
|
|
|
|
}
|
2013-04-22 16:28:05 -04:00
|
|
|
|
2019-06-14 21:02:52 -04:00
|
|
|
if ( ! isset( $size_data['height'] ) ) {
|
|
|
|
$size_data['height'] = null;
|
|
|
|
}
|
2012-10-01 16:59:06 -04:00
|
|
|
|
2019-06-14 21:02:52 -04:00
|
|
|
if ( ! isset( $size_data['crop'] ) ) {
|
|
|
|
$size_data['crop'] = false;
|
|
|
|
}
|
2012-10-01 16:59:06 -04:00
|
|
|
|
2023-02-08 15:51:21 -05:00
|
|
|
if ( ( $this->size['width'] === $size_data['width'] ) && ( $this->size['height'] === $size_data['height'] ) ) {
|
2023-02-07 12:24:15 -05:00
|
|
|
return new WP_Error( 'image_subsize_create_error', __( 'The image already has the requested size.' ) );
|
|
|
|
}
|
|
|
|
|
2019-06-14 21:02:52 -04:00
|
|
|
$resized = $this->resize( $size_data['width'], $size_data['height'], $size_data['crop'] );
|
2012-10-01 16:59:06 -04:00
|
|
|
|
2019-06-14 21:02:52 -04:00
|
|
|
if ( is_wp_error( $resized ) ) {
|
|
|
|
$saved = $resized;
|
|
|
|
} else {
|
|
|
|
$saved = $this->_save( $this->image );
|
2012-10-01 16:59:06 -04:00
|
|
|
|
2019-06-14 21:02:52 -04:00
|
|
|
$this->image->clear();
|
|
|
|
$this->image->destroy();
|
|
|
|
$this->image = null;
|
2012-10-01 16:59:06 -04:00
|
|
|
}
|
|
|
|
|
2022-09-19 18:53:10 -04:00
|
|
|
$this->size = $orig_size;
|
|
|
|
$this->image = $orig_image;
|
2012-10-01 16:59:06 -04:00
|
|
|
|
2019-06-14 21:02:52 -04:00
|
|
|
if ( ! is_wp_error( $saved ) ) {
|
|
|
|
unset( $saved['path'] );
|
|
|
|
}
|
|
|
|
|
|
|
|
return $saved;
|
2012-10-01 16:59:06 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Crops Image.
|
|
|
|
*
|
|
|
|
* @since 3.5.0
|
|
|
|
*
|
2020-07-22 20:52:05 -04:00
|
|
|
* @param int $src_x The start x position to crop from.
|
|
|
|
* @param int $src_y The start y position to crop from.
|
|
|
|
* @param int $src_w The width to crop.
|
|
|
|
* @param int $src_h The height to crop.
|
|
|
|
* @param int $dst_w Optional. The destination width.
|
|
|
|
* @param int $dst_h Optional. The destination height.
|
2015-06-26 21:03:25 -04:00
|
|
|
* @param bool $src_abs Optional. If the source crop points are absolute.
|
2021-01-03 17:04:04 -05:00
|
|
|
* @return true|WP_Error
|
2012-10-01 16:59:06 -04:00
|
|
|
*/
|
|
|
|
public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false ) {
|
|
|
|
if ( $src_abs ) {
|
|
|
|
$src_w -= $src_x;
|
|
|
|
$src_h -= $src_y;
|
|
|
|
}
|
|
|
|
|
|
|
|
try {
|
|
|
|
$this->image->cropImage( $src_w, $src_h, $src_x, $src_y );
|
2017-11-30 18:11:00 -05:00
|
|
|
$this->image->setImagePage( $src_w, $src_h, 0, 0 );
|
2012-10-01 16:59:06 -04:00
|
|
|
|
|
|
|
if ( $dst_w || $dst_h ) {
|
2023-07-09 17:25:23 -04:00
|
|
|
/*
|
|
|
|
* If destination width/height isn't specified,
|
|
|
|
* use same as width/height from source.
|
|
|
|
*/
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! $dst_w ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
$dst_w = $src_w;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
|
|
|
if ( ! $dst_h ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
$dst_h = $src_h;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2012-10-01 16:59:06 -04:00
|
|
|
|
2016-02-24 17:51:26 -05:00
|
|
|
$thumb_result = $this->thumbnail_image( $dst_w, $dst_h );
|
|
|
|
if ( is_wp_error( $thumb_result ) ) {
|
|
|
|
return $thumb_result;
|
|
|
|
}
|
|
|
|
|
2012-12-06 02:56:04 -05:00
|
|
|
return $this->update_size();
|
2012-10-01 16:59:06 -04:00
|
|
|
}
|
2017-11-30 18:11:00 -05:00
|
|
|
} catch ( Exception $e ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
return new WP_Error( 'image_crop_error', $e->getMessage() );
|
|
|
|
}
|
2020-08-16 09:33:09 -04:00
|
|
|
|
2012-12-06 02:56:04 -05:00
|
|
|
return $this->update_size();
|
2012-10-01 16:59:06 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Rotates current image counter-clockwise by $angle.
|
|
|
|
*
|
|
|
|
* @since 3.5.0
|
|
|
|
*
|
|
|
|
* @param float $angle
|
2015-05-22 02:18:25 -04:00
|
|
|
* @return true|WP_Error
|
2012-10-01 16:59:06 -04:00
|
|
|
*/
|
|
|
|
public function rotate( $angle ) {
|
|
|
|
/**
|
|
|
|
* $angle is 360-$angle because Imagick rotates clockwise
|
|
|
|
* (GD rotates counter-clockwise)
|
|
|
|
*/
|
|
|
|
try {
|
2017-11-30 18:11:00 -05:00
|
|
|
$this->image->rotateImage( new ImagickPixel( 'none' ), 360 - $angle );
|
2013-09-28 02:37:11 -04:00
|
|
|
|
2022-01-25 08:55:05 -05:00
|
|
|
// Normalize EXIF orientation data so that display is consistent across devices.
|
2017-02-26 23:22:51 -05:00
|
|
|
if ( is_callable( array( $this->image, 'setImageOrientation' ) ) && defined( 'Imagick::ORIENTATION_TOPLEFT' ) ) {
|
|
|
|
$this->image->setImageOrientation( Imagick::ORIENTATION_TOPLEFT );
|
|
|
|
}
|
2017-02-25 00:26:41 -05:00
|
|
|
|
2013-09-28 02:37:11 -04:00
|
|
|
// Since this changes the dimensions of the image, update the size.
|
|
|
|
$result = $this->update_size();
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( is_wp_error( $result ) ) {
|
2013-09-28 02:37:11 -04:00
|
|
|
return $result;
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2013-09-28 02:37:11 -04:00
|
|
|
|
|
|
|
$this->image->setImagePage( $this->size['width'], $this->size['height'], 0, 0 );
|
2017-11-30 18:11:00 -05:00
|
|
|
} catch ( Exception $e ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
return new WP_Error( 'image_rotate_error', $e->getMessage() );
|
|
|
|
}
|
2020-08-16 09:33:09 -04:00
|
|
|
|
2013-09-28 02:37:11 -04:00
|
|
|
return true;
|
2012-10-01 16:59:06 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-11-16 17:02:21 -05:00
|
|
|
* Flips current image.
|
2012-10-01 16:59:06 -04:00
|
|
|
*
|
|
|
|
* @since 3.5.0
|
|
|
|
*
|
2015-06-26 21:03:25 -04:00
|
|
|
* @param bool $horz Flip along Horizontal Axis
|
|
|
|
* @param bool $vert Flip along Vertical Axis
|
2015-07-02 17:05:24 -04:00
|
|
|
* @return true|WP_Error
|
2012-10-01 16:59:06 -04:00
|
|
|
*/
|
|
|
|
public function flip( $horz, $vert ) {
|
|
|
|
try {
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( $horz ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
$this->image->flipImage();
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2012-10-01 16:59:06 -04:00
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( $vert ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
$this->image->flopImage();
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
Media/Upload: rotate images on upload according to EXIF Orientation.
Props msaggiorato, wpdavis, markoheijnen, dhuyvetter, msaggiorato, n7studios, triplejumper12, pbiron, mikeschroder, joemcgill, azaozz.
Fixes #14459.
Built from https://develop.svn.wordpress.org/trunk@46202
git-svn-id: http://core.svn.wordpress.org/trunk@46014 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-20 14:21:57 -04:00
|
|
|
|
2022-01-25 08:55:05 -05:00
|
|
|
// Normalize EXIF orientation data so that display is consistent across devices.
|
Media/Upload: rotate images on upload according to EXIF Orientation.
Props msaggiorato, wpdavis, markoheijnen, dhuyvetter, msaggiorato, n7studios, triplejumper12, pbiron, mikeschroder, joemcgill, azaozz.
Fixes #14459.
Built from https://develop.svn.wordpress.org/trunk@46202
git-svn-id: http://core.svn.wordpress.org/trunk@46014 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-20 14:21:57 -04:00
|
|
|
if ( is_callable( array( $this->image, 'setImageOrientation' ) ) && defined( 'Imagick::ORIENTATION_TOPLEFT' ) ) {
|
|
|
|
$this->image->setImageOrientation( Imagick::ORIENTATION_TOPLEFT );
|
|
|
|
}
|
2017-11-30 18:11:00 -05:00
|
|
|
} catch ( Exception $e ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
return new WP_Error( 'image_flip_error', $e->getMessage() );
|
|
|
|
}
|
Media/Upload: rotate images on upload according to EXIF Orientation.
Props msaggiorato, wpdavis, markoheijnen, dhuyvetter, msaggiorato, n7studios, triplejumper12, pbiron, mikeschroder, joemcgill, azaozz.
Fixes #14459.
Built from https://develop.svn.wordpress.org/trunk@46202
git-svn-id: http://core.svn.wordpress.org/trunk@46014 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-20 14:21:57 -04:00
|
|
|
|
2012-10-01 16:59:06 -04:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
Media/Upload: rotate images on upload according to EXIF Orientation.
Props msaggiorato, wpdavis, markoheijnen, dhuyvetter, msaggiorato, n7studios, triplejumper12, pbiron, mikeschroder, joemcgill, azaozz.
Fixes #14459.
Built from https://develop.svn.wordpress.org/trunk@46202
git-svn-id: http://core.svn.wordpress.org/trunk@46014 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2019-09-20 14:21:57 -04:00
|
|
|
/**
|
|
|
|
* Check if a JPEG image has EXIF Orientation tag and rotate it if needed.
|
|
|
|
*
|
|
|
|
* As ImageMagick copies the EXIF data to the flipped/rotated image, proceed only
|
|
|
|
* if EXIF Orientation can be reset afterwards.
|
|
|
|
*
|
|
|
|
* @since 5.3.0
|
|
|
|
*
|
|
|
|
* @return bool|WP_Error True if the image was rotated. False if no EXIF data or if the image doesn't need rotation.
|
|
|
|
* WP_Error if error while rotating.
|
|
|
|
*/
|
|
|
|
public function maybe_exif_rotate() {
|
|
|
|
if ( is_callable( array( $this->image, 'setImageOrientation' ) ) && defined( 'Imagick::ORIENTATION_TOPLEFT' ) ) {
|
|
|
|
return parent::maybe_exif_rotate();
|
|
|
|
} else {
|
|
|
|
return new WP_Error( 'write_exif_error', __( 'The image cannot be rotated because the embedded meta data cannot be updated.' ) );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-10-01 16:59:06 -04:00
|
|
|
/**
|
2012-11-16 17:02:21 -05:00
|
|
|
* Saves current image to file.
|
|
|
|
*
|
|
|
|
* @since 3.5.0
|
2022-06-21 07:18:17 -04:00
|
|
|
* @since 6.0.0 The `$filesize` value was added to the returned array.
|
2012-10-01 16:59:06 -04:00
|
|
|
*
|
2021-09-09 16:39:58 -04:00
|
|
|
* @param string $destfilename Optional. Destination filename. Default null.
|
|
|
|
* @param string $mime_type Optional. The mime-type. Default null.
|
2022-06-21 07:18:17 -04:00
|
|
|
* @return array|WP_Error {
|
|
|
|
* Array on success or WP_Error if the file failed to save.
|
|
|
|
*
|
|
|
|
* @type string $path Path to the image file.
|
|
|
|
* @type string $file Name of the image file.
|
|
|
|
* @type int $width Image width.
|
|
|
|
* @type int $height Image height.
|
|
|
|
* @type string $mime-type The mime type of the image.
|
|
|
|
* @type int $filesize File size of the image.
|
|
|
|
* }
|
2012-10-01 16:59:06 -04:00
|
|
|
*/
|
|
|
|
public function save( $destfilename = null, $mime_type = null ) {
|
|
|
|
$saved = $this->_save( $this->image, $destfilename, $mime_type );
|
|
|
|
|
|
|
|
if ( ! is_wp_error( $saved ) ) {
|
2017-11-30 18:11:00 -05:00
|
|
|
$this->file = $saved['path'];
|
2012-10-01 16:59:06 -04:00
|
|
|
$this->mime_type = $saved['mime-type'];
|
|
|
|
|
|
|
|
try {
|
|
|
|
$this->image->setImageFormat( strtoupper( $this->get_extension( $this->mime_type ) ) );
|
2017-11-30 18:11:00 -05:00
|
|
|
} catch ( Exception $e ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
return new WP_Error( 'image_save_error', $e->getMessage(), $this->file );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return $saved;
|
|
|
|
}
|
|
|
|
|
Media: Adjust PDF upload handling to remove non-opaque alpha channels from previews.
Previously, Imagick uploads of PDF files with non-opaque alpha channels would result in a black background replacing alpha in the generated thumbnail. This patch adds a `remove_pdf_alpha_channel()` function in the Imagick classes to use a white background instead.
Props gitlost, joemcgill, joedolson, launchinteractive, emirpprime, mwtsn, ceer, maysi, madejackson, 6adminit, costdev, oglekler.
Fixes #39216.
Built from https://develop.svn.wordpress.org/trunk@56271
git-svn-id: http://core.svn.wordpress.org/trunk@55783 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2023-07-19 18:35:27 -04:00
|
|
|
/**
|
|
|
|
* Removes PDF alpha after it's been read.
|
|
|
|
*
|
|
|
|
* @since 6.4.0
|
|
|
|
*/
|
|
|
|
protected function remove_pdf_alpha_channel() {
|
|
|
|
$version = Imagick::getVersion();
|
|
|
|
// Remove alpha channel if possible to avoid black backgrounds for Ghostscript >= 9.14. RemoveAlphaChannel added in ImageMagick 6.7.5.
|
|
|
|
if ( $version['versionNumber'] >= 0x675 ) {
|
|
|
|
try {
|
|
|
|
// Imagick::ALPHACHANNEL_REMOVE mapped to RemoveAlphaChannel in PHP imagick 3.2.0b2.
|
|
|
|
$this->image->setImageAlphaChannel( defined( 'Imagick::ALPHACHANNEL_REMOVE' ) ? Imagick::ALPHACHANNEL_REMOVE : 12 );
|
|
|
|
} catch ( Exception $e ) {
|
|
|
|
return new WP_Error( 'pdf_alpha_process_failed', $e->getMessage() );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-05-22 02:18:25 -04:00
|
|
|
/**
|
2022-06-21 07:18:17 -04:00
|
|
|
* @since 3.5.0
|
|
|
|
* @since 6.0.0 The `$filesize` value was added to the returned array.
|
|
|
|
*
|
2015-05-22 02:18:25 -04:00
|
|
|
* @param Imagick $image
|
2020-07-23 16:01:04 -04:00
|
|
|
* @param string $filename
|
|
|
|
* @param string $mime_type
|
2022-06-21 07:18:17 -04:00
|
|
|
* @return array|WP_Error {
|
|
|
|
* Array on success or WP_Error if the file failed to save.
|
|
|
|
*
|
|
|
|
* @type string $path Path to the image file.
|
|
|
|
* @type string $file Name of the image file.
|
|
|
|
* @type int $width Image width.
|
|
|
|
* @type int $height Image height.
|
|
|
|
* @type string $mime-type The mime type of the image.
|
|
|
|
* @type int $filesize File size of the image.
|
|
|
|
* }
|
2015-05-22 02:18:25 -04:00
|
|
|
*/
|
2012-10-01 16:59:06 -04:00
|
|
|
protected function _save( $image, $filename = null, $mime_type = null ) {
|
|
|
|
list( $filename, $extension, $mime_type ) = $this->get_output_format( $filename, $mime_type );
|
|
|
|
|
2017-11-30 18:11:00 -05:00
|
|
|
if ( ! $filename ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
$filename = $this->generate_filename( null, null, $extension );
|
2017-11-30 18:11:00 -05:00
|
|
|
}
|
2012-10-01 16:59:06 -04:00
|
|
|
|
|
|
|
try {
|
2020-01-28 19:45:18 -05:00
|
|
|
// Store initial format.
|
2012-10-01 16:59:06 -04:00
|
|
|
$orig_format = $this->image->getImageFormat();
|
|
|
|
|
|
|
|
$this->image->setImageFormat( strtoupper( $this->get_extension( $mime_type ) ) );
|
Media: Support Stream Wrappers In `WP_Image_Editor_Imagick`
Since `WP_Image_Editor`'s introduction, stream wrappers have functioned in `WP_Image_Editor_GD`, but haven't been properly supported in `WP_Image_Editor_Imagick`.
- Detects stream wrappers and uses `file_put_contents()` along with `Imagick::read/getImageBlob()` for handling when necessary.
- Introduces private method, `WP_Image_Editor_Imagick::write_image` to handle detection and proper saving.
- Introduces `WP_Test_Stream` class for testing stream wrappers, along with new tests for Imagick's stream handling and a stream filename test.
Adds requirement for `Imagick::readImageBlob()`, available in Imagick >= 2.0.0, which aligns with the current requirement of Imagick >= 2.2.0.
Props p00ya, calin, joemcgill, pputzer, jimyaghi, mikeschroder.
Fixes #42663.
Built from https://develop.svn.wordpress.org/trunk@49230
git-svn-id: http://core.svn.wordpress.org/trunk@48992 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-20 10:37:05 -04:00
|
|
|
} catch ( Exception $e ) {
|
|
|
|
return new WP_Error( 'image_save_error', $e->getMessage(), $filename );
|
|
|
|
}
|
2012-10-01 16:59:06 -04:00
|
|
|
|
Media: enable control of progressive image output.
Add a new `image_save_progressive` filter which developers can use to control whether intermediate image sizes are saved in a progressive format (when available). By default, progressive image output is not used, matching the previous behavior.
Props: adamsilverstein, _ck_, markoheijnen, SergeyBiryukov, Japh, pmeenan, mikeschroder, derekspringer, buley, ericlewis, bahia0019, born2webdesign.
Fixes #21668.
Built from https://develop.svn.wordpress.org/trunk@57607
git-svn-id: http://core.svn.wordpress.org/trunk@57108 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-02-12 18:26:11 -05:00
|
|
|
if ( method_exists( $this->image, 'setInterlaceScheme' ) && method_exists( $this->image, 'getInterlaceScheme' ) && defined( 'Imagick::INTERLACE_PLANE' ) ) {
|
|
|
|
$orig_interlace = $this->image->getInterlaceScheme();
|
|
|
|
/**
|
|
|
|
* Filters whether to output progressive images (if available).
|
|
|
|
*
|
|
|
|
* @since 6.5.0
|
|
|
|
*
|
|
|
|
* @param bool $interlace Whether to use progressive images for output if available. Default false.
|
|
|
|
* @param string $mime_type The mime type being saved.
|
|
|
|
*/
|
|
|
|
if ( apply_filters( 'image_save_progressive', false, $mime_type ) ) {
|
|
|
|
$this->image->setInterlaceScheme( Imagick::INTERLACE_PLANE ); // True - line interlace output.
|
|
|
|
} else {
|
|
|
|
$this->image->setInterlaceScheme( Imagick::INTERLACE_NO ); // False - no interlace output.
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
Media: Support Stream Wrappers In `WP_Image_Editor_Imagick`
Since `WP_Image_Editor`'s introduction, stream wrappers have functioned in `WP_Image_Editor_GD`, but haven't been properly supported in `WP_Image_Editor_Imagick`.
- Detects stream wrappers and uses `file_put_contents()` along with `Imagick::read/getImageBlob()` for handling when necessary.
- Introduces private method, `WP_Image_Editor_Imagick::write_image` to handle detection and proper saving.
- Introduces `WP_Test_Stream` class for testing stream wrappers, along with new tests for Imagick's stream handling and a stream filename test.
Adds requirement for `Imagick::readImageBlob()`, available in Imagick >= 2.0.0, which aligns with the current requirement of Imagick >= 2.2.0.
Props p00ya, calin, joemcgill, pputzer, jimyaghi, mikeschroder.
Fixes #42663.
Built from https://develop.svn.wordpress.org/trunk@49230
git-svn-id: http://core.svn.wordpress.org/trunk@48992 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-20 10:37:05 -04:00
|
|
|
$write_image_result = $this->write_image( $this->image, $filename );
|
|
|
|
if ( is_wp_error( $write_image_result ) ) {
|
|
|
|
return $write_image_result;
|
|
|
|
}
|
|
|
|
|
|
|
|
try {
|
2020-01-28 19:45:18 -05:00
|
|
|
// Reset original format.
|
2012-10-01 16:59:06 -04:00
|
|
|
$this->image->setImageFormat( $orig_format );
|
Media: enable control of progressive image output.
Add a new `image_save_progressive` filter which developers can use to control whether intermediate image sizes are saved in a progressive format (when available). By default, progressive image output is not used, matching the previous behavior.
Props: adamsilverstein, _ck_, markoheijnen, SergeyBiryukov, Japh, pmeenan, mikeschroder, derekspringer, buley, ericlewis, bahia0019, born2webdesign.
Fixes #21668.
Built from https://develop.svn.wordpress.org/trunk@57607
git-svn-id: http://core.svn.wordpress.org/trunk@57108 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2024-02-12 18:26:11 -05:00
|
|
|
if ( isset( $orig_interlace ) ) {
|
|
|
|
$this->image->setInterlaceScheme( $orig_interlace );
|
|
|
|
}
|
2017-11-30 18:11:00 -05:00
|
|
|
} catch ( Exception $e ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
return new WP_Error( 'image_save_error', $e->getMessage(), $filename );
|
|
|
|
}
|
|
|
|
|
2020-01-28 19:45:18 -05:00
|
|
|
// Set correct file permissions.
|
2017-11-30 18:11:00 -05:00
|
|
|
$stat = stat( dirname( $filename ) );
|
2020-01-28 19:45:18 -05:00
|
|
|
$perms = $stat['mode'] & 0000666; // Same permissions as parent folder, strip off the executable bits.
|
2019-07-09 01:45:58 -04:00
|
|
|
chmod( $filename, $perms );
|
2012-10-01 16:59:06 -04:00
|
|
|
|
|
|
|
return array(
|
2013-12-04 17:49:10 -05:00
|
|
|
'path' => $filename,
|
2019-09-10 15:23:55 -04:00
|
|
|
/** This filter is documented in wp-includes/class-wp-image-editor-gd.php */
|
2013-12-04 17:49:10 -05:00
|
|
|
'file' => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
|
|
|
|
'width' => $this->size['width'],
|
|
|
|
'height' => $this->size['height'],
|
2012-10-01 16:59:06 -04:00
|
|
|
'mime-type' => $mime_type,
|
Media: Store attachment’s file size in metadata.
Store the file size of all newly uploaded attachments, as part of the metadata stored in post meta. Storing file size means, developers will not have to resort to doing `filesize` function calls, that can be time consuming on assets on offloaded to services like Amazon’s S3.
This change also introduces a new helper function called, `wp_filesize`. This is a wrapper around the `filesize` php function, that adds some helpful filters and ensures the return value is an integer.
Props Cybr, Spacedmonkey, SergeyBiryukov, johnwatkins0, swissspidy, desrosj, joemcgill, azaozz, antpb, adamsilverstein, uday17035.
Fixes #49412.
Built from https://develop.svn.wordpress.org/trunk@52837
git-svn-id: http://core.svn.wordpress.org/trunk@52426 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2022-03-10 08:10:02 -05:00
|
|
|
'filesize' => wp_filesize( $filename ),
|
2012-10-01 16:59:06 -04:00
|
|
|
);
|
|
|
|
}
|
|
|
|
|
Media: Support Stream Wrappers In `WP_Image_Editor_Imagick`
Since `WP_Image_Editor`'s introduction, stream wrappers have functioned in `WP_Image_Editor_GD`, but haven't been properly supported in `WP_Image_Editor_Imagick`.
- Detects stream wrappers and uses `file_put_contents()` along with `Imagick::read/getImageBlob()` for handling when necessary.
- Introduces private method, `WP_Image_Editor_Imagick::write_image` to handle detection and proper saving.
- Introduces `WP_Test_Stream` class for testing stream wrappers, along with new tests for Imagick's stream handling and a stream filename test.
Adds requirement for `Imagick::readImageBlob()`, available in Imagick >= 2.0.0, which aligns with the current requirement of Imagick >= 2.2.0.
Props p00ya, calin, joemcgill, pputzer, jimyaghi, mikeschroder.
Fixes #42663.
Built from https://develop.svn.wordpress.org/trunk@49230
git-svn-id: http://core.svn.wordpress.org/trunk@48992 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-20 10:37:05 -04:00
|
|
|
/**
|
|
|
|
* Writes an image to a file or stream.
|
|
|
|
*
|
2020-10-20 10:54:04 -04:00
|
|
|
* @since 5.6.0
|
Media: Support Stream Wrappers In `WP_Image_Editor_Imagick`
Since `WP_Image_Editor`'s introduction, stream wrappers have functioned in `WP_Image_Editor_GD`, but haven't been properly supported in `WP_Image_Editor_Imagick`.
- Detects stream wrappers and uses `file_put_contents()` along with `Imagick::read/getImageBlob()` for handling when necessary.
- Introduces private method, `WP_Image_Editor_Imagick::write_image` to handle detection and proper saving.
- Introduces `WP_Test_Stream` class for testing stream wrappers, along with new tests for Imagick's stream handling and a stream filename test.
Adds requirement for `Imagick::readImageBlob()`, available in Imagick >= 2.0.0, which aligns with the current requirement of Imagick >= 2.2.0.
Props p00ya, calin, joemcgill, pputzer, jimyaghi, mikeschroder.
Fixes #42663.
Built from https://develop.svn.wordpress.org/trunk@49230
git-svn-id: http://core.svn.wordpress.org/trunk@48992 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-20 10:37:05 -04:00
|
|
|
*
|
|
|
|
* @param Imagick $image
|
|
|
|
* @param string $filename The destination filename or stream URL.
|
|
|
|
* @return true|WP_Error
|
|
|
|
*/
|
|
|
|
private function write_image( $image, $filename ) {
|
|
|
|
if ( wp_is_stream( $filename ) ) {
|
|
|
|
/*
|
|
|
|
* Due to reports of issues with streams with `Imagick::writeImageFile()` and `Imagick::writeImage()`, copies the blob instead.
|
|
|
|
* Checks for exact type due to: https://www.php.net/manual/en/function.file-put-contents.php
|
|
|
|
*/
|
|
|
|
if ( file_put_contents( $filename, $image->getImageBlob() ) === false ) {
|
2020-11-09 10:35:05 -05:00
|
|
|
return new WP_Error(
|
|
|
|
'image_save_error',
|
|
|
|
sprintf(
|
|
|
|
/* translators: %s: PHP function name. */
|
|
|
|
__( '%s failed while writing image to stream.' ),
|
|
|
|
'<code>file_put_contents()</code>'
|
|
|
|
),
|
|
|
|
$filename
|
|
|
|
);
|
Media: Support Stream Wrappers In `WP_Image_Editor_Imagick`
Since `WP_Image_Editor`'s introduction, stream wrappers have functioned in `WP_Image_Editor_GD`, but haven't been properly supported in `WP_Image_Editor_Imagick`.
- Detects stream wrappers and uses `file_put_contents()` along with `Imagick::read/getImageBlob()` for handling when necessary.
- Introduces private method, `WP_Image_Editor_Imagick::write_image` to handle detection and proper saving.
- Introduces `WP_Test_Stream` class for testing stream wrappers, along with new tests for Imagick's stream handling and a stream filename test.
Adds requirement for `Imagick::readImageBlob()`, available in Imagick >= 2.0.0, which aligns with the current requirement of Imagick >= 2.2.0.
Props p00ya, calin, joemcgill, pputzer, jimyaghi, mikeschroder.
Fixes #42663.
Built from https://develop.svn.wordpress.org/trunk@49230
git-svn-id: http://core.svn.wordpress.org/trunk@48992 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-20 10:37:05 -04:00
|
|
|
} else {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
} else {
|
2020-11-09 10:35:05 -05:00
|
|
|
$dirname = dirname( $filename );
|
2020-11-09 08:18:04 -05:00
|
|
|
|
2020-11-09 10:35:05 -05:00
|
|
|
if ( ! wp_mkdir_p( $dirname ) ) {
|
2020-11-09 08:18:04 -05:00
|
|
|
return new WP_Error(
|
|
|
|
'image_save_error',
|
|
|
|
sprintf(
|
|
|
|
/* translators: %s: Directory path. */
|
|
|
|
__( 'Unable to create directory %s. Is its parent directory writable by the server?' ),
|
2020-11-09 10:35:05 -05:00
|
|
|
esc_html( $dirname )
|
2020-11-09 08:18:04 -05:00
|
|
|
)
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
Media: Support Stream Wrappers In `WP_Image_Editor_Imagick`
Since `WP_Image_Editor`'s introduction, stream wrappers have functioned in `WP_Image_Editor_GD`, but haven't been properly supported in `WP_Image_Editor_Imagick`.
- Detects stream wrappers and uses `file_put_contents()` along with `Imagick::read/getImageBlob()` for handling when necessary.
- Introduces private method, `WP_Image_Editor_Imagick::write_image` to handle detection and proper saving.
- Introduces `WP_Test_Stream` class for testing stream wrappers, along with new tests for Imagick's stream handling and a stream filename test.
Adds requirement for `Imagick::readImageBlob()`, available in Imagick >= 2.0.0, which aligns with the current requirement of Imagick >= 2.2.0.
Props p00ya, calin, joemcgill, pputzer, jimyaghi, mikeschroder.
Fixes #42663.
Built from https://develop.svn.wordpress.org/trunk@49230
git-svn-id: http://core.svn.wordpress.org/trunk@48992 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2020-10-20 10:37:05 -04:00
|
|
|
try {
|
|
|
|
return $image->writeImage( $filename );
|
|
|
|
} catch ( Exception $e ) {
|
|
|
|
return new WP_Error( 'image_save_error', $e->getMessage(), $filename );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-10-01 16:59:06 -04:00
|
|
|
/**
|
2012-11-16 17:02:21 -05:00
|
|
|
* Streams current image to browser.
|
|
|
|
*
|
|
|
|
* @since 3.5.0
|
2012-10-01 16:59:06 -04:00
|
|
|
*
|
2017-08-22 07:12:44 -04:00
|
|
|
* @param string $mime_type The mime type of the image.
|
2021-01-03 17:04:04 -05:00
|
|
|
* @return true|WP_Error True on success, WP_Error object on failure.
|
2012-10-01 16:59:06 -04:00
|
|
|
*/
|
|
|
|
public function stream( $mime_type = null ) {
|
|
|
|
list( $filename, $extension, $mime_type ) = $this->get_output_format( null, $mime_type );
|
|
|
|
|
|
|
|
try {
|
2020-01-28 19:45:18 -05:00
|
|
|
// Temporarily change format for stream.
|
2012-10-01 16:59:06 -04:00
|
|
|
$this->image->setImageFormat( strtoupper( $extension ) );
|
|
|
|
|
2020-01-28 19:45:18 -05:00
|
|
|
// Output stream of image content.
|
2012-10-01 16:59:06 -04:00
|
|
|
header( "Content-Type: $mime_type" );
|
|
|
|
print $this->image->getImageBlob();
|
|
|
|
|
2020-01-28 19:45:18 -05:00
|
|
|
// Reset image to original format.
|
2012-10-01 16:59:06 -04:00
|
|
|
$this->image->setImageFormat( $this->get_extension( $this->mime_type ) );
|
2017-11-30 18:11:00 -05:00
|
|
|
} catch ( Exception $e ) {
|
2012-10-01 16:59:06 -04:00
|
|
|
return new WP_Error( 'image_stream_error', $e->getMessage() );
|
|
|
|
}
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
2016-02-24 17:51:26 -05:00
|
|
|
|
|
|
|
/**
|
2016-03-04 12:37:27 -05:00
|
|
|
* Strips all image meta except color profiles from an image.
|
2016-02-24 17:51:26 -05:00
|
|
|
*
|
|
|
|
* @since 4.5.0
|
2016-03-04 12:37:27 -05:00
|
|
|
*
|
|
|
|
* @return true|WP_Error True if stripping metadata was successful. WP_Error object on error.
|
2016-02-24 17:51:26 -05:00
|
|
|
*/
|
|
|
|
protected function strip_meta() {
|
2016-03-08 23:44:26 -05:00
|
|
|
|
|
|
|
if ( ! is_callable( array( $this->image, 'getImageProfiles' ) ) ) {
|
2020-11-09 10:35:05 -05:00
|
|
|
return new WP_Error(
|
|
|
|
'image_strip_meta_error',
|
|
|
|
sprintf(
|
|
|
|
/* translators: %s: ImageMagick method name. */
|
|
|
|
__( '%s is required to strip image meta.' ),
|
|
|
|
'<code>Imagick::getImageProfiles()</code>'
|
|
|
|
)
|
|
|
|
);
|
2016-03-08 23:44:26 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
if ( ! is_callable( array( $this->image, 'removeImageProfile' ) ) ) {
|
2020-11-09 10:35:05 -05:00
|
|
|
return new WP_Error(
|
|
|
|
'image_strip_meta_error',
|
|
|
|
sprintf(
|
|
|
|
/* translators: %s: ImageMagick method name. */
|
|
|
|
__( '%s is required to strip image meta.' ),
|
|
|
|
'<code>Imagick::removeImageProfile()</code>'
|
|
|
|
)
|
|
|
|
);
|
2016-03-08 23:44:26 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Protect a few profiles from being stripped for the following reasons:
|
|
|
|
*
|
|
|
|
* - icc: Color profile information
|
|
|
|
* - icm: Color profile information
|
|
|
|
* - iptc: Copyright data
|
|
|
|
* - exif: Orientation data
|
|
|
|
* - xmp: Rights usage data
|
|
|
|
*/
|
|
|
|
$protected_profiles = array(
|
|
|
|
'icc',
|
|
|
|
'icm',
|
|
|
|
'iptc',
|
|
|
|
'exif',
|
|
|
|
'xmp',
|
|
|
|
);
|
|
|
|
|
2016-02-24 17:51:26 -05:00
|
|
|
try {
|
|
|
|
// Strip profiles.
|
|
|
|
foreach ( $this->image->getImageProfiles( '*', true ) as $key => $value ) {
|
2019-06-14 21:02:52 -04:00
|
|
|
if ( ! in_array( $key, $protected_profiles, true ) ) {
|
2016-02-24 17:51:26 -05:00
|
|
|
$this->image->removeImageProfile( $key );
|
|
|
|
}
|
|
|
|
}
|
2016-02-26 16:58:26 -05:00
|
|
|
} catch ( Exception $e ) {
|
2016-02-24 17:51:26 -05:00
|
|
|
return new WP_Error( 'image_strip_meta_error', $e->getMessage() );
|
|
|
|
}
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2016-11-18 17:22:32 -05:00
|
|
|
/**
|
|
|
|
* Sets up Imagick for PDF processing.
|
|
|
|
* Increases rendering DPI and only loads first page.
|
|
|
|
*
|
|
|
|
* @since 4.7.0
|
|
|
|
*
|
|
|
|
* @return string|WP_Error File to load or WP_Error on failure.
|
|
|
|
*/
|
|
|
|
protected function pdf_setup() {
|
|
|
|
try {
|
2023-07-09 17:25:23 -04:00
|
|
|
/*
|
|
|
|
* By default, PDFs are rendered in a very low resolution.
|
|
|
|
* We want the thumbnail to be readable, so increase the rendering DPI.
|
|
|
|
*/
|
2016-11-18 17:22:32 -05:00
|
|
|
$this->image->setResolution( 128, 128 );
|
|
|
|
|
2020-10-16 06:48:07 -04:00
|
|
|
// Only load the first page.
|
|
|
|
return $this->file . '[0]';
|
|
|
|
} catch ( Exception $e ) {
|
|
|
|
return new WP_Error( 'pdf_setup_failed', $e->getMessage(), $this->file );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Load the image produced by Ghostscript.
|
|
|
|
*
|
|
|
|
* Includes a workaround for a bug in Ghostscript 8.70 that prevents processing of some PDF files
|
|
|
|
* when `use-cropbox` is set.
|
|
|
|
*
|
2020-10-20 10:54:04 -04:00
|
|
|
* @since 5.6.0
|
2020-10-16 06:48:07 -04:00
|
|
|
*
|
2021-07-01 17:02:57 -04:00
|
|
|
* @return true|WP_Error
|
2020-10-16 06:48:07 -04:00
|
|
|
*/
|
|
|
|
protected function pdf_load_source() {
|
|
|
|
$filename = $this->pdf_setup();
|
|
|
|
|
|
|
|
if ( is_wp_error( $filename ) ) {
|
|
|
|
return $filename;
|
|
|
|
}
|
|
|
|
|
|
|
|
try {
|
2023-07-09 17:25:23 -04:00
|
|
|
/*
|
|
|
|
* When generating thumbnails from cropped PDF pages, Imagemagick uses the uncropped
|
|
|
|
* area (resulting in unnecessary whitespace) unless the following option is set.
|
|
|
|
*/
|
2019-09-23 06:36:57 -04:00
|
|
|
$this->image->setOption( 'pdf:use-cropbox', true );
|
|
|
|
|
2023-07-09 17:25:23 -04:00
|
|
|
/*
|
|
|
|
* Reading image after Imagick instantiation because `setResolution`
|
|
|
|
* only applies correctly before the image is read.
|
|
|
|
*/
|
2020-10-16 06:48:07 -04:00
|
|
|
$this->image->readImage( $filename );
|
2017-11-30 18:11:00 -05:00
|
|
|
} catch ( Exception $e ) {
|
2020-10-16 06:48:07 -04:00
|
|
|
// Attempt to run `gs` without the `use-cropbox` option. See #48853.
|
|
|
|
$this->image->setOption( 'pdf:use-cropbox', false );
|
|
|
|
|
|
|
|
$this->image->readImage( $filename );
|
2016-11-18 17:22:32 -05:00
|
|
|
}
|
2020-10-16 06:48:07 -04:00
|
|
|
|
|
|
|
return true;
|
2016-11-18 17:22:32 -05:00
|
|
|
}
|
2012-11-07 12:50:38 -05:00
|
|
|
}
|