php-phpbb/phpBB/includes/mcp/mcp_warn.php

<?php
/** 
*
* @package mcp
* @version $Id$
* @copyright (c) 2005 phpBB Group 
* @license http://opensource.org/licenses/gpl-license.php GNU Public License 
*
*/

/**
* @package mcp
* mcp_warn
* Handling warning the users
*/
class mcp_warn
{

	var $p_master;
	
	function mcp_main(&$p_master)
	{
		$this->p_master = &$p_master;
	}

	function main($id, $mode)
	{
		global $auth, $db, $user, $template;
		global $config, $phpbb_root_path, $phpEx, $SID;

		$action = request_var('action', array('' => ''));

		if (is_array($action))
		{
			list($action, ) = each($action);
		}

		switch ($mode)
		{
			case 'front':
				mcp_warn_front_view($id, $mode);
				$this->tpl_name = 'mcp_warn_front';
				break;
			case 'warn_post':
				mcp_warn_post_view($id, $mode, $action);
				$this->tpl_name = 'mcp_warn_post';
				break;
			case 'warn_user':
				mcp_warn_user_view($id, $mode, $action);
				$this->tpl_name = 'mcp_warn_user';
				break;
		}
	}
}

/**
* @package module_install
*/
class mcp_warn_info
{
	function module()
	{
		return array(
			'filename'	=> 'mcp_warn',
			'title'		=> 'MCP_WARN',
			'version'	=> '1.0.0',
			'modes'		=> array(
				'front'				=> array('title' => 'MCP_WARN_FRONT', 'auth' => 'acl_m_'),
				'list'				=> array('title' => 'MCP_WARN_LIST', 'auth' => 'acl_m_'),
				'warn_user'			=> array('title' => 'MCP_WARN_USER', 'auth' => 'acl_m_'),
				'warn_post'			=> array('title' => 'MCP_WARN_POST', 'auth' => 'acl_m_'),
			),
		);
	}

	function install()
	{
	}

	function uninstall()
	{
	}
}


//
// Functions
//

/**
* Generates the summary on the main page of the warning module
*/
function mcp_warn_front_view($id, $mode)
{
	global $SID, $phpEx, $phpbb_root_path, $config;
	global $template, $db, $user, $auth;

	$template->assign_var('U_POST_ACTION', "mcp.$phpEx$SID&amp;i=warn&amp;mode=warn_user");

	// Obtain a list of the 5 naughtiest users....
	// These are the 5 users with the highest warning count

	$sql = 'SELECT user_id, username, user_warnings
		FROM ' . USERS_TABLE . '
		WHERE user_warnings > 0
		ORDER BY user_warnings DESC LIMIT 5';
	$result = $db->sql_query($sql);

	while ($row = $db->sql_fetchrow($result))
	{
		$template->assign_block_vars('highest', array(
			'U_NOTES'		=> 'mcp.' . $phpEx . $SID . '&amp;i=notes&amp;mode=user_notes&amp;u=' . $row['user_id'],
			'U_USER'		=> 'memberlist.' . $phpEx . $SID . '&amp;mode=viewprofile&amp;u=' . $row['user_id'],

			'USERNAME'		=> $row['username'],
			'WARNING_TIME'	=> $user->format_date($row['user_warning_time']), // TODO: Need to obtain the time of the last warning. Probably store this in the USERS_TABLE rather than join the WARNINGS_TABLE for efficiency
			'WARNINGS'		=> $row['user_warnings'],
			)
		);
	}
	$db->sql_freeresult($result);

	// And now the 5 most recent users to get in trouble

	$sql = 'SELECT u.user_id, u.username, u.user_warnings, w.warning_time
		FROM ' . USERS_TABLE . ' u, ' . WARNINGS_TABLE . ' w
		WHERE u.user_id = w.user_id
		ORDER BY w.warning_time DESC LIMIT 5';
	$result = $db->sql_query($sql);

	while ($row = $db->sql_fetchrow($result))
	{
		$template->assign_block_vars('latest', array(
			'U_NOTES'		=> 'mcp.' . $phpEx . $SID . '&amp;i=notes&amp;mode=user_notes&amp;u=' . $row['user_id'],
			'U_USER'		=> 'memberlist.' . $phpEx . $SID . '&amp;mode=viewprofile&amp;u=' . $row['user_id'],

			'USERNAME'		=> $row['username'],
			'WARNING_TIME'	=> $user->format_date($row['warning_time']),
			'WARNINGS'		=> $row['user_warnings'],
			)
		);
	}
	$db->sql_freeresult($result);
}

