/**

*

* @package phpBB3

* @version $Id: functions_content.php 9184 2008-12-11 14:46:38Z acydburn $

* @copyright (c) 2005 phpBB Group

* @license http://opensource.org/licenses/gpl-license.php GNU Public License

*

*/

/**

* @ignore

*/

if (!defined('IN_PHPBB'))

{

	exit;

}

/**

* gen_sort_selects()

* make_jumpbox()

* bump_topic_allowed()

* get_context()

* decode_message()

* strip_bbcode()

* generate_text_for_display()

* generate_text_for_storage()

* generate_text_for_edit()

* make_clickable_callback()

* make_clickable()

* censor_text()

* bbcode_nl2br()

* smiley_text()

* parse_attachments()

* extension_allowed()

* truncate_string()

* get_username_string()

* class bitfield

*/

/**

* Generate sort selection fields

*/

function gen_sort_selects(&$limit_days, &$sort_by_text, &$sort_days, &$sort_key, &$sort_dir, &$s_limit_days, &$s_sort_key, &$s_sort_dir, &$u_sort_param, $def_st = false, $def_sk = false, $def_sd = false)

{

	global $user;

	$sort_dir_text = array('a' => $user->lang['ASCENDING'], 'd' => $user->lang['DESCENDING']);

	$sorts = array(

		'st'	=> array(

			'key'		=> 'sort_days',

			'default'	=> $def_st,

			'options'	=> $limit_days,

			'output'	=> &$s_limit_days,

		),

		'sk'	=> array(

			'key'		=> 'sort_key',

			'default'	=> $def_sk,

			'options'	=> $sort_by_text,

			'output'	=> &$s_sort_key,

		),

		'sd'	=> array(

			'key'		=> 'sort_dir',

			'default'	=> $def_sd,

			'options'	=> $sort_dir_text,

			'output'	=> &$s_sort_dir,

		),

	);

	$u_sort_param  = '';

	foreach ($sorts as $name => $sort_ary)

	{

		$key = $sort_ary['key'];

		$selected = $$sort_ary['key'];

		// Check if the key is selectable. If not, we reset to the default or first key found.

		// This ensures the values are always valid. We also set $sort_dir/sort_key/etc. to the

		// correct value, else the protection is void. ;)

		if (!isset($sort_ary['options'][$selected]))

		{

			if ($sort_ary['default'] !== false)

			{

				$selected = $$key = $sort_ary['default'];

			}

			else

			{

				@reset($sort_ary['options']);

				$selected = $$key = key($sort_ary['options']);

			}

		}

		$sort_ary['output'] = '<select name="' . $name . '" id="' . $name . '">';

		foreach ($sort_ary['options'] as $option => $text)

		{

			$sort_ary['output'] .= '<option value="' . $option . '"' . (($selected == $option) ? ' selected="selected"' : '') . '>' . $text . '</option>';

		}

		$sort_ary['output'] .= '</select>';

		$u_sort_param .= ($selected !== $sort_ary['default']) ? ((strlen($u_sort_param)) ? '&' : '') . "{$name}={$selected}" : '';

	}

	return;

}

/**

* Generate Jumpbox

*/

function make_jumpbox($action, $forum_id = false, $select_all = false, $acl_list = false, $force_display = false)

