<?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

 *

 * @see WP_Image_Editor

 */

class WP_Image_Editor_Imagick extends WP_Image_Editor {

	/**

	 * Imagick object.

	 *

	 * @var Imagick

	 */

	protected $image;

	public function __destruct() {

		if ( $this->image instanceof Imagick ) {

			// We don't need the original in memory anymore.

			$this->image->clear();

			$this->image->destroy();

		}

	}

	/**

	 * Checks to see if current environment supports Imagick.

	 *

	 * We require Imagick 2.2.0 or greater, based on whether the queryFormats()

	 * method can be called statically.

	 *

	 * @since 3.5.0

	 *

	 * @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', false ) || ! class_exists( 'ImagickPixel', false ) ) {

			return false;

		}

		if ( version_compare( phpversion( 'imagick' ), '2.2.0', '<' ) ) {

			return false;

		}

		$required_methods = array(

			'clear',

			'destroy',

			'valid',

			'getimage',

			'writeimage',

			'getimageblob',

			'getimagegeometry',

			'getimageformat',

			'setimageformat',

			'setimagecompression',

			'setimagecompressionquality',

			'setimagepage',

			'setoption',

			'scaleimage',

			'cropimage',

			'rotateimage',

			'flipimage',

			'flopimage',

			'readimage',

			'readimageblob',

		);

		// Now, test for deep requirements within Imagick.

		if ( ! defined( 'imagick::COMPRESSION_JPEG' ) ) {

			return false;

		}

		$class_methods = array_map( 'strtolower', get_class_methods( 'Imagick' ) );

		if ( array_diff( $required_methods, $class_methods ) ) {

			return false;

		}

		return true;

	}

	/**

	 * Checks to see if editor supports the mime-type specified.

	 *

	 * @since 3.5.0

	 *

	 * @param string $mime_type

	 * @return bool

	 */

	public static function supports_mime_type( $mime_type ) {

		$imagick_extension = strtoupper( self::get_extension( $mime_type ) );

		if ( ! $imagick_extension ) {

			return false;

		}

		/*

		 * 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.

		 */

		if ( ! method_exists( 'Imagick', 'setIteratorIndex' ) && 'image/jpeg' !== $mime_type ) {

				return false;

		}

		try {

			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged

			return ( (bool) @Imagick::queryFormats( $imagick_extension ) );

		} catch ( Exception $e ) {

			return false;

		}

	}

	/**

	 * Loads image from $this->file into new Imagick Object.

	 *

	 * @since 3.5.0

	 *

	 * @return true|WP_Error True if loaded; WP_Error on failure.

	 */

	public function load() {

		if ( $this->image instanceof Imagick ) {

			return true;

		}

		if ( ! is_file( $this->file ) && ! wp_is_stream( $this->file ) ) {

			return new WP_Error( 'error_loading_image', __( 'File does not exist?' ), $this->file );

		}

		/*

		 * Even though Imagick uses less PHP memory than GD, set higher limit

		 * for users that have low PHP.ini limits.

		 */

		wp_raise_memory_limit( 'image' );

		try {

			$this->image    = new Imagick();

			$file_extension = strtolower( pathinfo( $this->file, PATHINFO_EXTENSION ) );

			if ( 'pdf' === $file_extension ) {

				$pdf_loaded = $this->pdf_load_source();

				if ( is_wp_error( $pdf_loaded ) ) {

					return $pdf_loaded;

				}

			} else {

				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 );

				}

			}

			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.

			if ( is_callable( array( $this->image, 'setIteratorIndex' ) ) ) {

				$this->image->setIteratorIndex( 0 );

			}

			if ( 'pdf' === $file_extension ) {

				$this->remove_pdf_alpha_channel();

			}

