HEX
Server: Apache
System: Linux efa57bbe-abb1-400d-2985-3b056fbc2701.secureserver.net 6.1.147-1.el9.elrepo.x86_64 #1 SMP PREEMPT_DYNAMIC Thu Jul 24 12:33:32 EDT 2025 x86_64
User: root (0)
PHP: 8.0.30.4
Disabled: NONE
Upload Files
File: //var/www/wp-content/plugins/image-optimization/modules/optimization/components/media-control.php
<?php

namespace ImageOptimization\Modules\Optimization\Components;

use ImageOptimization\Classes\Image\{
	Exceptions\Invalid_Image_Exception,
	Image,
	Image_Conversion,
	Image_Conversion_Option,
	Image_Meta,
	Image_Optimization_Error_Type,
	Image_Status
};

use ImageOptimization\Modules\Oauth\Components\{
	Exceptions\Auth_Error,
};

use ImageOptimization\Modules\Optimization\{
	Classes\Exceptions\Image_Validation_Error,
	Classes\Optimization_Error_Message,
	Classes\Validate_Image,
	Module,
};

use ImageOptimization\Classes\File_Utils;
use ImageOptimization\Modules\Settings\Classes\Settings;
use ImageOptimization\Modules\Stats\Classes\Optimization_Stats;

use Throwable;

use ImageOptimization\Plugin;

if ( ! defined( 'ABSPATH' ) ) {
	exit; // Exit if accessed directly.
}

/**
 * The class is responsible for rendering optimization control in all views.
 */
class Media_Control {
	const COLUMN_ID = 'image_optimization';
	const META_BOX_ID = 'image_optimization_meta_box';
	const DETAILS_MODAL_FIELD_ID = 'image_optimization_modal';

	/**
	 * Adds a new optimization column to the library list view.
	 *
	 * @param array $columns
	 * @return array
	 */
	public function add_optimization_column( array $columns ): array {
		if ( empty( $columns ) ) {
			return $columns;
		}

		$columns[ self::COLUMN_ID ] = esc_html__( 'Image optimization', 'image-optimization' );

		return $columns;
	}

	/**
	 * Renders optimization controls in the library list view.
	 *
	 * @param string $column_name
	 * @param int $attachment_id
	 * @return void
	 */
	public function render_optimization_column( string $column_name, int $attachment_id ) {
		if ( self::COLUMN_ID !== $column_name ) {
			return;
		}

		$this->render_optimization_control( 'list-view', $attachment_id );
	}

	/**
	 * Adds optimization control as media meta box.
	 *
	 * @return void
	 */
	public function add_optimization_meta_box() {
		add_meta_box(
			self::META_BOX_ID,
			__( 'Image optimization', 'image-optimization' ),
			function( $post ) {
				$this->render_optimization_control( 'meta-box', $post->ID );
			},
			'attachment',
			'side',
		);
	}

	/**
	 * Adds optimization control to media modals.
	 *
	 * @param array $form_fields
	 * @param \WP_Post $post
	 *
	 * @return array
	 */
	public function add_media_modal_details( array $form_fields, \WP_Post $post ): array {
		$form_fields[ self::DETAILS_MODAL_FIELD_ID ] = [
			'label' => '',
			'input' => 'hidden',
			'value' => $this->get_optimization_control_html( 'details-view', $post->ID ),
			'required' => false,
		];

		return $form_fields;
	}

	/**
	 * Returns optimization control as an HTML string.
	 *
	 * @param string $context Control placement context. One of ['list-view', 'meta-box', 'details-view'].
	 * @param int $image_id Attachment id.
	 * @return false|string
	 */
	public function get_optimization_control_html( string $context, int $image_id ) {
		ob_start();

		$this->render_optimization_control( $context, $image_id );

		$html = ob_get_contents();
		ob_end_clean();

		return $html;
	}

