589 lines
15 KiB
PHP
589 lines
15 KiB
PHP
<?php
|
|
declare(strict_types=1);
|
|
|
|
namespace WP_Rocket\Engine\Media\ImageDimensions;
|
|
|
|
use SplFileInfo;
|
|
use WP_Filesystem_Direct;
|
|
use WP_Rocket\Admin\Options_Data;
|
|
use WP_Rocket\Engine\Admin\Settings\Settings;
|
|
use WP_Rocket\Engine\Optimization\RegexTrait;
|
|
use WP_Rocket\Logger\Logger;
|
|
|
|
class ImageDimensions {
|
|
use RegexTrait;
|
|
/**
|
|
* Options_Data instance
|
|
*
|
|
* @var Options_Data
|
|
*/
|
|
private $options;
|
|
|
|
/**
|
|
* Filesystem instance
|
|
*
|
|
* @var WP_Filesystem_Direct
|
|
*/
|
|
private $filesystem;
|
|
|
|
/**
|
|
* Frontend constructor.
|
|
*
|
|
* @param Options_Data $options Options_Data instance.
|
|
* @param WP_Filesystem_Direct $filesystem Filesystem instance.
|
|
*/
|
|
public function __construct( Options_Data $options, $filesystem = null ) {
|
|
$this->options = $options;
|
|
|
|
if ( null === $filesystem ) {
|
|
$filesystem = rocket_direct_filesystem();
|
|
}
|
|
|
|
$this->filesystem = $filesystem;
|
|
}
|
|
|
|
/**
|
|
* Adds the images dimensions option to WP Rocket options array
|
|
*
|
|
* @since 3.8
|
|
*
|
|
* @param array $options WP Rocket options array.
|
|
* @return array
|
|
*/
|
|
public function add_option( array $options ): array {
|
|
$options['image_dimensions'] = 0;
|
|
|
|
return $options;
|
|
}
|
|
|
|
/**
|
|
* Sanitizes the option value when saving from the settings page
|
|
*
|
|
* @since 3.8
|
|
*
|
|
* @param array $input Array of sanitized values after being submitted by the form.
|
|
* @param Settings $settings Settings class instance.
|
|
* @return array
|
|
*/
|
|
public function sanitize_option_value( array $input, Settings $settings ): array {
|
|
$input['image_dimensions'] = $settings->sanitize_checkbox( $input, 'image_dimensions' );
|
|
|
|
return $input;
|
|
}
|
|
|
|
/**
|
|
* Specify image dimensions and insert it into images.
|
|
*
|
|
* @param string $html Buffer Page HTML contents.
|
|
*
|
|
* @return string Buffer Page HTML contents after inserting dimentions into images.
|
|
*/
|
|
public function specify_image_dimensions( $html ) {
|
|
Logger::debug( 'Start Specify Image Dimensions.' );
|
|
|
|
if ( ! $this->can_specify_dimensions_images() ) {
|
|
Logger::debug( 'Specify Image Dimensions failed because option is not enabled from admin or by filter (rocket_specify_image_dimensions).' );
|
|
return $html;
|
|
}
|
|
|
|
// Get all images without width and height attributes.
|
|
$images_regex = '<img(?:[^>](?!height=[\'\"](?:\S+)[\'\"]))*+>|<img(?:[^>](?!width=[\'\"](?:\S+)[\'\"]))*+>';
|
|
|
|
/**
|
|
* Filters Specify image dimensions inside picture tags also.
|
|
*
|
|
* @since 3.8
|
|
*
|
|
* @param bool Do or not. Default is True, so it will skip all img tags that are inside picture tag.
|
|
*/
|
|
if ( apply_filters( 'rocket_specify_dimension_skip_pictures', true ) ) {
|
|
$images_regex = '<\s*picture[^>]*>.*<\s*\/\s*picture\s*>(*SKIP)(*FAIL)|' . $images_regex;
|
|
}
|
|
|
|
$clean_html = $this->hide_scripts( $html );
|
|
$clean_html = $this->hide_noscripts( $clean_html );
|
|
|
|
preg_match_all( "/{$images_regex}/Uis", $clean_html, $images_match );
|
|
|
|
if ( empty( $images_match ) ) {
|
|
Logger::debug( 'Specify Image Dimensions failed because there is no image without dimensions on this page.' );
|
|
return $html;
|
|
}
|
|
|
|
$replaces = [];
|
|
|
|
/**
|
|
* Filters Page images passed to specify dimensions.
|
|
*
|
|
* @since 3.8
|
|
*
|
|
* @param array Page images.
|
|
*/
|
|
$images = apply_filters( 'rocket_specify_dimension_images', $images_match[0] );
|
|
|
|
Logger::debug( 'Specify Image Dimensions found ( ' . count( $images ) . ' ).', $images );
|
|
|
|
foreach ( $images as $image ) {
|
|
$image_url = $this->can_specify_dimensions_one_image( $image );
|
|
|
|
if ( ! $image_url ) {
|
|
Logger::debug(
|
|
'Specify Image Dimensions failed because it has attribute (data-lazy-original or data-no-image-dimensions) or it\'s without src.',
|
|
[ 'image' => $image ]
|
|
);
|
|
continue;
|
|
}
|
|
|
|
$sizes = $this->get_image_sizes( $image_url );
|
|
|
|
if ( ! $sizes ) {
|
|
continue;
|
|
}
|
|
|
|
$width_height = $this->set_dimensions( $image, $sizes );
|
|
|
|
if ( ! $width_height ) {
|
|
continue;
|
|
}
|
|
|
|
// Replace image with new attributes, we will replace all images at once after the loop for optimizations.
|
|
$replaces[ $image ] = $this->assign_width_height( $image, $width_height );
|
|
}
|
|
|
|
if ( empty( $replaces ) ) {
|
|
return $html;
|
|
}
|
|
|
|
return str_replace( array_keys( $replaces ), $replaces, $html );
|
|
}
|
|
|
|
/**
|
|
* Determines if the file is external.
|
|
*
|
|
* @since 3.8
|
|
*
|
|
* @param string $url URL of the file.
|
|
* @return bool True if external, false otherwise.
|
|
*/
|
|
private function is_external_file( $url ) {
|
|
$file = get_rocket_parse_url( $url );
|
|
|
|
if ( ! empty( $file['query'] ) ) {
|
|
return true;
|
|
}
|
|
|
|
if ( empty( $file['path'] ) ) {
|
|
return true;
|
|
}
|
|
|
|
$parsed_site_url = wp_parse_url( site_url() );
|
|
|
|
if ( empty( $parsed_site_url['host'] ) ) {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Filters the allowed hosts for optimization
|
|
*
|
|
* @since 3.4
|
|
*
|
|
* @param array $hosts Allowed hosts.
|
|
* @param array $zones Zones to check available hosts.
|
|
*/
|
|
$hosts = (array) apply_filters( 'rocket_cdn_hosts', [], [ 'all' ] );
|
|
$hosts[] = $parsed_site_url['host'];
|
|
$langs = get_rocket_i18n_uri();
|
|
|
|
// Get host for all langs.
|
|
foreach ( $langs as $lang ) {
|
|
$url_host = wp_parse_url( $lang, PHP_URL_HOST );
|
|
|
|
if ( ! isset( $url_host ) ) {
|
|
continue;
|
|
}
|
|
|
|
$hosts[] = $url_host;
|
|
}
|
|
|
|
$hosts = array_unique( $hosts );
|
|
|
|
if ( empty( $hosts ) ) {
|
|
return true;
|
|
}
|
|
|
|
// URL has domain and domain is part of the internal domains.
|
|
if ( ! empty( $file['host'] ) ) {
|
|
foreach ( $hosts as $host ) {
|
|
if ( false !== strpos( $file['host'], $host ) ) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Get local absolute path for image.
|
|
*
|
|
* @param string $url Image url.
|
|
*
|
|
* @return string Image absolute local path.
|
|
*/
|
|
private function get_local_path( $url ) {
|
|
$url = $this->normalize_url( $url );
|
|
|
|
$path = rocket_url_to_path( $url );
|
|
if ( $path ) {
|
|
return $path;
|
|
}
|
|
|
|
$relative_url = ltrim( wp_make_link_relative( $url ), '/' );
|
|
$ds = rocket_get_constant( 'DIRECTORY_SEPARATOR' );
|
|
$base_path = isset( $_SERVER['DOCUMENT_ROOT'] ) ? ( sanitize_text_field( wp_unslash( $_SERVER['DOCUMENT_ROOT'] ) ) . $ds ) : '';
|
|
|
|
return $base_path . str_replace( '/', $ds, $relative_url );
|
|
}
|
|
|
|
/**
|
|
* Check if we can specify dimensions for external images.
|
|
*
|
|
* @return bool Valid to be parsed or not.
|
|
*/
|
|
private function can_specify_dimensions_external_images() {
|
|
/**
|
|
* Enable/Disable specify image dimensions for external images.
|
|
*
|
|
* @since 3.8
|
|
*
|
|
* @param bool Specify image dimensions for external images or not.
|
|
*/
|
|
return ini_get( 'allow_url_fopen' ) && apply_filters( 'rocket_specify_image_dimensions_for_distant', false );
|
|
}
|
|
|
|
/**
|
|
* Sets the width and height dimensions string
|
|
*
|
|
* @param string $image Image HTML element.
|
|
* @param array $sizes Array of data created by getimagesize().
|
|
*
|
|
* @return string|false
|
|
*/
|
|
private function set_dimensions( string $image, array $sizes ) {
|
|
preg_match( '/<img.*height=[\'\"](?<height>\S+)[\'\"].*>/i', $image, $initial_height );
|
|
preg_match( '/<img.*width=[\'\"](?<width>\S+)[\'\"].*>/i', $image, $initial_width );
|
|
|
|
if (
|
|
empty( $initial_height['height'] )
|
|
&&
|
|
empty( $initial_width['width'] )
|
|
) {
|
|
return $sizes[3];
|
|
}
|
|
|
|
if ( ! empty( $initial_height['height'] ) ) {
|
|
if ( ! is_numeric( $initial_height['height'] ) ) {
|
|
Logger::debug(
|
|
'Specify Image Dimensions failed because specified height is not numeric.',
|
|
[ 'image' => $image ]
|
|
);
|
|
|
|
return false;
|
|
}
|
|
|
|
$ratio = $initial_height['height'] / $sizes[1];
|
|
|
|
return 'width="' . (int) round( $sizes[0] * $ratio ) . '" height="' . $initial_height['height'] . '"';
|
|
}
|
|
|
|
if ( ! empty( $initial_width['width'] ) ) {
|
|
if ( ! is_numeric( $initial_width['width'] ) ) {
|
|
Logger::debug(
|
|
'Specify Image Dimensions failed because specified width is not numeric.',
|
|
[ 'image' => $image ]
|
|
);
|
|
|
|
return false;
|
|
}
|
|
|
|
$ratio = $initial_width['width'] / $sizes[0];
|
|
|
|
return 'width="' . $initial_width['width'] . '" height="' . (int) round( $sizes[1] * $ratio ) . '"';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Assign width and height attributes to the img tag.
|
|
*
|
|
* @param string $image IMG tag.
|
|
* @param string $width_height Width/Height attributes in ready state like [height="100" width="100"].
|
|
*
|
|
* @return string IMG tag after adding attributes otherwise return the input img when error.
|
|
*/
|
|
private function assign_width_height( string $image, string $width_height ): string {
|
|
// Remove old width and height attributes if found.
|
|
$changed_image = preg_replace( '/(height|width)=[\'"](?:\S+)*[\'"]\s?/i', '', $image );
|
|
$changed_image = preg_replace( '/<\s*img/i', '<img ' . $width_height, $changed_image );
|
|
|
|
if ( null === $changed_image ) {
|
|
return $image;
|
|
}
|
|
|
|
return $changed_image;
|
|
}
|
|
|
|
/**
|
|
* Check if the image exists, internal or external image.
|
|
*
|
|
* @param string $image Image Url for external and Image absolute path for internal.
|
|
* @param bool $external If this image is external or not.
|
|
*
|
|
* @return bool If image exists or not.
|
|
*/
|
|
private function image_exists( string $image, $external = false ): bool {
|
|
if ( ! $image ) {
|
|
return false;
|
|
}
|
|
|
|
if ( ! $external ) {
|
|
return $this->filesystem->exists( $image );
|
|
}
|
|
|
|
$file_headers = get_headers( $image );
|
|
|
|
if ( ! $file_headers ) {
|
|
return false;
|
|
}
|
|
|
|
return false !== strstr( $file_headers[0], '200' );
|
|
}
|
|
|
|
/**
|
|
* Check if we can specify image dimensions for all images.
|
|
*
|
|
* @return bool Can we or not.
|
|
*/
|
|
private function can_specify_dimensions_images(): bool {
|
|
/**
|
|
* Filter images dimensions attributes process.
|
|
*
|
|
* @since 2.2
|
|
*
|
|
* @param bool Do the job or not.
|
|
*/
|
|
return apply_filters( 'rocket_specify_image_dimensions', false )
|
|
||
|
|
$this->options->get( 'image_dimensions', false );
|
|
}
|
|
|
|
/**
|
|
* Check if we can specify image dimensions for one image.
|
|
*
|
|
* @param string $image Full img tag.
|
|
*
|
|
* @return false|string false if we can't specify for this image otherwise get img src attribute.
|
|
*/
|
|
private function can_specify_dimensions_one_image( string $image ) {
|
|
// Don't touch lazy-load file (no conflict with Photon (Jetpack)).
|
|
if (
|
|
false !== strpos( $image, 'data-lazy-original' )
|
|
||
|
|
false !== strpos( $image, 'data-no-image-dimensions' )
|
|
||
|
|
! preg_match( '/\s+src\s*=\s*[\'"](?<url>[^\'"]+)/i', $image, $src_match )
|
|
) {
|
|
return false;
|
|
}
|
|
|
|
return $src_match['url'];
|
|
|
|
}
|
|
|
|
/**
|
|
* Get Image sizes.
|
|
*
|
|
* @param string $image_url Image url to get sizes for.
|
|
*
|
|
* @return array|false Get image sizes otherwise false.
|
|
*/
|
|
private function get_image_sizes( string $image_url ) {
|
|
if ( $this->is_external_file( $image_url ) ) {
|
|
$image_url = $this->normalize_url( $image_url );
|
|
|
|
if ( ! $this->can_specify_dimensions_external_images() ) {
|
|
Logger::debug(
|
|
'Specify Image Dimensions failed because you/server disabled specifying dimensions for external images.',
|
|
[ 'image_url' => $image_url ]
|
|
);
|
|
return false;
|
|
}
|
|
|
|
if ( ! $this->image_exists( $image_url, true ) ) {
|
|
Logger::debug(
|
|
'Specify Image Dimensions failed because external image not found.',
|
|
[ 'image_url' => $image_url ]
|
|
);
|
|
return false;
|
|
}
|
|
|
|
$sizes = $this->getimagesize( $image_url );
|
|
|
|
if ( ! $sizes ) {
|
|
Logger::debug(
|
|
'Specify Image Dimensions failed because image is not valid.',
|
|
[ 'image_url' => $image_url ]
|
|
);
|
|
return false;
|
|
}
|
|
|
|
return $sizes;
|
|
}
|
|
|
|
$local_path = $this->get_local_path( $image_url );
|
|
|
|
if ( ! $this->image_exists( $local_path, false ) ) {
|
|
Logger::debug(
|
|
'Specify Image Dimensions failed because internal image is not found.',
|
|
[ 'image_url' => $image_url ]
|
|
);
|
|
|
|
return false;
|
|
}
|
|
|
|
$sizes = $this->getimagesize( $local_path );
|
|
|
|
if ( ! $sizes ) {
|
|
Logger::debug(
|
|
'Specify Image Dimensions failed because image is not valid.',
|
|
[ 'image_url' => $image_url ]
|
|
);
|
|
|
|
return false;
|
|
}
|
|
|
|
return $sizes;
|
|
}
|
|
|
|
/**
|
|
* Gets image sizes for the given file
|
|
*
|
|
* @param string $filename File we want to retrieve information about.
|
|
*
|
|
* @return array|false
|
|
*/
|
|
private function getimagesize( string $filename ) {
|
|
$file = new SplFileInfo( strtok( $filename, '?' ) );
|
|
|
|
if ( 'svg' === $file->getExtension() ) {
|
|
return $this->svg_getimagesize( $filename );
|
|
}
|
|
|
|
return getimagesize( $filename );
|
|
}
|
|
|
|
/**
|
|
* Gets image sizes for the given SVG file
|
|
*
|
|
* Uses the width/height attributes if present, or fallback to viewBox attribute
|
|
*
|
|
* @param string $filename File we want to retrieve information about.
|
|
*
|
|
* @return array|false
|
|
*/
|
|
private function svg_getimagesize( string $filename ) {
|
|
$svgfile = simplexml_load_file( rawurlencode( $filename ), 'SimpleXMLElement', rocket_get_constant( 'LIBXML_NOERROR', 32 ) | rocket_get_constant( 'LIBXML_NOWARNING', 64 ) );
|
|
|
|
if ( ! $svgfile ) {
|
|
return false;
|
|
}
|
|
|
|
$width = $this->format_svg_value( (string) $svgfile->attributes()->width );
|
|
$height = $this->format_svg_value( (string) $svgfile->attributes()->height );
|
|
$size = [];
|
|
|
|
if (
|
|
! empty( $width )
|
|
&&
|
|
! empty( $height )
|
|
) {
|
|
$size[0] = $width;
|
|
$size[1] = $height;
|
|
$size[2] = 0;
|
|
$size[3] = 'width="' . absint( $width ) . '" height="' . absint( $height ) . '"';
|
|
|
|
return $size;
|
|
}
|
|
|
|
$view_box = preg_split( '/[\s,]+/', (string) $svgfile->attributes()->viewBox );
|
|
|
|
if ( ! empty( $view_box ) ) {
|
|
if (
|
|
! empty( $view_box[2] )
|
|
&&
|
|
! empty( $view_box[3] )
|
|
) {
|
|
$size[0] = $view_box[2];
|
|
$size[1] = $view_box[3];
|
|
$size[2] = 0;
|
|
$size[3] = 'width="' . absint( $size[0] ) . '" height="' . absint( $size[1] ) . '"';
|
|
|
|
return $size;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Formats the SVG width/height value in case of unusual units
|
|
*
|
|
* @since 3.10.8
|
|
*
|
|
* @param string $value The value of the SVG width/height attribute.
|
|
*
|
|
* @return string
|
|
*/
|
|
private function format_svg_value( string $value ): string {
|
|
// No unit, we can use the value directly.
|
|
if ( is_numeric( $value ) ) {
|
|
return $value;
|
|
}
|
|
|
|
if ( empty( $value ) ) {
|
|
return $value;
|
|
}
|
|
|
|
$px_pattern = '/([0-9]+)\s*px/i';
|
|
|
|
// If pixel unit, remove the unit and return the numeric value.
|
|
if ( preg_match( $px_pattern, $value ) ) {
|
|
return preg_replace( $px_pattern, '$1', $value );
|
|
}
|
|
|
|
// Return an empty string for other units.
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Normalize relative url to full url.
|
|
*
|
|
* @param string $url Url to be normalized.
|
|
*
|
|
* @return string Normalized url.
|
|
*/
|
|
private function normalize_url( string $url ): string {
|
|
$url_host = wp_parse_url( $url, PHP_URL_HOST );
|
|
|
|
if ( empty( $url_host ) ) {
|
|
$relative_url = ltrim( wp_make_link_relative( $url ), '/' );
|
|
$site_url_components = wp_parse_url( site_url( '/' ) );
|
|
return $site_url_components['scheme'] . '://' . $site_url_components['host'] . '/' . $relative_url;
|
|
}
|
|
|
|
return $url;
|
|
}
|
|
}
|