{

	global $config, $auth, $template, $user, $db;

	// We only return if the jumpbox is not forced to be displayed (in case it is needed for functionality)

	if (!$config['load_jumpbox'] && $force_display === false)

	{

		return;

	}

	$sql = 'SELECT forum_id, forum_name, parent_id, forum_type, left_id, right_id

		FROM ' . FORUMS_TABLE . '

		ORDER BY left_id ASC';

	$result = $db->sql_query($sql, 600);

	$right = $padding = 0;

	$padding_store = array('0' => 0);

	$display_jumpbox = false;

	$iteration = 0;

	// Sometimes it could happen that forums will be displayed here not be displayed within the index page

	// This is the result of forums not displayed at index, having list permissions and a parent of a forum with no permissions.

	// If this happens, the padding could be "broken"

	while ($row = $db->sql_fetchrow($result))

	{

		if ($row['left_id'] < $right)

		{

			$padding++;

			$padding_store[$row['parent_id']] = $padding;

		}

		else if ($row['left_id'] > $right + 1)

		{

			// Ok, if the $padding_store for this parent is empty there is something wrong. For now we will skip over it.

			// @todo digging deep to find out "how" this can happen.

			$padding = (isset($padding_store[$row['parent_id']])) ? $padding_store[$row['parent_id']] : $padding;

		}

		$right = $row['right_id'];

		if ($row['forum_type'] == FORUM_CAT && ($row['left_id'] + 1 == $row['right_id']))

		{

			// Non-postable forum with no subforums, don't display

			continue;

		}

		if (!$auth->acl_get('f_list', $row['forum_id']))

		{

			// if the user does not have permissions to list this forum skip

			continue;

		}

		if ($acl_list && !$auth->acl_gets($acl_list, $row['forum_id']))

		{

			continue;

		}

		if (!$display_jumpbox)

		{

			$template->assign_block_vars('jumpbox_forums', array(

				'FORUM_ID'		=> ($select_all) ? 0 : -1,

				'FORUM_NAME'	=> ($select_all) ? $user->lang['ALL_FORUMS'] : $user->lang['SELECT_FORUM'],

				'S_FORUM_COUNT'	=> $iteration)

			);

			$iteration++;

			$display_jumpbox = true;

		}

		$template->assign_block_vars('jumpbox_forums', array(

			'FORUM_ID'		=> $row['forum_id'],

			'FORUM_NAME'	=> $row['forum_name'],

			'SELECTED'		=> ($row['forum_id'] == $forum_id) ? ' selected="selected"' : '',

			'S_FORUM_COUNT'	=> $iteration,

			'S_IS_CAT'		=> ($row['forum_type'] == FORUM_CAT) ? true : false,

			'S_IS_LINK'		=> ($row['forum_type'] == FORUM_LINK) ? true : false,

			'S_IS_POST'		=> ($row['forum_type'] == FORUM_POST) ? true : false)

		);

		for ($i = 0; $i < $padding; $i++)

		{

			$template->assign_block_vars('jumpbox_forums.level', array());

		}

		$iteration++;

	}

	$db->sql_freeresult($result);

	unset($padding_store);

	$template->assign_vars(array(

		'S_DISPLAY_JUMPBOX'	=> $display_jumpbox,

		'S_JUMPBOX_ACTION'	=> $action)

	);

	return;

}

/**

* Bump Topic Check - used by posting and viewtopic

*/

function bump_topic_allowed($forum_id, $topic_bumped, $last_post_time, $topic_poster, $last_topic_poster)

{

	global $config, $auth, $user;

	// Check permission and make sure the last post was not already bumped

	if (!$auth->acl_get('f_bump', $forum_id) || $topic_bumped)

	{

		return false;

	}

	// Check bump time range, is the user really allowed to bump the topic at this time?

	$bump_time = ($config['bump_type'] == 'm') ? $config['bump_interval'] * 60 : (($config['bump_type'] == 'h') ? $config['bump_interval'] * 3600 : $config['bump_interval'] * 86400);

	// Check bump time

	if ($last_post_time + $bump_time > time())

	{

		return false;

	}

	// Check bumper, only topic poster and last poster are allowed to bump

	if ($topic_poster != $user->data['user_id'] && $last_topic_poster != $user->data['user_id'])

	{

		return false;

	}

	// A bump time of 0 will completely disable the bump feature... not intended but might be useful.

	return $bump_time;

}

/**

* Generates a text with approx. the specified length which contains the specified words and their context

*

* @param	string	$text	The full text from which context shall be extracted

* @param	string	$words	An array of words which should be contained in the result, has to be a valid part of a PCRE pattern (escape with preg_quote!)

* @param	int		$length	The desired length of the resulting text, however the result might be shorter or longer than this value

*

* @return	string			Context of the specified words separated by "..."

*/

function get_context($text, $words, $length = 400)

