create a backup of the original image

docs/hooks/index.md

@@ -6,6 +6,8 @@ The plugin provides several hooks to let you extend or modify its behavior.
 
 - [updated_tiny_postmeta](updated_tiny_postmeta.md) — Triggered when tinify meta data has been updated
 - [tiny_image_after_compression](tiny_image_after_compression.md) — Triggered after successful optimization.
+- [tiny_image_before_compression](tiny_image_before_compression.md) — Triggered before optimizing an attachment.
+
 
 ## Filters
 

docs/hooks/tiny_image_before_compression.md

@@ -0,0 +1,21 @@
+# tiny_image_before_compression
+
+Action that is done before compressing an single attachment
+
+**Location:** `src/class-tiny-image.php`  
+**Since:** 3.7.0
+
+## Arguments
+
+1. `int        $attachment_id` - The attachment ID.
+
+## Example
+
+```php
+add_action(
+	'tiny_image_before_compression',
+	function ( $id ) {
+		// notify system of compression
+	}
+);
+```

src/class-tiny-compress.php

@@ -96,7 +96,7 @@ public function get_status() {
 	/**
 	 * Compresses a single file
 	 *
-	 * @param [type]                             $file
+	 * @param string                             $file
 	 * @param array                              $resize_opts
 	 * @param array                              $preserve_opts
 	 * @param array{ string } conversion options

src/class-tiny-image.php

@@ -226,10 +226,23 @@ public function compress() {
 				'name'     => $this->name,
 			)
 		);
+
 		if ( $this->settings->get_compressor() === null || ! $this->file_type_allowed() ) {
 			return;
 		}
 
+		/**
+		 * Fires before an image is sent for compression.
+		 *
+		 * @since 3.7.0
+		 *
+		 * @param int $attachment_id The attachment ID
+		 */
+		do_action(
+			'tiny_image_before_compression',
+			$this->id
+		);
+
 		$success = 0;
 		$failed  = 0;
 
@@ -251,6 +264,7 @@ public function compress() {
 			if ( ! $size->is_duplicate() ) {
 				$size->add_tiny_meta_start();
 				$this->update_tiny_post_meta();
+
 				$resize   = $this->settings->get_resize_options( $size_name );
 				$preserve = $this->settings->get_preserve_options( $size_name );
 				Tiny_Logger::debug(

src/class-tiny-plugin.php

@@ -68,6 +68,13 @@ public function init() {
 
 		add_action( 'delete_attachment', $this->get_method( 'clean_attachment' ), 10, 2 );
 
+		add_action(
+			'tiny_image_before_compression',
+			$this->get_method( 'backup_original_image' ),
+			10,
+			1
+		);
+
 		load_plugin_textdomain(
 			self::NAME,
 			false,
@@ -904,6 +911,76 @@ public function clean_attachment( $post_id ) {
 		$tiny_image->delete_converted_image();
 	}
 
+	/**
+	 * Creates a backup of an image size before compression.
+	 *
+	 * Hooked to the `tiny_image_before_compression` action. Only creates
+	 * a backup for the original image size when the backup setting is enabled.
+	 * The backup is stored under {upload_dir}/tinify_backup/, preserving the
+	 * original path structure relative to the uploads base directory.
+	 *
+	 * When an unscaled original exists, that is backed up instead of the
+	 * scaled version.
+	 *
+	 * @since 3.7.0
+	 *
+	 * @param int       $attachment_id The ID of the attachment
+	 * @return bool             return true on backup created
+	 */
+	public function backup_original_image( $attachment_id ) {
+		if ( ! $this->settings->get_backup_enabled() ) {
+			return false;
+		}
+
+		$tiny_image = new Tiny_Image( $this->settings, $attachment_id );
+
+		$original_image = $tiny_image->get_image_size( Tiny_Image::ORIGINAL_UNSCALED );
+		if ( null === $original_image ) {
+			$original_image = $tiny_image->get_image_size();
+		}
+
+		if ( null === $original_image ) {
+			return false;
+		}
+
+		$file_path  = $original_image->filename;
+		$upload_dir = wp_upload_dir();
+		if ( Tiny_Helpers::str_starts_with( $file_path, $upload_dir['basedir'] ) ) {
+			$file_path = str_replace( $upload_dir['basedir'], '', $original_image->filename );
+			$file_path = ltrim( $file_path, '/' );
+		}
+
+		$upload_base = trailingslashit( $upload_dir['basedir'] );
+		$backup_file = $upload_base . 'tinify_backup/' . $file_path;
+
+		$wp_filesystem = Tiny_Helpers::get_wp_filesystem();
+
+		if ( $wp_filesystem->exists( $backup_file ) ) {
+			return false;
+		}
+
+		$backup_dir = dirname( $backup_file );
+
+		if ( ! wp_mkdir_p( $backup_dir ) ) {
+			return false;
+		}
+
+		return $wp_filesystem->copy( $original_image->filename, $backup_file );
+	}
+
+	public static function request_review() {
+		$review_url    =
+			'https://wordpress.org/support/plugin/tiny-compress-images/reviews/#new-post';
+		$review_block  = esc_html__( 'Enjoying TinyPNG?', 'tiny-compress-images' );
+		$review_block .= ' ';
+		$review_block .= sprintf(
+			'<a href="%s" target="_blank">%s</a>',
+			esc_url( $review_url ),
+			esc_html__( 'Write a review', 'tiny-compress-images' )
+		);
+		return $review_block;
+	}
+
 	/**
 	 * Runs on uninstall
 	 *

src/class-tiny-settings.php

@@ -127,6 +127,9 @@ public function admin_init() {
 		$field = self::get_prefixed_name( 'resize_original' );
 		register_setting( 'tinify', $field );
 
+		$field = self::get_prefixed_name( 'backup' );
+		register_setting( 'tinify', $field );
+
 		$field = self::get_prefixed_name( 'preserve_data' );
 		register_setting( 'tinify', $field );
 
@@ -324,6 +327,22 @@ public function new_plugin_install() {
 		return ! $compression_timing;
 	}
 
+	/**
+	 * Checks if backup is enabled.
+	 * backup is enabled when original will be compressed and setting is on.
+	 *
+	 * @return bool true if backup is enabled
+	 */
+	public function get_backup_enabled() {
+		$sizes = $this->get_sizes();
+		if ( ! $sizes[ Tiny_Image::ORIGINAL ]['tinify'] ) {
+			return false;
+		}
+
+		$setting = get_option( self::get_prefixed_name( 'backup' ) );
+		return isset( $setting['enabled'] ) && 'on' === $setting['enabled'];
+	}
+
 	public function get_resize_enabled() {
 		/* This only applies if the original is being resized. */
 		$sizes = $this->get_sizes();
@@ -362,6 +381,12 @@ public function get_preserve_enabled( $name ) {
 		return isset( $setting[ $name ] ) && 'on' === $setting[ $name ];
 	}
 
+	/**
+	 * Retrieves the preserve options for the original image
+	 *
+	 * @param string $size_name Name of the size
+	 * @return array<string>|false false if size is not original, otherwise array of preserved keys
+	 */
 	public function get_preserve_options( $size_name ) {
 		if ( ! Tiny_Image::is_original( $size_name ) &&
 			! Tiny_Image::is_original_unscaled( $size_name )

src/views/settings-original-image.php

@@ -68,6 +68,28 @@
 				</div>
 			</div>
 
+			<p class="tiny-preserve">
+				<?php
+					$backup_enabled_id   = self::get_prefixed_name( 'backup' );
+					$backup_enabled_name = self::get_prefixed_name( 'backup[enabled]' );
+					$backup_enabled      = $this->get_backup_enabled();
+				?>
+				<input
+					type="checkbox"
+					id="<?php echo esc_attr( $backup_enabled_id ); ?>"
+					name="<?php echo esc_attr( $backup_enabled_name ); ?>"
+					value="on"
+					<?php checked( $backup_enabled ); ?> />
+				<label for="<?php echo esc_attr( $backup_enabled_id ); ?>">
+					<?php
+					esc_html_e(
+						'Create a backup of the uncompressed image',
+						'tiny-compress-images'
+					);
+					?>
+				</label>
+			</p>
+
 			<?php
 			$this->render_preserve_input(
 				'creation',

test/helpers/wordpress.php

@@ -315,6 +315,14 @@ public function createImage($file_size, $path, $name)
 			->at($dir);
 	}
 
+	/**
+	 * Creates images on the virtual disk for testing
+	 * @param null|array $sizes Array of size name (array key) => bytes to create; each file will be named "$name-<size name>.png"
+	 * @param int $original_size Bytes of image
+	 * @param string $path Path to image
+	 * @param string $name Name of the image
+	 * @return void
+	 */
 	public function createImages($sizes = null, $original_size = 12345, $path = '14/01', $name = 'test')
 	{
 		vfsStream::newDirectory(self::UPLOAD_DIR . "/$path")->at($this->vfs);
@@ -342,6 +350,13 @@ public function createImagesFromJSON($virtual_images)
 		}
 	}
 
+	/**
+	 * creates image meta data for testing
+	 *
+	 * @param string $path directory of the file in UPLOAD_DIR
+	 * @param string $name name of the file without extension
+	 * @return array metadata array
+	 */
 	public function getTestMetadata($path = '14/01', $name = 'test')
 	{
 		$metadata = array(
@@ -371,6 +386,7 @@ public function getTestMetadata($path = '14/01', $name = 'test')
 	 */
 	public static function assertHook($hookname, $expected_args = null)
 	{
+
 		$found = self::findHook($hookname, $expected_args);
 
 		$message = is_null($expected_args)
@@ -399,7 +415,7 @@ public static function assertNotHook($hookname, $expected_args = null)
 
 	private static function findHook($hookname, $expected_args = null)
 	{
-		$hooks = array('add_action', 'add_filter');
+		$hooks = array('add_action', 'add_filter', 'do_action', 'apply_filters');
 		$found = false;
 
 		foreach ($hooks as $method) {
@@ -458,7 +474,7 @@ public function current_time()
 	 */
 	public function wp_mkdir_p($dir)
 	{
-		mkdir($dir, 0755, true);
+		return mkdir($dir, 0755, true) || is_dir($dir);
 	}
 
 	/**
@@ -519,9 +535,7 @@ public function wp_timezone_string()
 	 *
 	 * @return void
 	 */
-	public function update_option()
-	{
-	}
+	public function update_option() {}
 
 	/**
 	 * Mocked function for https://developer.wordpress.org/reference/functions/check_ajax_referer/
@@ -621,7 +635,7 @@ public function esc_html($text)
 	{
 		return $text;
 	}
-	
+
 	/**
 	 * Mocked function for https://developer.wordpress.org/reference/functions/insert_with_markers/
 	 *
@@ -631,16 +645,16 @@ public function insert_with_markers($filename, $marker, $insertion)
 	{
 		$content = file_exists($filename) ? file_get_contents($filename) : '';
 		$insertion = is_array($insertion) ? implode("\n", $insertion) : $insertion;
-		
+
 		$start = "# BEGIN {$marker}";
 		$end = "# END {$marker}";
-	
+
 		$content = preg_replace('/' . preg_quote($start, '/') . '.*?' . preg_quote($end, '/') . '\s*/s', '', $content);
-	
+
 		if ($insertion) {
 			$content = "{$start}\n{$insertion}\n{$end}\n" . ltrim($content);
 		}
-	
+
 		return file_put_contents($filename, trim($content) . "\n") !== false;
 	}