post-views-counter.php

<?php
/*
Plugin Name: Post Views Counter
Description: Forget WP-PostViews. Display how many times a post, page or custom post type had been viewed in a simple, fast and reliable way.
Version: 1.2.1
Author: dFactory
Author URI: http://www.dfactory.eu/
Plugin URI: http://www.dfactory.eu/plugins/post-views-counter/
License: MIT License
License URI: http://opensource.org/licenses/MIT
Text Domain: post-views-counter
Domain Path: /languages

Post Views Counter
Copyright (C) 2014-2016, Digital Factory - info@digitalfactory.pl

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

// exit if accessed directly
if ( ! defined( 'ABSPATH' ) )
	exit;

if ( ! class_exists( 'Post_Views_Counter' ) ) :

/**
 * Post Views Counter final class.
 *
 * @class Post_Views_Counter
 * @version	1.2.1
 */
final class Post_Views_Counter {

	private static $instance;
	public $options;
	public $defaults = array(
		'general' => array(
			'post_types_count'		=> array( 'post' ),
			'counter_mode'			=> 'php',
			'post_views_column'		=> true,
			'time_between_counts'	=> array(
				'number' => 24,
				'type'	 => 'hours'
			),
			'reset_counts'			=> array(
				'number' => 30,
				'type'	 => 'days'
			),
			'flush_interval'		=> array(
				'number' => 0,
				'type'	 => 'minutes'
			),
			'exclude'				=> array(
				'groups' => array(),
				'roles'	 => array()
			),
			'exclude_ips'			=> array(),
			'restrict_edit_views'	=> false,
			'deactivation_delete'	=> false,
			'cron_run'				=> true,
			'cron_update'			=> true
		),
		'display' => array(
			'label'				 	=> 'Post Views:',
			'post_types_display' 	=> array( 'post' ),
			'page_types_display'	=> array( 'singular' ),
			'restrict_display'	 	=> array(
				'groups' => array(),
				'roles'	 => array()
			),
			'position'			 	=> 'after',
			'display_style'		 	=> array(
				'icon'	 => true,
				'text'	 => true
			),
			'link_to_post'		 	=> true,
			'icon_class'		 	=> 'dashicons-chart-bar'
		),
		'version' => '1.2.1'
	);

	/**
	 * Disable object clone.
	 */
	private function __clone() {}

	/**
	 * Disable unserializing of the class.
	 */
	private function __wakeup() {}

	/**
	 * Main Post_Views_Counter instance,
	 * Insures that only one instance of Post_Views_Counter exists in memory at one time.
	 * 
	 * @return object
	 */
	public static function instance() {
		if ( ! isset( self::$instance ) && ! ( self::$instance instanceof Post_Views_Counter ) ) {
			self::$instance = new Post_Views_Counter;
			self::$instance->define_constants();

			add_action( 'plugins_loaded', array( self::$instance, 'load_textdomain' ) );

			self::$instance->includes();
			self::$instance->update		= new Post_Views_Counter_Update();
			self::$instance->settings	= new Post_Views_Counter_Settings();
			self::$instance->query		= new Post_Views_Counter_Query();
			self::$instance->cron		= new Post_Views_Counter_Cron();
			self::$instance->counter	= new Post_Views_Counter_Counter();
			self::$instance->columns	= new Post_Views_Counter_Columns();
			self::$instance->frontend	= new Post_Views_Counter_Frontend();
			self::$instance->dashboard	= new Post_Views_Counter_Dashboard();
			self::$instance->widgets	= new Post_Views_Counter_Widgets();
		}
		return self::$instance;
	}

	/**
	 * Setup plugin constants.
	 *
	 * @return void
	 */
	private function define_constants() {
		define( 'POST_VIEWS_COUNTER_URL', plugins_url( '', __FILE__ ) );
		define( 'POST_VIEWS_COUNTER_PATH', plugin_dir_path( __FILE__ ) );
		define( 'POST_VIEWS_COUNTER_REL_PATH', dirname( plugin_basename( __FILE__ ) ) . '/' );
	}