	/**
	 * Renders the optimization control for the current image in the current context.
	 *
	 * @param string $context Control placement context. One of ['list-view', 'meta-box', 'details-view'].
	 * @param int $image_id Attachment id.
	 * @return void Renders the control.
	 */
	public function render_optimization_control( string $context, int $image_id ) {
		$global_context = [
			'image_id' => $image_id,
			'can_be_restored' => false,
		];

		// @var ImageOptimizer/Modules/ConnectManager/Module
		$module = Plugin::instance()->modules_manager->get_modules( 'connect-manager' );

		try {
			if ( ! $module->connect_instance->is_connected() || ! $module->connect_instance->is_activated() ) {
				throw new Auth_Error( 'You have to activate your license to use Image Optimizer' );
			}

			Validate_Image::is_valid( $image_id );

			$image = new Image( $image_id );
			$meta = new Image_Meta( $image->get_id() );

			if ( Image_Status::OPTIMIZED === $meta->get_status() ) {
				$global_context['can_be_restored'] = $image->can_be_restored();
			} else {
				$ic = new Image_Conversion();

				$path = $image->get_file_path( Image::SIZE_FULL );
				$backups_enabled = Settings::get( Settings::BACKUP_ORIGINAL_IMAGES_OPTION_NAME );
				$conversion_enabled = $ic->is_enabled();
				$needs_conversion = $conversion_enabled &&
									strtolower( File_Utils::get_extension( $path ) ) !== $ic->get_current_file_extension();

				$global_context['can_be_restored'] = ( $needs_conversion && $conversion_enabled ) || $backups_enabled;
			}

			switch ( $meta->get_status() ) {
				case Image_Status::OPTIMIZATION_IN_PROGRESS:
					Module::load_template( $context, 'loading', array_merge(
						$global_context, [
							'action' => 'optimize',
						]
					) );

					break;

				case Image_Status::REOPTIMIZING_IN_PROGRESS:
					Module::load_template( $context, 'loading', array_merge(
						$global_context, [
							'action' => 'reoptimize',
						]
					) );

					break;

				case Image_Status::RESTORING_IN_PROGRESS:
					Module::load_template( $context, 'loading', array_merge(
						$global_context, [
							'action' => 'restore',
						]
					) );

					break;

				case Image_Status::OPTIMIZED:
					$stats = Optimization_Stats::get_image_stats( $image_id );
					$saved = [
						'relative' => max( 100 - round( $stats['current_image_size'] / $stats['initial_image_size'] * 100 ), 0 ),
						'absolute' => $stats['initial_image_size'] - $stats['current_image_size'],
					];

					$is_losseless_and_webp = Image_Conversion_Option::WEBP === Settings::get( Settings::CONVERT_TO_FORMAT_OPTION_NAME )
											 && 'lossless' === Settings::get( Settings::COMPRESSION_LEVEL_OPTION_NAME );

					Module::load_template( $context, 'optimized', array_merge(
						$global_context, [
							'sizes_optimized_count' => $stats['optimized_image_count'],
							'sizes_total' => $stats['total_image_count'],
							'saved' => $saved,
							'is_losseless_and_webp' => $is_losseless_and_webp,
						]
					) );

					break;

				case Image_Status::OPTIMIZATION_FAILED:
					$error_type = $meta->get_error_type() ?? Image_Optimization_Error_Type::GENERIC;
					$error_message = Optimization_Error_Message::get_optimization_error_message( $error_type );
					$images_left = $module->connect_instance->images_left();

					Module::load_template( $context, 'error', array_merge(
						$global_context, [
							'message' => $error_message,
							'optimization_error_type' => $error_type,
							'images_left' => $images_left,
							'allow_retry' => true,
							'action' => 'optimize',
						]
					) );

					break;

				case Image_Status::REOPTIMIZING_FAILED:
					$error_type = $meta->get_error_type() ?? Image_Optimization_Error_Type::GENERIC;
					$error_message = Optimization_Error_Message::get_reoptimization_error_message( $error_type );
					$images_left = $module->connect_instance->images_left();

					Module::load_template( $context, 'error', array_merge(
						$global_context, [
							'message' => $error_message,
							'optimization_error_type' => $error_type,
							'images_left' => $images_left,
							'allow_retry' => true,
							'action' => 'reoptimize',
						]
					) );

					break;

				case Image_Status::RESTORING_FAILED:
					Module::load_template( $context, 'error', array_merge(
						$global_context, [
							'message' => esc_html__( 'Image restoring error', 'image-optimization' ),
							'allow_retry' => true,
							'action' => 'restore',
						]
					) );

					break;

				default:
					Module::load_template( $context, 'not-optimized', $global_context );
			}
		} catch ( Invalid_Image_Exception | Image_Validation_Error $iie ) {
			Module::load_template( $context, 'error', array_merge(
				$global_context, [
					'action' => 'error',
					'message' => $iie->getMessage(),
					'allow_retry' => false,
				]
			) );
		} catch ( Auth_Error $ae ) {
			Module::load_template( $context, 'error', array_merge(
				$global_context, [
					'action' => 'error',
					'message' => esc_html__( 'N/A', 'image-optimization' ),
					'allow_retry' => false,
				]
			) );
		} catch ( Throwable $t ) {
			Module::load_template( $context, 'error', array_merge(
				$global_context, [
					'action' => 'error',
					'message' => esc_html__( 'Internal server error', 'image-optimization' ),
					'allow_retry' => false,
				]
			) );
		}
	}

	public function __construct() {
		add_filter( 'manage_upload_columns', [ $this, 'add_optimization_column' ] );
		add_action( 'manage_media_custom_column', [ $this, 'render_optimization_column' ], 10, 2 );

		add_action( 'add_meta_boxes_attachment', [ $this, 'add_optimization_meta_box' ] );
		add_filter( 'attachment_fields_to_edit', [ $this, 'add_media_modal_details' ], 10, 2 );
	}
}