WordPress.com stats plugin.
Version: 2.4.1
Text Domain: wordpresscom-popular-posts
Author: Frasten
Author URI: http://polpoinodroidi.com
License: GPL3
*/
/* Created by Frasten (email : frasten@gmail.com) */
if ( ! class_exists( 'WPPP' ) && class_exists( 'WP_Widget' ) ) :
class WPPP extends WP_Widget {
var $defaults;
var $cache_expire = 600;
function WPPP() {
$this->defaults = array('title' => __( 'Popular Posts', 'wordpresscom-popular-posts' )
,'number' => '5'
,'days' => '0'
,'show' => 'both'
,'format' => "%post_title%"
,'excerpt_length' => '100'
,'title_length' => '0'
,'cutoff' => '0'
,'list_tag' => 'ul'
,'category' => '0'
,'enable_cache' => '1'
,'cache_only_when_visitor' => '0'
,'time_format' => ''
,'magic_number' => '1'
);
$widget_ops = array( 'classname' => 'widget_wppp',
'description' => __( "A list of your most popular posts", 'wordpresscom-popular-posts' )
);
$control_ops = array( 'width' => 350, 'height' => 300 );
$this->WP_Widget( 'wppp', __( 'Popular Posts', 'wordpresscom-popular-posts' ), $widget_ops, $control_ops );
}
function widget( $args, $instance = null ) {
global $wpdb, $allowedposttags;
if ( ! function_exists( 'stats_get_options' ) || ! function_exists( 'stats_get_csv' ) )
return;
extract( $args );
if ( ! $instance ) {
// Called from static non-widget function. (Or maybe some error? :-P)
$instance = $args;
/* cache */
if ( ! empty( $instance['cachename'] ) ) {
$this->id = $instance['cachename'];
}
}
$from_shortcode = false;
if ( ! empty( $instance['from_shortcode'] ) )
$from_shortcode = true;
/* Before the widget (as defined by the theme) */
if ( ! $from_shortcode )
echo $before_widget;
/* CACHE SYSTEM */
if ( $this->id && ( ! isset( $instance['enable_cache'] ) || $instance['enable_cache'] ) ) {
$cache = get_option( 'wppp_cache' );
if ( $cache && is_array( $cache ) ) {
$widget_cache = $cache[$this->id];
/* Don't serve a cached version (forcing refresh) when the user
* is logged in (if set in the preferences) */
if ( ! $instance['cache_only_when_visitor'] || ! is_user_logged_in() ) {
/* Check if it is valid or not */
if ( isset( $widget_cache['time'] ) &&
$widget_cache['time'] > ( time() - $this->cache_expire ) ) {
/* If it's called from the function, let's make some check to
* see if the options have changed. */
$valid = true;
if ( ! empty( $instance['cachename'] ) ) {
$settings_string = implode( '|', $instance );
$md5 = md5( $settings_string );
if ( $md5 != $widget_cache['settings_checksum'] )
$valid = false;
}
if ( $valid ) {
/* Print out the data from the cache. */
if ( ! $from_shortcode ) {
echo $widget_cache['value'];
echo $after_widget;
return;
}
else
return $widget_cache['value'];
}
unset( $valid );
} /* end cache's validity check */
} /* end check if cache_only_when_visitor */
unset( $widget_cache );
}
unset( $cache );
}
/* END CACHE SYSTEM */
// Check against malformed values
$instance['days'] = intval( $instance['days'] );
$instance['number'] = intval( $instance['number'] );
if ( $instance['days'] <= 0 )
$instance['days'] = '-1';
// A little hackish, but "could" work!
$howmany = $instance['number'];
if ( $instance['show'] == 'posts' )
$howmany *= 2;
else if ( $instance['show'] == 'pages' )
$howmany *= 4; // pages are usually less, let's try more!
// If I want to show links by category, I need more data.
if ( $instance['category'] ) {
$howmany *= 3;
}
/* The last workaround: if the automatic guesses are not enough,
* users can raise the "magic number" to increase the size of the
* data asked to the server.
* Note: if this number is set too high, it can slow the requests.
* So it's a good practice to enable the cache for this plugin. */
$instance['magic_number'] = floatval( $instance['magic_number'] );
if ( $instance['magic_number'] > 1 ) {
$howmany *= $instance['magic_number'];
$howmany = intval( $howmany );
}
// If I set some posts to be excluded, I must ask for more data
$excluded_ids = explode( ',', $instance['exclude'] );
if ( is_array( $excluded_ids ) && sizeof( $excluded_ids ) && $excluded_ids[0] !== '' ) {
$howmany += sizeof( $excluded_ids );
}
/* TEMPORARY FIX FOR WP_STATS PLUGIN */
$reset_cache = false;
$stats_cache = get_option( 'stats_cache' );
if ( ! $stats_cache || ! is_array( $stats_cache ) ) {
$reset_cache = true;
}
else {
foreach ( $stats_cache as $key => $val ) {
if ( ! is_array( $val ) || ! sizeof( $val ) ) {
$reset_cache = true;
break;
}
foreach ( $val as $key => $val2 ) {
if ( ! is_array( $val2 ) || ! sizeof( $val2 ) ) {
$reset_cache = true;
break;
}
break;
}
break;
}
}
if ( $reset_cache ) {
update_option( 'stats_cache', "" );
}
/* END FIX */
$top_posts = stats_get_csv( 'postviews', "days={$instance['days']}&limit=$howmany" );
$output = '';
/*********************
* TITLE *
********************/
if ( ! empty( $instance['title'] ) ) {
/* I'm disabling this because it escapes html code and users want to
* use it. If anybody will need this filter, I'll try to find a solution.
* Instead, I'm using wp_kses() for securing it.
$instance['title'] = apply_filters( 'widget_title', $instance['title'] );
*/
$instance['title'] = wp_kses( $instance['title'], $allowedposttags );
// Tags before and after the title (as called by WordPress)
if ( $before_title || $after_title ) {
$instance['title'] = $before_title . $instance['title'] . $after_title;
}
$output .= $instance['title'] . "\n";
}
// Check against malicious data
if ( ! in_array( $instance['list_tag'], array( 'ul', 'ol', 'none' ) ) )
$instance['list_tag'] = $this->defaults['list_tag'];
if ( $instance['list_tag'] != 'none' )
$output .= "<{$instance['list_tag']} class='wppp_list'>\n";
// Cleaning and filtering
if ( is_array( $top_posts ) && sizeof( $top_posts ) ) {
$temp_list = array();
foreach ( $top_posts as $p ) {
// If I set some posts to be excluded:
if ( sizeof( $excluded_ids ) && in_array( $p['post_id'], $excluded_ids ) ) continue;
/* I don't know why, but on some blogs there are "fake" entries,
without data. */
if ( ! $p['post_id'] ) continue;
// Posts with views <= 0 must be excluded
if ( $p['views'] <= 0 ) continue;
// If I have set to have a cutoff, exclude the posts with views below that threshold
if ( $instance['cutoff'] > 0 && $p['views'] < $instance['cutoff'] ) continue;
$temp_list[] = $p;
}
$top_posts = $temp_list;
}
else {
/* No popular posts. Maybe something went wrong while fetching data.
* Write a hidden debug message. */
echo "\n";
return;
}
/*************************************************************
* Removing non-existing posts and updating data from the DB *
************************************************************/
$id_list = array();
foreach ( $top_posts as $p ) {
$id_list[] = $p['post_id'];
}
// If no top-posts, just do nothing gracefully
if ( sizeof( $id_list ) ) {
// Must unescape the CSV data, to avoid issues with truncate functions
for ( $i = 0; $i < sizeof( $top_posts ); $i++ ) {
$top_posts[$i]['post_title'] = stripslashes( htmlspecialchars_decode( $top_posts[$i]['post_title'] ) );
}
/* The data from WP-Stats aren't updated, so we must fetch them
* from the DB, overwriting the old values.
* 1) check if that id is still valid (deleted post?)
* 2) exclude private posts and drafts
* 3) If I chose to show only posts or pages, only show them
* 4) If I chose to show only a category, only show those posts.
* Thanks to Rob Malon for this.
*/
/* Let's save CPU time: execute this long query with joins only if necessary */
$instance['category'] = (int) $instance['category'];
$filter_category = $instance['category'] > 0;
if ( $filter_category ) {
$query = "SELECT p.id, p.post_title FROM $wpdb->posts AS p INNER JOIN $wpdb->term_relationships AS r ON r.object_id = p.id";
}
else {
$query = "SELECT p.id, p.post_title FROM $wpdb->posts AS p";
}
$query .= " WHERE p.id IN (" . implode( ',', $id_list ) . ")";
$query .= " AND p.post_status != 'draft' AND p.post_status != 'private' AND p.post_status != 'trash'";
// If I want to show only posts or only pages:
if ( $instance['show'] != 'both' ) {
$query .= " AND p.post_type = '" . ( $instance['show'] == 'pages' ? 'page' : 'post' ) . "'";
}
if ( $filter_category ) {
/* NOTE: if a category is set, it won't show pages (you can set
* categories only with posts. */
$query .= " AND (r.term_taxonomy_id = '{$instance['category']}'";
/* If I chose a parent category and the post is in a child category,
* I must also check if the post is in any of the child categories. */
/* I need the term_id of the category, because get_categories()
* wants it. */
$query_cat = "SELECT term_id FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = '{$instance['category']}'";
$cat_id = $wpdb->get_var( $query_cat );
$children = get_categories("child_of=$cat_id&hide_empty=0");
foreach ($children as $child) {
$query .= " OR r.term_taxonomy_id = '$child->term_taxonomy_id'";
}
$query .= ')';
}
$results = $wpdb->get_results( $query );
$valid_list = array();
foreach ( $results as $valid ) {
$valid_list[$valid->id] = $valid;
}
$temp_list = array();
foreach ( $top_posts as $p ) {
if ( in_array( $p['post_id'], array_keys( $valid_list ) ) ) {
// Updating the title from the DB
$p['post_title'] = __( $valid_list[$p['post_id']]->post_title );
$temp_list[] = $p;
}
// Limit the number of posts shown following user settings.
if ( sizeof( $temp_list ) >= $instance['number'] )
break;
}
$top_posts = $temp_list;
unset( $temp_list );
} // end if (I have posts)
foreach ( $top_posts as $post ) {
if ( $instance['list_tag'] != 'none' )
$output .= "\t
";
// Replace format with data
$replace = array(
'%post_permalink%' => get_permalink( $post['post_id'] ),
'%post_title%' => esc_html( $this->truncateText( $post['post_title'], $instance['title_length'] ) ),
'%post_title_attribute%' => esc_attr( $post['post_title'] ),
'%post_views%' => number_format_i18n( $post['views'] )
);
// %post_category% stuff
if ( strpos( $instance['format'], '%post_category%' ) ) {
// RS account for multiple categories
$cat = get_the_category( $post['post_id'] );
$replace['%post_category%'] = $cat[0]->cat_name;
}
// %post_comments% stuff
if ( strpos( $instance['format'], '%post_comments%' ) ) {
$replace['%post_comments%'] = get_comments_number( $post['post_id'] );
}
// %post_excerpt% stuff
if ( strpos( $instance['format'], '%post_excerpt%' ) ) {
// I get the excerpt for the post only if necessary, to save CPU time.
$temppost = &get_post( $post['post_id'] );
if ( ! empty( $temppost->post_excerpt ) ) {
/* Excerpt already saved by the user */
$replace['%post_excerpt%'] = $this->truncateText( $temppost->post_excerpt, $instance['excerpt_length'] );
}
else {
// let's calculate the excerpt:
$excerpt = strip_tags( $temppost->post_content );
$excerpt = preg_replace( '|\[(.+?)\](.+?\[/\\1\])?|s', '', $excerpt );
$excerpt = $this->truncateText( $excerpt, $instance['excerpt_length'] );
$replace['%post_excerpt%'] = $excerpt;
}
unset( $temppost );
}
// %post_time% stuff
if ( strpos( $instance['format'], '%post_time%' ) ) {
/* If the first argument of get_the_time() is not set, it will use
* the default DATE format. */
$replace['%post_time%'] = get_the_time( $instance['time_format'], $post['post_id'] );
}
// %post_thumbnail% stuff, WP 2.9 only.
if ( FALSE !== strpos( $instance['format'], '%post_thumbnail%' ) ) {
// Check for mandatory functions (from WP 2.9 only)
if ( function_exists( 'get_the_post_thumbnail' ) && function_exists( 'has_post_thumbnail' ) ) {
if ( has_post_thumbnail( $post['post_id'] ) ) {
/* TODO: allow users to set a size for it */
$replace['%post_thumbnail%'] = get_the_post_thumbnail( $post['post_id'] );
}
else {
// No image found, show nothing.
$replace['%post_thumbnail%'] = '';
}
}
}
$output .= wp_kses( strtr( $instance['format'], $replace ), $allowedposttags );
if ( $instance['list_tag'] != 'none' )
$output .= "
\n";
}
if ( $instance['list_tag'] != 'none' )
$output .= "\n";
/* Cache data */
$cache = get_option( 'wppp_cache' );
if ( ! is_array($cache) ) $cache = array();
$cache[$this->id] = array( 'value' => $output, 'time' => time() );
if ( $md5 ) {
/* If I'm calling this from the function, I must save the checksum
* for the settings, to reset the cache everytime I change the settings. */
$cache[$this->id]['settings_checksum'] = $md5;
}
update_option( 'wppp_cache', $cache );
if ( ! $from_shortcode )
echo $output;
else
return $output;
/* After the widget (as defined by the theme) */
echo $after_widget;
}
function update( $new_instance, $old_instance ) {
$instance = $old_instance;
$instance['title'] = $new_instance['title'];
$instance['number'] = intval( $new_instance['number'] );
$instance['days'] = intval( $new_instance['days'] );
$instance['format'] = $new_instance['format'];
$instance['show'] = in_array( $new_instance['show'], array( 'both', 'posts', 'pages' ) ) ?
$new_instance['show'] :
$this->defaults['show'];
$instance['excerpt_length'] = intval( $new_instance['excerpt_length'] );
$instance['title_length'] = intval( $new_instance['title_length'] );
// I want only digits or commas for this:
$instance['exclude'] = preg_replace( '/[^0-9,]/', '', $new_instance['exclude'] );
$instance['cutoff'] = max( intval( $new_instance['cutoff'] ), 0 );
$instance['list_tag'] = in_array( $new_instance['list_tag'], array( 'ul', 'ol', 'none') ) ?
$new_instance['list_tag'] :
$this->defaults['list_tag'];
$instance['category'] = intval( $new_instance['category'] );
$instance['enable_cache'] = ( $new_instance['enable_cache'] ? 1 : 0 );
$instance['cache_only_when_visitor'] = ( $new_instance['cache_only_when_visitor'] ? 1 : 0 );
$instance['magic_number'] = floatval( $new_instance['magic_number'] );
$instance['time_format'] = $new_instance['time_format'];
/* Reset cache */
$cache = get_option( 'wppp_cache' );
unset( $cache[$this->id] );
update_option( 'wppp_cache', $cache );
return $instance;
}
function form( $instance ) {
// Set the settings that are still undefined
$instance = wp_parse_args( (array) $instance, $this->defaults );
$field_id = $this->get_field_id( 'title' );
echo "";
$field_id = $this->get_field_id( 'number' );
echo "";
$field_id = $this->get_field_id( 'days' );
echo "";
$field_id = $this->get_field_id( 'show' );
echo "';
$field_id = $this->get_field_id( 'format' );
echo "";
$field_id = $this->get_field_id( 'excerpt_length' );
echo "";
$field_id = $this->get_field_id( 'time_format' );
echo "";
$field_id = $this->get_field_id( 'title_length' );
echo "";
$field_id = $this->get_field_id( 'exclude' );
echo "";
$field_id = $this->get_field_id( 'cutoff' );
echo "
" . __('(0 means unlimited)', 'wordpresscom-popular-posts' ) . '
';
$field_id = $this->get_field_id( 'list_tag' );
echo "';
// Category stuff
$field_id = $this->get_field_id( 'category' );
echo "';
$field_cache = $field_id = $this->get_field_id( 'enable_cache' );
echo "';
/* This option is enabled only when enable_cache is on. */
$field_id = $this->get_field_id( 'cache_only_when_visitor' );
echo "';
/* JavaScript for cache_only_when_visitor */
echo <<
//
EOF;
$field_id = $this->get_field_id( 'magic_number' );
echo "";
}
function truncateText( $text, $chars = 50 ) {
if ( strlen( $text ) <= $chars || $chars <= 0 )
return $text;
$new = wordwrap( $text, $chars, "|" );
$newtext = explode( "|", $new );
return $newtext[0] . "...";
}
}
endif;
/* You can call this function if you want to integrate the plugin in a theme
* that doesn't support widgets.
*
* Just insert this code:
*
*
* Optionally you can add some parameters to the function, in this format:
* name=value&name=value etc.
*
* Possible names are:
* - title (title of the widget, you can add tags (e.g.
Popular Posts
) default: Popular Posts)
* - number (number of links shown, default: 5)
* - days (length of the time frame of the stats, default 0, i.e. infinite)
* - show (can be: both, posts, pages, default both)
* - format (the format of the links shown, default: %post_title%)
* - time_format (the format used with %post_time%, see http://codex.wordpress.org/Formatting_Date_and_Time)
* - excerpt_length (the length of the excerpt, if %post_excerpt% is used in the format)
* - title_length (the length of the title links, default 0, i.e. unlimited)
* - exclude (the list of post/page IDs to exclude, separated by commas)
* - cutoff (don't show posts/pages with a view count under this number, default 0, i.e. unlimited)
* - list_tag (can be: ul, ol, none, default ul)
* - category (the ID of the category, see FAQ for info. Default 0, i.e. all categories)
* - cachename (it is used to enable the cache. Please see the FAQ)
* - cache_only_when_visitor (if enabled, it doesn't serve a cached version of the popular posts to the users logged in, default 0)
* - magic_number (set it to a number greater than 1 if you see less links than expected)
*
* Example: if you want to show the widget without any title, the 3 most viewed
* articles, in the last week, and in this format: My Article (123 views)
* you will use this:
* WPPP_show_popular_posts( "title=&number=3&days=7&format=%post_title% (%post_views% views)" );
*
* You don't have to fill every field, you can insert only the values you
* want to change from default values.
*
* You can use these special markers in the `format` value:
* %post_permalink% the link to the post
* %post_title% the title the post
* %post_title_attribute% the title of the post; use this in attributes, e.g. defaults );
$wppp->widget( $args );
}
/**
* This function allows using [wp_popular_posts] shortcodes in posts/pages.
*/
function WPPP_shortcode_popular_posts( $user_args = '' ) {
$wppp = new WPPP();
$default_values = $wppp->defaults;
$default_values['from_shortcode'] = true;
$args = shortcode_atts( $default_values, $user_args );
return $wppp->widget( $args );
}
add_shortcode('wp_popular_posts', 'WPPP_shortcode_popular_posts');
function wppp_notice_incompatible() {
echo "