WordPress 4.5.1
[autoinstalls/wordpress.git] / wp-includes / class-wp-image-editor-imagick.php
index 2e1bebc994afcee056a2301c2d63aad7176d9e33..74ba793be7a66f88cb2d78dca7bf8854521407fb 100644 (file)
  * @uses WP_Image_Editor Extends class
  */
 class WP_Image_Editor_Imagick extends WP_Image_Editor {
+       /**
+        * Imagick object.
+        *
+        * @access protected
+        * @var Imagick
+        */
+       protected $image;
 
-       protected $image = null; // Imagick Object
-
-       function __destruct() {
+       public function __destruct() {
                if ( $this->image instanceof Imagick ) {
                        // we don't need the original in memory anymore
                        $this->image->clear();
@@ -33,14 +38,17 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * method can be called statically.
         *
         * @since 3.5.0
+        *
+        * @static
         * @access public
         *
-        * @return boolean
+        * @param array $args
+        * @return bool
         */
        public static function test( $args = array() ) {
 
                // First, test Imagick's extension and classes.
-               if ( ! extension_loaded( 'imagick' ) || ! class_exists( 'Imagick' ) || ! class_exists( 'ImagickPixel' ) )
+               if ( ! extension_loaded( 'imagick' ) || ! class_exists( 'Imagick', false ) || ! class_exists( 'ImagickPixel', false ) )
                        return false;
 
                if ( version_compare( phpversion( 'imagick' ), '2.2.0', '<' ) )
@@ -59,6 +67,7 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                        'setimagecompression',
                        'setimagecompressionquality',
                        'setimagepage',
+                       'setoption',
                        'scaleimage',
                        'cropimage',
                        'rotateimage',
@@ -70,8 +79,15 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                if ( ! defined( 'imagick::COMPRESSION_JPEG' ) )
                        return false;
 
-               if ( array_diff( $required_methods, get_class_methods( 'Imagick' ) ) )
+               $class_methods = array_map( 'strtolower', get_class_methods( 'Imagick' ) );
+               if ( array_diff( $required_methods, $class_methods ) ) {
                        return false;
+               }
+
+               // HHVM Imagick does not support loading from URL, so fail to allow fallback to GD.
+               if ( defined( 'HHVM_VERSION' ) && isset( $args['path'] ) && preg_match( '|^https?://|', $args['path'] ) ) {
+                       return false;
+               }
 
                return true;
        }
@@ -80,10 +96,12 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * Checks to see if editor supports the mime-type specified.
         *
         * @since 3.5.0
+        *
+        * @static
         * @access public
         *
         * @param string $mime_type
-        * @return boolean
+        * @return bool
         */
        public static function supports_mime_type( $mime_type ) {
                $imagick_extension = strtoupper( self::get_extension( $mime_type ) );
@@ -110,7 +128,7 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * @since 3.5.0
         * @access protected
         *
-        * @return boolean|WP_Error True if loaded; WP_Error on failure.
+        * @return true|WP_Error True if loaded; WP_Error on failure.
         */
        public function load() {
                if ( $this->image instanceof Imagick )
@@ -119,13 +137,14 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                if ( ! is_file( $this->file ) && ! preg_match( '|^https?://|', $this->file ) )
                        return new WP_Error( 'error_loading_image', __('File doesn&#8217;t exist?'), $this->file );
 
+               /** This filter is documented in wp-includes/class-wp-image-editor-imagick.php */
                // Even though Imagick uses less PHP memory than GD, set higher limit for users that have low PHP.ini limits
                @ini_set( 'memory_limit', apply_filters( 'image_memory_limit', WP_MAX_MEMORY_LIMIT ) );
 
                try {
                        $this->image = new Imagick( $this->file );
 
-                       if( ! $this->image->valid() )
+                       if ( ! $this->image->valid() )
                                return new WP_Error( 'invalid_image', __('File is not an image.'), $this->file);
 
                        // Select the first frame to handle animated images properly
@@ -139,8 +158,9 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                }
 
                $updated_size = $this->update_size();
-               if ( is_wp_error( $updated_size ) )
-                               return $updated_size;
+               if ( is_wp_error( $updated_size ) ) {
+                       return $updated_size;
+               }
 
                return $this->set_quality();
        }
@@ -152,15 +172,19 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * @access public
         *
         * @param int $quality Compression Quality. Range: [1,100]
-        * @return boolean|WP_Error
+        * @return true|WP_Error True if set successfully; WP_Error on failure.
         */
        public function set_quality( $quality = null ) {
-               if ( !$quality )
-                       $quality = $this->quality;
+               $quality_result = parent::set_quality( $quality );
+               if ( is_wp_error( $quality_result ) ) {
+                       return $quality_result;
+               } else {
+                       $quality = $this->get_quality();
+               }
 
                try {
-                       if( 'image/jpeg' == $this->mime_type ) {
-                               $this->image->setImageCompressionQuality( apply_filters( 'jpeg_quality', $quality, 'image_resize' ) );
+                       if ( 'image/jpeg' == $this->mime_type ) {
+                               $this->image->setImageCompressionQuality( $quality );
                                $this->image->setImageCompression( imagick::COMPRESSION_JPEG );
                        }
                        else {
@@ -171,7 +195,7 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                        return new WP_Error( 'image_quality_error', $e->getMessage() );
                }
 
-               return parent::set_quality( $quality );
+               return true;
        }
 
        /**
@@ -182,6 +206,8 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         *
         * @param int $width
         * @param int $height
+        *
+        * @return true|WP_Error
         */
        protected function update_size( $width = null, $height = null ) {
                $size = null;
@@ -190,7 +216,7 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                                $size = $this->image->getImageGeometry();
                        }
                        catch ( Exception $e ) {
-                               return new WP_Error( 'invalid_image', __('Could not read image size'), $this->file );
+                               return new WP_Error( 'invalid_image', __( 'Could not read image size.' ), $this->file );
                        }
                }
 
@@ -206,13 +232,17 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
        /**
         * Resizes current image.
         *
+        * 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.
+        *
         * @since 3.5.0
         * @access public
         *
-        * @param int $max_w
-        * @param int $max_h
-        * @param boolean $crop
-        * @return boolean|WP_Error
+        * @param  int|null $max_w Image width.
+        * @param  int|null $max_h Image height.
+        * @param  bool     $crop
+        * @return bool|WP_Error
         */
        public function resize( $max_w, $max_h, $crop = false ) {
                if ( ( $this->size['width'] == $max_w ) && ( $this->size['height'] == $max_h ) )
@@ -227,18 +257,148 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                        return $this->crop( $src_x, $src_y, $src_w, $src_h, $dst_w, $dst_h );
                }
 
+               // Execute the resize
+               $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
+        * @access protected
+        *
+        * @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.
+        * @return bool|WP_Error
+        */
+       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',
+               );
+
+               /**
+                * Set the filter value if '$filter_name' name is in our whitelist and the related
+                * Imagick constant is defined or fall back to our default filter.
+                */
+               if ( in_array( $filter_name, $allowed_filters ) && defined( 'Imagick::' . $filter_name ) ) {
+                       $filter = constant( 'Imagick::' . $filter_name );
+               } else {
+                       $filter = defined( 'Imagick::FILTER_TRIANGLE' ) ? Imagick::FILTER_TRIANGLE : false;
+               }
+
+               /**
+                * Filter whether to strip metadata from images when they're resized.
+                *
+                * 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.
+                */
+               if ( apply_filters( 'image_strip_meta', $strip_meta ) ) {
+                       $this->strip_meta(); // Fail silently if not supported.
+               }
+
                try {
-                       /**
-                        * @TODO: Thumbnail is more efficient, given a newer version of Imagemagick.
-                        * $this->image->thumbnailImage( $dst_w, $dst_h );
+                       /*
+                        * 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.
+                        */
+                       if ( is_callable( array( $this->image, 'sampleImage' ) ) ) {
+                               $resize_ratio = ( $dst_w / $this->size['width'] ) * ( $dst_h / $this->size['height'] );
+                               $sample_factor = 5;
+
+                               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 );
+                               }
+                       }
+
+                       /*
+                        * 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
+                        * settings and retains backwards compatibility with pre 4.5 functionality.
+                        */
+                       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 );
+                       }
+
+                       // Set appropriate quality settings after resizing.
+                       if ( 'image/jpeg' == $this->mime_type ) {
+                               if ( is_callable( array( $this->image, 'unsharpMaskImage' ) ) ) {
+                                       $this->image->unsharpMaskImage( 0.25, 0.25, 8, 0.065 );
+                               }
+
+                               $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' );
+                       }
+
+                       /*
+                        * 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.
                         */
-                       $this->image->scaleImage( $dst_w, $dst_h );
+                       if ( is_callable( array( $this->image, 'getImageAlphaChannel' ) )
+                               && is_callable( array( $this->image, 'setImageAlphaChannel' ) )
+                               && defined( 'Imagick::ALPHACHANNEL_UNDEFINED' )
+                               && defined( 'Imagick::ALPHACHANNEL_OPAQUE' )
+                       ) {
+                               if ( $this->image->getImageAlphaChannel() === Imagick::ALPHACHANNEL_UNDEFINED ) {
+                                       $this->image->setImageAlphaChannel( Imagick::ALPHACHANNEL_OPAQUE );
+                               }
+                       }
+
+                       // 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 );
+                               }
+                       }
+
+                       if ( is_callable( array( $this->image, 'setInterlaceScheme' ) ) && defined( 'Imagick::INTERLACE_NO' ) ) {
+                               $this->image->setInterlaceScheme( Imagick::INTERLACE_NO );
+                       }
+
                }
                catch ( Exception $e ) {
                        return new WP_Error( 'image_resize_error', $e->getMessage() );
                }
