diff options
Diffstat (limited to 'plugins/jetpack/_inc/lib/class.media-summary.php')
| -rw-r--r-- | plugins/jetpack/_inc/lib/class.media-summary.php | 295 |
1 files changed, 194 insertions, 101 deletions
diff --git a/plugins/jetpack/_inc/lib/class.media-summary.php b/plugins/jetpack/_inc/lib/class.media-summary.php index 6d5f2d48..79d5845f 100644 --- a/plugins/jetpack/_inc/lib/class.media-summary.php +++ b/plugins/jetpack/_inc/lib/class.media-summary.php @@ -1,23 +1,50 @@ -<?php +<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName +/** + * Provides media summary of a post. + * + * @package automattic/jetpack + */ + /** * Class Jetpack_Media_Summary * - * embed [video] > gallery > image > text + * Priority: embed [video] > gallery > image > text */ class Jetpack_Media_Summary { + /** + * Media cache. + * + * @var array + */ private static $cache = array(); - static function get( $post_id, $blog_id = 0, $args = array() ) { + /** + * Get media summary for a post. + * + * @param int $post_id Post ID. + * @param int $blog_id Blog ID, if applicable. + * @param array $args { + * Optional. An array of arguments. + * @type int $max_words Maximum number of words. + * @type int $max_chars Maximum number of characters. + * } + * + * @return array|mixed|void + */ + public static function get( $post_id, $blog_id = 0, $args = array() ) { + // @todo: Use type hinting in the line above when at PHP 7.0+. + $post_id = (int) $post_id; + $blog_id = (int) $blog_id; $defaults = array( 'max_words' => 16, 'max_chars' => 256, ); - $args = wp_parse_args( $args, $defaults ); + $args = wp_parse_args( $args, $defaults ); $switched = false; - if ( !empty( $blog_id ) && $blog_id != get_current_blog_id() && function_exists( 'switch_to_blog' ) ) { + if ( ! empty( $blog_id ) && get_current_blog_id() !== $blog_id && function_exists( 'switch_to_blog' ) ) { switch_to_blog( $blog_id ); $switched = true; } else { @@ -26,6 +53,9 @@ class Jetpack_Media_Summary { $cache_key = "{$blog_id}_{$post_id}_{$args['max_words']}_{$args['max_chars']}"; if ( isset( self::$cache[ $cache_key ] ) ) { + if ( $switched ) { + restore_current_blog(); + } return self::$cache[ $cache_key ]; } @@ -47,9 +77,9 @@ class Jetpack_Media_Summary { 'excerpt' => '', 'word_count' => 0, 'secure' => array( - 'image' => '', + 'image' => '', ), - 'count' => array( + 'count' => array( 'image' => 0, 'video' => 0, 'word' => 0, @@ -57,31 +87,35 @@ class Jetpack_Media_Summary { ), ); - if ( empty( $post->post_password ) ) { - $return['excerpt'] = self::get_excerpt( $post->post_content, $post->post_excerpt, $args['max_words'], $args['max_chars'] , $post); - $return['count']['word'] = self::get_word_count( $post->post_content ); + if ( $post instanceof WP_Post && empty( $post->post_password ) ) { + $return['excerpt'] = self::get_excerpt( $post->post_content, $post->post_excerpt, $args['max_words'], $args['max_chars'], $post ); + $return['count']['word'] = self::get_word_count( $post->post_content ); $return['count']['word_remaining'] = self::get_word_remaining_count( $post->post_content, $return['excerpt'] ); - $return['count']['link'] = self::get_link_count( $post->post_content ); + $return['count']['link'] = self::get_link_count( $post->post_content ); } $extract = Jetpack_Media_Meta_Extractor::extract( $blog_id, $post_id, Jetpack_Media_Meta_Extractor::ALL ); - if ( empty( $extract['has'] ) ) + if ( empty( $extract['has'] ) ) { + if ( $switched ) { + restore_current_blog(); + } return $return; + } - // Prioritize [some] video embeds - if ( !empty( $extract['has']['shortcode'] ) ) { + // Prioritize [some] video embeds. + if ( ! empty( $extract['has']['shortcode'] ) ) { foreach ( $extract['shortcode'] as $type => $data ) { switch ( $type ) { case 'videopress': case 'wpvideo': - if ( 0 == $return['count']['video'] ) { - // If there is no id on the video, then let's just skip this - if ( ! isset ( $data['id'][0] ) ) { + if ( 0 === $return['count']['video'] ) { + // If there is no id on the video, then let's just skip this. + if ( ! isset( $data['id'][0] ) ) { break; } - $guid = $data['id'][0]; + $guid = $data['id'][0]; $video_info = videopress_get_video_details( $guid ); // Only add the video tags if the guid returns a valid videopress object. @@ -99,39 +133,38 @@ class Jetpack_Media_Summary { $thumbnail = $video_info->poster; if ( ! empty( $thumbnail ) ) { - $return['image'] = $thumbnail; + $return['image'] = $thumbnail; $return['secure']['image'] = $thumbnail; } - $return['type'] = 'video'; - $return['video'] = esc_url_raw( $url ); - $return['video_type'] = 'video/mp4'; + $return['type'] = 'video'; + $return['video'] = esc_url_raw( $url ); + $return['video_type'] = 'video/mp4'; $return['secure']['video'] = $return['video']; } - } $return['count']['video']++; break; case 'youtube': - if ( 0 == $return['count']['video'] ) { - $return['type'] = 'video'; - $return['video'] = esc_url_raw( 'http://www.youtube.com/watch?feature=player_embedded&v=' . $extract['shortcode']['youtube']['id'][0] ); - $return['image'] = self::get_video_poster( 'youtube', $extract['shortcode']['youtube']['id'][0] ); + if ( 0 === $return['count']['video'] ) { + $return['type'] = 'video'; + $return['video'] = esc_url_raw( 'http://www.youtube.com/watch?feature=player_embedded&v=' . $extract['shortcode']['youtube']['id'][0] ); + $return['image'] = self::get_video_poster( 'youtube', $extract['shortcode']['youtube']['id'][0] ); $return['secure']['video'] = self::https( $return['video'] ); $return['secure']['image'] = self::https( $return['image'] ); } $return['count']['video']++; break; case 'vimeo': - if ( 0 == $return['count']['video'] ) { - $return['type'] = 'video'; - $return['video'] = esc_url_raw( 'http://vimeo.com/' . $extract['shortcode']['vimeo']['id'][0] ); + if ( 0 === $return['count']['video'] ) { + $return['type'] = 'video'; + $return['video'] = esc_url_raw( 'http://vimeo.com/' . $extract['shortcode']['vimeo']['id'][0] ); $return['secure']['video'] = self::https( $return['video'] ); $poster_image = get_post_meta( $post_id, 'vimeo_poster_image', true ); - if ( !empty( $poster_image ) ) { - $return['image'] = $poster_image; - $poster_url_parts = wp_parse_url( $poster_image ); + if ( ! empty( $poster_image ) ) { + $return['image'] = $poster_image; + $poster_url_parts = wp_parse_url( $poster_image ); $return['secure']['image'] = 'https://secure-a.vimeocdn.com' . $poster_url_parts['path']; } } @@ -139,38 +172,36 @@ class Jetpack_Media_Summary { break; } } - } - if ( !empty( $extract['has']['embed'] ) ) { - foreach( $extract['embed']['url'] as $embed ) { + if ( ! empty( $extract['has']['embed'] ) ) { + foreach ( $extract['embed']['url'] as $embed ) { if ( preg_match( '/((youtube|vimeo|dailymotion)\.com|youtu.be)/', $embed ) ) { - if ( 0 == $return['count']['video'] ) { - $return['type'] = 'video'; - $return['video'] = 'http://' . $embed; + if ( 0 === $return['count']['video'] ) { + $return['type'] = 'video'; + $return['video'] = 'http://' . $embed; $return['secure']['video'] = self::https( $return['video'] ); if ( false !== strpos( $embed, 'youtube' ) ) { - $return['image'] = self::get_video_poster( 'youtube', jetpack_get_youtube_id( $return['video'] ) ); + $return['image'] = self::get_video_poster( 'youtube', jetpack_get_youtube_id( $return['video'] ) ); $return['secure']['image'] = self::https( $return['image'] ); - } else if ( false !== strpos( $embed, 'youtu.be' ) ) { - $youtube_id = jetpack_get_youtube_id( $return['video'] ); - $return['video'] = 'http://youtube.com/watch?v=' . $youtube_id . '&feature=youtu.be'; + } elseif ( false !== strpos( $embed, 'youtu.be' ) ) { + $youtube_id = jetpack_get_youtube_id( $return['video'] ); + $return['video'] = 'http://youtube.com/watch?v=' . $youtube_id . '&feature=youtu.be'; $return['secure']['video'] = self::https( $return['video'] ); - $return['image'] = self::get_video_poster( 'youtube', jetpack_get_youtube_id( $return['video'] ) ); + $return['image'] = self::get_video_poster( 'youtube', jetpack_get_youtube_id( $return['video'] ) ); $return['secure']['image'] = self::https( $return['image'] ); - } else if ( false !== strpos( $embed, 'vimeo' ) ) { + } elseif ( false !== strpos( $embed, 'vimeo' ) ) { $poster_image = get_post_meta( $post_id, 'vimeo_poster_image', true ); - if ( !empty( $poster_image ) ) { - $return['image'] = $poster_image; - $poster_url_parts = wp_parse_url( $poster_image ); + if ( ! empty( $poster_image ) ) { + $return['image'] = $poster_image; + $poster_url_parts = wp_parse_url( $poster_image ); $return['secure']['image'] = 'https://secure-a.vimeocdn.com' . $poster_url_parts['path']; } - } else if ( false !== strpos( $embed, 'dailymotion' ) ) { - $return['image'] = str_replace( 'dailymotion.com/video/','dailymotion.com/thumbnail/video/', $embed ); - $return['image'] = wp_parse_url( $return['image'], PHP_URL_SCHEME ) === null ? 'http://' . $return['image'] : $return['image']; + } elseif ( false !== strpos( $embed, 'dailymotion' ) ) { + $return['image'] = str_replace( 'dailymotion.com/video/', 'dailymotion.com/thumbnail/video/', $embed ); + $return['image'] = wp_parse_url( $return['image'], PHP_URL_SCHEME ) === null ? 'http://' . $return['image'] : $return['image']; $return['secure']['image'] = self::https( $return['image'] ); } - } $return['count']['video']++; } @@ -178,64 +209,65 @@ class Jetpack_Media_Summary { } // Do we really want to make the video the primary focus of the post? - if ( 'video' == $return['type'] ) { - $content = wpautop( strip_tags( $post->post_content ) ); - $paragraphs = explode( '</p>', $content ); + if ( 'video' === $return['type'] ) { + $content = wpautop( wp_strip_all_tags( $post->post_content ) ); + $paragraphs = explode( '</p>', $content ); $number_of_paragraphs = 0; foreach ( $paragraphs as $i => $paragraph ) { - // Don't include blank lines as a paragraph - if ( '' == trim( $paragraph ) ) { - unset( $paragraphs[$i] ); + // Don't include blank lines as a paragraph. + if ( '' === trim( $paragraph ) ) { + unset( $paragraphs[ $i ] ); continue; } $number_of_paragraphs++; } - $number_of_paragraphs = $number_of_paragraphs - $return['count']['video']; // subtract amount for videos.. + $number_of_paragraphs = $number_of_paragraphs - $return['count']['video']; // subtract amount for videos. - // More than 2 paragraph? The video is not the primary focus so we can do some more analysis - if ( $number_of_paragraphs > 2 ) + // More than 2 paragraph? The video is not the primary focus so we can do some more analysis. + if ( $number_of_paragraphs > 2 ) { $return['type'] = 'standard'; + } } // If we don't have any prioritized embed... - if ( 'standard' == $return['type'] ) { + if ( 'standard' === $return['type'] ) { if ( ( ! empty( $extract['has']['gallery'] ) || ! empty( $extract['shortcode']['gallery']['count'] ) ) && ! empty( $extract['image'] ) ) { - //... Then we prioritize galleries first (multiple images returned) + // ... Then we prioritize galleries first (multiple images returned) $return['type'] = 'gallery'; $return['images'] = $extract['image']; foreach ( $return['images'] as $image ) { $return['secure']['images'][] = array( 'url' => self::ssl_img( $image['url'] ) ); $return['count']['image']++; } - } else if ( ! empty( $extract['has']['image'] ) ) { - // ... Or we try and select a single image that would make sense - $content = wpautop( strip_tags( $post->post_content ) ); - $paragraphs = explode( '</p>', $content ); + } elseif ( ! empty( $extract['has']['image'] ) ) { + // ... Or we try and select a single image that would make sense. + $content = wpautop( wp_strip_all_tags( $post->post_content ) ); + $paragraphs = explode( '</p>', $content ); $number_of_paragraphs = 0; foreach ( $paragraphs as $i => $paragraph ) { - // Don't include 'actual' captions as a paragraph + // Don't include 'actual' captions as a paragraph. if ( false !== strpos( $paragraph, '[caption' ) ) { - unset( $paragraphs[$i] ); + unset( $paragraphs[ $i ] ); continue; } - // Don't include blank lines as a paragraph - if ( '' == trim( $paragraph ) ) { - unset( $paragraphs[$i] ); + // Don't include blank lines as a paragraph. + if ( '' === trim( $paragraph ) ) { + unset( $paragraphs[ $i ] ); continue; } $number_of_paragraphs++; } - $return['image'] = $extract['image'][0]['url']; + $return['image'] = $extract['image'][0]['url']; $return['secure']['image'] = self::ssl_img( $return['image'] ); $return['count']['image']++; - if ( $number_of_paragraphs <= 2 && 1 == count( $extract['image'] ) ) { - // If we have lots of text or images, let's not treat it as an image post, but return its first image - $return['type'] = 'image'; + if ( $number_of_paragraphs <= 2 && 1 === count( $extract['image'] ) ) { + // If we have lots of text or images, let's not treat it as an image post, but return its first image. + $return['type'] = 'image'; } } } @@ -259,11 +291,25 @@ class Jetpack_Media_Summary { return $return; } - static function https( $str ) { + /** + * Converts http to https:// + * + * @param string $str URL. + * + * @return string URL. + */ + public static function https( $str ) { return str_replace( 'http://', 'https://', $str ); } - static function ssl_img( $url ) { + /** + * Returns a Photonized version of the URL. + * + * @param string $url URL. + * + * @return string URL. + */ + public static function ssl_img( $url ) { if ( false !== strpos( $url, 'files.wordpress.com' ) ) { return self::https( $url ); } else { @@ -271,20 +317,35 @@ class Jetpack_Media_Summary { } } - static function get_video_poster( $type, $id ) { - if ( 'videopress' == $type ) { + /** + * Get the video poster. + * + * @param string $type Video service. + * @param string $id Video ID for the service. + * + * @return string URL of image thumbnail for the video. + */ + public static function get_video_poster( $type, $id ) { + if ( 'videopress' === $type ) { if ( function_exists( 'video_get_highest_resolution_image_url' ) ) { return video_get_highest_resolution_image_url( $id ); - } else if ( class_exists( 'VideoPress_Video' ) ) { + } elseif ( class_exists( 'VideoPress_Video' ) ) { $video = new VideoPress_Video( $id ); return $video->poster_frame_uri; } - } else if ( 'youtube' == $type ) { - return 'http://img.youtube.com/vi/'.$id.'/0.jpg'; + } elseif ( 'youtube' === $type ) { + return 'http://img.youtube.com/vi/' . $id . '/0.jpg'; } } - static function clean_text( $text ) { + /** + * Clean text of shortcodes and tags. + * + * @param string $text Dirty text. + * + * @return string Clean text. + */ + public static function clean_text( $text ) { return trim( preg_replace( '/[\s]+/', @@ -293,7 +354,7 @@ class Jetpack_Media_Summary { '@https?://[\S]+@', '', strip_shortcodes( - strip_tags( + wp_strip_all_tags( $text ) ) @@ -306,6 +367,7 @@ class Jetpack_Media_Summary { * Retrieve an excerpt for the post summary. * * This function works around a suspected problem with Core. If resolved, this function should be simplified. + * * @link https://github.com/Automattic/jetpack/pull/8510 * @link https://core.trac.wordpress.org/ticket/42814 * @@ -316,24 +378,31 @@ class Jetpack_Media_Summary { * @param WP_Post $requested_post The post object. * @return string Post excerpt. **/ - static function get_excerpt( $post_content, $post_excerpt, $max_words = 16, $max_chars = 256, $requested_post = null ) { + public static function get_excerpt( $post_content, $post_excerpt, $max_words = 16, $max_chars = 256, $requested_post = null ) { global $post; $original_post = $post; // Saving the global for later use. - if ( function_exists( 'wpcom_enhanced_excerpt_extract_excerpt' ) ) { - return self::clean_text( wpcom_enhanced_excerpt_extract_excerpt( array( - 'text' => $post_content, - 'excerpt_only' => true, - 'show_read_more' => false, - 'max_words' => $max_words, - 'max_chars' => $max_chars, - 'read_more_threshold' => 25, - ) ) ); + if ( empty( $post_excerpt ) && function_exists( 'wpcom_enhanced_excerpt_extract_excerpt' ) ) { + return self::clean_text( + wpcom_enhanced_excerpt_extract_excerpt( + array( + 'text' => $post_content, + 'excerpt_only' => true, + 'show_read_more' => false, + 'max_words' => $max_words, + 'max_chars' => $max_chars, + 'read_more_threshold' => 25, + ) + ) + ); } elseif ( $requested_post instanceof WP_Post ) { + // @todo Refactor to not need to override the global. + // phpcs:ignore: WordPress.WP.GlobalVariablesOverride.Prohibited $post = $requested_post; // setup_postdata does not set the global. setup_postdata( $post ); /** This filter is documented in core/src/wp-includes/post-template.php */ $post_excerpt = apply_filters( 'get_the_excerpt', $post_excerpt, $post ); - $post = $original_post; // wp_reset_postdata uses the $post global. + // phpcs:ignore: WordPress.WP.GlobalVariablesOverride.Prohibited + $post = $original_post; // wp_reset_postdata uses the $post global. wp_reset_postdata(); return self::clean_text( $post_excerpt ); } @@ -344,26 +413,50 @@ class Jetpack_Media_Summary { * Split a string into an array of words. * * @param string $text Post content or excerpt. + * + * @return array Array of words. */ - static function split_content_in_words( $text ) { - $words = preg_split( '/[\s!?;,.]+/', $text, null, PREG_SPLIT_NO_EMPTY ); + public static function split_content_in_words( $text ) { + $words = preg_split( '/[\s!?;,.]+/', $text, -1, PREG_SPLIT_NO_EMPTY ); // Return an empty array if the split above fails. return $words ? $words : array(); } - static function get_word_count( $post_content ) { + /** + * Get the word count. + * + * @param string $post_content Post content. + * + * @return int Word count. + */ + public static function get_word_count( $post_content ) { return (int) count( self::split_content_in_words( self::clean_text( $post_content ) ) ); } - static function get_word_remaining_count( $post_content, $excerpt_content ) { + /** + * Get remainder word count (after the excerpt). + * + * @param string $post_content Post content. + * @param string $excerpt_content Excerpt content. + * + * @return int Number of words after the excerpt. + */ + public static function get_word_remaining_count( $post_content, $excerpt_content ) { $content_word_count = count( self::split_content_in_words( self::clean_text( $post_content ) ) ); $excerpt_word_count = count( self::split_content_in_words( self::clean_text( $excerpt_content ) ) ); return (int) $content_word_count - $excerpt_word_count; } - static function get_link_count( $post_content ) { + /** + * Counts the number of links in a post. + * + * @param string $post_content Post content. + * + * @return false|int Number of links. + */ + public static function get_link_count( $post_content ) { return preg_match_all( '/\<a[\> ]/', $post_content, $matches ); } } |