			$this->mime_type = $this->get_mime_type( $this->image->getImageFormat() );

		} catch ( Exception $e ) {

			return new WP_Error( 'invalid_image', $e->getMessage(), $this->file );

		}

		$updated_size = $this->update_size();

		if ( is_wp_error( $updated_size ) ) {

			return $updated_size;

		}

		return $this->set_quality();

	}

	/**

	 * Sets Image Compression quality on a 1-100% scale.

	 *

	 * @since 3.5.0

	 * @since 6.8.0 The `$dims` parameter was added.

	 *

	 * @param int   $quality Compression Quality. Range: [1,100]

	 * @param array $dims    Optional. Image dimensions array with 'width' and 'height' keys.

	 * @return true|WP_Error True if set successfully; WP_Error on failure.

	 */

	public function set_quality( $quality = null, $dims = array() ) {

		$quality_result = parent::set_quality( $quality, $dims );

		if ( is_wp_error( $quality_result ) ) {

			return $quality_result;

		} else {

			$quality = $this->get_quality();

		}

		try {

			switch ( $this->mime_type ) {

				case 'image/jpeg':

					$this->image->setImageCompressionQuality( $quality );

					$this->image->setCompressionQuality( $quality );

					$this->image->setImageCompression( imagick::COMPRESSION_JPEG );

					break;

				case 'image/webp':

					$webp_info = wp_get_webp_info( $this->file );

					if ( 'lossless' === $webp_info['type'] ) {

						// Use WebP lossless settings.

						$this->image->setImageCompressionQuality( 100 );

						$this->image->setCompressionQuality( 100 );

						$this->image->setOption( 'webp:lossless', 'true' );

						parent::set_quality( 100 );

					} else {

						$this->image->setImageCompressionQuality( $quality );

						$this->image->setCompressionQuality( $quality );

					}

					break;

				case 'image/avif':

					// Set the AVIF encoder to work faster, with minimal impact on image size.

					$this->image->setOption( 'heic:speed', 7 );

					$this->image->setImageCompressionQuality( $quality );

					$this->image->setCompressionQuality( $quality );

					break;

				default:

					$this->image->setImageCompressionQuality( $quality );

					$this->image->setCompressionQuality( $quality );

			}

		} catch ( Exception $e ) {

			return new WP_Error( 'image_quality_error', $e->getMessage() );

		}

		return true;

	}

	/**

	 * Sets or updates current image size.

	 *

	 * @since 3.5.0

	 *

	 * @param int $width

	 * @param int $height

	 * @return true|WP_Error

	 */

	protected function update_size( $width = null, $height = null ) {

		$size = null;

		if ( ! $width || ! $height ) {

			try {

				$size = $this->image->getImageGeometry();

			} catch ( Exception $e ) {

				return new WP_Error( 'invalid_image', __( 'Could not read image size.' ), $this->file );

			}

		}

		if ( ! $width ) {

			$width = $size['width'];

		}

		if ( ! $height ) {

			$height = $size['height'];

		}

		/*

		 * If we still don't have the image size, fall back to `wp_getimagesize`. This ensures AVIF and HEIC images

		 * are properly sized without affecting previous `getImageGeometry` behavior.

		 */

		if ( ( ! $width || ! $height ) && ( 'image/avif' === $this->mime_type || wp_is_heic_image_mime_type( $this->mime_type ) ) ) {

			$size   = wp_getimagesize( $this->file );

			$width  = $size[0];

			$height = $size[1];

		}

		return parent::update_size( $width, $height );

	}

	/**

	 * 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.

	 *

	 * However seems it introduces more problems than it fixes,

	 * see https://core.trac.wordpress.org/ticket/58202.

	 *

	 * 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

	 * @since 6.3.0 This method was deprecated.

	 *

	 * @return int|null The new limit on success, null on failure.

	 */

	public static function set_imagick_time_limit() {

		_deprecated_function( __METHOD__, '6.3.0' );

		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;

		}

	}

	/**

	 * 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

	 *

	 * @param int|null   $max_w Image width.

	 * @param int|null   $max_h Image height.

	 * @param bool|array $crop  {

	 *     Optional. Image cropping behavior. If false, the image will be scaled (default).

	 *     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'.

	 * }

	 * @return true|WP_Error

	 */

	public function resize( $max_w, $max_h, $crop = false ) {

		if ( ( $this->size['width'] === $max_w ) && ( $this->size['height'] === $max_h ) ) {

			return true;

		}

		$dims = image_resize_dimensions( $this->size['width'], $this->size['height'], $max_w, $max_h, $crop );

		if ( ! $dims ) {

			return new WP_Error( 'error_getting_dimensions', __( 'Could not calculate resized image dimensions' ) );

		}

		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 );

		}

		$this->set_quality(

			null,

			array(

				'width'  => $dst_w,

				'height' => $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

	 *

	 * @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 void|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',