-
-               return $this->update_size( $dst_w, $dst_h );
        }
 
        /**
@@ -248,15 +408,21 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * @access public
         *
         * @param array $sizes {
-        *     An array of image size arrays. Default sizes are 'small', 'medium', 'large'.
+        *     An array of image size arrays. Default sizes are 'small', 'medium', 'medium_large', 'large'.
+        *
+        *     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.
         *
         *     @type array $size {
-        *         @type int  $width  Image width.
-        *         @type int  $height Image height.
+        *         Array of height, width values, and whether to crop.
+        *
+        *         @type int  $width  Image width. Optional if `$height` is specified.
+        *         @type int  $height Image height. Optional if `$width` is specified.
         *         @type bool $crop   Optional. Whether to crop the image. Default false.
         *     }
         * }
-        * @return array An array of resized images metadata by size.
+        * @return array An array of resized images' metadata by size.
         */
        public function multi_resize( $sizes ) {
                $metadata = array();
@@ -267,15 +433,25 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                        if ( ! $this->image )
                                $this->image = $orig_image->getImage();
 
-                       if ( ! ( isset( $size_data['width'] ) && isset( $size_data['height'] ) ) )
+                       if ( ! isset( $size_data['width'] ) && ! isset( $size_data['height'] ) ) {
                                continue;
+                       }
+
+                       if ( ! isset( $size_data['width'] ) ) {
+                               $size_data['width'] = null;
+                       }
+                       if ( ! isset( $size_data['height'] ) ) {
+                               $size_data['height'] = null;
+                       }
 
-                       if ( ! isset( $size_data['crop'] ) )
+                       if ( ! isset( $size_data['crop'] ) ) {
                                $size_data['crop'] = false;
+                       }
 
                        $resize_result = $this->resize( $size_data['width'], $size_data['height'], $size_data['crop'] );
+                       $duplicate = ( ( $orig_size['width'] == $size_data['width'] ) && ( $orig_size['height'] == $size_data['height'] ) );
 
-                       if( ! is_wp_error( $resize_result ) ) {
+                       if ( ! is_wp_error( $resize_result ) && ! $duplicate ) {
                                $resized = $this->_save( $this->image );
 
                                $this->image->clear();
@@ -302,15 +478,14 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * @since 3.5.0
         * @access public
         *
-        * @param string|int $src The source file or Attachment ID.
-        * @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.
-        * @param boolean $src_abs Optional. If the source crop points are absolute.
-        * @return boolean|WP_Error
+        * @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.
+        * @param bool $src_abs Optional. If the source crop points are absolute.
+        * @return bool|WP_Error
         */
        public function crop( $src_x, $src_y, $src_w, $src_h, $dst_w = null, $dst_h = null, $src_abs = false ) {
                if ( $src_abs ) {
@@ -330,7 +505,11 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                                if ( ! $dst_h )
                                        $dst_h = $src_h;
 
-                               $this->image->scaleImage( $dst_w, $dst_h );
+                               $thumb_result = $this->thumbnail_image( $dst_w, $dst_h );
+                               if ( is_wp_error( $thumb_result ) ) {
+                                       return $thumb_result;
+                               }
+
                                return $this->update_size();
                        }
                }
@@ -347,7 +526,7 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * @access public
         *
         * @param float $angle
-        * @return boolean|WP_Error
+        * @return true|WP_Error
         */
        public function rotate( $angle ) {
                /**
@@ -376,9 +555,9 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * @since 3.5.0
         * @access public
         *
-        * @param boolean $horz Flip along Horizontal Axis
-        * @param boolean $vert Flip along Vertical Axis
-        * @returns boolean|WP_Error
+        * @param bool $horz Flip along Horizontal Axis
+        * @param bool $vert Flip along Vertical Axis
+        * @return true|WP_Error
         */
        public function flip( $horz, $vert ) {
                try {
@@ -422,6 +601,13 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                return $saved;
        }
 
+       /**
+        *
+        * @param Imagick $image
+        * @param string $filename
+        * @param string $mime_type
+        * @return array|WP_Error
+        */
        protected function _save( $image, $filename = null, $mime_type = null ) {
                list( $filename, $extension, $mime_type ) = $this->get_output_format( $filename, $mime_type );
 
@@ -447,11 +633,12 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
                $perms = $stat['mode'] & 0000666; //same permissions as parent folder, strip off the executable bits
                @ chmod( $filename, $perms );
 
+               /** This filter is documented in wp-includes/class-wp-image-editor-gd.php */
                return array(
-                       'path' => $filename,
-                       'file' => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
-                       'width' => $this->size['width'],
-                       'height' => $this->size['height'],
+                       'path'      => $filename,
+                       'file'      => wp_basename( apply_filters( 'image_make_intermediate_size', $filename ) ),
+                       'width'     => $this->size['width'],
+                       'height'    => $this->size['height'],
                        'mime-type' => $mime_type,
                );
        }
@@ -463,7 +650,7 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
         * @access public
         *
         * @param string $mime_type
-        * @return boolean|WP_Error
+        * @return true|WP_Error
         */
        public function stream( $mime_type = null ) {
                list( $filename, $extension, $mime_type ) = $this->get_output_format( null, $mime_type );
@@ -485,4 +672,57 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
 
                return true;
        }
+
+       /**
+        * Strips all image meta except color profiles from an image.
+        *
+        * @since 4.5.0
+        * @access protected
+        *
+        * @return true|WP_Error True if stripping metadata was successful. WP_Error object on error.
+        */
+       protected function strip_meta() {
+
+               if ( ! is_callable( array( $this->image, 'getImageProfiles' ) ) ) {
+                       /* translators: %s: ImageMagick method name */
+                       return new WP_Error( 'image_strip_meta_error', sprintf( __( '%s is required to strip image meta.' ), '<code>Imagick::getImageProfiles()</code>' ) );
+               }
+
+               if ( ! is_callable( array( $this->image, 'removeImageProfile' ) ) ) {
+                       /* translators: %s: ImageMagick method name */
+                       return new WP_Error( 'image_strip_meta_error', sprintf( __( '%s is required to strip image meta.' ), '<code>Imagick::removeImageProfile()</code>' ) );
+               }
+
+               /*
+                * 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',
+               );
+
+               try {
+                       // Strip profiles.
+                       foreach ( $this->image->getImageProfiles( '*', true ) as $key => $value ) {
+                               if ( ! in_array( $key, $protected_profiles ) ) {
+                                       $this->image->removeImageProfile( $key );
+                               }
+                       }
+
+               } catch ( Exception $e ) {
+                       return new WP_Error( 'image_strip_meta_error', $e->getMessage() );
+               }
+
+               return true;
+       }
+
 }