Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Smush\Core\Media;

[2] Fix | Delete

[3] Fix | Delete

use Smush\Core\Animated_Status_Controller;

[4] Fix | Delete

use Smush\Core\Array_Utils;

[5] Fix | Delete

use Smush\Core\Backup_Size;

[6] Fix | Delete

use Smush\Core\File_System;

[7] Fix | Delete

use Smush\Core\Helper;

[8] Fix | Delete

use Smush\Core\Settings;

[9] Fix | Delete

use Smush\Core\Smush_File;

[10] Fix | Delete

use WP_Error;

[11] Fix | Delete

use WP_Smush;

[12] Fix | Delete

[13] Fix | Delete

class Media_Item extends Smush_File {

[14] Fix | Delete

const ANIMATED_META_KEY = 'wp-smush-animated';

[15] Fix | Delete

const TRANSPARENT_META_KEY = 'wp-smush-transparent';

[16] Fix | Delete

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

[17] Fix | Delete

[18] Fix | Delete

const SIZE_KEY_SCALED = 'wp_scaled';

[19] Fix | Delete

const SIZE_KEY_FULL = 'full';

[20] Fix | Delete

const BACKUP_SIZES_META_KEY = '_wp_attachment_backup_sizes';

[21] Fix | Delete

const DEFAULT_BACKUP_KEY = 'smush-full';

[22] Fix | Delete

[23] Fix | Delete

private $id;

[24] Fix | Delete

/**

[25] Fix | Delete

* @var array|false

[26] Fix | Delete

[27] Fix | Delete

private $metadata;

[28] Fix | Delete

/**

[29] Fix | Delete

* @var string

[30] Fix | Delete

[31] Fix | Delete

private $edit_link;

[32] Fix | Delete

/**

[33] Fix | Delete

* @var string

[34] Fix | Delete

[35] Fix | Delete

private $file;

[36] Fix | Delete

/**

[37] Fix | Delete

* @var Media_Item_Size[]

[38] Fix | Delete

[39] Fix | Delete

private $sizes;

[40] Fix | Delete

/**

[41] Fix | Delete

* @var Settings

[42] Fix | Delete

[43] Fix | Delete

private $plugin_settings;

[44] Fix | Delete

/**

[45] Fix | Delete

* @var \WP_Post

[46] Fix | Delete

[47] Fix | Delete

private $post;

[48] Fix | Delete

/**

[49] Fix | Delete

* @var string[]

[50] Fix | Delete

[51] Fix | Delete

private $animated_mime_types = array( 'image/gif' );

[52] Fix | Delete

/**

[53] Fix | Delete

* @var bool

[54] Fix | Delete

[55] Fix | Delete

private $animated;

[56] Fix | Delete

/**

[57] Fix | Delete

* @var bool

[58] Fix | Delete

[59] Fix | Delete

private $transparent;

[60] Fix | Delete

/**

[61] Fix | Delete

* @var int

[62] Fix | Delete

[63] Fix | Delete

private $ignored;

[64] Fix | Delete

/**

[65] Fix | Delete

* @var int

[66] Fix | Delete

[67] Fix | Delete

private $size_limit;

[68] Fix | Delete

/**

[69] Fix | Delete

* @var WP_Error

[70] Fix | Delete

[71] Fix | Delete

private $errors;

[72] Fix | Delete

/**

[73] Fix | Delete

* @var array

[74] Fix | Delete

[75] Fix | Delete

private $smushable_sizes;

[76] Fix | Delete

/**

[77] Fix | Delete

* @var bool

[78] Fix | Delete

[79] Fix | Delete

private $is_image;

[80] Fix | Delete

/**

[81] Fix | Delete

* @var bool

[82] Fix | Delete

[83] Fix | Delete

private $mime_type_supported;

[84] Fix | Delete

/**

[85] Fix | Delete

* @var array[]

[86] Fix | Delete

[87] Fix | Delete

private $missing_sizes;

[88] Fix | Delete

[89] Fix | Delete

private $reset_properties = array(

[90] Fix | Delete

'metadata',

[91] Fix | Delete

'file',

[92] Fix | Delete

'sizes',

[93] Fix | Delete

'post',

[94] Fix | Delete

'animated',

[95] Fix | Delete

'ignored',

[96] Fix | Delete

'errors',

[97] Fix | Delete

'smushable_sizes',

[98] Fix | Delete

'is_image',

[99] Fix | Delete

'mime_type_supported',

[100] Fix | Delete

'missing_sizes',

[101] Fix | Delete

'backup_sizes',

[102] Fix | Delete

'mime_type',

[103] Fix | Delete

'attached_file',

[104] Fix | Delete

'original_image_path',

[105] Fix | Delete

'outdated_meta_values',

[106] Fix | Delete

);

[107] Fix | Delete

/**

[108] Fix | Delete

* @var Backup_Size[]

[109] Fix | Delete

[110] Fix | Delete

private $backup_sizes;

[111] Fix | Delete

/**

[112] Fix | Delete

* @var string

[113] Fix | Delete

[114] Fix | Delete

private $mime_type;

[115] Fix | Delete

/**

[116] Fix | Delete

* @var string

[117] Fix | Delete

[118] Fix | Delete

private $attached_file;

[119] Fix | Delete

/**

[120] Fix | Delete

* @var false|string

[121] Fix | Delete

[122] Fix | Delete

private $original_image_path;

[123] Fix | Delete

/**

[124] Fix | Delete

* @var Array_Utils

[125] Fix | Delete

[126] Fix | Delete

private $array_utils;

[127] Fix | Delete

private $registered_wp_sizes;

[128] Fix | Delete

private $outdated_meta_values = array();

[129] Fix | Delete

/**

[130] Fix | Delete

* @var File_System

[131] Fix | Delete

[132] Fix | Delete

private $fs;

[133] Fix | Delete

[134] Fix | Delete

public function __construct( $id ) {

[135] Fix | Delete

$this->id = $id;

[136] Fix | Delete

[137] Fix | Delete

$this->set_settings( Settings::get_instance() );

[138] Fix | Delete

$size_limit = WP_Smush::is_pro()

[139] Fix | Delete

? WP_SMUSH_PREMIUM_MAX_BYTES

[140] Fix | Delete

: WP_SMUSH_MAX_BYTES;

[141] Fix | Delete

$this->set_size_limit( $size_limit );

[142] Fix | Delete

$this->array_utils = new Array_Utils();

[143] Fix | Delete

$this->fs = new File_System();

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

public function size_limit_exceeded() {

[147] Fix | Delete

foreach ( $this->get_smushable_sizes() as $size ) {

[148] Fix | Delete

if ( $size->exceeds_size_limit() ) {

[149] Fix | Delete

return true;

[150] Fix | Delete

}

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

return false;

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

private function get_file_name_exceeding_limit() {

[157] Fix | Delete

foreach ( $this->get_smushable_sizes() as $size ) {

[158] Fix | Delete

if ( $size->exceeds_size_limit() ) {

[159] Fix | Delete

return $size->get_file_name();

[160] Fix | Delete

}

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete

return '';

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

public function set_size_limit( $size_limit ) {

[167] Fix | Delete

$this->size_limit = $size_limit;

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

public function get_size_limit() {

[171] Fix | Delete

return $this->size_limit;

[172] Fix | Delete

}

[173] Fix | Delete

[174] Fix | Delete

public function get_human_size_limit() {

[175] Fix | Delete

return size_format( $this->get_size_limit() );

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

public function get_id() {

[179] Fix | Delete

return $this->id;

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

/**

[183] Fix | Delete

* Checks whether important metadata exists for the media item.

[184] Fix | Delete

[185] Fix | Delete

* Missing metadata for a size does not mean there is a problem, for example data

[186] Fix | Delete

* is not generated if the image is too small to generate a 'large' version.

[187] Fix | Delete

* So we don't check metadata for sizes.

[188] Fix | Delete

[189] Fix | Delete

* @return bool

[190] Fix | Delete

[191] Fix | Delete

public function has_wp_metadata() {

[192] Fix | Delete

$metadata = $this->get_wp_metadata();

[193] Fix | Delete

[194] Fix | Delete

return is_array( $metadata )

[195] Fix | Delete

&& ! empty( $metadata )

[196] Fix | Delete

&& ! empty( $metadata['file'] );

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

private function get_missing_sizes() {

[200] Fix | Delete

if ( is_null( $this->missing_sizes ) ) {

[201] Fix | Delete

$this->missing_sizes = wp_get_missing_image_subsizes( $this->get_id() );

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

return $this->missing_sizes;

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete

/**

[208] Fix | Delete

* TODO: maybe add an error for this

[209] Fix | Delete

* @return bool

[210] Fix | Delete

[211] Fix | Delete

public function has_missing_sizes() {

[212] Fix | Delete

return ! empty( $this->get_missing_sizes() );

[213] Fix | Delete

}

[214] Fix | Delete

[215] Fix | Delete

public function get_wp_metadata() {

[216] Fix | Delete

if ( empty( $this->metadata ) ) {

[217] Fix | Delete

$this->metadata = $this->fetch_wp_metadata();

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

return $this->metadata;

[221] Fix | Delete

}

[222] Fix | Delete

[223] Fix | Delete

private function fetch_wp_metadata() {

[224] Fix | Delete

$attachment_metadata = wp_get_attachment_metadata( $this->get_id() );

[225] Fix | Delete

[226] Fix | Delete

return $this->array_utils->ensure_array( $attachment_metadata );

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

/**

[230] Fix | Delete

* @return void

[231] Fix | Delete

[232] Fix | Delete

private function update_wp_metadata() {

[233] Fix | Delete

$updated_attachment_meta = $this->make_attachment_meta();

[234] Fix | Delete

if ( ! $this->arrays_same( $this->get_wp_metadata(), $updated_attachment_meta ) ) {

[235] Fix | Delete

wp_update_attachment_metadata( $this->get_id(), $updated_attachment_meta );

[236] Fix | Delete

}

[237] Fix | Delete

}

[238] Fix | Delete

[239] Fix | Delete

private function file_name_from_path( $file_path ) {

[240] Fix | Delete

return wp_basename( $file_path );

[241] Fix | Delete

}

[242] Fix | Delete

[243] Fix | Delete

/**

[244] Fix | Delete

* TODO: use this instead of Helper::get_image_media_link

[245] Fix | Delete

* @return string

[246] Fix | Delete

[247] Fix | Delete

public function get_edit_link() {

[248] Fix | Delete

if ( is_null( $this->edit_link ) ) {

[249] Fix | Delete

$this->edit_link = $this->prepare_edit_link();

[250] Fix | Delete

}

[251] Fix | Delete

[252] Fix | Delete

return $this->edit_link;

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

private function prepare_edit_link() {

[256] Fix | Delete

// TODO: copy implementation from Helper::get_image_media_link

[257] Fix | Delete

return '';

[258] Fix | Delete

}

[259] Fix | Delete

[260] Fix | Delete

/**

[261] Fix | Delete

* File dir relative to the uploads directory e.g. 2023/05/. Includes trailing slash.

[262] Fix | Delete

* @return string

[263] Fix | Delete

[264] Fix | Delete

public function get_relative_file_dir() {

[265] Fix | Delete

$relative_file_dir = dirname( $this->get_relative_file_path() );

[266] Fix | Delete

if ( '.' === $relative_file_dir ) {

[267] Fix | Delete

return '';

[268] Fix | Delete

}

[269] Fix | Delete

return trailingslashit( $relative_file_dir );

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

/**

[273] Fix | Delete

* The relative file path e.g. 2023/05/image.png

[274] Fix | Delete

[275] Fix | Delete

* @return string

[276] Fix | Delete

[277] Fix | Delete

public function get_relative_file_path() {

[278] Fix | Delete

if ( is_null( $this->file ) ) {

[279] Fix | Delete

$this->file = $this->prepare_relative_file_path();

[280] Fix | Delete

}

[281] Fix | Delete

[282] Fix | Delete

return $this->file;

[283] Fix | Delete

}

[284] Fix | Delete

[285] Fix | Delete

private function prepare_relative_file_path() {

[286] Fix | Delete

$file = (string) $this->get_array_value( $this->get_wp_metadata(), 'file' );

[287] Fix | Delete

[288] Fix | Delete

if ( empty( $file ) ) {

[289] Fix | Delete

/**

[290] Fix | Delete

* If metadata is missing we still want some of our functions to work, e.g. backup and restore

[291] Fix | Delete

[292] Fix | Delete

* Using _wp_attached_file meta because:

[293] Fix | Delete

* 1. get_attached_file returns the full path but the _wp_attached_file meta has the relative path we need

[294] Fix | Delete

* 2. get_attached_file is filtered which can interfere with our code e.g. the S3 module changes attached file, but we don't want that

[295] Fix | Delete

[296] Fix | Delete

$file = $this->get_post_meta( '_wp_attached_file' );

[297] Fix | Delete

}

[298] Fix | Delete

[299] Fix | Delete

return $file;

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

private function get_post_meta( $key ) {

[303] Fix | Delete

return get_post_meta( $this->get_id(), $key, true );

[304] Fix | Delete

}

[305] Fix | Delete

[306] Fix | Delete

public function has_size( $key ) {

[307] Fix | Delete

$sizes = $this->get_sizes();

[308] Fix | Delete

[309] Fix | Delete

return ! empty( $sizes[ $key ] );

[310] Fix | Delete

}

[311] Fix | Delete

[312] Fix | Delete

public function has_scaled_size() {

[313] Fix | Delete

return $this->has_size( self::SIZE_KEY_SCALED );

[314] Fix | Delete

}

[315] Fix | Delete

[316] Fix | Delete

public function has_full_size() {

[317] Fix | Delete

return $this->has_size( self::SIZE_KEY_FULL );

[318] Fix | Delete

}

[319] Fix | Delete

[320] Fix | Delete

/**

[321] Fix | Delete

* @param $key

[322] Fix | Delete

[323] Fix | Delete

* @return Media_Item_Size

[324] Fix | Delete

[325] Fix | Delete

public function get_size( $key ) {

[326] Fix | Delete

return $this->get_array_value( $this->get_sizes(), $key );

[327] Fix | Delete

}

[328] Fix | Delete

[329] Fix | Delete

public function get_scaled_size() {

[330] Fix | Delete

return $this->get_size( self::SIZE_KEY_SCALED );

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

public function get_full_size() {

[334] Fix | Delete

return $this->get_size( self::SIZE_KEY_FULL );

[335] Fix | Delete

}

[336] Fix | Delete

[337] Fix | Delete

public function get_sizes() {

[338] Fix | Delete

if ( is_null( $this->sizes ) ) {

[339] Fix | Delete

$this->sizes = $this->prepare_sizes();

[340] Fix | Delete

}

[341] Fix | Delete

[342] Fix | Delete

return $this->sizes;

[343] Fix | Delete

}

[344] Fix | Delete

[345] Fix | Delete

/**

[346] Fix | Delete

* The 'main' size is the size has get_attached_file as the file path

[347] Fix | Delete

[348] Fix | Delete

* @return Media_Item_Size

[349] Fix | Delete

[350] Fix | Delete

public function get_main_size() {

[351] Fix | Delete

return $this->get_scaled_or_full_size();

[352] Fix | Delete

}

[353] Fix | Delete

[354] Fix | Delete

private function prepare_sizes() {

[355] Fix | Delete

$media_item_sizes = array();

[356] Fix | Delete

[357] Fix | Delete

$metadata_sizes = $this->get_wp_metadata_sizes();

[358] Fix | Delete

foreach ( $metadata_sizes as $size_key => $metadata_size ) {

[359] Fix | Delete

$registered_size = $this->array_utils->ensure_array( $this->get_registered_wp_size( $size_key ) );

[360] Fix | Delete

$metadata_size = $this->array_utils->ensure_array( $metadata_size );

[361] Fix | Delete

$size = $this->initialize_size( $size_key, array_merge( $registered_size, $metadata_size ) );

[362] Fix | Delete

[363] Fix | Delete

if ( $size ) {

[364] Fix | Delete

$media_item_sizes[ $size_key ] = $size;

[365] Fix | Delete

}

[366] Fix | Delete

}

[367] Fix | Delete

[368] Fix | Delete

$scaled_size = $this->prepare_scaled_size();

[369] Fix | Delete

if ( $scaled_size ) {

[370] Fix | Delete

$media_item_sizes[ self::SIZE_KEY_SCALED ] = $scaled_size;

[371] Fix | Delete

}

[372] Fix | Delete

[373] Fix | Delete

$full_size = $this->prepare_full_size();

[374] Fix | Delete

if ( $full_size ) {

[375] Fix | Delete

$media_item_sizes[ self::SIZE_KEY_FULL ] = $full_size;

[376] Fix | Delete

}

[377] Fix | Delete

[378] Fix | Delete

return $media_item_sizes;

[379] Fix | Delete

}

[380] Fix | Delete

[381] Fix | Delete

public function prepare_scaled_size() {

[382] Fix | Delete

$file = $this->get_attached_file();

[383] Fix | Delete

if ( $file && $this->separate_original_image_path_exists() ) {

[384] Fix | Delete

$wp_size_metadata = $this->attachment_metadata_as_size_metadata( $file );

[385] Fix | Delete

[386] Fix | Delete

return $this->initialize_size( self::SIZE_KEY_SCALED, $wp_size_metadata );

[387] Fix | Delete

}

[388] Fix | Delete

[389] Fix | Delete

return null;

[390] Fix | Delete

}

[391] Fix | Delete

[392] Fix | Delete

private function separate_original_image_path_exists() {

[393] Fix | Delete

$original_image = $this->get_original_image_path();

[394] Fix | Delete

$main_file = $this->get_attached_file();

[395] Fix | Delete

[396] Fix | Delete

return $original_image !== $main_file;

[397] Fix | Delete

}

[398] Fix | Delete

[399] Fix | Delete

public function prepare_full_size() {

[400] Fix | Delete

$original_image_exists = $this->separate_original_image_path_exists();

[401] Fix | Delete

[402] Fix | Delete

if ( $original_image_exists ) {

[403] Fix | Delete

$original_image_file = $this->get_original_image_path();

[404] Fix | Delete

$image_size = $this->fs->file_exists( $original_image_file ) ?

[405] Fix | Delete

$this->fs->getimagesize( $original_image_file ) : false;

[406] Fix | Delete

if ( ! $image_size ) {

[407] Fix | Delete

return null;

[408] Fix | Delete

}

[409] Fix | Delete

[410] Fix | Delete

return $this->initialize_size( self::SIZE_KEY_FULL, array(

[411] Fix | Delete

'file' => $this->file_name_from_path( $original_image_file ),

[412] Fix | Delete

'width' => $image_size[0],

[413] Fix | Delete

'height' => $image_size[1],

[414] Fix | Delete

'mime-type' => $this->get_mime_type(),

[415] Fix | Delete

'filesize' => $this->fs->filesize( $original_image_file ),

[416] Fix | Delete

) );

[417] Fix | Delete

} else {

[418] Fix | Delete

$main_file = $this->get_attached_file();

[419] Fix | Delete

$wp_size_metadata = $this->attachment_metadata_as_size_metadata( $main_file );

[420] Fix | Delete

[421] Fix | Delete

return $this->initialize_size( self::SIZE_KEY_FULL, $wp_size_metadata );

[422] Fix | Delete

}

[423] Fix | Delete

}

[424] Fix | Delete

[425] Fix | Delete

public function has_smushable_sizes() {

[426] Fix | Delete

return ! empty( $this->get_smushable_sizes() );

[427] Fix | Delete

}

[428] Fix | Delete

[429] Fix | Delete

/**

[430] Fix | Delete

* @return Media_Item_Size[]

[431] Fix | Delete

[432] Fix | Delete

public function get_smushable_sizes() {

[433] Fix | Delete

if ( is_null( $this->smushable_sizes ) ) {

[434] Fix | Delete

$this->smushable_sizes = $this->prepare_smushable_sizes();

[435] Fix | Delete

}

[436] Fix | Delete

[437] Fix | Delete

return $this->smushable_sizes;

[438] Fix | Delete

}

[439] Fix | Delete

[440] Fix | Delete

private function prepare_smushable_sizes() {

[441] Fix | Delete

$sizes = array();

[442] Fix | Delete

foreach ( $this->get_sizes() as $size_key => $size ) {

[443] Fix | Delete

if ( $size->is_smushable() ) {

[444] Fix | Delete

$sizes[ $size_key ] = $size;

[445] Fix | Delete

}

[446] Fix | Delete

}

[447] Fix | Delete

[448] Fix | Delete

return $sizes;

[449] Fix | Delete

}

[450] Fix | Delete

[451] Fix | Delete

private function get_array_value( $array, $key ) {

[452] Fix | Delete

return $array && isset( $array[ $key ] )

[453] Fix | Delete

? $array[ $key ]

[454] Fix | Delete

: null;

[455] Fix | Delete

}

[456] Fix | Delete

[457] Fix | Delete

/**

[458] Fix | Delete

* @return array|mixed

[459] Fix | Delete

[460] Fix | Delete

private function get_wp_metadata_sizes() {

[461] Fix | Delete

// TODO: media items created before a certain WP version might not have the scaled size so that needs to be normalized for all wp versions

[462] Fix | Delete

$metadata = $this->get_wp_metadata();

[463] Fix | Delete

[464] Fix | Delete

return empty( $metadata['sizes'] )

[465] Fix | Delete

? array()

[466] Fix | Delete

: $metadata['sizes'];

[467] Fix | Delete

}

[468] Fix | Delete

[469] Fix | Delete

private function get_wp_metadata_size( $size_key ) {

[470] Fix | Delete

$metadata = $this->get_wp_metadata_sizes();

[471] Fix | Delete

[472] Fix | Delete

return empty( $metadata[ $size_key ] )

[473] Fix | Delete

? array()

[474] Fix | Delete

: $metadata[ $size_key ];

[475] Fix | Delete

}

[476] Fix | Delete

[477] Fix | Delete

public function is_skipped() {

[478] Fix | Delete

return $this->is_ignored() ||

[479] Fix | Delete

$this->is_animated();

[480] Fix | Delete

}

[481] Fix | Delete

[482] Fix | Delete

public function is_mime_type_supported() {

[483] Fix | Delete

if ( is_null( $this->mime_type_supported ) ) {

[484] Fix | Delete

$this->mime_type_supported = $this->check_is_mime_type_supported();

[485] Fix | Delete

}

[486] Fix | Delete

[487] Fix | Delete

return $this->mime_type_supported;

[488] Fix | Delete

}

[489] Fix | Delete

[490] Fix | Delete

private function check_is_mime_type_supported() {

[491] Fix | Delete

$mime_type = $this->get_mime_type();

[492] Fix | Delete

$supported = in_array( $mime_type, $this->get_supported_mime_types(), true );

[493] Fix | Delete

[494] Fix | Delete

return apply_filters( 'wp_smush_resmush_mime_supported', $supported, $mime_type );

[495] Fix | Delete

}

[496] Fix | Delete

[497] Fix | Delete

public function is_image() {

[498] Fix | Delete

if ( is_null( $this->is_image ) ) {

[499] Fix | Delete

12 3