%s
EOT;
printf(
$template,
checked( $options['enabled'], false, false ),
esc_html__( 'Hide related content after posts', 'jetpack' ),
checked( $options['enabled'], true, false ),
esc_html__( 'Show related content after posts', 'jetpack' ),
$ui_settings
);
}
}
/**
* Head JS/CSS for admin settings page.
*
* @uses esc_html__
* @returns null
*/
public function print_setting_head() {
$related_headline = sprintf(
'%s
',
esc_html__( 'Related', 'jetpack' )
);
$related_with_images = '';
$related_without_images = '';
if ( $this->_allow_feature_toggle() ) {
$extra_css = '#settings-reading-relatedposts-customize { padding-left:2em; margin-top:.5em; }';
} else {
$extra_css = '';
}
echo <<
#settings-reading-relatedposts .disabled { opacity:.5; filter:Alpha(opacity=50); }
#settings-reading-relatedposts-preview .jp-relatedposts { background:#fff; padding:.5em; width:75%; }
$extra_css
EOT;
}
/**
* Gets an array of related posts that match the given post_id.
*
* @param int $post_id
* @param array $args - params to use when building ElasticSearch filters to narrow down the search domain.
* @uses self::get_options, get_post_type, wp_parse_args, apply_filters
* @return array
*/
public function get_for_post_id( $post_id, array $args ) {
$options = $this->get_options();
if ( ! empty( $args['size'] ) )
$options['size'] = $args['size'];
if ( ! $options['enabled'] || 0 == (int)$post_id || empty( $options['size'] ) )
return array();
$defaults = array(
'size' => (int)$options['size'],
'post_type' => get_post_type( $post_id ),
'has_terms' => array(),
'date_range' => array(),
'exclude_post_ids' => array(),
);
$args = wp_parse_args( $args, $defaults );
$args = apply_filters( 'jetpack_relatedposts_filter_args', $args, $post_id );
$filters = $this->_get_es_filters_from_args( $post_id, $args );
$filters = apply_filters( 'jetpack_relatedposts_filter_filters', $filters, $post_id );
$results = $this->_get_related_posts( $this->_blog_id, $post_id, $args['size'], $filters );
return apply_filters( 'jetpack_relatedposts_returned_results', $results, $post_id );
}
/**
* =========================
* PRIVATE UTILITY FUNCTIONS
* =========================
*/
/**
* Creates an array of ElasticSearch filters based on the post_id and args.
*
* @param int $post_id
* @param array $args
* @uses apply_filters, get_post_types
* @return array
*/
protected function _get_es_filters_from_args( $post_id, array $args ) {
$filters = array();
$args['has_terms'] = apply_filters( 'jetpack_relatedposts_filter_has_terms', $args['has_terms'], $post_id );
if ( ! empty( $args['has_terms'] ) ) {
foreach( (array)$args['has_terms'] as $term ) {
if ( mb_strlen( $term->taxonomy ) ) {
switch ( $term->taxonomy ) {
case 'post_tag':
$tax_fld = 'tag.slug';
break;
case 'category':
$tax_fld = 'category.slug';
break;
default:
$tax_fld = 'taxonomy.' . $term->taxonomy . '.slug';
break;
}
$filters[] = array( 'term' => array( $tax_fld => $term->slug ) );
}
}
}
$args['post_type'] = apply_filters( 'jetpack_relatedposts_filter_post_type', $args['post_type'], $post_id );
$valid_post_types = get_post_types();
if ( is_array( $args['post_type'] ) ) {
$sanitized_post_types = array();
foreach ( $args['post_type'] as $pt ) {
if ( in_array( $pt, $valid_post_types ) )
$sanitized_post_types[] = $pt;
}
if ( ! empty( $sanitized_post_types ) )
$filters[] = array( 'terms' => array( 'post_type' => $sanitized_post_types ) );
} else if ( in_array( $args['post_type'], $valid_post_types ) && 'all' != $args['post_type'] ) {
$filters[] = array( 'term' => array( 'post_type' => $args['post_type'] ) );
}
$args['date_range'] = apply_filters( 'jetpack_relatedposts_filter_date_range', $args['date_range'], $post_id );
if ( is_array( $args['date_range'] ) && ! empty( $args['date_range'] ) ) {
$args['date_range'] = array_map( 'intval', $args['date_range'] );
if ( !empty( $args['date_range']['from'] ) && !empty( $args['date_range']['to'] ) ) {
$filters[] = array(
'range' => array(
'date_gmt' => $this->_get_coalesced_range( $args['date_range'] ),
)
);
}
}
$args['exclude_post_ids'] = apply_filters( 'jetpack_relatedposts_filter_exclude_post_ids', $args['exclude_post_ids'], $post_id );
if ( !empty( $args['exclude_post_ids'] ) && is_array( $args['exclude_post_ids'] ) ) {
foreach ( $args['exclude_post_ids'] as $exclude_post_id) {
$exclude_post_id = (int)$exclude_post_id;
if ( $exclude_post_id > 0 )
$filters[] = array( 'not' => array( 'term' => array( 'post_id' => $exclude_post_id ) ) );
}
}
return $filters;
}
/**
* Takes a range and coalesces it into a month interval bracketed by a time as determined by the blog_id to enhance caching.
*
* @param array $date_range
* @return array
*/
protected function _get_coalesced_range( array $date_range ) {
$now = time();
$coalesce_time = $this->_blog_id % 86400;
$current_time = $now - strtotime( 'today', $now );
if ( $current_time < $coalesce_time && '01' == date( 'd', $now ) ) {
// Move back 1 period
return array(
'from' => date( 'Y-m-01', strtotime( '-1 month', $date_range['from'] ) ) . ' ' . date( 'H:i:s', $coalesce_time ),
'to' => date( 'Y-m-01', $date_range['to'] ) . ' ' . date( 'H:i:s', $coalesce_time ),
);
} else {
// Use current period
return array(
'from' => date( 'Y-m-01', $date_range['from'] ) . ' ' . date( 'H:i:s', $coalesce_time ),
'to' => date( 'Y-m-01', strtotime( '+1 month', $date_range['to'] ) ) . ' ' . date( 'H:i:s', $coalesce_time ),
);
}
}
/**
* Generate and output ajax response for related posts API call.
* NOTE: Calls exit() to end all further processing after payload has been outputed.
*
* @param array $excludes array of post_ids to exclude
* @uses send_nosniff_header, self::get_for_post_id, get_the_ID
* @return null
*/
protected function _action_frontend_init_ajax( array $excludes ) {
define( 'DOING_AJAX', true );
header( 'Content-type: application/json; charset=utf-8' ); // JSON can only be UTF-8
send_nosniff_header();
$related_posts = $this->get_for_post_id(
get_the_ID(),
array(
'exclude_post_ids' => $excludes,
)
);
$options = $this->get_options();
$response = array(
'version' => self::VERSION,
'show_thumbnails' => (bool) $options['show_thumbnails'],
'items' => array(),
);
if ( count( $related_posts ) == $options['size'] )
$response['items'] = $related_posts;
echo json_encode( $response );
exit();
}
/**
* Blog reader has clicked on a related link, log this action for future relevance analysis and redirect the user to their post.
* NOTE: Calls exit() to end all further processing after redirect has been outputed.
*
* @param int $to_post_id
* @param int $link_position
* @uses get_the_ID, add_query_arg, get_permalink, wp_safe_redirect
* @return null
*/
protected function _action_frontend_redirect( $to_post_id, $link_position ) {
$post_id = get_the_ID();
$this->_log_click( $post_id, $to_post_id, $link_position );
wp_safe_redirect( add_query_arg( array( 'relatedposts_exclude' => $post_id ), get_permalink( $to_post_id ) ) );
exit();
}
/**
* Returns a UTF-8 encoded array of post information for the given post_id
*
* @param int $blog_id
* @param int $post_id
* @param int $position
* @uses get_post, add_query_arg, remove_query_arg, get_post_format
* @return array
*/
protected function _get_related_post_data_for_post( $blog_id, $post_id, $position ) {
$post = get_post( $post_id );
return array(
'id' => $post->ID,
'url' => add_query_arg(
array( 'relatedposts_to' => $post->ID, 'relatedposts_order' => $position ),
remove_query_arg( array( 'relatedposts', 'relatedposts_exclude' ) )
),
'title' => $this->_to_utf8( $this->_get_title( $post->post_title, $post->post_content ) ),
'format' => get_post_format( $post->ID ),
'excerpt' => $this->_to_utf8( $this->_get_excerpt( $post->post_excerpt, $post->post_content ) ),
'context' => $this->_to_utf8( $this->_generate_related_post_context( $this->_blog_id, $post->ID ) ),
'img' => $this->_generate_related_post_image_params( $this->_blog_id, $post->ID ),
);
}
/**
* Returns either the title or a small excerpt to use as title for post.
*
* @param string $post_title
* @param string $post_content
* @uses strip_shortcodes, wp_trim_words
* @return string
*/
protected function _get_title( $post_title, $post_content ) {
if ( ! empty( $post_title ) )
return $post_title;
else
return wp_trim_words( strip_shortcodes( $post_content ), 5 );
}
/**
* Returns a plain text post excerpt for title attribute of links.
*
* @param string $post_excerpt
* @param string $post_content
* @uses strip_shortcodes, wp_trim_words
* @return string
*/
protected function _get_excerpt( $post_excerpt, $post_content ) {
if ( empty( $post_excerpt ) )
$excerpt = $post_content;
else
$excerpt = $post_excerpt;
return wp_trim_words( strip_shortcodes( $excerpt ), 30 );
}
/**
* Generates the thumbnail image to be used for the post. Uses the
* image as returned by Jetpack_PostImages::get_image()
*
* @param int $blog_id
* @param int $post_id
* @uses self::get_options, apply_filters, Jetpack_PostImages::get_image, Jetpack_PostImages::fit_image_url
* @return string
*/
protected function _generate_related_post_image_params( $blog_id, $post_id ) {
$options = $this->get_options();
$image_params = array(
'src' => '',
'width' => 0,
'height' => 0,
);
if ( ! $options['show_thumbnails'] ) {
return $image_params;
}
$thumbnail_size = apply_filters(
'jetpack_relatedposts_filter_thumbnail_size',
array( 'width' => 350, 'height' => 200 )
);
if ( !is_array( $thumbnail_size ) ) {
$thumbnail_size = array(
'width' => (int)$thumbnail_size,
'height' => (int)$thumbnail_size
);
}
// Try to get post image
if ( class_exists( 'Jetpack_PostImages' ) ) {
$img_url = '';
$post_image = Jetpack_PostImages::get_image(
$post_id,
$thumbnail_size
);
if ( is_array($post_image) ) {
$img_url = $post_image['src'];
} elseif ( class_exists( 'Jetpack_Media_Summary' ) ) {
$media = Jetpack_Media_Summary::get(
$post_id,
$blog_id
);
if ( is_array($media) && !empty( $media['image'] ) ) {
$img_url = $media['image'];
}
}
if ( !empty( $img_url ) ) {
$image_params['width'] = $thumbnail_size['width'];
$image_params['height'] = $thumbnail_size['height'];
$image_params['src'] = Jetpack_PostImages::fit_image_url(
$img_url,
$thumbnail_size['width'],
$thumbnail_size['height']
);
}
}
return $image_params;
}
/**
* Returns the string UTF-8 encoded
*
* @param string $text
* @return string
*/
protected function _to_utf8( $text ) {
if ( $this->_convert_charset ) {
return iconv( $this->_blog_charset, 'UTF-8', $text );
} else {
return $text;
}
}
/**
* =============================================
* PROTECTED UTILITY FUNCTIONS EXTENDED BY WPCOM
* =============================================
*/
/**
* Workhorse method to return array of related posts matched by ElasticSearch.
*
* @param int $blog_id
* @param int $post_id
* @param int $size
* @param array $filters
* @uses wp_remote_post, is_wp_error, get_option, wp_remote_retrieve_body, get_post, add_query_arg, remove_query_arg, get_permalink, get_post_format, apply_filters
* @return array
*/
protected function _get_related_posts( $blog_id, $post_id, $size, array $filters ) {
$hits = $this->_get_related_post_ids( $blog_id, $post_id, $size, $filters );
$hits = apply_filters( 'jetpack_relatedposts_filter_hits', $hits, $post_id );
$related_posts = array();
foreach ( $hits as $i => $hit ) {
$related_posts[] = $this->_get_related_post_data_for_post( $blog_id, $hit['id'], $i );
}
return $related_posts;
}
/**
* Get array of related posts matched by ElasticSearch.
*
* @param int $blog_id
* @param int $post_id
* @param int $size
* @param array $filters
* @uses wp_remote_post, is_wp_error, wp_remote_retrieve_body
* @return array
*/
protected function _get_related_post_ids( $blog_id, $post_id, $size, array $filters ) {
$body = array(
'size' => (int) $size,
);
if ( !empty( $filters ) )
$body['filter'] = array( 'and' => $filters );
$response = wp_remote_post(
"https://public-api.wordpress.com/rest/v1/sites/$blog_id/posts/$post_id/related/",
array(
'timeout' => 10,
'user-agent' => 'jetpack_related_posts',
'sslverify' => true,
'body' => $body,
)
);
if ( is_wp_error( $response ) ) {
return array();
}
$results = json_decode( wp_remote_retrieve_body( $response ), true );
$related_posts = array();
if ( is_array( $results ) && !empty( $results['hits'] ) ) {
foreach( $results['hits'] as $hit ) {
$related_posts[] = array(
'id' => $hit['fields']['post_id'],
);
}
}
return $related_posts;
}
/**
* Generates a context for the related content (second line in related post output).
* Order of importance:
* - First category (Not 'Uncategorized')
* - First post tag
* - Number of comments
*
* @param int $blog_id
* @param int $post_id
* @uses get_the_category, get_the_terms, get_comments_number, number_format_i18n, __, _n
* @return string
*/
protected function _generate_related_post_context( $blog_id, $post_id ) {
$categories = get_the_category( $post_id );
if ( is_array( $categories ) ) {
foreach ( $categories as $category ) {
if ( 'uncategorized' != $category->slug && '' != trim( $category->name ) ) {
return sprintf(
_x( 'In "%s"', 'in {category/tag name}', 'jetpack' ),
$category->name
);
}
}
}
$tags = get_the_terms( $post_id, 'post_tag' );
if ( is_array( $tags ) ) {
foreach ( $tags as $tag ) {
if ( '' != trim( $tag->name ) ) {
return sprintf(
_x( 'In "%s"', 'in {category/tag name}', 'jetpack' ),
$tag->name
);
}
}
}
$comment_count = get_comments_number( $post_id );
if ( $comment_count > 0 ) {
return sprintf(
_n( 'With 1 comment', 'With %s comments', $comment_count, 'jetpack' ),
number_format_i18n( $comment_count )
);
}
return '';
}
/**
* Logs clicks for clickthrough analysis and related result tuning.
*
* @return null
*/
protected function _log_click( $post_id, $to_post_id, $link_position ) {
}
/**
* Determines if we should show config in admin dashboard to turn on related posts.
*
* @param int $blog_id
* @return bool
*/
protected function _show_config_in_admin( $blog_id ) {
return true;
}
/**
* Determines if the current post is able to use related posts.
*
* @param int $blog_id
* @uses self::get_options, is_admin, is_single, wp_count_posts, get_post
* @return bool
*/
protected function _enabled_for_request( $blog_id ) {
// Must have feature enabled
$options = $this->get_options();
if ( ! $options['enabled'] )
return false;
// Only run for frontend pages
if ( is_admin() )
return false;
// Only run for standalone posts
if ( ! is_single() )
return false;
// Don't run if blog is very sparse
$post_count = wp_count_posts();
if ( $post_count->publish < 10 )
return false;
return true;
}
/**
* Adds filters and enqueues assets.
*
* @uses self::_enqueue_assets, add_filter
* @return null
*/
protected function _action_frontend_init_page() {
$this->_enqueue_assets( true, true );
add_filter( 'the_content', array( $this, 'filter_add_target_to_dom' ), 40 );
}
/**
* Enqueues assets needed to do async loading of related posts.
*
* @uses wp_enqueue_script, wp_enqueue_style, plugins_url
* @return null
*/
protected function _enqueue_assets( $script, $style ) {
if ( $script )
wp_enqueue_script( 'jetpack_related-posts', plugins_url( 'related-posts.js', __FILE__ ), array( 'jquery' ), self::VERSION );
if ( $style )
wp_enqueue_style( 'jetpack_related-posts', plugins_url( 'related-posts.css', __FILE__ ), array(), self::VERSION );
}
protected function _allow_feature_toggle() {
if ( null === $this->_allow_feature_toggle ) {
$this->_allow_feature_toggle = apply_filters( 'jetpack_relatedposts_filter_allow_feature_toggle', false );
}
return $this->_allow_feature_toggle;
}
}
class Jetpack_RelatedPosts_Raw extends Jetpack_RelatedPosts {
protected $_query_name;
/**
* Allows callers of this class to tag each query with a unique name for tracking purposes.
*
* @param string $name
* @return Jetpack_RelatedPosts_Raw
*/
public function set_query_name( $name ) {
$this->_query_name = (string) $name;
return $this;
}
/**
* The raw related posts class can be used by other plugins or themes
* to get related content. This class wraps the existing RelatedPosts
* logic thus we never want to add anything to the DOM or do anything
* for event hooks. We will also not present any settings for this
* class and keep it enabled as calls to this class is done
* programmatically.
*/
public function action_admin_init() {}
public function action_frontend_init() {}
public function get_options() {
return array(
'enabled' => true,
);
}
/**
* Workhorse method to return array of related posts ids matched by ElasticSearch.
*
* @param int $blog_id
* @param int $post_id
* @param int $size
* @param array $filters
* @uses wp_remote_post, is_wp_error, wp_remote_retrieve_body
* @return array
*/
protected function _get_related_posts( $blog_id, $post_id, $size, array $filters ) {
$hits = $this->_get_related_post_ids( $blog_id, $post_id, $size, $filters );
return $hits;
}
}
