class-svg-upload.php — Admin and Site Enhancements (ASE) 7.8.1

admin-site-enhancements / classes / class-svg-upload.php

admin-site-enhancements / classes Last commit date

class-svg-upload.php

289 lines

1	<?php
2
3	namespace ASENHA\Classes;
4
5	/**
6	* Class for SVG Upload module
7	*
8	* @since 6.9.5
9	*/
10	class SVG_Upload {
11
12	/**
13	* Add SVG mime type for media library uploads
14	*
15	* @link https://developer.wordpress.org/reference/hooks/upload_mimes/
16	* @since 2.6.0
17	*/
18	public function add_svg_mime( $mimes ) {
19
20	global $roles_svg_upload_enabled;
21
22	$current_user = wp_get_current_user();
23	$current_user_roles = (array) $current_user->roles; // single dimensional array of role slugs
24
25	if ( count( $roles_svg_upload_enabled ) > 0 ) {
26
27	// Add mime type for user roles set to enable SVG upload
28	foreach ( $current_user_roles as $role ) {
29	if ( in_array( $role, $roles_svg_upload_enabled ) ) {
30	$mimes['svg'] = 'image/svg+xml';
31	}
32	}
33
34	}
35
36	return $mimes;
37
38	}
39
40	/**
41	* Check and confirm if the real file type is indeed SVG
42	*
43	* @link https://developer.wordpress.org/reference/functions/wp_check_filetype_and_ext/
44	* @since 2.6.0
45	*/
46	public function confirm_file_type_is_svg( $filetypes_extensions, $file, $filename, $mimes ) {
47
48	global $roles_svg_upload_enabled;
49
50	$current_user = wp_get_current_user();
51	$current_user_roles = (array) $current_user->roles; // single dimensional array of role slugs
52
53	if ( count( $roles_svg_upload_enabled ) > 0 ) {
54
55	// Check file extension
56	if ( substr( $filename, -4 ) == '.svg' ) {
57
58	// Add mime type for user roles set to enable SVG upload
59	foreach ( $current_user_roles as $role ) {
60	if ( in_array( $role, $roles_svg_upload_enabled ) ) {
61	$filetypes_extensions['type'] = 'image/svg+xml';
62	$filetypes_extensions['ext'] = 'svg';
63	}
64	}
65
66	}
67
68	}
69
70	return $filetypes_extensions;
71
72	}
73
74	/**
75	* Sanitize the SVG file and maybe allow upload based on the result
76	*
77	* @since 2.6.0
78	*/
79	public function sanitize_and_maybe_allow_svg_upload( $file ) {
80	if ( ! isset( $file['tmp_name'] ) ) {
81	return $file;
82	}
83
84	$file_tmp_name = $file['tmp_name']; // full path
85	$file_name = isset( $file['name'] ) ? $file['name'] : '';
86	$file_type_ext = wp_check_filetype_and_ext( $file_tmp_name, $file_name );
87	$file_type = ! empty( $file_type_ext['type'] ) ? $file_type_ext['type'] : '';
88
89	if ( 'image/svg+xml' === $file_type ) {
90	$original_svg = file_get_contents( $file_tmp_name );
91
92	$sanitizer = $this->get_svg_sanitizer();
93	$sanitized_svg = $sanitizer->sanitize( $original_svg ); // boolean
94
95	if ( false === $sanitized_svg ) {
96
97	$file['error'] = 'This SVG file could not be sanitized, so, was not uploaded for security reasons.';
98
99	}
100
101	file_put_contents( $file_tmp_name, $sanitized_svg );
102	}
103
104	return $file;
105	}
106
107	/**
108	* Sanitize a file after it is added to the media library, e.g. via REST API POST request
109	*
110	* @since 7.5.2
111	*/
112	public function sanitize_after_upload( $attachment, $request, $creating ) {
113	// Let's sanitize SVG upon creation/insertion in the media library.
114	if ( $creating ) {
115	if ( $attachment instanceof WP_Post ) {
116	$file_path = get_attached_file( $attachment->ID );
117	$original_svg = file_get_contents( $file_path );
118
119	$sanitizer = $this->get_svg_sanitizer();
120	$sanitized_svg = $sanitizer->sanitize( $original_svg ); // boolean
121
122	if ( false !== $sanitized_svg ) {
123	// Sanitization was a success, let's write the result back to the file
124	file_put_contents( $file_path, $sanitized_svg );
125	}
126	}
127	}
128	}
129
130	/**
131	* Get sanitizer object
132	*
133	* @since 7.5.2
134	*/
135	public function get_svg_sanitizer() {
136	if ( ! class_exists( '\enshrined\svgSanitize\Sanitizer' ) ) {
137	// Load sanitizer library - https://github.com/darylldoyle/svg-sanitizer
138	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/data/AttributeInterface.php';
139	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/data/TagInterface.php';
140	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/data/AllowedAttributes.php';
141	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/data/AllowedTags.php';
142	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/data/XPath.php';
143	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/ElementReference/Resolver.php';
144	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/ElementReference/Subject.php';
145	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/ElementReference/Usage.php';
146	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/Exceptions/NestingException.php';
147	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/Helper.php';
148	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/Sanitizer.php';
149	}
150
151	// $sanitizer = new Sanitizer();
152	$sanitizer = new \enshrined\svgSanitize\Sanitizer();
153
154	return $sanitizer;
155	}
156
157	/**
158	* Generate metadata for the svg attachment
159	*
160	* @link https://developer.wordpress.org/reference/functions/wp_generate_attachment_metadata/
161	* @since 2.6.0
162	*/
163	public function generate_svg_metadata( $metadata, $attachment_id, $context ) {
164
165	if ( get_post_mime_type( $attachment_id ) == 'image/svg+xml' ) {
166
167	// Get SVG dimensions
168	$svg_path = get_attached_file( $attachment_id );
169	$svg = simplexml_load_file( $svg_path );
170	$width = 0;
171	$height = 0;
172
173	if ( $svg ) {
174
175	$attributes = $svg->attributes();
176	if ( isset( $attributes->width, $attributes->height ) ) {
177	$width = intval( floatval( $attributes->width ) );
178	$height = intval( floatval( $attributes->height ) );
179	} elseif ( isset( $attributes->viewBox ) ) {
180	$sizes = explode( ' ', $attributes->viewBox );
181	if ( isset( $sizes[2], $sizes[3] ) ) {
182	$width = intval( floatval( $sizes[2] ) );
183	$height = intval( floatval( $sizes[3] ) );
184	}
185	}
186
187	}
188
189	$metadata['width'] = $width;
190	$metadata['height'] = $height;
191
192	// Get SVG filename
193	$svg_url = wp_get_original_image_url( $attachment_id );
194	$svg_url_path = str_replace( wp_upload_dir()['baseurl'] .'/' , '', $svg_url );
195	$metadata['file'] = $svg_url_path;
196
197	}
198
199	return $metadata;
200
201	}
202
203	/**
204	* Remove responsive image attributes, i.e. srcset attributes, from SVG images HTML
205	* This helps ensure SVGs are displayed properly on the frontend
206	*
207	* @link https://plugins.trac.wordpress.org/browser/svg-support/tags/2.5.7/functions/attachment.php#L282
208	* @since 7.3.0
209	*/
210	public function disable_svg_srcset( $sources ) {
211	$first_element = reset( $sources );
212
213	if ( isset( $first_element ) && ! empty( $first_element['url'] ) ) {
214	$extension = pathinfo( reset($sources)['url'], PATHINFO_EXTENSION );
215
216	if ( 'svg' === $extension ) {
217	$sources = array(); // return empty array
218	return $sources;
219	} else {
220	return $sources;
221	}
222	} else {
223	return $sources;
224	}
225	}
226
227	/**
228	* Remove responsive image attributes, i.e. srcset attributes, from SVG images HTML
229	* This helps ensure SVGs are displayed properly on the frontend
230	*
231	* @link https://gist.github.com/ericvalois/5b1e161c127632a1ace7d65ce1363e69
232	* @since 7.3.0
233	*/
234	public function remove_svg_responsive_image_attr( string $sizes, $size, $image_src = null ) {
235	$explode = explode( '.', $image_src );
236	$extension = end( $explode );
237
238	if( 'svg' === $extension ){
239	$sizes = '';
240	}
241
242	return $sizes;
243	}
244
245	/**
246	* Return svg file URL to show preview in media library
247	*
248	* @link https://developer.wordpress.org/reference/hooks/wp_ajax_action/
249	* @link https://developer.wordpress.org/reference/functions/wp_get_attachment_url/
250	* @since 2.6.0
251	*/
252	public function get_svg_attachment_url() {
253
254	$attachment_url = '';
255	$attachment_id = isset( $_REQUEST['attachmentID'] ) ? $_REQUEST['attachmentID'] : '';
256
257	// Check response mime type
258	if ( $attachment_id ) {
259
260	echo esc_url( wp_get_attachment_url( $attachment_id ) );
261
262	die();
263
264	}
265
266	}
267
268	/**
269	* Return svg file URL to show preview in media library
270	*
271	* @link https://developer.wordpress.org/reference/functions/wp_prepare_attachment_for_js/
272	* @since 2.6.0
273	*/
274	public function get_svg_url_in_media_library( $response ) {
275
276	// Check response mime type
277	if ( $response['mime'] === 'image/svg+xml' ) {
278
279	$response['image'] = array(
280	'src' => $response['url'],
281	);
282
283	}
284
285	return $response;
286
287	}
288
289	}