<?php

[0] Fix | Delete

[1] Fix | Delete

namespace ImageOptimization\Modules\Optimization\Components;

[2] Fix | Delete

[3] Fix | Delete

use ImageOptimization\Classes\Image\{

[4] Fix | Delete

Exceptions\Invalid_Image_Exception,

[5] Fix | Delete

Image,

[6] Fix | Delete

Image_Conversion,

[7] Fix | Delete

Image_Conversion_Option,

[8] Fix | Delete

Image_Meta,

[9] Fix | Delete

Image_Optimization_Error_Type,

[10] Fix | Delete

Image_Status

[11] Fix | Delete

};

[12] Fix | Delete

[13] Fix | Delete

use ImageOptimization\Modules\Oauth\Components\{

[14] Fix | Delete

Exceptions\Auth_Error,

[15] Fix | Delete

};

[16] Fix | Delete

[17] Fix | Delete

use ImageOptimization\Modules\Optimization\{

[18] Fix | Delete

Classes\Exceptions\Image_Validation_Error,

[19] Fix | Delete

Classes\Optimization_Error_Message,

[20] Fix | Delete

Classes\Validate_Image,

[21] Fix | Delete

Module,

[22] Fix | Delete

};

[23] Fix | Delete

[24] Fix | Delete

use ImageOptimization\Classes\File_Utils;

[25] Fix | Delete

use ImageOptimization\Modules\Settings\Classes\Settings;

[26] Fix | Delete

use ImageOptimization\Modules\Stats\Classes\Optimization_Stats;

[27] Fix | Delete

[28] Fix | Delete

use Throwable;

[29] Fix | Delete

[30] Fix | Delete

use ImageOptimization\Plugin;

[31] Fix | Delete

[32] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[33] Fix | Delete

exit; // Exit if accessed directly.

[34] Fix | Delete

}

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* The class is responsible for rendering optimization control in all views.

[38] Fix | Delete

*/

[39] Fix | Delete

