PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 6.2.2
Jetpack – WP Security, Backup, Speed, & Growth v6.2.2
16.2-beta 12.0.3 12.1.3 12.2.3 12.3.2 12.4.2 12.5.2 12.6.4 12.7.3 12.8.3 12.9.5 13.0.2 13.1.5 13.2.4 13.3.3 13.4.5 13.5.2 13.6.2 13.7.2 13.8.3 13.9.2 14.0.1 14.1.1 14.2.2 14.3.1 All 501 releases
jetpack / class.jetpack-post-images.php

class.jetpack-post-images.php in Jetpack – WP Security, Backup, Speed, & Growth 6.2.2, at class.jetpack-post-images.php

640 lines 19.5 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2
3 /**
4 * Useful for finding an image to display alongside/in representation of a specific post.
5 *
6 * Includes a few different methods, all of which return a similar-format array containing
7 * details of any images found. Everything can (should) be called statically, it's just a
8 * function-bucket. You can also call Jetpack_PostImages::get_image() to cycle through all of the methods until
9 * one of them finds something useful.
10 *
11 * This file is included verbatim in Jetpack
12 */
13 class Jetpack_PostImages {
14 /**
15 * If a slideshow is embedded within a post, then parse out the images involved and return them
16 */
17 static function from_slideshow( $post_id, $width = 200, $height = 200 ) {
18 $images = array();
19
20 $post = get_post( $post_id );
21
22 if ( ! $post ) {
23 return $images;
24 }
25
26 if ( ! empty( $post->post_password ) ) {
27 return $images;
28 }
29
30 if ( false === has_shortcode( $post->post_content, 'slideshow' ) ) {
31 return $images; // no slideshow - bail
32 }
33
34 $permalink = get_permalink( $post->ID );
35
36 // Mechanic: Somebody set us up the bomb
37 $old_post = $GLOBALS['post'];
38 $GLOBALS['post'] = $post;
39 $old_shortcodes = $GLOBALS['shortcode_tags'];
40 $GLOBALS['shortcode_tags'] = array( 'slideshow' => $old_shortcodes['slideshow'] );
41
42 // Find all the slideshows
43 preg_match_all( '/' . get_shortcode_regex() . '/sx', $post->post_content, $slideshow_matches, PREG_SET_ORDER );
44
45 ob_start(); // The slideshow shortcode handler calls wp_print_scripts and wp_print_styles... not too happy about that
46
47 foreach ( $slideshow_matches as $slideshow_match ) {
48 $slideshow = do_shortcode_tag( $slideshow_match );
49 if ( false === $pos = stripos( $slideshow, 'jetpack-slideshow' ) ) // must be something wrong - or we changed the output format in which case none of the following will work
50 continue;
51 $start = strpos( $slideshow, '[', $pos );
52 $end = strpos( $slideshow, ']', $start );
53 $post_images = json_decode( wp_specialchars_decode( str_replace( "'", '"', substr( $slideshow, $start, $end - $start + 1 ) ), ENT_QUOTES ) ); // parse via JSON
54 // If the JSON didn't decode don't try and act on it.
55 if ( is_array( $post_images ) ) {
56 foreach ( $post_images as $post_image ) {
57 if ( !$post_image_id = absint( $post_image->id ) )
58 continue;
59
60 $meta = wp_get_attachment_metadata( $post_image_id );
61
62 // Must be larger than 200x200 (or user-specified)
63 if ( !isset( $meta['width'] ) || $meta['width'] < $width )
64 continue;
65 if ( !isset( $meta['height'] ) || $meta['height'] < $height )
66 continue;
67
68 $url = wp_get_attachment_url( $post_image_id );
69
70 $images[] = array(
71 'type' => 'image',
72 'from' => 'slideshow',
73 'src' => $url,
74 'src_width' => $meta['width'],
75 'src_height' => $meta['height'],
76 'href' => $permalink,
77 );
78 }
79 }
80 }
81 ob_end_clean();
82
83 // Operator: Main screen turn on
84 $GLOBALS['shortcode_tags'] = $old_shortcodes;
85 $GLOBALS['post'] = $old_post;
86
87 return $images;
88 }
89
90 /**
91 * If a gallery is detected, then get all the images from it.
92 */
93 static function from_gallery( $post_id ) {
94 $images = array();
95
96 $post = get_post( $post_id );
97
98 if ( ! $post ) {
99 return $images;
100 }
101
102 if ( ! empty( $post->post_password ) ) {
103 return $images;
104 }
105
106 $permalink = get_permalink( $post->ID );
107
108 /**
109 * Juggle global post object because the gallery shortcode uses the
110 * global object.
111 *
112 * See core ticket:
113 * https://core.trac.wordpress.org/ticket/39304
114 */
115 if ( isset( $GLOBALS['post'] ) ) {
116 $juggle_post = $GLOBALS['post'];
117 $GLOBALS['post'] = $post;
118 $galleries = get_post_galleries( $post->ID, false );
119 $GLOBALS['post'] = $juggle_post;
120 } else {
121 $GLOBALS['post'] = $post;
122 $galleries = get_post_galleries( $post->ID, false );
123 unset( $GLOBALS['post'] );
124 }
125
126 foreach ( $galleries as $gallery ) {
127 if ( isset( $gallery['type'] ) && 'slideshow' === $gallery['type'] && ! empty( $gallery['ids'] ) ) {
128 $image_ids = explode( ',', $gallery['ids'] );
129 $image_size = isset( $gallery['size'] ) ? $gallery['size'] : 'thumbnail';
130 foreach ( $image_ids as $image_id ) {
131 $image = wp_get_attachment_image_src( $image_id, $image_size );
132 if ( ! empty( $image[0] ) ) {
133 list( $raw_src ) = explode( '?', $image[0] ); // pull off any Query string (?w=250)
134 $raw_src = wp_specialchars_decode( $raw_src ); // rawify it
135 $raw_src = esc_url_raw( $raw_src ); // clean it
136 $images[] = array(
137 'type' => 'image',
138 'from' => 'gallery',
139 'src' => $raw_src,
140 'href' => $permalink,
141 );
142 }
143 }
144 } elseif ( ! empty( $gallery['src'] ) ) {
145 foreach ( $gallery['src'] as $src ) {
146 list( $raw_src ) = explode( '?', $src ); // pull off any Query string (?w=250)
147 $raw_src = wp_specialchars_decode( $raw_src ); // rawify it
148 $raw_src = esc_url_raw( $raw_src ); // clean it
149 $images[] = array(
150 'type' => 'image',
151 'from' => 'gallery',
152 'src' => $raw_src,
153 'href' => $permalink,
154 );
155 }
156 }
157 }
158
159 return $images;
160 }
161
162 /**
163 * Get attachment images for a specified post and return them. Also make sure
164 * their dimensions are at or above a required minimum.
165 */
166 static function from_attachment( $post_id, $width = 200, $height = 200 ) {
167 $images = array();
168
169 $post = get_post( $post_id );
170
171 if ( ! empty( $post->post_password ) ) {
172 return $images;
173 }
174
175 $post_images = get_posts( array(
176 'post_parent' => $post_id, // Must be children of post
177 'numberposts' => 5, // No more than 5
178 'post_type' => 'attachment', // Must be attachments
179 'post_mime_type' => 'image', // Must be images
180 'suppress_filters' => false,
181 ) );
182
183 if ( ! $post_images ) {
184 return $images;
185 }
186
187 $permalink = get_permalink( $post_id );
188
189 foreach ( $post_images as $post_image ) {
190 $meta = wp_get_attachment_metadata( $post_image->ID );
191 // Must be larger than 200x200
192 if ( !isset( $meta['width'] ) || $meta['width'] < $width )
193 continue;
194 if ( !isset( $meta['height'] ) || $meta['height'] < $height )
195 continue;
196
197 $url = wp_get_attachment_url( $post_image->ID );
198
199 $images[] = array(
200 'type' => 'image',
201 'from' => 'attachment',
202 'src' => $url,
203 'src_width' => $meta['width'],
204 'src_height' => $meta['height'],
205 'href' => $permalink,
206 );
207 }
208
209 /*
210 * We only want to pass back attached images that were actually inserted.
211 * We can load up all the images found in the HTML source and then
212 * compare URLs to see if an image is attached AND inserted.
213 */
214 $html_images = self::from_html( $post_id );
215 $inserted_images = array();
216
217 foreach( $html_images as $html_image ) {
218 $src = parse_url( $html_image['src'] );
219 // strip off any query strings from src
220 if( ! empty( $src['scheme'] ) && ! empty( $src['host'] ) ) {
221 $inserted_images[] = $src['scheme'] . '://' . $src['host'] . $src['path'];
222 } elseif( ! empty( $src['host'] ) ) {
223 $inserted_images[] = set_url_scheme( 'http://' . $src['host'] . $src['path'] );
224 } else {
225 $inserted_images[] = site_url( '/' ) . $src['path'];
226 }
227 }
228 foreach( $images as $i => $image ) {
229 if ( !in_array( $image['src'], $inserted_images ) )
230 unset( $images[$i] );
231 }
232
233 return $images;
234 }
235
236 /**
237 * Check if a Featured Image is set for this post, and return it in a similar
238 * format to the other images?_from_*() methods.
239 * @param int $post_id The post ID to check
240 * @return Array containing details of the Featured Image, or empty array if none.
241 */
242 static function from_thumbnail( $post_id, $width = 200, $height = 200 ) {
243 $images = array();
244
245 $post = get_post( $post_id );
246
247 if ( ! empty( $post->post_password ) ) {
248 return $images;
249 }
250
251 if ( ! function_exists( 'get_post_thumbnail_id' ) ) {
252 return $images;
253 }
254
255 $thumb = get_post_thumbnail_id( $post_id );
256
257 if ( $thumb ) {
258 $meta = wp_get_attachment_metadata( $thumb );
259 // Must be larger than requested minimums
260 if ( !isset( $meta['width'] ) || $meta['width'] < $width )
261 return $images;
262 if ( !isset( $meta['height'] ) || $meta['height'] < $height )
263 return $images;
264
265 $too_big = ( ( ! empty( $meta['width'] ) && $meta['width'] > 1200 ) || ( ! empty( $meta['height'] ) && $meta['height'] > 1200 ) );
266
267 if (
268 $too_big &&
269 (
270 ( method_exists( 'Jetpack', 'is_module_active' ) && Jetpack::is_module_active( 'photon' ) ) ||
271 ( defined( 'IS_WPCOM' ) && IS_WPCOM )
272 )
273 ) {
274 $img_src = wp_get_attachment_image_src( $thumb, array( 1200, 1200 ) );
275 } else {
276 $img_src = wp_get_attachment_image_src( $thumb, 'full' );
277 }
278 if ( ! is_array( $img_src ) ) {
279 // If wp_get_attachment_image_src returns false but we know that there should be an image that could be used.
280 // we try a bit harder and user the data that we have.
281 $thumb_post_data = get_post( $thumb );
282 $img_src = array( $thumb_post_data->guid, $meta['width'], $meta['height'] );
283 }
284
285 $url = $img_src[0];
286 $images = array( array( // Other methods below all return an array of arrays
287 'type' => 'image',
288 'from' => 'thumbnail',
289 'src' => $url,
290 'src_width' => $img_src[1],
291 'src_height' => $img_src[2],
292 'href' => get_permalink( $thumb ),
293 ) );
294
295 }
296
297 if ( empty( $images ) && ( defined( 'IS_WPCOM' ) && IS_WPCOM ) ) {
298 $meta_thumbnail = get_post_meta( $post_id, '_jetpack_post_thumbnail', true );
299 if ( ! empty( $meta_thumbnail ) ) {
300 if ( ! isset( $meta_thumbnail['width'] ) || $meta_thumbnail['width'] < $width ) {
301 return $images;
302 }
303
304 if ( ! isset( $meta_thumbnail['height'] ) || $meta_thumbnail['height'] < $height ) {
305 return $images;
306 }
307
308 $images = array( array( // Other methods below all return an array of arrays
309 'type' => 'image',
310 'from' => 'thumbnail',
311 'src' => $meta_thumbnail['URL'],
312 'src_width' => $meta_thumbnail['width'],
313 'src_height' => $meta_thumbnail['height'],
314 'href' => $meta_thumbnail['URL'],
315 ) );
316 }
317 }
318
319 return $images;
320 }
321
322 /**
323 * Very raw -- just parse the HTML and pull out any/all img tags and return their src
324 *
325 * @param mixed $html_or_id The HTML string to parse for images, or a post id.
326 * @param int $width Minimum Image width.
327 * @param int $height Minimum Image height.
328 *
329 * @uses DOMDocument
330 *
331 * @return Array containing images
332 */
333 static function from_html( $html_or_id, $width = 200, $height = 200 ) {
334 $images = array();
335
336 if ( is_numeric( $html_or_id ) ) {
337 $post = get_post( $html_or_id );
338
339 if ( empty( $post ) || ! empty( $post->post_password ) ) {
340 return $images;
341 }
342
343 $html = $post->post_content; // DO NOT apply the_content filters here, it will cause loops.
344 } else {
345 $html = $html_or_id;
346 }
347
348 if ( ! $html ) {
349 return $images;
350 }
351
352 // Do not go any further if DOMDocument is disabled on the server.
353 if ( ! class_exists( 'DOMDocument' ) ) {
354 return $images;
355 }
356
357 // Let's grab all image tags from the HTML.
358 $dom_doc = new DOMDocument;
359
360 // The @ is not enough to suppress errors when dealing with libxml,
361 // we have to tell it directly how we want to handle errors.
362 libxml_use_internal_errors( true );
363 @$dom_doc->loadHTML( $html );
364 libxml_use_internal_errors( false );
365
366 $image_tags = $dom_doc->getElementsByTagName( 'img' );
367
368 // For each image Tag, make sure it can be added to the $images array, and add it.
369 foreach ( $image_tags as $image_tag ) {
370 $img_src = $image_tag->getAttribute( 'src' );
371
372 if ( empty( $img_src ) ) {
373 continue;
374 }
375
376 // Do not grab smiley images that were automatically created by WP when entering text smilies.
377 if ( stripos( $img_src, '/smilies/' ) ) {
378 continue;
379 }
380
381 $meta = array(
382 'width' => (int) $image_tag->getAttribute( 'width' ),
383 'height' => (int) $image_tag->getAttribute( 'height' ),
384 );
385
386 // Must be larger than 200x200 (or user-specified).
387 if ( empty( $meta['width'] ) || $meta['width'] < $width ) {
388 continue;
389 }
390 if ( empty( $meta['height'] ) || $meta['height'] < $height ) {
391 continue;
392 }
393
394 $images[] = array(
395 'type' => 'image',
396 'from' => 'html',
397 'src' => $img_src,
398 'src_width' => $meta['width'],
399 'src_height' => $meta['height'],
400 'href' => '', // No link to apply to these. Might potentially parse for that as well, but not for now.
401 );
402 }
403 return $images;
404 }
405
406 /**
407 * @param int $post_id The post ID to check
408 * @param int $size
409 * @return Array containing details of the image, or empty array if none.
410 */
411 static function from_blavatar( $post_id, $size = 96 ) {
412
413 $permalink = get_permalink( $post_id );
414
415 if ( function_exists( 'blavatar_domain' ) && function_exists( 'blavatar_exists' ) && function_exists( 'blavatar_url' ) ) {
416 $domain = blavatar_domain( $permalink );
417
418 if ( ! blavatar_exists( $domain ) ) {
419 return array();
420 }
421
422 $url = blavatar_url( $domain, 'img', $size );
423 } elseif ( function_exists( 'has_site_icon' ) && has_site_icon() ) {
424 $url = get_site_icon_url( $size );
425 } else {
426 return array();
427 }
428
429 return array( array(
430 'type' => 'image',
431 'from' => 'blavatar',
432 'src' => $url,
433 'src_width' => $size,
434 'src_height' => $size,
435 'href' => $permalink,
436 ) );
437 }
438
439 /**
440 * Gets a post image from the author avatar.
441 *
442 * @param int $post_id The post ID to check.
443 * @param int $size The size of the avatar to get.
444 * @param string $default The default image to use.
445 * @return Array containing details of the image, or empty array if none.
446 */
447 static function from_gravatar( $post_id, $size = 96, $default = false ) {
448 $post = get_post( $post_id );
449 $permalink = get_permalink( $post_id );
450
451 if ( function_exists( 'wpcom_get_avatar_url' ) ) {
452 $url = wpcom_get_avatar_url( $post->post_author, $size, $default, true );
453 if ( $url && is_array( $url ) ) {
454 $url = $url[0];
455 }
456 } else {
457 $url = get_avatar_url( $post->post_author, array(
458 'size' => $size,
459 'default' => $default,
460 ) );
461 }
462
463 return array(
464 array(
465 'type' => 'image',
466 'from' => 'gravatar',
467 'src' => $url,
468 'src_width' => $size,
469 'src_height' => $size,
470 'href' => $permalink,
471 ),
472 );
473 }
474
475 /**
476 * Run through the different methods that we have available to try to find a single good
477 * display image for this post.
478 * @param int $post_id
479 * @param array $args Other arguments (currently width and height required for images where possible to determine)
480 * @return Array containing details of the best image to be used
481 */
482 static function get_image( $post_id, $args = array() ) {
483 $image = '';
484
485 /**
486 * Fires before we find a single good image for a specific post.
487 *
488 * @since 2.2.0
489 *
490 * @param int $post_id Post ID.
491 */
492 do_action( 'jetpack_postimages_pre_get_image', $post_id );
493 $media = self::get_images( $post_id, $args );
494
495
496 if ( is_array( $media ) ) {
497 foreach ( $media as $item ) {
498 if ( 'image' == $item['type'] ) {
499 $image = $item;
500 break;
501 }
502 }
503 }
504
505 /**
506 * Fires after we find a single good image for a specific post.
507 *
508 * @since 2.2.0
509 *
510 * @param int $post_id Post ID.
511 */
512 do_action( 'jetpack_postimages_post_get_image', $post_id );
513
514 return $image;
515 }
516
517 /**
518 * Get an array containing a collection of possible images for this post, stopping once we hit a method
519 * that returns something useful.
520 * @param int $post_id
521 * @param array $args Optional args, see defaults list for details
522 * @return Array containing images that would be good for representing this post
523 */
524 static function get_images( $post_id, $args = array() ) {
525 // Figure out which image to attach to this post.
526 $media = false;
527
528 /**
529 * Filters the array of images that would be good for a specific post.
530 * This filter is applied before options ($args) filter the original array.
531 *
532 * @since 2.0.0
533 *
534 * @param array $media Array of images that would be good for a specific post.
535 * @param int $post_id Post ID.
536 * @param array $args Array of options to get images.
537 */
538 $media = apply_filters( 'jetpack_images_pre_get_images', $media, $post_id, $args );
539 if ( $media )
540 return $media;
541
542 $defaults = array(
543 'width' => 200, // Required minimum width (if possible to determine)
544 'height' => 200, // Required minimum height (if possible to determine)
545
546 'fallback_to_avatars' => false, // Optionally include Blavatar and Gravatar (in that order) in the image stack
547 'avatar_size' => 96, // Used for both Grav and Blav
548 'gravatar_default' => false, // Default image to use if we end up with no Gravatar
549
550 'from_thumbnail' => true, // Use these flags to specify which methods to use to find an image
551 'from_slideshow' => true,
552 'from_gallery' => true,
553 'from_attachment' => true,
554 'from_html' => true,
555
556 'html_content' => '' // HTML string to pass to from_html()
557 );
558 $args = wp_parse_args( $args, $defaults );
559
560 $media = false;
561 if ( $args['from_thumbnail'] )
562 $media = self::from_thumbnail( $post_id, $args['width'], $args['height'] );
563 if ( !$media && $args['from_slideshow'] )
564 $media = self::from_slideshow( $post_id, $args['width'], $args['height'] );
565 if ( !$media && $args['from_gallery'] )
566 $media = self::from_gallery( $post_id );
567 if ( !$media && $args['from_attachment'] )
568 $media = self::from_attachment( $post_id, $args['width'], $args['height'] );
569 if ( !$media && $args['from_html'] ) {
570 if ( empty( $args['html_content'] ) )
571 $media = self::from_html( $post_id, $args['width'], $args['height'] ); // Use the post_id, which will load the content
572 else
573 $media = self::from_html( $args['html_content'], $args['width'], $args['height'] ); // If html_content is provided, use that
574 }
575
576 if ( !$media && $args['fallback_to_avatars'] ) {
577 $media = self::from_blavatar( $post_id, $args['avatar_size'] );
578 if ( !$media )
579 $media = self::from_gravatar( $post_id, $args['avatar_size'], $args['gravatar_default'] );
580 }
581
582 /**
583 * Filters the array of images that would be good for a specific post.
584 * This filter is applied after options ($args) filter the original array.
585 *
586 * @since 2.0.0
587 *
588 * @param array $media Array of images that would be good for a specific post.
589 * @param int $post_id Post ID.
590 * @param array $args Array of options to get images.
591 */
592 return apply_filters( 'jetpack_images_get_images', $media, $post_id, $args );
593 }
594
595 /**
596 * Takes an image URL and pixel dimensions then returns a URL for the
597 * resized and cropped image.
598 *
599 * @param string $src
600 * @param int $dimension
601 * @return string Transformed image URL
602 */
603 static function fit_image_url( $src, $width, $height ) {
604 $width = (int) $width;
605 $height = (int) $height;
606
607 if ( $width < 1 || $height < 1 ) {
608 return $src;
609 }
610
611 // See if we should bypass WordPress.com SaaS resizing
612 if ( has_filter( 'jetpack_images_fit_image_url_override' ) ) {
613 /**
614 * Filters the image URL used after dimensions are set by Photon.
615 *
616 * @since 3.3.0
617 *
618 * @param string $src Image URL.
619 * @param int $width Image width.
620 * @param int $width Image height.
621 */
622 return apply_filters( 'jetpack_images_fit_image_url_override', $src, $width, $height );
623 }
624
625 // If WPCOM hosted image use native transformations
626 $img_host = parse_url( $src, PHP_URL_HOST );
627 if ( '.files.wordpress.com' == substr( $img_host, -20 ) ) {
628 return add_query_arg( array( 'w' => $width, 'h' => $height, 'crop' => 1 ), set_url_scheme( $src ) );
629 }
630
631 // Use Photon magic
632 if( function_exists( 'jetpack_photon_url' ) ) {
633 return jetpack_photon_url( $src, array( 'resize' => "$width,$height" ) );
634 }
635
636 // Arg... no way to resize image using WordPress.com infrastructure!
637 return $src;
638 }
639 }
640