[ticket/11700] Fix extension loading with namespaces

naderman · naderman · commit fe36375a36ec · 2013-09-19T18:29:08.000+02:00
class loader now expects all classes to be prefixed with a backslash
when resolving paths

PHPBB3-11700
diff --git a/phpBB/phpbb/class_loader.php b/phpBB/phpbb/class_loader.php
@@ -55,7 +55,12 @@ class class_loader
 	* @param \phpbb\cache\driver\driver_interface $cache An implementation of the phpBB cache interface.
 	*/
 	public function __construct($namespace, $path, $php_ext = 'php', \phpbb\cache\driver\driver_interface $cache = null)
-	{
+    {
+		if ($namespace[0] !== '\\')
+		{
+			$namespace = '\\' . $namespace;
+		}
+
 		$this->namespace = $namespace;
 		$this->path = $path;
 		$this->php_ext = $php_ext;
@@ -105,7 +110,8 @@ public function unregister()
 	* Resolves a phpBB class name to a relative path which can be included.
 	*
 	* @param string       $class The class name to resolve, must be in the
-	*                            namespace the loader was constructed with
+	*                            namespace the loader was constructed with.
+	*                            Has to begin with \
 	* @return string|bool        A relative path to the file containing the
 	*                            class or false if looking it up failed.
 	*/
@@ -144,6 +150,7 @@ public function resolve_path($class)
 	*/
 	public function load_class($class)
 	{
+		$class = '\\' . $class;
 		if (substr($class, 0, strlen($this->namespace)) === $this->namespace)
 		{
 			$path = $this->resolve_path($class);
diff --git a/phpBB/phpbb/controller/helper.php b/phpBB/phpbb/controller/helper.php
@@ -91,7 +91,7 @@ public function render($template_file, $page_title = '', $status_code = 200)
 
 		page_footer(true, false, false);
 
-		return new \Response($this->template->assign_display('body'), $status_code);
+		return new Response($this->template->assign_display('body'), $status_code);
 	}
 
 	/**
diff --git a/phpBB/phpbb/controller/resolver.php b/phpBB/phpbb/controller/resolver.php
@@ -95,12 +95,12 @@ public function getController(Request $request)
 		* the style paths for the extension (the ext author can change them
 		* if necessary).
 		*/
-		$controller_dir = explode('_', get_class($controller_object));
+		$controller_dir = explode('\\', get_class($controller_object));
 
-		// 0 phpbb, 1 ext, 2 vendor, 3 extension name, ...
-		if (!is_null($this->template) && isset($controller_dir[3]) && $controller_dir[1] === 'ext')
+		// 0 vendor, 1 extension name, ...
+		if (!is_null($this->template) && isset($controller_dir[1]))
 		{
-			$controller_style_dir = 'ext/' . $controller_dir[2] . '/' . $controller_dir[3] . '/styles';
+			$controller_style_dir = 'ext/' . $controller_dir[0] . '/' . $controller_dir[1] . '/styles';
 
 			if (is_dir($controller_style_dir))
 			{
diff --git a/phpBB/phpbb/event/kernel_exception_subscriber.php b/phpBB/phpbb/event/kernel_exception_subscriber.php
@@ -55,7 +55,7 @@ public function __construct(\phpbb\template\template $template, \phpbb\user $use
 	* @param GetResponseForExceptionEvent $event
 	* @return null
 	*/
-	public function on_kernel_exception(\GetResponseForExceptionEvent $event)
+	public function on_kernel_exception(GetResponseForExceptionEvent $event)
 	{
 		page_header($this->user->lang('INFORMATION'));
 
@@ -74,7 +74,7 @@ public function on_kernel_exception(\GetResponseForExceptionEvent $event)
 
 
 		$status_code = $exception instanceof HttpException ? $exception->getStatusCode() : 500;
-		$response = new \Response($this->template->assign_display('body'), $status_code);
+		$response = new Response($this->template->assign_display('body'), $status_code);
 		$event->setResponse($response);
 	}
 
diff --git a/phpBB/phpbb/event/kernel_request_subscriber.php b/phpBB/phpbb/event/kernel_request_subscriber.php
@@ -65,14 +65,14 @@ public function __construct(\phpbb\extension\finder $finder, $root_path, $php_ex
 	* @param GetResponseEvent $event
 	* @return null
 	*/
-	public function on_kernel_request(\GetResponseEvent $event)
+	public function on_kernel_request(GetResponseEvent $event)
 	{
 		$request = $event->getRequest();
-		$context = new \RequestContext();
+		$context = new RequestContext();
 		$context->fromRequest($request);
 
 		$matcher = phpbb_get_url_matcher($this->finder, $context, $this->root_path, $this->php_ext);
-		$router_listener = new \RouterListener($matcher, $context);
+		$router_listener = new RouterListener($matcher, $context);
 		$router_listener->onKernelRequest($event);
 	}
 
diff --git a/phpBB/phpbb/event/kernel_terminate_subscriber.php b/phpBB/phpbb/event/kernel_terminate_subscriber.php
@@ -31,7 +31,7 @@ class kernel_terminate_subscriber implements EventSubscriberInterface
 	* @param PostResponseEvent $event
 	* @return null
 	*/
-	public function on_kernel_terminate(\PostResponseEvent $event)
+	public function on_kernel_terminate(PostResponseEvent $event)
 	{
 		exit_handler();
 	}
diff --git a/tests/acp_board/auth_provider/valid.php b/tests/acp_board/auth_provider/valid.php
@@ -7,7 +7,9 @@
 *
 */
 
-class phpbb_auth_provider_acp_board_valid extends \phpbb\auth\provider\base
+namespace phpbb\auth\provider\acp;
+
+class board_valid extends \phpbb\auth\provider\base
 {
 	public function login($username, $password)
 	{
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -18,7 +18,7 @@
 
 $phpbb_class_loader_mock = new \phpbb\class_loader('phpbb_mock_', $phpbb_root_path . '../tests/mock/', "php");
 $phpbb_class_loader_mock->register();
-$phpbb_class_loader_ext = new \phpbb\class_loader('phpbb_ext_', $phpbb_root_path . 'ext/', "php");
+$phpbb_class_loader_ext = new \phpbb\class_loader('\\', $phpbb_root_path . 'ext/', "php");
 $phpbb_class_loader_ext->register();
 $phpbb_class_loader = new \phpbb\class_loader('phpbb\\', $phpbb_root_path . 'phpbb/', "php");
 $phpbb_class_loader->register();
diff --git a/tests/class_loader/class_loader_test.php b/tests/class_loader/class_loader_test.php
@@ -36,31 +36,31 @@ public function test_resolve_path()
 
 		$this->assertEquals(
 			$prefix . 'class_name.php',
-			$class_loader->resolve_path('phpbb\\class_name'),
+			$class_loader->resolve_path('\\phpbb\\class_name'),
 			'Top level class'
 		);
 		$this->assertEquals(
 			$prefix . 'dir/class_name.php',
-			$class_loader->resolve_path('phpbb\\dir\\class_name'),
+			$class_loader->resolve_path('\\phpbb\\dir\\class_name'),
 			'Class in a directory'
 		);
 		$this->assertEquals(
 			$prefix . 'dir/subdir/class_name.php',
-			$class_loader->resolve_path('phpbb\\dir\\subdir\\class_name'),
+			$class_loader->resolve_path('\\phpbb\\dir\\subdir\\class_name'),
 			'Class in a sub-directory'
 		);
 		$this->assertEquals(
 			$prefix . 'dir2/dir2.php',
-			$class_loader->resolve_path('phpbb\\dir2\\dir2'),
+			$class_loader->resolve_path('\\phpbb\\dir2\\dir2'),
 			'Class with name of dir within dir'
 		);
 	}
 
 	public function test_resolve_cached()
 	{
 		$cache_map = array(
-			'class_loader_phpbb__' => array('phpbb\\a\\cached_name' => 'a/cached_name'),
-			'class_loader___' => array('phpbb\\ext\\foo' => 'foo'),
+			'class_loader___phpbb__' => array('\\phpbb\\a\\cached_name' => 'a/cached_name'),
+			'class_loader___' => array('\\phpbb\\ext\\foo' => 'foo'),
 		);
 		$cache = new phpbb_mock_cache($cache_map);
 
@@ -72,26 +72,26 @@ public function test_resolve_cached()
 
 		$this->assertEquals(
 			$prefix . 'dir/class_name.php',
-			$class_loader->resolve_path('phpbb\\dir\\class_name'),
+			$class_loader->resolve_path('\\phpbb\\dir\\class_name'),
 			'Class in a directory'
 		);
 
-		$this->assertFalse($class_loader->resolve_path('phpbb\\ext\\foo'));
-		$this->assertFalse($class_loader_ext->resolve_path('phpbb\\a\\cached_name'));
+		$this->assertFalse($class_loader->resolve_path('\\phpbb\\ext\\foo'));
+		$this->assertFalse($class_loader_ext->resolve_path('\\phpbb\\a\\cached_name'));
 
 		$this->assertEquals(
 			$prefix . 'a/cached_name.php',
-			$class_loader->resolve_path('phpbb\\a\\cached_name'),
+			$class_loader->resolve_path('\\phpbb\\a\\cached_name'),
 			'Cached class found'
 		);
 
 		$this->assertEquals(
 			$prefix . 'foo.php',
-			$class_loader_ext->resolve_path('phpbb\\ext\\foo'),
+			$class_loader_ext->resolve_path('\\phpbb\\ext\\foo'),
 			'Cached class found in alternative loader'
 		);
 
-		$cache_map['class_loader_phpbb__']['phpbb\\dir\\class_name'] = 'dir/class_name';
+		$cache_map['class_loader___phpbb__']['\\phpbb\\dir\\class_name'] = 'dir/class_name';
 		$cache->check($this, $cache_map);
 	}
 }
diff --git a/tests/controller/controller_test.php b/tests/controller/controller_test.php
@@ -53,11 +53,11 @@ public function test_controller_resolver()
 
 		// Autoloading classes within the tests folder does not work
 		// so I'll include them manually.
-		if (!class_exists('phpbb_ext_foo_controller'))
+		if (!class_exists('foo\\controller'))
 		{
 			include(__DIR__.'/ext/foo/controller.php');
 		}
-		if (!class_exists('phpbb_controller_foo'))
+		if (!class_exists('phpbb\\controller\\foo'))
 		{
 			include(__DIR__.'/phpbb/controller/foo.php');
 		}
@@ -66,11 +66,11 @@ public function test_controller_resolver()
 		$symfony_request = new Request();
 		$symfony_request->attributes->set('_controller', 'foo.controller:handle');
 
-		$this->assertEquals($resolver->getController($symfony_request), array(new phpbb_ext_foo_controller, 'handle'));
+		$this->assertEquals($resolver->getController($symfony_request), array(new foo\controller, 'handle'));
 
 		$symfony_request = new Request();
 		$symfony_request->attributes->set('_controller', 'core_foo.controller:bar');
 
-		$this->assertEquals($resolver->getController($symfony_request), array(new phpbb_controller_foo, 'bar'));
+		$this->assertEquals($resolver->getController($symfony_request), array(new phpbb\controller\foo, 'bar'));
 	}
 }
diff --git a/tests/controller/ext/foo/config/services.yml b/tests/controller/ext/foo/config/services.yml
@@ -1,3 +1,3 @@
 services:
     foo.controller:
-        class: phpbb_ext_foo_controller
+        class: foo\controller
diff --git a/tests/controller/ext/foo/controller.php b/tests/controller/ext/foo/controller.php
@@ -1,8 +1,10 @@
 <?php
 
+namespace foo;
+
 use Symfony\Component\HttpFoundation\Response;
 
-class phpbb_ext_foo_controller
+class controller
 {
 	/**
 	* Handle method
diff --git a/tests/extension/ext/bar/my/hidden_class.php b/tests/extension/ext/bar/my/hidden_class.php
@@ -1,5 +1,7 @@
 <?php
 
-class phpbb_ext_bar_my_hidden_class
+namespace bar\my;
+
+class hidden_class
 {
 }
diff --git a/tests/extension/ext/foo/acp/fail_info.php b/tests/extension/ext/foo/acp/fail_info.php
@@ -11,7 +11,7 @@ class foo_info
 	public function module()
 	{
 		return array(
-			'filename'	=> 'phpbb_ext_foo_acp_fail_module',
+			'filename'	=> 'foo\acp\fail_module',
 			'title'		=> 'Foobar',
 			'version'	=> '3.1.0-dev',
 			'modes'		=> array(
diff --git a/tests/functional/extension_controller_test.php b/tests/functional/extension_controller_test.php
@@ -78,7 +78,7 @@ public function test_missing_argument()
 		$this->phpbb_extension_manager->enable('foo/bar');
 		$crawler = self::request('GET', 'app.php/foo/baz', array(), false);
 		$this->assert_response_html(500);
-		$this->assertContains('Missing value for argument #1: test in class phpbb_ext_foo_bar_controller:baz', $crawler->filter('body')->text());
+		$this->assertContains('Missing value for argument #1: test in class foo\bar\controller\controller:baz', $crawler->filter('body')->text());
 		$this->phpbb_extension_manager->purge('foo/bar');
 	}
 
diff --git a/tests/functional/extension_module_test.php b/tests/functional/extension_module_test.php
@@ -69,7 +69,7 @@ public function setUp()
 		$modules->update_module_data($parent_data, true);
 
 		$module_data = array(
-			'module_basename'	=> 'phpbb_ext_foo_bar_acp_main_module',
+			'module_basename'	=> 'foo\\bar\\acp\\main_module',
 			'module_enabled'	=> 1,
 			'module_display'	=> 1,
 			'parent_id'			=> $parent_data['module_id'],
@@ -90,7 +90,7 @@ public function test_foo_bar()
 	{
 		$this->login();
 		$this->admin_login();
-		$crawler = self::request('GET', 'adm/index.php?i=phpbb_ext_foo_bar_acp_main_module&mode=mode&sid=' . $this->sid);
+		$crawler = self::request('GET', 'adm/index.php?i=foo\\bar\\acp\\main_module&mode=mode&sid=' . $this->sid);
 		$this->assertContains("Bertie rulez!", $crawler->filter('#main')->text());
 		$this->phpbb_extension_manager->purge('foo/bar');
 	}
diff --git a/tests/functional/fixtures/ext/foo/bar/acp/main_info.php b/tests/functional/fixtures/ext/foo/bar/acp/main_info.php
@@ -8,6 +8,8 @@
 *
 */
 
+namespace foo\bar\acp;
+
 /**
 * @ignore
 */
@@ -16,12 +18,12 @@
 	exit;
 }
 
-class phpbb_ext_foo_bar_acp_main_info
+class main_info
 {
 	function module()
 	{
 		return array(
-			'filename'	=> 'phpbb_ext_foo_bar_acp_main_module',
+			'filename'	=> 'foo\bar\acp\main_module',
 			'title'		=> 'ACP_FOOBAR_TITLE',
 			'version'	=> '1.0.0',
 			'modes'		=> array(
diff --git a/tests/functional/fixtures/ext/foo/bar/acp/main_module.php b/tests/functional/fixtures/ext/foo/bar/acp/main_module.php
@@ -8,6 +8,8 @@
 *
 */
 
+namespace foo\bar\acp;
+
 /**
 * @ignore
 */
@@ -16,7 +18,7 @@
 	exit;
 }
 
-class phpbb_ext_foo_bar_acp_main_module
+class main_module
 {
 	var $u_action;
 
diff --git a/tests/functional/fixtures/ext/foo/bar/config/services.yml b/tests/functional/fixtures/ext/foo/bar/config/services.yml
@@ -1,6 +1,6 @@
 services:
     foo_bar.controller:
-        class: phpbb_ext_foo_bar_controller
+        class: foo\bar\controller\controller
         arguments:
             - @controller.helper
             - @template
diff --git a/tests/functional/fixtures/ext/foo/bar/controller/controller.php b/tests/functional/fixtures/ext/foo/bar/controller/controller.php
@@ -1,7 +1,10 @@
 <?php
+
+namespace foo\bar\controller;
+
 use Symfony\Component\HttpFoundation\Response;
 
-class phpbb_ext_foo_bar_controller
+class controller
 {
 	protected $template;
 
diff --git a/tests/functional/fixtures/ext/foo/bar/event/permission.php b/tests/functional/fixtures/ext/foo/bar/event/permission.php
@@ -8,6 +8,8 @@
 *
 */
 
+namespace foo\bar\event;
+
 /**
 * @ignore
 */
@@ -22,7 +24,7 @@
 */
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
-class phpbb_ext_foo_bar_event_permission implements EventSubscriberInterface
+class permission implements EventSubscriberInterface
 {
 	static public function getSubscribedEvents()
 	{
diff --git a/tests/functional/fixtures/ext/foo/bar/event/user_setup.php b/tests/functional/fixtures/ext/foo/bar/event/user_setup.php
@@ -8,6 +8,8 @@
 *
 */
 
+namespace foo\bar\event;
+
 /**
 * @ignore
 */
@@ -22,7 +24,7 @@
 */
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
-class phpbb_ext_foo_bar_event_user_setup implements EventSubscriberInterface
+class user_setup implements EventSubscriberInterface
 {
 	static public function getSubscribedEvents()
 	{
diff --git a/tests/functional/fixtures/ext/foo/bar/ext.php b/tests/functional/fixtures/ext/foo/bar/ext.php
@@ -1,6 +1,8 @@
 <?php
 
-class phpbb_ext_foo_bar_ext extends \phpbb\extension\base
+namespace foo\bar;
+
+class ext extends \phpbb\extension\base
 {
 
 }

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ public function render($template_file, $page_title = '', $status_code = 200)`
`91`	`91`
`92`	`92`	`page_footer(true, false, false);`
`93`	`93`
`94`		`- return new \Response($this->template->assign_display('body'), $status_code);`
	`94`	`+ return new Response($this->template->assign_display('body'), $status_code);`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public function __construct(\phpbb\template\template $template, \phpbb\user $use`
`55`	`55`	`* @param GetResponseForExceptionEvent $event`
`56`	`56`	`* @return null`
`57`	`57`	`*/`
`58`		`- public function on_kernel_exception(\GetResponseForExceptionEvent $event)`
	`58`	`+ public function on_kernel_exception(GetResponseForExceptionEvent $event)`
`59`	`59`	`{`
`60`	`60`	`page_header($this->user->lang('INFORMATION'));`
`61`	`61`
`@@ -74,7 +74,7 @@ public function on_kernel_exception(\GetResponseForExceptionEvent $event)`
`74`	`74`
`75`	`75`
`76`	`76`	`$status_code = $exception instanceof HttpException ? $exception->getStatusCode() : 500;`
`77`		`- $response = new \Response($this->template->assign_display('body'), $status_code);`
	`77`	`+ $response = new Response($this->template->assign_display('body'), $status_code);`
`78`	`78`	`$event->setResponse($response);`
`79`	`79`	`}`
`80`	`80`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class kernel_terminate_subscriber implements EventSubscriberInterface`
`31`	`31`	`* @param PostResponseEvent $event`
`32`	`32`	`* @return null`
`33`	`33`	`*/`
`34`		`- public function on_kernel_terminate(\PostResponseEvent $event)`
	`34`	`+ public function on_kernel_terminate(PostResponseEvent $event)`
`35`	`35`	`{`
`36`	`36`	`exit_handler();`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,9 @@`
`7`	`7`	`*`
`8`	`8`	`*/`
`9`	`9`
`10`		`-class phpbb_auth_provider_acp_board_valid extends \phpbb\auth\provider\base`
	`10`	`+namespace phpbb\auth\provider\acp;`
	`11`	`+`
	`12`	`+class board_valid extends \phpbb\auth\provider\base`
`11`	`13`	`{`
`12`	`14`	`public function login($username, $password)`
`13`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -53,11 +53,11 @@ public function test_controller_resolver()`
`53`	`53`
`54`	`54`	`// Autoloading classes within the tests folder does not work`
`55`	`55`	`// so I'll include them manually.`
`56`		`- if (!class_exists('phpbb_ext_foo_controller'))`
	`56`	`+ if (!class_exists('foo\\controller'))`
`57`	`57`	`{`
`58`	`58`	`include(__DIR__.'/ext/foo/controller.php');`
`59`	`59`	`}`
`60`		`- if (!class_exists('phpbb_controller_foo'))`
	`60`	`+ if (!class_exists('phpbb\\controller\\foo'))`
`61`	`61`	`{`
`62`	`62`	`include(__DIR__.'/phpbb/controller/foo.php');`
`63`	`63`	`}`
`@@ -66,11 +66,11 @@ public function test_controller_resolver()`
`66`	`66`	`$symfony_request = new Request();`
`67`	`67`	`$symfony_request->attributes->set('_controller', 'foo.controller:handle');`
`68`	`68`
`69`		`- $this->assertEquals($resolver->getController($symfony_request), array(new phpbb_ext_foo_controller, 'handle'));`
	`69`	`+ $this->assertEquals($resolver->getController($symfony_request), array(new foo\controller, 'handle'));`
`70`	`70`
`71`	`71`	`$symfony_request = new Request();`
`72`	`72`	`$symfony_request->attributes->set('_controller', 'core_foo.controller:bar');`
`73`	`73`
`74`		`- $this->assertEquals($resolver->getController($symfony_request), array(new phpbb_controller_foo, 'bar'));`
	`74`	`+ $this->assertEquals($resolver->getController($symfony_request), array(new phpbb\controller\foo, 'bar'));`
`75`	`75`	`}`
`76`	`76`	`}`