class Media_Control {

[40] Fix | Delete

const COLUMN_ID = 'image_optimization';

[41] Fix | Delete

const META_BOX_ID = 'image_optimization_meta_box';

[42] Fix | Delete

const DETAILS_MODAL_FIELD_ID = 'image_optimization_modal';

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Adds a new optimization column to the library list view.

[46] Fix | Delete

*

[47] Fix | Delete

* @param array $columns

[48] Fix | Delete

* @return array

[49] Fix | Delete

*/

[50] Fix | Delete

public function add_optimization_column( array $columns ): array {

[51] Fix | Delete

if ( empty( $columns ) ) {

[52] Fix | Delete

return $columns;

[53] Fix | Delete

}

[54] Fix | Delete

[55] Fix | Delete

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

[56] Fix | Delete

[57] Fix | Delete

return $columns;

[58] Fix | Delete

}

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* Renders optimization controls in the library list view.

[62] Fix | Delete

*

[63] Fix | Delete

* @param string $column_name

[64] Fix | Delete

* @param int $attachment_id

[65] Fix | Delete

* @return void

[66] Fix | Delete

*/

[67] Fix | Delete

public function render_optimization_column( string $column_name, int $attachment_id ) {

[68] Fix | Delete

if ( self::COLUMN_ID !== $column_name ) {

[69] Fix | Delete

return;

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

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

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Adds optimization control as media meta box.

[77] Fix | Delete

*

[78] Fix | Delete

* @return void

[79] Fix | Delete

*/

[80] Fix | Delete

public function add_optimization_meta_box() {

[81] Fix | Delete

add_meta_box(

[82] Fix | Delete

self::META_BOX_ID,

[83] Fix | Delete

__( 'Image optimization', 'image-optimization' ),

[84] Fix | Delete

function( $post ) {

[85] Fix | Delete

$this->render_optimization_control( 'meta-box', $post->ID );

[86] Fix | Delete

},

[87] Fix | Delete

'attachment',

[88] Fix | Delete

'side',

[89] Fix | Delete

);

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

/**

[93] Fix | Delete

* Adds optimization control to media modals.

[94] Fix | Delete

*

[95] Fix | Delete

* @param array $form_fields

[96] Fix | Delete

* @param \WP_Post $post

[97] Fix | Delete

*

[98] Fix | Delete

* @return array

[99] Fix | Delete

*/

[100] Fix | Delete

public function add_media_modal_details( array $form_fields, \WP_Post $post ): array {

[101] Fix | Delete

$form_fields[ self::DETAILS_MODAL_FIELD_ID ] = [

[102] Fix | Delete

'label' => '',

[103] Fix | Delete

'input' => 'hidden',

[104] Fix | Delete

'value' => $this->get_optimization_control_html( 'details-view', $post->ID ),

[105] Fix | Delete

'required' => false,

[106] Fix | Delete

];

[107] Fix | Delete

[108] Fix | Delete

return $form_fields;

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

/**

[112] Fix | Delete

* Returns optimization control as an HTML string.

[113] Fix | Delete

*

[114] Fix | Delete

* @param string $context Control placement context. One of ['list-view', 'meta-box', 'details-view'].

[115] Fix | Delete

* @param int $image_id Attachment id.

[116] Fix | Delete

* @return false|string

[117] Fix | Delete

*/

[118] Fix | Delete

public function get_optimization_control_html( string $context, int $image_id ) {

[119] Fix | Delete

ob_start();

[120] Fix | Delete

[121] Fix | Delete

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

[122] Fix | Delete

[123] Fix | Delete

$html = ob_get_contents();

[124] Fix | Delete

ob_end_clean();

[125] Fix | Delete

[126] Fix | Delete

return $html;

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

/**

[130] Fix | Delete

* Renders the optimization control for the current image in the current context.

[131] Fix | Delete

*

[132] Fix | Delete

* @param string $context Control placement context. One of ['list-view', 'meta-box', 'details-view'].

[133] Fix | Delete

* @param int $image_id Attachment id.

[134] Fix | Delete

* @return void Renders the control.

[135] Fix | Delete

*/

[136] Fix | Delete

public function render_optimization_control( string $context, int $image_id ) {

[137] Fix | Delete

$global_context = [

[138] Fix | Delete

'image_id' => $image_id,

[139] Fix | Delete

'can_be_restored' => false,

[140] Fix | Delete

];

[141] Fix | Delete

[142] Fix | Delete

// @var ImageOptimizer/Modules/ConnectManager/Module

[143] Fix | Delete

$module = Plugin::instance()->modules_manager->get_modules( 'connect-manager' );

[144] Fix | Delete

[145] Fix | Delete

try {

[146] Fix | Delete

if ( ! $module->connect_instance->is_connected() || ! $module->connect_instance->is_activated() ) {

[147] Fix | Delete

throw new Auth_Error( 'You have to activate your license to use Image Optimizer' );

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

Validate_Image::is_valid( $image_id );

[151] Fix | Delete

[152] Fix | Delete

$image = new Image( $image_id );

[153] Fix | Delete

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

[154] Fix | Delete

[155] Fix | Delete

if ( Image_Status::OPTIMIZED === $meta->get_status() ) {

[156] Fix | Delete

$global_context['can_be_restored'] = $image->can_be_restored();

[157] Fix | Delete

} else {

[158] Fix | Delete

$ic = new Image_Conversion();

[159] Fix | Delete

[160] Fix | Delete

$path = $image->get_file_path( Image::SIZE_FULL );

[161] Fix | Delete

$backups_enabled = Settings::get( Settings::BACKUP_ORIGINAL_IMAGES_OPTION_NAME );

[162] Fix | Delete

$conversion_enabled = $ic->is_enabled();

[163] Fix | Delete

$needs_conversion = $conversion_enabled &&

[164] Fix | Delete

strtolower( File_Utils::get_extension( $path ) ) !== $ic->get_current_file_extension();

[165] Fix | Delete

[166] Fix | Delete

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

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

switch ( $meta->get_status() ) {

[170] Fix | Delete

case Image_Status::OPTIMIZATION_IN_PROGRESS:

[171] Fix | Delete

Module::load_template( $context, 'loading', array_merge(

[172] Fix | Delete

$global_context, [

[173] Fix | Delete

'action' => 'optimize',

[174] Fix | Delete

]

[175] Fix | Delete

) );

[176] Fix | Delete

[177] Fix | Delete

break;

[178] Fix | Delete

[179] Fix | Delete

case Image_Status::REOPTIMIZING_IN_PROGRESS:

[180] Fix | Delete

Module::load_template( $context, 'loading', array_merge(

[181] Fix | Delete

$global_context, [

[182] Fix | Delete

'action' => 'reoptimize',

[183] Fix | Delete

]

[184] Fix | Delete

) );

[185] Fix | Delete

[186] Fix | Delete

break;

[187] Fix | Delete

[188] Fix | Delete

case Image_Status::RESTORING_IN_PROGRESS:

[189] Fix | Delete

Module::load_template( $context, 'loading', array_merge(

[190] Fix | Delete

$global_context, [

[191] Fix | Delete

'action' => 'restore',

[192] Fix | Delete

]

[193] Fix | Delete

) );

[194] Fix | Delete

[195] Fix | Delete

break;

[196] Fix | Delete

[197] Fix | Delete

case Image_Status::OPTIMIZED:

[198] Fix | Delete

$stats = Optimization_Stats::get_image_stats( $image_id );

[199] Fix | Delete

$saved = [

[200] Fix | Delete

'relative' => max( 100 - round( $stats['current_image_size'] / $stats['initial_image_size'] * 100 ), 0 ),

[201] Fix | Delete

'absolute' => $stats['initial_image_size'] - $stats['current_image_size'],

[202] Fix | Delete

];

[203] Fix | Delete

[204] Fix | Delete

$is_losseless_and_webp = Image_Conversion_Option::WEBP === Settings::get( Settings::CONVERT_TO_FORMAT_OPTION_NAME )

[205] Fix | Delete

&& 'lossless' === Settings::get( Settings::COMPRESSION_LEVEL_OPTION_NAME );

[206] Fix | Delete

[207] Fix | Delete

Module::load_template( $context, 'optimized', array_merge(

[208] Fix | Delete

$global_context, [

[209] Fix | Delete

'sizes_optimized_count' => $stats['optimized_image_count'],

[210] Fix | Delete

'sizes_total' => $stats['total_image_count'],

[211] Fix | Delete

'saved' => $saved,

[212] Fix | Delete

'is_losseless_and_webp' => $is_losseless_and_webp,

[213] Fix | Delete

]

[214] Fix | Delete

) );

[215] Fix | Delete

[216] Fix | Delete

break;

[217] Fix | Delete

[218] Fix | Delete

case Image_Status::OPTIMIZATION_FAILED:

[219] Fix | Delete

$error_type = $meta->get_error_type() ?? Image_Optimization_Error_Type::GENERIC;

[220] Fix | Delete

$error_message = Optimization_Error_Message::get_optimization_error_message( $error_type );

[221] Fix | Delete

$images_left = $module->connect_instance->images_left();

[222] Fix | Delete

[223] Fix | Delete

Module::load_template( $context, 'error', array_merge(

[224] Fix | Delete

$global_context, [

[225] Fix | Delete

'message' => $error_message,

[226] Fix | Delete

'optimization_error_type' => $error_type,

[227] Fix | Delete

'images_left' => $images_left,

[228] Fix | Delete

'allow_retry' => true,

[229] Fix | Delete

'action' => 'optimize',

[230] Fix | Delete

]

[231] Fix | Delete

) );

[232] Fix | Delete

[233] Fix | Delete

break;

[234] Fix | Delete

[235] Fix | Delete

case Image_Status::REOPTIMIZING_FAILED:

[236] Fix | Delete

$error_type = $meta->get_error_type() ?? Image_Optimization_Error_Type::GENERIC;

[237] Fix | Delete

$error_message = Optimization_Error_Message::get_reoptimization_error_message( $error_type );

[238] Fix | Delete

$images_left = $module->connect_instance->images_left();

[239] Fix | Delete

[240] Fix | Delete

Module::load_template( $context, 'error', array_merge(

[241] Fix | Delete

$global_context, [

[242] Fix | Delete

'message' => $error_message,

[243] Fix | Delete

'optimization_error_type' => $error_type,

[244] Fix | Delete

'images_left' => $images_left,

[245] Fix | Delete

'allow_retry' => true,

[246] Fix | Delete

'action' => 'reoptimize',

[247] Fix | Delete

]

[248] Fix | Delete

) );

[249] Fix | Delete

[250] Fix | Delete

break;

[251] Fix | Delete

[252] Fix | Delete

case Image_Status::RESTORING_FAILED:

[253] Fix | Delete

Module::load_template( $context, 'error', array_merge(

[254] Fix | Delete

$global_context, [

[255] Fix | Delete

'message' => esc_html__( 'Image restoring error', 'image-optimization' ),

[256] Fix | Delete

'allow_retry' => true,

[257] Fix | Delete

'action' => 'restore',

[258] Fix | Delete

]

[259] Fix | Delete

) );

[260] Fix | Delete

[261] Fix | Delete

break;

[262] Fix | Delete

[263] Fix | Delete

default:

[264] Fix | Delete

Module::load_template( $context, 'not-optimized', $global_context );

[265] Fix | Delete

}

[266] Fix | Delete

} catch ( Invalid_Image_Exception | Image_Validation_Error $iie ) {

[267] Fix | Delete

Module::load_template( $context, 'error', array_merge(

[268] Fix | Delete

$global_context, [

[269] Fix | Delete

'action' => 'error',

[270] Fix | Delete

'message' => $iie->getMessage(),

[271] Fix | Delete

'allow_retry' => false,

[272] Fix | Delete

]

[273] Fix | Delete

) );

[274] Fix | Delete

} catch ( Auth_Error $ae ) {

[275] Fix | Delete

Module::load_template( $context, 'error', array_merge(

[276] Fix | Delete

$global_context, [

[277] Fix | Delete

'action' => 'error',

[278] Fix | Delete

'message' => esc_html__( 'N/A', 'image-optimization' ),

[279] Fix | Delete

'allow_retry' => false,

[280] Fix | Delete

]

[281] Fix | Delete

) );

[282] Fix | Delete

} catch ( Throwable $t ) {

[283] Fix | Delete

Module::load_template( $context, 'error', array_merge(

[284] Fix | Delete

$global_context, [

[285] Fix | Delete

'action' => 'error',

[286] Fix | Delete

'message' => esc_html__( 'Internal server error', 'image-optimization' ),

[287] Fix | Delete

'allow_retry' => false,

[288] Fix | Delete

]

[289] Fix | Delete

) );

[290] Fix | Delete

}

[291] Fix | Delete

}

[292] Fix | Delete

[293] Fix | Delete

public function __construct() {

[294] Fix | Delete

add_filter( 'manage_upload_columns', [ $this, 'add_optimization_column' ] );

[295] Fix | Delete

add_action( 'manage_media_custom_column', [ $this, 'render_optimization_column' ], 10, 2 );

[296] Fix | Delete

[297] Fix | Delete

add_action( 'add_meta_boxes_attachment', [ $this, 'add_optimization_meta_box' ] );

[298] Fix | Delete

add_filter( 'attachment_fields_to_edit', [ $this, 'add_media_modal_details' ], 10, 2 );

[299] Fix | Delete

}

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete