Chris@76: <?php
Chris@76: 
Chris@76: /**
Chris@76:  * Simple Machines Forum (SMF)
Chris@76:  *
Chris@76:  * @package SMF
Chris@76:  * @author Simple Machines http://www.simplemachines.org
Chris@76:  * @copyright 2011 Simple Machines
Chris@76:  * @license http://www.simplemachines.org/about/smf/license.php BSD
Chris@76:  *
Chris@76:  * @version 2.0
Chris@76:  */
Chris@76: 
Chris@76: if (!defined('SMF'))
Chris@76: 	die('Hacking attempt...');
Chris@76: 
Chris@76: /*	This file currently only holds the function for showing a list of online
Chris@76: 	users used by the board index and SSI. In the future it'll also contain
Chris@76: 	functions used by the Who's online page.
Chris@76: 
Chris@76: 	array getMembersOnlineStats(array membersOnlineOptions)
Chris@76: 		- retrieve a list and several other statistics of the users currently
Chris@76: 		  online on the forum.
Chris@76: 		- used by the board index and SSI.
Chris@76: 		- also returns the membergroups of the users that are currently online.
Chris@76: 		- (optionally) hides members that chose to hide their online presense.
Chris@76: */
Chris@76: 
Chris@76: // Retrieve a list and several other statistics of the users currently online.
Chris@76: function getMembersOnlineStats($membersOnlineOptions)
Chris@76: {
Chris@76: 	global $smcFunc, $context, $scripturl, $user_info, $modSettings, $txt;
Chris@76: 
Chris@76: 	// The list can be sorted in several ways.
Chris@76: 	$allowed_sort_options = array(
Chris@76: 		'log_time',
Chris@76: 		'real_name',
Chris@76: 		'show_online',
Chris@76: 		'online_color',
Chris@76: 		'group_name',
Chris@76: 	);
Chris@76: 	// Default the sorting method to 'most recent online members first'.
Chris@76: 	if (!isset($membersOnlineOptions['sort']))
Chris@76: 	{
Chris@76: 		$membersOnlineOptions['sort'] = 'log_time';
Chris@76: 		$membersOnlineOptions['reverse_sort'] = true;
Chris@76: 	}
Chris@76: 
Chris@76: 	// Not allowed sort method? Bang! Error!
Chris@76: 	elseif (!in_array($membersOnlineOptions['sort'], $allowed_sort_options))
Chris@76: 		trigger_error('Sort method for getMembersOnlineStats() function is not allowed', E_USER_NOTICE);
Chris@76: 
Chris@76: 	// Initialize the array that'll be returned later on.
Chris@76: 	$membersOnlineStats = array(
Chris@76: 		'users_online' => array(),
Chris@76: 		'list_users_online' => array(),
Chris@76: 		'online_groups' => array(),
Chris@76: 		'num_guests' => 0,
Chris@76: 		'num_spiders' => 0,
Chris@76: 		'num_buddies' => 0,
Chris@76: 		'num_users_hidden' => 0,
Chris@76: 		'num_users_online' => 0,
Chris@76: 	);
Chris@76: 
Chris@76: 	// Get any spiders if enabled.
Chris@76: 	$spiders = array();
Chris@76: 	$spider_finds = array();
Chris@76: 	if (!empty($modSettings['show_spider_online']) && ($modSettings['show_spider_online'] < 3 || allowedTo('admin_forum')) && !empty($modSettings['spider_name_cache']))
Chris@76: 		$spiders = unserialize($modSettings['spider_name_cache']);
Chris@76: 
Chris@76: 	// Load the users online right now.
Chris@76: 	$request = $smcFunc['db_query']('', '
Chris@76: 		SELECT
Chris@76: 			lo.id_member, lo.log_time, lo.id_spider, mem.real_name, mem.member_name, mem.show_online,
Chris@76: 			mg.online_color, mg.id_group, mg.group_name
Chris@76: 		FROM {db_prefix}log_online AS lo
Chris@76: 			LEFT JOIN {db_prefix}members AS mem ON (mem.id_member = lo.id_member)
Chris@76: 			LEFT JOIN {db_prefix}membergroups AS mg ON (mg.id_group = CASE WHEN mem.id_group = {int:reg_mem_group} THEN mem.id_post_group ELSE mem.id_group END)',
Chris@76: 		array(
Chris@76: 			'reg_mem_group' => 0,
Chris@76: 		)
Chris@76: 	);
Chris@76: 	while ($row = $smcFunc['db_fetch_assoc']($request))
Chris@76: 	{
Chris@76: 		if (empty($row['real_name']))
Chris@76: 		{
Chris@76: 			// Do we think it's a spider?
Chris@76: 			if ($row['id_spider'] && isset($spiders[$row['id_spider']]))
Chris@76: 			{
Chris@76: 				$spider_finds[$row['id_spider']] = isset($spider_finds[$row['id_spider']]) ? $spider_finds[$row['id_spider']] + 1 : 1;
Chris@76: 				$membersOnlineStats['num_spiders']++;
Chris@76: 			}
Chris@76: 			// Guests are only nice for statistics.
Chris@76: 			$membersOnlineStats['num_guests']++;
Chris@76: 
Chris@76: 			continue;
Chris@76: 		}
Chris@76: 
Chris@76: 		elseif (empty($row['show_online']) && empty($membersOnlineOptions['show_hidden']))
Chris@76: 		{
Chris@76: 			// Just increase the stats and don't add this hidden user to any list.
Chris@76: 			$membersOnlineStats['num_users_hidden']++;
Chris@76: 			continue;
Chris@76: 		}
Chris@76: 
Chris@76: 		// Some basic color coding...
Chris@76: 		if (!empty($row['online_color']))
Chris@76: 			$link = '<a href="' . $scripturl . '?action=profile;u=' . $row['id_member'] . '" style="color: ' . $row['online_color'] . ';">' . $row['real_name'] . '</a>';
Chris@76: 		else
Chris@76: 			$link = '<a href="' . $scripturl . '?action=profile;u=' . $row['id_member'] . '">' . $row['real_name'] . '</a>';
Chris@76: 
Chris@76: 		// Buddies get counted and highlighted.
Chris@76: 		$is_buddy = in_array($row['id_member'], $user_info['buddies']);
Chris@76: 		if ($is_buddy)
Chris@76: 		{
Chris@76: 			$membersOnlineStats['num_buddies']++;
Chris@76: 			$link = '<strong>' . $link . '</strong>';
Chris@76: 		}
Chris@76: 
Chris@76: 		// A lot of useful information for each member.
Chris@76: 		$membersOnlineStats['users_online'][$row[$membersOnlineOptions['sort']] . $row['member_name']] = array(
Chris@76: 			'id' => $row['id_member'],
Chris@76: 			'username' => $row['member_name'],
Chris@76: 			'name' => $row['real_name'],
Chris@76: 			'group' => $row['id_group'],
Chris@76: 			'href' => $scripturl . '?action=profile;u=' . $row['id_member'],
Chris@76: 			'link' => $link,
Chris@76: 			'is_buddy' => $is_buddy,
Chris@76: 			'hidden' => empty($row['show_online']),
Chris@76: 			'is_last' => false,
Chris@76: 		);
Chris@76: 
Chris@76: 		// This is the compact version, simply implode it to show.
Chris@76: 		$membersOnlineStats['list_users_online'][$row[$membersOnlineOptions['sort']] . $row['member_name']] = empty($row['show_online']) ? '<em>' . $link . '</em>' : $link;
Chris@76: 
Chris@76: 		// Store all distinct (primary) membergroups that are shown.
Chris@76: 		if (!isset($membersOnlineStats['online_groups'][$row['id_group']]))
Chris@76: 			$membersOnlineStats['online_groups'][$row['id_group']] = array(
Chris@76: 				'id' => $row['id_group'],
Chris@76: 				'name' => $row['group_name'],
Chris@76: 				'color' => $row['online_color']
Chris@76: 			);
Chris@76: 	}
Chris@76: 	$smcFunc['db_free_result']($request);
Chris@76: 
Chris@76: 	// If there are spiders only and we're showing the detail, add them to the online list - at the bottom.
Chris@76: 	if (!empty($spider_finds) && $modSettings['show_spider_online'] > 1)
Chris@76: 		foreach ($spider_finds as $id => $count)
Chris@76: 		{
Chris@76: 			$link = $spiders[$id] . ($count > 1 ? ' (' . $count . ')' : '');
Chris@76: 			$sort = $membersOnlineOptions['sort'] = 'log_time' && $membersOnlineOptions['reverse_sort'] ? 0 : 'zzz_';
Chris@76: 			$membersOnlineStats['users_online'][$sort . $spiders[$id]] = array(
Chris@76: 				'id' => 0,
Chris@76: 				'username' => $spiders[$id],
Chris@76: 				'name' => $link,
Chris@76: 				'group' => $txt['spiders'],
Chris@76: 				'href' => '',
Chris@76: 				'link' => $link,
Chris@76: 				'is_buddy' => false,
Chris@76: 				'hidden' => false,
Chris@76: 				'is_last' => false,
Chris@76: 			);
Chris@76: 			$membersOnlineStats['list_users_online'][$sort . $spiders[$id]] = $link;
Chris@76: 		}
Chris@76: 
Chris@76: 	// Time to sort the list a bit.
Chris@76: 	if (!empty($membersOnlineStats['users_online']))
Chris@76: 	{
Chris@76: 		// Determine the sort direction.
Chris@76: 		$sortFunction = empty($membersOnlineOptions['reverse_sort']) ? 'ksort' : 'krsort';
Chris@76: 
Chris@76: 		// Sort the two lists.
Chris@76: 		$sortFunction($membersOnlineStats['users_online']);
Chris@76: 		$sortFunction($membersOnlineStats['list_users_online']);
Chris@76: 
Chris@76: 		// Mark the last list item as 'is_last'.
Chris@76: 		$userKeys = array_keys($membersOnlineStats['users_online']);
Chris@76: 		$membersOnlineStats['users_online'][end($userKeys)]['is_last'] = true;
Chris@76: 	}
Chris@76: 
Chris@76: 	// Also sort the membergroups.
Chris@76: 	ksort($membersOnlineStats['online_groups']);
Chris@76: 
Chris@76: 	// Hidden and non-hidden members make up all online members.
Chris@76: 	$membersOnlineStats['num_users_online'] = count($membersOnlineStats['users_online']) + $membersOnlineStats['num_users_hidden'] - (isset($modSettings['show_spider_online']) && $modSettings['show_spider_online'] > 1 ? count($spider_finds) : 0);
Chris@76: 
Chris@76: 	return $membersOnlineStats;
Chris@76: }
Chris@76: 
Chris@76: // Check if the number of users online is a record and store it.
Chris@76: function trackStatsUsersOnline($total_users_online)
Chris@76: {
Chris@76: 	global $modSettings, $smcFunc;
Chris@76: 
Chris@76: 	$settingsToUpdate = array();
Chris@76: 
Chris@76: 	// More members on now than ever were?  Update it!
Chris@76: 	if (!isset($modSettings['mostOnline']) || $total_users_online >= $modSettings['mostOnline'])
Chris@76: 		$settingsToUpdate = array(
Chris@76: 			'mostOnline' => $total_users_online,
Chris@76: 			'mostDate' => time()
Chris@76: 		);
Chris@76: 
Chris@76: 	$date = strftime('%Y-%m-%d', forum_time(false));
Chris@76: 
Chris@76: 	// No entry exists for today yet?
Chris@76: 	if (!isset($modSettings['mostOnlineUpdated']) || $modSettings['mostOnlineUpdated'] != $date)
Chris@76: 	{
Chris@76: 		$request = $smcFunc['db_query']('', '
Chris@76: 			SELECT most_on
Chris@76: 			FROM {db_prefix}log_activity
Chris@76: 			WHERE date = {date:date}
Chris@76: 			LIMIT 1',
Chris@76: 			array(
Chris@76: 				'date' => $date,
Chris@76: 			)
Chris@76: 		);
Chris@76: 
Chris@76: 		// The log_activity hasn't got an entry for today?
Chris@76: 		if ($smcFunc['db_num_rows']($request) === 0)
Chris@76: 		{
Chris@76: 			$smcFunc['db_insert']('ignore',
Chris@76: 				'{db_prefix}log_activity',
Chris@76: 				array('date' => 'date', 'most_on' => 'int'),
Chris@76: 				array($date, $total_users_online),
Chris@76: 				array('date')
Chris@76: 			);
Chris@76: 		}
Chris@76: 		// There's an entry in log_activity on today...
Chris@76: 		else
Chris@76: 		{
Chris@76: 			list ($modSettings['mostOnlineToday']) = $smcFunc['db_fetch_row']($request);
Chris@76: 
Chris@76: 			if ($total_users_online > $modSettings['mostOnlineToday'])
Chris@76: 				trackStats(array('most_on' => $total_users_online));
Chris@76: 
Chris@76: 			$total_users_online = max($total_users_online, $modSettings['mostOnlineToday']);
Chris@76: 		}
Chris@76: 		$smcFunc['db_free_result']($request);
Chris@76: 
Chris@76: 		$settingsToUpdate['mostOnlineUpdated'] = $date;
Chris@76: 		$settingsToUpdate['mostOnlineToday'] = $total_users_online;
Chris@76: 	}
Chris@76: 
Chris@76: 	// Highest number of users online today?
Chris@76: 	elseif ($total_users_online > $modSettings['mostOnlineToday'])
Chris@76: 	{
Chris@76: 		trackStats(array('most_on' => $total_users_online));
Chris@76: 		$settingsToUpdate['mostOnlineToday'] = $total_users_online;
Chris@76: 	}
Chris@76: 
Chris@76: 	if (!empty($settingsToUpdate))
Chris@76: 		updateSettings($settingsToUpdate);
Chris@76: }
Chris@76: 
Chris@76: ?>