Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Error_Handler class.

[2] Fix | Delete

[3] Fix | Delete

* @package Smush\Core

[4] Fix | Delete

* @version 3.12.0

[5] Fix | Delete

[6] Fix | Delete

[7] Fix | Delete

namespace Smush\Core;

[8] Fix | Delete

[9] Fix | Delete

use Smush\Core\Media\Media_Item;

[10] Fix | Delete

use Smush\Core\Media\Media_Item_Cache;

[11] Fix | Delete

use Smush\Core\Media\Media_Item_Optimizer;

[12] Fix | Delete

use Smush\Core\Stats\Global_Stats;

[13] Fix | Delete

use WP_Error;

[14] Fix | Delete

[15] Fix | Delete

if ( ! defined( 'WPINC' ) ) {

[16] Fix | Delete

die;

[17] Fix | Delete

}

[18] Fix | Delete

[19] Fix | Delete

class Error_Handler {

[20] Fix | Delete

/**

[21] Fix | Delete

* Ignore meta key.

[22] Fix | Delete

[23] Fix | Delete

const IGNORE_KEY = 'wp-smush-ignore-bulk';

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Error meta key.

[27] Fix | Delete

[28] Fix | Delete

const ERROR_KEY = 'wp-smush-error';

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Animated error code.

[32] Fix | Delete

[33] Fix | Delete

const ANIMATED_ERROR_CODE = 'animated';

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* Handled error codes.

[37] Fix | Delete

[38] Fix | Delete

* @var array

[39] Fix | Delete

[40] Fix | Delete

private static $locked_error_codes = array(

[41] Fix | Delete

'ignored',

[42] Fix | Delete

// 'in_progress',

[43] Fix | Delete

// 'animated',

[44] Fix | Delete

);

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Skipped error codes.

[48] Fix | Delete

[49] Fix | Delete

* @var array

[50] Fix | Delete

[51] Fix | Delete

private static $skipped_error_codes = array(

[52] Fix | Delete

'skipped_filter',

[53] Fix | Delete

'ignored',

[54] Fix | Delete

'animated',

[55] Fix | Delete

'size_limit',

[56] Fix | Delete

'size_pro_limit',

[57] Fix | Delete

);

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* Should regenerate thumbnail error codes.

[61] Fix | Delete

[62] Fix | Delete

* @var array

[63] Fix | Delete

[64] Fix | Delete

private static $regenerate_error_codes = array(

[65] Fix | Delete

'no_file_meta',

[66] Fix | Delete

'file_not_found',

[67] Fix | Delete

[68] Fix | Delete

);

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* Get error message.

[72] Fix | Delete

[73] Fix | Delete

* @param string $error_code Error code.

[74] Fix | Delete

* @param int $image_id Attachment ID.

[75] Fix | Delete

* @return string

[76] Fix | Delete

[77] Fix | Delete

public static function get_error_message( $error_code, $image_id = 0 ) {

[78] Fix | Delete

$error_messages = self::get_default_error_messages();

[79] Fix | Delete

$error_message = ! empty( $error_messages[ $error_code ] ) ? $error_messages[ $error_code ] : '';

[80] Fix | Delete

return self::format_error_message( $error_message, $error_code, $image_id );

[81] Fix | Delete

}

[82] Fix | Delete

[83] Fix | Delete

/**

[84] Fix | Delete

* Get sprintf error message.

[85] Fix | Delete

[86] Fix | Delete

* @param string $error_message Error message.

[87] Fix | Delete

* @param string $error_code Error code.

[88] Fix | Delete

* @param int $image_id Attachment ID.

[89] Fix | Delete

* @return string

[90] Fix | Delete

[91] Fix | Delete

private static function format_error_message( $error_message, $error_code, $image_id ) {

[92] Fix | Delete

if ( empty( $image_id ) || empty( $error_message ) || false === strpos( $error_message, '%s' ) ) {

[93] Fix | Delete

return $error_message;

[94] Fix | Delete

}

[95] Fix | Delete

switch ( $error_code ) {

[96] Fix | Delete

case 'size_limit':

[97] Fix | Delete

case 'size_pro_limit':

[98] Fix | Delete

$size_exceeded = Helper::size_limit_exceeded( $image_id );

[99] Fix | Delete

if ( $size_exceeded ) {

[100] Fix | Delete

$error_message = sprintf( $error_message, size_format( $size_exceeded ) );

[101] Fix | Delete

} else {

[102] Fix | Delete

$error_message = null;

[103] Fix | Delete

}

[104] Fix | Delete

break;

[105] Fix | Delete

case 'not_writable':

[106] Fix | Delete

$file_path = Helper::get_attached_file( $image_id );

[107] Fix | Delete

$error_message = sprintf( $error_message, Helper::clean_file_path( dirname( $file_path ) ) );

[108] Fix | Delete

break;

[109] Fix | Delete

case 'file_not_found':

[110] Fix | Delete

$file_path = Helper::get_attached_file( $image_id );

[111] Fix | Delete

$file_not_found = $file_path;

[112] Fix | Delete

if ( file_exists( $file_path ) ) {

[113] Fix | Delete

// Try go get the not found thumbnail file.

[114] Fix | Delete

$all_file_sizes = wp_get_attachment_metadata( $image_id );

[115] Fix | Delete

$dir_path = dirname( $file_path );

[116] Fix | Delete

if ( ! empty( $all_file_sizes['sizes'] ) ) {

[117] Fix | Delete

foreach ( $all_file_sizes['sizes'] as $size => $size_data ) {

[118] Fix | Delete

$size_file = $dir_path . '/' . $size_data['file'];

[119] Fix | Delete

if ( ! file_exists( $size_file ) ) {

[120] Fix | Delete

$file_not_found = $size_file;

[121] Fix | Delete

break;

[122] Fix | Delete

}

[123] Fix | Delete

}

[124] Fix | Delete

}

[125] Fix | Delete

}

[126] Fix | Delete

$error_message = sprintf( $error_message, basename( $file_not_found ) );

[127] Fix | Delete

break;

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

return $error_message;

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

public static function get_all_failed_images() {

[134] Fix | Delete

$media_item_error_ids = Global_Stats::get()->get_error_list()->get_ids();

[135] Fix | Delete

$optimization_error_ids = self::get_last_optimization_error_ids( PHP_INT_MAX );

[136] Fix | Delete

return array_unique( array_merge( $media_item_error_ids, $optimization_error_ids ) );

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

/**

[140] Fix | Delete

* Get last optimization errors.

[141] Fix | Delete

[142] Fix | Delete

* @param int $limit Query limit.

[143] Fix | Delete

* @return array

[144] Fix | Delete

[145] Fix | Delete

private static function get_last_optimization_error_ids( $limit ) {

[146] Fix | Delete

global $wpdb;

[147] Fix | Delete

// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared

[148] Fix | Delete

$query = $wpdb->prepare(

[149] Fix | Delete

"SELECT DISTINCT post_meta_error.post_id FROM $wpdb->postmeta as post_meta_error

[150] Fix | Delete

LEFT JOIN $wpdb->postmeta as post_meta_ignore ON post_meta_ignore.post_id = post_meta_error.post_id AND post_meta_ignore.meta_key= %s

[151] Fix | Delete

WHERE post_meta_ignore.meta_value IS NULL AND post_meta_error.meta_key = %s

[152] Fix | Delete

ORDER BY post_meta_error.post_id DESC LIMIT %d;",

[153] Fix | Delete

Media_Item::IGNORED_META_KEY,

[154] Fix | Delete

Media_Item_Optimizer::ERROR_META_KEY,

[155] Fix | Delete

$limit

[156] Fix | Delete

);

[157] Fix | Delete

/**

[158] Fix | Delete

* Due to performance, we do not join with table wp_posts to exclude the deleted attachments,

[159] Fix | Delete

* leave a filter for third-party custom it.

[160] Fix | Delete

[161] Fix | Delete

$query = apply_filters( 'wp_smush_query_get_last_optimize_errors', $query );

[162] Fix | Delete

// phpcs:ignore WordPress.DB.DirectDatabaseQuery, WordPress.DB.PreparedSQL.NotPrepared

[163] Fix | Delete

return $wpdb->get_col( $query );

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

private static function get_last_media_item_errors( $limit ) {

[167] Fix | Delete

$error_list_ids = Global_Stats::get()->get_error_list()->get_ids();

[168] Fix | Delete

$last_errors = array();

[169] Fix | Delete

if ( empty( $error_list_ids ) ) {

[170] Fix | Delete

return $last_errors;

[171] Fix | Delete

}

[172] Fix | Delete

foreach( $error_list_ids as $attachment_id ) {

[173] Fix | Delete

$media_item = Media_Item_Cache::get_instance()->get( $attachment_id );

[174] Fix | Delete

if ( ! $media_item->has_errors() ) {

[175] Fix | Delete

continue;

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

$last_errors[ $attachment_id ] = self::get_error( $media_item->get_errors(), $media_item );

[179] Fix | Delete

[180] Fix | Delete

if ( count( $last_errors ) >= $limit ) {

[181] Fix | Delete

break;

[182] Fix | Delete

}

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

return $last_errors;

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

private static function get_last_optimize_errors( $limit ) {

[189] Fix | Delete

$last_errors_ids = self::get_last_optimization_error_ids( $limit );

[190] Fix | Delete

$last_errors = array();

[191] Fix | Delete

if ( empty( $last_errors_ids ) ) {

[192] Fix | Delete

return $last_errors;

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

foreach( $last_errors_ids as $attachment_id ) {

[196] Fix | Delete

$media_item = Media_Item_Cache::get_instance()->get( $attachment_id );

[197] Fix | Delete

$optimizer = new Media_Item_Optimizer($media_item);

[198] Fix | Delete

[199] Fix | Delete

if( ! $optimizer->has_errors() ) {

[200] Fix | Delete

continue;

[201] Fix | Delete

}

[202] Fix | Delete

[203] Fix | Delete

$last_errors[ $attachment_id ] = self::get_error( $optimizer->get_errors(), $media_item );

[204] Fix | Delete

[205] Fix | Delete

if ( count( $last_errors ) >= $limit ) {

[206] Fix | Delete

break;

[207] Fix | Delete

}

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

return $last_errors;

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

/**

[214] Fix | Delete

* Get latest errors.

[215] Fix | Delete

[216] Fix | Delete

* @param int $limit Limit number of errors to return.

[217] Fix | Delete

* @return array

[218] Fix | Delete

[219] Fix | Delete

public static function get_last_errors( $limit = 10 ) {

[220] Fix | Delete

$last_errors = self::get_last_media_item_errors( $limit );

[221] Fix | Delete

$no_item_errors = count( $last_errors );

[222] Fix | Delete

if ( $no_item_errors >= $limit ) {

[223] Fix | Delete

return $last_errors;

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete

$optimize_errors = self::get_last_optimize_errors( $limit - $no_item_errors );

[227] Fix | Delete

[228] Fix | Delete

return $last_errors + $optimize_errors;

[229] Fix | Delete

}

[230] Fix | Delete

[231] Fix | Delete

/**

[232] Fix | Delete

* @return array

[233] Fix | Delete

[234] Fix | Delete

public static function get_error( WP_Error $errors, Media_Item $media_item ) {

[235] Fix | Delete

$thumbnail = $media_item->get_size('thumbnail' );

[236] Fix | Delete

return array(

[237] Fix | Delete

'error_code' => $errors->get_error_code(),

[238] Fix | Delete

'error_message' => $errors->get_error_message(),

[239] Fix | Delete

'file_name' => $media_item->get_scaled_or_full_size()->get_file_name(),

[240] Fix | Delete

'thumbnail' => $thumbnail ? $thumbnail->get_file_url() : false,

[241] Fix | Delete

);

[242] Fix | Delete

}

[243] Fix | Delete

[244] Fix | Delete

/**

[245] Fix | Delete

* Get error messages.

[246] Fix | Delete

[247] Fix | Delete

* @return array

[248] Fix | Delete

[249] Fix | Delete

private static function get_default_error_messages() {

[250] Fix | Delete

return apply_filters(

[251] Fix | Delete

'wp_smush_error_messages',

[252] Fix | Delete

array(

[253] Fix | Delete

'missing_id' => esc_html__( 'No attachment ID was received.', 'wp-smushit' ),

[254] Fix | Delete

'ignored' => esc_html__( 'Skip ignored file.', 'wp-smushit' ),

[255] Fix | Delete

'animated' => esc_html__( 'Skipped animated file.', 'wp-smushit' ),

[256] Fix | Delete

'in_progress' => esc_html__( 'File processing is in progress.', 'wp-smushit' ),

[257] Fix | Delete

'no_file_meta' => esc_html__( 'No file data found in image meta', 'wp-smushit' ),

[258] Fix | Delete

'skipped_filter' => esc_html__( 'Skipped with wp_smush_image filter', 'wp-smushit' ),

[259] Fix | Delete

'empty_path' => esc_html__( 'File path is empty', 'wp-smushit' ),

[260] Fix | Delete

'empty_response' => esc_html__( 'Webp no response was received.', 'wp-smushit' ),

[261] Fix | Delete

'not_processed' => esc_html__( 'Not processed', 'wp-smushit' ),

[262] Fix | Delete

/* translators: %s: image size */

[263] Fix | Delete

'size_limit' => __( 'Skipped (%s), file size limit of 5mb exceeded', 'wp-smushit' ),

[264] Fix | Delete

/* translators: %s: image size */

[265] Fix | Delete

'size_pro_limit' => __( 'Skipped (%s), file size limit of 256mb exceeded', 'wp-smushit' ),

[266] Fix | Delete

/* translators: %s: Directory path */

[267] Fix | Delete

'not_writable' => __( '%s is not writable', 'wp-smushit' ),

[268] Fix | Delete

/* translators: %s: File path */

[269] Fix | Delete

'file_not_found' => __( 'Skipped (%s), File not found.', 'wp-smushit' ),

[270] Fix | Delete

)

[271] Fix | Delete

);

[272] Fix | Delete

}

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete