From 06158693c7b846518abfe9d72491fc7376e457f3 Mon Sep 17 00:00:00 2001
From: David King <imkingdavid@gmail.com>
Date: Fri, 19 Oct 2012 19:54:19 -0400
Subject: [feature/controller] Implement a front controller

PHPBB3-10864
---
 phpBB/includes/controller/helper.php           | 142 +++++++++++++++++++++++++
 phpBB/includes/controller/provider.php         |  94 ++++++++++++++++
 phpBB/includes/controller/resolver.php         | 123 +++++++++++++++++++++
 phpBB/includes/controller/route_collection.php |  36 +++++++
 4 files changed, 395 insertions(+)
 create mode 100644 phpBB/includes/controller/helper.php
 create mode 100644 phpBB/includes/controller/provider.php
 create mode 100644 phpBB/includes/controller/resolver.php
 create mode 100644 phpBB/includes/controller/route_collection.php

(limited to 'phpBB/includes/controller')

diff --git a/phpBB/includes/controller/helper.php b/phpBB/includes/controller/helper.php
new file mode 100644
index 0000000000..1998ea6733
--- /dev/null
+++ b/phpBB/includes/controller/helper.php
@@ -0,0 +1,142 @@
+<?php
+/**
+*
+* @package controller
+* @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;
+}
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+* Controller helper class, contains methods that do things for controllers
+* @package phpBB3
+*/
+class phpbb_controller_helper
+{
+	/**
+	* Container
+	* @var ContainerBuilder
+	*/
+	protected $container;
+
+	/**
+	* Template object
+	* @var phpbb_template
+	*/
+	protected $template;
+
+	/**
+	* phpBB Root Path
+	* @var string
+	*/
+	protected $phpbb_root_path;
+
+	/**
+	* PHP Extension
+	* @var string
+	*/
+	protected $php_ext;
+
+	/**
+	* Base URL
+	* @var array
+	*/
+	protected $url_base;
+
+	/**
+	* Constructor
+	*
+	* @param ContainerBuilder $container DI Container
+	*/
+	public function __construct(ContainerBuilder $container)
+	{
+		$this->container = $container;
+
+		$this->template = $this->container->get('template');
+		$this->phpbb_root_path = $this->container->getParameter('core.root_path');
+		$this->php_ext = $this->container->getParameter('core.php_ext');
+	}
+
+	/**
+	* Automate setting up the page and creating the response object.
+	*
+	* @param string $handle 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
+	* @return Response object containing rendered page
+	*/
+	public function render($template_file, $page_title = '', $status_code = 200)
+	{
+		if (!function_exists('page_header'))
+		{
+			include("{$this->phpbb_root_path}includes/functions.{$this->php_ext}");
+		}
+
+		page_header($page_title);
+
+		$this->template->set_filenames(array(
+			'body'	=> $template_file,
+		));
+
+		page_footer(true, false, false);
+
+		return new Response($this->template->return_display('body'), $status_code);
+	}
+
+	/**
+	* Easily generate a URL
+	*
+	* @param array $url_parts Each array element is a 'folder'
+	* 		i.e. array('my', 'ext') maps to ./app.php/my/ext
+	* @param mixed $query The Query string, passed directly into the second
+	*		argument of append_sid()
+	* @return string A URL that has already been run through append_sid()
+	*/
+	public function url(array $url_parts, $query = '')
+	{
+		return append_sid($this->phpbb_root_path . $this->url_base . implode('/', $url_parts), $query);
+	}
+
+	/**
+	* Set base to prepend to urls generated by url()
+	* This allows extensions to have a certain 'directory' under which
+	* all their pages are served, but not have to type it every time
+	*
+	* @param array $url_parts Each array element is a 'folder'
+	*		i.e. array('my', 'ext') maps to ./app.php/my/ext
+	* @return null
+	*/
+	public function set_url_base(array $url_parts)
+	{
+		$this->url_base = !empty($url_parts) ? implode('/', $url_parts) . '/' : '';
+	}
+
+	/**
+	* Output an error, effectively the same thing as trigger_error
+	*
+	* @param string $code The error code (e.g. 404, 500, 503, etc.)
+	* @param string $message The error message
+	* @return Response A Reponse instance
+	*/
+	public function error($code = 500, $message = '')
+	{
+		$this->template->assign_vars(array(
+			'MESSAGE_TEXT'	=> $message,
+			'MESSAGE_TITLE'	=> $this->container->get('user')->lang('INFORMATION'),
+		));
+
+		return $this->render('message_body.html', $this->container->get('user')->lang('INFORMATION'), $code);
+	}
+}
diff --git a/phpBB/includes/controller/provider.php b/phpBB/includes/controller/provider.php
new file mode 100644
index 0000000000..25deedb5d1
--- /dev/null
+++ b/phpBB/includes/controller/provider.php
@@ -0,0 +1,94 @@
+<?php
+/**
+*
+* @package controller
+* @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;
+}
+
+use Symfony\Component\Routing\RouteCollection;
+use Symfony\Component\Routing\Loader\YamlFileLoader;
+use Symfony\Component\Config\FileLocator;
+
+/**
+* Controller interface
+* @package phpBB3
+*/
+class phpbb_controller_provider
+{
+	/**
+	* YAML file(s) containing route information
+	* @var array
+	*/
+	protected $routing_paths;
+
+	/**
+	* Construct method
+	*
+	* @param array() $routing_paths Array of strings containing paths
+	*							to YAML files holding route information
+	*/
+	public function __construct($routing_paths = array())
+	{
+		$this->set_paths($routing_paths);
+	}
+
+	/**
+	* 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 get_paths(phpbb_extension_finder $finder)
+	{
+		// We hardcode the path to the core config directory
+		// because the finder cannot find it
+		$this->set_paths(array_merge(array('config'), array_map('dirname', array_keys($finder
+			->directory('config')
+			->prefix('routing')
+			->suffix('yml')
+			->find()
+		))));
+
+		return $this;
+	}
+
+	/**
+	* Set the $routing_paths property with a given list of paths
+	*
+	* @return The current instance of this object for method chaining
+	*/
+	public function set_paths(array $paths)
+	{
+		$this->routing_paths = $paths;
+
+		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_paths as $path)
+		{
+			$loader = new YamlFileLoader(new FileLocator($base_path . $path));
+			$routes->addCollection($loader->load('routing.yml'));
+		}
+
+		return $routes;
+	}
+}
diff --git a/phpBB/includes/controller/resolver.php b/phpBB/includes/controller/resolver.php
new file mode 100644
index 0000000000..bf9ce3330d
--- /dev/null
+++ b/phpBB/includes/controller/resolver.php
@@ -0,0 +1,123 @@
+<?php
+/**
+*
+* @package controller
+* @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;
+}
+
+use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+* Controller manager class
+* @package phpBB3
+*/
+class phpbb_controller_resolver implements ControllerResolverInterface
+{
+	/**
+	* User object
+	* @var phpbb_user
+	*/
+	protected $user;
+
+	/**
+	* ContainerInterface object
+	* @var ContainerInterface
+	*/
+	protected $container;
+
+	/**
+	* Construct method
+	*
+	* @param phpbb_user $user User Object
+	* @param ContainerInterface $container ContainerInterface object
+	*/
+	public function __construct(phpbb_user $user, ContainerInterface $container)
+	{
+		$this->user = $user;
+		$this->container = $container;
+	}
+
+	/**
+	* Load a controller callable
+	*
+	* @param Symfony\Component\HttpFoundation\Request $request Symfony Request object
+	* @return bool|Callable Callable or false
+	* @throws RuntimeException
+	*/
+	public function getController(Request $request)
+	{
+		$controller = $request->attributes->get('_controller');
+
+		if (!$controller)
+		{
+			throw new RuntimeException($this->user->lang['CONTROLLER_NOT_SPECIFIED']);
+		}
+
+		// Require a method name along with the service name
+		if (stripos($controller, ':') === false)
+		{
+			throw new RuntimeException($this->user->lang['CONTROLLER_METHOD_NOT_SPECIFIED']);
+		}
+
+		list($service, $method) = explode(':', $controller);
+
+		if (!$this->container->has($service))
+		{
+			throw new RuntimeException($this->user->lang('CONTROLLER_SERVICE_UNDEFINED', $service));
+		}
+
+		$controller_object = $this->container->get($service);
+
+		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 string $controller Controller class name
+	* @return bool False
+	*/
+	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))
+			{
+				$arguments[] = $attributes[$param->name];
+			}
+			else if ($param->isDefaultValueAvailable())
+			{
+				$arguments[] = $param->getDefaultValue();
+			}
+			else
+			{
+				throw new RuntimeException($user->lang('CONTROLLER_ARGUMENT_VALUE_MISSING', $param->getPosition() + 1, get_class($object) . ':' . $method, $param->name));
+			}
+		}
+
+		return $arguments;
+	}
+}
diff --git a/phpBB/includes/controller/route_collection.php b/phpBB/includes/controller/route_collection.php
new file mode 100644
index 0000000000..e6c7d3b543
--- /dev/null
+++ b/phpBB/includes/controller/route_collection.php
@@ -0,0 +1,36 @@
+<?php
+/**
+*
+* @package controller
+* @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;
+}
+
+use Symfony\Component\Routing\RouteCollection;
+
+/**
+* Controller manager class
+* @package phpBB3
+*/
+class phpbb_controller_route_collection extends RouteCollection
+{
+	/**
+	* Construct method
+	*
+	* @param phpbb_extension_finder $finder Finder object
+	*/
+	public function __construct(phpbb_extension_finder $finder, phpbb_controller_provider $provider)
+	{
+		parent::__construct();
+		$this->addCollection($provider->get_paths($finder)->find());
+	}
+}
-- 
cgit v1.2.1


