root/wp-useronline/trunk/wp-useronline.php

<?php
/*
Plugin Name: WP-UserOnline
Plugin URI: http://lesterchan.net/portfolio/programming/php/
Description: Enable you to display how many users are online on your Wordpress blog with detailed statistics of where they are and who there are(Members/Guests/Search Bots).
Version: 2.31
Author: Lester 'GaMerZ' Chan
Author URI: http://lesterchan.net
*/


/*  
    Copyright 2008  Lester Chan  (email : lesterchan@gmail.com)

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/


### Load WP-Config File If This File Is Called Directly
if (!function_exists('add_action')) {
    $wp_root = '../../..';
    if (file_exists($wp_root.'/wp-load.php')) {
        require_once($wp_root.'/wp-load.php');
    } else {
        require_once($wp_root.'/wp-config.php');
    }
}


### Use WordPress 2.6 Constants
if (!defined('WP_CONTENT_DIR')) {
    define( 'WP_CONTENT_DIR', ABSPATH.'wp-content');
}
if (!defined('WP_CONTENT_URL')) {
    define('WP_CONTENT_URL', get_option('siteurl').'/wp-content');
}
if (!defined('WP_PLUGIN_DIR')) {
    define('WP_PLUGIN_DIR', WP_CONTENT_DIR.'/plugins');
}
if (!defined('WP_PLUGIN_URL')) {
    define('WP_PLUGIN_URL', WP_CONTENT_URL.'/plugins');
}


### Create Text Domain For Translations
add_action('init', 'useronline_textdomain');
function useronline_textdomain() {
    if (!function_exists('wp_print_styles')) {
        load_plugin_textdomain('wp-useronline', 'wp-content/plugins/wp-useronline');
    } else {
        load_plugin_textdomain('wp-useronline', false, 'wp-useronline');
    }
}


### UserOnline Table Name
global $wpdb;
$wpdb->useronline = $wpdb->prefix.'useronline';


### Function: WP-UserOnline Menu
add_action('admin_menu', 'useronline_menu');
function useronline_menu() {
    if (function_exists('add_submenu_page')) {
        add_submenu_page('index.php',  __('WP-UserOnline', 'wp-useronline'),  __('WP-UserOnline', 'wp-useronline'), 1, 'wp-useronline/wp-useronline.php', 'display_useronline');
    }
    if (function_exists('add_options_page')) {
        add_options_page(__('Useronline', 'wp-useronline'), __('Useronline', 'wp-useronline'), 'manage_options', 'wp-useronline/useronline-options.php');
    }
}


### Function: Displays UserOnline Header
add_action('wp_head', 'useronline_header');
function useronline_header() {
    wp_register_script('wp-useronline', WP_PLUGIN_URL.'/wp-useronline/useronline-js-packed.js', false, '2.31');
    echo "\n".'<!-- Start Of Script Generated By WP-UserOnline 2.31 -->'."\n";
    echo '<script type="text/javascript">'."\n";
    echo '/* <![CDATA[ */'."\n";
    echo "\t".'var useronline_ajax_url = \''.WP_PLUGIN_URL.'/wp-useronline/wp-useronline.php'."';\n";
    echo "\t".'var useronline_timeout = '.(get_option('useronline_timeout')*1000).';'."\n";
    echo '/* ]]> */'."\n";
    echo '</script>'."\n";
    wp_print_scripts(array('sack', 'wp-useronline'));
    echo '<!-- End Of Script Generated By WP-UserOnline 2.31 -->'."\n";
}


