Convert images to optimized formats

.gitignore

@@ -13,3 +13,4 @@ node_modules/
 /playwright/.cache/
 test/integration/.auth/user.json
 artifacts/
+.phpunit.result.cache

.vscode/launch.json

@@ -1,14 +1,14 @@
 {
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-      {
-        "name": "Listen for XDebug",
-        "type": "php",
-        "request": "launch",
-        "port": 9003
-      }
-    ]
-  }
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "XDebug PHPUnit",
+      "type": "php",
+      "request": "launch",
+      "port": 9003
+    }
+  ]
+}

src/class-tiny-bulk-optimization.php

@@ -27,7 +27,7 @@ public static function get_optimization_statistics( $settings, $result = null )
 		$stats = array();
 		$stats['uploaded-images'] = 0;
 		$stats['optimized-image-sizes'] = 0;
-		$stats['available-unoptimised-sizes'] = 0;
+		$stats['available-unoptimized-sizes'] = 0;
 		$stats['optimized-library-size'] = 0;
 		$stats['unoptimized-library-size'] = 0;
 		$stats['available-for-optimization'] = array();
@@ -99,6 +99,8 @@ private static function wpdb_retrieve_images_and_metadata( $start_id ) {
 	private static function populate_optimization_statistics( $settings, $result, $stats ) {
 		$active_sizes = $settings->get_sizes();
 		$active_tinify_sizes = $settings->get_active_tinify_sizes();
+		$conversion_enabled = $settings->get_conversion_enabled();
+
 		for ( $i = 0; $i < sizeof( $result ); $i++ ) {
 			$wp_metadata = unserialize( (string) $result[ $i ]['meta_value'] );
 			$tiny_metadata = unserialize( (string) $result[ $i ]['tiny_meta_value'] );
@@ -114,18 +116,28 @@ private static function populate_optimization_statistics( $settings, $result, $s
 				$active_tinify_sizes
 			);
 			$image_stats = $tiny_image->get_statistics( $active_sizes, $active_tinify_sizes );
+
 			$stats['uploaded-images']++;
-			$stats['available-unoptimised-sizes'] += $image_stats['available_unoptimized_sizes'];
-			$stats['optimized-image-sizes'] += $image_stats['image_sizes_optimized'];
-			$stats['optimized-library-size'] += $image_stats['optimized_total_size'];
+			if ( $conversion_enabled ) {
+				$stats['available-unoptimized-sizes'] +=
+				$image_stats['available_unconverted_sizes'];
+				$stats['optimized-image-sizes'] +=
+				$image_stats['image_sizes_converted'];
+			} else {
+				$stats['available-unoptimized-sizes'] +=
+				$image_stats['available_uncompressed_sizes'];
+				$stats['optimized-image-sizes'] +=
+				$image_stats['image_sizes_compressed'];
+			}
+			$stats['optimized-library-size'] += $image_stats['compressed_total_size'];
 			$stats['unoptimized-library-size'] += $image_stats['initial_total_size'];
-			if ( $image_stats['available_unoptimized_sizes'] > 0 ) {
+			if ( $image_stats['available_uncompressed_sizes'] > 0 ) {
 				$stats['available-for-optimization'][] = array(
 					'ID' => $result[ $i ]['ID'],
 					'post_title' => $result[ $i ]['post_title'],
 				);
 			}
-		}
+		}// End for().
 		return $stats;
 	}
 }

src/class-tiny-compress-client.php

