id = $post->ID; } else { $this->id = (int) $id; } } /** * Get the attachment backup filepath. * * @since 1.0 * * @access public * @return string|false */ public function get_backup_path() { $file_path = $this->get_original_path(); $backup_path = get_imagify_attachment_backup_path( $file_path ); if( file_exists( $backup_path ) ) { return $backup_path; } return false; } /** * Get the attachment optimization data. * * @since 1.0 * * @access public * @return array */ public function get_data() { return get_post_meta( $this->id, '_imagify_data', true ); } /** * Get the attachment extension. * * @since 1.0 * * @access public * @return string */ public function get_extension() { $fullsize_path = $this->get_original_path(); return pathinfo( $fullsize_path, PATHINFO_EXTENSION ); } /** * Get the attachment error if there is one. * * @since 1.1.5 * * @access public * @return string The message error */ public function get_optimized_error() { $error = $this->get_size_data( 'full', 'error' ); if ( is_string( $error ) ) { return $error; } return false; } /** * Get the attachment optimization level. * * @since 1.0 * * @access public * @return int */ public function get_optimization_level() { return get_post_meta( $this->id, '_imagify_optimization_level', true ); } /** * Get the attachment optimization level label. * * @since 1.2 * * @access public * @return string */ public function get_optimization_level_label() { $label = ''; $level = $this->get_optimization_level(); switch( $level ) { case 2: $label = __( 'Ultra', 'imagify' ); break; case 1: $label = __( 'Aggressive', 'imagify' ); break; case 0: $label = __( 'Normal', 'imagify' ); break; } return $label; } /** * Count number of optimized sizes. * * @since 1.0 * * @access public * @return int */ public function get_optimized_sizes_count() { $data = $this->get_data(); $sizes = (array) $data['sizes']; $count = 0; if ( isset( $sizes['full'] ) ) { unset( $sizes['full'] ); } foreach ( $sizes as $size ) { if ( $size['success'] ) { $count++; } } return (int) $count; } /** * Get the attachment optimization status (success or error). * * @since 1.0 * * @access public * @return string */ public function get_status() { return get_post_meta( $this->id, '_imagify_status', true ); } /** * Get the original attachment path. * * @since 1.0 * * @access public * @return string */ public function get_original_path() { return get_attached_file( $this->id ); } /** * Get the original attachment size. * * @since 1.0 * * @access public * @return string */ public function get_original_size() { $original_size = $this->get_size_data( 'full', 'original_size' ); $original_size = ( empty( $original_size ) ) ? @filesize( $this->get_original_path() ) : $original_size; $original_size = size_format( $original_size, 2 ); return $original_size; } /** * Get the original attachment URL. * * @since 1.0 * * @access public * @return string */ public function get_original_url() { return wp_get_attachment_url( $this->id ); } /* * Get the statistics of a specific size. * * @since 1.0 * * @access public * @param string $size The thumbnail slug. * @param string $key The specific data slug. * @return array|string */ public function get_size_data( $size = 'full', $key = '' ) { $data = $this->get_data(); $stats = array(); if ( isset( $data['sizes'][ $size ] ) ) { $stats = $data['sizes'][ $size ]; } if ( isset( $stats[ $key ] ) ) { $stats = $stats[ $key ]; } return $stats; } /** * Get the global statistics data or a specific one. * * @since 1.0 * * @access public * @param string $key The specific data slug. * @return array|string */ public function get_stats_data( $key = '' ) { $data = $this->get_data(); $stats = ''; if ( isset( $data['stats'] ) ) { $stats = $data['stats']; } if ( isset( $stats[ $key ] ) ) { $stats = $stats[ $key ]; } return $stats; } /** * Check if the attachment is already optimized (before Imagify). * * @since 1.1.6 * * @access public * @return bool True if the attachment is optimized. */ public function is_already_optimized() { return ( 'already_optimized' === $this->get_status() ) > 0; } /** * Check if the attachment is optimized. * * @since 1.0 * * @access public * @return bool True if the attachment is optimized. */ public function is_optimized() { return ( 'success' === $this->get_status() ) > 0; } /** * Check if the attachment exceeding the limit size (> 5mo). * * @since 1.0 * * @access public * @return bool True if the attachment is skipped. */ public function is_exceeded() { $filepath = $this->get_original_path(); $size = 0; if ( file_exists( $filepath ) ) { $size = filesize( $filepath ); } return ( $size > IMAGIFY_MAX_BYTES ) > 0; } /** * Check if the attachment has a backup of the original size. * * @since 1.0 * * @access public * @return bool True if the attachment has a backup. */ public function has_backup() { return (bool) $this->get_backup_path(); } /** * Check if the attachment has an error. * * @since 1.0 * * @access public * @return bool True if the attachment has an error. */ public function has_error() { $has_error = $this->get_size_data( 'full', 'error' ); return ( is_string( $has_error ) ) > 0; } /** * Update the metadata size of the attachment * * @since 1.2 * * @access public * @return void */ public function update_metadata_size() { if ( ! wp_attachment_is_image( $this->id ) ) { return false; } $size = @getimagesize( $this->get_original_path() ); if ( isset( $size[0], $size[1] ) ) { $metadata = wp_get_attachment_metadata( $this->id ); $metadata['width'] = $size[0]; $metadata['height'] = $size[1]; wp_update_attachment_metadata( $this->id, $metadata ); } } /** * Delete the backup file. * * @since 1.0 * * @access public * @return void */ public function delete_backup() { $backup_path = $this->get_backup_path(); if ( ! empty( $backup_path ) ) { @unlink( $backup_path ); } } /** * Fills statistics data with values from $data array * * @since 1.0 * * @access public * @static * @param array $data The statistics data * @param object $response The API response * @param int $id The attachment ID * @param int $url The attachment URL * @param string $size The attachment size key * @return bool|array False if the original size has an error or an array contains the data for other result */ static public function fill_data( $data, $response, $id, $url, $size = 'full' ) { if ( is_wp_error( $response ) ) { $error = $response->get_error_message(); $error_status = 'error'; $data['sizes'][ $size ] = array( 'success' => false, 'error' => $error ); // Update the error status for the original size if ( 'full' === $size ) { update_post_meta( $id, '_imagify_data', $data ); if ( false !== strpos( $error, 'This image is already compressed' ) ) { $error_status = 'already_optimized'; } update_post_meta( $id, '_imagify_status', $error_status ); return false; } } else { $data['sizes'][ $size ] = array( 'success' => true, 'file_url' => $url, 'original_size' => $response->original_size, 'optimized_size' => $response->new_size, 'percent' => $response->percent ); $data['stats']['original_size'] += ( isset( $response->original_size ) ) ? $response->original_size : 0; $data['stats']['optimized_size'] += ( isset( $response->new_size ) ) ? $response->new_size : 0; } return $data; } /** * Optimize all sizes with Imagify. * * @since 1.0 * * @access public * @param int $optimization_level The optimization level (2=ultra, 1=aggressive, 0=normal) * @param array $metadata The attachment meta data * @return array $optimized_data The optimization data */ public function optimize( $optimization_level = null, $metadata = array() ) { $optimization_level = ( is_null( $optimization_level ) ) ? (int) get_imagify_option( 'optimization_level', 1 ) : (int) $optimization_level; $id = $this->id; $metadata = ( (bool) $metadata ) ? $metadata : wp_get_attachment_metadata( $id ); $sizes = ( isset( $metadata['sizes'] ) ) ? (array) $metadata['sizes'] : array(); $data = array( 'stats' => array( 'original_size' => 0, 'optimized_size' => 0, 'percent' => 0, ) ); // Get file path & URL for original image $attachment_path = $this->get_original_path(); $attachment_url = $this->get_original_url(); // Check if the attachment extension is allowed if ( ! $id || ! wp_attachment_is_image( $id ) ) { return; } // Check if the full size is already optimized if ( $this->is_optimized() && ( $this->get_optimization_level() == $optimization_level ) ) { return; } /** * Fires before optimizing an attachment. * * @since 1.0 * * @param int $id The attachment ID */ do_action( 'before_imagify_optimize_attachment', $id ); // Get the resize values for the original size $resize = array(); $do_resize = get_imagify_option( 'resize_larger', false ); $resize_width = get_imagify_option( 'resize_larger_w' ); $attachment_size = @getimagesize( $attachment_path ); if ( $do_resize && isset( $attachment_size[0] ) && $resize_width < $attachment_size[0] ) { $resize['width'] = $resize_width; } // Optimize the original size $response = do_imagify( $attachment_path, get_imagify_option( 'backup', false ), $optimization_level, $resize, get_imagify_option( 'exif', false ) ); $data = $this->fill_data( $data, $response, $id, $attachment_url ); // Save the optimization level update_post_meta( $id, '_imagify_optimization_level', $optimization_level ); if( (bool) ! $data ) { return; } // If we resized the original with success, we have to update the attachment metadata // If not, WordPress keeps the old attachment size. if ( $do_resize && isset( $resize['width'] ) ) { $this->update_metadata_size(); } // Optimize all thumbnails if ( (bool) $sizes ) { foreach ( $sizes as $size_key => $size_data ) { // Check if this size has to be optimized if ( array_key_exists( $size_key, get_imagify_option( 'disallowed-sizes', array() ) ) && ! imagify_is_active_for_network() ) { $data['sizes'][ $size_key ] = array( 'success' => false, 'error' => __( 'This size isn\'t authorized to be optimized. Update your Imagify settings if you want to optimize it.', 'imagify' ) ); continue; } $thumbnail_path = trailingslashit( dirname( $attachment_path ) ) . $size_data['file']; $thumbnail_url = trailingslashit( dirname( $attachment_url ) ) . $size_data['file']; // Optimize the thumbnail size $response = do_imagify( $thumbnail_path, false, $optimization_level ); $data = $this->fill_data( $data, $response, $id, $thumbnail_url, $size_key ); /** * Filter the optimization data of a specific thumbnail * * @since 1.0 * * @param array $data The statistics data * @param object $response The API response * @param int $id The attachment ID * @param string $thumbnail_path The attachment path * @param string $thumbnail_url The attachment URL * @param string $size_key The attachment size key * @param bool $is_aggressive The optimization level * @return array $data The new optimization data */ $data = apply_filters( 'imagify_fill_thumbnail_data', $data, $response, $id, $thumbnail_path, $thumbnail_url, $size_key, $optimization_level ); } } $data['stats']['percent'] = round( ( ( $data['stats']['original_size'] - $data['stats']['optimized_size'] ) / $data['stats']['original_size'] ) * 100, 2 ); update_post_meta( $id, '_imagify_data', $data ); update_post_meta( $id, '_imagify_status', 'success' ); $optimized_data = $this->get_data(); /** * Fires after optimizing an attachment. * * @since 1.0 * * @param int $id The attachment ID * @param array $optimized_data The optimization data */ do_action( 'after_imagify_optimize_attachment', $id, $optimized_data ); return $optimized_data; } /** * Process an attachment restoration from the backup file. * * @since 1.0 * * @access public * @return void */ public function restore() { // Stop the process if there is no backup file to restore if ( ! $this->has_backup() ) { return; } $id = $this->id; $backup_path = $this->get_backup_path(); $attachment_path = $this->get_original_path(); /** * Fires before restoring an attachment. * * @since 1.0 * * @param int $id The attachment ID */ do_action( 'before_imagify_restore_attachment', $id ); // Create the original image from the backup @copy( $backup_path, $attachment_path ); imagify_chmod_file( $attachment_path ); if ( ! function_exists( 'wp_generate_attachment_metadata' ) ) { require_once( ABSPATH . 'wp-admin/includes/image.php' ); } remove_filter( 'wp_generate_attachment_metadata', '_imagify_optimize_attachment', PHP_INT_MAX ); wp_generate_attachment_metadata( $id, $attachment_path ); // Remove old optimization data delete_post_meta( $id, '_imagify_data' ); delete_post_meta( $id, '_imagify_status' ); delete_post_meta( $id, '_imagify_optimization_level' ); // Restore the original size in the metadata $this->update_metadata_size(); /** * Fires after restoring an attachment. * * @since 1.0 * * @param int $id The attachment ID */ do_action( 'after_imagify_restore_attachment', $id ); } }