mirror of
https://github.com/phpbb/phpbb.git
synced 2025-08-07 01:06:48 +02:00
[ticket/14220] Move route loading to services
PHPBB3-14220
This commit is contained in:
@@ -13,21 +13,20 @@
|
||||
|
||||
namespace phpbb\routing;
|
||||
|
||||
use phpbb\routing\resources_locator\resources_locator_interface;
|
||||
use Symfony\Component\Config\ConfigCache;
|
||||
use Symfony\Component\Filesystem\Exception\IOException;
|
||||
use Symfony\Component\Config\Loader\LoaderInterface;
|
||||
use Symfony\Component\DependencyInjection\ContainerInterface;
|
||||
use Symfony\Component\DependencyInjection\Exception\ParameterNotFoundException;
|
||||
use Symfony\Component\DependencyInjection\Exception\RuntimeException;
|
||||
use Symfony\Component\Routing\Matcher\Dumper\PhpMatcherDumper;
|
||||
use Symfony\Component\Filesystem\Exception\IOException;
|
||||
use Symfony\Component\Routing\Generator\Dumper\PhpGeneratorDumper;
|
||||
use Symfony\Component\Routing\Matcher\UrlMatcher;
|
||||
use Symfony\Component\Routing\Generator\UrlGenerator;
|
||||
use Symfony\Component\Routing\Matcher\Dumper\PhpMatcherDumper;
|
||||
use Symfony\Component\Routing\Matcher\UrlMatcher;
|
||||
use Symfony\Component\Routing\RequestContext;
|
||||
use Symfony\Component\Routing\RouteCollection;
|
||||
use Symfony\Component\Routing\RouterInterface;
|
||||
use Symfony\Component\Routing\Loader\YamlFileLoader;
|
||||
use Symfony\Component\Config\FileLocator;
|
||||
use phpbb\extension\manager;
|
||||
|
||||
/**
|
||||
* Integration of all pieces of the routing system for easier use.
|
||||
@@ -35,11 +34,19 @@ use phpbb\extension\manager;
|
||||
class router implements RouterInterface
|
||||
{
|
||||
/**
|
||||
* Extension manager
|
||||
*
|
||||
* @var manager
|
||||
* @var ContainerInterface
|
||||
*/
|
||||
protected $extension_manager;
|
||||
protected $container;
|
||||
|
||||
/**
|
||||
* @var resources_locator_interface
|
||||
*/
|
||||
protected $resources_locator;
|
||||
|
||||
/**
|
||||
* @var LoaderInterface
|
||||
*/
|
||||
protected $loader;
|
||||
|
||||
/**
|
||||
* phpBB root path
|
||||
@@ -62,13 +69,6 @@ class router implements RouterInterface
|
||||
*/
|
||||
protected $environment;
|
||||
|
||||
/**
|
||||
* YAML file(s) containing route information
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $routing_files;
|
||||
|
||||
/**
|
||||
* @var \Symfony\Component\Routing\Matcher\UrlMatcherInterface|null
|
||||
*/
|
||||
@@ -85,203 +85,31 @@ class router implements RouterInterface
|
||||
protected $context;
|
||||
|
||||
/**
|
||||
* @var RouteCollection|null
|
||||
* @var RouteCollection
|
||||
*/
|
||||
protected $route_collection;
|
||||
|
||||
/**
|
||||
* @var \phpbb\filesystem\filesystem_interface
|
||||
*/
|
||||
protected $filesystem;
|
||||
|
||||
/**
|
||||
* @var ContainerInterface
|
||||
*/
|
||||
protected $container;
|
||||
|
||||
/**
|
||||
* Construct method
|
||||
*
|
||||
* @param ContainerInterface $container DI container
|
||||
* @param \phpbb\filesystem\filesystem_interface $filesystem Filesystem helper
|
||||
* @param string $phpbb_root_path phpBB root path
|
||||
* @param string $php_ext PHP file extension
|
||||
* @param string $environment Name of the current environment
|
||||
* @param manager $extension_manager Extension manager
|
||||
* @param array $routing_files Array of strings containing paths to YAML files holding route information
|
||||
* @param ContainerInterface $container DI container
|
||||
* @param resources_locator_interface $resources_locator Resources locator
|
||||
* @param LoaderInterface $loader Resources loader
|
||||
* @param string $phpbb_root_path phpBB root path
|
||||
* @param string $php_ext PHP file extension
|
||||
* @param string $environment Name of the current environment
|
||||
*/
|
||||
public function __construct(ContainerInterface $container, \phpbb\filesystem\filesystem_interface $filesystem, $phpbb_root_path, $php_ext, $environment, manager $extension_manager = null, $routing_files = array())
|
||||
public function __construct(ContainerInterface $container, resources_locator_interface $resources_locator, LoaderInterface $loader, $phpbb_root_path, $php_ext, $environment)
|
||||
{
|
||||
$this->container = $container;
|
||||
$this->filesystem = $filesystem;
|
||||
$this->extension_manager = $extension_manager;
|
||||
$this->routing_files = $routing_files;
|
||||
$this->resources_locator = $resources_locator;
|
||||
$this->loader = $loader;
|
||||
$this->phpbb_root_path = $phpbb_root_path;
|
||||
$this->php_ext = $php_ext;
|
||||
$this->environment = $environment;
|
||||
$this->context = new RequestContext();
|
||||
}
|
||||
|
||||
/**
|
||||
* Find the list of routing files
|
||||
*
|
||||
* @param array $paths Array of paths where to look for routing files (they must be relative to the phpBB root path).
|
||||
* @return router
|
||||
*/
|
||||
public function find_routing_files(array $paths)
|
||||
{
|
||||
$this->routing_files = array('config/' . $this->environment . '/routing/environment.yml');
|
||||
foreach ($paths as $path)
|
||||
{
|
||||
if (file_exists($this->phpbb_root_path . $path . 'config/' . $this->environment . '/routing/environment.yml'))
|
||||
{
|
||||
$this->routing_files[] = $path . 'config/' . $this->environment . '/routing/environment.yml';
|
||||
}
|
||||
else if (!is_dir($this->phpbb_root_path . $path . 'config/' . $this->environment))
|
||||
{
|
||||
if (file_exists($this->phpbb_root_path . $path . 'config/default/routing/environment.yml'))
|
||||
{
|
||||
$this->routing_files[] = $path . 'config/default/routing/environment.yml';
|
||||
}
|
||||
else if (!is_dir($this->phpbb_root_path . $path . 'config/default/routing') && file_exists($this->phpbb_root_path . $path . 'config/routing.yml'))
|
||||
{
|
||||
$this->routing_files[] = $path . 'config/routing.yml';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Find a list of controllers
|
||||
*
|
||||
* @param string $base_path Base path to prepend to file paths
|
||||
* @return router
|
||||
*/
|
||||
public function find($base_path = '')
|
||||
{
|
||||
if ($this->route_collection === null || $this->route_collection->count() === 0)
|
||||
{
|
||||
$this->route_collection = new RouteCollection;
|
||||
foreach ($this->routing_files as $file_path)
|
||||
{
|
||||
$loader = new YamlFileLoader(new FileLocator($this->filesystem->realpath($base_path)));
|
||||
$this->route_collection->addCollection($loader->load($file_path));
|
||||
}
|
||||
}
|
||||
|
||||
$this->resolveParameters($this->route_collection);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Replaces placeholders with service container parameter values in:
|
||||
* - the route defaults,
|
||||
* - the route requirements,
|
||||
* - the route path,
|
||||
* - the route host,
|
||||
* - the route schemes,
|
||||
* - the route methods.
|
||||
*
|
||||
* @param RouteCollection $collection
|
||||
*/
|
||||
private function resolveParameters(RouteCollection $collection)
|
||||
{
|
||||
foreach ($collection as $route)
|
||||
{
|
||||
foreach ($route->getDefaults() as $name => $value)
|
||||
{
|
||||
$route->setDefault($name, $this->resolve($value));
|
||||
}
|
||||
|
||||
$requirements = $route->getRequirements();
|
||||
unset($requirements['_scheme']);
|
||||
unset($requirements['_method']);
|
||||
|
||||
foreach ($requirements as $name => $value)
|
||||
{
|
||||
$route->setRequirement($name, $this->resolve($value));
|
||||
}
|
||||
|
||||
$route->setPath($this->resolve($route->getPath()));
|
||||
$route->setHost($this->resolve($route->getHost()));
|
||||
|
||||
$schemes = array();
|
||||
foreach ($route->getSchemes() as $scheme)
|
||||
{
|
||||
$schemes = array_merge($schemes, explode('|', $this->resolve($scheme)));
|
||||
}
|
||||
|
||||
$route->setSchemes($schemes);
|
||||
$methods = array();
|
||||
foreach ($route->getMethods() as $method)
|
||||
{
|
||||
$methods = array_merge($methods, explode('|', $this->resolve($method)));
|
||||
}
|
||||
|
||||
$route->setMethods($methods);
|
||||
$route->setCondition($this->resolve($route->getCondition()));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively replaces placeholders with the service container parameters.
|
||||
*
|
||||
* @param mixed $value The source which might contain "%placeholders%"
|
||||
*
|
||||
* @return mixed The source with the placeholders replaced by the container
|
||||
* parameters. Arrays are resolved recursively.
|
||||
*
|
||||
* @throws ParameterNotFoundException When a placeholder does not exist as a container parameter
|
||||
* @throws RuntimeException When a container value is not a string or a numeric value
|
||||
*/
|
||||
private function resolve($value)
|
||||
{
|
||||
if (is_array($value))
|
||||
{
|
||||
foreach ($value as $key => $val)
|
||||
{
|
||||
$value[$key] = $this->resolve($val);
|
||||
}
|
||||
|
||||
return $value;
|
||||
}
|
||||
|
||||
if (!is_string($value))
|
||||
{
|
||||
return $value;
|
||||
}
|
||||
|
||||
$container = $this->container;
|
||||
$escapedValue = preg_replace_callback('/%%|%([^%\s]++)%/', function ($match) use ($container, $value)
|
||||
{
|
||||
// skip %%
|
||||
if (!isset($match[1]))
|
||||
{
|
||||
return '%%';
|
||||
}
|
||||
|
||||
$resolved = $container->getParameter($match[1]);
|
||||
if (is_string($resolved) || is_numeric($resolved))
|
||||
{
|
||||
return (string) $resolved;
|
||||
}
|
||||
|
||||
throw new RuntimeException(sprintf(
|
||||
'The container parameter "%s", used in the route configuration value "%s", '.
|
||||
'must be a string or numeric, but it is of type %s.',
|
||||
$match[1],
|
||||
$value,
|
||||
gettype($resolved)
|
||||
)
|
||||
);
|
||||
}, $value);
|
||||
|
||||
return str_replace('%%', '%', $escapedValue);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the list of routes
|
||||
*
|
||||
@@ -289,12 +117,22 @@ class router implements RouterInterface
|
||||
*/
|
||||
public function get_routes()
|
||||
{
|
||||
if ($this->route_collection == null || empty($this->routing_files))
|
||||
if ($this->route_collection === null /*|| $this->route_collection->count() === 0*/)
|
||||
{
|
||||
$this->find_routing_files(
|
||||
($this->extension_manager !== null) ? $this->extension_manager->all_enabled(false) : array()
|
||||
)
|
||||
->find($this->phpbb_root_path);
|
||||
$this->route_collection = new RouteCollection;
|
||||
foreach ($this->resources_locator->locate_resources() as $resource)
|
||||
{
|
||||
if (is_array($resource))
|
||||
{
|
||||
$this->route_collection->addCollection($this->loader->load($resource[0], $resource[1]));
|
||||
}
|
||||
else
|
||||
{
|
||||
$this->route_collection->addCollection($this->loader->load($resource));
|
||||
}
|
||||
}
|
||||
|
||||
$this->resolveParameters($this->route_collection);
|
||||
}
|
||||
|
||||
return $this->route_collection;
|
||||
@@ -365,6 +203,7 @@ class router implements RouterInterface
|
||||
|
||||
return $this->matcher;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new dumped URL Matcher (dump it if necessary)
|
||||
*/
|
||||
@@ -457,4 +296,111 @@ class router implements RouterInterface
|
||||
{
|
||||
$this->generator = new UrlGenerator($this->get_routes(), $this->context);
|
||||
}
|
||||
|
||||
/**
|
||||
* Replaces placeholders with service container parameter values in:
|
||||
* - the route defaults,
|
||||
* - the route requirements,
|
||||
* - the route path,
|
||||
* - the route host,
|
||||
* - the route schemes,
|
||||
* - the route methods.
|
||||
*
|
||||
* @param RouteCollection $collection
|
||||
*/
|
||||
protected function resolveParameters(RouteCollection $collection)
|
||||
{
|
||||
/** @var \Symfony\Component\Routing\Route $route */
|
||||
foreach ($collection as $route)
|
||||
{
|
||||
foreach ($route->getDefaults() as $name => $value)
|
||||
{
|
||||
$route->setDefault($name, $this->resolve($value));
|
||||
}
|
||||
|
||||
$requirements = $route->getRequirements();
|
||||
unset($requirements['_scheme']);
|
||||
unset($requirements['_method']);
|
||||
|
||||
foreach ($requirements as $name => $value)
|
||||
{
|
||||
$route->setRequirement($name, $this->resolve($value));
|
||||
}
|
||||
|
||||
$route->setPath($this->resolve($route->getPath()));
|
||||
$route->setHost($this->resolve($route->getHost()));
|
||||
|
||||
$schemes = array();
|
||||
foreach ($route->getSchemes() as $scheme)
|
||||
{
|
||||
$schemes = array_merge($schemes, explode('|', $this->resolve($scheme)));
|
||||
}
|
||||
|
||||
$route->setSchemes($schemes);
|
||||
$methods = array();
|
||||
foreach ($route->getMethods() as $method)
|
||||
{
|
||||
$methods = array_merge($methods, explode('|', $this->resolve($method)));
|
||||
}
|
||||
|
||||
$route->setMethods($methods);
|
||||
$route->setCondition($this->resolve($route->getCondition()));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively replaces placeholders with the service container parameters.
|
||||
*
|
||||
* @param mixed $value The source which might contain "%placeholders%"
|
||||
*
|
||||
* @return mixed The source with the placeholders replaced by the container
|
||||
* parameters. Arrays are resolved recursively.
|
||||
*
|
||||
* @throws ParameterNotFoundException When a placeholder does not exist as a container parameter
|
||||
* @throws RuntimeException When a container value is not a string or a numeric value
|
||||
*/
|
||||
private function resolve($value)
|
||||
{
|
||||
if (is_array($value))
|
||||
{
|
||||
foreach ($value as $key => $val)
|
||||
{
|
||||
$value[$key] = $this->resolve($val);
|
||||
}
|
||||
|
||||
return $value;
|
||||
}
|
||||
|
||||
if (!is_string($value))
|
||||
{
|
||||
return $value;
|
||||
}
|
||||
|
||||
$container = $this->container;
|
||||
$escapedValue = preg_replace_callback('/%%|%([^%\s]++)%/', function ($match) use ($container, $value)
|
||||
{
|
||||
// skip %%
|
||||
if (!isset($match[1]))
|
||||
{
|
||||
return '%%';
|
||||
}
|
||||
|
||||
$resolved = $container->getParameter($match[1]);
|
||||
if (is_string($resolved) || is_numeric($resolved))
|
||||
{
|
||||
return (string) $resolved;
|
||||
}
|
||||
|
||||
throw new RuntimeException(sprintf(
|
||||
'The container parameter "%s", used in the route configuration value "%s", '.
|
||||
'must be a string or numeric, but it is of type %s.',
|
||||
$match[1],
|
||||
$value,
|
||||
gettype($resolved)
|
||||
)
|
||||
);
|
||||
}, $value);
|
||||
|
||||
return str_replace('%%', '%', $escapedValue);
|
||||
}
|
||||
}
|
||||
|
Reference in New Issue
Block a user