/**
* Handles warning the user when the warning is for a specific post
*/
function mcp_warn_post_view($id, $mode, $action)
{
	global $SID, $phpEx, $phpbb_root_path, $config;
	global $template, $db, $user, $auth;

	$post_id = request_var('p', 0);
	$notify = (isset($_REQUEST['notify_user'])) ? true : false;
	$warning = request_var('warning', '');

	$sql = 'SELECT u.*, p.* FROM ' . POSTS_TABLE . ' p, ' . USERS_TABLE . " u 
		WHERE post_id = $post_id
		AND u.user_id = p.poster_id";
	$result = $db->sql_query($sql);

	if (!$userrow = $db->sql_fetchrow($result))
	{
		trigger_error($user->lang['NO_POST']);
	}
	$db->sql_freeresult($result);

	// There is no point issuing a warning to ignored users (ie anonymous and bots)
	if ($userrow['user_type'] == USER_IGNORE)
	{
		trigger_error($user->lang['CANNOT_WARN_ANONYMOUS']);
	}

	// Check if there is already a warning for this post to prevent multiple
	// warnings for the same offence
	$sql = 'SELECT * FROM ' . WARNINGS_TABLE . "
		WHERE post_id = $post_id";
	$result = $db->sql_query($sql);

	if ($row = $db->sql_fetchrow($result))
	{
		trigger_error($user->lang['ALREADY_WARNED']);
	}
	$db->sql_freeresult($result);
	
	$user_id = $userrow['user_id'];

	if ($warning && $action == 'add_warning')
	{
		add_warning($userrow, $warning, $notify, $post_id);

		$redirect = "mcp.$phpEx$SID&amp;i=notes&amp;mode=user_notes&amp;u=$user_id";
		meta_refresh(2, $redirect);
		trigger_error($user->lang['USER_WARNING_ADDED'] . '<br /><br />' . sprintf($user->lang['RETURN_PAGE'], '<a href="' . $redirect . '">', '</a>'));
	}

	// OK, they didn't submit a warning so lets build the page for them to do so
	
	// We want to make the message available here as a reminder
	// Parse the message and subject
	$message = $userrow['post_text'];

	// If the board has HTML off but the post has HTML on then we process it, else leave it alone
	if (!$auth->acl_get('f_html', $userrow['forum_id']) && $row['enable_html'])
	{
		$message = preg_replace('#(<!\-\- h \-\-><)([\/]?.*?)(><!\-\- h \-\->)#is', "&lt;\\2&gt;", $message);
	}

	// Second parse bbcode here
	if ($userrow['bbcode_bitfield'])
	{
		$bbcode->bbcode_second_pass($message, $row['bbcode_uid'], $row['bbcode_bitfield']);
	}

	// Always process smilies after parsing bbcodes
	$message = smiley_text($message);

	if ($userrow['enable_html'] && $auth->acl_get('f_html', $userrow['forum_id']))
	{
		// Remove Comments from post content
		$message = preg_replace('#<!\-\-(.*?)\-\->#is', '', $message);
	}

	// Replace naughty words such as farty pants
	$message = str_replace("\n", '<br />', censor_text($message));

	// Generate the appropriate user information for the user we are looking at
	$rank_title = $rank_img = '';
//	get_user_rank($userrow['user_rank'], $userrow['user_posts'], $rank_title, $rank_img);

	$avatar_img = '';
	if (!empty($userrow['user_avatar']))
	{
		switch ($userrow['user_avatar_type'])
		{
			case AVATAR_UPLOAD:
				$avatar_img = $config['avatar_path'] . '/';
				break;
			case AVATAR_GALLERY:
				$avatar_img = $config['avatar_gallery_path'] . '/';
				break;
		}
		$avatar_img .= $userrow['user_avatar'];

		$avatar_img = '<img src="' . $avatar_img . '" width="' . $userrow['user_avatar_width'] . '" height="' . $userrow['user_avatar_height'] . '" border="0" alt="" />';
	}
	else
	{
		$avatar_img = '<img src="adm/images/no_avatar.gif" alt="" />';
	}

	$template->assign_vars(array(
		'U_POST_ACTION'		=> "mcp.$phpEx$SID&amp;i=$id&amp;mode=$mode&amp;p=$post_id",

		'POST'				=> $message,
		'USERNAME'			=> $userrow['username'],
		'USER_COLOR'		=> (!empty($userrow['user_colour'])) ? $userrow['user_colour'] : '',
		'RANK_TITLE'		=> $rank_title,
		'JOINED'			=> $user->format_date($userrow['user_regdate'], $user->lang['DATE_FORMAT']),
		'POSTS'				=> ($userrow['user_posts']) ? $userrow['user_posts'] : 0,

		'AVATAR_IMG'		=> $avatar_img,
		'RANK_IMG'			=> $rank_img,
		)
	);
}