### Function: Process UserOnline
add_action('admin_head', 'useronline');
add_action('wp_head', 'useronline');
function useronline() {
    global $wpdb, $useronline;
    // Useronline Settings
    $timeoutseconds = get_option('useronline_timeout');
    $timestamp = current_time('timestamp');
    $timeout = ($timestamp-$timeoutseconds);
    $ip = get_ipaddress();
    $url = addslashes(urlencode($_SERVER['REQUEST_URI']));
    $referral = '';
    $useragent = $_SERVER['HTTP_USER_AGENT'];
    $current_user = wp_get_current_user();
    if(!empty($_SERVER['HTTP_REFERER'])) {
        $referral = addslashes(urlencode(strip_tags($_SERVER['HTTP_REFERER'])));
    }
    // Check For Bot
    $bots = get_option('useronline_bots');
    foreach ($bots as $name => $lookfor) { 
        if (stristr($useragent, $lookfor) !== false) { 
            $user_id = 0;
            $display_name = addslashes($name);
            $user_name = addslashes($lookfor);        
            $type = 'bot';
            $where = "WHERE ip = '$ip'";
            $bot_found = true;
            break;
        } 
    }

    // If No Bot Is Found, Then We Check Members And Guests
    if(!$bot_found) {
        // Check For Member
        if($current_user->ID > 0) {
            $user_id = $current_user->ID;
            $display_name = addslashes($current_user->display_name);
            $user_name = addslashes($current_user->user_login);        
            $type = 'member';
            $where = "WHERE userid = '$user_id'";
        // Check For Comment Author (Guest)
        } elseif(!empty($_COOKIE['comment_author_'.COOKIEHASH])) {
            $user_id = 0;
            $display_name = addslashes(trim($_COOKIE['comment_author_'.COOKIEHASH]));
            $user_name = __('guest', 'wp-useronline').'_'.$display_name;        
            $type = 'guest';
            $where = "WHERE ip = '$ip'";
        // Check For Guest
        } else {
            $user_id = 0;
            $display_name = __('Guest', 'wp-useronline');
            $user_name = "guest";        
            $type = 'guest';
            $where = "WHERE ip = '$ip'";
        }
    }

    // Get User Agent
    $useragent = addslashes($useragent);

    // Check For Page Title
    $make_page = wp_title('&raquo;', false);
    if(empty($make_page)) {
        $make_page = get_bloginfo('name');
    } elseif(is_single()) {
        $make_page = get_bloginfo('name').' &raquo; '.__('Blog Archive', 'wp-useronline').' '.$make_page;
    } else {
        $make_page = get_bloginfo('name').$make_page;
    }
    $make_page = addslashes($make_page);
    
    // Delete Users
    $delete_users = $wpdb->query("DELETE FROM $wpdb->useronline $where OR (timestamp < $timeout)");
    
    // Insert Users
    $insert_user = $wpdb->query("INSERT INTO $wpdb->useronline VALUES ('$timestamp', '$user_id', '$user_name', '$display_name', '$useragent', '$ip', '$make_page', '$url', '$type', '$referral')");

    // Count Users Online
    $useronline = intval($wpdb->get_var("SELECT COUNT(*) FROM $wpdb->useronline"));
    
    // Get Most User Online
    $most_useronline = intval(get_option('useronline_most_users'));

    // Check Whether Current Users Online Is More Than Most Users Online
    if($useronline > $most_useronline) {
        update_option('useronline_most_users', $useronline);
        update_option('useronline_most_timestamp', current_time('timestamp'));
    }
}


### Function: Display UserOnline
if(!function_exists('get_useronline')) {
    function get_useronline($display = true) {
        // Template - Naming Conventions
        $useronline_naming = get_option('useronline_naming');
        // Template - User(s) Online
        $template_useronline = stripslashes(get_option('useronline_template_useronline'));
        $template_useronline = str_replace('%USERONLINE_PAGE_URL%', get_option('useronline_url'), $template_useronline);
        $template_useronline = str_replace('%USERONLINE_MOSTONLINE_COUNT%', number_format_i18n(get_most_useronline()), $template_useronline);
        $template_useronline = str_replace('%USERONLINE_MOSTONLINE_DATE%', get_most_useronline_date(), $template_useronline);
        if(get_useronline_count() == 1) {
            $template_useronline = str_replace('%USERONLINE_USERS%', stripslashes($useronline_naming['user']), $template_useronline);            
        } else {
            $useronline_naming_users = str_replace('%USERONLINE_COUNT%', number_format_i18n(get_useronline_count()), stripslashes($useronline_naming['users']));
            $template_useronline = str_replace('%USERONLINE_USERS%', $useronline_naming_users, $template_useronline);
        }
        if($display) {
            echo $template_useronline;
        } else {
            return $template_useronline;
        }
    }
}


### Function: Display UserOnline Count
if(!function_exists('get_useronline_count')) {
    function get_useronline_count($display = false) {
        global $useronline;
        if($display) {
            echo number_format_i18n($useronline);
        } else {
            return $useronline;
        }
    }
}


### Function: Display Max UserOnline
if(!function_exists('get_most_useronline')) {
    function get_most_useronline($display = false) {
        $most_useronline_users = intval(get_option('useronline_most_users'));
        if($display) {
            echo number_format_i18n($most_useronline_users);
        } else {
            return $most_useronline_users;
        }
    }
}


### Function: Display Max UserOnline Date
if(!function_exists('get_most_useronline_date')) {
    function get_most_useronline_date($display = false) {
        $most_useronline_timestamp = get_option('useronline_most_timestamp');
        $most_useronline_date = mysql2date(sprintf(__('%s @ %s', 'wp-useronline'), get_option('date_format'), get_option('time_format')), gmdate('Y-m-d H:i:s', $most_useronline_timestamp));
        if($display) {
            echo $most_useronline_date;
        } else {
            return $most_useronline_date;
        }
    }
}


