ate Super Smush count. if ( isset( $stats['stats']['lossy'] ) && 1 == $stats['stats']['lossy'] ) { if ( empty( $key ) ) { update_post_meta( $id, 'wp-smush-lossy', 1 ); } else { $this->update_super_smush_count( $id, 'add', $key ); } } // Check and update re-smush list for media gallery. if ( ! empty( $this->resmush_ids ) && in_array( $id, $this->resmush_ids ) ) { $this->update_resmush_list( $id ); } } /** * Remove the given attachment id from resmush list and updates it to db * * @param string $attachment_id Attachment ID. * @param string $mkey Option key. */ public function update_resmush_list( $attachment_id, $mkey = 'wp-smush-resmush-list' ) { $resmush_list = get_option( $mkey ); // If there are any items in the resmush list, Unset the Key. if ( ! empty( $resmush_list ) && count( $resmush_list ) > 0 ) { $key = array_search( $attachment_id, $resmush_list ); if ( $resmush_list ) { unset( $resmush_list[ $key ] ); } $resmush_list = array_values( $resmush_list ); } // If Resmush List is empty. if ( empty( $resmush_list ) || 0 === count( $resmush_list ) ) { // Delete resmush list. delete_option( $mkey ); } else { update_option( $mkey, $resmush_list, false ); } } /** * Remove the Update info. * * @param bool $remove_notice Remove notice. */ public function dismiss_update_info( $remove_notice = false ) { // From URL arg. if ( isset( $_GET['dismiss_smush_update_info'] ) && 1 == $_GET['dismiss_smush_update_info'] ) { $remove_notice = true; } // From Ajax. if ( ! empty( $_REQUEST['action'] ) && 'dismiss_update_info' === $_REQUEST['action'] ) { $remove_notice = true; } // Update Db. if ( $remove_notice ) { update_site_option( 'wp-smush-hide_update_info', 1 ); } } /** * Check whether to skip a specific image size or not * * @param string $size Registered image size. * * @return bool true/false Whether to skip the image size or not */ public function skip_image_size( $size = '' ) { // No image size specified, Don't skip. if ( empty( $size ) ) { return false; } $image_sizes = $this->settings->get_setting( WP_SMUSH_PREFIX . 'image_sizes' ); // If Images sizes aren't set, don't skip any of the image size. if ( false === $image_sizes ) { return false; } // Check if the size is in the smush list. return is_array( $image_sizes ) && ! in_array( $size, $image_sizes ); } /** * Process an image with Smush. * * @since 3.8.0 Added new param $convert_to_webp. * * @param string $file_path Absolute path to the image. * @param bool $convert_to_webp Convert the image to webp. * * @return array|bool|WP_Error */ public function do_smushit( $file_path = '', $convert_to_webp = false ) { $errors = new WP_Error(); $dir_name = trailingslashit( dirname( $file_path ) ); // Check if file exists and the directory is writable. if ( empty( $file_path ) ) { $errors->add( 'empty_path', __( 'File path is empty', 'wp-smushit' ) ); } elseif ( ! file_exists( $file_path ) || ! is_file( $file_path ) ) { // Check that the file exists. /* translators: %s: file path */ $errors->add( 'file_not_found', sprintf( __( 'Could not find %s', 'wp-smushit' ), $file_path ) ); } elseif ( ! is_writable( $dir_name ) ) { // Check that the file is writable. /* translators: %s: directory name */ $errors->add( 'not_writable', sprintf( __( '%s is not writable', 'wp-smushit' ), $dir_name ) ); } $file_size = file_exists( $file_path ) ? filesize( $file_path ) : ''; // Check if premium user. $max_size = WP_Smush::is_pro() ? WP_SMUSH_PREMIUM_MAX_BYTES : WP_SMUSH_MAX_BYTES; // Check if file exists. if ( 0 === (int) $file_size ) { /* translators: %1$s: image size, %2$s: image name */ $errors->add( 'image_not_found', sprintf( __( 'Skipped (%1$s), image not found', 'wp-smushit' ), size_format( $file_size, 1 ) ) ); } elseif ( $file_size > $max_size ) { // Check size limit. /* translators: %1$s: image size, %2$s: image name */ $errors->add( 'size_limit', sprintf( __( 'Skipped (%1$s), size limit exceeded', 'wp-smushit' ), size_format( $file_size, 1 ) ) ); } if ( count( $errors->get_error_messages() ) ) { return $errors; } // Save original file permissions. clearstatcache(); $perms = fileperms( $file_path ) & 0777; /** Send image for smushing, and fetch the response */ $response = $this->_post( $file_path, $file_size, $convert_to_webp ); if ( ! $response['success'] ) { $errors->add( 'false_response', $response['message'] ); } elseif ( empty( $response['data'] ) ) { // If there is no data. $errors->add( 'no_data', __( 'Unknown API error', 'wp-smushit' ) ); } if ( count( $errors->get_error_messages() ) ) { return $errors; } // If there are no savings, or image returned is bigger in size. if ( ( ! empty( $response['data']->bytes_saved ) && (int) $response['data']->bytes_saved ) <= 0 || empty( $response['data']->image ) ) { return $response; } if ( $convert_to_webp ) { $webp = WP_Smush::get_instance()->core()->mod->webp; $webp_file = $webp->get_webp_file_path( $file_path, true ); // Add a new file as webp. file_put_contents( $webp_file, $response['data']->image ); } else { $tempfile = $file_path . '.tmp'; // Add the file as tmp. file_put_contents( $tempfile, $response['data']->image ); // Replace the file. $success = @rename( $tempfile, $file_path ); // If tempfile still exists, unlink it. if ( file_exists( $tempfile ) ) { @unlink( $tempfile ); } // If file renaming failed. if ( ! $success ) { @copy( $tempfile, $file_path ); @unlink( $tempfile ); } } // Some servers are having issue with file permission, this should fix it. if ( empty( $perms ) || ! $perms ) { // Source: WordPress Core. $stat = stat( dirname( $file_path ) ); $perms = $stat['mode'] & 0000666; // Same permissions as parent folder, strip off the executable bits. } if ( $convert_to_webp ) { @chmod( $webp_file, $perms ); } else { @chmod( $file_path, $perms ); } return $response; } /** * Posts an image to Smush. * * @since 3.8.0 Added new param $convert_to_webp. * * @param string $file_path Path of file to send to Smush. * @param int $file_size File size. * @param bool $convert_to_webp Convert the image to webp. * * @return bool|array array containing success status, and stats */ private function _post( $file_path, $file_size, $convert_to_webp = false ) { $headers = array( 'accept' => 'application/json', // The API returns JSON. 'content-type' => 'application/binary', // Set content type to binary. 'lossy' => WP_Smush::is_pro() && $this->settings->get( 'lossy' ) ? 'true' : 'false', 'exif' => $this->settings->get( 'strip_exif' ) ? 'false' : 'true', ); if ( $convert_to_webp ) { $headers['webp'] = 'true'; } // Check if premium member, add API key. $api_key = Helper::get_wpmudev_apikey(); if ( ! empty( $api_key ) && WP_Smush::is_pro() ) { $headers['apikey'] = $api_key; } $api_url = defined( 'WP_SMUSH_API_HTTP' ) ? WP_SMUSH_API_HTTP : WP_SMUSH_API; $args = array( 'headers' => $headers, 'body' => file_get_contents( $file_path ), 'timeout' => WP_SMUSH_TIMEOUT, 'user-agent' => WP_SMUSH_UA, ); // Temporary increase the limit. wp_raise_memory_limit( 'image' ); $result = wp_remote_post( $api_url, $args ); unset( $args ); // Free memory. if ( is_wp_error( $result ) ) { $er_msg = $result->get_error_message(); // Hostgator Issue. if ( ! empty( $er_msg ) && strpos( $er_msg, 'SSL CA cert' ) !== false ) { // Update DB for using http protocol. $this->settings->set_setting( WP_SMUSH_PREFIX . 'use_http', 1 ); } // Check for timeout error and suggest to filter timeout. if ( strpos( $er_msg, 'timed out' ) ) { $data['message'] = esc_html__( "Skipped due to a timeout error. You can increase the request timeout to make sure Smush has enough time to process larger files. define('WP_SMUSH_TIMEOUT', 150);", 'wp-smushit' ); } else { // Handle error. /* translators: %s error message */ $data['message'] = sprintf( __( 'Error posting to API: %s', 'wp-smushit' ), $result->get_error_message() ); } $data['success'] = false; unset( $result ); // Free memory. return $data; } elseif ( 200 !== wp_remote_retrieve_response_code( $result ) ) { // Handle error. /* translators: %1$s: respnse code, %2$s error message */ $data['message'] = sprintf( __( 'Error posting to API: %1$s %2$s', 'wp-smushit' ), wp_remote_retrieve_response_code( $result ), wp_remote_retrieve_response_message( $result ) ); $data['success'] = false; unset( $result ); // Free memory. return $data; } // If there is a response and image was successfully optimised. $response = json_decode( $result['body'] ); if ( $response && true === $response->success ) { // If there is any savings. if ( $response->data->bytes_saved > 0 ) { // base64_decode is necessary to send binary img over JSON, no security problems here! $image = base64_decode( $response->data->image ); $image_md5 = md5( $response->data->image ); if ( $response->data->image_md5 !== $image_md5 ) { // Handle error. $data['message'] = __( 'Smush data corrupted, try again.', 'wp-smushit' ); $data['success'] = false; } else { $data['success'] = true; $data['data'] = $response->data; $data['data']->image = $image; } unset( $image );// Free memory. } else { // Just return the data. $data['success'] = true; $data['data'] = $response->data; } // Check for API message and store in db. if ( isset( $response->data->api_message ) && ! empty( $response->data->api_message ) ) { $this->add_api_message( $response->data->api_message ); } // If is_premium is set in response, send it over to check for member validity. if ( ! empty( $response->data ) && isset( $response->data->is_premium ) ) { $this->api_headers['is_premium'] = $response->data->is_premium; } } else { // Server side error, get message from response. $data['message'] = ! empty( $response->data ) ? $response->data : __( "Image couldn't be smushed", 'wp-smushit' ); $data['success'] = false; } // Free memory and return data. unset( $result ); unset( $response ); return $data; } /** * Replace the old API message with the latest one if it doesn't exists already * * @param array $api_message API message. */ private function add_api_message( $api_message = array() ) { if ( empty( $api_message ) || ! count( $api_message ) || empty( $api_message['timestamp'] ) || empty( $api_message['message'] ) ) { return; } $o_api_message = get_site_option( WP_SMUSH_PREFIX . 'api_message', array() ); if ( array_key_exists( $api_message['timestamp'], $o_api_message ) ) { return; } $api_message['status'] = 'show'; $message = array(); $message[ $api_message['timestamp'] ] = array( 'message' => sanitize_text_field( $api_message['message'] ), 'type' => sanitize_text_field( $api_message['type'] ), 'status' => 'show', ); update_site_option( WP_SMUSH_PREFIX . 'api_message', $message ); } /** * Fills $placeholder array with values from $data array * * @param array $placeholders Placeholders array. * @param array $data Data to fill with. * * @return array */ public function array_fill_placeholders( array $placeholders, array $data ) { $placeholders['percent'] = $data['compression']; $placeholders['bytes'] = $data['bytes_saved']; $placeholders['size_before'] = $data['before_size']; $placeholders['size_after'] = $data['after_size']; $placeholders['time'] = $data['time']; return $placeholders; } /** * Returns signature for single size of the smush api message to be saved to db; * * @return array */ public function get_size_signature() { return array( 'percent' => 0, 'bytes' => 0, 'size_before' => 0, 'size_after' => 0, 'time' => 0, ); } /** * Optimises the image sizes * * Note: Function name is bit confusing, it is for optimisation, and calls the resizing function as well * * Read the image paths from an attachment's metadata and process each image * with wp_smushit(). * * @param array $meta Image metadata. * @param null|int $id Image ID. * * @return mixed */ public function resize_from_meta_data( $meta, $id = null ) { // Flag to check, if original size image should be smushed or not. $original = $this->settings->get( 'original' ); $smush_full = WP_Smush::is_pro() && true === $original; $errors = new WP_Error(); $stats = array( 'stats' => array_merge( $this->get_size_signature(), array( 'api_version' => - 1, 'lossy' => - 1, 'keep_exif' => false, ) ), 'sizes' => array(), ); if ( $id && false === wp_attachment_is_image( $id ) ) { return $meta; } // Set attachment id and media type. $this->attachment_id = $id; $this->media_type = 'wp'; // File path and URL for original image. $attachment_file_path = Helper::get_attached_file( $id ); // Set a flag if any image got error during webp conversion. $webp_has_error = false; $should_convert_to_webp = WP_Smush::get_instance()->core()->mod->webp->should_be_converted( $id ); // Keep all new webp image path in this list. $webp_files = array(); // If images has other registered size, smush them first. if ( ! empty( $meta['sizes'] ) && ! has_filter( 'wp_image_editors', 'photon_subsizes_override_image_editors' ) ) { foreach ( $meta['sizes'] as $size_key => $size_data ) { // Check if registered size is supposed to be Smushed or not. if ( 'full' !== $size_key && $this->skip_image_size( $size_key ) ) { continue; } // We take the original image. The 'sizes' will all match the same URL and // path. So just get the dirname and replace the filename. $attachment_file_path_size = path_join( dirname( $attachment_file_path ), $size_data['file'] ); /** * Allows S3 to hook over here and check if the given file path exists else download the file. */ do_action( 'smush_file_exists', $attachment_file_path_size, $id, $size_data ); $ext = Helper::get_mime_type( $attachment_file_path_size ); if ( $ext ) { $valid_mime = array_search( $ext, array( 'jpg' => 'image/jpeg', 'png' => 'image/png', 'gif' => 'image/gif', ), true ); if ( false === $valid_mime ) { continue; } } /** * Allows to skip a image from smushing. * * @param bool , Smush image or not * @$size string, Size of image being smushed */ if ( ! apply_filters( 'wp_smush_media_image', true, $size_key ) ) { continue; } /** * Convert to WebP * * @since 3.8.0 */ if ( $should_convert_to_webp ) { $webp_response = WP_Smush::get_instance()->core()->mod->smush->do_smushit( $attachment_file_path_size, true ); if ( is_wp_error( $webp_response ) || ! $webp_response ) { $webp_has_error = true; } else { $webp_files[] = WP_Smush::get_instance()->core()->mod->webp->get_webp_file_path( $attachment_file_path_size ); } } // Store details for each size key. $response = $this->do_smushit( $attachment_file_path_size ); if ( is_wp_error( $response ) ) { /** * If webp is active and some images have been converted to webp already * delete those new webp files. * * @since 3.8.0 */ if ( $should_convert_to_webp && 0 < count( $webp_files ) ) { foreach ( $webp_files as $webp_file ) { if ( file_exists( $webp_file ) ) { unlink( $webp_file ); } } } return $response; } // If there are no stats. if ( empty( $response['data'] ) ) { continue; } // If the image size grew after smushing, skip it. if ( $response['data']->after_size > $response['data']->before_size ) { continue; } // All Clear, Store the stat. // TODO: Move the existing stats code over here, we don't need to do the stats part twice. $stats['sizes'][ $size_key ] = (object) $this->array_fill_placeholders( $this->get_size_signature(), (array) $response['data'] ); if ( empty( $stats['stats']['api_version'] ) || $stats['stats']['api_version'] == - 1 ) { $stats['stats']['api_version'] = $response['data']->api_version; $stats['stats']['lossy'] = $response['data']->lossy; $stats['stats']['keep_exif'] = ! empty( $response['data']->keep_exif ) ? $response['data']->keep_exif : 0; } } } elseif ( ! has_filter( 'wp_image_editors', 'photon_subsizes_override_image_editors' ) ) { $smush_full = true; } /** * Allows to skip a image from smushing * * @param bool , Smush image or not * @$size string, Size of image being smushed */ $smush_full_image = apply_filters( 'wp_smush_media_image', true, 'full' ); // Whether to update the image stats or not. $store_stats = true; /** * Convert to WebP * * @since 3.8.0 */ if ( $should_convert_to_webp && false === $webp_has_error ) { $webp_response = WP_Smush::get_instance()->core()->mod->smush->do_smushit( $attachment_file_path, true ); if ( is_wp_error( $webp_response ) || ! $webp_response ) { $webp_has_error = true; } else { $webp_files[] = WP_Smush::get_instance()->core()->mod->webp->get_webp_file_path( $attachment_file_path ); } } // If original size is supposed to be smushed. if ( $smush_full && $smush_full_image ) { $full_image_response = $this->do_smushit( $attachment_file_path ); if ( is_wp_error( $full_image_response ) ) { /** * If webp is active and some images have been converted to webp already * delete those new webp files. * * @since 3.8.0 */ if ( $should_convert_to_webp && 0 < count( $webp_files ) ) { foreach ( $webp_files as $webp_file ) { if ( file_exists( $webp_file ) ) { unlink( $webp_file ); } } } return $full_image_response; } // If there are no stats. if ( empty( $full_image_response['data'] ) ) { $store_stats = false; } // If the image size grew after smushing, skip it. if ( $full_image_response['data']->after_size > $full_image_response['data']->before_size ) { $store_stats = false; } if ( $store_stats ) { $stats['sizes']['full'] = (object) $this->array_fill_placeholders( $this->get_size_signature(), (array) $full_image_response['data'] ); } // Api version and lossy, for some images, full image i skipped and for other images only full exists // so have to add code again. if ( empty( $stats['stats']['api_version'] ) || $stats['stats']['api_version'] == - 1 ) { $stats['stats']['api_version'] = $full_image_response['data']->api_version; $stats['stats']['lossy'] = $full_image_response['data']->lossy; $stats['stats']['keep_exif'] = ! empty( $full_image_response['data']->keep_exif ) ? $full_image_response['data']->keep_exif : 0; } } $has_errors = (bool) count( $errors->get_error_messages() ); // Set smush status for all the images, store it in wp-smpro-smush-data. if ( ! $has_errors ) { $existing_stats = get_post_meta( $id, self::$smushed_meta_key, true ); if ( ! empty( $existing_stats ) ) { // Update stats for each size. if ( isset( $existing_stats['sizes'] ) && ! empty( $stats['sizes'] ) ) { foreach ( $existing_stats['sizes'] as $size_name => $size_stats ) { // If stats for a particular size doesn't exists. if ( empty( $stats['sizes'][ $size_name ] ) ) { $stats['sizes'][ $size_name ] = $existing_stats['sizes'][ $size_name ]; } else { $existing_stats_size = (object) $existing_stats['sizes'][ $size_name ]; // Store the original image size. $stats['sizes'][ $size_name ]->size_before = ( ! empty( $existing_stats_size->size_before ) && $existing_stats_size->size_before > $stats['sizes'][ $size_name ]->size_before ) ? $existing_stats_size->size_before : $stats['sizes'][ $size_name ]->size_before; // Update compression percent and bytes saved for each size. $stats['sizes'][ $size_name ]->bytes = $stats['sizes'][ $size_name ]->bytes + $existing_stats_size->bytes; $stats['sizes'][ $size_name ]->percent = $this->calculate_percentage( $stats['sizes'][ $size_name ], $existing_stats_size ); } } } } // Sum Up all the stats. $stats = WP_Smush::get_instance()->core()->total_compression( $stats ); // If there was any compression and there was no error in smushing. if ( isset( $stats['stats']['bytes'] ) && $stats['stats']['bytes'] >= 0 && ! $has_errors ) { /** * Runs if the image smushing was successful * * @param int $id Image Id * * @param array $stats Smush Stats for the image * * @param array $meta Attachment meta. */ do_action( 'wp_smush_image_optimised', $id, $stats, $meta ); } /** * If webp is active and all images have been converted to webp set a flag to meta. * * @since 3.8.0 */ if ( $should_convert_to_webp && false === $webp_has_error ) { $udir = WP_Smush::get_instance()->core()->mod->webp->get_upload_dir(); // Use the relative path of the first webp image as a flag. $stats['webp_flag'] = substr( $webp_files[0], strlen( $udir['webp_path'] . '/' ) ); } update_post_meta( $id, self::$smushed_meta_key, $stats ); } else { /** * If webp is active and some images have been converted to webp already delete those new webp files. * * @since 3.8.0 */ if ( $should_convert_to_webp && 0 < count( $webp_files ) ) { foreach ( $webp_files as $webp_file ) { unlink( $webp_file ); } } } unset( $stats ); // Unset response. if ( ! empty( $response ) ) { unset( $response ); } return $meta; } /** * Calculate saving percentage from existing and current stats * * @param object|string $stats Stats object. * @param object|string $existing_stats Existing stats object. * * @return float */ public function calculate_percentage( $stats = '', $existing_stats = '' ) { if ( empty( $stats ) || empty( $existing_stats ) ) { return 0; } $size_before = ! empty( $stats->size_before ) ? $stats->size_before : $existing_stats->size_before; $size_after = ! empty( $stats->size_after ) ? $stats->size_after : $existing_stats->size_after; $savings = $size_before - $size_after; if ( $savings > 0 ) { $percentage = ( $savings / $size_before ) * 100; $percentage = $percentage > 0 ? round( $percentage, 2 ) : $percentage; return $percentage; } return 0; } /** * Read the image paths from an attachment's metadata and process each image with wp_smushit(). * * @uses resize_from_meta_data * * @param array $meta Attachment metadata. * @param int $id Attachment ID. * * @return mixed */ public function smush_image( $meta, $id ) { // We need to check if this call originated from Gutenberg and allow only media. if ( ! empty( $GLOBALS['wp']->query_vars['rest_route'] ) ) { $route = untrailingslashit( $GLOBALS['wp']->query_vars['rest_route'] ); // Only allow media routes. if ( empty( $route ) || '/wp/v2/media' !== $route ) { // If not - return image metadata. return $meta; } } $upload_attachment = filter_input( INPUT_POST, 'action', FILTER_SANITIZE_STRING ); $is_upload_attachment = 'upload-attachment' === $upload_attachment || isset( $_POST['post_id'] ); // Our async task runs when action is upload-attachment and post_id found. So do not run on these conditions. if ( $is_upload_attachment && defined( 'WP_SMUSH_ASYNC' ) && WP_SMUSH_ASYNC ) { return $meta; } // Return directly if not a image. if ( ! wp_attachment_is_image( $id ) ) { return $meta; } // Check if we're restoring the image Or already smushing the image. if ( get_option( "wp-smush-restore-$id", false ) || get_option( "smush-in-progress-$id", false ) ) { return $meta; } /** * Filter: wp_smush_image * * Whether to smush the given attachment id or not * * @param bool $skip Bool, whether to Smush image or not. * @param int $ID Attachment Id, Attachment id of the image being processed. */ if ( ! apply_filters( 'wp_smush_image', true, $id ) ) { return $meta; } // Set a transient to avoid multiple request. update_option( 'smush-in-progress-' . $id, true ); // While uploading from Mobile App or other sources, admin_init action may not fire. // So we need to manually initialize those. WP_Smush::get_instance()->core()->mod->resize->initialize( true ); // Check if auto is enabled. $auto_smush = $this->is_auto_smush_enabled(); // Allow downloading the file from S3 all throughout the process. do_action( 'smush_s3_integration_fetch_file' ); // Get the file path for backup. $attachment_file_path = get_attached_file( $id ); Helper::check_animated_status( $attachment_file_path, $id ); // Take backup. WP_Smush::get_instance()->core()->mod->backup->create_backup( $attachment_file_path, $id ); // Optionally resize images. $meta = WP_Smush::get_instance()->core()->mod->resize->auto_resize( $id, $meta ); // Auto Smush the new image. if ( $auto_smush ) { // Optionally convert PNGs to JPG. $meta = WP_Smush::get_instance()->core()->mod->png2jpg->png_to_jpg( $id, $meta ); /** * Fix for Hostgator. * Check for use of http url (Hostgator mostly). */ $use_http = wp_cache_get( WP_SMUSH_PREFIX . 'use_http', 'smush' ); if ( ! $use_http ) { $use_http = $this->settings->get_setting( WP_SMUSH_PREFIX . 'use_http', false ); wp_cache_add( WP_SMUSH_PREFIX . 'use_http', $use_http, 'smush' ); } if ( $use_http ) { define( 'WP_SMUSH_API_HTTP', 'http://smushpro.wpmudev.org/1.0/' ); } $this->resize_from_meta_data( $meta, $id ); } else { // Remove the smush metadata. delete_post_meta( $id, self::$smushed_meta_key ); } // Delete transient. delete_option( 'smush-in-progress-' . $id ); return $meta; } /** * Smush single images * * @param int $attachment_id Attachment ID. * @param bool $return Return/echo the stats. * * @return array|string */ public function smush_single( $attachment_id, $return = false ) { // If the smushing option is already set, return the status. if ( get_option( "smush-in-progress-{$attachment_id}", false ) || get_option( "wp-smush-restore-{$attachment_id}", false ) ) { // Get the button status. $status = WP_Smush::get_instance()->library()->generate_markup( $attachment_id ); if ( $return ) { return $status; } wp_send_json_success( $status ); } // Set a transient to avoid multiple request. update_option( "smush-in-progress-{$attachment_id}", true ); $attachment_id = absint( (int) $attachment_id ); // Allow downloading the file from S3 all throughout the process. do_action( 'smush_s3_integration_fetch_file' ); // Get the file path for backup. $attachment_file_path = get_attached_file( $attachment_id ); Helper::check_animated_status( $attachment_file_path, $attachment_id ); // Take backup. WP_Smush::get_instance()->core()->mod->backup->create_backup( $attachment_file_path, $attachment_id ); // Get the image metadata from $_POST. $original_meta = ! empty( $_POST['metadata'] ) ? Helper::format_meta_from_post( $_POST['metadata'] ) : ''; $original_meta = empty( $original_meta ) ? wp_get_attachment_metadata( $attachment_id ) : $original_meta; // Send image for resizing, if enabled resize first before any other operation. $updated_meta = $this->resize_image( $attachment_id, $original_meta ); // Convert PNGs to JPG. $updated_meta = WP_Smush::get_instance()->core()->mod->png2jpg->png_to_jpg( $attachment_id, $updated_meta ); $original_meta = ! empty( $updated_meta ) ? $updated_meta : $original_meta; // Smush the image. $smush = $this->resize_from_meta_data( $original_meta, $attachment_id ); /** * When S3 integration is enabled, the wp_update_attachment_metadata below will trigger the * wp_update_attachment_metadata filter WP Offload Media, which in turn will try to re-upload all the files * to an S3 bucket. But, if some sizes are skipped during Smushing, WP Offload Media will print error * messages to debug.log. This will help avoid that. * * @since 3.0 */ add_filter( 'as3cf_attachment_file_paths', array( $this, 'remove_sizes_from_s3_upload' ), 10, 3 ); // Update the details, after smushing, so that latest image is used in hook. wp_update_attachment_metadata( $attachment_id, $original_meta ); // Delete the transient after attachment meta is updated. delete_option( 'smush-in-progress-' . $attachment_id ); // Get the button status. $status = WP_Smush::get_instance()->library()->generate_markup( $attachment_id ); // Send Json response if we are not suppose to return the results. if ( is_wp_error( $smush ) ) { if ( $return ) { return array( 'error' => $smush->get_error_message() ); } wp_send_json_error( array( 'error_msg' => '

