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