### Function Check If User Is Online
function is_online($user_login) { 
    global $wpdb;
    $is_online = $wpdb->get_var("SELECT COUNT(*) FROM $wpdb->useronline WHERE username = '$user_login' LIMIT 1");
    return intval($is_online);
}



### Function: Update Member last Visit
//add_action('wp_head', 'update_memberlastvisit');
function update_memberlastvisit() {
    global $current_user, $user_ID;
    if(!empty($current_user) && intval($user_ID) > 0) {
        update_user_option($user_ID, 'member_last_login', current_time('timestamp'));   
    }
}


### Function: Get Member last Visit
function get_memberlastvisit($user_id = 0) {
    $date_format = sprintf(__('%s @ %s', 'wp-useronline'), get_option('date_format'), get_option('time_format'));
    if($user_id == 0) {
        return mysql2date($date_format, gmdate('Y-m-d H:i:s', get_user_option('member_last_login')));
    } else {
        return mysql2date($date_format, gmdate('Y-m-d H:i:s', get_user_option('member_last_login', $user_id)));
    }
}


### Function: Display Users Browsing The Site
function get_users_browsing_site($display = true) {
    global $wpdb;

    // Get Users Browsing Site
    $page_url = addslashes(urlencode($_SERVER['REQUEST_URI']));
    $users_browse = $wpdb->get_results("SELECT displayname, type FROM $wpdb->useronline ORDER BY type");

    // Variables
    $members = array();
    $guests = array();
    $bots = array();
    $total_members = 0;
    $total_guests = 0;
    $total_bots = 0;
    $nicetext_members = '';
    $nicetext_guests = '';
    $nicetext_bots = '';

    // If There Is Users Browsing, Then We Execute
    if($users_browse) {
        // Get Users Information
        foreach($users_browse as $user_browse) {
            switch($user_browse->type) {
                case 'member':
                    $members[] = stripslashes($user_browse->displayname);
                    $total_members++;
                    break;
                case 'guest':                        
                    $guests[] = stripslashes($user_browse->displayname);
                    $total_guests++;
                    break;
                case 'bot':
                    $bots[] = stripslashes($user_browse->displayname);
                    $total_bots++;
                    break;
            }
        }

        // If We Do Not Display It, Return Respective Users Count
        if(!$display) {
            return array($total_members, $total_guests, $total_bots);
        } 
        
        // Template - Naming Conventions
        $useronline_naming = get_option('useronline_naming');

        // Template - User(s) Browsing Site
        $options_browsingsite = get_option('useronline_template_browsingsite');
        $separator_members_browsingsite = stripslashes($options_browsingsite[0]);
        $separator_guests_browsingsite = stripslashes($options_browsingsite[1]);
        $separator_bots_browsingsite = stripslashes($options_browsingsite[2]);
        $template_browsingsite = stripslashes($options_browsingsite[3]);

        // Nice Text For Users
        if(get_useronline_count() == 1) {
            $template_browsingsite = str_replace('%USERONLINE_USERS%', stripslashes($useronline_naming['user']), $template_browsingsite);        
        } else {
            $useronline_naming_users = str_replace('%USERONLINE_COUNT%', number_format_i18n(get_useronline_count()), stripslashes($useronline_naming['users']));
            $template_browsingsite = str_replace('%USERONLINE_USERS%', $useronline_naming_users, $template_browsingsite);
        }

        // Print Member Name
        if($members) {
            $temp_member = '';
            if(!function_exists('get_totalposts')) {
                foreach($members as $member) {
                    $temp_member .= $member.$separator_members_browsingsite;
                }
            } else {
                foreach($members as $member) {
                    $temp_member .= useronline_stats_page_link($member).$separator_members_browsingsite;
                }
            }
            $template_browsingsite = str_replace('%USERONLINE_MEMBER_NAMES%', substr($temp_member, 0, -strlen($separator_members_browsingsite)), $template_browsingsite);
        } else {
            $template_browsingsite = str_replace('%USERONLINE_MEMBER_NAMES%', '', $template_browsingsite);
        }

        // Nice Text For Members
        if($total_members > 1) { 
            $useronline_naming_members = str_replace('%USERONLINE_COUNT%', number_format_i18n($total_members), stripslashes($useronline_naming['members']));
            $template_browsingsite = str_replace('%USERONLINE_MEMBERS%', $useronline_naming_members, $template_browsingsite);
        } elseif($total_members == 1) {
            $template_browsingsite = str_replace('%USERONLINE_MEMBERS%', stripslashes($useronline_naming['member']), $template_browsingsite);
        } else {
            $template_browsingsite = str_replace('%USERONLINE_MEMBERS%', '', $template_browsingsite);
        }
        
        // Nice Text For Guests
        if($total_guests > 1) {
            $useronline_naming_guests = str_replace('%USERONLINE_COUNT%', number_format_i18n($total_guests), stripslashes($useronline_naming['guests']));
            $template_browsingsite = str_replace('%USERONLINE_GUESTS%', $useronline_naming_guests, $template_browsingsite);
        } elseif($total_guests == 1) {            
            $template_browsingsite = str_replace('%USERONLINE_GUESTS%', stripslashes($useronline_naming['guest']), $template_browsingsite);
        } else {
            $template_browsingsite = str_replace('%USERONLINE_GUESTS%', '', $template_browsingsite);
        }

        // Nice Text For Bots
        if($total_bots > 1) {
            $useronline_naming_bots = str_replace('%USERONLINE_COUNT%', number_format_i18n($total_bots), stripslashes($useronline_naming['bots']));
            $template_browsingsite = str_replace('%USERONLINE_BOTS%', $useronline_naming_bots, $template_browsingsite);
        } elseif($total_bots == 1) {            
            $template_browsingsite = str_replace('%USERONLINE_BOTS%', stripslashes($useronline_naming['bot']), $template_browsingsite);
        } else {
            $template_browsingsite = str_replace('%USERONLINE_BOTS%', '', $template_browsingsite);
        }
        // Seperators
        if($total_members > 0 && $total_guests > 0) {
            $template_browsingsite = str_replace('%USERONLINE_GUESTS_SEPERATOR%', $separator_guests_browsingsite, $template_browsingsite);
        } else {
            $template_browsingsite = str_replace('%USERONLINE_GUESTS_SEPERATOR%', '', $template_browsingsite);
        }
        if(($total_guests > 0 || $total_members > 0) && $total_bots > 0) {
            $template_browsingsite = str_replace('%USERONLINE_BOTS_SEPERATOR%', $separator_bots_browsingsite, $template_browsingsite);
        } else {
            $template_browsingsite = str_replace('%USERONLINE_BOTS_SEPERATOR%', '', $template_browsingsite);
        }

        // Output The Template
        echo $template_browsingsite;
    } else {
        // This Should Not Happen
        _e('No User Is Browsing This Site', 'wp-useronline');
    }
}


