4 files changed, 555 insertions, 0 deletions
diff --git a/phpBB/phpbb/controller/exception.php b/phpBB/phpbb/controller/exception.php
new file mode 100644
index 0000000000..437558b06a
--- /dev/null
+++ b/phpBB/phpbb/controller/exception.php
@@ -0,0 +1,21 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @copyright (c) phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+* For full copyright and license information, please see
+* the docs/CREDITS.txt file.
+*
+*/
+
+namespace phpbb\controller;
+
+/**
+* Controller exception class
+*/
+class exception extends \RuntimeException
+{
+}
diff --git a/phpBB/phpbb/controller/helper.php b/phpBB/phpbb/controller/helper.php
new file mode 100644
index 0000000000..ce6bfba981
--- /dev/null
+++ b/phpBB/phpbb/controller/helper.php
@@ -0,0 +1,267 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @copyright (c) phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+* For full copyright and license information, please see
+* the docs/CREDITS.txt file.
+*
+*/
+
+namespace phpbb\controller;
+
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Generator\UrlGenerator;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+use Symfony\Component\Routing\RequestContext;
+
+/**
+* Controller helper class, contains methods that do things for controllers
+*/
+class helper
+{
+	/**
+	* Template object
+	* @var \phpbb\template\template
+	*/
+	protected $template;
+
+	/**
+	* User object
+	* @var \phpbb\user
+	*/
+	protected $user;
+
+	/**
+	* config object
+	* @var \phpbb\config\config
+	*/
+	protected $config;
+
+	/* @var \phpbb\symfony_request */
+	protected $symfony_request;
+
+	/* @var \phpbb\request\request_interface */
+	protected $request;
+
+	/**
+	* @var \phpbb\filesystem The filesystem object
+	*/
+	protected $filesystem;
+
+	/**
+	* phpBB root path
+	* @var string
+	*/
+	protected $phpbb_root_path;
+
+	/**
+	* PHP file extension
+	* @var string
+	*/
+	protected $php_ext;
+
+	/**
+	* Constructor
+	*
+	* @param \phpbb\template\template $template Template object
+	* @param \phpbb\user $user User object
+	* @param \phpbb\config\config $config Config object
+	 *
+	 * @param \phpbb\controller\provider $provider Path provider
+	* @param \phpbb\extension\manager $manager Extension manager object
+	* @param \phpbb\symfony_request $symfony_request Symfony Request object
+	* @param \phpbb\request\request_interface $request phpBB request object
+	* @param \phpbb\filesystem $filesystem The filesystem object
+	* @param string $phpbb_root_path phpBB root path
+	* @param string $php_ext PHP file extension
+	*/
+	public function __construct(\phpbb\template\template $template, \phpbb\user $user, \phpbb\config\config $config, \phpbb\controller\provider $provider, \phpbb\extension\manager $manager, \phpbb\symfony_request $symfony_request, \phpbb\request\request_interface $request, \phpbb\filesystem $filesystem, $phpbb_root_path, $php_ext)
+	{
+		$this->template = $template;
+		$this->user = $user;
+		$this->config = $config;
+		$this->symfony_request = $symfony_request;
+		$this->request = $request;
+		$this->filesystem = $filesystem;
+		$this->phpbb_root_path = $phpbb_root_path;
+		$this->php_ext = $php_ext;
+		$provider->find_routing_files($manager->get_finder());
+		$this->route_collection = $provider->find($phpbb_root_path)->get_routes();
+	}
+
+	/**
+	* Automate setting up the page and creating the response object.
+	*
+	* @param string $template_file The template handle to render
+	* @param string $page_title The title of the page to output
+	* @param int $status_code The status code to be sent to the page header
+	* @param bool $display_online_list Do we display online users list
+	* @param int $item_id Restrict online users to item id
+	* @param string $item Restrict online users to a certain session item, e.g. forum for session_forum_id
+	* @param bool $send_headers Whether headers should be sent by page_header(). Defaults to false for controllers.
+	*
+	* @return Response object containing rendered page
+	*/
+	public function render($template_file, $page_title = '', $status_code = 200, $display_online_list = false, $item_id = 0, $item = 'forum', $send_headers = false)
+	{
+		page_header($page_title, $display_online_list, $item_id, $item, $send_headers);
+
+		$this->template->set_filenames(array(
+			'body'	=> $template_file,
+		));
+
+		page_footer(true, false, false);
+
+		$headers = !empty($this->user->data['is_bot']) ? array('X-PHPBB-IS-BOT' => 'yes') : array();
+
+		return new Response($this->template->assign_display('body'), $status_code, $headers);
+	}
+
+	/**
+	* Generate a URL to a route
+	*
+	* @param string	$route		Name of the route to travel
+	* @param array	$params		String or array of additional url parameters
+	* @param bool	$is_amp		Is url using &amp; (true) or & (false)
+	* @param string|bool		$session_id	Possibility to use a custom session id instead of the global one
+	* @param bool|string		$reference_type The type of reference to be generated (one of the constants)
+	* @return string The URL already passed through append_sid()
+	*/
+	public function route($route, array $params = array(), $is_amp = true, $session_id = false, $reference_type = UrlGeneratorInterface::ABSOLUTE_PATH)
+	{
+		$anchor = '';
+		if (isset($params['#']))
+		{
+			$anchor = '#' . $params['#'];
+			unset($params['#']);
+		}
+
+		$context = new RequestContext();
+		$context->fromRequest($this->symfony_request);
+
+		if ($this->config['force_server_vars'])
+		{
+			$context->setHost($this->config['server_name']);
+			$context->setScheme(substr($this->config['server_protocol'], 0, -3));
+			$context->setHttpPort($this->config['server_port']);
+			$context->setHttpsPort($this->config['server_port']);
+			$context->setBaseUrl(rtrim($this->config['script_path'], '/'));
+		}
+
+		$script_name = $this->symfony_request->getScriptName();
+		$page_name = substr($script_name, -1, 1) == '/' ? '' : utf8_basename($script_name);
+
+		$base_url = $context->getBaseUrl();
+
+		// Append page name if base URL does not contain it
+		if (!empty($page_name) && strpos($base_url, '/' . $page_name) === false)
+		{
+			$base_url .= '/' . $page_name;
+		}
+
+		// If enable_mod_rewrite is false we need to replace the current front-end by app.php, otherwise we need to remove it.
+		$base_url = str_replace('/' . $page_name, empty($this->config['enable_mod_rewrite']) ? '/app.' . $this->php_ext : '', $base_url);
+
+		// We need to update the base url to move to the directory of the app.php file if the current script is not app.php
+		if ($page_name !== 'app.php' && !$this->config['force_server_vars'])
+		{
+			if (empty($this->config['enable_mod_rewrite']))
+			{
+				$base_url = str_replace('/app.' . $this->php_ext, '/' . $this->phpbb_root_path . 'app.' . $this->php_ext, $base_url);
+			}
+			else
+			{
+				$base_url .= preg_replace(get_preg_expression('path_remove_dot_trailing_slash'), '$2', $this->phpbb_root_path);
+			}
+		}
+
+		$base_url = $this->request->escape($this->filesystem->clean_path($base_url), true);
+
+		$context->setBaseUrl($base_url);
+
+		$url_generator = new UrlGenerator($this->route_collection, $context);
+		$route_url = $url_generator->generate($route, $params, $reference_type);
+
+		if ($is_amp)
+		{
+			$route_url = str_replace(array('&amp;', '&'), array('&', '&amp;'), $route_url);
+		}
+
+		if ($reference_type === UrlGeneratorInterface::RELATIVE_PATH && empty($this->config['enable_mod_rewrite']))
+		{
+			$route_url = 'app.' . $this->php_ext . '/' . $route_url;
+		}
+
+		return append_sid($route_url . $anchor, false, $is_amp, $session_id, true);
+	}
+
+	/**
+	* Output an error, effectively the same thing as trigger_error
+	*
+	* @param string $message The error message
+	* @param int $code The error code (e.g. 404, 500, 503, etc.)
+	* @return Response A Response instance
+	*
+	* @deprecated 3.1.3 (To be removed: 3.3.0) Use exceptions instead.
+	*/
+	public function error($message, $code = 500)
+	{
+		return $this->message($message, array(), 'INFORMATION', $code);
+	}
+
+	/**
+	 * Output a message
+	 *
+	 * In case of an error, please throw an exception instead
+	 *
+	 * @param string $message The message to display (must be a language variable)
+	 * @param array $parameters The parameters to use with the language var
+	 * @param string $title Title for the message (must be a language variable)
+	 * @param int $code The HTTP status code (e.g. 404, 500, 503, etc.)
+	 * @return Response A Response instance
+	 */
+	public function message($message, array $parameters = array(), $title = 'INFORMATION', $code = 200)
+	{
+		array_unshift($parameters, $message);
+		$message_text = call_user_func_array(array($this->user, 'lang'), $parameters);
+		$message_title = $this->user->lang($title);
+
+		if ($this->request->is_ajax())
+		{
+			global $refresh_data;
+
+			return new JsonResponse(
+				array(
+					'MESSAGE_TITLE'		=> $message_title,
+					'MESSAGE_TEXT'		=> $message_text,
+					'S_USER_WARNING'	=> false,
+					'S_USER_NOTICE'		=> false,
+					'REFRESH_DATA'		=> (!empty($refresh_data)) ? $refresh_data : null
+				),
+				$code
+			);
+		}
+
+		$this->template->assign_vars(array(
+			'MESSAGE_TEXT'	=> $message_text,
+			'MESSAGE_TITLE'	=> $message_title,
+		));
+
+		return $this->render('message_body.html', $message_title, $code);
+	}
+
+	/**
+	* Return the current url
+	*
+	* @return string
+	*/
+	public function get_current_url()
+	{
+		return generate_board_url(true) . $this->request->escape($this->symfony_request->getRequestUri(), true);
+	}
+}
diff --git a/phpBB/phpbb/controller/provider.php b/phpBB/phpbb/controller/provider.php
new file mode 100644
index 0000000000..7e26848290
--- /dev/null
+++ b/phpBB/phpbb/controller/provider.php
@@ -0,0 +1,92 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @copyright (c) phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+* For full copyright and license information, please see
+* the docs/CREDITS.txt file.
+*
+*/
+
+namespace phpbb\controller;
+
+use Symfony\Component\Routing\RouteCollection;
+use Symfony\Component\Routing\Loader\YamlFileLoader;
+use Symfony\Component\Config\FileLocator;
+
+/**
+* Controller interface
+*/
+class provider
+{
+	/**
+	* YAML file(s) containing route information
+	* @var array
+	*/
+	protected $routing_files;
+
+	/**
+	* Collection of the routes in phpBB and all found extensions
+	* @var RouteCollection
+	*/
+	protected $routes;
+
+	/**
+	* Construct method
+	*
+	* @param array $routing_files Array of strings containing paths
+	*							to YAML files holding route information
+	*/
+	public function __construct($routing_files = array())
+	{
+		$this->routing_files = $routing_files;
+	}
+
+	/**
+	* Find the list of routing files
+	*
+	* @param \phpbb\finder $finder
+	* @return null
+	*/
+	public function find_routing_files(\phpbb\finder $finder)
+	{
+		// We hardcode the path to the core config directory
+		// because the finder cannot find it
+		$this->routing_files = array_merge($this->routing_files, array('config/routing.yml'), array_keys($finder
+				->directory('/config')
+				->suffix('routing.yml')
+				->find()
+		));
+	}
+
+	/**
+	* Find a list of controllers
+	*
+	* @param string $base_path Base path to prepend to file paths
+	* @return provider
+	*/
+	public function find($base_path = '')
+	{
+		$this->routes = new RouteCollection;
+		foreach ($this->routing_files as $file_path)
+		{
+			$loader = new YamlFileLoader(new FileLocator(phpbb_realpath($base_path)));
+			$this->routes->addCollection($loader->load($file_path));
+		}
+
+		return $this;
+	}
+
+	/**
+	* Get the list of routes
+	*
+	* @return RouteCollection Get the route collection
+	*/
+	public function get_routes()
+	{
+		return $this->routes;
+	}
+}
diff --git a/phpBB/phpbb/controller/resolver.php b/phpBB/phpbb/controller/resolver.php
new file mode 100644
index 0000000000..948a6a218c
--- /dev/null
+++ b/phpBB/phpbb/controller/resolver.php
@@ -0,0 +1,175 @@
+<?php
+/**
+*
+* This file is part of the phpBB Forum Software package.
+*
+* @copyright (c) phpBB Limited <https://www.phpbb.com>
+* @license GNU General Public License, version 2 (GPL-2.0)
+*
+* For full copyright and license information, please see
+* the docs/CREDITS.txt file.
+*
+*/
+
+namespace phpbb\controller;
+
+use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+* Controller manager class
+*/
+class resolver implements ControllerResolverInterface
+{
+	/**
+	* User object
+	* @var \phpbb\user
+	*/
+	protected $user;
+
+	/**
+	* ContainerInterface object
+	* @var ContainerInterface
+	*/
+	protected $container;
+
+	/**
+	* phpbb\template\template object
+	* @var \phpbb\template\template
+	*/
+	protected $template;
+
+	/**
+	* Request type cast helper object
+	* @var \phpbb\request\type_cast_helper
+	*/
+	protected $type_cast_helper;
+
+	/**
+	* phpBB root path
+	* @var string
+	*/
+	protected $phpbb_root_path;
+
+	/**
+	* Construct method
+	*
+	* @param \phpbb\user $user User Object
+	* @param ContainerInterface $container ContainerInterface object
+	* @param string $phpbb_root_path Relative path to phpBB root
+	* @param \phpbb\template\template $template
+	*/
+	public function __construct(\phpbb\user $user, ContainerInterface $container, $phpbb_root_path, \phpbb\template\template $template = null)
+	{
+		$this->user = $user;
+		$this->container = $container;
+		$this->template = $template;
+		$this->type_cast_helper = new \phpbb\request\type_cast_helper();
+		$this->phpbb_root_path = $phpbb_root_path;
+	}
+
+	/**
+	* Load a controller callable
+	*
+	* @param \Symfony\Component\HttpFoundation\Request $request Symfony Request object
+	* @return bool|Callable Callable or false
+	* @throws \phpbb\controller\exception
+	*/
+	public function getController(Request $request)
+	{
+		$controller = $request->attributes->get('_controller');
+
+		if (!$controller)
+		{
+			throw new \phpbb\controller\exception($this->user->lang['CONTROLLER_NOT_SPECIFIED']);
+		}
+
+		// Require a method name along with the service name
+		if (stripos($controller, ':') === false)
+		{
+			throw new \phpbb\controller\exception($this->user->lang['CONTROLLER_METHOD_NOT_SPECIFIED']);
+		}
+
+		list($service, $method) = explode(':', $controller);
+
+		if (!$this->container->has($service))
+		{
+			throw new \phpbb\controller\exception($this->user->lang('CONTROLLER_SERVICE_UNDEFINED', $service));
+		}
+
+		$controller_object = $this->container->get($service);
+
+		/*
+		* If this is an extension controller, we'll try to automatically set
+		* the style paths for the extension (the ext author can change them
+		* if necessary).
+		*/
+		$controller_dir = explode('\\', get_class($controller_object));
+
+		// 0 vendor, 1 extension name, ...
+		if (!is_null($this->template) && isset($controller_dir[1]))
+		{
+			$controller_style_dir = 'ext/' . $controller_dir[0] . '/' . $controller_dir[1] . '/styles';
+
+			if (is_dir($this->phpbb_root_path . $controller_style_dir))
+			{
+				$this->template->set_style(array($controller_style_dir, 'styles'));
+			}
+		}
+
+		return array($controller_object, $method);
+	}
+
+	/**
+	* Dependencies should be specified in the service definition and can be
+	* then accessed in __construct(). Arguments are sent through the URL path
+	* and should match the parameters of the method you are using as your
+	* controller.
+	*
+	* @param \Symfony\Component\HttpFoundation\Request $request Symfony Request object
+	* @param mixed $controller A callable (controller class, method)
+	* @return array An array of arguments to pass to the controller
+	* @throws \phpbb\controller\exception
+	*/
+	public function getArguments(Request $request, $controller)
+	{
+		// At this point, $controller contains the object and method name
+		list($object, $method) = $controller;
+		$mirror = new \ReflectionMethod($object, $method);
+
+		$arguments = array();
+		$parameters = $mirror->getParameters();
+		$attributes = $request->attributes->all();
+		foreach ($parameters as $param)
+		{
+			if (array_key_exists($param->name, $attributes))
+			{
+				if (is_string($attributes[$param->name]))
+				{
+					$value = $attributes[$param->name];
+					$this->type_cast_helper->set_var($value, $attributes[$param->name], 'string', true, false);
+					$arguments[] = $value;
+				}
+				else
+				{
+					$arguments[] = $attributes[$param->name];
+				}
+			}
+			else if ($param->getClass() && $param->getClass()->isInstance($request))
+			{
+				$arguments[] = $request;
+			}
+			else if ($param->isDefaultValueAvailable())
+			{
+				$arguments[] = $param->getDefaultValue();
+			}
+			else
+			{
+				throw new \phpbb\controller\exception($this->user->lang('CONTROLLER_ARGUMENT_VALUE_MISSING', $param->getPosition() + 1, get_class($object) . ':' . $method, $param->name));
+			}
+		}
+
+		return $arguments;
+	}
+}