From 4e1f17a87dc6fefa30becc594a7f41e7f6293cad Mon Sep 17 00:00:00 2001
From: David King <imkingdavid@gmail.com>
Date: Sun, 11 Nov 2012 14:17:31 -0500
Subject: [feature/controller] includes/functions.php is included by default

PHPBB3-10864
---
 phpBB/includes/controller/helper.php | 5 -----
 1 file changed, 5 deletions(-)

(limited to 'phpBB/includes/controller')

diff --git a/phpBB/includes/controller/helper.php b/phpBB/includes/controller/helper.php
index 1998ea6733..f3127fd1fc 100644
--- a/phpBB/includes/controller/helper.php
+++ b/phpBB/includes/controller/helper.php
@@ -79,11 +79,6 @@ class phpbb_controller_helper
 	*/
 	public function render($template_file, $page_title = '', $status_code = 200)
 	{
-		if (!function_exists('page_header'))
-		{
-			include("{$this->phpbb_root_path}includes/functions.{$this->php_ext}");
-		}
-
 		page_header($page_title);
 
 		$this->template->set_filenames(array(
-- 
cgit v1.2.1


From 7687f069611b35f81c6d0fc87e46b9bb0821d616 Mon Sep 17 00:00:00 2001
From: David King <imkingdavid@gmail.com>
Date: Tue, 13 Nov 2012 09:26:31 -0500
Subject: [feature/controller] Inject dependencies instead of container

PHPBB3-10864
---
 phpBB/includes/controller/helper.php | 42 ++++++++++++++++++------------------
 1 file changed, 21 insertions(+), 21 deletions(-)

(limited to 'phpBB/includes/controller')

diff --git a/phpBB/includes/controller/helper.php b/phpBB/includes/controller/helper.php
index f3127fd1fc..0fc3ba0c67 100644
--- a/phpBB/includes/controller/helper.php
+++ b/phpBB/includes/controller/helper.php
@@ -15,9 +15,7 @@ if (!defined('IN_PHPBB'))
 	exit;
 }
 
-use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\DependencyInjection\ContainerBuilder;
 
 /**
 * Controller helper class, contains methods that do things for controllers
@@ -25,12 +23,6 @@ use Symfony\Component\DependencyInjection\ContainerBuilder;
 */
 class phpbb_controller_helper
 {
-	/**
-	* Container
-	* @var ContainerBuilder
-	*/
-	protected $container;
-
 	/**
 	* Template object
 	* @var phpbb_template
@@ -38,13 +30,19 @@ class phpbb_controller_helper
 	protected $template;
 
 	/**
-	* phpBB Root Path
+	* User object
+	* @var phpbb_user
+	*/
+	protected $user;
+
+	/**
+	* phpBB root path
 	* @var string
 	*/
-	protected $phpbb_root_path;
+	protected $root_path;
 
 	/**
-	* PHP Extension
+	* PHP extension
 	* @var string
 	*/
 	protected $php_ext;
@@ -58,15 +56,17 @@ class phpbb_controller_helper
 	/**
 	* Constructor
 	*
-	* @param ContainerBuilder $container DI Container
+	* @param phpbb_template $template Template object
+	* @param phpbb_user $user User object
+	* @param string $root_path phpBB root path
+	* @param string $php_ext PHP extension
 	*/
-	public function __construct(ContainerBuilder $container)
+	public function __construct(phpbb_template $template, phpbb_user $user, $root_path, $php_ext)
 	{
-		$this->container = $container;
-
-		$this->template = $this->container->get('template');
-		$this->phpbb_root_path = $this->container->getParameter('core.root_path');
-		$this->php_ext = $this->container->getParameter('core.php_ext');
+		$this->template = $template;
+		$this->user = $user;
+		$this->root_path = $root_path;
+		$this->php_ext = $php_ext;
 	}
 
 	/**
@@ -101,7 +101,7 @@ class phpbb_controller_helper
 	*/
 	public function url(array $url_parts, $query = '')
 	{
-		return append_sid($this->phpbb_root_path . $this->url_base . implode('/', $url_parts), $query);
+		return append_sid($this->root_path . $this->url_base . implode('/', $url_parts), $query);
 	}
 
 	/**
@@ -129,9 +129,9 @@ class phpbb_controller_helper
 	{
 		$this->template->assign_vars(array(
 			'MESSAGE_TEXT'	=> $message,
-			'MESSAGE_TITLE'	=> $this->container->get('user')->lang('INFORMATION'),
+			'MESSAGE_TITLE'	=> $this->user->lang('INFORMATION'),
 		));
 
-		return $this->render('message_body.html', $this->container->get('user')->lang('INFORMATION'), $code);
+		return $this->render('message_body.html', $this->user->lang('INFORMATION'), $code);
 	}
 }
-- 
cgit v1.2.1


From 2e594504596eaf6ab758240a1cd012dfea79fe77 Mon Sep 17 00:00:00 2001
From: David King <imkingdavid@gmail.com>
Date: Tue, 13 Nov 2012 10:42:20 -0500
Subject: [feature/controller] Use assign_display() instead of return_display()

The latter was deemed unnecessary at the moment.

PHPBB3-10864
---
 phpBB/includes/controller/helper.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'phpBB/includes/controller')

diff --git a/phpBB/includes/controller/helper.php b/phpBB/includes/controller/helper.php
index 0fc3ba0c67..8bb4427382 100644
--- a/phpBB/includes/controller/helper.php
+++ b/phpBB/includes/controller/helper.php
@@ -87,7 +87,7 @@ class phpbb_controller_helper
 
 		page_footer(true, false, false);
 
-		return new Response($this->template->return_display('body'), $status_code);
+		return new Response($this->template->assign_display('body'), $status_code);
 	}
 
 	/**
-- 
cgit v1.2.1


From d3aa8823b21990634f8b74676ac301739ddfc58b Mon Sep 17 00:00:00 2001
From: David King <imkingdavid@gmail.com>
Date: Wed, 14 Nov 2012 15:42:13 -0500
Subject: [feature/controller] Use a dumped url matcher class to improve
 performance

PHPBB3-10864
---
 phpBB/includes/controller/route_collection.php | 36 --------------------------
 1 file changed, 36 deletions(-)
 delete mode 100644 phpBB/includes/controller/route_collection.php

(limited to 'phpBB/includes/controller')

diff --git a/phpBB/includes/controller/route_collection.php b/phpBB/includes/controller/route_collection.php
deleted file mode 100644
index e6c7d3b543..0000000000
--- a/phpBB/includes/controller/route_collection.php
+++ /dev/null
@@ -1,36 +0,0 @@
-<?php
-/**
-*
-* @package controller
-* @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;
-}
-
-use Symfony\Component\Routing\RouteCollection;
-
-/**
-* Controller manager class
-* @package phpBB3
-*/
-class phpbb_controller_route_collection extends RouteCollection
-{
-	/**
-	* Construct method
-	*
-	* @param phpbb_extension_finder $finder Finder object
-	*/
-	public function __construct(phpbb_extension_finder $finder, phpbb_controller_provider $provider)
-	{
-		parent::__construct();
-		$this->addCollection($provider->get_paths($finder)->find());
-	}
-}
-- 
cgit v1.2.1


From b4eff4f06acce78536a392b733f2438f4d1d1c52 Mon Sep 17 00:00:00 2001
From: David King <imkingdavid@gmail.com>
Date: Thu, 15 Nov 2012 13:54:41 -0500
Subject: [feature/controller] Remove URL Base from helper class

I had forgotten that the container sends the same instance of objects to all
services that request it, so in this case all controllers would share the same
base url path, which is not desired.

PHPBB3-10864
---
 phpBB/includes/controller/helper.php | 22 +---------------------
 1 file changed, 1 insertion(+), 21 deletions(-)

(limited to 'phpBB/includes/controller')

diff --git a/phpBB/includes/controller/helper.php b/phpBB/includes/controller/helper.php
index 8bb4427382..6b697c7e46 100644
--- a/phpBB/includes/controller/helper.php
+++ b/phpBB/includes/controller/helper.php
@@ -47,12 +47,6 @@ class phpbb_controller_helper
 	*/
 	protected $php_ext;
 
-	/**
-	* Base URL
-	* @var array
-	*/
-	protected $url_base;
-
 	/**
 	* Constructor
 	*
@@ -101,21 +95,7 @@ class phpbb_controller_helper
 	*/
 	public function url(array $url_parts, $query = '')
 	{
-		return append_sid($this->root_path . $this->url_base . implode('/', $url_parts), $query);
-	}
-
-	/**
-	* Set base to prepend to urls generated by url()
-	* This allows extensions to have a certain 'directory' under which
-	* all their pages are served, but not have to type it every time
-	*
-	* @param array $url_parts Each array element is a 'folder'
-	*		i.e. array('my', 'ext') maps to ./app.php/my/ext
-	* @return null
-	*/
-	public function set_url_base(array $url_parts)
-	{
-		$this->url_base = !empty($url_parts) ? implode('/', $url_parts) . '/' : '';
+		return append_sid($this->root_path . implode('/', $url_parts), $query);
 	}
 
 	/**
-- 
cgit v1.2.1


From db1d49d559a337f7266a9e9f0cfaf3eb025b0ed1 Mon Sep 17 00:00:00 2001
From: David King <imkingdavid@gmail.com>
Date: Thu, 15 Nov 2012 13:59:30 -0500
Subject: [feature/controller] Rename get_paths to import_paths_from_finder

Also removed unused variable from url_matcher function

PHPBB3-10864
---
 phpBB/includes/controller/provider.php | 20 ++++----------------
 1 file changed, 4 insertions(+), 16 deletions(-)

(limited to 'phpBB/includes/controller')

diff --git a/phpBB/includes/controller/provider.php b/phpBB/includes/controller/provider.php
index 25deedb5d1..b2a5b9f6b2 100644
--- a/phpBB/includes/controller/provider.php
+++ b/phpBB/includes/controller/provider.php
@@ -39,7 +39,7 @@ class phpbb_controller_provider
 	*/
 	public function __construct($routing_paths = array())
 	{
-		$this->set_paths($routing_paths);
+		$this->routing_paths = $routing_paths;
 	}
 
 	/**
@@ -48,28 +48,16 @@ class phpbb_controller_provider
 	*
 	* @return The current instance of this object for method chaining
 	*/
-	public function get_paths(phpbb_extension_finder $finder)
+	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->set_paths(array_merge(array('config'), array_map('dirname', array_keys($finder
+		$this->routing_paths = array_merge(array('config'), array_map('dirname', array_keys($finder
 			->directory('config')
 			->prefix('routing')
 			->suffix('yml')
 			->find()
-		))));
-
-		return $this;
-	}
-
-	/**
-	* Set the $routing_paths property with a given list of paths
-	*
-	* @return The current instance of this object for method chaining
-	*/
-	public function set_paths(array $paths)
-	{
-		$this->routing_paths = $paths;
+		)));
 
 		return $this;
 	}
-- 
cgit v1.2.1


From 14f44c17ad76878ed540cd5dd56a3a62b30dbd15 Mon Sep 17 00:00:00 2001
From: David King <imkingdavid@gmail.com>
Date: Thu, 15 Nov 2012 16:14:11 -0500
Subject: [feature/controller] phpbb_controller_exception instead of
 RuntimeException

PHPBB3-10864
---
 phpBB/includes/controller/exception.php | 24 ++++++++++++++++++++++++
 phpBB/includes/controller/resolver.php  | 11 ++++++-----
 2 files changed, 30 insertions(+), 5 deletions(-)
 create mode 100644 phpBB/includes/controller/exception.php

(limited to 'phpBB/includes/controller')

diff --git a/phpBB/includes/controller/exception.php b/phpBB/includes/controller/exception.php
new file mode 100644
index 0000000000..da2fefc600
--- /dev/null
+++ b/phpBB/includes/controller/exception.php
@@ -0,0 +1,24 @@
+<?php
+/**
+*
+* @package controller
+* @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;
+}
+
+/**
+* Controller exception class
+* @package phpBB3
+*/
+class phpbb_controller_provider extends RuntimeException
+{
+}
diff --git a/phpBB/includes/controller/resolver.php b/phpBB/includes/controller/resolver.php
index bf9ce3330d..0e724ec608 100644
--- a/phpBB/includes/controller/resolver.php
+++ b/phpBB/includes/controller/resolver.php
@@ -54,7 +54,7 @@ class phpbb_controller_resolver implements ControllerResolverInterface
 	*
 	* @param Symfony\Component\HttpFoundation\Request $request Symfony Request object
 	* @return bool|Callable Callable or false
-	* @throws RuntimeException
+	* @throws phpbb_controller_exception
 	*/
 	public function getController(Request $request)
 	{
@@ -62,20 +62,20 @@ class phpbb_controller_resolver implements ControllerResolverInterface
 
 		if (!$controller)
 		{
-			throw new RuntimeException($this->user->lang['CONTROLLER_NOT_SPECIFIED']);
+			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 RuntimeException($this->user->lang['CONTROLLER_METHOD_NOT_SPECIFIED']);
+			throw new phpbb_controller_exception($this->user->lang['CONTROLLER_METHOD_NOT_SPECIFIED']);
 		}
 
 		list($service, $method) = explode(':', $controller);
 
 		if (!$this->container->has($service))
 		{
-			throw new RuntimeException($this->user->lang('CONTROLLER_SERVICE_UNDEFINED', $service));
+			throw new phpbb_controller_exception($this->user->lang('CONTROLLER_SERVICE_UNDEFINED', $service));
 		}
 
 		$controller_object = $this->container->get($service);
@@ -92,6 +92,7 @@ class phpbb_controller_resolver implements ControllerResolverInterface
 	* @param Symfony\Component\HttpFoundation\Request $request Symfony Request object
 	* @param string $controller Controller class name
 	* @return bool False
+	* @throws phpbb_controller_exception
 	*/
 	public function getArguments(Request $request, $controller)
 	{
@@ -114,7 +115,7 @@ class phpbb_controller_resolver implements ControllerResolverInterface
 			}
 			else
 			{
-				throw new RuntimeException($user->lang('CONTROLLER_ARGUMENT_VALUE_MISSING', $param->getPosition() + 1, get_class($object) . ':' . $method, $param->name));
+				throw new phpbb_controller_exception($user->lang('CONTROLLER_ARGUMENT_VALUE_MISSING', $param->getPosition() + 1, get_class($object) . ':' . $method, $param->name));
 			}
 		}
 
-- 
cgit v1.2.1


From 74bc46049303952e5f16f61e9f63fa2eeaffbadc Mon Sep 17 00:00:00 2001
From: David King <imkingdavid@gmail.com>
Date: Fri, 16 Nov 2012 09:43:08 -0500
Subject: [feature/controller] Rename improperly named controller exception
 class

PHPBB3-10864
---
 phpBB/includes/controller/exception.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'phpBB/includes/controller')

diff --git a/phpBB/includes/controller/exception.php b/phpBB/includes/controller/exception.php
index da2fefc600..faa8b6b584 100644
--- a/phpBB/includes/controller/exception.php
+++ b/phpBB/includes/controller/exception.php
@@ -19,6 +19,6 @@ if (!defined('IN_PHPBB'))
 * Controller exception class
 * @package phpBB3
 */
-class phpbb_controller_provider extends RuntimeException
+class phpbb_controller_exception extends RuntimeException
 {
 }
-- 
cgit v1.2.1


From 120267e58030eb4b7184e0d54166dfc8d905c3f7 Mon Sep 17 00:00:00 2001
From: David King <imkingdavid@gmail.com>
Date: Fri, 16 Nov 2012 10:27:55 -0500
Subject: [feature/controller] Correctly access user object

PHPBB3-10864
---
 phpBB/includes/controller/resolver.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'phpBB/includes/controller')