{

	// first replace all whitespaces with single spaces

	$text = preg_replace('/ +/', ' ', strtr($text, "\t\n\r\x0C ", '     '));

	$word_indizes = array();

	if (sizeof($words))

	{

		$match = '';

		// find the starting indizes of all words

		foreach ($words as $word)

		{

			if ($word)

			{

				if (preg_match('#(?:[^\w]|^)(' . $word . ')(?:[^\w]|$)#i', $text, $match))

				{

					$pos = utf8_strpos($text, $match[1]);

					if ($pos !== false)

					{

						$word_indizes[] = $pos;

					}

				}

			}

		}

		unset($match);

		if (sizeof($word_indizes))

		{

			$word_indizes = array_unique($word_indizes);

			sort($word_indizes);

			$wordnum = sizeof($word_indizes);

			// number of characters on the right and left side of each word

			$sequence_length = (int) ($length / (2 * $wordnum)) - 2;

			$final_text = '';

			$word = $j = 0;

			$final_text_index = -1;

			// cycle through every character in the original text

			for ($i = $word_indizes[$word], $n = utf8_strlen($text); $i < $n; $i++)

			{

				// if the current position is the start of one of the words then append $sequence_length characters to the final text

				if (isset($word_indizes[$word]) && ($i == $word_indizes[$word]))

				{

					if ($final_text_index < $i - $sequence_length - 1)

					{

						$final_text .= '... ' . preg_replace('#^([^ ]*)#', '', utf8_substr($text, $i - $sequence_length, $sequence_length));

					}

					else

					{

						// if the final text is already nearer to the current word than $sequence_length we only append the text

						// from its current index on and distribute the unused length to all other sequenes

						$sequence_length += (int) (($final_text_index - $i + $sequence_length + 1) / (2 * $wordnum));

						$final_text .= utf8_substr($text, $final_text_index + 1, $i - $final_text_index - 1);

					}

					$final_text_index = $i - 1;

					// add the following characters to the final text (see below)

					$word++;

					$j = 1;

				}

				if ($j > 0)

				{

					// add the character to the final text and increment the sequence counter

					$final_text .= utf8_substr($text, $i, 1);

					$final_text_index++;

					$j++;

					// if this is a whitespace then check whether we are done with this sequence

					if (utf8_substr($text, $i, 1) == ' ')

					{

						// only check whether we have to exit the context generation completely if we haven't already reached the end anyway

						if ($i + 4 < $n)

						{

							if (($j > $sequence_length && $word >= $wordnum) || utf8_strlen($final_text) > $length)

							{

								$final_text .= ' ...';

								break;

							}

						}

						else

						{

							// make sure the text really reaches the end

							$j -= 4;

						}

						// stop context generation and wait for the next word

						if ($j > $sequence_length)

						{

							$j = 0;

						}

					}

				}

			}

			return $final_text;

		}

	}

	if (!sizeof($words) || !sizeof($word_indizes))

	{

		return (utf8_strlen($text) >= $length + 3) ? utf8_substr($text, 0, $length) . '...' : $text;

	}

}

/**

* Decode text whereby text is coming from the db and expected to be pre-parsed content

* We are placing this outside of the message parser because we are often in need of it...

*/

function decode_message(&$message, $bbcode_uid = '')

