Merge pull request #3592 from Nicofuma/ticket/13388

[ticket/13388] Integrate routing and di parameters resolution

phpBB/phpbb/routing/router.php

@@ -15,6 +15,9 @@ namespace phpbb\routing;
 
 use Symfony\Component\Config\ConfigCache;
 use Symfony\Component\Filesystem\Exception\IOException;
+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\Routing\Generator\Dumper\PhpGeneratorDumper;
 use Symfony\Component\Routing\Matcher\UrlMatcher;
@@ -91,19 +94,25 @@ class router implements RouterInterface
 	 */
 	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|null	$extension_manager						Extension manager
-	 * @param array			$routing_files							Array of strings containing paths to YAML files
-	 * 																holding route information
+	 * @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
 	 */
-	public function __construct(\phpbb\filesystem\filesystem_interface $filesystem, $phpbb_root_path, $php_ext, $environment, manager $extension_manager = null, $routing_files = array())
+	public function __construct(ContainerInterface $container, \phpbb\filesystem\filesystem_interface $filesystem, $phpbb_root_path, $php_ext, $environment, manager $extension_manager = null, $routing_files = array())
 	{
+		$this->container			= $container;
 		$this->filesystem			= $filesystem;
 		$this->extension_manager	= $extension_manager;
 		$this->routing_files		= $routing_files;
@@ -162,9 +171,117 @@ class router implements RouterInterface
 			}
 		}
 
+		$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
 	 *