diff --git a/phpBB/includes/controller/resolver.php b/phpBB/includes/controller/resolver.php
index 0e724ec608..5674a65118 100644
--- a/phpBB/includes/controller/resolver.php
+++ b/phpBB/includes/controller/resolver.php
@@ -115,7 +115,7 @@ class phpbb_controller_resolver implements ControllerResolverInterface
 			}
 			else
 			{
-				throw new phpbb_controller_exception($user->lang('CONTROLLER_ARGUMENT_VALUE_MISSING', $param->getPosition() + 1, get_class($object) . ':' . $method, $param->name));
+				throw new phpbb_controller_exception($this->user->lang('CONTROLLER_ARGUMENT_VALUE_MISSING', $param->getPosition() + 1, get_class($object) . ':' . $method, $param->name));
 			}
 		}
 
-- 
cgit v1.2.1


From c2f352ab3550dd5eed1aa425b720bd0cdf8d6859 Mon Sep 17 00:00:00 2001
From: David King <imkingdavid@gmail.com>
Date: Fri, 16 Nov 2012 10:35:55 -0500
Subject: [feature/controller] Fix param block for controller callable

PHPBB3-10864
---
 phpBB/includes/controller/resolver.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'phpBB/includes/controller')

diff --git a/phpBB/includes/controller/resolver.php b/phpBB/includes/controller/resolver.php
index 5674a65118..901aa7eaa0 100644
--- a/phpBB/includes/controller/resolver.php
+++ b/phpBB/includes/controller/resolver.php
@@ -90,7 +90,7 @@ class phpbb_controller_resolver implements ControllerResolverInterface
 	* controller.
 	*
 	* @param Symfony\Component\HttpFoundation\Request $request Symfony Request object