{

	global $config;

	if ($bbcode_uid)

	{

		$match = array('
', "[/*:m:$bbcode_uid]", ":u:$bbcode_uid", ":o:$bbcode_uid", ":$bbcode_uid");

		$replace = array("\n", '', '', '', '');

	}

	else

	{

		$match = array('
');

		$replace = array("\n");

	}

	$message = str_replace($match, $replace, $message);

	$match = get_preg_expression('bbcode_htm');

	$replace = array('\1', '\1', '\2', '\1', '', '');

	$message = preg_replace($match, $replace, $message);

}

/**

* Strips all bbcode from a text and returns the plain content

*/

function strip_bbcode(&$text, $uid = '')

{

	if (!$uid)

	{

		$uid = '[0-9a-z]{5,}';

	}

	$text = preg_replace("#\[\/?[a-z0-9\*\+\-]+(?:=(?:".*"|[^\]]*))?(?::[a-z])?(\:$uid)\]#", ' ', $text);

	$match = get_preg_expression('bbcode_htm');

	$replace = array('\1', '\1', '\2', '\1', '', '');

	$text = preg_replace($match, $replace, $text);

}

/**

* For display of custom parsed text on user-facing pages

* Expects $text to be the value directly from the database (stored value)

*/

function generate_text_for_display($text, $uid, $bitfield, $flags)

{

	static $bbcode;

	if (!$text)

	{

		return '';

	}

	$text = censor_text($text);

	// Parse bbcode if bbcode uid stored and bbcode enabled

	if ($uid && ($flags & OPTION_FLAG_BBCODE))

	{

		if (!class_exists('bbcode'))

		{

			global $phpbb_root_path, $phpEx;

			include($phpbb_root_path . 'includes/bbcode.' . $phpEx);

		}

		if (empty($bbcode))

		{

			$bbcode = new bbcode($bitfield);

		}

		else

		{

			$bbcode->bbcode($bitfield);

		}

		$bbcode->bbcode_second_pass($text, $uid);

	}

	$text = bbcode_nl2br($text);

	$text = smiley_text($text, !($flags & OPTION_FLAG_SMILIES));

	return $text;

}

/**

* For parsing custom parsed text to be stored within the database.

* This function additionally returns the uid and bitfield that needs to be stored.

* Expects $text to be the value directly from request_var() and in it's non-parsed form

*/

function generate_text_for_storage(&$text, &$uid, &$bitfield, &$flags, $allow_bbcode = false, $allow_urls = false, $allow_smilies = false)

{

	global $phpbb_root_path, $phpEx;

	$uid = $bitfield = '';

	$flags = (($allow_bbcode) ? OPTION_FLAG_BBCODE : 0) + (($allow_smilies) ? OPTION_FLAG_SMILIES : 0) + (($allow_urls) ? OPTION_FLAG_LINKS : 0);

	if (!$text)

	{

		return;

	}

	if (!class_exists('parse_message'))

	{

		include($phpbb_root_path . 'includes/message_parser.' . $phpEx);

	}

	$message_parser = new parse_message($text);

	$message_parser->parse($allow_bbcode, $allow_urls, $allow_smilies);

	$text = $message_parser->message;

	$uid = $message_parser->bbcode_uid;

	// If the bbcode_bitfield is empty, there is no need for the uid to be stored.

	if (!$message_parser->bbcode_bitfield)

	{

		$uid = '';

	}

	$bitfield = $message_parser->bbcode_bitfield;

	return;

}

/**

* For decoding custom parsed text for edits as well as extracting the flags

* Expects $text to be the value directly from the database (pre-parsed content)

*/

function generate_text_for_edit($text, $uid, $flags)

{

	global $phpbb_root_path, $phpEx;

	decode_message($text, $uid);

	return array(

		'allow_bbcode'	=> ($flags & OPTION_FLAG_BBCODE) ? 1 : 0,

		'allow_smilies'	=> ($flags & OPTION_FLAG_SMILIES) ? 1 : 0,

		'allow_urls'	=> ($flags & OPTION_FLAG_LINKS) ? 1 : 0,

		'text'			=> $text

	);

}

/**

* A subroutine of make_clickable used with preg_replace

* It places correct HTML around an url, shortens the displayed text

* and makes sure no entities are inside URLs

*/

function make_clickable_callback($type, $whitespace, $url, $relative_url, $class)

{

	$orig_url		= $url;

	$orig_relative	= $relative_url;

	$append			= '';

	$url			= htmlspecialchars_decode($url);

	$relative_url	= htmlspecialchars_decode($relative_url);

	// make sure no HTML entities were matched

	$chars = array('<', '>', '"');

	$split = false;

	foreach ($chars as $char)

	{

		$next_split = strpos($url, $char);

		if ($next_split !== false)

		{

			$split = ($split !== false) ? min($split, $next_split) : $next_split;

		}

	}

	if ($split !== false)

	{

		// an HTML entity was found, so the URL has to end before it

		$append			= substr($url, $split) . $relative_url;

		$url			= substr($url, 0, $split);

		$relative_url	= '';

	}

	else if ($relative_url)

	{

		// same for $relative_url

		$split = false;

		foreach ($chars as $char)

		{

			$next_split = strpos($relative_url, $char);

			if ($next_split !== false)

			{

				$split = ($split !== false) ? min($split, $next_split) : $next_split;

			}

		}

		if ($split !== false)

		{

			$append			= substr($relative_url, $split);

			$relative_url	= substr($relative_url, 0, $split);

		}

	}

	// if the last character of the url is a punctuation mark, exclude it from the url

	$last_char = ($relative_url) ? $relative_url[strlen($relative_url) - 1] : $url[strlen($url) - 1];

	switch ($last_char)

	{

		case '.':

		case '?':

		case '!':

		case ':':

		case ',':

			$append = $last_char;

			if ($relative_url)

			{

				$relative_url = substr($relative_url, 0, -1);

			}

			else

			{

				$url = substr($url, 0, -1);

			}

		break;

		// set last_char to empty here, so the variable can be used later to

		// check whether a character was removed

		default:

			$last_char = '';

		break;

	}

	$short_url = (strlen($url) > 55) ? substr($url, 0, 39) . ' ... ' . substr($url, -10) : $url;

	switch ($type)

	{

		case MAGIC_URL_LOCAL:

			$tag			= 'l';

			$relative_url	= preg_replace('/[&?]sid=[0-9a-f]{32}$/', '', preg_replace('/([&?])sid=[0-9a-f]{32}&/', '$1', $relative_url));

			$url			= $url . '/' . $relative_url;

			$text			= $relative_url;

			// this url goes to http://domain.tld/path/to/board/ which

			// would result in an empty link if treated as local so

			// don't touch it and let MAGIC_URL_FULL take care of it.

			if (!$relative_url)

			{

				return $whitespace . $orig_url . '/' . $orig_relative; // slash is taken away by relative url pattern

			}

		break;

		case MAGIC_URL_FULL:

			$tag	= 'm';

			$text	= $short_url;

		break;

		case MAGIC_URL_WWW:

			$tag	= 'w';

			$url	= 'http://' . $url;

			$text	= $short_url;

		break;

		case MAGIC_URL_EMAIL:

			$tag	= 'e';

			$text	= $short_url;

			$url	= 'mailto:' . $url;

		break;

	}

	$url	= htmlspecialchars($url);

	$text	= htmlspecialchars($text);

	$append	= htmlspecialchars($append);

	$html	= "$whitespace<a$class href=\"$url\">$text$append";

	return $html;

}

/**

* make_clickable function

*

* Replace magic urls of form http://xxx.xxx., www.xxx. and xxx@xxx.xxx.

* Cuts down displayed size of link if over 50 chars, turns absolute links

* into relative versions when the server/script path matches the link

*/

function make_clickable($text, $server_url = false, $class = 'postlink')

{

	if ($server_url === false)

	{

		$server_url = generate_board_url();

	}

	static $magic_url_match;

	static $magic_url_replace;

	static $static_class;

	if (!is_array($magic_url_match) || $static_class != $class)

	{

		$static_class = $class;

		$class = ($static_class) ? ' class="' . $static_class . '"' : '';

		$local_class = ($static_class) ? ' class="' . $static_class . '-local"' : '';

		$magic_url_match = $magic_url_replace = array();

		// Be sure to not let the matches cross over. ;)

		// relative urls for this board

		$magic_url_match[] = '#(^|[\n\t (>.])(' . preg_quote($server_url, '#') . ')/(' . get_preg_expression('relative_url_inline') . ')#ie';

		$magic_url_replace[] = "make_clickable_callback(MAGIC_URL_LOCAL, '\$1', '\$2', '\$3', '$local_class')";

		// matches a xxxx://aaaaa.bbb.cccc. ...

		$magic_url_match[] = '#(^|[\n\t (>.])(' . get_preg_expression('url_inline') . ')#ie';

		$magic_url_replace[] = "make_clickable_callback(MAGIC_URL_FULL, '\$1', '\$2', '', '$class')";

		// matches a "www.xxxx.yyyy[/zzzz]" kinda lazy URL thing

		$magic_url_match[] = '#(^|[\n\t (>])(' . get_preg_expression('www_url_inline') . ')#ie';

		$magic_url_replace[] = "make_clickable_callback(MAGIC_URL_WWW, '\$1', '\$2', '', '$class')";

		// matches an email@domain type address at the start of a line, or after a space or after what might be a BBCode.

		$magic_url_match[] = '/(^|[\n\t (>])(' . get_preg_expression('email') . ')/ie';

		$magic_url_replace[] = "make_clickable_callback(MAGIC_URL_EMAIL, '\$1', '\$2', '', '')";

	}

	return preg_replace($magic_url_match, $magic_url_replace, $text);

}

/**

* Censoring

*/

function censor_text($text)

{

	static $censors;

	// We moved the word censor checks in here because we call this function quite often - and then only need to do the check once

	if (!isset($censors) || !is_array($censors))

	{

		global $config, $user, $auth, $cache;

		// We check here if the user is having viewing censors disabled (and also allowed to do so).

		if (!$user->optionget('viewcensors') && $config['allow_nocensors'] && $auth->acl_get('u_chgcensors'))

		{

			$censors = array();

		}

		else

		{

			$censors = $cache->obtain_word_list();

		}

	}

	if (sizeof($censors))

	{

		return preg_replace($censors['match'], $censors['replace'], $text);

	}

	return $text;

}

/**

* custom version of nl2br which takes custom BBCodes into account

*/

function bbcode_nl2br($text)

{

	// custom BBCodes might contain carriage returns so they

	// are not converted into 
 so now revert that

	$text = str_replace(array("\n", "\r"), array('
', "\n"), $text);

	return $text;

}

/**

* Smiley processing

*/

function smiley_text($text, $force_option = false)

{

	global $config, $user, $phpbb_root_path;