<?php
/**
 * Imagick image editor that removes photo metadata on every save.
 *
 * @package SpaceBay
 */

namespace SpaceBay\Content;

defined( 'ABSPATH' ) || exit;

/**
 * WordPress's Imagick editor keeps metadata unless it resizes, and even then
 * keeps the EXIF, XMP and IPTC profiles (camera, GPS location, names). This
 * editor removes all of them before saving and keeps only the colour profile.
 *
 * Only Media::shrink() uses it, through the wp_image_editors filter, and only
 * after WordPress has loaded WP_Image_Editor_Imagick.
 */
class ImagickStripEditor extends \WP_Image_Editor_Imagick {

	/**
	 * Removes metadata, then saves.
	 *
	 * @param \Imagick    $image     Image.
	 * @param string|null $filename  File name.
	 * @param string|null $mime_type MIME type.
	 * @return array|\WP_Error
	 */
	protected function _save( $image, $filename = null, $mime_type = null ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- Overrides the WordPress method.
		$stripped = self::strip_all( $image );

		if ( is_wp_error( $stripped ) ) {
			return $stripped;
		}

		return parent::_save( $image, $filename, $mime_type );
	}

	/**
	 * Strips every profile and comment except the ICC colour profile.
	 *
	 * @param \Imagick $image Image.
	 * @return true|\WP_Error
	 */
	public static function strip_all( $image ) {
		try {
			$icc = array();

			foreach ( array( 'icc', 'icm' ) as $name ) {
				$found = $image->getImageProfiles( $name, true );

				if ( ! empty( $found[ $name ] ) ) {
					$icc[ $name ] = $found[ $name ];
				}
			}

			$image->stripImage();

			foreach ( $icc as $name => $data ) {
				$image->profileImage( $name, $data );
			}
		} catch ( \Exception $e ) {
			// Better no image than one that still carries the location.
			return new \WP_Error( 'image_strip_meta_error', $e->getMessage() );
		}

		return true;
	}
}