### Function: Display Users Browsing The Page
function get_users_browsing_page($display = true) {
    global $wpdb;

    // Get Users Browsing Page
    $page_url = addslashes(urlencode($_SERVER['REQUEST_URI']));
    $users_browse = $wpdb->get_results("SELECT displayname, type FROM $wpdb->useronline WHERE url = '$page_url' ORDER BY type");

    // Variables
    $members = array();
    $guests = array();
    $bots = array();
    $total_users = 0;
    $total_members = 0;
    $total_guests = 0;
    $total_bots = 0;
    $nicetext_members = '';
    $nicetext_guests = '';
    $nicetext_bots = '';

    // If There Is Users Browsing, Then We Execute
    if($users_browse) {
        // Reassign Bots Name
        $bots = get_option('useronline_bots');
        $bots_name = array();
        foreach($bots as $botname => $botlookfor) {
            $bots_name[] = $botname;
        }
        // Get Users Information
        foreach($users_browse as $user_browse) {
            switch($user_browse->type) {
                case 'member':
                    $members[] = stripslashes($user_browse->displayname);
                    $total_members++;
                    break;
                case 'guest':                        
                    $guests[] = stripslashes($user_browse->displayname);
                    $total_guests++;
                    break;
                case 'bot':
                    $bots[] = stripslashes($user_browse->displayname);
                    $total_bots++;
                    break;
            }
        }
        $total_users = ($total_guests+$total_bots+$total_members);

        // If We Do Not Display It, Return Respective Users Count
        if(!$display) {
            return array ($total_users, $total_members, $total_guests, $total_bots);
        } 

        // Template - Naming Conventions
        $useronline_naming = get_option('useronline_naming');

        // Template - User(s) Browsing Site
        $options_browsingpage = get_option('useronline_template_browsingpage');
        $separator_members_browsingpage = stripslashes($options_browsingpage[0]);
        $separator_guests_browsingpage = stripslashes($options_browsingpage[1]);
        $separator_bots_browsingpage = stripslashes($options_browsingpage[2]);
        $template_browsingpage = stripslashes($options_browsingpage[3]);

        // Nice Text For Users
        if($total_users == 1) {
            $template_browsingpage = str_replace('%USERONLINE_USERS%', stripslashes($useronline_naming['user']), $template_browsingpage);        
        } else {
            $useronline_naming_users = str_replace('%USERONLINE_COUNT%', number_format_i18n($total_users), stripslashes($useronline_naming['users'<