4 files changed, 157 insertions, 151 deletions
diff --git a/phpBB/phpbb/controller/exception.php b/phpBB/phpbb/controller/exception.php
index 06ece8d1d5..e227c7c37b 100644
--- a/phpBB/phpbb/controller/exception.php
+++ b/phpBB/phpbb/controller/exception.php
@@ -1,9 +1,13 @@
 <?php
 /**
 *
-* @package controller
-* @copyright (c) 2012 phpBB Group
-* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+* 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.
 *
 */
 
@@ -11,8 +15,7 @@ namespace phpbb\controller;
 
 /**
 * Controller exception class
-* @package phpBB3
 */
-class exception extends \RuntimeException
+class exception extends \phpbb\exception\runtime_exception
 {
 }
diff --git a/phpBB/phpbb/controller/helper.php b/phpBB/phpbb/controller/helper.php
index 05a05d1e57..e98de0e771 100644
--- a/phpBB/phpbb/controller/helper.php
+++ b/phpBB/phpbb/controller/helper.php
@@ -1,19 +1,24 @@
 <?php
 /**
 *
-* @package controller
-* @copyright (c) 2012 phpBB Group
-* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+* 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\UrlGeneratorInterface;
 
 /**
 * Controller helper class, contains methods that do things for controllers
-* @package phpBB3
 */
 class helper
 {
@@ -35,47 +40,52 @@ class helper
 	*/
 	protected $config;
 
-	/**
-	* phpBB root path
-	* @var string
-	*/
-	protected $phpbb_root_path;
+	/* @var \phpbb\symfony_request */
+	protected $symfony_request;
+
+	/* @var \phpbb\request\request_interface */
+	protected $request;
 
 	/**
-	* PHP extension
-	* @var string
-	*/
-	protected $php_ext;
+	 * @var \phpbb\routing\helper
+	 */
+	protected $routing_helper;
 
 	/**
 	* Constructor
 	*
 	* @param \phpbb\template\template $template Template object
-    * @param \phpbb\user $user User object
-    * @param \phpbb\config\config $config Config object
-	* @param string $phpbb_root_path phpBB root path
-	* @param string $php_ext PHP extension
+	* @param \phpbb\user $user User object
+	* @param \phpbb\config\config $config Config object
+	* @param \phpbb\symfony_request $symfony_request Symfony Request object
+	* @param \phpbb\request\request_interface $request phpBB request object
+	* @param \phpbb\routing\helper $routing_helper Helper to generate the routes
 	*/
-	public function __construct(\phpbb\template\template $template, \phpbb\user $user, \phpbb\config\config $config, $phpbb_root_path, $php_ext)
+	public function __construct(\phpbb\template\template $template, \phpbb\user $user, \phpbb\config\config $config, \phpbb\symfony_request $symfony_request, \phpbb\request\request_interface $request, \phpbb\routing\helper $routing_helper)
 	{
 		$this->template = $template;
 		$this->user = $user;
 		$this->config = $config;
-		$this->phpbb_root_path = $phpbb_root_path;
-		$this->php_ext = $php_ext;
+		$this->symfony_request = $symfony_request;
+		$this->request = $request;
+		$this->routing_helper = $routing_helper;
 	}
 
 	/**
 	* Automate setting up the page and creating the response object.
 	*
-	* @param string $handle The template handle to render
+	* @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
+	*
 	* @return Response object containing rendered page
 	*/
-	public function render($template_file, $page_title = '', $status_code = 200)
+	public function render($template_file, $page_title = '', $status_code = 200, $display_online_list = false, $item_id = 0, $item = 'forum')
 	{
-		page_header($page_title);
+		page_header($page_title, $display_online_list, $item_id, $item);
 
 		$this->template->set_filenames(array(
 			'body'	=> $template_file,
@@ -87,47 +97,96 @@ class helper
 	}
 
 	/**
-	* Generate a URL
+	* Generate a URL to a route
 	*
-	* @param string	$route		The route to travel
-	* @param mixed	$params		String or array of additional url parameters
+	* @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	$session_id	Possibility to use a custom session id instead of the global one
+	* @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 url($route, $params = false, $is_amp = true, $session_id = false)
+	public function route($route, array $params = array(), $is_amp = true, $session_id = false, $reference_type = UrlGeneratorInterface::ABSOLUTE_PATH)
 	{
-		$route_params = '';
-		if (($route_delim = strpos($route, '?')) !== false)
-		{
-			$route_params = substr($route, $route_delim);
-			$route = substr($route, 0, $route_delim);
-		}
-
-		// If enable_mod_rewrite is false, we need to include app.php
-		$route_prefix = $this->phpbb_root_path;
-		if (empty($this->config['enable_mod_rewrite']))
-		{
-			$route_prefix .= 'app.' . $this->php_ext . '/';
-		}
-
-		return append_sid($route_prefix . "$route" . $route_params, $params, $is_amp, $session_id);
+		return $this->routing_helper->route($route, $params, $is_amp, $session_id, $reference_type);
 	}
 
 	/**
 	* Output an error, effectively the same thing as trigger_error
 	*
 	* @param string $message The error message
-	* @param string $code The error code (e.g. 404, 500, 503, etc.)
-	* @return Response A Reponse instance
+	* @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,
-			'MESSAGE_TITLE'	=> $this->user->lang('INFORMATION'),
+			'MESSAGE_TEXT'	=> $message_text,
+			'MESSAGE_TITLE'	=> $message_title,
 		));
 
-		return $this->render('message_body.html', $this->user->lang('INFORMATION'), $code);
+		return $this->render('message_body.html', $message_title, $code);
+	}
+
+	/**
+	 * Assigns automatic refresh time meta tag in template
+	 *
+	 * @param	int		$time	time in seconds, when redirection should occur
+	 * @param	string	$url	the URL where the user should be redirected
+	 * @return	null
+	 */
+	public function assign_meta_refresh_var($time, $url)
+	{
+		$this->template->assign_vars(array(
+			'META' => '<meta http-equiv="refresh" content="' . $time . '; url=' . $url . '" />',
+		));
+	}
+
+	/**
+	* 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
deleted file mode 100644
index fde51696e8..0000000000
--- a/phpBB/phpbb/controller/provider.php
+++ /dev/null
@@ -1,75 +0,0 @@
-<?php
-/**
-*
-* @package controller
-* @copyright (c) 2012 phpBB Group
-* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
-*
-*/
-
-namespace phpbb\controller;
-
-use Symfony\Component\Routing\RouteCollection;
-use Symfony\Component\Routing\Loader\YamlFileLoader;
-use Symfony\Component\Config\FileLocator;
-
-/**
-* Controller interface
-* @package phpBB3
-*/
-class provider
-{
-	/**
-	* YAML file(s) containing route information
-	* @var array
-	*/
-	protected $routing_files;
-
-	/**
-	* 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;
-	}
-
-	/**
-	* Locate paths containing routing files
-	* This sets an internal property but does not return the paths.
-	*
-	* @return The current instance of this object for method chaining
-	*/
-	public function import_paths_from_finder(\phpbb\extension\finder $finder)
-	{
-		// We hardcode the path to the core config directory
-		// because the finder cannot find it
-		$this->routing_files = array_merge(array('config/routing.yml'), array_keys($finder
-			->directory('config')
-			->suffix('routing.yml')
-			->find()
-		));
-
-		return $this;
-	}
-
-	/**
-	* Get a list of controllers and return it
-	*
-	* @param string $base_path Base path to prepend to file paths
-	* @return array Array of controllers and their route information
-	*/
-	public function find($base_path = '')
-	{
-		$routes = new RouteCollection;
-		foreach ($this->routing_files as $file_path)
-		{
-			$loader = new YamlFileLoader(new FileLocator($base_path));
-			$routes->addCollection($loader->load($file_path));
-		}
-
-		return $routes;
-	}
-}
diff --git a/phpBB/phpbb/controller/resolver.php b/phpBB/phpbb/controller/resolver.php
index 233179e343..4f432c3323 100644
--- a/phpBB/phpbb/controller/resolver.php
+++ b/phpBB/phpbb/controller/resolver.php
@@ -1,9 +1,13 @@
 <?php
 /**
 *
-* @package controller
-* @copyright (c) 2012 phpBB Group
-* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+* 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.
 *
 */
 
@@ -15,17 +19,10 @@ use Symfony\Component\HttpFoundation\Request;
 
 /**
 * Controller manager class
-* @package phpBB3
 */
 class resolver implements ControllerResolverInterface
 {
 	/**
-	* User object
-	* @var \phpbb\user
-	*/
-	protected $user;
-
-	/**
 	* ContainerInterface object
 	* @var ContainerInterface
 	*/
@@ -33,28 +30,41 @@ class resolver implements ControllerResolverInterface
 
 	/**
 	* phpbb\template\template object
-	* @var phpbb\template\template
+	* @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\template\template $template = null)
+	public function __construct(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
+	* @param \Symfony\Component\HttpFoundation\Request $request Symfony Request object
 	* @return bool|Callable Callable or false
 	* @throws \phpbb\controller\exception
 	*/
@@ -64,20 +74,20 @@ class resolver implements ControllerResolverInterface
 
 		if (!$controller)
 		{
-			throw new \phpbb\controller\exception($this->user->lang['CONTROLLER_NOT_SPECIFIED']);
+			throw new \phpbb\controller\exception('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']);
+			throw new \phpbb\controller\exception('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));
+			throw new \phpbb\controller\exception('CONTROLLER_SERVICE_UNDEFINED', array($service));
 		}
 
 		$controller_object = $this->container->get($service);
@@ -94,7 +104,7 @@ class resolver implements ControllerResolverInterface
 		{
 			$controller_style_dir = 'ext/' . $controller_dir[0] . '/' . $controller_dir[1] . '/styles';
 
-			if (is_dir($controller_style_dir))
+			if (is_dir($this->phpbb_root_path . $controller_style_dir))
 			{
 				$this->template->set_style(array($controller_style_dir, 'styles'));
 			}
@@ -109,9 +119,9 @@ class resolver implements ControllerResolverInterface
 	* and should match the parameters of the method you are using as your
 	* controller.
 	*
-	* @param Symfony\Component\HttpFoundation\Request $request Symfony Request object
+	* @param \Symfony\Component\HttpFoundation\Request $request Symfony Request object
 	* @param mixed $controller A callable (controller class, method)
-	* @return bool False
+	* @return array An array of arguments to pass to the controller
 	* @throws \phpbb\controller\exception
 	*/
 	public function getArguments(Request $request, $controller)
@@ -127,7 +137,16 @@ class resolver implements ControllerResolverInterface
 		{
 			if (array_key_exists($param->name, $attributes))
 			{
-				$arguments[] = $attributes[$param->name];
+				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))
 			{
@@ -139,7 +158,7 @@ class resolver implements ControllerResolverInterface
 			}
 			else
 			{
-				throw new \phpbb\controller\exception($this->user->lang('CONTROLLER_ARGUMENT_VALUE_MISSING', $param->getPosition() + 1, get_class($object) . ':' . $method, $param->name));
+				throw new \phpbb\controller\exception('CONTROLLER_ARGUMENT_VALUE_MISSING', array($param->getPosition() + 1, get_class($object) . ':' . $method, $param->name));
 			}
 		}