Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Smush page parser that is used by CDN and Lazy load modules.

[2] Fix | Delete

[3] Fix | Delete

* @since 3.2.2

[4] Fix | Delete

* @package Smush\Core\Modules\Helpers

[5] Fix | Delete

[6] Fix | Delete

[7] Fix | Delete

namespace Smush\Core\Modules\Helpers;

[8] Fix | Delete

[9] Fix | Delete

use Smush\Core\Server_Utils;

[10] Fix | Delete

use Smush\Core\Settings;

[11] Fix | Delete

use Smush\Core\Transform\Transformer;

[12] Fix | Delete

use WP_Smush;

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Class Parser

[16] Fix | Delete

[17] Fix | Delete

class Parser {

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* CDN module status.

[21] Fix | Delete

[22] Fix | Delete

* @var bool $cdn

[23] Fix | Delete

[24] Fix | Delete

private $cdn = false;

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Lazy load module status.

[28] Fix | Delete

[29] Fix | Delete

* @var bool $lazy_load

[30] Fix | Delete

[31] Fix | Delete

private $lazy_load = false;

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* Process background images.

[35] Fix | Delete

[36] Fix | Delete

* @since 3.2.2

[37] Fix | Delete

* @var bool $background_images

[38] Fix | Delete

[39] Fix | Delete

private $background_images = false;

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* Server utils instance.

[43] Fix | Delete

[44] Fix | Delete

* @var Server_Utils

[45] Fix | Delete

[46] Fix | Delete

private $server_utils;

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* Transformer instance.

[50] Fix | Delete

[51] Fix | Delete

* @var Transformer

[52] Fix | Delete

[53] Fix | Delete

private $transformer;

[54] Fix | Delete

[55] Fix | Delete

public function __construct() {

[56] Fix | Delete

$this->server_utils = new Server_Utils();

[57] Fix | Delete

$this->transformer = new Transformer();

[58] Fix | Delete

}

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* Smush will __construct this class multiple times, but only once does it need to be initialized.

[62] Fix | Delete

[63] Fix | Delete

* @since 3.5.0 Moved from __construct().

[64] Fix | Delete

[65] Fix | Delete

public function init() {

[66] Fix | Delete

if ( is_admin() || is_customize_preview() || wp_doing_ajax() || wp_doing_cron() ) {

[67] Fix | Delete

return;

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

$settings = Settings::get_instance();

[71] Fix | Delete

$background_images = $settings->get( 'background_images' );

[72] Fix | Delete

if ( $background_images ) {

[73] Fix | Delete

$this->enable( 'background_images' );

[74] Fix | Delete

}

[75] Fix | Delete

if ( $settings->is_cdn_active() ) {

[76] Fix | Delete

$this->enable( 'cdn' );

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

$lazy_load_options = $settings->get_setting( 'wp-smush-lazy_load' );

[80] Fix | Delete

$this->enable( 'lazy_load' );

[81] Fix | Delete

if ( isset( $lazy_load_options['format']['iframe'] ) && $lazy_load_options['format']['iframe'] ) {

[82] Fix | Delete

$this->enable( 'iframes' );

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

// Start an output buffer before any output starts.

[86] Fix | Delete

add_action(

[87] Fix | Delete

'template_redirect',

[88] Fix | Delete

function () {

[89] Fix | Delete

ob_start( array( $this, 'parse_page' ) );

[90] Fix | Delete

[91] Fix | Delete

[92] Fix | Delete

);

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

/**

[96] Fix | Delete

* Enable parser for selected module.

[97] Fix | Delete

[98] Fix | Delete

* @since 3.2.2

[99] Fix | Delete

* @param string $module Module ID.

[100] Fix | Delete

[101] Fix | Delete

public function enable( $module ) {

[102] Fix | Delete

if ( ! in_array( $module, array( 'cdn', 'lazy_load', 'background_images' ), true ) ) {

[103] Fix | Delete

return;

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

$this->$module = true;

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

/**

[110] Fix | Delete

* Disable parser for selected module.

[111] Fix | Delete

[112] Fix | Delete

* @since 3.2.2

[113] Fix | Delete

* @param string $module Module ID.

[114] Fix | Delete

[115] Fix | Delete

public function disable( $module ) {

[116] Fix | Delete

if ( ! in_array( $module, array( 'cdn', 'lazy_load' ), true ) ) {

[117] Fix | Delete

return;

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

$this->$module = false;

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* Process images from current buffer content.

[125] Fix | Delete

[126] Fix | Delete

* Use DOMDocument class to find all available images in current HTML content and set attachment ID attribute.

[127] Fix | Delete

[128] Fix | Delete

* @since 3.0

[129] Fix | Delete

* @since 3.2.2 Moved from \Smush\Core\Modules\CDN.

[130] Fix | Delete

[131] Fix | Delete

* @param string $content Current buffer content.

[132] Fix | Delete

[133] Fix | Delete

* @return string

[134] Fix | Delete

[135] Fix | Delete

public function parse_page( $content ) {

[136] Fix | Delete

// Do not parse page if CDN and Lazy load modules are disabled.

[137] Fix | Delete

if ( ! $this->cdn && ! $this->lazy_load ) {

[138] Fix | Delete

return $content;

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

if ( is_customize_preview() ) {

[142] Fix | Delete

return $content;

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

if ( empty( $content ) ) {

[146] Fix | Delete

return $content;

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

$content = $this->transformer->transform_content(

[150] Fix | Delete

$content,

[151] Fix | Delete

$this->server_utils->get_current_url()

[152] Fix | Delete

);

[153] Fix | Delete

[154] Fix | Delete

return $content;

[155] Fix | Delete

}

[156] Fix | Delete

[157] Fix | Delete

/**

[158] Fix | Delete

* Process all images within <img> tags.

[159] Fix | Delete

[160] Fix | Delete

* @since 3.2.2

[161] Fix | Delete

[162] Fix | Delete

* @param string $content Current buffer content.

[163] Fix | Delete

[164] Fix | Delete

* @return string

[165] Fix | Delete

[166] Fix | Delete

private function process_images( $content ) {

[167] Fix | Delete

$images = $this->get_images_from_content( $content );

[168] Fix | Delete

[169] Fix | Delete

if ( empty( $images ) ) {

[170] Fix | Delete

return $content;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

foreach ( $images[0] as $key => $image ) {

[174] Fix | Delete

$img_src = $images['src'][ $key ];

[175] Fix | Delete

$new_image = $image;

[176] Fix | Delete

[177] Fix | Delete

// Update the image with correct CDN links.

[178] Fix | Delete

if ( $this->cdn ) {

[179] Fix | Delete

$new_image = WP_Smush::get_instance()->core()->mod->cdn->parse_image( $img_src, $new_image, $images['srcset'][ $key ], $images['type'][ $key ] );

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

$content = str_replace( $image, $new_image, $content );

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

return $content;

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

/**

[189] Fix | Delete

* Process all images that are contained as background-images.

[190] Fix | Delete

[191] Fix | Delete

* @since 3.2.2

[192] Fix | Delete

[193] Fix | Delete

* @param string $content Current buffer content.

[194] Fix | Delete

[195] Fix | Delete

* @return string

[196] Fix | Delete

[197] Fix | Delete

private function process_background_images( $content ) {

[198] Fix | Delete

$images = self::get_background_images( $content );

[199] Fix | Delete

[200] Fix | Delete

if ( empty( $images ) ) {

[201] Fix | Delete

return $content;

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

// Try to sort out the duplicate entries.

[205] Fix | Delete

$elements = array_unique( $images[0] );

[206] Fix | Delete

// TODO: check what this is and whether or not we are doing the same thing in the new framework

[207] Fix | Delete

$urls = array_unique( $images['img_url'] );

[208] Fix | Delete

if ( count( $elements ) === count( $urls ) ) {

[209] Fix | Delete

$images[0] = $elements;

[210] Fix | Delete

$images['img_url'] = $urls;

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

foreach ( $images[0] as $key => $image ) {

[214] Fix | Delete

$img_src = $images['img_url'][ $key ];

[215] Fix | Delete

$new_image = $image;

[216] Fix | Delete

[217] Fix | Delete

// Update the image with correct CDN links.

[218] Fix | Delete

$new_image = WP_Smush::get_instance()->core()->mod->cdn->parse_background_image( $img_src, $new_image );

[219] Fix | Delete

[220] Fix | Delete

$content = str_replace( $image, $new_image, $content );

[221] Fix | Delete

/**

[222] Fix | Delete

* Filter the current page content after process background images.

[223] Fix | Delete

[224] Fix | Delete

* @param string $content Current Page content.

[225] Fix | Delete

* @param string $image Backround Image tag without src.

[226] Fix | Delete

* @param string $img_src Image src.

[227] Fix | Delete

[228] Fix | Delete

$content = apply_filters( 'smush_after_process_background_images', $content, $image, $img_src );

[229] Fix | Delete

}

[230] Fix | Delete

[231] Fix | Delete

return $content;

[232] Fix | Delete

}

[233] Fix | Delete

[234] Fix | Delete

/**

[235] Fix | Delete

* Get image tags from page content.

[236] Fix | Delete

[237] Fix | Delete

* @since 3.1.0

[238] Fix | Delete

* @since 3.2.0 Moved to WP_Smush_Content from \Smush\Core\Modules\CDN

[239] Fix | Delete

* @since 3.2.2 Moved to Parser from WP_Smush_Content

[240] Fix | Delete

[241] Fix | Delete

* Performance test: auto generated page with ~900 lines of HTML code, 84 images.

[242] Fix | Delete

* - Smush 2.4.0: 82 matches, 104359 steps (~80 ms) <- does not match <source> images in <picture>.

[243] Fix | Delete

* - Smush 2.5.0: 84 matches, 63791 steps (~51 ms).

[244] Fix | Delete

[245] Fix | Delete

* @param string $content Page content.

[246] Fix | Delete

[247] Fix | Delete

* @return array

[248] Fix | Delete

[249] Fix | Delete

public function get_images_from_content( $content ) {

[250] Fix | Delete

$images = array();

[251] Fix | Delete

[252] Fix | Delete

/**

[253] Fix | Delete

* Filter out only <body> content. As this was causing issues with escaped JS strings in <head>.

[254] Fix | Delete

[255] Fix | Delete

* @since 3.6.2

[256] Fix | Delete

[257] Fix | Delete

if ( preg_match( '/(?=<body).*<\/body>/is', $content, $body ) ) {

[258] Fix | Delete

$content = $body[0];

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

[262] Fix | Delete

// TODO: Deprecate in favor of wp_smush_images_from_content_regex

[263] Fix | Delete

$pattern = apply_filters( 'smush_images_from_content_regex', $pattern );

[264] Fix | Delete

[265] Fix | Delete

if ( preg_match_all( $pattern, $content, $images ) ) {

[266] Fix | Delete

foreach ( $images as $key => $unused ) {

[267] Fix | Delete

// Simplify the output as much as possible, mostly for confirming test results.

[268] Fix | Delete

if ( is_numeric( $key ) && $key > 0 ) {

[269] Fix | Delete

unset( $images[ $key ] );

[270] Fix | Delete

}

[271] Fix | Delete

}

[272] Fix | Delete

}

[273] Fix | Delete

[274] Fix | Delete

return $images;

[275] Fix | Delete

}

[276] Fix | Delete

[277] Fix | Delete

/**

[278] Fix | Delete

* Get background images from content.

[279] Fix | Delete

[280] Fix | Delete

* @since 3.2.2

[281] Fix | Delete

[282] Fix | Delete

* Performance test: auto generated page with ~900 lines of HTML code, 84 images (only 1 with background image).

[283] Fix | Delete

* - Smush 2.4.0: 1 match, 522510 steps (~355 ms)

[284] Fix | Delete

* - Smush 2.5.0: 1 match, 12611 steps, (~12 ms)

[285] Fix | Delete

[286] Fix | Delete

* @param string $content Page content.

[287] Fix | Delete

[288] Fix | Delete

* @return array

[289] Fix | Delete

[290] Fix | Delete

private static function get_background_images( $content ) {

[291] Fix | Delete

$images = array();

[292] Fix | Delete

[293] Fix | Delete

$pattern = '/(?:background-image:\s*?url$\s*[\'"]?(?P<img_url>.*?[^)\'"]+)[\'"]?\s*$)/i';

[294] Fix | Delete

// TODO: deprecate the following in favor of wp_smush_background_images_regex

[295] Fix | Delete

$pattern = apply_filters( 'smush_background_images_regex', $pattern );

[296] Fix | Delete

[297] Fix | Delete

if ( preg_match_all( $pattern, $content, $images ) ) {

[298] Fix | Delete

foreach ( $images as $key => $unused ) {

[299] Fix | Delete

// Simplify the output as much as possible, mostly for confirming test results.

[300] Fix | Delete

if ( is_numeric( $key ) && $key > 0 ) {

[301] Fix | Delete

unset( $images[ $key ] );

[302] Fix | Delete

}

[303] Fix | Delete

}

[304] Fix | Delete

}

[305] Fix | Delete

[306] Fix | Delete

/**

[307] Fix | Delete

* Make sure that the image doesn't start and end with ".

[308] Fix | Delete

[309] Fix | Delete

* @since 3.5.0

[310] Fix | Delete

[311] Fix | Delete

$images['img_url'] = array_map(

[312] Fix | Delete

function ( $image ) {

[313] Fix | Delete

// Quote entities.

[314] Fix | Delete

$quotes = apply_filters( 'wp_smush_background_image_quotes', array( '"', '"', ''', ''' ) );

[315] Fix | Delete

[316] Fix | Delete

$image = trim( $image );

[317] Fix | Delete

[318] Fix | Delete

// Remove the starting quotes.

[319] Fix | Delete

if ( in_array( substr( $image, 0, 6 ), $quotes, true ) ) {

[320] Fix | Delete

$image = substr( $image, 6 );

[321] Fix | Delete

}

[322] Fix | Delete

[323] Fix | Delete

// Remove the ending quotes.

[324] Fix | Delete

if ( in_array( substr( $image, -6 ), $quotes, true ) ) {

[325] Fix | Delete

$image = substr( $image, 0, -6 );

[326] Fix | Delete

}

[327] Fix | Delete

[328] Fix | Delete

return $image;

[329] Fix | Delete

[330] Fix | Delete

$images['img_url']

[331] Fix | Delete

);

[332] Fix | Delete

[333] Fix | Delete

return $images;

[334] Fix | Delete

}

[335] Fix | Delete

[336] Fix | Delete

/**

[337] Fix | Delete

* Add attribute to selected tag.

[338] Fix | Delete

[339] Fix | Delete

* @since 3.1.0

[340] Fix | Delete

* @since 3.2.0 Moved to WP_Smush_Content from \Smush\Core\Modules\CDN

[341] Fix | Delete

* @since 3.2.2 Moved to Parser from WP_Smush_Content

[342] Fix | Delete

[343] Fix | Delete

* @param string $element Image element.

[344] Fix | Delete

* @param string $name Img attribute name (srcset, size, etc).

[345] Fix | Delete

* @param string $value Attribute value.

[346] Fix | Delete

[347] Fix | Delete

public static function add_attribute( &$element, $name, $value = null ) {

[348] Fix | Delete

$closing = false === strpos( $element, '/>' ) ? '>' : ' />';

[349] Fix | Delete

$quotes = false === strpos( $element, '"' ) ? '\'' : '"';

[350] Fix | Delete

[351] Fix | Delete

if ( ! is_null( $value ) ) {

[352] Fix | Delete

$element = rtrim( $element, $closing ) . " {$name}={$quotes}{$value}{$quotes}{$closing}";

[353] Fix | Delete

} else {

[354] Fix | Delete

$element = rtrim( $element, $closing ) . " {$name}{$closing}";

[355] Fix | Delete

}

[356] Fix | Delete

}

[357] Fix | Delete

[358] Fix | Delete

/**

[359] Fix | Delete

* Get attribute from an HTML element.

[360] Fix | Delete

[361] Fix | Delete

* @since 3.2.0

[362] Fix | Delete

* @since 3.2.2 Moved to Parser from WP_Smush_Content

[363] Fix | Delete

[364] Fix | Delete

* @param string $element HTML element.

[365] Fix | Delete

* @param string $name Attribute name.

[366] Fix | Delete

[367] Fix | Delete

* @return string

[368] Fix | Delete

[369] Fix | Delete

public static function get_attribute( $element, $name ) {

[370] Fix | Delete

preg_match( "/{$name}=['\"]([^'\"]+)['\"]/is", $element, $value );

[371] Fix | Delete

return isset( $value['1'] ) ? $value['1'] : '';

[372] Fix | Delete

}

[373] Fix | Delete

[374] Fix | Delete

/**

[375] Fix | Delete

* Remove attribute from selected tag.

[376] Fix | Delete

[377] Fix | Delete

* @since 3.2.0

[378] Fix | Delete

* @since 3.2.2 Moved to Parser from WP_Smush_Content

[379] Fix | Delete

[380] Fix | Delete

* @param string $element Image element.

[381] Fix | Delete

* @param string $attribute Img attribute name (srcset, size, etc).

[382] Fix | Delete

[383] Fix | Delete

public static function remove_attribute( &$element, $attribute ) {

[384] Fix | Delete

$element = preg_replace( '/' . $attribute . '=[\'"](.*?)[\'"]/i', '', $element );

[385] Fix | Delete

}

[386] Fix | Delete

[387] Fix | Delete

/**

[388] Fix | Delete

* Get URLs from a string of content.

[389] Fix | Delete

[390] Fix | Delete

* This is mostly used to get the URLs from srcset and parse each single URL to use in CDN.

[391] Fix | Delete

[392] Fix | Delete

* Performance test: auto generated page with ~900 lines of HTML code, 84 images

[393] Fix | Delete

* - Smush 2.4.0: 11957 matches, 237227 steps (~169 ms) <- many false positive matches.

[394] Fix | Delete

* - Smush 2.5.0: 278 matches, 14509 steps, (~15 ms).

[395] Fix | Delete

[396] Fix | Delete

* @since 3.3.0

[397] Fix | Delete

[398] Fix | Delete

* @param string $content Content.

[399] Fix | Delete

[400] Fix | Delete

* @return array

[401] Fix | Delete

[402] Fix | Delete

public static function get_links_from_content( $content ) {

[403] Fix | Delete

$images = array();

[404] Fix | Delete

preg_match_all( '/(?:https?[^\s\'"]*)/is', $content, $images );

[405] Fix | Delete

return $images;

[406] Fix | Delete

}

[407] Fix | Delete

[408] Fix | Delete

}

[409] Fix | Delete

[410] Fix | Delete