mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-04-22 00:32:29 +02:00
Code Issues Releases Wiki Activity

[feature/extension-manager] The class loader no longer knows about extensions

Browse Source 
Instead the class loader is instantiated twice. Once with the phpbb_ prefix
and once with the phpbb_ext_ prefix.

PHPBB3-10323
This commit is contained in:
Nils Adermann 2011-08-15 21:38:47 -04:00
parent 989bd9cde7
commit 96209e0224
9 changed files with 77 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
phpBB/common.php
View File

@ -96,13 +96,16 @@ require($phpbb_root_path . 'includes/utf/utf_tools.' . $phpEx);
set_error_handler(defined('PHPBB_MSG_HANDLER') ? PHPBB_MSG_HANDLER : 'msg_handler');
// Setup class loader first
$class_loader = new phpbb_class_loader($phpbb_root_path . 'includes/', $phpbb_root_path . 'ext/', '.' . $phpEx);
$class_loader->register();
$phpbb_class_loader_ext = new phpbb_class_loader('phpbb_ext_', $phpbb_root_path . 'ext/', ".$phpEx");
$phpbb_class_loader_ext->register();
$phpbb_class_loader = new phpbb_class_loader('phpbb_', $phpbb_root_path . 'includes/', ".$phpEx");
$phpbb_class_loader->register();
// set up caching
$cache_factory = new phpbb_cache_factory($acm_type);
$cache = $cache_factory->get_service();
$class_loader->set_cache($cache->get_driver());
$phpbb_class_loader_ext->set_cache($cache->get_driver());
$phpbb_class_loader->set_cache($cache->get_driver());
// Instantiate some basic classes
$request = new phpbb_request();

9
phpBB/download/file.php
View File

@ -46,13 +46,16 @@ if (isset($_GET['avatar']))
require($phpbb_root_path . 'includes/functions_download' . '.' . $phpEx);
require($phpbb_root_path . 'includes/utf/utf_tools.' . $phpEx);
$class_loader = new phpbb_class_loader($phpbb_root_path . 'includes/', $phpbb_root_path . 'ext/', '.' . $phpEx);
$class_loader->register();
$phpbb_class_loader_ext = new phpbb_class_loader('phpbb_ext_', $phpbb_root_path . 'ext/', ".$phpEx");
$phpbb_class_loader_ext->register();
$phpbb_class_loader = new phpbb_class_loader('phpbb_', $phpbb_root_path . 'includes/', ".$phpEx");
$phpbb_class_loader->register();
// set up caching
$cache_factory = new phpbb_cache_factory($acm_type);
$cache = $cache_factory->get_service();
$class_loader->set_cache($cache->get_driver());
$phpbb_class_loader_ext->set_cache($cache->get_driver());
$phpbb_class_loader->set_cache($cache->get_driver());
$request = new phpbb_request();
$db = new $sql_db();

47
phpBB/includes/class_loader.php
View File

