tonesque.php — Jetpack – WP Security, Backup, Speed, & Growth 12.9.5

jetpack / _inc / lib / tonesque.php

jetpack / _inc / lib Last commit date

tonesque.php

279 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Tonesque
4	* Grab an average color representation from an image.
5	*
6	* @author Automattic
7	* @author Matias Ventura
8	* @package automattic/jetpack
9	*/
10
11	/**
12	* Color representation class.
13	*/
14	class Tonesque {
15	/**
16	* Image URL.
17	*
18	* @var string
19	*/
20	private $image_url = '';
21	/**
22	* Image identifier representing the image.
23	*
24	* @var null\|object
25	*/
26	private $image_obj = null;
27	/**
28	* Color code.
29	*
30	* @var string
31	*/
32	private $color = '';
33
34	/**
35	* Constructor.
36	*
37	* @param string $image_url Image URL.
38	*/
39	public function __construct( $image_url ) {
40	if ( ! class_exists( 'Jetpack_Color' ) ) {
41	require_once JETPACK__PLUGIN_DIR . '/_inc/lib/class.color.php';
42	}
43
44	$this->image_url = esc_url_raw( $image_url );
45	$this->image_url = trim( $this->image_url );
46	/**
47	* Allows any image URL to be passed in for $this->image_url.
48	*
49	* @module theme-tools
50	*
51	* @since 2.5.0
52	*
53	* @param string $image_url The URL to any image
54	*/
55	$this->image_url = apply_filters( 'tonesque_image_url', $this->image_url );
56
57	$this->image_obj = self::imagecreatefromurl( $this->image_url );
58	}
59
60	/**
61	* Get an image object from a URL.
62	*
63	* @param string $image_url Image URL.
64	*
65	* @return object\|bool Image object or false if the image could not be loaded.
66	*/
67	public static function imagecreatefromurl( $image_url ) {
68	$data = null;
69
70	// If it's a URL.
71	if ( preg_match( '#^https?://#i', $image_url ) ) {
72	// If it's a url pointing to a local media library url.
73	$content_url = content_url();
74	$_image_url = set_url_scheme( $image_url );
75	if ( str_starts_with( $_image_url, $content_url ) ) {
76	$_image_path = str_replace( $content_url, WP_CONTENT_DIR, $_image_url );
77	if ( file_exists( $_image_path ) ) {
78	$filetype = wp_check_filetype( $_image_path );
79	$type = $filetype['type'];
80
81	if ( str_starts_with( $type, 'image/' ) ) {
82	$data = file_get_contents( $_image_path ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
83	}
84	}
85	}
86
87	if ( empty( $data ) ) {
88	$response = wp_safe_remote_get( $image_url );
89	$response_code = wp_remote_retrieve_response_code( $response );
90	if (
91	is_wp_error( $response )
92	\|\| ! $response_code
93	\|\| $response_code < 200
94	\|\| $response_code >= 300
95	) {
96	return false;
97	}
98	$data = wp_remote_retrieve_body( $response );
99	}
100	}
101
102	// If it's a local path in our WordPress install.
103	if ( file_exists( $image_url ) ) {
104	$filetype = wp_check_filetype( $image_url );
105	$type = $filetype['type'];
106
107	if ( str_starts_with( $type, 'image/' ) ) {
108	$data = file_get_contents( $image_url ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
109	}
110	}
111
112	if ( null === $data ) {
113	return false;
114	}
115
116	// Now turn it into an image and return it.
117	return imagecreatefromstring( $data );
118	}
119
120	/**
121	* Construct object from image.
122	*
123	* @param string $type Type (hex, rgb, hsv) (optional).
124	*
125	* @return string\|bool color as a string formatted as $type or false if the image could not be loaded.
126	*/
127	public function color( $type = 'hex' ) {
128	// Bail if there is no image to work with.
129	if ( ! $this->image_obj ) {
130	return false;
131	}
132
133	// Finds dominant color.
134	$color = self::grab_color();
135	// Passes value to Color class.
136	return self::get_color( $color, $type );
137	}
138
139	/**
140	* Grabs the color index for each of five sample points of the image
141	*
142	* @param string $type can be 'index' or 'hex'.
143	*
144	* @return array\|false color indices or false if the image could not be loaded.
145	*/
146	public function grab_points( $type = 'index' ) {
147	$img = $this->image_obj;
148	if ( ! $img ) {
149	return false;
150	}
151
152	$height = imagesy( $img );
153	$width = imagesx( $img );
154
155	/*
156	* Sample five points in the image
157	* based on rule of thirds and center.
158	*/
159	$topy = round( $height / 3 );
160	$bottomy = round( ( $height / 3 ) * 2 );
161	$leftx = round( $width / 3 );
162	$rightx = round( ( $width / 3 ) * 2 );
163	$centery = round( $height / 2 );
164	$centerx = round( $width / 2 );
165
166	// Cast those colors into an array.
167	$points = array(
168	imagecolorat( $img, $leftx, $topy ),
169	imagecolorat( $img, $rightx, $topy ),
170	imagecolorat( $img, $leftx, $bottomy ),
171	imagecolorat( $img, $rightx, $bottomy ),
172	imagecolorat( $img, $centerx, $centery ),
173	);
174
175	if ( 'hex' === $type ) {
176	foreach ( $points as $i => $p ) {
177	$c = imagecolorsforindex( $img, $p );
178	$points[ $i ] = self::get_color(
179	array(
180	'r' => $c['red'],
181	'g' => $c['green'],
182	'b' => $c['blue'],
183	),
184	'hex'
185	);
186	}
187	}
188
189	return $points;
190	}
191
192	/**
193	* Finds the average color of the image based on five sample points
194	*
195	* @return array\|bool array with rgb color or false if the image could not be loaded.
196	*/
197	public function grab_color() {
198	$img = $this->image_obj;
199	if ( ! $img ) {
200	return false;
201	}
202
203	$rgb = self::grab_points();
204
205	$r = array();
206	$g = array();
207	$b = array();
208
209	/*
210	* Process the color points
211	* Find the average representation
212	*/
213	foreach ( $rgb as $color ) {
214	$index = imagecolorsforindex( $img, $color );
215	$r[] = $index['red'];
216	$g[] = $index['green'];
217	$b[] = $index['blue'];
218	}
219	$red = round( array_sum( $r ) / 5 );
220	$green = round( array_sum( $g ) / 5 );
221	$blue = round( array_sum( $b ) / 5 );
222
223	// The average color of the image as rgb array.
224	$color = array(
225	'r' => $red,
226	'g' => $green,
227	'b' => $blue,
228	);
229
230	return $color;
231	}
232
233	/**
234	* Get a Color object using /lib class.color
235	* Convert to appropriate type
236	*
237	* @param string $color Color code.
238	* @param string $type Color type (rgb, hex, hsv).
239	*
240	* @return string
241	*/
242	public function get_color( $color, $type ) {
243	$c = new Jetpack_Color( $color, 'rgb' );
244	$this->color = $c;
245
246	switch ( $type ) {
247	case 'rgb':
248	$color = implode( ',', $c->toRgbInt() );
249	break;
250	case 'hex':
251	$color = $c->toHex();
252	break;
253	case 'hsv':
254	$color = implode( ',', $c->toHsvInt() );
255	break;
256	default:
257	return $c->toHex();
258	}
259
260	return $color;
261	}
262
263	/**
264	*
265	* Checks contrast against main color
266	* Gives either black or white for using with opacity
267	*
268	* @return string\|bool Returns black or white or false if the image could not be loaded.
269	*/
270	public function contrast() {
271	if ( ! $this->color ) {
272	return false;
273	}
274
275	$c = $this->color->getMaxContrastColor();
276	return implode( ',', $c->toRgbInt() );
277	}
278	}
279