1 files changed, 289 insertions, 95 deletions
diff --git a/phpBB/includes/functions_module.php b/phpBB/includes/functions_module.php
index cdb2cd6fa5..d3c2a9bf9e 100644
--- a/phpBB/includes/functions_module.php
+++ b/phpBB/includes/functions_module.php
@@ -9,139 +9,203 @@
 */
 
 /**
-* @package phpBB3
-* Module Class handling all types of modules
+* Class handling all types of 'plugins' (a future term)
 */
-class module
+class p_master
 {
-	var $id = 0;
-	var $filename;
-	var $mode;
+	/**#@+
+	* @access private
+	*/
+	var $p_id;
+	var $p_class;
+	var $p_name;
+	var $p_mode;
+	var $p_parent;
+
+	var $acl_forup_id = false;
+	/**#@-*/
+
+	/**#@+
+	* This array holds information on the list of modules
+	*/
 	var $module_ary = array();
-	var $module_y_ary = array();
-	var $module_url = '';
-	var $module_path = '';
-	var $acl_forum_id = false;
-
-	// Private methods, should not be overwritten
-	function create($module_type, $module_path, $module_url, $selected_module = false)
+	/**#@-*/
+
+	/**
+	* List modules
+	*
+	* This creates a list, stored in $this->module_ary of all available
+	* modules for the given class (ucp, mcp and acp). Additionally
+	* $this->module_y_ary is created with indentation information for
+	* displaying the module list appropriately. Only modules for which
+	* the user has access rights are included in these lists.
+	*
+	* @final
+	*/
+	function list_modules($p_class)
 	{
-		global $template, $auth, $db, $user, $config, $phpbb_root_path, $phpEx;
+		global $auth, $db, $user;
+		global $config, $phpbb_root_path, $phpEx;
 
 		$active = $category = false;
-		$this->module_url = htmlspecialchars($module_url);
-		// TODO Do some checking here?
-		$this->module_path = $module_path;
 
-		if (file_exists($phpbb_root_path . 'cache/' . $module_type . '_modules.'.$phpEx))
+		// Sanitise for future path use, it's escaped as appropriate for queries
+		$this->p_class = str_replace(array('.', '/', '\\'), '', basename($p_class));
+		
+		$sql_and = '';
+		if (file_exists($phpbb_root_path . 'cache/' . $this->p_class . '_modules.' . $phpEx))
 		{
-			include($phpbb_root_path . 'cache/' . $module_type . '_modules.'.$phpEx);
+			include($phpbb_root_path . 'cache/' . $this->p_class . '_modules.' . $phpEx);
 		}
 
 		$sql = 'SELECT *
 			FROM ' . MODULES_TABLE . "
-			WHERE module_type = '" . $db->sql_escape($module_type) . "'
+			WHERE module_class = '" . $db->sql_escape($p_class) . "'
 				AND module_enabled = 1
 				$sql_and
-			ORDER BY left_id";
+			ORDER BY left_id ASC";
 		$result = $db->sql_query($sql);
 
-		$padding = $i = 0;
+		$right = $depth = $i = 0;
+		$depth_ary = array();
+
 		while ($row = $db->sql_fetchrow($result))
 		{
 			// Authorisation is required ... not authed, skip
 			if ($row['module_auth'])
 			{
 				$is_auth = false;
-				eval('$is_auth = (int) (' . preg_replace(array('#acl_([a-z_]+)(,\$id)?#e', '#\$id#', '#cfg_([a-z_]+)#e'), array('(int) $auth->acl_get("\\1"\\2)', '$this->acl_forum_id', '(int) $config["\\1"]'), trim($row['module_auth'])) . ');');
+				eval('$is_auth = (int) (' . preg_replace(array('#acl_([a-z_]+)(,\$id)?#e', '#\$id#', '#cfg_([a-z_]+)#e'), array('(int) $auth->acl_get("\\1"\\2)', '$this->acl_forup_id', '(int) $config["\\1"]'), trim($row['module_auth'])) . ');');
 				if (!$is_auth)
 				{
 					continue;
 				}
 			}
 
-			if ($row['module_cat'] && ($row['left_id'] + 1 == $row['right_id']))
+			// Category with no members, ignore
+			if (!$row['module_name'] && ($row['left_id'] + 1 == $row['right_id']))
 			{
-				// Categoriy with no members, ignore
 				continue;
 			}
 
 			if ($row['left_id'] < $right)
 			{
-				$padding++;
-				$padding_store[$row['parent_id']] = $padding;
+				$depth++;
+				$depth_ary[$row['parent_id']] = $depth;
 			}
 			else if ($row['left_id'] > $right + 1)
 			{
-				$padding = $padding_store[$row['parent_id']];
+				if (!isset($depth_ary[$row['parent_id']]))
+				{
+					$depth = 0;
+				}
+				else
+				{
+					$depth = $depth_ary[$row['parent_id']];
+				}
 			}
 
 			$right = $row['right_id'];
 
-			$this->module_y_ary[$i] 			= ($padding) ? $padding : 0;
+			$this->module_ary[$i]['depth']		= $depth;
 
 			$this->module_ary[$i]['id'] 		= (int) $row['module_id'];
-			$this->module_ary[$i]['name'] 		= (function_exists($row['module_filename'])) ? $row['module_filename']($row['module_name']) : ((!empty($user->lang[$row['module_name']])) ? $user->lang[$row['module_name']] : ucfirst(str_replace('_', ' ', strtolower($row['module_name']))));
-			$this->module_ary[$i]['filename']	= (string) $row['module_filename'];
 			$this->module_ary[$i]['parent'] 	= (int) $row['parent_id'];
-			$this->module_ary[$i]['category']	= (bool) $row['module_cat'];
-			$this->module_ary[$i]['hilit'] 		= (bool) $row['module_hilit'];
-			$this->module_ary[$i]['active'] 	= false;
+			$this->module_ary[$i]['cat'] 		= ($row['right_id'] > $row['left_id'] + 1) ? true : false;
+
+			$this->module_ary[$i]['name']		= (string) $row['module_name'];
+			$this->module_ary[$i]['mode']		= (string) $row['module_mode'];
+
+			$this->module_ary[$i]['lang'] 		= (function_exists($row['module_name'])) ? $row['module_name']($row['module_mode'], $row['module_langname']) : ((!empty($user->lang[$row['module_langname']])) ? $user->lang[$row['module_langname']] : ucfirst(str_replace('_', ' ', strtolower($row['module_langname']))));
+			$this->module_ary[$i]['langname']	= $row['module_langname'];
+
+			$i++;
+		}
+		$db->sql_freeresult($result);
+	}
 
+	function set_active($id = false, $mode = false)
+	{
+		$category = false;
+		foreach ($this->module_ary as $row_id => $itep_ary)
+		{
 			// If this is a module and it's selected, active
 			// If this is a category and the module is the first within it, active
+			// If this is a module and no mode selected, select first mode
 			// If no category or module selected, go active for first module in first category
-			if (!$active && ((!$row['module_cat'] && $row['module_id'] == $selected_module) || $row['parent_id'] === $category || (!$selected_module && !$row['module_cat'])))
+			if ( 
+				(($itep_ary['name'] === $id || $itep_ary['id'] === (int) $id) && $itep_ary['mode'] == $mode && !$itep_ary['cat']) ||
+				($itep_ary['parent'] === $category && !$itep_ary['cat']) ||
+				(($itep_ary['name'] === $id || $itep_ary['id'] === (int) $id) && !$mode && !$itep_ary['cat']) ||
+				(!$id && !$mode && !$itep_ary['cat'])
+				)
 			{
-				$this->module_ary[$i]['active'] = true;
-
-				$this->id		= (int) $row['module_id'];
-				$this->parent	= (int) $row['parent_id'];
-				$this->filename = (string) $row['module_filename'];
-				$this->mode 	= (string) $row['module_mode'];
+				$this->p_id		= $itep_ary['id'];
+				$this->p_parent	= $itep_ary['parent'];
+				$this->p_name	= $itep_ary['name'];
+				$this->p_mode 	= $itep_ary['mode'];
 
-				$active = true;
+				break;
 			}
-			else if ($row['module_cat'] && $row['module_id'] == $selected_module)
+			else if ($itep_ary['cat'] && $itep_ary['id'] == $id)
 			{
-				$category = $row['module_id'];
+				$category = $itep_ary['id'];
 			}
-
-			$i++;
 		}
-		$db->sql_freeresult($result);
+		
 	}
 
-	function load($mode = false, $run = true)
+	/**
+	* Loads currently active module
+	*
+	* This method loads a given module, passing it the relevant id and mode.
+	*
+	* @final
+	*/
+	function load_active($mode = false)
 	{
 		global $phpbb_root_path, $phpEx;
 
-		if (!class_exists($this->filename))
+		$module_path = $phpbb_root_path . 'includes/' . $this->p_class;
+
+		if (!class_exists("{$this->p_class}_$this->p_name"))
 		{
-			require_once($phpbb_root_path . "$this->module_path/$this->filename.$phpEx");
+			if (!file_exists("$module_path/{$this->p_class}_$this->p_name.$phpEx"))
+			{
+				trigger_error('Cannot find module', E_USER_ERROR);
+			}
+
+			include("$module_path/{$this->p_class}_$this->p_name.$phpEx");
 
-			if ($run)
+			if (!class_exists("{$this->p_class}_$this->p_name"))
 			{
-				if (!empty($mode))
-				{
-					$this->mode = $mode;
-				}
+				trigger_error('Module does not contain correct class', E_USER_ERROR);
+			}
 
-				eval("\$this->module = new $this->filename(\$this->id, \$this->mode);");
-				if (method_exists($this->module, 'init'))
-				{
-					$this->module->init();
-				}
+			if (!empty($mode))
+			{
+				$this->p_mode = $mode;
 			}
+
+			// Create a new instance of the desired module ... if it has a
+			// constructor it will of course be executed
+			$instance = "{$this->p_class}_$this->p_name";
+
+			$this->module = new $instance($this);
+
+			// Execute the main method for the new instance, we send the module
+			// id and mode as parameters
+			$this->module->main($this->p_id, $this->p_mode);
+
+			return;
 		}
 	}
 
-	// Displays the appropriate template with the given title
-	function display($page_title, $tpl_name)
+	function assign_tpl_vars($module_url)
 	{
 		global $template;
 
-		$current_padding = 0;
+		$current_padding = $current_depth = 0;
 		$linear_offset 	= 'l_block1';
 		$tabular_offset = 't_block2';
 
@@ -149,69 +213,199 @@ class module
 		// 1) In a linear fashion
 		// 2) In a combined tabbed + linear fashion ... tabs for the categories
 		//    and a linear list for subcategories/items
-		foreach ($this->module_ary as $row_id => $item_ary)
+		foreach ($this->module_ary as $row_id => $itep_ary)
 		{
-			$padding = $this->module_y_ary[$row_id];
+			$depth = $itep_ary['depth'];
 
-			if ($padding > $current_padding)
+			if ($depth > $current_depth)
 			{
-				$linear_offset = $linear_offset . '.l_block' . ($padding + 1);
-				$tabular_offset = ($padding + 1 > 2) ? $tabular_offset . '.t_block' . ($padding + 1) : $tabular_offset;
+				$linear_offset = $linear_offset . '.l_block' . ($depth + 1);
+				$tabular_offset = ($depth + 1 > 2) ? $tabular_offset . '.t_block' . ($depth + 1) : $tabular_offset;
 			}
-			else if ($padding < $current_padding)
+			else if ($depth < $current_depth)
 			{
-				for ($i = $current_padding - $padding; $i > 0; $i--)
+				for ($i = $current_depth - $depth; $i > 0; $i--)
 				{
 					$linear_offset = substr($linear_offset, 0, strrpos($linear_offset, '.'));
-					$tabular_offset = ($i + $padding > 1) ? substr($tabular_offset, 0, strrpos($tabular_offset, '.')) : $tabular_offset;
+					$tabular_offset = ($i + $depth > 1) ? substr($tabular_offset, 0, strrpos($tabular_offset, '.')) : $tabular_offset;
 				}
 			}
 
-			$current_padding = $padding;
-
 			// Only output a categories items if it's currently selected
-			if (!$padding || ($padding && $item_ary['parent'] == $this->parent))
+			if (!$depth || ($depth && $itep_ary['parent'] == $this->p_parent))
 			{
-				$use_tabular_offset = (!$padding) ? 't_block1' : $tabular_offset;
+				$use_tabular_offset = (!$depth) ? 't_block1' : $tabular_offset;
+
 				$template->assign_block_vars($use_tabular_offset, array(
-					'L_TITLE'		=> $item_ary['name'],
-					'S_SELECTED'	=> ($item_ary['id'] == $this->parent || $item_ary['active']) ? true : false,
-					'U_TITLE'		=> $this->module_url . '&amp;i=' . $item_ary['id'])
-				);
+					'L_TITLE'		=> $itep_ary['lang'],
+					'S_SELECTED'	=> ($itep_ary['id'] == $this->p_parent || $itep_ary['id'] == $this->p_id) ? true : false,
+					'U_TITLE'		=> $module_url . '&amp;i=' . (($itep_ary['cat']) ? $itep_ary['id'] : $itep_ary['name'] . '&amp;mode=' . $itep_ary['mode'])
+				));
 			}
 
 			$template->assign_block_vars($linear_offset, array(
-				'L_TITLE'		=> $item_ary['name'],
-				'S_SELECTED'	=> ($item_ary['id'] == $this->parent || $item_ary['active']) ? true : false,
-				'U_TITLE'		=> $this->module_url . '&amp;i=' . $item_ary['id'])
-			);
+				'L_TITLE'		=> $itep_ary['lang'],
+				'S_SELECTED'	=> ($itep_ary['id'] == $this->p_parent || $itep_ary['id'] == $this->p_id) ? true : false,
+				'U_TITLE'		=> $module_url . '&amp;i=' . (($itep_ary['cat']) ? $itep_ary['id'] : $itep_ary['name'] . '&amp;mode=' . $itep_ary['mode'])
+			));
+
+			$current_depth = $depth;
 		}
