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

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

admin-site-enhancements / classes Last commit date

class-image-upload-control.php

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