' . Helper::filter_error( $smush->get_error_message(), $attachment_id ) . '

', 'show_warning' => (int) $this->show_warning(), ) ); } $this->update_resmush_list( $attachment_id ); \Smush\Core\Core::add_to_smushed_list( $attachment_id ); if ( $return ) { return $status; } wp_send_json_success( $status ); } /** * If auto smush is set to true or not, default is true * * @return int|mixed */ public function is_auto_smush_enabled() { $auto_smush = $this->settings->get( 'auto' ); // Keep the auto smush on by default. if ( ! isset( $auto_smush ) ) { $auto_smush = 1; } return $auto_smush; } /** * Deletes all the backup files when an attachment is deleted * Update resmush List * Update Super Smush image count * * @param int $image_id Attachment ID. * * @return bool|void */ public function delete_images( $image_id ) { // Update the savings cache. WP_Smush::get_instance()->core()->get_savings( 'resize' ); // Update the savings cache. WP_Smush::get_instance()->core()->get_savings( 'pngjpg' ); // If no image id provided. if ( empty( $image_id ) ) { return false; } // Check and Update resmush list. $resmush_list = get_option( 'wp-smush-resmush-list' ); if ( $resmush_list ) { $this->update_resmush_list( $image_id, 'wp-smush-resmush-list' ); } /** Delete Backups */ // Check if we have any smush data for image. WP_Smush::get_instance()->core()->mod->backup->delete_backup_files( $image_id ); /** * Delete webp. * * Run WebP::delete_images always even when the module is deactivated. * * @since 3.8.0 */ WP_Smush::get_instance()->core()->mod->webp->delete_images( $image_id, false ); } /** * Calculate saving percentage for a given size stats * * @param object $stats Stats object. * * @return float|int */ private function calculate_percentage_from_stats( $stats ) { if ( empty( $stats ) || ! isset( $stats->size_before, $stats->size_after ) ) { return 0; } $savings = $stats->size_before - $stats->size_after; if ( $savings > 0 ) { $percentage = ( $savings / $stats->size_before ) * 100; $percentage = $percentage > 0 ? round( $percentage, 2 ) : $percentage; return $percentage; } return 0; } /** * Perform the resize operation for the image * * @param int $attachment_id Attachment ID. * @param array $meta Attachment meta. * * @return mixed */ public function resize_image( $attachment_id, $meta ) { if ( empty( $attachment_id ) || empty( $meta ) ) { return $meta; } return WP_Smush::get_instance()->core()->mod->resize->auto_resize( $attachment_id, $meta ); } /** * Send a smush request for the attachment * * @param int $id Attachment ID. */ public function wp_smush_handle_async( $id ) { // If we don't have image id, or the smush is already in progress for the image, return. if ( empty( $id ) || get_option( 'smush-in-progress-' . $id, false ) || get_option( "wp-smush-restore-$id", false ) ) { return; } // If auto Smush is disabled. if ( ! $this->is_auto_smush_enabled() ) { return; } /** * Filter: wp_smush_image * * Whether to smush the given attachment id or not * * @param bool $skip Whether to Smush image or not. * @param int $id Attachment id of the image being processed. */ if ( ! apply_filters( 'wp_smush_image', true, $id ) ) { return; } $this->smush_single( $id, true ); } /** * Send a smush request for the attachment * * @param int $id Attachment ID. * @param array $post_data Post data. */ public function wp_smush_handle_editor_async( $id, $post_data ) { // If we don't have image id, or the smush is already in progress for the image, return. if ( empty( $id ) || get_option( "smush-in-progress-$id", false ) || get_option( "wp-smush-restore-$id", false ) ) { return; } // If auto Smush is disabled. if ( ! $this->is_auto_smush_enabled() ) { return; } /** * Filter: wp_smush_image * * Whether to smush the given attachment id or not * * @param bool $skip Whether to Smush image or not. * @param int $id Attachment ID of the image being processed. */ if ( ! apply_filters( 'wp_smush_image', true, $id ) ) { return; } // If filepath is not set or file doesn't exists. if ( ! isset( $post_data['filepath'] ) || ! file_exists( $post_data['filepath'] ) ) { return; } // Send image for smushing. $res = $this->do_smushit( $post_data['filepath'] ); // Exit if smushing wasn't successful. if ( is_wp_error( $res ) || empty( $res['success'] ) || ! $res['success'] ) { return; } // Update stats if it's the full size image. // Return if it's not the full image size. if ( $post_data['filepath'] != get_attached_file( $post_data['postid'] ) ) { return; } // Get the existing Stats. $smush_stats = get_post_meta( $post_data['postid'], self::$smushed_meta_key, true ); $stats_full = ! empty( $smush_stats['sizes'] ) && ! empty( $smush_stats['sizes']['full'] ) ? $smush_stats['sizes']['full'] : ''; if ( empty( $stats_full ) ) { return; } // store the original image size. $stats_full->size_before = ( ! empty( $stats_full->size_before ) && $stats_full->size_before > $res['data']->before_size ) ? $stats_full->size_before : $res['data']->before_size; $stats_full->size_after = $res['data']->after_size; // Update compression percent and bytes saved for each size. $stats_full->bytes = $stats_full->size_before - $stats_full->size_after; $stats_full->percent = $this->calculate_percentage_from_stats( $stats_full ); $smush_stats['sizes']['full'] = $stats_full; // Update stats. update_post_meta( $post_data['postid'], self::$smushed_meta_key, $smush_stats ); } /** * Remove paths that should not be re-uploaded to an S3 bucket. * * See as3cf_attachment_file_paths filter description for more information. * * @since 3.0 * * @param array $paths Paths to be uploaded to S3 bucket. * @param int $attachment_id Attachment ID. * @param array $meta Image metadata. * * @return mixed */ public function remove_sizes_from_s3_upload( $paths, $attachment_id, $meta ) { // Only run when S3 integration is active (it shouldn't run otherwise, but check just in case), // and when the image does have sizes. if ( ! $this->settings->get( 's3' ) || empty( $meta['sizes'] ) ) { return $paths; } foreach ( $meta['sizes'] as $size_key => $size_data ) { // Check if registered size is supposed to be Smushed or not. if ( 'full' !== $size_key && $this->skip_image_size( $size_key ) ) { unset( $paths[ $size_key ] ); } } return $paths; } }