-	* @param string $controller Controller class name
+	* @param mixed $controller A callable (controller class, method)
 	* @return bool False
 	* @throws phpbb_controller_exception
 	*/
-- 
cgit v1.2.1


From d41b1146e8947919ed9bdd41e6a30ad15e91d262 Mon Sep 17 00:00:00 2001
From: David King <imkingdavid@gmail.com>
Date: Fri, 16 Nov 2012 10:37:07 -0500
Subject: [feature/controller] Rename $root_path class property to
 $phpbb_root_path

PHPBB3-10864
---
 phpBB/includes/controller/helper.php | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

(limited to 'phpBB/includes/controller')

diff --git a/phpBB/includes/controller/helper.php b/phpBB/includes/controller/helper.php
index 6b697c7e46..6dc3ec4626 100644
--- a/phpBB/includes/controller/helper.php
+++ b/phpBB/includes/controller/helper.php
@@ -39,7 +39,7 @@ class phpbb_controller_helper
 	* phpBB root path
 	* @var string
 	*/
-	protected $root_path;
+	protected $phpbb_root_path;
 
 	/**
 	* PHP extension
@@ -52,14 +52,14 @@ class phpbb_controller_helper
 	*
 	* @param phpbb_template $template Template object
 	* @param phpbb_user $user User object
-	* @param string $root_path phpBB root path
+	* @param string $phpbb_root_path phpBB root path
 	* @param string $php_ext PHP extension
 	*/
