diff options
Diffstat (limited to 'phpBB/includes/acp/acp_extensions.php')
| -rw-r--r-- | phpBB/includes/acp/acp_extensions.php | 355 | 
1 files changed, 355 insertions, 0 deletions
| diff --git a/phpBB/includes/acp/acp_extensions.php b/phpBB/includes/acp/acp_extensions.php new file mode 100644 index 0000000000..2ff479d824 --- /dev/null +++ b/phpBB/includes/acp/acp_extensions.php @@ -0,0 +1,355 @@ +<?php +/** +* +* @package acp +* @copyright (c) 2012 phpBB Group +* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ +	exit; +} + +/** +* @package acp +*/ +class acp_extensions +{ +	var $u_action; + +	private $db; +	private $config; +	private $template; +	private $user; + +	function main() +	{ +		// Start the page +		global $config, $user, $template, $request, $phpbb_extension_manager, $db, $phpbb_root_path, $phpEx; + +		$this->db = $db; +		$this->config = $config; +		$this->template = $template; +		$this->user = $user; + +		$user->add_lang(array('install', 'acp/extensions', 'migrator')); + +		$this->page_title = 'ACP_EXTENSIONS'; + +		$action = $request->variable('action', 'list'); +		$ext_name = $request->variable('ext_name', ''); + +		// What is a safe limit of execution time? Half the max execution time should be safe. +		$safe_time_limit = (ini_get('max_execution_time') / 2); +		$start_time = time(); + +		// Cancel action +		if ($request->is_set_post('cancel')) +		{ +			$action = 'list'; +			$ext_name = ''; +		} + +		if (in_array($action, array('enable', 'disable', 'delete_data')) && !check_link_hash($request->variable('hash', ''), $action . '.' . $ext_name)) +		{ +			trigger_error('FORM_INVALID', E_USER_WARNING); +		} + +		// If they've specified an extension, let's load the metadata manager and validate it. +		if ($ext_name) +		{ +			$md_manager = new \phpbb\extension\metadata_manager($ext_name, $config, $phpbb_extension_manager, $template, $phpbb_root_path); + +			try +			{ +				$md_manager->get_metadata('all'); +			} +			catch(\phpbb\extension\exception $e) +			{ +				trigger_error($e, E_USER_WARNING); +			} +		} + +		// What are we doing? +		switch ($action) +		{ +			case 'list': +			default: +				$this->list_enabled_exts($phpbb_extension_manager); +				$this->list_disabled_exts($phpbb_extension_manager); +				$this->list_available_exts($phpbb_extension_manager); + +				$this->tpl_name = 'acp_ext_list'; +			break; + +			case 'enable_pre': +				if (!$md_manager->validate_dir()) +				{ +					trigger_error($user->lang['EXTENSION_DIR_INVALID'] . adm_back_link($this->u_action), E_USER_WARNING); +				} + +				if (!$md_manager->validate_enable()) +				{ +					trigger_error($user->lang['EXTENSION_NOT_AVAILABLE'] . adm_back_link($this->u_action), E_USER_WARNING); +				} + +				if ($phpbb_extension_manager->enabled($ext_name)) +				{ +					redirect($this->u_action); +				} + +				$this->tpl_name = 'acp_ext_enable'; + +				$template->assign_vars(array( +					'PRE'				=> true, +					'L_CONFIRM_MESSAGE'	=> $this->user->lang('EXTENSION_ENABLE_CONFIRM', $md_manager->get_metadata('display-name')), +					'U_ENABLE'			=> $this->u_action . '&action=enable&ext_name=' . urlencode($ext_name) . '&hash=' . generate_link_hash('enable.' . $ext_name), +				)); +			break; + +			case 'enable': +				if (!$md_manager->validate_dir()) +				{ +					trigger_error($user->lang['EXTENSION_DIR_INVALID'] . adm_back_link($this->u_action), E_USER_WARNING); +				} + +				if (!$md_manager->validate_enable()) +				{ +					trigger_error($user->lang['EXTENSION_NOT_AVAILABLE'] . adm_back_link($this->u_action), E_USER_WARNING); +				} + +				try +				{ +					while ($phpbb_extension_manager->enable_step($ext_name)) +					{ +						// Are we approaching the time limit? If so we want to pause the update and continue after refreshing +						if ((time() - $start_time) >= $safe_time_limit) +						{ +							$template->assign_var('S_NEXT_STEP', true); + +							meta_refresh(0, $this->u_action . '&action=enable&ext_name=' . urlencode($ext_name) . '&hash=' . generate_link_hash('enable.' . $ext_name)); +						} +					} +				} +				catch (\phpbb\db\migration\exception $e) +				{ +					$template->assign_var('MIGRATOR_ERROR', $e->getLocalisedMessage($user)); +				} + +				$this->tpl_name = 'acp_ext_enable'; + +				$template->assign_vars(array( +					'U_RETURN'		=> $this->u_action . '&action=list', +				)); +			break; + +			case 'disable_pre': +				if (!$phpbb_extension_manager->enabled($ext_name)) +				{ +					redirect($this->u_action); +				} + +				$this->tpl_name = 'acp_ext_disable'; + +				$template->assign_vars(array( +					'PRE'				=> true, +					'L_CONFIRM_MESSAGE'	=> $this->user->lang('EXTENSION_DISABLE_CONFIRM', $md_manager->get_metadata('display-name')), +					'U_DISABLE'			=> $this->u_action . '&action=disable&ext_name=' . urlencode($ext_name) . '&hash=' . generate_link_hash('disable.' . $ext_name), +				)); +			break; + +			case 'disable': +				while ($phpbb_extension_manager->disable_step($ext_name)) +				{ +					// Are we approaching the time limit? If so we want to pause the update and continue after refreshing +					if ((time() - $start_time) >= $safe_time_limit) +					{ +						$template->assign_var('S_NEXT_STEP', true); + +						meta_refresh(0, $this->u_action . '&action=disable&ext_name=' . urlencode($ext_name) . '&hash=' . generate_link_hash('disable.' . $ext_name)); +					} +				} + +				$this->tpl_name = 'acp_ext_disable'; + +				$template->assign_vars(array( +					'U_RETURN'	=> $this->u_action . '&action=list', +				)); +			break; + +			case 'delete_data_pre': +				if ($phpbb_extension_manager->enabled($ext_name)) +				{ +					redirect($this->u_action); +				} +				$this->tpl_name = 'acp_ext_delete_data'; + +				$template->assign_vars(array( +					'PRE'				=> true, +					'L_CONFIRM_MESSAGE'	=> $this->user->lang('EXTENSION_DELETE_DATA_CONFIRM', $md_manager->get_metadata('display-name')), +					'U_PURGE'			=> $this->u_action . '&action=delete_data&ext_name=' . urlencode($ext_name) . '&hash=' . generate_link_hash('delete_data.' . $ext_name), +				)); +			break; + +			case 'delete_data': +				try +				{ +					while ($phpbb_extension_manager->purge_step($ext_name)) +					{ +						// Are we approaching the time limit? If so we want to pause the update and continue after refreshing +						if ((time() - $start_time) >= $safe_time_limit) +						{ +							$template->assign_var('S_NEXT_STEP', true); + +							meta_refresh(0, $this->u_action . '&action=delete_data&ext_name=' . urlencode($ext_name) . '&hash=' . generate_link_hash('delete_data.' . $ext_name)); +						} +					} +				} +				catch (\phpbb\db\migration\exception $e) +				{ +					$template->assign_var('MIGRATOR_ERROR', $e->getLocalisedMessage($user)); +				} + +				$this->tpl_name = 'acp_ext_delete_data'; + +				$template->assign_vars(array( +					'U_RETURN'	=> $this->u_action . '&action=list', +				)); +			break; + +			case 'details': +				// Output it to the template +				$md_manager->output_template_data(); + +				$template->assign_var('U_BACK', $this->u_action . '&action=list'); + +				$this->tpl_name = 'acp_ext_details'; +			break; +		} +	} + +	/** +	 * Lists all the enabled extensions and dumps to the template +	 * +	 * @param  $phpbb_extension_manager     An instance of the extension manager +	 * @return null +	 */ +	public function list_enabled_exts(\phpbb\extension\manager $phpbb_extension_manager) +	{ +		foreach ($phpbb_extension_manager->all_enabled() as $name => $location) +		{ +			$md_manager = $phpbb_extension_manager->create_extension_metadata_manager($name, $this->template); + +			try +			{ +				$this->template->assign_block_vars('enabled', array( +					'META_DISPLAY_NAME'		=> $md_manager->get_metadata('display-name'), + +					'U_DETAILS'		=> $this->u_action . '&action=details&ext_name=' . urlencode($name), +				)); + +				$this->output_actions('enabled', array( +					'DISABLE'		=> $this->u_action . '&action=disable_pre&ext_name=' . urlencode($name), +				)); +			} +			catch(\phpbb\extension\exception $e) +			{ +				$this->template->assign_block_vars('disabled', array( +					'META_DISPLAY_NAME'		=> $this->user->lang('EXTENSION_INVALID_LIST', $name, $e), +				)); +			} +		} +	} + +	/** +	 * Lists all the disabled extensions and dumps to the template +	 * +	 * @param  $phpbb_extension_manager     An instance of the extension manager +	 * @return null +	 */ +	public function list_disabled_exts(\phpbb\extension\manager $phpbb_extension_manager) +	{ +		foreach ($phpbb_extension_manager->all_disabled() as $name => $location) +		{ +			$md_manager = $phpbb_extension_manager->create_extension_metadata_manager($name, $this->template); + +			try +			{ +				$this->template->assign_block_vars('disabled', array( +					'META_DISPLAY_NAME'		=> $md_manager->get_metadata('display-name'), + +					'U_DETAILS'		=> $this->u_action . '&action=details&ext_name=' . urlencode($name), +				)); + +				$this->output_actions('disabled', array( +					'ENABLE'		=> $this->u_action . '&action=enable_pre&ext_name=' . urlencode($name), +					'DELETE_DATA'	=> $this->u_action . '&action=delete_data_pre&ext_name=' . urlencode($name), +				)); +			} +			catch(\phpbb\extension\exception $e) +			{ +				$this->template->assign_block_vars('disabled', array( +					'META_DISPLAY_NAME'		=> $this->user->lang('EXTENSION_INVALID_LIST', $name, $e), +				)); +			} +		} +	} + +	/** +	 * Lists all the available extensions and dumps to the template +	 * +	 * @param  $phpbb_extension_manager     An instance of the extension manager +	 * @return null +	 */ +	public function list_available_exts(\phpbb\extension\manager $phpbb_extension_manager) +	{ +		$uninstalled = array_diff_key($phpbb_extension_manager->all_available(), $phpbb_extension_manager->all_configured()); + +		foreach ($uninstalled as $name => $location) +		{ +			$md_manager = $phpbb_extension_manager->create_extension_metadata_manager($name, $this->template); + +			try +			{ +				$this->template->assign_block_vars('disabled', array( +					'META_DISPLAY_NAME'		=> $md_manager->get_metadata('display-name'), + +					'U_DETAILS'		=> $this->u_action . '&action=details&ext_name=' . urlencode($name), +				)); + +				$this->output_actions('disabled', array( +					'ENABLE'		=> $this->u_action . '&action=enable_pre&ext_name=' . urlencode($name), +				)); +			} +			catch(\phpbb\extension\exception $e) +			{ +				$this->template->assign_block_vars('disabled', array( +					'META_DISPLAY_NAME'		=> $this->user->lang('EXTENSION_INVALID_LIST', $name, $e), +				)); +			} +		} +	} + +	/** +	* Output actions to a block +	* +	* @param string $block +	* @param array $actions +	*/ +	private function output_actions($block, $actions) +	{ +		foreach ($actions as $lang => $url) +		{ +			$this->template->assign_block_vars($block . '.actions', array( +				'L_ACTION'			=> $this->user->lang('EXTENSION_' . $lang), +				'L_ACTION_EXPLAIN'	=> (isset($this->user->lang['EXTENSION_' . $lang . '_EXPLAIN'])) ? $this->user->lang('EXTENSION_' . $lang . '_EXPLAIN') : '', +				'U_ACTION'			=> $url, +			)); +		} +	} +} | 