	/**
	 * Include required files
	 *
	 * @return void
	 */
	private function includes() {
		include_once( POST_VIEWS_COUNTER_PATH . 'includes/update.php' );
		include_once( POST_VIEWS_COUNTER_PATH . 'includes/settings.php' );
		include_once( POST_VIEWS_COUNTER_PATH . 'includes/columns.php' );
		include_once( POST_VIEWS_COUNTER_PATH . 'includes/query.php' );
		include_once( POST_VIEWS_COUNTER_PATH . 'includes/cron.php' );
		include_once( POST_VIEWS_COUNTER_PATH . 'includes/counter.php' );
		include_once( POST_VIEWS_COUNTER_PATH . 'includes/frontend.php' );
		include_once( POST_VIEWS_COUNTER_PATH . 'includes/dashboard.php' );
		include_once( POST_VIEWS_COUNTER_PATH . 'includes/widgets.php' );
	}

	/**
	 * Class constructor.
	 * 
	 * @return void
	 */
	public function __construct() {
		register_activation_hook( __FILE__, array( $this, 'activation' ) );
		register_deactivation_hook( __FILE__, array( $this, 'deactivation' ) );

		// settings
		$this->options = array(
			'general'	=> array_merge( $this->defaults['general'], get_option( 'post_views_counter_settings_general', $this->defaults['general'] ) ),
			'display'	=> array_merge( $this->defaults['display'], get_option( 'post_views_counter_settings_display', $this->defaults['display'] ) )
		);

		// actions
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_scripts_styles' ) );
		add_action( 'wp_loaded', array( $this, 'load_pluggable_functions' ), 10 );

		// filters
		add_filter( 'plugin_row_meta', array( $this, 'plugin_extend_links' ), 10, 2 );
		add_filter( 'plugin_action_links', array( $this, 'plugin_settings_link' ), 10, 2 );
	}

	/**
	 * Plugin activation function.
	 */
	public function activation() {
		global $wpdb, $charset_collate;

		// required for dbdelta
		require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );

		// create post views table
		dbDelta( '
			CREATE TABLE IF NOT EXISTS ' . $wpdb->prefix . 'post_views (
				id bigint unsigned NOT NULL,
				type tinyint(1) unsigned NOT NULL,
				period varchar(8) NOT NULL,
				count bigint unsigned NOT NULL,
				PRIMARY KEY  (type, period, id),
				UNIQUE INDEX id_period (id, period) USING BTREE,
				INDEX type_period_count (type, period, count) USING BTREE
			) ' . $charset_collate . ';'
		);

		// add default options
		add_option( 'post_views_counter_settings_general', $this->defaults['general'], '', 'no' );
		add_option( 'post_views_counter_settings_display', $this->defaults['display'], '', 'no' );
		add_option( 'post_views_counter_version', $this->defaults['version'], '', 'no' );