-	public function __construct(phpbb_template $template, phpbb_user $user, $root_path, $php_ext)
+	public function __construct(phpbb_template $template, phpbb_user $user, $phpbb_root_path, $php_ext)
 	{
 		$this->template = $template;
 		$this->user = $user;
-		$this->root_path = $root_path;
+		$this->phpbb_root_path = $phpbb_root_path;
 		$this->php_ext = $php_ext;
 	}
 
@@ -95,7 +95,7 @@ class phpbb_controller_helper
 	*/
 	public function url(array $url_parts, $query = '')
 	{
-		return append_sid($this->root_path . implode('/', $url_parts), $query);
+		return append_sid($this->phpbb_root_path . implode('/', $url_parts), $query);
 	}
 
 	/**
-- 
cgit v1.2.1


From 1952a4f276930edd16ca51fd690ed3e7965071da Mon Sep 17 00:00:00 2001
From: David King <imkingdavid@gmail.com>
Date: Fri, 16 Nov 2012 10:38:40 -0500
Subject: [feature/controller] Flip method parameters, require $message

PHPBB3-10864
---
 phpBB/includes/controller/helper.php | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'phpBB/includes/controller')

diff --git a/phpBB/includes/controller/helper.php b/phpBB/includes/controller/helper.php
index 6dc3ec4626..6cacc8fefa 100644
--- a/phpBB/includes/controller/helper.php
+++ b/phpBB/includes/controller/helper.php
@@ -101,11 +101,11 @@ class phpbb_controller_helper
 	/**
 	* Output an error, effectively the same thing as trigger_error
 	*
-	* @param string $code The error code (e.g. 404, 500, 503, etc.)
 	* @param string $message The error message
+	* @param string $code The error code (e.g. 404, 500, 503, etc.)
 	* @return Response A Reponse instance
 	*/