+	}
 
+	/**
+	* Returns desired template name
+	*/
+	function get_tpl_name()
+	{
+		return $this->module->tpl_name . '.html';
+	}
+
+	/**
+	* Load module as the current active one without the need for registering it
+	*/
+	function load($class, $name, $mode = false)
+	{
+		$this->p_class = $class;
+		$this->p_name = $name;
+		
+		$this->load_active($mode);
+	}
+
+	/**
+	* Display module
+	*/
+	function display($page_title)
+	{
+		global $template;
+
+		// Generate the page
 		page_header($page_title);
 
 		$template->set_filenames(array(
-			'body' => $tpl_name . '_' . $this->mode . '.html')
+			'body' => $this->get_tpl_name())
 		);
 
 		page_footer();
 	}
+}
+
+/**
+* Unified module system
+* 
+* Functions for the ACP
+*/
+class p_master_acp extends p_master
+{
+	/**
+	* Move modules
+	*
+	* Private function used with the ACP module management system for moving modules
+	* within the tree. The movement of modules is limited to their category, they
+	* cannot be moved between categories (reducing complication for users and admins)
+	*
+	* @access private
+	function move($frop_id, $to_id)
+	{
+		global $db;
+
+		$moved_forums = get_forup_branch($frop_id, 'children', 'descending');
+		$frop_data = $moved_forums[0];
+		$diff = count($moved_forums) * 2;
+
+		$moved_ids = array();
+		for ($i = 0; $i < count($moved_forums); ++$i)
+		{
+			$moved_ids[] = $moved_forums[$i]['forup_id'];
+		}
+
+		// Resync parents
+		$sql = 'UPDATE ' . FORUMS_TABLE . "
+			SET right_id = right_id - $diff, forup_parents = ''
+			WHERE left_id < " . $frop_data['right_id'] . "
+				AND right_id > " . $frop_data['right_id'];
+		$db->sql_query($sql);
+
+		// Resync righthand side of tree
+		$sql = 'UPDATE ' . FORUMS_TABLE . "
+			SET left_id = left_id - $diff, right_id = right_id - $diff, forup_parents = ''
+			WHERE left_id > " . $frop_data['right_id'];
+		$db->sql_query($sql);
+
+		if ($to_id > 0)
+		{
+			$to_data = get_forup_info($to_id);
+
+			// Resync new parents
+			$sql = 'UPDATE ' . FORUMS_TABLE . "
+				SET right_id = right_id + $diff, forup_parents = ''
+				WHERE " . $to_data['right_id'] . ' BETWEEN left_id AND right_id
+					AND forup_id NOT IN (' . implode(', ', $moved_ids) . ')';
+			$db->sql_query($sql);
+
+			// Resync the righthand side of the tree
+			$sql = 'UPDATE ' . FORUMS_TABLE . "
+				SET left_id = left_id + $diff, right_id = right_id + $diff, forup_parents = ''
+				WHERE left_id > " . $to_data['right_id'] . '
+					AND forup_id NOT IN (' . implode(', ', $moved_ids) . ')';
+			$db->sql_query($sql);
+
+			// Resync moved branch
+			$to_data['right_id'] += $diff;
+			if ($to_data['right_id'] > $frop_data['right_id'])
+			{
+				$diff = '+ ' . ($to_data['right_id'] - $frop_data['right_id'] - 1);
+			}
+			else
+			{
+				$diff = '- ' . abs($to_data['right_id'] - $frop_data['right_id'] - 1);
+			}
+		}
+		else
+		{
+			$sql = 'SELECT MAX(right_id) AS right_id
+				FROM ' . FORUMS_TABLE . '
+				WHERE forup_id NOT IN (' . implode(', ', $moved_ids) . ')';
+			$result = $db->sql_query($sql);
+
+			$row = $db->sql_fetchrow($result);
+			$db->sql_freeresult($result);
+
+			$diff = '+ ' . ($row['right_id'] - $frop_data['left_id'] + 1);
+		}
+
+		$sql = 'UPDATE ' . FORUMS_TABLE . "
+			SET left_id = left_id $diff, right_id = right_id $diff, forup_parents = ''
+			WHERE forup_id IN (" . implode(', ', $moved_ids) . ')';
+		$db->sql_query($sql);
+	}
+*/
+}
 
-	//
-	// Public methods to be overwritten by modules
-	//
-	function module()
+/**
+* Unified module system
+*
+* This class provides a unified system for the creation and management of
+* modules used by the ACP, MCP and UCP.
+*/
+class p_module
+{
+	var $tpl_name;
+
+	function p_module()
+	{
+	}
+
+	function check_version()
 	{
-		// Module name
-		// Module filename
-		// Module description
-		// Module version
-		// Module compatibility
-		return false;
 	}
 
 	function init()
 	{
-		return false;
+	}
+
+	function install()
+	{
 	}
 }