		// schedule cache flush
		$this->schedule_cache_flush();
	}

	/**
	 * Plugin deactivation function.
	 */
	public function deactivation() {
		// delete default options
		if ( $this->options['general']['deactivation_delete'] ) {
			delete_option( 'post_views_counter_settings_general' );
			delete_option( 'post_views_counter_settings_display' );
		}

		// remove schedule
		wp_clear_scheduled_hook( 'pvc_reset_counts' );
		remove_action( 'pvc_reset_counts', array( Post_Views_Counter()->cron, 'reset_counts' ) );

		$this->remove_cache_flush();
	}

	/**
	 * Schedule cache flushing if it's not already scheduled.
	 */
	public function schedule_cache_flush( $forced = true ) {
		if ( $forced || ! wp_next_scheduled( 'pvc_flush_cached_counts' ) ) {
			wp_schedule_event( time(), 'post_views_counter_flush_interval', 'pvc_flush_cached_counts' );
		}
	}

	/**
	 * Remove scheduled cache flush and the corresponding action.
	 */
	public function remove_cache_flush() {
		wp_clear_scheduled_hook( 'pvc_flush_cached_counts' );
		remove_action( 'pvc_flush_cached_counts', array( Post_Views_Counter()->cron, 'flush_cached_counts' ) );
	}

	/**
	 * Load text domain.
	 */
	public function load_textdomain() {
		load_plugin_textdomain( 'post-views-counter', false, POST_VIEWS_COUNTER_REL_PATH . 'languages/' );
	}

	/**
	 * Load pluggable template functions.
	 */
	public function load_pluggable_functions() {
		include_once( POST_VIEWS_COUNTER_PATH . 'includes/functions.php' );
	}

	/**
	 * Enqueue admin scripts and styles.
	 */
	public function admin_scripts_styles( $page ) {
		wp_register_style(
			'pvc-admin', POST_VIEWS_COUNTER_URL . '/css/admin.css'
		);

		wp_register_script(
			'pvc-admin-settings', POST_VIEWS_COUNTER_URL . '/js/admin-settings.js', array( 'jquery' ), $this->defaults['version']
		);

		wp_register_script(
			'pvc-admin-post', POST_VIEWS_COUNTER_URL . '/js/admin-post.js', array( 'jquery' ), $this->defaults['version']
		);
		
		wp_register_script(
			'pvc-admin-quick-edit', POST_VIEWS_COUNTER_URL . '/js/admin-quick-edit.js', array( 'jquery', 'inline-edit-post' ), $this->defaults['version']
		);		

		// load on PVC settings page
		if ( $page === 'settings_page_post-views-counter' ) {

			wp_enqueue_script( 'pvc-admin-settings' );

			wp_localize_script(
				'pvc-admin-settings', 'pvcArgsSettings', array(
				'resetToDefaults' => __( 'Are you sure you want to reset these settings to defaults?', 'post-views-counter' )
				)
			);

			wp_enqueue_style( 'pvc-admin' );

			// load on single post page
		} elseif ( $page === 'post.php' || $page === 'post-new.php' ) {

			$post_types = Post_Views_Counter()->options['general']['post_types_count'];

			global $post_type;

			if ( ! in_array( $post_type, (array) $post_types ) )
				return;
			
			wp_enqueue_style( 'pvc-admin' );
			wp_enqueue_script( 'pvc-admin-post' );
		} elseif ( $page === 'edit.php' ) {
			$post_types = Post_Views_Counter()->options['general']['post_types_count'];
			
			global $post_type;

			if ( ! in_array( $post_type, (array) $post_types ) )
				return;

			wp_enqueue_style( 'pvc-admin' );
			wp_enqueue_script( 'pvc-admin-quick-edit' );
		}
	}
	
	/**
	 * Add links to plugin support forum.
	 */
	public function plugin_extend_links( $links, $file ) {

		if ( ! current_user_can( 'install_plugins' ) )
			return $links;

		$plugin = plugin_basename( __FILE__ );

		if ( $file == $plugin ) {
			return array_merge(
				$links, array( sprintf( '<a href="http://www.dfactory.eu/support/forum/post-views-counter/" target="_blank">%s</a>', __( 'Support', 'post-views-counter' ) ) )
			);
		}

		return $links;
	}

	/**
	 * Add link to settings page.
	 */
	public function plugin_settings_link( $links, $file ) {
		if ( ! is_admin() || ! current_user_can( 'manage_options' ) )
			return $links;

		static $plugin;

		$plugin = plugin_basename( __FILE__ );

		if ( $file == $plugin ) {
			$settings_link = sprintf( '<a href="%s">%s</a>', admin_url( 'options-general.php' ) . '?page=post-views-counter', __( 'Settings', 'post-views-counter' ) );

			array_unshift( $links, $settings_link );
		}

		return $links;
	}

}

endif; // end if class_exists check

/**
 * Initialise Post Views Counter.
 * 
 * @return object
 */
function Post_Views_Counter() {
	static $instance;

	// first call to instance() initializes the plugin
	if ( $instance === null || ! ( $instance instanceof Post_Views_Counter ) )
		$instance = Post_Views_Counter::instance();

	return $instance;
}

Post_Views_Counter();