@@ -29,6 +29,7 @@
 }
 
 class Tiny_Compress_Client extends Tiny_Compress {
+
 	private $last_error_code = 0;
 	private $last_message = '';
 	private $proxy;
@@ -72,7 +73,6 @@ protected function validate() {
 			$this->set_request_options( \Tinify\Tinify::getClient( \Tinify\Tinify::ANONYMOUS ) );
 			\Tinify\Tinify::getClient()->request( 'get', '/keys/' . $this->get_key() );
 			return true;
-
 		} catch ( \Tinify\Exception $err ) {
 			$this->last_error_code = $err->status;
 
@@ -88,7 +88,7 @@ protected function validate() {
 		}
 	}
 
-	protected function compress( $input, $resize_opts, $preserve_opts ) {
+	protected function compress( $input, $resize_opts, $preserve_opts, $convert_opts ) {
 		try {
 			$this->last_error_code = 0;
 			$this->set_request_options( \Tinify\Tinify::getClient() );
@@ -103,25 +103,39 @@ protected function compress( $input, $resize_opts, $preserve_opts ) {
 				$source = $source->preserve( $preserve_opts );
 			}
 
-			$result = $source->result();
-
+			$compress_result = $source->result();
 			$meta = array(
 				'input' => array(
 					'size' => strlen( $input ),
-					'type' => $result->mediaType(),
+					'type' => Tiny_Helpers::get_mimetype( $input ),
 				),
 				'output' => array(
-					'size' => $result->size(),
-					'type' => $result->mediaType(),
-					'width' => $result->width(),
-					'height' => $result->height(),
-					'ratio' => round( $result->size() / strlen( $input ), 4 ),
+					'size' => $compress_result->size(),
+					'type' => $compress_result->mediaType(),
+					'width' => $compress_result->width(),
+					'height' => $compress_result->height(),
+					'ratio' => round( $compress_result->size() / strlen( $input ), 4 ),
 				),
 			);
 
-			$buffer = $result->toBuffer();
-			return array( $buffer, $meta );
+			$buffer = $compress_result->toBuffer();
+			$result = array( $buffer, $meta, null );
+
+			if ( isset( $convert_opts['convert'] ) && true == $convert_opts['convert'] ) {
+				$convert_to = $convert_opts['convert_to'];
+				$convert_source = $source->convert( array(
+					'type' => $convert_to,
+				) );
+				$convert_result = $convert_source->result();
+				$meta['convert'] = array(
+					'type' => $convert_result->mediaType(),
+					'size' => $convert_result->size(),
+				);
+				$convert_buffer = $convert_result->toBuffer();
+				$result = array( $buffer, $meta, $convert_buffer );
+			}
 
+			return $result;
 		} catch ( \Tinify\Exception $err ) {
 			$this->last_error_code = $err->status;
 
@@ -130,7 +144,7 @@ protected function compress( $input, $resize_opts, $preserve_opts ) {
 				get_class( $err ),
 				$err->status
 			);
-		}// End try().
+		} // End try().
 	}
 
 	public function create_key( $email, $options ) {

src/class-tiny-compress-fopen.php

@@ -82,7 +82,7 @@ protected function validate() {
 		}
 	}
 
-	protected function compress( $input, $resize_opts, $preserve_opts ) {
+	protected function compress( $input, $resize_opts, $preserve_opts, $convert_opts ) {
 		$params = $this->request_options( 'POST', $input );
 		list($details, $headers, $status_code) = $this->request( $params );
 
@@ -133,7 +133,7 @@ protected function compress( $input, $resize_opts, $preserve_opts ) {
 		$meta = array(
 			'input' => array(
 				'size' => strlen( $input ),
-				'type' => $headers['content-type'],
+				'type' => Tiny_Helpers::get_mimetype( $input ),
 			),
 			'output' => array(
 				'size' => strlen( $output ),
@@ -144,9 +144,36 @@ protected function compress( $input, $resize_opts, $preserve_opts ) {
 			),
 		);
 
-		return array( $output, $meta );
-	}
+		$convert = null;
+
+		if ( isset( $convert_opts['convert'] ) && true === $convert_opts['convert'] ) {
+			$convert_to = $convert_opts['convert_to'];
+			$convert_params = $this->request_options(
+				'POST',
+				array(
+					'convert' => array(
+						'type' => $convert_to,
+					),
+				),
+				array( 'Content-Type: application/json' )
+			);
+
+			list($convert_output, $convert_headers) = $this->request(
+				$convert_params,
+				$output_url
+			);
+			$meta['convert'] = array(
+				'type' => $convert_headers['content-type'],
+				'size' => strlen( $convert_output ),
+			);
+			$convert = $convert_output;
 
+		}
+
+		$result = array( $output, $meta, $convert );
+
+		return $result;
+	}
 	private function request( $params, $url = Tiny_Config::SHRINK_URL ) {
 		$context = stream_context_create( $params );
 		$request = fopen( $url, 'rb', false, $context );
@@ -188,8 +215,10 @@ private function request( $params, $url = Tiny_Config::SHRINK_URL ) {
 		$response = stream_get_contents( $request );
 		fclose( $request );
 
-		if ( isset( $headers['content-type'] ) &&
-			substr( 'application/json' == $headers['content-type'], 0, 16 ) ) {
+		if (
+			isset( $headers['content-type'] ) &&
+			substr( 'application/json' == $headers['content-type'], 0, 16 )
+		) {
 			$response = $this->decode( $response );
 		}
 
@@ -221,11 +250,11 @@ private function request_options( $method, $body = null, $headers = array() ) {
 		return array(
 			'http' => array(
 				'method' => $method,
-				'header' => array_merge( $headers, array(
+				'header' => array_merge($headers, array(
 					'Authorization: Basic ' . base64_encode( 'api:' . $this->api_key ),
 					'User-Agent: ' . self::identifier(),
 					'Content-Type: multipart/form-data',
-				) ),
+				)),
 				'content' => $body,
 				'follow_location' => 0,
 				'max_redirects' => 1, // Necessary for PHP 5.2

src/class-tiny-compress.php

@@ -19,6 +19,7 @@
 */
 
 abstract class Tiny_Compress {
+
 	const KEY_MISSING = 'Register an account or provide an API key first';
 	const FILE_MISSING = 'File does not exist';
 	const WRITE_ERROR = 'No permission to write to file';
@@ -43,7 +44,7 @@ public static function create( $api_key, $after_compress_callback = null ) {
 	public static function estimate_cost( $compressions, $usage ) {
 		return round(
 			self::compression_cost( $compressions + $usage ) -
-			self::compression_cost( $usage ),
+				self::compression_cost( $usage ),
 			2
 		);
 	}
@@ -80,7 +81,7 @@ public function get_status() {
 			if ( $err->get_status() == 404 ) {
 				$message = 'The key that you have entered is not valid';
 			} else {
-				list( $message ) = explode( ' (HTTP', $err->getMessage(), 2 );
+				list($message) = explode( ' (HTTP', $err->getMessage(), 2 );
 			}
 		}
 
@@ -92,7 +93,21 @@ public function get_status() {
 		);
 	}
 
-	public function compress_file( $file, $resize_opts = array(), $preserve_opts = array() ) {
+	/**
+	 * Compresses a single file
+	 *
+	 * @param [type] $file
+	 * @param array $resize_opts
+	 * @param array $preserve_opts
+	 * @param array{ convert: bool, convert_to: string } conversion options
+	 * @return void
+	 */
+	public function compress_file(
+		$file,
+		$resize_opts = array(),
+		$preserve_opts = array(),
+		$convert_opts = array()
+	) {
 		if ( $this->get_key() == null ) {
 			throw new Tiny_Exception( self::KEY_MISSING, 'KeyError' );
 		}
@@ -110,28 +125,55 @@ public function compress_file( $file, $resize_opts = array(), $preserve_opts = a
 		}
 
 		try {
-			list( $output, $details ) = $this->compress(
-				file_get_contents( $file ),
+			$file_data = file_get_contents( $file );
+
+			list($output, $details, $convert_output ) = $this->compress(
+				$file_data,
 				$resize_opts,
-				$preserve_opts
+				$preserve_opts,
+				$convert_opts
 			);
 		} catch ( Tiny_Exception $err ) {
 			$this->call_after_compress_callback();
 			throw $err;
 		}
 
-		$this->call_after_compress_callback();
-		file_put_contents( $file, $output );
+		try {
+			file_put_contents( $file, $output );
+		} catch ( Exception $e ) {
+			throw new Tiny_Exception( $e->getMessage(), 'FileError' );
+		}
+
+		if ( $convert_output ) {
+			$converted_filepath = Tiny_Helpers::replace_file_extension(
+				$details['convert']['type'],
+				$file
+			);
+
+			try {
+				file_put_contents( $converted_filepath, $convert_output );
+			} catch ( Exception $e ) {
+				throw new Tiny_Exception( $e->getMessage(), 'FileError' );
+			}
+			$details['convert']['path'] = $converted_filepath;
+		}
 
 		if ( $resize_opts ) {
 			$details['output']['resized'] = true;
 		}
 
+		$this->call_after_compress_callback();
+
 		return $details;
 	}
 
 	protected abstract function validate();
-	protected abstract function compress( $input, $resize_options, $preserve_options );
+	protected abstract function compress(
+		$input,
+		$resize_options,
+		$preserve_options,
+		$convert_opts
+	);
 
 	protected static function identifier() {
 		return 'WordPress/' . Tiny_Plugin::wp_version() . ' Plugin/' . Tiny_Plugin::version();
@@ -150,7 +192,12 @@ private static function needs_resize( $file, $resize_options ) {
 
 		list($width, $height) = getimagesize( $file );
 
-		return ( $width > $resize_options['width'] || $height > $resize_options['height'] );
+		$should_resize_width  = isset( $resize_options['width'] ) &&
+			$width > $resize_options['width'];
+		$should_resize_height = isset( $resize_options['height'] ) &&
+			$height > $resize_options['height'];
+
+		return $should_resize_width || $should_resize_height;
 	}
 
 	private static function compression_cost( $total ) {