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

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

admin-site-enhancements / classes Last commit date

class-svg-upload.php

259 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
81	if ( ! isset( $file['tmp_name'] ) ) {
82	return $file;
83	}
84
85	$file_tmp_name = $file['tmp_name']; // full path
86	$file_name = isset( $file['name'] ) ? $file['name'] : '';
87	$file_type_ext = wp_check_filetype_and_ext( $file_tmp_name, $file_name );
88	$file_type = ! empty( $file_type_ext['type'] ) ? $file_type_ext['type'] : '';
89
90	if ( 'image/svg+xml' === $file_type ) {
91
92	if ( ! class_exists( '\enshrined\svgSanitize\Sanitizer' ) ) {
93	// Load sanitizer library - https://github.com/darylldoyle/svg-sanitizer
94	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/data/AttributeInterface.php';
95	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/data/TagInterface.php';
96	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/data/AllowedAttributes.php';
97	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/data/AllowedTags.php';
98	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/data/XPath.php';
99	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/ElementReference/Resolver.php';
100	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/ElementReference/Subject.php';
101	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/ElementReference/Usage.php';
102	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/Exceptions/NestingException.php';
103	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/Helper.php';
104	require_once ASENHA_PATH . 'vendor/enshrined/svg-sanitize/src/Sanitizer.php';
105	}
106
107	// $sanitizer = new Sanitizer();
108	$sanitizer = new \enshrined\svgSanitize\Sanitizer();
109
110	$original_svg = file_get_contents( $file_tmp_name );
111	$sanitized_svg = $sanitizer->sanitize( $original_svg ); // boolean
112
113	if ( false === $sanitized_svg ) {
114
115	$file['error'] = 'This SVG file could not be sanitized, so, was not uploaded for security reasons.';
116
117	}
118
119	file_put_contents( $file_tmp_name, $sanitized_svg );
120
121	}
122
123	return $file;
124
125	}
126
127	/**
128	* Generate metadata for the svg attachment
129	*
130	* @link https://developer.wordpress.org/reference/functions/wp_generate_attachment_metadata/
131	* @since 2.6.0
132	*/
133	public function generate_svg_metadata( $metadata, $attachment_id, $context ) {
134
135	if ( get_post_mime_type( $attachment_id ) == 'image/svg+xml' ) {
136
137	// Get SVG dimensions
138	$svg_path = get_attached_file( $attachment_id );
139	$svg = simplexml_load_file( $svg_path );
140	$width = 0;
141	$height = 0;
142
143	if ( $svg ) {
144
145	$attributes = $svg->attributes();
146	if ( isset( $attributes->width, $attributes->height ) ) {
147	$width = intval( floatval( $attributes->width ) );
148	$height = intval( floatval( $attributes->height ) );
149	} elseif ( isset( $attributes->viewBox ) ) {
150	$sizes = explode( ' ', $attributes->viewBox );
151	if ( isset( $sizes[2], $sizes[3] ) ) {
152	$width = intval( floatval( $sizes[2] ) );
153	$height = intval( floatval( $sizes[3] ) );
154	}
155	}
156
157	}
158
159	$metadata['width'] = $width;
160	$metadata['height'] = $height;
161
162	// Get SVG filename
163	$svg_url = wp_get_original_image_url( $attachment_id );
164	$svg_url_path = str_replace( wp_upload_dir()['baseurl'] .'/' , '', $svg_url );
165	$metadata['file'] = $svg_url_path;
166
167	}
168
169	return $metadata;
170
171	}
172
173	/**
174	* Remove responsive image attributes, i.e. srcset attributes, from SVG images HTML
175	* This helps ensure SVGs are displayed properly on the frontend
176	*
177	* @link https://plugins.trac.wordpress.org/browser/svg-support/tags/2.5.7/functions/attachment.php#L282
178	* @since 7.3.0
179	*/
180	public function disable_svg_srcset( $sources ) {
181	$first_element = reset( $sources );
182
183	if ( isset( $first_element ) && ! empty( $first_element['url'] ) ) {
184	$extension = pathinfo( reset($sources)['url'], PATHINFO_EXTENSION );
185
186	if ( 'svg' === $extension ) {
187	$sources = array(); // return empty array
188	return $sources;
189	} else {
190	return $sources;
191	}
192	} else {
193	return $sources;
194	}
195	}
196
197	/**
198	* Remove responsive image attributes, i.e. srcset attributes, from SVG images HTML
199	* This helps ensure SVGs are displayed properly on the frontend
200	*
201	* @link https://gist.github.com/ericvalois/5b1e161c127632a1ace7d65ce1363e69
202	* @since 7.3.0
203	*/
204	public function remove_svg_responsive_image_attr( string $sizes, array $size, $image_src = null ) {
205	$explode = explode( '.', $image_src );
206	$extension = end( $explode );
207
208	if( 'svg' === $extension ){
209	$sizes = '';
210	}
211
212	return $sizes;
213	}
214
215	/**
216	* Return svg file URL to show preview in media library
217	*
218	* @link https://developer.wordpress.org/reference/hooks/wp_ajax_action/
219	* @link https://developer.wordpress.org/reference/functions/wp_get_attachment_url/
220	* @since 2.6.0
221	*/
222	public function get_svg_attachment_url() {
223
224	$attachment_url = '';
225	$attachment_id = isset( $_REQUEST['attachmentID'] ) ? $_REQUEST['attachmentID'] : '';
226
227	// Check response mime type
228	if ( $attachment_id ) {
229
230	echo esc_url( wp_get_attachment_url( $attachment_id ) );
231
232	die();
233
234	}
235
236	}
237
238	/**
239	* Return svg file URL to show preview in media library
240	*
241	* @link https://developer.wordpress.org/reference/functions/wp_prepare_attachment_for_js/
242	* @since 2.6.0
243	*/
244	public function get_svg_url_in_media_library( $response ) {
245
246	// Check response mime type
247	if ( $response['mime'] === 'image/svg+xml' ) {
248
249	$response['image'] = array(
250	'src' => $response['url'],
251	);
252
253	}
254
255	return $response;
256
257	}
258
259	}