diff options
Diffstat (limited to 'phpBB/includes/functions_acp.php')
| -rw-r--r-- | phpBB/includes/functions_acp.php | 636 | 
1 files changed, 636 insertions, 0 deletions
| diff --git a/phpBB/includes/functions_acp.php b/phpBB/includes/functions_acp.php new file mode 100644 index 0000000000..11cc1f6dd8 --- /dev/null +++ b/phpBB/includes/functions_acp.php @@ -0,0 +1,636 @@ +<?php +/** +* +* @package acp +* @copyright (c) 2005 phpBB Group +* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ +	exit; +} + +/** +* Header for acp pages +*/ +function adm_page_header($page_title) +{ +	global $config, $db, $user, $template; +	global $phpbb_root_path, $phpbb_admin_path, $phpEx, $SID, $_SID; +	global $phpbb_dispatcher; + +	if (defined('HEADER_INC')) +	{ +		return; +	} + +	define('HEADER_INC', true); + +	// A listener can set this variable to `true` when it overrides this function +	$adm_page_header_override = false; + +	/** +	* Execute code and/or overwrite adm_page_header() +	* +	* @event core.adm_page_header +	* @var	string	page_title			Page title +	* @var	bool	adm_page_header_override	Shall we return instead of +	*									running the rest of adm_page_header() +	* @since 3.1-A1 +	*/ +	$vars = array('page_title', 'adm_page_header_override'); +	extract($phpbb_dispatcher->trigger_event('core.adm_page_header', compact($vars))); + +	if ($adm_page_header_override) +	{ +		return; +	} + +	// gzip_compression +	if ($config['gzip_compress']) +	{ +		if (@extension_loaded('zlib') && !headers_sent()) +		{ +			ob_start('ob_gzhandler'); +		} +	} + +	$template->assign_vars(array( +		'PAGE_TITLE'			=> $page_title, +		'USERNAME'				=> $user->data['username'], + +		'SID'					=> $SID, +		'_SID'					=> $_SID, +		'SESSION_ID'			=> $user->session_id, +		'ROOT_PATH'				=> $phpbb_admin_path, + +		'U_LOGOUT'				=> append_sid("{$phpbb_root_path}ucp.$phpEx", 'mode=logout'), +		'U_ADM_LOGOUT'			=> append_sid("{$phpbb_admin_path}index.$phpEx", 'action=admlogout'), +		'U_ADM_INDEX'			=> append_sid("{$phpbb_admin_path}index.$phpEx"), +		'U_INDEX'				=> append_sid("{$phpbb_root_path}index.$phpEx"), + +		'T_IMAGES_PATH'			=> "{$phpbb_root_path}images/", +		'T_SMILIES_PATH'		=> "{$phpbb_root_path}{$config['smilies_path']}/", +		'T_AVATAR_PATH'			=> "{$phpbb_root_path}{$config['avatar_path']}/", +		'T_AVATAR_GALLERY_PATH'	=> "{$phpbb_root_path}{$config['avatar_gallery_path']}/", +		'T_ICONS_PATH'			=> "{$phpbb_root_path}{$config['icons_path']}/", +		'T_RANKS_PATH'			=> "{$phpbb_root_path}{$config['ranks_path']}/", +		'T_UPLOAD_PATH'			=> "{$phpbb_root_path}{$config['upload_path']}/", + +		'ICON_MOVE_UP'				=> '<img src="' . $phpbb_admin_path . 'images/icon_up.gif" alt="' . $user->lang['MOVE_UP'] . '" title="' . $user->lang['MOVE_UP'] . '" />', +		'ICON_MOVE_UP_DISABLED'		=> '<img src="' . $phpbb_admin_path . 'images/icon_up_disabled.gif" alt="' . $user->lang['MOVE_UP'] . '" title="' . $user->lang['MOVE_UP'] . '" />', +		'ICON_MOVE_DOWN'			=> '<img src="' . $phpbb_admin_path . 'images/icon_down.gif" alt="' . $user->lang['MOVE_DOWN'] . '" title="' . $user->lang['MOVE_DOWN'] . '" />', +		'ICON_MOVE_DOWN_DISABLED'	=> '<img src="' . $phpbb_admin_path . 'images/icon_down_disabled.gif" alt="' . $user->lang['MOVE_DOWN'] . '" title="' . $user->lang['MOVE_DOWN'] . '" />', +		'ICON_EDIT'					=> '<img src="' . $phpbb_admin_path . 'images/icon_edit.gif" alt="' . $user->lang['EDIT'] . '" title="' . $user->lang['EDIT'] . '" />', +		'ICON_EDIT_DISABLED'		=> '<img src="' . $phpbb_admin_path . 'images/icon_edit_disabled.gif" alt="' . $user->lang['EDIT'] . '" title="' . $user->lang['EDIT'] . '" />', +		'ICON_DELETE'				=> '<img src="' . $phpbb_admin_path . 'images/icon_delete.gif" alt="' . $user->lang['DELETE'] . '" title="' . $user->lang['DELETE'] . '" />', +		'ICON_DELETE_DISABLED'		=> '<img src="' . $phpbb_admin_path . 'images/icon_delete_disabled.gif" alt="' . $user->lang['DELETE'] . '" title="' . $user->lang['DELETE'] . '" />', +		'ICON_SYNC'					=> '<img src="' . $phpbb_admin_path . 'images/icon_sync.gif" alt="' . $user->lang['RESYNC'] . '" title="' . $user->lang['RESYNC'] . '" />', +		'ICON_SYNC_DISABLED'		=> '<img src="' . $phpbb_admin_path . 'images/icon_sync_disabled.gif" alt="' . $user->lang['RESYNC'] . '" title="' . $user->lang['RESYNC'] . '" />', + +		'S_USER_LANG'			=> $user->lang['USER_LANG'], +		'S_CONTENT_DIRECTION'	=> $user->lang['DIRECTION'], +		'S_CONTENT_ENCODING'	=> 'UTF-8', +		'S_CONTENT_FLOW_BEGIN'	=> ($user->lang['DIRECTION'] == 'ltr') ? 'left' : 'right', +		'S_CONTENT_FLOW_END'	=> ($user->lang['DIRECTION'] == 'ltr') ? 'right' : 'left', +	)); + +	// application/xhtml+xml not used because of IE +	header('Content-type: text/html; charset=UTF-8'); + +	header('Cache-Control: private, no-cache="set-cookie"'); +	header('Expires: 0'); +	header('Pragma: no-cache'); + +	return; +} + +/** +* Page footer for acp pages +*/ +function adm_page_footer($copyright_html = true) +{ +	global $db, $config, $template, $user, $auth, $cache; +	global $starttime, $phpbb_root_path, $phpbb_admin_path, $phpEx; +	global $request, $phpbb_dispatcher; + +	// A listener can set this variable to `true` when it overrides this function +	$adm_page_footer_override = false; + +	/** +	* Execute code and/or overwrite adm_page_footer() +	* +	* @event core.adm_page_footer +	* @var	bool	copyright_html			Shall we display the copyright? +	* @var	bool	adm_page_footer_override	Shall we return instead of +	*									running the rest of adm_page_footer() +	* @since 3.1-A1 +	*/ +	$vars = array('copyright_html', 'adm_page_footer_override'); +	extract($phpbb_dispatcher->trigger_event('core.adm_page_footer', compact($vars))); + +	if ($adm_page_footer_override) +	{ +		return; +	} + +	// Output page creation time +	if (defined('DEBUG')) +	{ +		$mtime = explode(' ', microtime()); +		$totaltime = $mtime[0] + $mtime[1] - $starttime; + +		if ($request->variable('explain', false) && $auth->acl_get('a_') && defined('DEBUG_EXTRA') && method_exists($db, 'sql_report')) +		{ +			$db->sql_report('display'); +		} + +		$debug_output = sprintf('Time : %.3fs | ' . $db->sql_num_queries() . ' Queries | GZIP : ' . (($config['gzip_compress']) ? 'On' : 'Off') . (($user->load) ? ' | Load : ' . $user->load : ''), $totaltime); + +		if ($auth->acl_get('a_') && defined('DEBUG_EXTRA')) +		{ +			if (function_exists('memory_get_peak_usage')) +			{ +				if ($memory_usage = memory_get_peak_usage()) +				{ +					$memory_usage = get_formatted_filesize($memory_usage); + +					$debug_output .= ' | Peak Memory Usage: ' . $memory_usage; +				} +			} + +			$debug_output .= ' | <a href="' . build_url() . '&explain=1">Explain</a>'; +		} +	} + +	$template->assign_vars(array( +		'DEBUG_OUTPUT'		=> (defined('DEBUG')) ? $debug_output : '', +		'TRANSLATION_INFO'	=> (!empty($user->lang['TRANSLATION_INFO'])) ? $user->lang['TRANSLATION_INFO'] : '', +		'S_COPYRIGHT_HTML'	=> $copyright_html, +		'CREDIT_LINE'		=> $user->lang('POWERED_BY', '<a href="https://www.phpbb.com/">phpBB</a>® Forum Software © phpBB Group'), +		'T_JQUERY_LINK'		=> ($config['load_jquery_cdn'] && !empty($config['load_jquery_url'])) ? $config['load_jquery_url'] : "{$phpbb_root_path}assets/javascript/jquery.js", +		'S_JQUERY_FALLBACK'	=> ($config['load_jquery_cdn']) ? true : false, +		'VERSION'			=> $config['version']) +	); + +	$template->display('body'); + +	garbage_collection(); +	exit_handler(); +} + +/** +* Generate back link for acp pages +*/ +function adm_back_link($u_action) +{ +	global $user; +	return '<br /><br /><a href="' . $u_action . '">« ' . $user->lang['BACK_TO_PREV'] . '</a>'; +} + +/** +* Build select field options in acp pages +*/ +function build_select($option_ary, $option_default = false) +{ +	global $user; + +	$html = ''; +	foreach ($option_ary as $value => $title) +	{ +		$selected = ($option_default !== false && $value == $option_default) ? ' selected="selected"' : ''; +		$html .= '<option value="' . $value . '"' . $selected . '>' . $user->lang[$title] . '</option>'; +	} + +	return $html; +} + +/** +* Build radio fields in acp pages +*/ +function h_radio($name, $input_ary, $input_default = false, $id = false, $key = false, $separator = '') +{ +	global $user; + +	$html = ''; +	$id_assigned = false; +	foreach ($input_ary as $value => $title) +	{ +		$selected = ($input_default !== false && $value == $input_default) ? ' checked="checked"' : ''; +		$html .= '<label><input type="radio" name="' . $name . '"' . (($id && !$id_assigned) ? ' id="' . $id . '"' : '') . ' value="' . $value . '"' . $selected . (($key) ? ' accesskey="' . $key . '"' : '') . ' class="radio" /> ' . $user->lang[$title] . '</label>' . $separator; +		$id_assigned = true; +	} + +	return $html; +} + +/** +* Build configuration template for acp configuration pages +*/ +function build_cfg_template($tpl_type, $key, &$new, $config_key, $vars) +{ +	global $user, $module, $phpbb_dispatcher; + +	$tpl = ''; +	$name = 'config[' . $config_key . ']'; + +	// Make sure there is no notice printed out for non-existent config options (we simply set them) +	if (!isset($new[$config_key])) +	{ +		$new[$config_key] = ''; +	} + +	switch ($tpl_type[0]) +	{ +		case 'text': +		case 'password': +			$size = (int) $tpl_type[1]; +			$maxlength = (int) $tpl_type[2]; + +			$tpl = '<input id="' . $key . '" type="' . $tpl_type[0] . '"' . (($size) ? ' size="' . $size . '"' : '') . ' maxlength="' . (($maxlength) ? $maxlength : 255) . '" name="' . $name . '" value="' . $new[$config_key] . '"' . (($tpl_type[0] === 'password') ?  ' autocomplete="off"' : '') . ' />'; +		break; + +		case 'dimension': +			$size = (int) $tpl_type[1]; +			$maxlength = (int) $tpl_type[2]; + +			$tpl = '<input id="' . $key . '" type="text"' . (($size) ? ' size="' . $size . '"' : '') . ' maxlength="' . (($maxlength) ? $maxlength : 255) . '" name="config[' . $config_key . '_width]" value="' . $new[$config_key . '_width'] . '" /> x <input type="text"' . (($size) ? ' size="' . $size . '"' : '') . ' maxlength="' . (($maxlength) ? $maxlength : 255) . '" name="config[' . $config_key . '_height]" value="' . $new[$config_key . '_height'] . '" />'; +		break; + +		case 'textarea': +			$rows = (int) $tpl_type[1]; +			$cols = (int) $tpl_type[2]; + +			$tpl = '<textarea id="' . $key . '" name="' . $name . '" rows="' . $rows . '" cols="' . $cols . '">' . $new[$config_key] . '</textarea>'; +		break; + +		case 'radio': +			$key_yes	= ($new[$config_key]) ? ' checked="checked"' : ''; +			$key_no		= (!$new[$config_key]) ? ' checked="checked"' : ''; + +			$tpl_type_cond = explode('_', $tpl_type[1]); +			$type_no = ($tpl_type_cond[0] == 'disabled' || $tpl_type_cond[0] == 'enabled') ? false : true; + +			$tpl_no = '<label><input type="radio" name="' . $name . '" value="0"' . $key_no . ' class="radio" /> ' . (($type_no) ? $user->lang['NO'] : $user->lang['DISABLED']) . '</label>'; +			$tpl_yes = '<label><input type="radio" id="' . $key . '" name="' . $name . '" value="1"' . $key_yes . ' class="radio" /> ' . (($type_no) ? $user->lang['YES'] : $user->lang['ENABLED']) . '</label>'; + +			$tpl = ($tpl_type_cond[0] == 'yes' || $tpl_type_cond[0] == 'enabled') ? $tpl_yes . $tpl_no : $tpl_no . $tpl_yes; +		break; + +		case 'select': +		case 'custom': + +			$return = ''; + +			if (isset($vars['method'])) +			{ +				$call = array($module->module, $vars['method']); +			} +			else if (isset($vars['function'])) +			{ +				$call = $vars['function']; +			} +			else +			{ +				break; +			} + +			if (isset($vars['params'])) +			{ +				$args = array(); +				foreach ($vars['params'] as $value) +				{ +					switch ($value) +					{ +						case '{CONFIG_VALUE}': +							$value = $new[$config_key]; +						break; + +						case '{KEY}': +							$value = $key; +						break; +					} + +					$args[] = $value; +				} +			} +			else +			{ +				$args = array($new[$config_key], $key); +			} + +			$return = call_user_func_array($call, $args); + +			if ($tpl_type[0] == 'select') +			{ +				$tpl = '<select id="' . $key . '" name="' . $name . '">' . $return . '</select>'; +			} +			else +			{ +				$tpl = $return; +			} + +		break; + +		default: +		break; +	} + +	if (isset($vars['append'])) +	{ +		$tpl .= $vars['append']; +	} + +	/** +	* Overwrite the html code we display for the config value +	* +	* @event core.build_config_template +	* @var	array	tpl_type	Config type array: +	*						0 => data type +	*						1 [optional] => string: size, int: minimum +	*						2 [optional] => string: max. length, int: maximum +	* @var	string	key			Should be used for the id attribute in html +	* @var	array	new			Array with the config values we display +	* @var	string	name		Should be used for the name attribute +	* @var	array	vars		Array with the options for the config +	* @var	string	tpl			The resulting html code we display +	* @since 3.1-A1 +	*/ +	$vars = array('tpl_type', 'key', 'new', 'name', 'vars', 'tpl'); +	extract($phpbb_dispatcher->trigger_event('core.build_config_template', compact($vars))); + +	return $tpl; +} + +/** +* Going through a config array and validate values, writing errors to $error. The validation method  accepts parameters separated by ':' for string and int. +* The first parameter defines the type to be used, the second the lower bound and the third the upper bound. Only the type is required. +*/ +function validate_config_vars($config_vars, &$cfg_array, &$error) +{ +	global $phpbb_root_path, $user, $phpbb_dispatcher; + +	$type	= 0; +	$min	= 1; +	$max	= 2; + +	foreach ($config_vars as $config_name => $config_definition) +	{ +		if (!isset($cfg_array[$config_name]) || strpos($config_name, 'legend') !== false) +		{ +			continue; +		} + +		if (!isset($config_definition['validate'])) +		{ +			continue; +		} + +		$validator = explode(':', $config_definition['validate']); + +		// Validate a bit. ;) (0 = type, 1 = min, 2= max) +		switch ($validator[$type]) +		{ +			case 'string': +				$length = utf8_strlen($cfg_array[$config_name]); + +				// the column is a VARCHAR +				$validator[$max] = (isset($validator[$max])) ? min(255, $validator[$max]) : 255; + +				if (isset($validator[$min]) && $length < $validator[$min]) +				{ +					$error[] = sprintf($user->lang['SETTING_TOO_SHORT'], $user->lang[$config_definition['lang']], $validator[$min]); +				} +				else if (isset($validator[$max]) && $length > $validator[2]) +				{ +					$error[] = sprintf($user->lang['SETTING_TOO_LONG'], $user->lang[$config_definition['lang']], $validator[$max]); +				} +			break; + +			case 'bool': +				$cfg_array[$config_name] = ($cfg_array[$config_name]) ? 1 : 0; +			break; + +			case 'int': +				$cfg_array[$config_name] = (int) $cfg_array[$config_name]; + +				if (isset($validator[$min]) && $cfg_array[$config_name] < $validator[$min]) +				{ +					$error[] = sprintf($user->lang['SETTING_TOO_LOW'], $user->lang[$config_definition['lang']], $validator[$min]); +				} +				else if (isset($validator[$max]) && $cfg_array[$config_name] > $validator[$max]) +				{ +					$error[] = sprintf($user->lang['SETTING_TOO_BIG'], $user->lang[$config_definition['lang']], $validator[$max]); +				} + +				if (strpos($config_name, '_max') !== false) +				{ +					// Min/max pairs of settings should ensure that min <= max +					// Replace _max with _min to find the name of the minimum +					// corresponding configuration variable +					$min_name = str_replace('_max', '_min', $config_name); + +					if (isset($cfg_array[$min_name]) && is_numeric($cfg_array[$min_name]) && $cfg_array[$config_name] < $cfg_array[$min_name]) +					{ +						// A minimum value exists and the maximum value is less than it +						$error[] = sprintf($user->lang['SETTING_TOO_LOW'], $user->lang[$config_definition['lang']], (int) $cfg_array[$min_name]); +					} +				} +			break; + +			// Absolute path +			case 'script_path': +				if (!$cfg_array[$config_name]) +				{ +					break; +				} + +				$destination = str_replace('\\', '/', $cfg_array[$config_name]); + +				if ($destination !== '/') +				{ +					// Adjust destination path (no trailing slash) +					if (substr($destination, -1, 1) == '/') +					{ +						$destination = substr($destination, 0, -1); +					} + +					$destination = str_replace(array('../', './'), '', $destination); + +					if ($destination[0] != '/') +					{ +						$destination = '/' . $destination; +					} +				} + +				$cfg_array[$config_name] = trim($destination); + +			break; + +			// Absolute path +			case 'lang': +				if (!$cfg_array[$config_name]) +				{ +					break; +				} + +				$cfg_array[$config_name] = basename($cfg_array[$config_name]); + +				if (!file_exists($phpbb_root_path . 'language/' . $cfg_array[$config_name] . '/')) +				{ +					$error[] = $user->lang['WRONG_DATA_LANG']; +				} +			break; + +			// Relative path (appended $phpbb_root_path) +			case 'rpath': +			case 'rwpath': +				if (!$cfg_array[$config_name]) +				{ +					break; +				} + +				$destination = $cfg_array[$config_name]; + +				// Adjust destination path (no trailing slash) +				if (substr($destination, -1, 1) == '/' || substr($destination, -1, 1) == '\\') +				{ +					$destination = substr($destination, 0, -1); +				} + +				$destination = str_replace(array('../', '..\\', './', '.\\'), '', $destination); +				if ($destination && ($destination[0] == '/' || $destination[0] == "\\")) +				{ +					$destination = ''; +				} + +				$cfg_array[$config_name] = trim($destination); + +			// Path being relative (still prefixed by phpbb_root_path), but with the ability to escape the root dir... +			case 'path': +			case 'wpath': + +				if (!$cfg_array[$config_name]) +				{ +					break; +				} + +				$cfg_array[$config_name] = trim($cfg_array[$config_name]); + +				// Make sure no NUL byte is present... +				if (strpos($cfg_array[$config_name], "\0") !== false || strpos($cfg_array[$config_name], '%00') !== false) +				{ +					$cfg_array[$config_name] = ''; +					break; +				} + +				if (!file_exists($phpbb_root_path . $cfg_array[$config_name])) +				{ +					$error[] = sprintf($user->lang['DIRECTORY_DOES_NOT_EXIST'], $cfg_array[$config_name]); +				} + +				if (file_exists($phpbb_root_path . $cfg_array[$config_name]) && !is_dir($phpbb_root_path . $cfg_array[$config_name])) +				{ +					$error[] = sprintf($user->lang['DIRECTORY_NOT_DIR'], $cfg_array[$config_name]); +				} + +				// Check if the path is writable +				if ($config_definition['validate'] == 'wpath' || $config_definition['validate'] == 'rwpath') +				{ +					if (file_exists($phpbb_root_path . $cfg_array[$config_name]) && !phpbb_is_writable($phpbb_root_path . $cfg_array[$config_name])) +					{ +						$error[] = sprintf($user->lang['DIRECTORY_NOT_WRITABLE'], $cfg_array[$config_name]); +					} +				} + +			break; + +			default: +				/** +				* Validate a config value +				* +				* @event core.validate_config_variable +				* @var	array	cfg_array	Array with config values +				* @var	string	config_name	Name of the config we validate +				* @var	array	config_definition	Array with the options for +				*									this config +				* @var	array	error		Array of errors, the errors should +				*							be strings only, language keys are +				*							not replaced afterwards +				* @since 3.1-A1 +				*/ +				$vars = array('cfg_array', 'config_name', 'config_definition', 'error'); +				extract($phpbb_dispatcher->trigger_event('core.validate_config_variable', compact($vars))); +			break; +		} +	} + +	return; +} + +/** +* Checks whatever or not a variable is OK for use in the Database +* param mixed $value_ary An array of the form array(array('lang' => ..., 'value' => ..., 'column_type' =>))' +* param mixed $error The error array +*/ +function validate_range($value_ary, &$error) +{ +	global $user; + +	$column_types = array( +		'BOOL'	=> array('php_type' => 'int', 		'min' => 0, 				'max' => 1), +		'USINT'	=> array('php_type' => 'int',		'min' => 0, 				'max' => 65535), +		'UINT'	=> array('php_type' => 'int', 		'min' => 0, 				'max' => (int) 0x7fffffff), +		// Do not use (int) 0x80000000 - it evaluates to different +		// values on 32-bit and 64-bit systems. +		// Apparently -2147483648 is a float on 32-bit systems, +		// despite fitting in an int, thus explicit cast is needed. +		'INT'	=> array('php_type' => 'int', 		'min' => (int) -2147483648,	'max' => (int) 0x7fffffff), +		'TINT'	=> array('php_type' => 'int',		'min' => -128,				'max' => 127), + +		'VCHAR'	=> array('php_type' => 'string', 	'min' => 0, 				'max' => 255), +	); +	foreach ($value_ary as $value) +	{ +		$column = explode(':', $value['column_type']); +		$max = $min = 0; +		$type = 0; +		if (!isset($column_types[$column[0]])) +		{ +			continue; +		} +		else +		{ +			$type = $column_types[$column[0]]; +		} + +		switch ($type['php_type']) +		{ +			case 'string' : +				$max = (isset($column[1])) ? min($column[1],$type['max']) : $type['max']; +				if (utf8_strlen($value['value']) > $max) +				{ +					$error[] = sprintf($user->lang['SETTING_TOO_LONG'], $user->lang[$value['lang']], $max); +				} +			break; + +			case 'int': +				$min = (isset($column[1])) ? max($column[1],$type['min']) : $type['min']; +				$max = (isset($column[2])) ? min($column[2],$type['max']) : $type['max']; +				if ($value['value'] < $min) +				{ +					$error[] = sprintf($user->lang['SETTING_TOO_LOW'], $user->lang[$value['lang']], $min); +				} +				else if ($value['value'] > $max) +				{ +					$error[] = sprintf($user->lang['SETTING_TOO_BIG'], $user->lang[$value['lang']], $max); +				} +			break; +		} +	} +} | 
