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

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

admin-site-enhancements / classes Last commit date

class-image-upload-control.php

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