/**
* Handles warning the user
*/
function mcp_warn_user_view($id, $mode, $action)
{
	global $SID, $phpEx, $phpbb_root_path, $config;
	global $template, $db, $user, $auth;

	$user_id = request_var('u', 0);
	$username = request_var('username', '');
	$notify = (isset($_REQUEST['notify_user'])) ? true : false;
	$warning = request_var('warning', '');

	$sql_where = ($user_id) ? "user_id = $user_id" : "username = '" . $db->sql_escape($username) . "'";

	$sql = 'SELECT * FROM ' . USERS_TABLE . " WHERE $sql_where";
	$result = $db->sql_query($sql);

	if (!$userrow = $db->sql_fetchrow($result))
	{
		trigger_error($user->lang['NO_USER']);
	}
	$db->sql_freeresult($result);

	$user_id = $userrow['user_id'];

	if ($warning && $action == 'add_warning')
	{
		add_warning($userrow, $warning, $notify);

		$redirect = "mcp.$phpEx$SID&amp;i=notes&amp;mode=user_notes&amp;u=$user_id";
		meta_refresh(2, $redirect);
		trigger_error($user->lang['USER_WARNING_ADDED'] . '<br /><br />' . sprintf($user->lang['RETURN_PAGE'], '<a href="' . $redirect . '">', '</a>'));
	}

	// OK, they didn't submit a warning so lets build the page for them to do so
	$template->assign_vars(array(
		'U_POST_ACTION'		=> "mcp.$phpEx$SID&amp;i=$id&amp;mode=$mode&amp;u=$user_id",

		'USERNAME'			=> $userrow['username'],
		'USER_COLOR'		=> (!empty($userrow['user_colour'])) ? $userrow['user_colour'] : '',
		'RANK_TITLE'		=> $rank_title,
		'JOINED'			=> $user->format_date($userrow['user_regdate'], $user->lang['DATE_FORMAT']),
		'POSTS'				=> ($userrow['user_posts']) ? $userrow['user_posts'] : 0,
		'WARNINGS'			=> ($userrow['user_warnings']) ? $userrow['user_warnings'] : 0,

		'AVATAR_IMG'		=> $avatar_img,
		'RANK_IMG'			=> $rank_img,
		)
	);
}

/**
* Insert the warning into the database
*/
function add_warning($userrow, $warning, $send_pm = true, $post_id = 0)
{
	global $SID, $phpEx, $phpbb_root_path, $config;
	global $template, $db, $user, $auth;

	if ($send_pm)
	{
		include($phpbb_root_path . 'includes/functions_privmsgs.' . $phpEx);

		$pm_data = array(
			'from_user_id'			=> $user->data['user_id'],
			'from_user_ip'			=> $user->data['user_ip'],
			'from_username'			=> $user->data['username'],
			'enable_sig'			=> false,
			'enable_bbcode'			=> false,
			'enable_html' 			=> false,
			'enable_smilies'		=> false,
			'enable_urls'			=> false,
			'icon_id'				=> 0,
			'message_md5'			=> 0,
			'bbcode_bitfield'		=> 0,
			'bbcode_uid'			=> '',
			'message'				=> $warning, // TODO: The message sent to the user should either be templated from the language pack or set in the board config
			'address_list'			=> array('u' => array($userrow['user_id'] => 'to')),
		);

		submit_pm('post', 'Warning Issued', $pm_data, false, false); // TODO: The topic should either be in the language of the recipient or set in the board config
	}

	add_log('admin', 'LOG_USER_WARNING', $userrow['username']);
	add_log('user', $userrow['user_id'], 'LOG_USER_GENERAL', $warning); // TODO: Need a relevant language entry for this such that it is displayed as a warning in the notes

	$sql_ary = array(
		'user_id'		=> $userrow['user_id'],
		'post_id'		=> $post_id,
		'log_id'		=> 0, // TODO : Obtain the log_id of the warning
		'warning_time'	=> time(),
	);

	$db->sql_query('INSERT INTO ' . WARNINGS_TABLE . ' ' . $db->sql_build_array('INSERT', $sql_ary));

	$db->sql_query('UPDATE ' . USERS_TABLE . ' SET user_warnings = user_warnings + 1 WHERE user_id = ' . $userrow['user_id']);
}
?>