Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/mets.corals.io/wp-content/plugins/wp-smushit/app/ |
<?php
/**
* Media library class.
*
* Responsible for displaying a UI (stats + action links) in the media library and the editor.
*
* @since 3.4.0
* @package Smush\App
*/
namespace Smush\App;
use Smush\Core\Core;
use Smush\Core\Helper;
use Smush\Core\Modules\Abstract_Module;
use Smush\Core\Modules\Smush;
use Smush\Core\Error_Handler;
use WP_Post;
use WP_Query;
use WP_Smush;
/**
* Class Media_Library
*/
class Media_Library extends Abstract_Module {
/**
* Core instance.
*
* @var Core $core
*/
private $core;
private $allowed_image_sizes;
/**
* Media_Library constructor.
*
* @param Core $core Core instance.
*/
public function __construct( Core $core ) {
parent::__construct();
$this->core = $core;
}
/**
* Init functionality that is related to the UI.
*/
public function init_ui() {
// Media library columns.
add_filter( 'manage_media_columns', array( $this, 'columns' ) );
add_filter( 'manage_upload_sortable_columns', array( $this, 'sortable_column' ) );
add_action( 'manage_media_custom_column', array( $this, 'custom_column' ), 10, 2 );
// Manage column sorting.
add_action( 'pre_get_posts', array( $this, 'smushit_orderby' ) );
// Smush image filter from Media Library.
add_filter( 'ajax_query_attachments_args', array( $this, 'filter_media_query' ) );
// Smush image filter from Media Library (list view).
add_action( 'restrict_manage_posts', array( $this, 'add_filter_dropdown' ) );
// Add pre WordPress 5.0 compatibility.
add_filter( 'wp_kses_allowed_html', array( $this, 'filter_html_attributes' ) );
add_action( 'admin_enqueue_scripts', array( $this, 'extend_media_modal' ), 15 );
add_filter( 'wp_prepare_attachment_for_js', array( $this, 'smush_send_status' ), 99, 3 );
}
/**
* Print column header for Smush results in the media library using the `manage_media_columns` hook.
*
* @param array $defaults Defaults array.
*
* @return array
*/
public function columns( $defaults ) {
$defaults['smushit'] = 'Smush';
return $defaults;
}
/**
* Add the Smushit Column to sortable list
*
* @param array $columns Columns array.
*
* @return array
*/
public function sortable_column( $columns ) {
$columns['smushit'] = 'smushit';
return $columns;
}
/**
* Print column data for Smush results in the media library using
* the `manage_media_custom_column` hook.
*
* @param string $column_name Column name.
* @param int $id Attachment ID.
*/
public function custom_column( $column_name, $id ) {
if ( 'smushit' === $column_name ) {
$escaped_text = wp_kses_post( $this->generate_markup( $id ) );
if ( $this->is_failed_processing_page() ) {
$escaped_text = sprintf( '<div class="smush-failed-processing">%s</div>', $escaped_text );
}
echo $escaped_text;
}
}
/**
* Detect failed processing page.
*
* @since 3.12.0
*
* @return boolean
*/
private function is_failed_processing_page() {
static $is_failed_processing_page;
if ( null === $is_failed_processing_page ) {
$filter = filter_input( INPUT_GET, 'smush-filter', FILTER_SANITIZE_SPECIAL_CHARS );
$is_failed_processing_page = 'failed_processing' === $filter;
}
return $is_failed_processing_page;
}
/**
* Order by query for smush columns.
*
* @param WP_Query $query Query.
*
* @return WP_Query
*/
public function smushit_orderby( $query ) {
global $current_screen;
// Filter only media screen.
if ( ! is_admin() || ( ! empty( $current_screen ) && 'upload' !== $current_screen->base ) ) {
return $query;
}
$filter = filter_input( INPUT_GET, 'smush-filter', FILTER_SANITIZE_SPECIAL_CHARS );
// Ignored.
if ( 'ignored' === $filter ) {
$query->set( 'meta_query', $this->query_ignored() );
return $query;
} elseif ( 'unsmushed' === $filter ) {
// Not processed.
$query->set( 'meta_query', $this->query_unsmushed() );
return $query;
} elseif ( 'failed_processing' === $filter ) {
// Failed processing.
$query->set( 'meta_query', $this->query_failed_processing() );
return $query;
}
// TODO: do we need this?
$orderby = $query->get( 'orderby' );
if ( isset( $orderby ) && 'smushit' === $orderby ) {
$query->set(
'meta_query',
array(
'relation' => 'OR',
array(
'key' => Smush::$smushed_meta_key,
'compare' => 'EXISTS',
),
array(
'key' => Smush::$smushed_meta_key,
'compare' => 'NOT EXISTS',
),
)
);
$query->set( 'orderby', 'meta_value_num' );
}
return $query;
}
/**
* Add our filter to the media query filter in Media Library.
*
* @since 2.9.0
*
* @see wp_ajax_query_attachments()
*
* @param array $query Query.
*
* @return mixed
*/
public function filter_media_query( $query ) {
$post_query = filter_input( INPUT_POST, 'query', FILTER_SANITIZE_SPECIAL_CHARS, FILTER_REQUIRE_ARRAY );
if ( ! isset( $post_query['stats'] ) ) {
return $query;
}
$filter_name = $post_query['stats'];
// Excluded.
if ( 'excluded' === $filter_name ) {
$query['meta_query'] = $this->query_ignored();
} elseif ( 'unsmushed' === $filter_name ) {
// Unsmushed.
$query['meta_query'] = $this->query_unsmushed();
} elseif ( 'failed_processing' === $filter_name ) {
// Failed processing.
$query['meta_query'] = $this->query_failed_processing();
}
return $query;
}
/**
* Meta query for images skipped from bulk smush.
*
* @return array
*/
private function query_failed_processing() {
$meta_query = array(
'relation' => 'AND',
array(
'key' => Error_Handler::ERROR_KEY,
'compare' => 'EXISTS',
),
array(
'key' => Error_Handler::IGNORE_KEY,
'compare' => 'NOT EXISTS',
),
);
if ( WP_Smush::is_pro() ) {
$meta_query[] = array(
'key' => Error_Handler::ERROR_KEY,
'value' => 'size_limit',
'compare' => '!=',
);
}
return $meta_query;
}
/**
* Meta query for images skipped from bulk smush.
*
* @return array
*/
private function query_ignored() {
return array(
array(
'key' => 'wp-smush-ignore-bulk',
'compare' => 'EXISTS',
),
);
}
/**
* Meta query for uncompressed images.
*
* @return array
*/
private function query_unsmushed() {
return Core::get_unsmushed_meta_query();
}
/**
* Adds a search dropdown in Media Library list view to filter out images that have been
* ignored with bulk Smush.
*
* @since 3.2.0
*/
public function add_filter_dropdown() {
$scr = get_current_screen();
if ( 'upload' !== $scr->base ) {
return;
}
$ignored = filter_input( INPUT_GET, 'smush-filter', FILTER_SANITIZE_SPECIAL_CHARS );
?>
<label for="smush_filter" class="screen-reader-text">
<?php esc_html_e( 'Filter by Smush status', 'wp-smushit' ); ?>
</label>
<select class="smush-filters" name="smush-filter" id="smush_filter">
<option value="" <?php selected( $ignored, '' ); ?>><?php esc_html_e( 'Smush: All images', 'wp-smushit' ); ?></option>
<option value="unsmushed" <?php selected( $ignored, 'unsmushed' ); ?>><?php esc_html_e( 'Smush: Not processed', 'wp-smushit' ); ?></option>
<option value="ignored" <?php selected( $ignored, 'ignored' ); ?>><?php esc_html_e( 'Smush: Bulk ignored', 'wp-smushit' ); ?></option>
<option value="failed_processing" <?php selected( $ignored, 'failed_processing' ); ?>><?php esc_html_e( 'Smush: Failed Processing', 'wp-smushit' ); ?></option>
</select>
<?php
}
/**
* Data attributes are not allowed on <a> elements on WordPress before 5.0.0.
* Add backward compatibility.
*
* @since 3.5.0
* @see https://github.com/WordPress/WordPress/commit/a0309e80b6a4d805e4f230649be07b4bfb1a56a5#diff-a0e0d196dd71dde453474b0f791828fe
* @param array $context Context.
*
* @return mixed
*/
public function filter_html_attributes( $context ) {
global $wp_version;
if ( version_compare( '5.0.0', $wp_version, '<' ) ) {
return $context;
}
$context['a']['data-tooltip'] = true;
$context['a']['data-id'] = true;
$context['a']['data-nonce'] = true;
return $context;
}
/**
* Load media assets.
*
* Localization also used in Gutenberg integration.
*/
public function extend_media_modal() {
// Get current screen.
$current_screen = get_current_screen();
// Only run on required pages.
if ( ! empty( $current_screen ) && ! in_array( $current_screen->id, Core::$external_pages, true ) && empty( $current_screen->is_block_editor ) ) {
return;
}
if ( wp_script_is( 'smush-backbone-extension', 'enqueued' ) ) {
return;
}
wp_enqueue_script(
'smush-backbone-extension',
WP_SMUSH_URL . 'app/assets/js/smush-media.min.js',
array(
'jquery',
'media-editor', // Used in image filters.
'media-views',
'media-grid',
'wp-util',
'wp-api',
),
WP_SMUSH_VERSION,
true
);
wp_localize_script(
'smush-backbone-extension',
'smush_vars',
array(
'strings' => array(
'stats_label' => esc_html__( 'Smush', 'wp-smushit' ),
'filter_all' => esc_html__( 'Smush: All images', 'wp-smushit' ),
'filter_not_processed' => esc_html__( 'Smush: Not processed', 'wp-smushit' ),
'filter_excl' => esc_html__( 'Smush: Bulk ignored', 'wp-smushit' ),
'filter_failed' => esc_html__( 'Smush: Failed Processing', 'wp-smushit' ),
'gb' => array(
'stats' => esc_html__( 'Smush Stats', 'wp-smushit' ),
'select_image' => esc_html__( 'Select an image to view Smush stats.', 'wp-smushit' ),
'size' => esc_html__( 'Image size', 'wp-smushit' ),
'savings' => esc_html__( 'Savings', 'wp-smushit' ),
),
),
)
);
}
/**
* Send smush status for attachment.
*
* @param array $response Response array.
* @param WP_Post $attachment Attachment object.
*
* @return mixed
*/
public function smush_send_status( $response, $attachment ) {
if ( ! isset( $attachment->ID ) ) {
return $response;
}
// Validate nonce.
$status = $this->smush_status( $attachment->ID );
$response['smush'] = $status;
return $response;
}
/**
* Get the smush button text for attachment.
*
* @param int $id Attachment ID for which the Status has to be set.
*
* @return string
*/
private function smush_status( $id ) {
$action = filter_input( INPUT_POST, 'action', FILTER_SANITIZE_SPECIAL_CHARS, FILTER_NULL_ON_FAILURE );
// Show Temporary Status, For Async Optimisation, No Good workaround.
if ( ! get_transient( 'wp-smush-restore-' . $id ) && 'upload-attachment' === $action && $this->settings->get( 'auto' ) ) {
$status_txt = '<p class="smush-status">' . __( 'Smushing in progress...', 'wp-smushit' ) . '</p>';
$button_txt = __( 'Smush Now!', 'wp-smushit' );
return $this->column_html( $id, $status_txt, $button_txt, false );
}
// Else return the normal status.
return trim( $this->generate_markup( $id ) );
}
/**
* Skip messages respective to their IDs.
*
* @param string $msg_id Message ID.
*
* @return bool
*/
public function skip_reason( $msg_id ) {
$count = count( get_intermediate_image_sizes() );
$smush_orgnl_txt = sprintf(
/* translators: %s: number of thumbnails */
esc_html__( 'When you upload an image to WordPress it automatically creates %s thumbnail sizes that are commonly used in your pages. WordPress also stores the original full-size image, but because these are not usually embedded on your site we don’t Smush them. Pro users can override this.', 'wp-smushit' ),
$count
);
$skip_msg = array(
'large_size' => $smush_orgnl_txt,
'size_limit' => esc_html__( "Image couldn't be smushed as it exceeded the 5Mb size limit, Pro users can smush images without any size restriction.", 'wp-smushit' ),
);
$skip_rsn = '';
if ( ! empty( $skip_msg[ $msg_id ] ) ) {
$skip_rsn = '<a href="https://wpmudev.com/project/wp-smush-pro/?utm_source=smush&utm_medium=plugin&utm_campaign=smush_medialibrary_savings" target="_blank">
<span class="sui-tooltip sui-tooltip-left sui-tooltip-constrained sui-tooltip-top-right-mobile" data-tooltip="' . $skip_msg[ $msg_id ] . '">
<span class="sui-tag sui-tag-purple sui-tag-sm">' . esc_html__( 'PRO', 'wp-smushit' ) . '</span></span></a>';
}
return $skip_rsn;
}
/**
* Generate HTML for image status on the media library page.
*
* @since 3.5.0 Refactored from set_status().
*
* @param int $id Attachment ID.
*
* @return string HTML content or array of results.
*/
public function generate_markup( $id ) {
// Don't proceed if attachment is not image, or if image is not a jpg, png or gif, or if is not found.
$is_smushable = Helper::is_smushable( $id );
$is_image_404 = false === $is_smushable;
if ( ! $is_smushable && ! $is_image_404 && empty( $smush_data ) ) {
return Error_Handler::get_error_message_for_media_library( 'not_processed' );
}
$smush_data = get_post_meta( $id, Smush::$smushed_meta_key, true );
$attachment_data = wp_get_attachment_metadata( $id );
$error_code = Error_Handler::get_error_code( $id );
$error_class = ! empty( $error_code ) ? ' smush-warning' : '';
if ( Error_Handler::is_ignored( $id ) ) {
$error_class .= ' smush-ignored';
}
$html = '<p class="smush-status' . $error_class . '">' . $this->get_optimization_status( $id, $smush_data ) . '</p>';
// Need links, except the time that the image can't be optimized anymore.
$links = $this->get_optimization_links( $id, $smush_data, $attachment_data );
if ( ! empty( $links ) ) {
$html .= '<div class="sui-smush-media smush-status-links">' . $links . '</div>';
}
// Attach the stats table.
if ( isset( $smush_data['sizes'] ) ) {
$html .= $this->get_detailed_stats( $id, $smush_data, $attachment_data );
}
return $html;
}
/**
* Get error message.
*
* @param int $attachment_id Attachment ID.
* @param string $error_code Error code.
* @return null|string
*/
private function get_error_message( $attachment_id, $error_code = false ) {
if ( ! empty( $error_code ) ) {
return Error_Handler::get_error_message_for_media_library( $error_code, $attachment_id );
}
$is_ignored = Error_Handler::is_ignored( $attachment_id );
$error_code = Error_Handler::get_error_code( $attachment_id );
if ( $is_ignored ) {
if ( Core::STATUS_ANIMATED === (int) $is_ignored || Error_Handler::ANIMATED_ERROR_CODE === $error_code ) {
return Error_Handler::get_error_message_for_media_library( 'animated' );
}
return Error_Handler::get_error_message_for_media_library( 'ignored' );
}
if ( empty( $error_code ) ) {
return;
}
return Error_Handler::get_error_message_for_media_library( $error_code, $attachment_id );
}
/**
* Get the image optimization status.
*
* Status Links Stats
* - Smushing in progress... No buttons false
* - Already optimized No buttons | Re-smush? false
* - Ignored from auto-smush Undo false
* - Not optimized Smush | Ignore false
* - X images reduced by Y
* Image size: Z Re-smush? | View Stats | Restore? true
*
* @param int $id Attachment ID.
* @param array $smush_data Optimization data.
* @param null|string $error_code Error code.
*
* @return string
*/
private function get_optimization_status( $id, $smush_data, $error_code = null ) {
if ( get_transient( 'smush-in-progress-' . $id ) ) {
return Error_Handler::get_error_message_for_media_library( 'in_progress' );
}
$error_message = $this->get_error_message( $id );
if ( $error_message ) {
return $error_message;
}
if ( empty( $smush_data ) ) {
return Error_Handler::get_error_message_for_media_library( 'not_processed' );
}
$stats = $this->core->get_stats_for_attachments( array( $id ) );
if ( $stats['size_after'] === $stats['size_before'] ) {
return __( 'Already optimized', 'wp-smushit' );
}
$percent = ( $stats['size_before'] - $stats['size_after'] ) / $stats['size_before'] * 100;
if ( 1 < $stats['count_images'] ) {
$status_text = sprintf( /* translators: %1$s: bytes savings, %2$s: percentage savings, %3$d: number of images */
esc_html__( '%3$d images reduced by %1$s (%2$s)', 'wp-smushit' ),
esc_html( size_format( $stats['size_before'] - $stats['size_after'], 1 ) ),
sprintf( '%01.1f%%', number_format_i18n( $percent, 2 ) ),
$stats['count_images']
);
} else {
$status_text = sprintf( /* translators: %1$s: bytes savings, %2$s: percentage savings */
esc_html__( 'Reduced by %1$s (%2$s)', 'wp-smushit' ),
esc_html( size_format( $stats['size_before'] - $stats['size_after'], 1 ) ),
sprintf( '%01.1f%%', number_format_i18n( $percent, 2 ) )
);
}
$file_path = get_attached_file( $id );
$size = file_exists( $file_path ) ? filesize( $file_path ) : 0;
if ( $size > 0 ) {
/* translators: %1$s: new line, %2$s: image size */
$status_text .= sprintf( __( '%1$sImage size: %2$s', 'wp-smushit' ), '<br />', size_format( $size, 1 ) );
}
return $status_text;
}
/**
* Get regenerate doc link.
*
* @since 3.12.0
*
* @return string
*/
private function get_regenerate_doc_link() {
$doc = 'https://wpmudev.com/docs/wpmu-dev-plugins/smush/';
if ( ! WP_Smush::is_pro() ) {
$doc = 'https://wpmudev.com/docs/wpmu-dev-plugins/smush/?utm_source=smush&utm_medium=plugin&utm_campaign=smush_pluginlist_docs';
}
$doc .= '#restoring-images';
return $doc;
}
/**
* Get revert link with utm links.
*
* @since 3.12.0
*
* @param int $attachment_id Attachment ID.
* @param string $utm_link Utm link.
*
* @return string
*/
private function get_revert_with_utm_links( $attachment_id, $utm_link = '' ) {
$nonce = wp_create_nonce( 'wp-smush-remove-skipped' );
$links = '';
$class_name = 'wp-smush-remove-skipped';
if ( ! empty( $utm_link ) ) {
$links .= $utm_link;
$class_name .= ' smush-revert-utm';
}
$links .= "<a href='#' class='" . esc_attr( $class_name ) . "' data-id='{$attachment_id}' data-nonce='{$nonce}'>" . esc_html__( 'Revert back to previous state', 'wp-smushit' ) . '</a>';
return $links;
}
/**
* Get ignore button with suggestion link for regeneration.
*
* @since 3.12.0
*
* @param int $attachment_id Attachment ID.
* @return string
*/
private function get_ignore_with_regenerate_links( $attachment_id ) {
$links = "<a target='_blank' href='" . esc_url( $this->get_regenerate_doc_link() ) . "' class='wp-smush-learnmore' data-id='{$attachment_id}'>" . esc_html__( 'Learn more', 'wp-smushit' ) . '</a>';
$links .= ' | ';
$links .= "<a href='#' class='smush-ignore-image' data-id='{$attachment_id}'>" . esc_html__( 'Ignore', 'wp-smushit' ) . '</a>';
return $links;
}
/**
* Get ignore links and resmush or utm link.
*
* @since 3.12.0
*
* @param int $attachment_id Attachment ID.
* @param string $utm_link Utm link.
*
* @return string
*/
private function get_ignore_with_failed_links( $attachment_id, $utm_link = '' ) {
$links = '';
$class_name = 'smush-ignore-image';
if ( empty( $utm_link ) ) {
$links = self::get_resmsuh_link( $attachment_id );
$links .= ' | ';
} else {
$links .= $utm_link;
$class_name .= ' smush-ignore-utm';
}
$links .= "<a href='#' class='" . esc_attr( $class_name ) . "' data-id='{$attachment_id}'>" . esc_html__( 'Ignore', 'wp-smushit' ) . '</a>';
return $links;
}
/**
* Get not processed links.
*
* @since 3.12.0
*
* @param int $attachment_id Attachment ID.
*
* @return string
*/
private function get_not_processed_link( $attachment_id ) {
$links = "<a href='#' class='wp-smush-send' data-id='{$attachment_id}'>" . esc_html__( 'Smush', 'wp-smushit' ) . '</a>';
$links .= ' | ';
$links .= "<a href='#' class='smush-ignore-image' data-id='{$attachment_id}'>" . esc_html__( 'Ignore', 'wp-smushit' ) . '</a>';
return $links;
}
/**
* Get optimization links. Possible values:
* - Smush
* - Ignore
* - View Stats
* - Restore
* - Undo
*
* @param int $id Attachment ID.
* @param array $smush_data Optimization data.
* @param array $attachment_data Attachment data.
*
* @return string
*/
public function get_optimization_links( $id, $smush_data = array(), $attachment_data = array() ) {
if ( get_transient( 'smush-in-progress-' . $id ) ) {
return '';
}
// Skipped.
$is_ignored = Error_Handler::is_ignored( $id );
$error_code = Error_Handler::get_error_code( $id );
$utm_link = Error_Handler::get_utm_msg( $error_code );
if ( $is_ignored ) {
return $this->get_revert_with_utm_links( $id, $utm_link );
}
$show_restore_link = $this->show_restore_option( $id, $attachment_data );
$should_hide_doc_link = apply_filters( 'wpmudev_branding_hide_doc_link', false );
$show_learn_more_link = ! $show_restore_link && ! $should_hide_doc_link;
if ( Error_Handler::should_regenerate_thumbnail( $error_code ) && $show_learn_more_link ) {
return $this->get_ignore_with_regenerate_links( $id );
}
if ( empty( $smush_data ) && ! empty( $error_code ) ) {
// Failed too early, maybe it was a temporary issue that resmushing will fix.
return $this->get_ignore_with_failed_links( $id, $utm_link );
}
// Not optimized.
if ( empty( $smush_data ) ) {
return $this->get_not_processed_link( $id );
}
$stats = $this->core->get_stats_for_attachments( array( $id ) );
$show_resmush = $this->show_resmush( $id, $smush_data, $attachment_data );
// Already optimized, but needs a resumsh.
if ( $stats['size_after'] === $stats['size_before'] && $show_resmush ) {
return self::get_resmsuh_link( $id );
}
$links = $show_resmush ? self::get_resmsuh_link( $id ) : $this->get_super_smush_link( $id, $smush_data );
// Show restore link only for images that had actual savings.
if ( $stats['size_after'] !== $stats['size_before'] && $show_restore_link ) {
$links .= empty( $links ) ? '' : ' | ';
$links .= self::get_restore_link( $id );
}
// Detailed Stats Link.
if ( $stats['size_after'] !== $stats['size_before'] ) {
$links .= empty( $links ) ? '' : ' | ';
$links .= sprintf(
'<a href="#" class="wp-smush-action smush-stats-details wp-smush-title sui-tooltip sui-tooltip-top-right" data-tooltip="%s">%s</a>',
esc_html__( 'Detailed stats for all the image sizes', 'wp-smushit' ),
esc_html__( 'View Stats', 'wp-smushit' )
);
}
return $links;
}
/**
* Checks the current settings and returns the value whether to enable or not the resmush option.
*
* @param string $id Attachment ID.
* @param array $wp_smush_data Smush data.
* @param array $attachment_data Attachment data.
*
* @return bool
*/
private function show_resmush( $id = '', $wp_smush_data = array(), $attachment_data = array() ) {
$resmush_ids = (array) get_option( 'wp-smush-resmush-list', array() );
// If it's in resmushed lists, return.
if ( in_array( $id, $resmush_ids ) ) {
return true;
}
return $this->should_resmush( $id, $wp_smush_data, $attachment_data );
}
/**
* Checks the current settings and returns the value whether to should resmush the attachment or not.
*
* @param int $attachment_id Attachment ID.
* @param array $smush_data Smush data.
* @param array $attachment_data Attachment data.
*
* @since 3.10.3 Create a general method for re-using inside Ajax::scan_images()
*
* @return bool
*/
public function should_resmush( $attachment_id, $smush_data, $attachment_data = array() ) {
// If skipped, returns.
if ( ! apply_filters( 'wp_smush_image', true, $attachment_id ) ) {
return false;
}
// If we need to optimise losslessly, add to resmush list.
if ( $this->settings->get( 'lossy' ) && empty( $smush_data['stats']['lossy'] ) ) {
return true;
}
// If we need to strip exif, put it in resmush list.
if ( $this->settings->get( 'strip_exif' ) && isset( $smush_data['stats']['keep_exif'] ) && ( 1 === (int) $smush_data['stats']['keep_exif'] ) ) {
return true;
}
if ( empty( $attachment_data ) ) {
$attachment_data = wp_get_attachment_metadata( $attachment_id );
}
$attachment_sizes = empty( $attachment_data['sizes'] ) ? array() : $attachment_data['sizes'];
$smushed_sizes = empty( $smush_data['sizes'] ) ? array() : $smush_data['sizes'];
// If Original image needs to be smushed.
if ( $this->settings->get( 'original' ) && WP_Smush::is_pro() && empty( $smushed_sizes['full'] ) ) {
return true;
}
// Initially assume that we should not resmush.
$should_resmush = false;
// Get list of allowed image sizes.
$allowed_image_sizes = $this->get_allowed_image_sizes();
// unsmushed sizes = allowed sizes - smushed sizes
$unsmushed_sizes = ! empty( $smushed_sizes ) && $allowed_image_sizes && is_array( $allowed_image_sizes )
? array_diff_key( $allowed_image_sizes, $smushed_sizes )
: false;
// Support for WordPress.com hosting Site Accelerator.
$has_photon_filter = has_filter( 'wp_image_editors', 'photon_subsizes_override_image_editors' );
if ( $unsmushed_sizes && ! $has_photon_filter ) {
$optimized_files = $this->get_optimized_image_files( $smushed_sizes, $attachment_sizes );
foreach ( $unsmushed_sizes as $unsmushed_image_size => $unsmushed_size_data ) {
if ( isset( $attachment_sizes[ $unsmushed_image_size ]['file'] ) ) {
$maybe_unsmushed_file = $attachment_sizes[ $unsmushed_image_size ]['file'];
if ( in_array( $maybe_unsmushed_file, $optimized_files, true ) ) {
// Even though the size is unsmushed, the underlying file has already been smushed, so skip.
continue;
}
}
// If image has a size that can be compressed.
if ( isset( $attachment_sizes[ $unsmushed_image_size ] ) ) {
$should_resmush = true;
break;
}
}
}
/**
* If the image needs to be resmushed add it to the list.
*
* @since 3.9.6 Add a filter to allow user handle resmush.
*
* @param bool $should_resmush Whether the image should resmush.
* @param int $attachment Attachment ID.
* @param array $smush_data Smushed data.
*
* @hooked Smush\Core\Modules\Png2jpg::should_resmush() 9
* @hooked Smush\Core\Modules\Resize::should_resmush() 10
* @hooked Smush\Core\Modules\Webp::should_resmush() 10
*/
return apply_filters( 'wp_smush_should_resmush', $should_resmush, $attachment_id, $smush_data );
}
/**
* Get allowed image sizes.
*
* @return array
*/
private function get_allowed_image_sizes() {
// Even with BP we do not scan multiple blogs in the same request, so cache it.
if ( is_null( $this->allowed_image_sizes ) ) {
$this->allowed_image_sizes = $this->prepare_allowed_image_sizes();
}
return $this->allowed_image_sizes;
}
private function prepare_allowed_image_sizes() {
$image_sizes = $this->settings->get_setting( 'wp-smush-image_sizes' );
if ( empty( $image_sizes ) ) {
// Empty means we need to smush all images. So get all sizes of current site.
$image_sizes = WP_Smush::get_instance()->core()->image_dimensions();
} elseif ( is_array( $image_sizes ) ) {
$image_sizes = array_flip( $image_sizes );
} else {
$image_sizes = array();
}
return $image_sizes;
}
/**
* Multiple attachment sizes can have the same underlying file.
* This method returns an array of file names that have been smushed already.
*
* @param $smushed_sizes
* @param $attachment_sizes
*
* @return array
*/
private function get_optimized_image_files( $smushed_sizes, $attachment_sizes ) {
$optimized_files = array();
foreach ( $smushed_sizes as $smushed_image_size => $image_stats ) {
if ( isset( $attachment_sizes[ $smushed_image_size ]['file'] ) ) {
$optimized_files[] = $attachment_sizes[ $smushed_image_size ]['file'];
}
}
return $optimized_files;
}
/**
* If any of the image size have a backup file, show the restore option
*
* @param int $image_id Attachment ID.
* @param string|array $attachment_data Attachment data.
*
* @return bool
*/
private function show_restore_option( $image_id, $attachment_data ) {
// No Attachment data, don't go ahead.
if ( empty( $attachment_data ) || ! $this->settings->get( 'backup' ) ) {
return false;
}
return $this->core->mod->backup->backup_exists( $image_id );
}
/**
* Print the column html.
*
* @param string $id Media id.
* @param string $html Status text.
* @param string $button_txt Button label.
* @param boolean $show_button Whether to shoe the button.
*
* @return string
*/
private function column_html( $id, $html = '', $button_txt = '', $show_button = true ) {
// Don't proceed if attachment is not image, or if image is not a jpg, png or gif, or if is not found.
$is_smushable = Helper::is_smushable( $id );
if ( ! $is_smushable ) {
return false === $is_smushable ? esc_html__( 'Image not found!', 'wp-smushit' ) : esc_html__( 'Not processed', 'wp-smushit' );
}
// If we aren't showing the button.
if ( ! $show_button ) {
return $html;
}
if ( 'Super-Smush' === $button_txt ) {
$html .= ' | ';
}
$html .= "<a href='#' class='wp-smush-send' data-id='{$id}'>{$button_txt}</a>";
if ( get_post_meta( $id, 'wp-smush-ignore-bulk', true ) ) {
$nonce = wp_create_nonce( 'wp-smush-remove-skipped' );
$html .= " | <a href='#' class='wp-smush-remove-skipped' data-id={$id} data-nonce={$nonce}>" . esc_html__( 'Show in bulk Smush', 'wp-smushit' ) . '</a>';
} else {
$html .= " | <a href='#' class='smush-ignore-image' data-id='{$id}'>" . esc_html__( 'Ignore', 'wp-smushit' ) . '</a>';
}
$html .= self::progress_bar();
return $html;
}
/**
* Shows the image size and the compression for each of them
*
* @param int $image_id Attachment ID.
* @param array $wp_smush_data Smush data array.
* @param array $attachment_metadata Attachment metadata.
*
* @return string
*/
private function get_detailed_stats( $image_id, $wp_smush_data, $attachment_metadata ) {
$stats = '<div id="smush-stats-' . $image_id . '" class="sui-smush-media smush-stats-wrapper hidden">
<table class="wp-smush-stats-holder">
<thead>
<tr>
<th class="smush-stats-header">' . esc_html__( 'Image size', 'wp-smushit' ) . '</th>
<th class="smush-stats-header">' . esc_html__( 'Savings', 'wp-smushit' ) . '</th>
</tr>
</thead>
<tbody>';
$size_stats = $wp_smush_data['sizes'];
// Reorder Sizes as per the maximum savings.
uasort(
$size_stats,
function( $a, $b ) {
if ( $a->bytes === $b->bytes ) {
return 0;
}
return $a->bytes < $b->bytes ? 1 : -1;
}
);
if ( ! empty( $attachment_metadata['sizes'] ) ) {
// Get skipped images.
$skipped = $this->get_skipped_images( $image_id, $size_stats, $attachment_metadata );
if ( ! empty( $skipped ) ) {
foreach ( $skipped as $img_data ) {
$skip_class = 'size_limit' === $img_data['reason'] ? ' error' : '';
$stats .= '<tr>
<td>' . strtoupper( $img_data['size'] ) . '</td>
<td class="smush-skipped' . $skip_class . '">' . $this->skip_reason( $img_data['reason'] ) . '</td>
</tr>';
}
}
}
// Show Sizes and their compression.
foreach ( $size_stats as $size_key => $size_value ) {
$dimensions = '';
// Get the dimensions for the image size if available.
if ( ! empty( $attachment_metadata['sizes'] ) && ! empty( $attachment_metadata['sizes'][ $size_key ] ) ) {
$dimensions = $attachment_metadata['sizes'][ $size_key ]['width'] . 'x' . $attachment_metadata['sizes'][ $size_key ]['height'];
}
$dimensions = ! empty( $dimensions ) ? sprintf( ' <br /> (%s)', $dimensions ) : '';
if ( $size_value->bytes > 0 ) {
$percent = round( $size_value->percent, 1 );
$percent = $percent > 0 ? ' ( ' . $percent . '% )' : '';
$stats .= '<tr>
<td>' . strtoupper( $size_key ) . $dimensions . '</td>
<td>' . size_format( $size_value->bytes, 1 ) . $percent . '</td>
</tr>';
}
}
$stats .= '</tbody>
</table>
</div>';
return $stats;
}
/**
* Return a list of images not smushed and reason
*
* @param int $image_id Attachment ID.
* @param array $size_stats Stats array.
* @param array $attachment_metadata Attachment metadata.
*
* @return array
*/
private function get_skipped_images( $image_id, $size_stats, $attachment_metadata ) {
$skipped = array();
// Get a list of all the sizes, Show skipped images.
$media_size = get_intermediate_image_sizes();
// Full size.
$full_image = get_attached_file( $image_id );
// If full image was not smushed, reason 1. Large Size logic, 2. Free and greater than 5Mb.
if ( ! array_key_exists( 'full', $size_stats ) && ! WP_Smush::is_pro() ) {
// For free version, Check the image size.
$skipped[] = array(
'size' => 'full',
'reason' => 'large_size',
);
// For free version, check if full size is greater than 5 Mb, show the skipped status.
$file_size = file_exists( $full_image ) ? filesize( $full_image ) : '';
if ( empty( $skipped ) && ! empty( $file_size ) && ( $file_size / WP_SMUSH_MAX_BYTES ) > 1 ) {
$skipped[] = array(
'size' => 'full',
'reason' => 'size_limit',
);
}
}
// For other sizes, check if the image was generated and not available in stats.
if ( is_array( $media_size ) ) {
foreach ( $media_size as $size ) {
if ( array_key_exists( $size, $attachment_metadata['sizes'] ) && ! array_key_exists( $size, $size_stats ) && ! empty( $size['file'] ) ) {
// Image Path.
$img_path = path_join( dirname( $full_image ), $size['file'] );
$image_size = file_exists( $img_path ) ? filesize( $img_path ) : '';
if ( ! empty( $image_size ) && ( $image_size / WP_SMUSH_MAX_BYTES ) > 1 ) {
$skipped[] = array(
'size' => 'full',
'reason' => 'size_limit',
);
}
}
}
}
return $skipped;
}
/**
* Returns the HTML for progress bar
*
* @return string
*/
public static function progress_bar() {
return '<span class="spinner wp-smush-progress"></span>';
}
/**
* Generates a Resmush link for a image.
*
* @param int $image_id Attachment ID.
* @param string $type Type of attachment.
*
* @return bool|string
*/
public static function get_resmsuh_link( $image_id, $type = 'wp' ) {
if ( empty( $image_id ) ) {
return false;
}
$class = 'wp-smush-action wp-smush-title sui-tooltip sui-tooltip-constrained';
$class .= 'wp' === $type ? ' wp-smush-resmush' : ' wp-smush-nextgen-resmush';
return sprintf(
'<a href="#" data-tooltip="%s" data-id="%d" data-nonce="%s" class="%s">%s</a>',
esc_html__( 'Smush image including original file', 'wp-smushit' ),
$image_id,
wp_create_nonce( 'wp-smush-resmush-' . $image_id ),
$class,
esc_html__( 'Resmush', 'wp-smushit' )
);
}
/**
* Returns a restore link for given image id
*
* @param int $image_id Attachment ID.
* @param string $type Attachment type.
*
* @return bool|string
*/
public static function get_restore_link( $image_id, $type = 'wp' ) {
if ( empty( $image_id ) ) {
return false;
}
$class = 'wp-smush-action wp-smush-title sui-tooltip';
$class .= 'wp' === $type ? ' wp-smush-restore' : ' wp-smush-nextgen-restore';
return sprintf(
'<a href="#" data-tooltip="%s" data-id="%d" data-nonce="%s" class="%s">%s</a>',
esc_html__( 'Restore original image', 'wp-smushit' ),
$image_id,
wp_create_nonce( 'wp-smush-restore-' . $image_id ),
$class,
esc_html__( 'Restore', 'wp-smushit' )
);
}
/**
* Show super smush link.
*
* @since 3.4.0
*
* @param int $id Attachment ID.
* @param array $smush_data Smush data array.
*
* @return string
*/
private function get_super_smush_link( $id, $smush_data ) {
if ( empty( $smush_data['stats'] ) ) {
return '';
}
// Image is already lossy.
if ( isset( $smush_data['stats']['lossy'] ) && $smush_data['stats']['lossy'] ) {
return '';
}
// Check if compression was lossless, and lossy compression is enabled.
if ( ! $this->settings->get( 'lossy' ) || 'image/gif' === get_post_mime_type( $id ) ) {
return '';
}
return "<a href='#' class='wp-smush-send' data-id='{$id}'>" . __( 'Super-Smush', 'wp-smushit' ) . '</a>';
}
}