php-phpbb/phpBB/includes/acp/acp_extensions.php

<?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'));

		$this->page_title = 'ACP_EXTENSIONS';

		$action = $request->variable('action', 'list');
		$ext_name = $request->variable('ext_name', '');

		// If they've specificed an extension, let's load the metadata manager and validate it.
		if ($ext_name)
		{
			$md_manager = new phpbb_extension_metadata_manager($ext_name, $db, $phpbb_extension_manager, $phpbb_root_path, ".$phpEx", $template, $config);

			try
			{
				$md_manager->get_metadata('all');
			}
			catch(phpbb_extension_exception $e)
			{
				trigger_error($e);
			}
		}

		// 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_enable() || $phpbb_extension_manager->enabled($ext_name))
				{
					trigger_error('EXTENSION_NOT_AVAILABLE');
				}

				$this->tpl_name = 'acp_ext_enable';

				$template->assign_vars(array(
					'PRE'		=> true,
					'U_ENABLE'	=> $this->u_action . '&amp;action=enable&amp;ext_name=' . urlencode($ext_name),
				));
			break;

			case 'enable':
				if (!$md_manager->validate_enable())
				{
					trigger_error('EXTENSION_NOT_AVAILABLE');
				}

				if ($phpbb_extension_manager->enable_step($ext_name))
				{
					$template->assign_var('S_NEXT_STEP', true);

					meta_refresh(0, $this->u_action . '&amp;action=enable&amp;ext_name=' . urlencode($ext_name));
				}

				$this->tpl_name = 'acp_ext_enable';

				$template->assign_vars(array(
					'U_RETURN'	=> $this->u_action . '&amp;action=list',
				));
			break;

			case 'disable_pre':
				if (!$phpbb_extension_manager->enabled($ext_name))
				{
					trigger_error('EXTENSION_NOT_AVAILABLE');
				}

				$this->tpl_name = 'acp_ext_disable';

				$template->assign_vars(array(
					'PRE'		=> true,
					'U_DISABLE'	=> $this->u_action . '&amp;action=disable&amp;ext_name=' . urlencode($ext_name),
				));
			break;

			case 'disable':
				if ($phpbb_extension_manager->disable_step($ext_name))
				{
					$template->assign_var('S_NEXT_STEP', true);

					meta_refresh(0, $this->u_action . '&amp;action=disable&amp;ext_name=' . urlencode($ext_name));
				}

				$this->tpl_name = 'acp_ext_disable';

				$template->assign_vars(array(
					'U_RETURN'	=> $this->u_action . '&amp;action=list',
				));
			break;

			case 'purge_pre':
				$this->tpl_name = 'acp_ext_purge';

				$template->assign_vars(array(
					'PRE'		=> true,
					'U_PURGE'	=> $this->u_action . '&amp;action=purge&amp;ext_name=' . urlencode($ext_name),
				));
			break;

			case 'purge':
				if ($phpbb_extension_manager->purge_step($ext_name))
				{
					$template->assign_var('S_NEXT_STEP', true);

					meta_refresh(0, $this->u_action . '&amp;action=purge&amp;ext_name=' . urlencode($ext_name));
				}

				$this->tpl_name = 'acp_ext_purge';

				$template->assign_vars(array(
					'U_RETURN'	=> $this->u_action . '&amp;action=list',
				));
			break;

			case 'details':
				// Output it to the template
				$md_manager->output_template_data();

				$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(
					'EXT_NAME'		=> $md_manager->get_metadata('display-name'),

					'U_DETAILS'		=> $this->u_action . '&amp;action=details&amp;ext_name=' . urlencode($name),
				));

				$this->output_actions('enabled', array(
					'DISABLE'		=> $this->u_action . '&amp;action=disable_pre&amp;ext_name=' . urlencode($name),
					'PURGE'			=> $this->u_action . '&amp;action=purge_pre&amp;ext_name=' . urlencode($name),
				));
			}
			catch(phpbb_extension_exception $e)
			{
				$this->template->assign_block_vars('disabled', array(
					'EXT_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(
					'EXT_NAME'		=> $md_manager->get_metadata('display-name'),

					'U_DETAILS'		=> $this->u_action . '&amp;action=details&amp;ext_name=' . urlencode($name),
				));

				$this->output_actions('disabled', array(
					'ENABLE'		=> $this->u_action . '&amp;action=enable_pre&amp;ext_name=' . urlencode($name),
					'PURGE'			=> $this->u_action . '&amp;action=purge_pre&amp;ext_name=' . urlencode($name),
				));
			}
			catch(phpbb_extension_exception $e)
			{
				$this->template->assign_block_vars('disabled', array(
					'EXT_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(
					'EXT_NAME'		=> $md_manager->get_metadata('display-name'),

					'U_DETAILS'		=> $this->u_action . '&amp;action=details&amp;ext_name=' . urlencode($name),
				));

				$this->output_actions('disabled', array(
					'ENABLE'		=> $this->u_action . '&amp;action=enable_pre&amp;ext_name=' . urlencode($name),
				));
			}
			catch(phpbb_extension_exception $e)
			{
				$this->template->assign_block_vars('disabled', array(
					'EXT_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($lang),
				'U_ACTION'		=> $url,
			));
		}
	}
}