diff --git a/CHANGELOG.md b/CHANGELOG.md index 2834838f..d8eb491b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,13 +4,25 @@ All notable changes to this project will be documented in this file, per [the Ke ## [Unreleased] - TBD +## [2.0.0] - 2022-04-06 +### Added +- New filter, `safe_svg_use_width_height_attributes`, that can be used to change the order of attributes we use to determine the SVG dimensions (props [@dkotter](https://github.com/dkotter), [@peterwilsoncc](https://github.com/peterwilsoncc) via [#43](https://github.com/10up/safe-svg/pull/43)). + +### Changed +- Documentation updates (props [@j-hoffmann](https://github.com/j-hoffmann), [@jeffpaul](https://github.com/jeffpaul), [@Zodiac1978](https://github.com/Zodiac1978) via [#39](https://github.com/10up/safe-svg/pull/39), [#42](https://github.com/10up/safe-svg/pull/42)). + +### Fixed +- Use the `viewBox` attributes first for image dimensions. Ensure we don't use image dimensions that end with percent signs (props [@dkotter](https://github.com/dkotter), [@peterwilsoncc](https://github.com/peterwilsoncc) via [#43](https://github.com/10up/safe-svg/pull/43)). +- Make sure we use the full size SVG dimensions rather than the requested size, to avoid wrong sizes being used and duplicate height and width attributes (props [@dkotter](https://github.com/dkotter), [@cadic](https://github.com/cadic) via [#44](https://github.com/10up/safe-svg/pull/44)). +- Ensure the `tmp_name` and `name` properties exist before we use them (props [@dkotter](https://github.com/dkotter), [@aksld](https://github.com/aksld) via [#46](https://github.com/10up/safe-svg/pull/46)). + ## [1.9.10] - 2022-02-23 **Note that this release bumps the WordPress minimum version from 4.0 to 4.7 and the PHP minimum version from 5.6 to 7.0.** ### Changed - Bump WordPress minimum version from 4.0 to 4.7 (props [@cadic](https://github.com/cadic) via [#32](https://github.com/10up/safe-svg/pull/32)). - Bump PHP minimum version from 5.6 to 7.0 (props [@mehidi258](https://github.com/mehidi258), [@iamdharmesh](https://github.com/iamdharmesh), [@amdd-tim](https://github.com/amdd-tim), [@darylldoyle](https://github.com/darylldoyle), [@jeffpaul](https://github.com/jeffpaul) via [#20](https://github.com/10up/safe-svg/pull/20)). -- Update `enshrined/svg-sanitize` from 0.13.3 to 0.5.2 (props [@mehidi258](https://github.com/mehidi258), [@iamdharmesh](https://github.com/iamdharmesh), [@amdd-tim](https://github.com/amdd-tim), [@darylldoyle](https://github.com/darylldoyle), [@jeffpaul](https://github.com/jeffpaul), [@cadic](https://github.com/cadic) via [#20](https://github.com/10up/safe-svg/pull/20), [#29](https://github.com/10up/safe-svg/pull/29)). +- Update `enshrined/svg-sanitize` from 0.13.3 to 0.15.2 (props [@mehidi258](https://github.com/mehidi258), [@iamdharmesh](https://github.com/iamdharmesh), [@amdd-tim](https://github.com/amdd-tim), [@darylldoyle](https://github.com/darylldoyle), [@jeffpaul](https://github.com/jeffpaul), [@cadic](https://github.com/cadic) via [#20](https://github.com/10up/safe-svg/pull/20), [#29](https://github.com/10up/safe-svg/pull/29)). - Bump WordPress version "tested up to" 5.9 (props [@BBerg10up](https://github.com/BBerg10up), [@jeffpaul](https://github.com/jeffpaul), [@cadic](https://github.com/cadic) via [#14](https://github.com/10up/safe-svg/pull/14), [#27](https://github.com/10up/safe-svg/pull/27)). - Updated library location and added a new build step (props [@darylldoyle](https://github.com/darylldoyle), [@dkotter](https://github.com/dkotter) via [#35](https://github.com/10up/safe-svg/pull/35), [#36](https://github.com/10up/safe-svg/pull/36)). - Updated plugin assets and added docs and repo management workflows via GitHub Actions (props [Brooke Campbell](https://www.linkedin.com/in/brookecampbelldesign/), [@jeffpaul](https://github.com/jeffpaul) via [#16](https://github.com/10up/safe-svg/pull/16), [#26](https://github.com/10up/safe-svg/pull/26)). @@ -186,6 +198,7 @@ All notable changes to this project will be documented in this file, per [the Ke - Initial Release. [Unreleased]: https://github.com/10up/safe-svg/compare/trunk...develop +[2.0.0]: https://github.com/10up/safe-svg/compare/1.9.10...2.0.0 [1.9.10]: https://github.com/10up/safe-svg/compare/1.9.9...1.9.10 [1.9.9]: https://github.com/10up/safe-svg/compare/1.9.8...1.9.9 [1.9.8]: https://github.com/10up/safe-svg/compare/1.9.7...1.9.8 diff --git a/CREDITS.md b/CREDITS.md index 1065ac8e..f2e08f79 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -12,7 +12,7 @@ The following individuals are responsible for curating the list of issues, respo Thank you to all the people who have already contributed to this repository via bug reports, code, design, ideas, project management, translation, testing, etc. -[Daryll Doyle (@darylldoyle)](https://github.com/darylldoyle), [Lewis Cowles (@LewisCowles1986)](https://github.com/LewisCowles1986), [Daniel M. Hendricks (@dmhendricks)](https://github.com/dmhendricks), [Dan Pock (@mallardduck)](https://github.com/mallardduck), [K. Adam White (@kadamwhite)](https://github.com/kadamwhite), [Joe Hoyle (@joehoyle)](https://github.com/joehoyle), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [Brandon Berg (@BBerg10up)](https://github.com/BBerg10up), [Max Lyuchin (@cadic)](https://github.com/cadic), [Mehidi Hassan (@mehidi258)](https://github.com/mehidi258), [Dharmesh Patel (@iamdharmesh)](https://github.com/iamdharmesh), [Timothy Decker (@amdd-tim)](https://github.com/amdd-tim), [Brooke Campbell](https://www.linkedin.com/in/brookecampbelldesign/), [Mehul Kaklotar (@mehulkaklotar)](https://github.com/mehulkaklotar), [@smerriman](https://github.com/smerriman), [Darin Kotter (@dkotter)](https://github.com/dkotter), [Manuel Friedli (@fritteli)](https://github.com/fritteli), [David Hamann (@davidhamann)](https://github.com/davidhamann). +[Daryll Doyle (@darylldoyle)](https://github.com/darylldoyle), [Lewis Cowles (@LewisCowles1986)](https://github.com/LewisCowles1986), [Daniel M. Hendricks (@dmhendricks)](https://github.com/dmhendricks), [Dan Pock (@mallardduck)](https://github.com/mallardduck), [K. Adam White (@kadamwhite)](https://github.com/kadamwhite), [Joe Hoyle (@joehoyle)](https://github.com/joehoyle), [Jeffrey Paul (@jeffpaul)](https://github.com/jeffpaul), [Brandon Berg (@BBerg10up)](https://github.com/BBerg10up), [Max Lyuchin (@cadic)](https://github.com/cadic), [Mehidi Hassan (@mehidi258)](https://github.com/mehidi258), [Dharmesh Patel (@iamdharmesh)](https://github.com/iamdharmesh), [Timothy Decker (@amdd-tim)](https://github.com/amdd-tim), [Brooke Campbell](https://www.linkedin.com/in/brookecampbelldesign/), [Mehul Kaklotar (@mehulkaklotar)](https://github.com/mehulkaklotar), [@smerriman](https://github.com/smerriman), [Darin Kotter (@dkotter)](https://github.com/dkotter), [Manuel Friedli (@fritteli)](https://github.com/fritteli), [David Hamann (@davidhamann)](https://github.com/davidhamann), [@j-hoffmann](https://github.com/j-hoffmann), [Peter Wilson (@peterwilsoncc)](https://github.com/peterwilsoncc), [Torsten Landsiedel (@Zodiac1978)](https://github.com/Zodiac1978), [Axel DUCORON (@aksld)](https://github.com/aksld). ## Libraries diff --git a/composer.json b/composer.json index 22b907ce..6cc87014 100644 --- a/composer.json +++ b/composer.json @@ -2,11 +2,21 @@ "name": "darylldoyle/safe-svg", "description": "Enable SVG uploads and sanitize them to stop XML/SVG vulnerabilities in your WordPress website", "type": "wordpress-plugin", + "homepage": "https://github.com/10up/safe-svg", + "readme": "https://github.com/10up/safe-svg/blob/develop/README.md", "license": "GPL-2.0-or-later", "authors": [ + { + "name": "10up", + "email": "opensource@10up.com", + "homepage": "https://10up.com/", + "role": "Developer" + }, { "name": "Daryll Doyle", - "homepage": "https://wpsvg.com/" + "email": "daryll@enshrined.co.uk", + "homepage": "http://enshrined.co.uk/", + "role": "Developer" } ], "require": { diff --git a/readme.txt b/readme.txt index e67450bb..61c87bfb 100644 --- a/readme.txt +++ b/readme.txt @@ -3,7 +3,7 @@ Contributors: 10up, enshrined Tags: svg, sanitize, upload, sanitise, security, svg upload, image, vector, file, graphic, media, mime Requires at least: 4.7 Tested up to: 5.9 -Stable tag: 1.9.10 +Stable tag: 2.0.0 Requires PHP: 7.0 License: GPLv2 or later License URI: http://www.gnu.org/licenses/gpl-2.0.html @@ -66,12 +66,19 @@ They take one argument that must be returned. See below for examples: == Changelog == += 2.0.0 - 2022-04-06 = +* **Added:** New filter, `safe_svg_use_width_height_attributes`, that can be used to change the order of attributes we use to determine the SVG dimensions (props [@dkotter](https://github.com/dkotter), [@peterwilsoncc](https://github.com/peterwilsoncc)). +* **Changed:** Documentation updates (props [@j-hoffmann](https://github.com/j-hoffmann), [@jeffpaul](https://github.com/jeffpaul), [@Zodiac1978](https://github.com/Zodiac1978)). +* **Fixed:** Use the `viewBox` attributes first for image dimensions. Ensure we don't use image dimensions that end with percent signs (props [@dkotter](https://github.com/dkotter), [@peterwilsoncc](https://github.com/peterwilsoncc)). +* **Fixed:** Make sure we use the full size SVG dimensions rather than the requested size, to avoid wrong sizes being used and duplicate height and width attributes (props [@dkotter](https://github.com/dkotter), [@cadic](https://github.com/cadic)). +* **Fixed:** Ensure the `tmp_name` and `name` properties exist before we use them (props [@dkotter](https://github.com/dkotter), [@aksld](https://github.com/aksld)). + = 1.9.10 - 2022-02-23 = **Note that this release bumps the WordPress minimum version from 4.0 to 4.7 and the PHP minimum version from 5.6 to 7.0.** * **Changed:** Bump WordPress minimum version from 4.0 to 4.7 (props [@cadic](https://github.com/cadic)). * **Changed:** Bump PHP minimum version from 5.6 to 7.0 (props [@mehidi258](https://github.com/mehidi258), [@iamdharmesh](https://github.com/iamdharmesh), [@amdd-tim](https://github.com/amdd-tim), [@darylldoyle](https://github.com/darylldoyle), [@jeffpaul](https://github.com/jeffpaul)). -* **Changed:** Update `enshrined/svg-sanitize` from 0.13.3 to 0.5.2 (props [@mehidi258](https://github.com/mehidi258), [@iamdharmesh](https://github.com/iamdharmesh), [@amdd-tim](https://github.com/amdd-tim), [@darylldoyle](https://github.com/darylldoyle), [@jeffpaul](https://github.com/jeffpaul), [@cadic](https://github.com/cadic)). +* **Changed:** Update `enshrined/svg-sanitize` from 0.13.3 to 0.15.2 (props [@mehidi258](https://github.com/mehidi258), [@iamdharmesh](https://github.com/iamdharmesh), [@amdd-tim](https://github.com/amdd-tim), [@darylldoyle](https://github.com/darylldoyle), [@jeffpaul](https://github.com/jeffpaul), [@cadic](https://github.com/cadic)). * **Changed:** Bump WordPress version "tested up to" 5.9 (props [@BBerg10up](https://github.com/BBerg10up), [@jeffpaul](https://github.com/jeffpaul), [@cadic](https://github.com/cadic)). * **Changed:** Updated library location and added a new build step (props [@darylldoyle](https://github.com/darylldoyle), [@dkotter](https://github.com/dkotter)). * **Changed:** Updated plugin assets and added docs and repo management workflows via GitHub Actions (props [Brooke Campbell](https://www.linkedin.com/in/brookecampbelldesign/), [@jeffpaul](https://github.com/jeffpaul)). @@ -80,120 +87,120 @@ They take one argument that must be returned. See below for examples: * **Fixed:** Use calculated size for SVGs instead of using `false` (props [@dkotter](https://github.com/dkotter), [@darylldoyle](https://github.com/darylldoyle), [@fritteli](https://github.com/fritteli)). * **Fixed:** Add better file type checking when looking for SVG files (props [@davidhamann](https://github.com/davidhamann), [@dkotter](https://github.com/dkotter), [@darylldoyle](https://github.com/darylldoyle)). -= 1.9.9 - 2020-05-07= += 1.9.9 - 2020-05-07 = * **Fixed:** Issue where 100% width is accidentally converted to 100px width (props [@joehoyle](https://github.com/joehoyle)). -= 1.9.8 - 2020-05-07= += 1.9.8 - 2020-05-07 = * **Changed:** Underlying library update. -= 1.9.7 - 2019-12-10= += 1.9.7 - 2019-12-10 = * **Changed:** Underlying library update. -= 1.9.6 - 2019-11-07= += 1.9.6 - 2019-11-07 = * **Security:** Underlying library update that fixes a security issue. -= 1.9.5 - 2019-11-04= += 1.9.5 - 2019-11-04 = * **Security:** Underlying library update that fixes some security issues. -= 1.9.4 - 2019-08-21= += 1.9.4 - 2019-08-21 = * **Fixed:** Bug causing lots of error log output to do with `safe_svg::fix_direct_image_output()`. -= 1.9.3 - 2019-02-19= += 1.9.3 - 2019-02-19 = * **Fixed:** Bug causing 0 height and width SVGs. -= 1.9.2 - 2019-02-14= += 1.9.2 - 2019-02-14 = * **Fixed:** Warning about an Illegal string offset. * **Fixed:** Issue if something other than a WP_Post object is passed in via the `wp_get_attachment_image_attributes` filter. -= 1.9.1 - 2019-01-29= += 1.9.1 - 2019-01-29 = * **Fixed:** Warning that was being generated by a change made in 1.9.0. -= 1.9.0 - 2019-01-03= += 1.9.0 - 2019-01-03 = * **Changed:** If an image is the correct ratio, allow skipping of the crop popup when setting header/logo images with SVGs. -= 1.8.1 - 2018-11-22= += 1.8.1 - 2018-11-22 = * **Changed:** Don't let errors break upload if uploading an empty file * **Fixed:** Featured image display in Gutenberg. Props [@dmhendricks](https://github.com/dmhendricks) :) -= 1.8.0 - 2018-11-04= += 1.8.0 - 2018-11-04 = * **Added:** Pull SVG dimensions from the width/height or viewbox attributes of the SVG. * **Added:** role="img" attribute to SVGs. -= 1.7.1 - 2018-10-01= += 1.7.1 - 2018-10-01 = * **Changed:** Underlying lib and added new filters for filtering allowed tags and attributes. -= 1.7.0 - 2018-10-01= += 1.7.0 - 2018-10-01 = * **Added:** Allow devs to filter tags and attrs within WordPress. -= 1.6.1 - 2018-03-17= += 1.6.1 - 2018-03-17 = * **Changed:** Images will now use the size chosen when inserted into the page rather than default to 2000px everytime. -= 1.6.0 - 2017-12-20= += 1.6.0 - 2017-12-20 = * **Added:** Fairly big new feature - The library now allows `` elements as long as they don't reference external files! * **Fixed:** You can now also embed safe image types within the SVG and not have them stripped (PNG, GIF, JPG). -= 1.5.3 - 2017-11-16= += 1.5.3 - 2017-11-16 = * **Fixed:** 1.5.2 introduced an issue that can freeze the media library. This fixes that issue. Sorry! -= 1.5.2 - 2017-11-15= += 1.5.2 - 2017-11-15 = * **Changed:** Tested with 4.9.0. * **Fixed:** Issue with SVGs when regenerating media. -= 1.5.1 - 2017-08-21= += 1.5.1 - 2017-08-21 = * **Fixed:** PHP strict standards warning. -= 1.5.0 - 2017-06-20= += 1.5.0 - 2017-06-20 = * **Changed:** Library update. * **Changed:** role, aria- and data- attributes are now whitelisted to improve accessibility. -= 1.4.5 - 2017-06-18= += 1.4.5 - 2017-06-18 = * **Changed:** Library update. * **Fixed:** some issues with defining the size of an SVG. -= 1.4.4 - 2017-06-07= += 1.4.4 - 2017-06-07 = * **Fixed:** SVGs now display as featured images in the admin area. -= 1.4.3 - 2017-03-06= += 1.4.3 - 2017-03-06 = * **Added:** WordPress 4.7.3 Compatibility. * **Changed:** Expanded SVG previews in media library. -= 1.4.2 - 2017-02-26= += 1.4.2 - 2017-02-26 = * **Added:** Check / fix for when mb_* functions are not available. -= 1.4.1 - 2017-02-23= += 1.4.1 - 2017-02-23 = * **Changed:** Underlying library to allow attributes/tags in all case variations. -= 1.4.0 - 2017-02-21= += 1.4.0 - 2017-02-21 = * **Added:** Ability to preview SVG on both grid and list view in the wp-admin media area * **Changed:** Underlying library version. -= 1.3.4 - 2017-02-20= += 1.3.4 - 2017-02-20 = * **Fixed:** SVGZ uploads failing and not sanitising correctly. -= 1.3.3 - 2017-02-15= += 1.3.3 - 2017-02-15 = * **Changed:** Allow SVGZ uploads. -= 1.3.2 - 2017-01-27= += 1.3.2 - 2017-01-27 = * **Fixed:** Mime type issue in 4.7.1. Mad props to [@LewisCowles1986](https://github.com/LewisCowles1986). -= 1.3.1 - 2016-12-01= += 1.3.1 - 2016-12-01 = * **Changed:** Underlying library version. -= 1.3.0 - 2016-10-10= += 1.3.0 - 2016-10-10 = * **Changed:** Minify SVGs after cleaning so they can be loaded correctly through `file_get_contents`. -= 1.2.0 - 2016-02-27= += 1.2.0 - 2016-02-27 = * **Added:** Support for camel case attributes such as viewBox. -= 1.1.1 - 2016-07-06= += 1.1.1 - 2016-07-06 = * **Fixed:** Issue with empty svg elements self-closing. -= 1.1.0 - 2015-07-04= += 1.1.0 - 2015-07-04 = * **Added:** I18n. * **Added:** da, de ,en, es, fr, nl and ru translations. * **Fixed:** Issue with filename not being pulled over on failed uploads. -= 1.0.0 - 2015-07-03= += 1.0.0 - 2015-07-03 = * Initial Release. == Upgrade Notice == diff --git a/safe-svg.php b/safe-svg.php index 7b52e264..37069a9f 100644 --- a/safe-svg.php +++ b/safe-svg.php @@ -1,9 +1,9 @@ svg_dimensions( get_attached_file( $attachment_id ) ); - if ( empty( $image[2] ) ) { + if ( $dimensions ) { + $image[1] = $dimensions['width']; + $image[2] = $dimensions['height']; + } else { + $image[1] = 100; $image[2] = 100; } } @@ -454,7 +462,7 @@ function metadata_error_fix( $data, $post_id ) { /** * Get SVG size from the width/height or viewport. * - * @param $svg + * @param string|false $svg The file path to where the SVG file should be, false otherwise. * * @return array|bool */ @@ -464,16 +472,43 @@ protected function svg_dimensions( $svg ) { $height = 0; if ( $svg ) { $attributes = $svg->attributes(); - if ( isset( $attributes->width, $attributes->height ) && is_numeric( (float)$attributes->width ) && is_numeric( (float)$attributes->height ) ) { - $width = floatval( $attributes->width ); - $height = floatval( $attributes->height ); - } elseif ( isset( $attributes->viewBox ) ) { + + if ( isset( $attributes->viewBox ) ) { $sizes = explode( ' ', $attributes->viewBox ); if ( isset( $sizes[2], $sizes[3] ) ) { - $width = floatval( $sizes[2] ); - $height = floatval( $sizes[3] ); + $viewbox_width = floatval( $sizes[2] ); + $viewbox_height = floatval( $sizes[3] ); } + } + + if ( isset( $attributes->width, $attributes->height ) && is_numeric( (float) $attributes->width ) && is_numeric( (float) $attributes->height ) && ! $this->str_ends_with( (string) $attributes->width, '%' ) && ! $this->str_ends_with( (string) $attributes->height, '%' ) ) { + $attr_width = floatval( $attributes->width ); + $attr_height = floatval( $attributes->height ); + } + + /** + * Decide which attributes of the SVG we use first for image tag dimensions. + * + * We default to using the parameters in the viewbox attribute but + * that can be overridden using this filter if you'd prefer to use + * the width and height attributes. + * + * @hook safe_svg_use_width_height_attributes + * + * @param {bool} $false If the width & height attributes should be used first. Default false. + * @param {string} $svg The file path to the SVG. + * + * @return {bool} If we should use the width & height attributes first or not. + */ + if ( (bool) apply_filters( 'safe_svg_use_width_height_attributes', false, $svg ) ) { + $width = $attr_width; + $height = $attr_height; } else { + $width = $viewbox_width; + $height = $viewbox_height; + } + + if ( ! $width && ! $height ) { return false; } } @@ -486,39 +521,49 @@ protected function svg_dimensions( $svg ) { } /** - * Fix the output of images using wp_get_attachment_image + * Disable the creation of srcset on SVG images. + * + * @param array $image_meta The image meta data. + * @param int[] $size_array { + * An array of requested width and height values. * - * @param array $attr Attributes for the image markup. - * @param WP_Post $attachment Image attachment post. - * @param string|array $size Requested size. Image size or array of width and height values - * (in that order). Default 'thumbnail'. + * @type int $0 The width in pixels. + * @type int $1 The height in pixels. + * } + * @param string $image_src The 'src' of the image. + * @param int $attachment_id The image attachment ID. */ - public function fix_direct_image_output( $attr, $attachment, $size = 'thumbnail' ) { - - // If we're not getting a WP_Post object, bail early. - // @see https://wordpress.org/support/topic/notice-trying-to-get-property-id/ - if ( ! $attachment instanceof WP_Post ) { - return $attr; + public function disable_srcset( $image_meta, $size_array, $image_src, $attachment_id ) { + if ( $attachment_id && 'image/svg+xml' === get_post_mime_type( $attachment_id ) ) { + $image_meta['sizes'] = array(); } - $mime = get_post_mime_type( $attachment->ID ); - if ( 'image/svg+xml' === $mime ) { - $default_height = 100; - $default_width = 100; - - $dimensions = $this->svg_dimensions( get_attached_file( $attachment->ID ) ); + return $image_meta; + } - if ( $dimensions ) { - $default_height = $dimensions['height']; - $default_width = $dimensions['width']; - } + /** + * Polyfill for `str_ends_with()` function added in PHP 8.0. + * + * Performs a case-sensitive check indicating if + * the haystack ends with needle. + * + * @param string $haystack The string to search in. + * @param string $needle The substring to search for in the `$haystack`. + * @return bool True if `$haystack` ends with `$needle`, otherwise false. + */ + protected function str_ends_with( $haystack, $needle ) { + if ( function_exists( 'str_ends_with' ) ) { + return str_ends_with( $haystack, $needle ); + } - $attr['height'] = $default_height; - $attr['width'] = $default_width; + if ( '' === $haystack && '' !== $needle ) { + return false; } - return $attr; + $len = strlen( $needle ); + return 0 === substr_compare( $haystack, $needle, -$len, $len ); } + } }