@ -31,25 +31,25 @@ if (!defined('IN_PHPBB'))
*/
class phpbb_class_loader
{
private $core_path;
private $ext_path;
private $prefix;
private $path;
private $php_ext;
private $cache;
private $cached_paths = array();
/**
* Creates a new phpbb_class_loader, which loads files with the given
* file extension from the given core or extension path.
* file extension from the given path.
*
* @param string $core_path phpBB's include directory for core files
* @param string $ext_path phpBB's extension directory
* @param string $php_ext The file extension for PHP files
* @param string $prefix Required class name prefix for files to be loaded
* @param string $path Directory to load files from
* @param string $php_ext The file extension for PHP files
* @param phpbb_cache_driver_interface $cache An implementation of the phpBB cache interface.
*/
public function __construct($core_path, $ext_path, $php_ext = '.php', phpbb_cache_driver_interface $cache = null)
public function __construct($prefix, $path, $php_ext = '.php', phpbb_cache_driver_interface $cache = null)
{
$this->core_path = $core_path;
$this->ext_path = $ext_path;
$this->prefix = $prefix;
$this->path = $path;
$this->php_ext = $php_ext;
$this->set_cache($cache);
@ -66,7 +66,7 @@ class phpbb_class_loader
{
if ($cache)
{
$this->cached_paths = $cache->get('class_loader');
$this->cached_paths = $cache->get('class_loader_' . $this->prefix);
if ($this->cached_paths === false)
{
@ -103,32 +103,21 @@ class phpbb_class_loader
*/
public function resolve_path($class)
{
if (substr($class, 6, 4) === 'ext_')
{
$path_prefix = $this->ext_path;
$prefix_length = 10;
}
else
{
$path_prefix = $this->core_path;
$prefix_length = 6;
}
if (isset($this->cached_paths[$class]))
{
return $path_prefix . $this->cached_paths[$class] . $this->php_ext;
return $this->path . $this->cached_paths[$class] . $this->php_ext;
}
if (!preg_match('/phpbb_[a-zA-Z0-9_]+/', $class))
if (!preg_match('/^' . $this->prefix . '[a-zA-Z0-9_]+$/', $class))
{
return false;
}
$parts = explode('_', substr($class, $prefix_length));
$parts = explode('_', substr($class, strlen($this->prefix)));
$dirs = '';
for ($i = 0, $n = sizeof($parts); $i < $n && is_dir($path_prefix . $dirs . $parts[$i]); $i++)
for ($i = 0, $n = sizeof($parts); $i < $n && is_dir($this->path . $dirs . $parts[$i]); $i++)
{
$dirs .= $parts[$i] . '/';
}
@ -141,7 +130,7 @@ class phpbb_class_loader
$relative_path = $dirs . implode(array_slice($parts, $i, sizeof($parts) - $i), '_');
if (!file_exists($path_prefix . $relative_path . $this->php_ext))
if (!file_exists($this->path . $relative_path . $this->php_ext))
{
return false;
}
@ -149,10 +138,10 @@ class phpbb_class_loader
if ($this->cache)
{
$this->cached_paths[$class] = $relative_path;
$this->cache->put('class_loader', $this->cached_paths);
$this->cache->put('class_loader_' . $this->prefix, $this->cached_paths);
}
return $path_prefix . $relative_path . $this->php_ext;
return $this->path . $relative_path . $this->php_ext;
}
/**
@ -162,7 +151,7 @@ class phpbb_class_loader
*/
public function load_class($class)
{
if (substr($class, 0, 6) === 'phpbb_')
if (substr($class, 0, strlen($this->prefix)) === $this->prefix)
{
$path = $this->resolve_path($class);

9
phpBB/install/database_update.php
View File

@ -109,13 +109,16 @@ if (!defined('EXT_TABLE'))
define('EXT_TABLE', $table_prefix . 'ext');
}
$class_loader = new phpbb_class_loader($phpbb_root_path . 'includes/', $phpbb_root_path . 'ext/', '.' . $phpEx);
$class_loader->register();
$phpbb_class_loader_ext = new phpbb_class_loader('phpbb_ext_', $phpbb_root_path . 'ext/', ".$phpEx");
$phpbb_class_loader_ext->register();
$phpbb_class_loader = new phpbb_class_loader('phpbb_', $phpbb_root_path . 'includes/', ".$phpEx");
$phpbb_class_loader->register();
// set up caching
$cache_factory = new phpbb_cache_factory($acm_type);
$cache = $cache_factory->get_service();
$class_loader->set_cache($cache->get_driver());
$phpbb_class_loader_ext->set_cache($cache->get_driver());
$phpbb_class_loader->set_cache($cache->get_driver());
$request = new phpbb_request();
$user = new user();

9
phpBB/install/index.php
View File

@ -82,13 +82,16 @@ include($phpbb_root_path . 'includes/functions_admin.' . $phpEx);
include($phpbb_root_path . 'includes/utf/utf_tools.' . $phpEx);
require($phpbb_root_path . 'includes/functions_install.' . $phpEx);
$class_loader = new phpbb_class_loader($phpbb_root_path . 'includes/', $phpbb_root_path . 'ext/', '.' . $phpEx);
$class_loader->register();
$phpbb_class_loader_ext = new phpbb_class_loader('phpbb_ext_', $phpbb_root_path . 'ext/', ".$phpEx");
$phpbb_class_loader_ext->register();
$phpbb_class_loader = new phpbb_class_loader('phpbb_', $phpbb_root_path . 'includes/', ".$phpEx");
$phpbb_class_loader->register();
// set up caching
$cache_factory = new phpbb_cache_factory('file');
$cache = $cache_factory->get_service();
$class_loader->set_cache($cache->get_driver());
$phpbb_class_loader_ext->set_cache($cache->get_driver());
$phpbb_class_loader->set_cache($cache->get_driver());
$request = new phpbb_request();

6
tests/bootstrap.php
View File

@ -32,8 +32,10 @@ else
require_once $phpbb_root_path . 'includes/constants.php';
require_once $phpbb_root_path . 'includes/class_loader.' . $phpEx;
$class_loader = new phpbb_class_loader($phpbb_root_path . 'includes/', $phpbb_root_path . 'ext/', '.php');
$class_loader->register();
$phpbb_class_loader_ext = new phpbb_class_loader('phpbb_ext_', $phpbb_root_path . 'ext/', ".php");
$phpbb_class_loader_ext->register();
$phpbb_class_loader = new phpbb_class_loader('phpbb_', $phpbb_root_path . 'includes/', ".php");
$phpbb_class_loader->register();
require_once 'test_framework/phpbb_test_case_helpers.php';
require_once 'test_framework/phpbb_test_case.php';

46
tests/class_loader/class_loader_test.php
View File

@ -13,20 +13,26 @@ class phpbb_class_loader_test extends PHPUnit_Framework_TestCase
{
public function setUp()
{
global $class_loader;
$class_loader->unregister();
global $phpbb_class_loader;
$phpbb_class_loader->unregister();
global $phpbb_class_loader_ext;
$phpbb_class_loader_ext->unregister();
}
public function tearDown()
{
global $class_loader;
$class_loader->register();
global $phpbb_class_loader_ext;
$phpbb_class_loader_ext->register();
global $phpbb_class_loader;
$phpbb_class_loader->register();
}
public function test_resolve_path()
{
$prefix = dirname(__FILE__) . '/';
$class_loader = new phpbb_class_loader($prefix . 'includes/', $prefix . 'ext/');
$class_loader = new phpbb_class_loader('phpbb_', $prefix . 'includes/');
$prefix .= 'includes/';
@ -56,20 +62,19 @@ class phpbb_class_loader_test extends PHPUnit_Framework_TestCase
$class_loader->resolve_path('phpbb_dir2'),
'Class with name of dir within dir (short class name)'
);
$this->assertEquals(
dirname(__FILE__) . '/ext/foo/class.php',
$class_loader->resolve_path('phpbb_ext_foo_class'),
'Extension class'
);
}
public function test_resolve_cached()
{
$cacheMap = array('class_loader' => array('phpbb_a_cached_name' => 'a/cached_name'));
$cache = new phpbb_mock_cache($cacheMap);
$cache_map = array(
'class_loader_phpbb_' => array('phpbb_a_cached_name' => 'a/cached_name'),
'class_loader_phpbb_ext_' => array('phpbb_ext_foo' => 'foo'),
);
$cache = new phpbb_mock_cache($cache_map);
$prefix = dirname(__FILE__) . '/';
$class_loader = new phpbb_class_loader($prefix . 'includes/', $prefix . 'ext/', '.php', $cache);
$class_loader = new phpbb_class_loader('phpbb_', $prefix . 'includes/', '.php', $cache);
$class_loader_ext = new phpbb_class_loader('phpbb_ext_', $prefix . 'includes/', '.php', $cache);
$prefix .= 'includes/';
@ -79,13 +84,22 @@ class phpbb_class_loader_test extends PHPUnit_Framework_TestCase
'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->assertEquals(
$prefix . 'a/cached_name.php',
$class_loader->resolve_path('phpbb_a_cached_name'),
'Class in a directory'
'Cached class found'
);
$cacheMap['class_loader']['phpbb_dir_class_name'] = 'dir/class_name';
$cache->check($this, $cacheMap);
$this->assertEquals(
$prefix . 'foo.php',
$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->check($this, $cache_map);
}
}

6
tests/class_loader/ext/foo/class.php
View File

@ -1,6 +0,0 @@
<?php
class phpbb_ext_foo_class
{
}

17
tests/extension/manager_test.php
View File

@ -23,30 +23,15 @@ class phpbb_extension_manager_test extends phpbb_database_test_case
{
parent::setUp();
// disable the regular class loader to replace it with one that loads
// test extensions
global $class_loader;
$class_loader->unregister();
$prefix = dirname(__FILE__) . '/';
$this->class_loader = new phpbb_class_loader($prefix . '../../phpBB/includes/', $prefix . 'ext/');
$this->class_loader->register();
$this->extension_manager = new phpbb_extension_manager(
$this->new_dbal(),
'phpbb_ext',
$prefix,
dirname(__FILE__) . '/',
'.php',
new phpbb_mock_cache
);
}
protected function tearDown()
{
global $class_loader;
$class_loader->register();
}
public function test_available()
{
$this->assertEquals(array('bar', 'foo', 'moo'), array_keys($this->extension_manager->all_available()));