-	public function error($code = 500, $message = '')
+	public function error($message, $code = 500)
 	{
 		$this->template->assign_vars(array(
 			'MESSAGE_TEXT'	=> $message,
-- 
cgit v1.2.1


From 4d6f6351dd0563b26105d15b98052d907f9c52ed Mon Sep 17 00:00:00 2001
From: David King <imkingdavid@gmail.com>
Date: Sat, 17 Nov 2012 18:05:32 -0500
Subject: [feature/controller] Allow injecting Symfony Request into controllers

PHPBB3-10864
---
 phpBB/includes/controller/resolver.php | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'phpBB/includes/controller')

diff --git a/phpBB/includes/controller/resolver.php b/phpBB/includes/controller/resolver.php
index 901aa7eaa0..ee469aa9c8 100644
--- a/phpBB/includes/controller/resolver.php
+++ b/phpBB/includes/controller/resolver.php
@@ -109,6 +109,10 @@ class phpbb_controller_resolver implements ControllerResolverInterface
 			{
 				$arguments[] = $attributes[$param->name];
 			}
+			else if ($param->getClass() && $param->getClass()->isInstance($request))
+			{
+				$arguments[] = $request;
+			}
 			else if ($param->isDefaultValueAvailable())
 			{
 				$arguments[] = $param->getDefaultValue();
-- 
cgit v1.2.1