<?php // exit if accessed directly if ( ! defined( 'ABSPATH' ) ) exit; /** * Post_Views_Counter_Counter class. * * @class Post_Views_Counter_Counter */ class Post_Views_Counter_Counter { const GROUP = 'pvc'; const NAME_ALLKEYS = 'cached_key_names'; const CACHE_KEY_SEPARATOR = '.'; const MAX_INSERT_STRING_LENGTH = 25000; private $db_insert_values = ''; private $cookie = array( 'exists' => false, 'visited_posts' => array(), 'expiration' => 0 ); public function __construct() { // actions add_action( 'plugins_loaded', array( $this, 'check_cookie' ), 1 ); add_action( 'deleted_post', array( $this, 'delete_post_views' ) ); add_action( 'wp', array( $this, 'check_post_php' ) ); add_action( 'wp_ajax_pvc-check-post', array( $this, 'check_post_js' ) ); add_action( 'wp_ajax_nopriv_pvc-check-post', array( $this, 'check_post_js' ) ); add_action( 'pvc_ajax_pvc-check-post', array( $this, 'check_post_ajax' ) ); add_action( 'rest_api_init', array( $this, 'rest_api_init' ) ); } /** * Check whether to count visit. * * @param int $id */ public function check_post( $id = 0 ) { // force check post in SHORTINIT mode if ( defined( 'SHORTINIT' ) && SHORTINIT ) $this->check_cookie(); // get post id $id = (int) ( empty( $id ) ? get_the_ID() : $id ); // get user id, from current user or static var in rest api request $user_id = get_current_user_id(); // get user IP address $user_ip = (string) $this->get_user_ip(); // empty id? if ( empty( $id ) ) return; do_action( 'pvc_before_check_visit', $id, $user_id, $user_ip ); // get ips $ips = Post_Views_Counter()->options['general']['exclude_ips']; // whether to count this ip if ( ! empty( $ips ) && filter_var( preg_replace( '/[^0-9a-fA-F:., ]/', '', $user_ip ), FILTER_VALIDATE_IP ) ) { // check ips foreach ( $ips as $ip ) { if ( strpos( $ip, '*' ) !== false ) { if ( $this->ipv4_in_range( $user_ip, $ip ) ) return; } else { if ( $user_ip === $ip ) return; } } } // get groups to check them faster $groups = Post_Views_Counter()->options['general']['exclude']['groups']; // whether to count this user if ( ! empty( $user_id ) ) { // exclude logged in users? if ( in_array( 'users', $groups, true ) ) return; // exclude specific roles? elseif ( in_array( 'roles', $groups, true ) && $this->is_user_role_excluded( $user_id, Post_Views_Counter()->options['general']['exclude']['roles'] ) ) return; // exclude guests? } elseif ( in_array( 'guests', $groups, true ) ) return; // whether to count robots if ( in_array( 'robots', $groups, true ) && Post_Views_Counter()->crawler_detect->is_crawler() ) return; $current_time = current_time( 'timestamp', true ); // cookie already existed? if ( $this->cookie['exists'] ) { // post already viewed but not expired? if ( in_array( $id, array_keys( $this->cookie['visited_posts'] ), true ) && $current_time < $this->cookie['visited_posts'][$id] ) { // update cookie but do not count visit $this->save_cookie( $id, $this->cookie, false ); return; // update cookie } else $this->save_cookie( $id, $this->cookie ); } else { // set new cookie $this->save_cookie( $id ); } $count_visit = (bool) apply_filters( 'pvc_count_visit', true, $id ); // count visit if ( $count_visit ) { // strict counts? if ( Post_Views_Counter()->options['general']['strict_counts'] ) $this->save_ip( $id ); return $this->count_visit( $id ); } else return; } /** * Check whether to count visit via PHP request. */ public function check_post_php() { // do not count admin entries if ( is_admin() && ! ( defined( 'DOING_AJAX' ) && DOING_AJAX ) ) return; // do we use PHP as counter? if ( Post_Views_Counter()->options['general']['counter_mode'] !== 'php' ) return; $post_types = Post_Views_Counter()->options['general']['post_types_count']; // whether to count this post type if ( empty( $post_types ) || ! is_singular( $post_types ) ) return; $this->check_post( get_the_ID() ); } /** * Check whether to count visit via Javascript(Ajax) request. */ public function check_post_js() { if ( isset( $_POST['action'], $_POST['id'], $_POST['pvc_nonce'] ) && $_POST['action'] === 'pvc-check-post' && ($post_id = (int) $_POST['id']) > 0 && wp_verify_nonce( $_POST['pvc_nonce'], 'pvc-check-post' ) !== false ) { // do we use Ajax as counter? if ( Post_Views_Counter()->options['general']['counter_mode'] != 'js' ) exit; // get countable post types $post_types = Post_Views_Counter()->options['general']['post_types_count']; // check if post exists $post = get_post( $post_id ); // whether to count this post type or not if ( empty( $post_types ) || empty( $post ) || ! in_array( $post->post_type, $post_types, true ) ) exit; $this->check_post( $post_id ); } exit; } /** * Check whether to count visit via Fast AJAX request. */ public function check_post_ajax() { if ( isset( $_POST['action'], $_POST['id'], $_POST['pvc_nonce'] ) && $_POST['action'] === 'pvc-check-post' && ($post_id = (int) $_POST['id']) > 0 ) { // do we use Ajax as counter? if ( Post_Views_Counter()->options['general']['counter_mode'] != 'ajax' ) exit; // get countable post types $post_types = Post_Views_Counter()->options['general']['post_types_count']; // check if post exists $post = get_post( $post_id ); // whether to count this post type or not if ( empty( $post_types ) || empty( $post ) || ! in_array( $post->post_type, $post_types, true ) ) exit; $this->check_post( $post_id ); } exit; } /** * Check whether to count visit via REST API request. * * @param array $request * @return int|bool */ public function check_post_rest_api( $request ) { $post_id = absint( $request['id'] ); // do we use REST API as counter? if ( Post_Views_Counter()->options['general']['counter_mode'] != 'rest_api' ) return new WP_Error( 'pvc_rest_api_disabled', __( 'REST API method is disabled.', 'post-views-counter' ), array( 'status' => 404 ) ); // @todo: get current user id in direct api endpoint calls // check if post exists $post = get_post( $post_id ); if ( ! $post ) return new WP_Error( 'pvc_post_invalid_id', __( 'Invalid post ID.', 'post-views-counter' ), array( 'status' => 404 ) ); $post_types = Post_Views_Counter()->options['general']['post_types_count']; // whether to count this post type if ( empty( $post_types ) || ! in_array( $post->post_type, $post_types ) ) return new WP_Error( 'pvc_post_type_excluded', __( 'Post type excluded.', 'post-views-counter' ), array( 'status' => 404 ) ); return $this->check_post( $post_id ); } /** * Initialize cookie session. */ public function check_cookie() { // do not run in admin except for ajax requests if ( is_admin() && ! ( defined( 'DOING_AJAX' ) && DOING_AJAX ) ) return; // assign cookie name $cookie_name = 'pvc_visits' . ( is_multisite() ? '_' . get_current_blog_id() : '' ); // is cookie set? if ( isset( $_COOKIE[$cookie_name] ) && ! empty( $_COOKIE[$cookie_name] ) ) { $visited_posts = $expirations = array(); foreach ( $_COOKIE[$cookie_name] as $content ) { // is cookie valid? if ( preg_match( '/^(([0-9]+b[0-9]+a?)+)$/', $content ) === 1 ) { // get single id with expiration $expiration_ids = explode( 'a', $content ); // check every expiration => id pair foreach ( $expiration_ids as $pair ) { $pair = explode( 'b', $pair ); $expirations[] = (int) $pair[0]; $visited_posts[(int) $pair[1]] = (int) $pair[0]; } } } $this->cookie = array( 'exists' => true, 'visited_posts' => $visited_posts, 'expiration' => max( $expirations ) ); } } /** * Save cookie function. * * @param int $id * @param array $cookie * @param bool $expired */ private function save_cookie( $id, $cookie = array(), $expired = true ) { $set_cookie = apply_filters( 'pvc_maybe_set_cookie', true ); // Cookie Notice compatibility if ( function_exists( 'cn_cookies_accepted' ) && ! cn_cookies_accepted() ) $set_cookie = false; if ( $set_cookie !== true ) return $id; $expiration = $this->get_timestamp( Post_Views_Counter()->options['general']['time_between_counts']['type'], Post_Views_Counter()->options['general']['time_between_counts']['number'] ); // assign cookie name $cookie_name = 'pvc_visits' . ( is_multisite() ? '_' . get_current_blog_id() : '' ); // is this a new cookie? if ( empty( $cookie ) ) { // set cookie setcookie( $cookie_name . '[0]', $expiration . 'b' . $id, $expiration, COOKIEPATH, COOKIE_DOMAIN, (isset( $_SERVER['HTTPS'] ) && $_SERVER['HTTPS'] !== 'off' ? true : false ), true ); } else { if ( $expired ) { // add new id or change expiration date if id already exists $cookie['visited_posts'][$id] = $expiration; } // create copy for better foreach performance $visited_posts_expirations = $cookie['visited_posts']; // get current gmt time $time = current_time( 'timestamp', true ); // check whether viewed id has expired - no need to keep it in cookie (less size) foreach ( $visited_posts_expirations as $post_id => $post_expiration ) { if ( $time > $post_expiration ) unset( $cookie['visited_posts'][$post_id] ); } // set new last expiration date if needed $cookie['expiration'] = max( $cookie['visited_posts'] ); $cookies = $imploded = array(); // create pairs foreach ( $cookie['visited_posts'] as $id => $exp ) { $imploded[] = $exp . 'b' . $id; } // split cookie into chunks (4000 bytes to make sure it is safe for every browser) $chunks = str_split( implode( 'a', $imploded ), 4000 ); // more then one chunk? if ( count( $chunks ) > 1 ) { $last_id = ''; foreach ( $chunks as $chunk_id => $chunk ) { // new chunk $chunk_c = $last_id . $chunk; // is it full-length chunk? if ( strlen( $chunk ) === 4000 ) { // get last part $last_part = strrchr( $chunk_c, 'a' ); // get last id $last_id = substr( $last_part, 1 ); // add new full-lenght chunk $cookies[$chunk_id] = substr( $chunk_c, 0, strlen( $chunk_c ) - strlen( $last_part ) ); } else { // add last chunk $cookies[$chunk_id] = $chunk_c; } } } else { // only one chunk $cookies[] = $chunks[0]; } foreach ( $cookies as $key => $value ) { // set cookie setcookie( $cookie_name . '[' . $key . ']', $value, $cookie['expiration'], COOKIEPATH, COOKIE_DOMAIN, (isset( $_SERVER['HTTPS'] ) && $_SERVER['HTTPS'] !== 'off' ? true : false ), true ); } } } /** * Save user IP function. * * @param int $id */ private function save_ip( $id ) { $set_cookie = apply_filters( 'pvc_maybe_set_cookie', true ); // Cookie Notice compatibility if ( function_exists( 'cn_cookies_accepted' ) && ! cn_cookies_accepted() ) $set_cookie = false; if ( $set_cookie !== true ) return $id; // get IP cached visits $ip_cache = get_transient( 'post_views_counter_ip_cache' ); if ( ! $ip_cache ) $ip_cache = array(); // get user IP address $user_ip = (string) $this->get_user_ip(); // get current time $current_time = current_time( 'timestamp', true ); // visit exists in transient? if ( isset( $ip_cache[$id][$user_ip] ) ) { if ( $current_time > $ip_cache[$id][$user_ip] + $this->get_timestamp( Post_Views_Counter()->options['general']['time_between_counts']['type'], Post_Views_Counter()->options['general']['time_between_counts']['number'], false ) ) $ip_cache[$id][$user_ip] = $current_time; else return; } else $ip_cache[$id][$user_ip] = $current_time; // keep it light, only 10 records per post and maximum 100 post records (=> max. 1000 ip entries) // also, the data gets deleted after a week if there's no activity during this time... if ( count( $ip_cache[$id] ) > 10 ) $ip_cache[$id] = array_slice( $ip_cache[$id], -10, 10, true ); if ( count( $ip_cache ) > 100 ) $ip_cache = array_slice( $ip_cache, -100, 100, true ); set_transient( 'post_views_counter_ip_cache', $ip_cache, WEEK_IN_SECONDS ); } /** * Count visit function. * * @global object $wpdb * @param int $id * @return int $id */ private function count_visit( $id ) { global $wpdb; $cache_key_names = array(); $using_object_cache = $this->using_object_cache(); $increment_amount = (int) apply_filters( 'pvc_views_increment_amount', 1, $id ); // get day, week, month and year $date = explode( '-', date( 'W-d-m-Y-o', current_time( 'timestamp', true ) ) ); foreach ( array( 0 => $date[3] . $date[2] . $date[1], // day like 20140324 1 => $date[4] . $date[0], // week like 201439 2 => $date[3] . $date[2], // month like 201405 3 => $date[3], // year like 2014 4 => 'total' // total views ) as $type => $period ) { if ( $using_object_cache ) { $cache_key = $id . self::CACHE_KEY_SEPARATOR . $type . self::CACHE_KEY_SEPARATOR . $period; wp_cache_add( $cache_key, 0, self::GROUP ); wp_cache_incr( $cache_key, $increment_amount, self::GROUP ); $cache_key_names[] = $cache_key; } else { // hit the db directly // @TODO: investigate queueing these queries on the 'shutdown' hook instead of running them instantly? $this->db_insert( $id, $type, $period, $increment_amount ); } } // update the list of cache keys to be flushed if ( $using_object_cache && ! empty( $cache_key_names ) ) $this->update_cached_keys_list_if_needed( $cache_key_names ); do_action( 'pvc_after_count_visit', $id ); return $id; } /** * Remove post views from database when post is deleted. * * @global object $wpdb * @param int $post_id */ public function delete_post_views( $post_id ) { global $wpdb; $wpdb->delete( $wpdb->prefix . 'post_views', array( 'id' => $post_id ), array( '%d' ) ); } /** * Get timestamp convertion. * * @param string $type * @param int $number * @param int $timestamp * @return string */ public function get_timestamp( $type, $number, $timestamp = true ) { $converter = array( 'minutes' => 60, 'hours' => 3600, 'days' => 86400, 'weeks' => 604800, 'months' => 2592000, 'years' => 946080000 ); return (int) ( ( $timestamp ? current_time( 'timestamp', true ) : 0 ) + $number * $converter[$type] ); } /** * Check if object cache is in use. * * @param bool $using * @return bool */ public function using_object_cache( $using = null ) { $using = wp_using_ext_object_cache( $using ); if ( $using ) { // check if explicitly disabled by flush_interval setting/option <= 0 $flush_interval_number = Post_Views_Counter()->options['general']['flush_interval']['number']; $using = ( $flush_interval_number <= 0 ) ? false : true; } return $using; } /** * Update the single cache key which holds a list of all the cache keys * that need to be flushed to the db. * * The value of that special cache key is a giant string containing key names separated with the `|` character. * Each such key name then consists of 3 elements: $id, $type, $period (separated by a `.` character). * Examples: * 62053.0.20150327|62053.1.201513|62053.2.201503|62053.3.2015|62053.4.total|62180.0.20150327|62180.1.201513|62180.2.201503|62180.3.2015|62180.4.total * A single key is `62053.0.20150327` and that key's data is: $id = 62053, $type = 0, $period = 20150327 * * This data format proved more efficient (avoids the (un)serialization overhead completely + duplicates filtering is a string search now) * * @param array $key_names */ private function update_cached_keys_list_if_needed( $key_names = array() ) { $existing_list = wp_cache_get( self::NAME_ALLKEYS, self::GROUP ); if ( ! $existing_list ) $existing_list = ''; $list_modified = false; // modify the list contents if/when needed if ( empty( $existing_list ) ) { // the simpler case of an empty initial list where we just // transform the specified key names into a string $existing_list = implode( '|', $key_names ); $list_modified = true; } else { // search each specified key name and append it if it's not found foreach ( $key_names as $key_name ) { if ( false === strpos( $existing_list, $key_name ) ) { $existing_list .= '|' . $key_name; $list_modified = true; } } } // save modified list back in cache if ( $list_modified ) { wp_cache_set( self::NAME_ALLKEYS, $existing_list, self::GROUP ); } } /** * Flush views data stored in the persistent object cache into * our custom table and clear the object cache keys when done. * * @global object $wpdb * @return bool */ public function flush_cache_to_db() { global $wpdb; $key_names = wp_cache_get( self::NAME_ALLKEYS, self::GROUP ); if ( ! $key_names ) $key_names = array(); else { // create an array out of a string that's stored in the cache $key_names = explode( '|', $key_names ); } foreach ( $key_names as $key_name ) { // get values stored within the key name itself list( $id, $type, $period ) = explode( self::CACHE_KEY_SEPARATOR, $key_name ); // get the cached count value $count = wp_cache_get( $key_name, self::GROUP ); // store cached value in the db $this->db_prepare_insert( $id, $type, $period, $count ); // clear the cache key we just flushed wp_cache_delete( $key_name, self::GROUP ); } // actually flush values to db (if any left) $this->db_commit_insert(); // remember last flush to db time wp_cache_set( 'last-flush', time(), self::GROUP ); // delete the key holding the list itself after we've successfully flushed it if ( ! empty( $key_names ) ) wp_cache_delete( self::NAME_ALLKEYS, self::GROUP ); return true; } /** * Insert or update views count. * * @global object $wpdb * @param int $id * @param string $type * @param string $period * @param int $count * @return bool */ private function db_insert( $id, $type, $period, $count = 1 ) { global $wpdb; $count = (int) $count; if ( ! $count ) $count = 1; return $wpdb->query( $wpdb->prepare( " INSERT INTO " . $wpdb->prefix . "post_views (id, type, period, count) VALUES (%d, %d, %s, %d) ON DUPLICATE KEY UPDATE count = count + %d", $id, $type, $period, $count, $count ) ); } /** * Prepare bulk insert or update views count. * * @param int $id * @param string $type * @param string $period * @param int $count * @return void */ private function db_prepare_insert( $id, $type, $period, $count = 1 ) { $count = (int) $count; if ( ! $count ) $count = 1; if ( ! empty( $this->db_insert_values ) ) $this->db_insert_values .= ', '; $this->db_insert_values .= sprintf( '(%d, %d, "%s", %d)', $id, $type, $period, $count ); if ( strlen( $this->db_insert_values ) > self::MAX_INSERT_STRING_LENGTH ) $this->db_commit_insert(); } /** * Insert accumulated values to database. * * @global object $wpdb * @return bool */ private function db_commit_insert() { if ( empty( $this->db_insert_values ) ) return false; global $wpdb; // $result = $wpdb->query( " // INSERT INTO " . $wpdb->prefix . "post_views (id, type, period, count) // VALUES " . $this->db_insert_values . " // ON DUPLICATE KEY UPDATE count = count + VALUES(count)" // ); $this->db_insert_values = ''; // return $result; } /** * Check whether user has excluded roles. * * @param string $option * @return bool */ public function is_user_role_excluded( $user_id, $option ) { $user = get_user_by( 'id', $user_id ); if ( empty( $user ) ) return false; $roles = (array) $user->roles; if ( ! empty( $roles ) ) { foreach ( $roles as $role ) { if ( in_array( $role, $option, true ) ) return true; } } return false; } /** * Check if IPv4 is in range. * * @param string $ip IP address * @param string $range IP range * @return boolean Whether IP is in range */ public function ipv4_in_range( $ip, $range ) { $start = str_replace( '*', '0', $range ); $end = str_replace( '*', '255', $range ); $ip = (float) sprintf( "%u", ip2long( $ip ) ); return ( $ip >= (float) sprintf( "%u", ip2long( $start ) ) && $ip <= (float) sprintf( "%u", ip2long( $end ) ) ); } /** * Get user real IP address. * * @return string */ public function get_user_ip() { foreach ( array( 'HTTP_CLIENT_IP', 'HTTP_X_FORWARDED_FOR', 'HTTP_X_FORWARDED', 'HTTP_X_CLUSTER_CLIENT_IP', 'HTTP_FORWARDED_FOR', 'HTTP_FORWARDED', 'REMOTE_ADDR' ) as $key ) { if ( array_key_exists( $key, $_SERVER ) === true ) { foreach ( explode( ',', $_SERVER[$key] ) as $ip ) { // trim for safety measures $ip = trim( $ip ); // attempt to validate IP if ( $this->validate_user_ip( $ip ) ) return $ip; } } } return isset( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : ''; } /** * Ensure an ip address is both a valid IP and does not fall within a private network range. * * @param $ip * @return bool */ public function validate_user_ip( $ip ) { if ( filter_var( $ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4 | FILTER_FLAG_NO_PRIV_RANGE | FILTER_FLAG_NO_RES_RANGE ) === false ) return false; return true; } /** * Register REST API endpoints. * * @return void */ public function rest_api_init() { // view post route register_rest_route( 'post-views-counter', '/view-post/', array( 'methods' => array( 'GET', 'POST' ), 'callback' => array( $this, 'check_post_rest_api' ), 'args' => array( 'id' => array( 'default' => 0, 'sanitize_callback' => 'absint' ) ) ) ); // get views route register_rest_route( 'post-views-counter', '/get-post-views/', array( 'methods' => array( 'GET', 'POST' ), 'callback' => array( $this, 'get_post_views_rest_api' ), 'permission_callback' => array( $this, 'get_post_views_permissions_check' ), 'args' => array( 'id' => array( 'default' => 0, 'user_id' => get_current_user_id() ) ) ) ); } /** * Get post views via REST API request. * * @param array $request * @return int */ public function get_post_views_rest_api( $request ) { $post_id = is_array( $request['id'] ) ? array_map( 'absint', $request['id'] ) : absint( $request['id'] ); return pvc_get_post_views( $post_id ); } /** * Check if a given request has access to get views * * @param WP_REST_Request $request Full data about the request. * @return WP_Error|bool */ public function get_post_views_permissions_check( $request ) { return (bool) apply_filters( 'pvc_rest_api_get_post_views_check', true, $request ); } }
