class-image-upload-control.php — Admin and Site Enhancements (ASE) 7.6.10

admin-site-enhancements / classes / class-image-upload-control.php

admin-site-enhancements / classes Last commit date

class-image-upload-control.php

473 lines

1	<?php
2
3	namespace ASENHA\Classes;
4
5	use Imagick;
6	/**
7	* Class for Image Upload Control module
8	*
9	* @since 6.9.5
10	*/
11	class Image_Upload_Control {
12	public $png_is_transparent;
13
14	/**
15	* Array storing the file names that were processed, as keys.
16	*
17	* @since 7.5.0
18	* @link https://plugins.trac.wordpress.org/browser/fix-image-rotation/tags/2.2.2/includes/class-fix-image-rotation.php#L30
19	*
20	* @access private
21	*
22	* @var array
23	*/
24	private $orientation_fixed;
25
26	/**
27	* Array storing the meta data of original files in case it
28	* needs to be restored later.
29	*
30	* @since 7.5.0
31	* @link https://plugins.trac.wordpress.org/browser/fix-image-rotation/tags/2.2.2/includes/class-fix-image-rotation.php#L42
32	*
33	* @access private
34	*
35	* @var array
36	*/
37	private $previous_meta;
38
39	/**
40	* Constructor
41	* @since 7.4.3
42	*/
43	function __construct() {
44	$this->png_is_transparent = false;
45	$this->orientation_fixed = array();
46	$this->previous_meta = array();
47	}
48
49	/**
50	* Handler for image uploads. Convert and resize images.
51	*
52	* @since 4.3.0
53	*/
54	public function image_upload_handler( $upload ) {
55	$applicable_mime_types = array(
56	'image/bmp',
57	'image/x-ms-bmp',
58	'image/png',
59	'image/jpeg',
60	'image/jpg',
61	'image/webp'
62	);
63	if ( in_array( $upload['type'], $applicable_mime_types ) ) {
64	// Exlude from conversion and resizing images with filenames ending with '-nr', e.g. birds-nr.png
65	if ( false !== strpos( $upload['file'], '-nr.' ) ) {
66	return $upload;
67	}
68	// Convert BMP
69	if ( 'image/bmp' === $upload['type'] \|\| 'image/x-ms-bmp' === $upload['type'] ) {
70	$upload = $this->maybe_convert_image( 'bmp', $upload );
71	}
72	// Convert PNG without transparency
73	if ( 'image/png' === $upload['type'] ) {
74	$upload = $this->maybe_convert_image( 'png', $upload );
75	}
76	// At this point, BMPs and non-transparent PNGs are already converted to JPGs, unless excluded with '-nr' suffix.
77	// Let's perform resize operation as needed, i.e. if image dimension is larger than specified
78	$mime_types_to_resize = array(
79	'image/jpeg',
80	'image/jpg',
81	'image/png',
82	'image/webp'
83	);
84	if ( !is_wp_error( $upload ) && in_array( $upload['type'], $mime_types_to_resize ) && filesize( $upload['file'] ) > 0 ) {
85	// https://developer.wordpress.org/reference/classes/wp_image_editor/
86	$wp_image_editor = wp_get_image_editor( $upload['file'] );
87	if ( !is_wp_error( $wp_image_editor ) ) {
88	$image_size = $wp_image_editor->get_size();
89	$options = get_option( ASENHA_SLUG_U, array() );
90	$max_width = $options['image_max_width'];
91	$max_height = $options['image_max_height'];
92	// Check upload image's dimension and only resize if larger than the defined max dimension
93	if ( isset( $image_size['width'] ) && $image_size['width'] > $max_width \|\| isset( $image_size['height'] ) && $image_size['height'] > $max_height ) {
94	$wp_image_editor->resize( $max_width, $max_height, false );
95	// false is for no cropping
96	if ( 'image/jpg' === $upload['type'] \|\| 'image/jpeg' === $upload['type'] ) {
97	$wp_image_editor->set_quality( 90 );
98	// default is 82
99	}
100	$wp_image_editor->save( $upload['file'] );
101	}
102	}
103	}
104	}
105	return $upload;
106	}
107
108	/**
109	* Convert BMP or PNG without transparency into JPG
110	*
111	* @since 4.3.0
112	*/
113	public function maybe_convert_image( $file_extension, $upload ) {
114	$image_object = null;
115	// Get image object from uploaded BMP/PNG
116	if ( 'bmp' === $file_extension ) {
117	if ( is_file( $upload['file'] ) ) {
118	// Generate image object from BMP for conversion to JPG later
119	if ( function_exists( 'imagecreatefrombmp' ) ) {
120	// PHP >= v7.2
121	$image_object = imagecreatefrombmp( $upload['file'] );
122	} else {
123	// PHP < v7.2
124	require_once ASENHA_PATH . 'includes/bmp-to-image-object.php';
125	$image_object = bmp_to_image_object( $upload['file'] );
126	}
127	}
128	}
129	if ( 'png' === $file_extension ) {
130	// Detect alpha/transparency in PNG
131	$this->png_is_transparent = false;
132	if ( is_file( $upload['file'] ) ) {
133	if ( function_exists( 'imagecreatefrompng' ) ) {
134	// GD library is present, so 'imagecreatefrompng' function is available
135	// Generate image object from PNG for potential conversion to JPG later.
136	$image_object = imagecreatefrompng( $upload['file'] );
137	// Get image dimension
138	list( $width, $height ) = getimagesize( $upload['file'] );
139	// Run through pixels until transparent pixel is found
140	for ($x = 0; $x < $width; $x++) {
141	for ($y = 0; $y < $height; $y++) {
142	$pixel_color_index = imagecolorat( $image_object, $x, $y );
143	$pixel_rgba = imagecolorsforindex( $image_object, $pixel_color_index );
144	// array of red, green, blue and alpha values
145	if ( $pixel_rgba['alpha'] > 0 ) {
146	// a pixel with alpha/transparency has been found
147	// alpha value range from 0 (completely opaque) to 127 (fully transparent).
148	// Ref: https://www.php.net/manual/en/function.imagecolorallocatealpha.php
149	$this->png_is_transparent = true;
150	break 2;
151	// Break both 'for' loops
152	}
153	}
154	}
155	} else {
156	if ( class_exists( 'Imagick' ) ) {
157	$imagick = new Imagick();
158	$imagick->readImage( $upload['file'] );
159	// Ref: https://stackoverflow.com/a/52295997
160	// Ref: https://www.php.net/manual/en/imagick.getimagechannelrange.php
161	// If the channel is defined, and has any transparent areas across any frame, then maxima will always be greater then minima.
162	// If the channel is NOT defined, then minima will be Inf placeholder, and maxima will be -Inf placeholder, so the above check will still work.
163	$alpha_range = $imagick->getImageChannelRange( Imagick::CHANNEL_ALPHA );
164	$this->png_is_transparent = $alpha_range['minima'] < $alpha_range['maxima'];
165	}
166	}
167	}
168	// Do not convert PNG with alpha/transparency
169	if ( $this->png_is_transparent ) {
170	return $upload;
171	}
172	}
173	// Let's convert BMP and non-transparent PNG into JPG
174	$converted_to_jpg = false;
175	if ( is_object( $image_object ) \|\| class_exists( 'Imagick' ) ) {
176	$wp_uploads = wp_upload_dir();
177	$old_filename = wp_basename( $upload['file'] );
178	// Assign new, unique file name for the converted image
179	// $new_filename = wp_basename( str_ireplace( '.' . $file_extension, '.jpg', $old_filename ) );
180	$new_filename = str_ireplace( '.' . $file_extension, '.jpg', $old_filename );
181	$new_filename = wp_unique_filename( dirname( $upload['file'] ), $new_filename );
182	// original image is always deleted in ASE Free
183	$keep_original_image = false;
184	$converted_to_jpg = false;
185	}
186	if ( is_object( $image_object ) ) {
187	// When image object creation is successful
188	// When conversion from BMP/PNG to JPG is successful using GD. Last parameter is JPG quality (0-100).
189	if ( imagejpeg( $image_object, $wp_uploads['path'] . '/' . $new_filename, 90 ) ) {
190	$converted_to_jpg = true;
191	}
192	} else {
193	// When image object creation with imagecreatefrombmp(), bmp_to_image_object() or imagecreatefrompng() is not successful, we use Imagick to convert from BMP and non-transparent PNG to JPG.
194	if ( class_exists( 'Imagick' ) ) {
195	$imagick = new Imagick();
196	$imagick->readImage( $upload['file'] );
197	$imagick->setImageCompressionQuality( 90 );
198	$imagick->setImageFormat( 'jpg' );
199	// $imagick->setFormat( 'jpg' );
200	if ( $imagick->writeImage( $wp_uploads['path'] . '/' . $new_filename ) ) {
201	$converted_to_jpg = true;
202	}
203	// Clear the Imagick object
204	$imagick->clear();
205	$imagick->destroy();
206	}
207	}
208	if ( $converted_to_jpg ) {
209	// Delete original BMP / PNG
210	if ( !$keep_original_image ) {
211	unlink( $upload['file'] );
212	}
213	// Add converted JPG info into $upload
214	$upload['file'] = $wp_uploads['path'] . '/' . $new_filename;
215	$upload['url'] = $wp_uploads['url'] . '/' . $new_filename;
216	$upload['type'] = 'image/jpeg';
217	}
218	return $upload;
219	}
220
221	/**
222	* Generate image object from PNG/JPG with GD library
223	*
224	* @since 6.9.11
225	*/
226	public function gd_generate_webp(
227	$file,
228	$file_extension,
229	$webp_path,
230	$webp_conversion_quality
231	) {
232	if ( 'png' == $file_extension ) {
233	$image_object = imagecreatefrompng( $file );
234	if ( $this->png_is_transparent ) {
235	imagepalettetotruecolor( $image_object );
236	}
237	}
238	if ( 'jpg' == $file_extension \|\| 'jpeg' == $file_extension ) {
239	$image_object = imagecreatefromjpeg( $file );
240	}
241	// When creation of image object from PNG/JPG is successful. let's generate WebP image
242	// Second parameter is file path, last parameter is WebP quality (0-100).
243	if ( !is_null( $image_object ) && is_object( $image_object ) ) {
244	imagewebp( $image_object, $webp_path, $webp_conversion_quality );
245	}
246	}
247
248	/**
249	* Checks the filename before it is uploaded to WordPress and
250	* runs the fix_image_orientation function in case its needed.
251	*
252	* @since 7.5.0
253	* @link https://plugins.trac.wordpress.org/browser/fix-image-rotation/tags/2.2.2/includes/class-fix-image-rotation.php#L172
254	*
255	* @access public
256	*
257	* @hook wp_handle_upload_prefilter
258	*
259	* @param array $file An array of data for a single file.
260	*
261	* @return array An array of data for a single file.
262	*/
263	public function prefilter_maybe_fix_image_orientation( $file ) {
264	// Get the file extension
265	// $suffix = substr( $file['name'], strrpos( $file['name'], '.', -1 ) + 1 );
266	$suffix = pathinfo( $file['name'], PATHINFO_EXTENSION );
267	if ( in_array( strtolower( $suffix ), array('jpg', 'jpeg', 'tiff'), true ) ) {
268	$this->fix_image_orientation( $file['tmp_name'] );
269	}
270	return $file;
271	}
272
273	/**
274	* Checks the filename before it is uploaded to WordPress and
275	* runs the fix_image_orientation function in case its needed.
276	*
277	* @since 7.5.0
278	* @link https://plugins.trac.wordpress.org/browser/fix-image-rotation/tags/2.2.2/includes/class-fix-image-rotation.php#L150
279	*
280	* @access public
281	*
282	* @hook wp_handle_upload
283	*
284	* @param array $file {
285	* Array of upload data.
286	*
287	* @type string $file Filename of the newly-uploaded file.
288	* @type string $url URL of the uploaded file.
289	* @type string $type File type.
290	* }
291	*
292	* @return array Array of upload data.
293	*/
294	public function maybe_fix_image_orientation( $file ) {
295	$suffix = substr( $file['file'], strrpos( $file['file'], '.', -1 ) + 1 );
296	if ( in_array( strtolower( $suffix ), array('jpg', 'jpeg', 'tiff'), true ) ) {
297	$this->fix_image_orientation( $file['file'] );
298	}
299	return $file;
300	}
301
302	/**
303	* Fixes the orientation of the image based on exif data
304	*
305	* @since 7.5.0
306	* @link https://plugins.trac.wordpress.org/browser/fix-image-rotation/tags/2.2.2/includes/class-fix-image-rotation.php#L191
307	*
308	* @access public
309	*
310	* @param string $file Path of the file.
311	*
312	* @return void
313	*/
314	public function fix_image_orientation( $file ) {
315	if ( !isset( $this->orientation_fixed[$file] ) ) {
316	$exif = exif_read_data( $file );
317	if ( isset( $exif ) && isset( $exif['Orientation'] ) && $exif['Orientation'] > 1 ) {
318	// Need it so that image editors are available to us.
319	// include_once ABSPATH . 'wp-admin/includes/image-edit.php';
320	// Calculate the operations we need to perform on the image.
321	$operations = $this->calculate_flip_and_rotate( $file, $exif );
322	if ( false !== $operations ) {
323	// Lets flip flop and rotate the image as needed.
324	$this->do_flip_and_rotate( $file, $operations );
325	}
326	}
327	}
328	}
329
330	/**
331	* Calculate the flips and rotations image will need to do to fix its orientation.
332	*
333	* @since 7.5.0
334	* @link https://plugins.trac.wordpress.org/browser/fix-image-rotation/tags/2.2.2/includes/class-fix-image-rotation.php#L225
335	*
336	* @access private
337	*
338	* @param string $file Path of the file.
339	*
340	* @param array $exif Exif data of the image.
341	*
342	* @return array\|bool Array of operations to be performed on the image,
343	* false if no operations are needed.
344	*/
345	private function calculate_flip_and_rotate( $file, $exif ) {
346	$rotator = false;
347	$flipper = false;
348	$orientation = 0;
349	// Lets switch to the orientation defined in the exif data.
350	switch ( $exif['Orientation'] ) {
351	case 1:
352	// We don't want to fix an already correct image :).
353	$this->orientation_fixed[$file] = true;
354	return false;
355	case 2:
356	$flipper = array(false, true);
357	break;
358	case 3:
359	$orientation = -180;
360	$rotator = true;
361	break;
362	case 4:
363	$flipper = array(true, false);
364	break;
365	case 5:
366	$orientation = -90;
367	$rotator = true;
368	$flipper = array(false, true);
369	break;
370	case 6:
371	$orientation = -90;
372	$rotator = true;
373	break;
374	case 7:
375	$orientation = -270;
376	$rotator = true;
377	$flipper = array(false, true);
378	break;
379	case 8:
380	case 9:
381	$orientation = -270;
382	$rotator = true;
383	break;
384	default:
385	$orientation = 0;
386	$rotator = true;
387	break;
388	}
389	return compact( 'orientation', 'rotator', 'flipper' );
390	}
391
392	/**
393	* Flips and rotates the image based on the parameters provided.
394	*
395	* @since 7.5.0
396	* @link https://plugins.trac.wordpress.org/browser/fix-image-rotation/tags/2.2.2/includes/class-fix-image-rotation.php#L299
397	*
398	* @access private
399	*
400	* @param string $file Path of the file.
401	*
402	* @param array $operations {
403	* Array of operations to be performed on the image.
404	*
405	* @type bool $rotator Whether to rotate the image or not.
406	* @type int $orientation Amount of rotation to be performed in degrees.
407	* @type array\|bool $flipper {
408	* Whether to flip the image or not, false if no flipping needed.
409	*
410	* @type bool $0 Flip along Horizontal Axis.
411	* @type bool $1 Flip along Vertical Axis.
412	* }
413	* }
414	*
415	* @return bool Returns true if operations were successful, false otherwise.
416	*/
417	private function do_flip_and_rotate( $file, $operations ) {
418	$editor = wp_get_image_editor( $file );
419	// If GD Library is being used, then we need to store metadata to restore later.
420	if ( 'WP_Image_Editor_GD' === get_class( $editor ) ) {
421	include_once ABSPATH . 'wp-admin/includes/image.php';
422	$this->previous_meta[$file] = wp_read_image_metadata( $file );
423	}
424	if ( !is_wp_error( $editor ) ) {
425	// Lets rotate and flip the image based on exif orientation.
426	if ( true === $operations['rotator'] ) {
427	$editor->rotate( $operations['orientation'] );
428	}
429	if ( false !== $operations['flipper'] ) {
430	$editor->flip( $operations['flipper'][0], $operations['flipper'][1] );
431	}
432	$editor->save( $file );
433	$this->orientation_fixed[$file] = true;
434	add_filter(
435	'wp_read_image_metadata',
436	array($this, 'restore_meta_data'),
437	10,
438	2
439	);
440	return true;
441	}
442	return false;
443	}
444
445	/**
446	* Restores the meta data of the image after being processed.
447	*
448	* WordPress' Imagick Library does not need this, but GD library
449	* removes metadata from the image upon rotation or flip so this
450	* method restores those values.
451	*
452	* @since 7.5.0
453	* @link https://plugins.trac.wordpress.org/browser/fix-image-rotation/tags/2.2.2/includes/class-fix-image-rotation.php#L341
454	*
455	* @hook wp_read_image_metadata
456	*
457	* @param array $meta Image meta data.
458	* @param string $file Path to image file.
459	*
460	* @return array Image meta data.
461	*/
462	public function restore_meta_data( $meta, $file ) {
463	if ( isset( $this->previous_meta[$file] ) ) {
464	$meta = $this->previous_meta[$file];
465	// Setting the Orientation meta to the new value after fixing the rotation.
466	$meta['orientation'] = 1;
467	return $meta;
468	}
469	return $meta;
470	}
471
472	}
473